diff --git a/.github/workflows/check-extensions-migration.yml b/.github/workflows/check-extensions-migration.yml new file mode 100644 index 0000000000..e15eb0a8a4 --- /dev/null +++ b/.github/workflows/check-extensions-migration.yml @@ -0,0 +1,85 @@ +# https://docs.github.com/en/actions +# Temporary: end-to-end test of the move of the third-party extensions to +# php/doc-extensions, with the Spanish manual. It builds the extensions manual +# and this manual from the branches of the pull requests of the block, serves +# both with web-php and checks that the old URLs are redirected and that the +# manuals link to each other. The test is web-php/tests/extensions-migration.sh, +# which anyone can run locally with the same six repositories (LANGUAGE=es). +# +# Remove this workflow once the pull requests are merged, or replace the pinned +# refs by master. + +name: "Extensions migration" + +on: + pull_request: + branches: ["master"] + types: [opened, synchronize, reopened] + +permissions: + contents: read + +concurrency: + group: "${{ github.workflow }}-${{ github.ref }}" + cancel-in-progress: true + +jobs: + end-to-end: + name: "End to end" + runs-on: ubuntu-latest + steps: + # The six repositories side by side: this is the layout expected by the + # doc-base scripts and by the test. The explicit ref takes the real head + # of this pull request, not the merge commit. + - name: "Checkout php/doc-es" + uses: actions/checkout@v7 + with: + path: es + ref: ${{ github.event.pull_request.head.sha }} + + # Fallback of the translation, with the moved extensions removed. + - name: "Checkout php/doc-en" + uses: actions/checkout@v7 + with: + repository: php/doc-en + path: en + ref: refs/pull/5998/head + + - name: "Checkout php/doc-base" + uses: actions/checkout@v7 + with: + repository: php/doc-base + path: doc-base + + - name: "Checkout php/phd" + uses: actions/checkout@v7 + with: + repository: php/phd + path: phd + ref: refs/pull/270/head + + - name: "Checkout php/doc-extensions" + uses: actions/checkout@v7 + with: + repository: php/doc-extensions + path: extensions + ref: refs/pull/49/head + + - name: "Checkout php/web-php" + uses: actions/checkout@v7 + with: + repository: php/web-php + path: web-php + ref: refs/pull/2038/head + + - name: "Setup PHP" + uses: shivammathur/setup-php@v2 + with: + php-version: "8.4" + extensions: "dom, iconv, intl, libxml, mbstring, simplexml, sqlite3, xmlreader, xmlwriter" + coverage: none + + - name: "Build both manuals and test the redirects and the links" + env: + LANGUAGE: es + run: sh web-php/tests/extensions-migration.sh "$GITHUB_WORKSPACE" diff --git a/appendices/aliases.xml b/appendices/aliases.xml index f93a5fc1c2..ce87eeb09e 100644 --- a/appendices/aliases.xml +++ b/appendices/aliases.xml @@ -3,7 +3,7 @@ - + Lista de alias Hay muchas funciones en PHP que pueden ser llamadas bajo @@ -238,92 +238,92 @@ mysql mysql_db_query - MySQL + MySQL mysql_createdb mysql_create_db - MySQL + MySQL mysql_db_name mysql_result - MySQL + MySQL mysql_dbname mysql_result - MySQL + MySQL mysql_dropdb mysql_drop_db - MySQL + MySQL mysql_fieldflags mysql_field_flags - MySQL + MySQL mysql_fieldlen mysql_field_len - MySQL + MySQL mysql_fieldname mysql_field_name - MySQL + MySQL mysql_fieldtable mysql_field_table - MySQL + MySQL mysql_fieldtype mysql_field_type - MySQL + MySQL mysql_freeresult mysql_free_result - MySQL + MySQL mysql_listdbs mysql_list_dbs - MySQL + MySQL mysql_listfields mysql_list_fields - MySQL + MySQL mysql_listtables mysql_list_tables - MySQL + MySQL mysql_numfields mysql_num_fields - MySQL + MySQL mysql_numrows mysql_num_rows - MySQL + MySQL mysql_selectdb mysql_select_db - MySQL + MySQL mysql_tablename mysql_result - MySQL + MySQL ociassignelem @@ -598,7 +598,7 @@ recode recode_string - Recode + Recode show_source diff --git a/appendices/filters.xml b/appendices/filters.xml index 229cb9a864..397e3d266f 100644 --- a/appendices/filters.xml +++ b/appendices/filters.xml @@ -587,7 +587,7 @@ El fichero comprimido tiene 1488 bytes. mcrypt.* y mdecrypt.* proporcionan un sistema de cifrado simétrico utilizando libmcrypt. Ambos conjuntos de filtros soportan los mismos algoritmos disponibles en la - extensión mcrypt en forma + extensión mcrypt en forma mcrypt.ciphername donde ciphername es el nombre del cifrado que será transmitido a mcrypt_module_open. diff --git a/appendices/migration56/changed-functions.xml b/appendices/migration56/changed-functions.xml index fa19a5a8b3..14158d4120 100644 --- a/appendices/migration56/changed-functions.xml +++ b/appendices/migration56/changed-functions.xml @@ -2,7 +2,7 @@ - + Funciones modificadas @@ -47,7 +47,7 @@ - <link linkend="book.mcrypt">Mcrypt</link> + <link xlink:href="../extensions/book.mcrypt.php">Mcrypt</link> diff --git a/appendices/migration56/incompatible.xml b/appendices/migration56/incompatible.xml index c3c8d16a89..ba5ac64dae 100644 --- a/appendices/migration56/incompatible.xml +++ b/appendices/migration56/incompatible.xml @@ -2,7 +2,7 @@ - + Cambios incompatibles con versiones anteriores Aunque la mayoría del código PHP 5 existente debería funcionar sin ninguna @@ -103,7 +103,7 @@ array(3) { - Las funciones <link linkend="book.mcrypt">Mcrypt</link> ahora requieren claves o IV válidos + Las funciones <link xlink:href="../extensions/book.mcrypt.php">Mcrypt</link> ahora requieren claves o IV válidos mcrypt_encrypt, mcrypt_decrypt, diff --git a/appendices/migration70/incompatible/removed-functions.xml b/appendices/migration70/incompatible/removed-functions.xml index d0ad539121..904412bcd7 100644 --- a/appendices/migration70/incompatible/removed-functions.xml +++ b/appendices/migration70/incompatible/removed-functions.xml @@ -2,7 +2,7 @@ - + Funciones eliminadas @@ -34,7 +34,7 @@ - Alias <link linkend="book.mcrypt">mcrypt</link> + Alias <link xlink:href="../extensions/book.mcrypt.php">mcrypt</link> La función obsoleta mcrypt_generic_end se @@ -55,7 +55,7 @@ Todas las funciones ext/mysql - Todas las funciones ext/mysql se han eliminado. + Todas las funciones ext/mysql se han eliminado. Para más información sobre la elección de otra API MySQL, consulte elegir una API MySQL. @@ -68,10 +68,8 @@ Todas las funciones ext/mssql se han eliminado. PDO_SQLSRV PDO_ODBC SQLSRV Unified ODBC API + role="alternatives"> PDO_SQLSRV PDO_ODBC SQLSRV Unified ODBC API diff --git a/appendices/migration72/other-changes.xml b/appendices/migration72/other-changes.xml index 6d051cc986..40854f900b 100644 --- a/appendices/migration72/other-changes.xml +++ b/appendices/migration72/other-changes.xml @@ -84,10 +84,10 @@ - Traslado de <link linkend="book.mcrypt">MCrypt</link> a PECL + Traslado de <link xlink:href="../extensions/book.mcrypt.php">MCrypt</link> a PECL - La extensión MCrypt ha sido trasladada del núcleo a PECL. + La extensión MCrypt ha sido trasladada del núcleo a PECL. Dado que la biblioteca mcrypt no ha visto actualizaciones desde 2007, su uso está fuertemente desaconsejado. En su lugar, debe utilizarse OpenSSL o la extensión diff --git a/appendices/migration74/removed-extensions.xml b/appendices/migration74/removed-extensions.xml index 7854b9d724..cb708e4efe 100644 --- a/appendices/migration74/removed-extensions.xml +++ b/appendices/migration74/removed-extensions.xml @@ -15,19 +15,19 @@ - Firebird/Interbase + Firebird/Interbase - el acceso a una base de datos basada en InterBase y/o Firebird sigue siendo con el driver PDO Firebird. - Recode + Recode - WDDX + WDDX diff --git a/faq/databases.xml b/faq/databases.xml index 09039ac0c4..5d8b5dc325 100644 --- a/faq/databases.xml +++ b/faq/databases.xml @@ -24,8 +24,8 @@ o la API ODBC Unificada. - En máquinas Windows se puede usar PDO_SQLSRV - o SQLSRV. + En máquinas Windows se puede usar PDO_SQLSRV + o SQLSRV. Consulte también la respuesta de la siguiente pregunta. diff --git a/install/pie.xml b/install/pie.xml index fd1eddb768..9b10e06f32 100644 --- a/install/pie.xml +++ b/install/pie.xml @@ -17,7 +17,7 @@ Tras instalar los requisitos y PIE en sí, puede instalar la - extensión MongoDB ejecutando + extensión MongoDB ejecutando el siguiente comando en la línea de comandos. diff --git a/install/unix/debian.xml b/install/unix/debian.xml index cc2b3b0968..5685709897 100644 --- a/install/unix/debian.xml +++ b/install/unix/debian.xml @@ -53,7 +53,7 @@ Un mejor control de la configuración En el ejemplo anterior, PHP fue instalado con solo los componentes principales. Es probable que se necesiten módulos adicionales, tales como - MySQL, + MySQL, cURL, GD, etc. También pueden ser instalados a través del comando apt. diff --git a/install/unix/dnf.xml b/install/unix/dnf.xml index 9e0f2e7f36..6a745e95a5 100644 --- a/install/unix/dnf.xml +++ b/install/unix/dnf.xml @@ -53,7 +53,7 @@ En la última sección, PHP ha sido instalado solo con los módulos básicos. Es muy probable que se requieran módulos adicionales, tales como - MySQL + MySQL cURL GD etc. diff --git a/install/windows/recommended.xml b/install/windows/recommended.xml index 6cc6f819c1..4c1b242c95 100644 --- a/install/windows/recommended.xml +++ b/install/windows/recommended.xml @@ -64,7 +64,7 @@ wincache.ocenabled=1 ; removed as of wincache 2.0.0.0 Para más información, leer : - Configuración de WinCache + Configuración de WinCache diff --git a/language-snippets.ent b/language-snippets.ent index e9e02a3513..3cd61bf8bc 100644 --- a/language-snippets.ent +++ b/language-snippets.ent @@ -374,8 +374,8 @@ de PHP. Esta función debe ser utilizada bajo su propio riesgo. '> Las extensiones IMAP, recode y -YAZ +linkend="book.imap">IMAP, recode y +YAZ no pueden ser utilizadas simultáneamente ya que utilizan un símbolo interno común. Nota: Yaz 2.0 y superior ya no sufre de este problema.'> @@ -1350,7 +1350,7 @@ de la codificación de caracteres interna.'> Una función o método a llamar. - Debe retornar un valor válido de retorno Gearman. + Debe retornar un valor válido de retorno Gearman. Si no se proporciona una instrucción de retorno, el valor predeterminado será GEARMAN_SUCCESS. @@ -2281,19 +2281,19 @@ también MySQL: elegir una API de la guía. Alternativas a esta función:'> Esta función estaba obsoleta en PHP 4.3.0, y -toda la extensión original MySQL fue eliminada en PHP 7.0.0. En +toda la extensión original MySQL fue eliminada en PHP 7.0.0. En su lugar, se puede utilizar la extensión MySQLi o la extensión PDO_MySQL. Ver también MySQL: elegir una API de la guía. Alternativas a esta función:'> Esta función estaba obsoleta en PHP 5.3.0, y -toda la extensión original MySQL fue eliminada en PHP 7.0.0. En +toda la extensión original MySQL fue eliminada en PHP 7.0.0. En su lugar, se puede utilizar la extensión MySQLi o la extensión PDO_MySQL. Ver también MySQL: elegir una API de la guía. Alternativas a esta función:'> Esta función estaba obsoleta en PHP 5.4.0, y -toda la extensión original MySQL fue eliminada en PHP 7.0.0. En +toda la extensión original MySQL fue eliminada en PHP 7.0.0. En su lugar, se puede utilizar la extensión MySQLi o la extensión PDO_MySQL. Ver también MySQL: elegir una API de la guía. Alternativas a esta función:'> @@ -3438,7 +3438,7 @@ local: { - Al evaluar los criterios de consulta, MongoDB compara los tipos y los valores según sus propias reglas de comparación para los tipos BSON, que difieren de las reglas de comparación y de manipulación de tipos de PHP. Al hacer coincidir un tipo BSON especial, los criterios de consulta deben utilizar la clase BSON (ej.: utilizar MongoDB\BSON\ObjectId para hacer coincidir un ObjectId). + Al evaluar los criterios de consulta, MongoDB compara los tipos y los valores según sus propias reglas de comparación para los tipos BSON, que difieren de las reglas de comparación y de manipulación de tipos de PHP. Al hacer coincidir un tipo BSON especial, los criterios de consulta deben utilizar la clase BSON (ej.: utilizar MongoDB\BSON\ObjectId para hacer coincidir un ObjectId). diff --git a/language/operators.xml b/language/operators.xml index 6b706cc099..cb1db9ae5a 100644 --- a/language/operators.xml +++ b/language/operators.xml @@ -1,6 +1,6 @@ - + Los operadores Un operador es algo que toma uno o más valores (o @@ -32,7 +32,7 @@ Existe una extensión PECL que permite la sobrecarga de algunos operadores para objetos. Para más información, véase la sección de - Sobrecarga de operadores para objetos. + Sobrecarga de operadores para objetos. &language.operators.precedence; diff --git a/reference/apcu/apcuiterator.xml b/reference/apcu/apcuiterator.xml deleted file mode 100644 index c9037917e3..0000000000 --- a/reference/apcu/apcuiterator.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - La clase APCUIterator - APCUIterator - - - - -
- &reftitle.intro; - - La clase APCUIterator hace más fácil iterar - sobre grandes cachés de APCu. Esto es útil ya que permite iterar sobre grandes - cachés en pasos, al mismo tiempo que captura un número definido de entradas por instancia de bloqueo, - por lo que libera los bloqueos de caché para otras actividades en lugar de mantener todo el caché - para obtener 100 entradas (el valor por defecto). Además, utilizar comparación por expresiones regulares - es más eficiente ya que se ha movido al nivel de C. - -
- - -
- &reftitle.classsynopsis; - - - - APCUIterator - - - - - APCUIterator - - - - Iterator - - - - - - &Methods; - - - - - - - - - - -
- -
- - &reference.apcu.entities.apcuiterator; - -
- diff --git a/reference/apcu/apcuiterator/construct.xml b/reference/apcu/apcuiterator/construct.xml deleted file mode 100644 index 52063a6b6d..0000000000 --- a/reference/apcu/apcuiterator/construct.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - APCUIterator::__construct - Construye un objeto iterador APCUIterator - - - - &reftitle.description; - - public APCUIterator::__construct - arraystringnullsearch&null; - intformatAPC_ITER_ALL - intchunk_size100 - intlistAPC_LIST_ACTIVE - - - Construye un APCUIterator object. - - - - - &reftitle.parameters; - - - search - - - O bien una expresión regular PCRE - que coincide con nombres de clave APCu, dada como &string;. - O una &array; de &string;s con nombres de claves APCu. - O, opcionalmente &null; para omitir la búsqueda. - - - - - format - - - El formato deseado, tal como está configurado con una o más de las - constantes APC_ITER_*. - - - - - chunk_size - - - El tamaño del fragmento. Debe ser un valor mayor que 0. El valor por defecto - es 100. - - - - - list - - - El tipo de lista. O bien pasar en APC_LIST_ACTIVE - o APC_LIST_DELETED. - - - - - - - - &reftitle.examples; - - Un ejemplo de <function>APCUIterator::__construct</function> - - -]]> - - - - - - &reftitle.seealso; - - apcu_exists - apcu_cache_info - - - - - diff --git a/reference/apcu/apcuiterator/current.xml b/reference/apcu/apcuiterator/current.xml deleted file mode 100644 index 2f7ef297c1..0000000000 --- a/reference/apcu/apcuiterator/current.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - APCUIterator::current - Obtener el elemento actual - - - - &reftitle.description; - - public mixedAPCUIterator::current - - - - Obtiene el elemento actual de la pila APCUIterator. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el elemento actual en caso de éxito, o &false; si no - hay más elementos o no existen, o en caso de error. - - - - - &reftitle.seealso; - - APCUIterator::next - Iterator::current - - - - - diff --git a/reference/apcu/apcuiterator/gettotalcount.xml b/reference/apcu/apcuiterator/gettotalcount.xml deleted file mode 100644 index 811f3b7f51..0000000000 --- a/reference/apcu/apcuiterator/gettotalcount.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - APCUIterator::getTotalCount - Obtiene el conteo total - - - - &reftitle.description; - - public intAPCUIterator::getTotalCount - - - - Obtener el conteo total. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El conteo total. - - - - - &reftitle.seealso; - - APCUIterator::getTotalHits - APCUIterator::getTotalSize - apcu_cache_info - - - - - diff --git a/reference/apcu/apcuiterator/gettotalhits.xml b/reference/apcu/apcuiterator/gettotalhits.xml deleted file mode 100644 index cadcdfeae0..0000000000 --- a/reference/apcu/apcuiterator/gettotalhits.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - APCUIterator::getTotalHits - Obtener resultados totales de la memoria caché - - - - &reftitle.description; - - public intAPCUIterator::getTotalHits - - - - Obtiene el número total de visitas a la memoria caché. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El número de visitas en caso de éxito, o &false; en caso de error. - - - - - &reftitle.seealso; - - APCUIterator::getTotalCount - APCUIterator::getTotalSize - apcu_cache_info - - - - - diff --git a/reference/apcu/apcuiterator/gettotalsize.xml b/reference/apcu/apcuiterator/gettotalsize.xml deleted file mode 100644 index 27d5f09bd8..0000000000 --- a/reference/apcu/apcuiterator/gettotalsize.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - APCUIterator::getTotalSize - Obtiene el tamaño total del caché - - - - &reftitle.description; - - public intAPCUIterator::getTotalSize - - - - Obtiene el tamaño total del caché. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El tamaño total del caché. - - - - - &reftitle.seealso; - - APCUIterator::getTotalCount - APCUIterator::getTotalHits - apc_cache_info - - - - - diff --git a/reference/apcu/apcuiterator/key.xml b/reference/apcu/apcuiterator/key.xml deleted file mode 100644 index bd1e4a2b83..0000000000 --- a/reference/apcu/apcuiterator/key.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - APCUIterator::key - Obtiene la clave del iterador - - - - &reftitle.description; - - public stringAPCUIterator::key - - - - Obtiene la clave del iterador actual. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la clave en caso de éxito, o &false; en caso de error. - - - - - &reftitle.seealso; - - APCUIterator::current - Iterator::key - - - - - diff --git a/reference/apcu/apcuiterator/next.xml b/reference/apcu/apcuiterator/next.xml deleted file mode 100644 index 5dff6c7120..0000000000 --- a/reference/apcu/apcuiterator/next.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - APCUIterator::next - Mueve el puntero al siguiente elemento - - - - &reftitle.description; - - public boolAPCUIterator::next - - - - Mueve el puntero del iterador al siguiente elemento. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - APCUIterator::current - APCUIterator::rewind - Iterator::next - - - - - diff --git a/reference/apcu/apcuiterator/rewind.xml b/reference/apcu/apcuiterator/rewind.xml deleted file mode 100644 index 174310835c..0000000000 --- a/reference/apcu/apcuiterator/rewind.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - APCUIterator::rewind - Rebobina el iterador - - - - &reftitle.description; - - public voidAPCUIterator::rewind - - - - Rebobina el iterador hasta el primer elemento. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - APCUIterator::next - Iterator::next - - - - - diff --git a/reference/apcu/apcuiterator/valid.xml b/reference/apcu/apcuiterator/valid.xml deleted file mode 100644 index def69d25e9..0000000000 --- a/reference/apcu/apcuiterator/valid.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - APCUIterator::valid - Comprueba si la posición actual es válida - - - - &reftitle.description; - - public boolAPCUIterator::valid - - - - Comprueba si la posición actual del iterador es válida. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si la posición actual del iterador es válida, en caso contrario &false;. - - - - - &reftitle.seealso; - - APCUIterator::current - Iterator::valid - - - - - diff --git a/reference/apcu/book.xml b/reference/apcu/book.xml deleted file mode 100644 index a67716979a..0000000000 --- a/reference/apcu/book.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Caché de usuario APC - APCu - - - &reftitle.intro; - - APCu es un array asociativo almacenado en memoria para PHP. - Las claves son de tipo &string; y los valores son variables PHP de cualquier tipo. - APCu solo gestiona la caché de variables del espacio de usuario. - - - La caché APCu es por proceso bajo Windows, por lo que al utilizar un SAPI - basado en procesos (en lugar de en hilos), no será compartida entre - diferentes procesos. - - - APCu es APC sin la caché de código operativo. - - - La primera versión es 4.0.0, fue un ramificado del código de la - cabeza de la rama principal de APC de la época. - El soporte para PHP 7 está disponible a partir de APCu 5.0.0. - El soporte para PHP 8 está disponible a partir de APCu 5.1.19. - - - - &reference.apcu.setup; - &reference.apcu.constants; - &reference.apcu.reference; - &reference.apcu.apcuiterator; - - - diff --git a/reference/apcu/constants.xml b/reference/apcu/constants.xml deleted file mode 100644 index 71cd2bbe87..0000000000 --- a/reference/apcu/constants.xml +++ /dev/null @@ -1,238 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - - APC_ITER_ALL - (int) - - - - - - - - - - APC_ITER_ATIME - (int) - - - - - - - - - - APC_ITER_CTIME - (int) - - - - - - - - - - APC_ITER_DEVICE - (int) - - - - - - - - - - APC_ITER_DTIME - (int) - - - - - - - - - - APC_ITER_FILENAME - (int) - - - - - - - - - - APC_ITER_INODE - (int) - - - - - - - - - - APC_ITER_KEY - (int) - - - - - - - - - - APC_ITER_MD5 - (int) - - - - - - - - - - APC_ITER_MEM_SIZE - (int) - - - - - - - - - - APC_ITER_MTIME - (int) - - - - - - - - - - APC_ITER_NONE - (int) - - - - - - - - - - APC_ITER_NUM_HITS - (int) - - - - - - - - - - APC_ITER_REFCOUNT - (int) - - - - - - - - - - APC_ITER_TTL - (int) - - - - - - - - - - APC_ITER_TYPE - (int) - - - - - - - - - - APC_ITER_VALUE - (int) - - - - - - - - - - APC_LIST_ACTIVE - (int) - - - - - - - - - - APC_LIST_DELETED - (int) - - - - - - - - - diff --git a/reference/apcu/functions/apcu-add.xml b/reference/apcu/functions/apcu-add.xml deleted file mode 100644 index b30b9efe0d..0000000000 --- a/reference/apcu/functions/apcu-add.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - apcu_add - - Almacena en caché una nueva variable en el almacén de datos - - - - &reftitle.description; - - boolapcu_add - stringkey - mixedvar - intttl0 - - - arrayapcu_add - arrayvalues - mixedunusedNULL - intttl0 - - - Almacena en caché una variable en el almacén de datos, solo si no ha sido ya almacenada. - - - - A diferencia de muchos otros mecanismos en PHP, las variables almacenadas - utilizando apcu_add persistirán entre las peticiones (hasta que - sus valores sean retirados del caché). - - - - - &reftitle.parameters; - - - key - - - Almacena la variable utilizando este nombre de clave. Cada clave es única en el caché, - intentar utilizar apcu_add para almacenar un dato con una - clave key ya existente no sobrescribirá el dato sino que devolverá - el valor &false;. (Esta es la única diferencia entre - las funciones apcu_add y apcu_store.) - - - - - var - - - La variable a almacenar. - - - - - ttl - - - Duración de vida; almacena la variable var en el caché durante - ttl segundos. Después de la expiración de - ttl, la variable almacenada será retirada del caché (en la - próxima petición). Si no se pasa ningún valor a - ttl (o si el valor de ttl es - 0), la variable persistirá hasta que sea retirada - manualmente del caché, o, de lo contrario, fallará al salir del caché (durante un - borrado, reinicio, etc.). - - - - - values - - - Los nombres son proporcionados por las claves del array values, - las variables por los valores. - - - - - - - &reftitle.returnvalues; - - Devuelve TRUE si una variable ha sido efectivamente añadida al caché, FALSE en caso contrario. - La segunda sintaxis devuelve un array con las claves erróneas. - - - - - &reftitle.examples; - - Un ejemplo con <function>apcu_add</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - apcu_store - apcu_fetch - apcu_delete - - - - - diff --git a/reference/apcu/functions/apcu-cache-info.xml b/reference/apcu/functions/apcu-cache-info.xml deleted file mode 100644 index 7244254cc6..0000000000 --- a/reference/apcu/functions/apcu-cache-info.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - apcu_cache_info - - Recupera la información almacenada en la memoria APCu - - - - &reftitle.description; - - arrayfalseapcu_cache_info - boollimited&false; - - - Recupera la información almacenada y los metadatos del almacén de datos de la APCu. - - - - - &reftitle.parameters; - - - limited - - - Si el parámetro limited es &true;, el - valor devuelto excluirá la lista individual de entradas de la memoria caché. Esto - es útil cuando se intentan optimizar las llamadas para la recopilación de estadísticas. - - - - - - - - &reftitle.returnvalues; - - Array de datos en caché (y metadatos)&return.falseforfailure; - - - - apcu_cache_info hará una advertencia si no puede recuperar - los datos de la caché del APCu. Esto suele ocurrir cuando el APCu no está activado. - - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL apcu 3.0.11 - - El parámetro limited fué introducido. - - - - PECL apcu 3.0.16 - - La opción "filehits" para el - parámetro cache_type fué introducido. - - - - - - - - - &reftitle.examples; - - Un ejemplo de <function>apcu_cache_info</function> - - -]]> - - &example.outputs.similar; - - 2000 - [ttl] => 0 - [num_hits] => 9 - [num_misses] => 3 - [start_time] => 1123958803 - [cache_list] => Array - ( - [0] => Array - ( - [filename] => /path/to/apcu_test.php - [device] => 29954 - [inode] => 1130511 - [type] => file - [num_hits] => 1 - [mtime] => 1123960686 - [creation_time] => 1123960696 - [deletion_time] => 0 - [access_time] => 1123962864 - [ref_count] => 1 - [mem_size] => 677 - ) - [1] => Array (...iterates for each cached file) -) -]]> - - - - - - &reftitle.seealso; - - APCu configuration directives - APCUIterator::getTotalSize - APCUIterator::getTotalHits - APCUIterator::getTotalCount - - - - - diff --git a/reference/apcu/functions/apcu-cas.xml b/reference/apcu/functions/apcu-cas.xml deleted file mode 100644 index d0d2f7cf64..0000000000 --- a/reference/apcu/functions/apcu-cas.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - - apcu_cas - Actualiza un valor antiguo con un nuevo valor - - - - &reftitle.description; - - boolapcu_cas - stringkey - intold - intnew - - - apcu_cas actualiza un valor entero ya existente si el - parámetro old coincide el valor almacenado - actualmente con el valor del parámetro new. - - - - - &reftitle.parameters; - - - key - - - La clave del valor que se está actualizando. - - - - - old - - - El valor antiguo (el valor actualmente almacenado). - - - - - new - - - El nuevo valor al que actualizar. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo de <function>apcu_cas</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - apcu_dec - apcu_store - - - - - diff --git a/reference/apcu/functions/apcu-clear-cache.xml b/reference/apcu/functions/apcu-clear-cache.xml deleted file mode 100644 index bfe7961b7c..0000000000 --- a/reference/apcu/functions/apcu-clear-cache.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - apcu_clear_cache - - Limpia el caché del APCu - - - - &reftitle.description; - - boolapcu_clear_cache - - - - Limpia el caché. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve siempre &true; - - - - - &reftitle.seealso; - - apcu_cache_info - - - - - diff --git a/reference/apcu/functions/apcu-dec.xml b/reference/apcu/functions/apcu-dec.xml deleted file mode 100644 index 1c5f22eeb8..0000000000 --- a/reference/apcu/functions/apcu-dec.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - - apcu_dec - Disminuir un número almacenado - - - - &reftitle.description; - - intfalseapcu_dec - stringkey - intstep1 - boolsuccess - intttl0 - - - Disminuye un valor entero almacenado. - - - - - &reftitle.parameters; - - - key - - - La clave de el valor a ser disminuido. - - - - - step - - - El paso, o valor a disminuir. - - - - - success - - - Opcionalmente pasa el valor booleano en caso de éxito o - en caso de error a esta variable referenciada. - - - - - ttl - - - TTL para usar si la operación inserta un nuevo valor (en lugar de disminuir uno existente). - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor actual del valor de las claves (key) en caso de éxito, - &return.falseforfailure; - - - - - &reftitle.examples; - - Ejemplo de <function>apcu_dec</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - apcu_inc - - - - - diff --git a/reference/apcu/functions/apcu-delete.xml b/reference/apcu/functions/apcu-delete.xml deleted file mode 100644 index cb90970829..0000000000 --- a/reference/apcu/functions/apcu-delete.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - apcu_delete - - Elimina una variable almacenada en caché - - - - &reftitle.description; - - mixedapcu_delete - mixedkey - - - Elimina una variable almacenada en caché. - - - - &reftitle.parameters; - - - key - - - Una clave (key) empleada para almacenar el valor como un - string para una única clave, - o como un array de strings para varias claves, - o como un object APCUIterator. - - - - - - - &reftitle.returnvalues; - - Si key es una &array;, se devuelve una &array; indexada de las claves. - De lo contrario, se devuelve &true; en caso de éxito, o &false; en caso de fallo. - - - - - &reftitle.examples; - - Un ejemplo de<function>apcu_delete</function> - - -]]> - - - - - - &reftitle.seealso; - - apcu_store - apcu_fetch - apcu_clear_cache - APCUIterator - - - - - diff --git a/reference/apcu/functions/apcu-enabled.xml b/reference/apcu/functions/apcu-enabled.xml deleted file mode 100644 index 09e1540d9c..0000000000 --- a/reference/apcu/functions/apcu-enabled.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - apcu_enabled - Si el APCu es utilizable en el entorno actual - - - - &reftitle.description; - - boolapcu_enabled - - - - Devuelve si el APCu es utilizable en el entorno actual. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; uando el APCu es utilizable en el entorno actual, &false; en caso contrario. - - - - - diff --git a/reference/apcu/functions/apcu-entry.xml b/reference/apcu/functions/apcu-entry.xml deleted file mode 100644 index b21667ee69..0000000000 --- a/reference/apcu/functions/apcu-entry.xml +++ /dev/null @@ -1,165 +0,0 @@ - - - - - - apcu_entry - - Recupera o genera de forma atómica una entrada de caché - - - - &reftitle.description; - - mixedapcu_entry - stringkey - callablecallback - intttl0 - - - Intenta de forma atómica encontrar key en la caché; si no se encuentra, se llama a callback, - pasando key como único argumento. El valor de retorno de la llamada se almacena en caché con el ttl - especificado opcionalmente y se devuelve. - - - - Cuando el control entra en apcu_entry, se adquiere de forma exclusiva el bloqueo de la caché, que se libera cuando el control - sale de apcu_entry. En efecto, esto convierte el cuerpo de callback en una sección crítica, impidiendo que - dos procesos ejecuten las mismas rutas de código concurrentemente. Además, prohíbe la ejecución concurrente de cualquier otra función de APCu, - ya que adquirirán el mismo bloqueo. - - - - - La única función de APCu que puede llamarse de forma segura desde callback es apcu_entry. - - - - - &reftitle.parameters; - - - key - - - Identificador de la entrada de caché - - - - - callback - - - Una retrollamada que acepta key como único argumento y devuelve el valor a almacenar en caché. - - - - - ttl - - - Tiempo de vida; almacena el valor de retorno del callback en la caché durante - ttl segundos. Después de que - ttl haya transcurrido, la entrada almacenada será - eliminada de la caché (en la siguiente petición). Si no se proporciona ttl - (o si el ttl es - 0), el valor persistirá hasta que se elimine manualmente de - la caché, o deje de existir en la caché (limpieza, - reinicio, etc.). - - - - - - - &reftitle.returnvalues; - - Devuelve el valor almacenado en caché - - - - - &reftitle.examples; - - Un ejemplo de <function>apcu_entry</function> - - apcu_entry("config.fruit", function($key){ - return [ - "apples", - "pears" - ]; - }), - "people" => apcu_entry("config.people", function($key){ - return [ - "bob", - "joe", - "niki" - ]; - }) - ]; -}); - -var_dump($config); -?> -]]> - - &example.outputs; - - - array(2) { - [0]=> - string(6) "apples" - [1]=> - string(5) "pears" - } - ["people"]=> - array(3) { - [0]=> - string(3) "bob" - [1]=> - string(3) "joe" - [2]=> - string(4) "niki" - } -} -]]> - - - - - - &reftitle.seealso; - - apcu_store - apcu_fetch - apcu_delete - - - - - diff --git a/reference/apcu/functions/apcu-exists.xml b/reference/apcu/functions/apcu-exists.xml deleted file mode 100644 index d98a760f1c..0000000000 --- a/reference/apcu/functions/apcu-exists.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - apcu_exists - Verifica si una entrada existe - - - - &reftitle.description; - - boolarrayapcu_exists - stringarraykeys - - - Verifica si una o varias entradas APCu existen. - - - - - &reftitle.parameters; - - - keys - - - Un string o un array de - strings que contiene las claves. - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor &true; si la clave existe, o &false; en caso contrario. - O bien, si un array ha sido pasado a keys, - entonces el valor devuelto es un array conteniendo todas las claves - existentes, o un array vacío si ninguna existe. - - - - - &reftitle.examples; - - Un ejemplo con <function>apcu_exists</function> - - -]]> - - &example.outputs.similar; - - - bool(true) - ["bar"]=> - bool(true) -} -]]> - - - - - - &reftitle.seealso; - - apcu_cache_info - apcu_fetch - - - - diff --git a/reference/apcu/functions/apcu-fetch.xml b/reference/apcu/functions/apcu-fetch.xml deleted file mode 100644 index b6ae24e004..0000000000 --- a/reference/apcu/functions/apcu-fetch.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - apcu_fetch - - Recupera una variable almacenada en la caché - - - - &reftitle.description; - - mixedapcu_fetch - mixedkey - boolsuccess - - - Recupera una entrada de la caché. - - - - &reftitle.parameters; - - - key - - - La clave key utilizada para almacenar el valor - (con apcu_store). Si se pasa un array, entonces cada elemento es recuperado y devuelto. - - - - - success - - - Definido como &true; en caso de éxito y &false; en caso de fallo. - - - - - - - &reftitle.returnvalues; - - La variable o el array de variables almacenado en caso de éxito; - &false; en caso de fallo. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL apcu 3.0.17 - - El parámetro success ha sido añadido. - - - - - - - - - &reftitle.examples; - - Un ejemplo con <function>apcu_fetch</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - apcu_store - apcu_delete - APCUIterator - - - - - diff --git a/reference/apcu/functions/apcu-inc.xml b/reference/apcu/functions/apcu-inc.xml deleted file mode 100644 index 54d07bbef1..0000000000 --- a/reference/apcu/functions/apcu-inc.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - apcu_inc - Incrementa un número almacenado - - - - &reftitle.description; - - intfalseapcu_inc - stringkey - intstep1 - boolsuccess - intttl0 - - - Incrementa un número almacenado. - - - - - &reftitle.parameters; - - - key - - - La clave del valor que debe ser incrementado. - - - - - step - - - El paso de incrementación o el valor a añadir. - - - - - success - - - Opcional, pasa el valor booleano éxito o fallo a la variable referenciada. - - - - - ttl - - - Duración de vida a utilizar si la función inserta una nueva variable (en lugar de incrementar una variable existente). - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor actual asociado a la clave key en caso de éxito, - &return.falseforfailure; - - - - - &reftitle.examples; - - Un ejemplo con <function>apcu_inc</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - apcu_dec - - - - - diff --git a/reference/apcu/functions/apcu-key-info.xml b/reference/apcu/functions/apcu-key-info.xml deleted file mode 100644 index 6f2a3d5ba6..0000000000 --- a/reference/apcu/functions/apcu-key-info.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - apcu_key_info - - Devuelve información detallada sobre la clave de caché - - - - - &reftitle.description; - - arraynullapcu_key_info - stringkey - - - Devuelve información detallada sobre la clave de caché. - - - - - &reftitle.parameters; - - - key - - - La clave de la que se desea obtener la información. - - - - - - - - &reftitle.returnvalues; - - Un array que contiene información detallada sobre la clave de caché, - o el valor &null; si la clave no existe. - - - - - &reftitle.examples; - - Un ejemplo con <function>apcu_key_info</function> - - -]]> - - &example.outputs; - - - int(0) - ["access_time"]=> - int(1606701783) - ["mtime"]=> - int(1606701783) - ["creation_time"]=> - int(1606701783) - ["deletion_time"]=> - int(0) - ["ttl"]=> - int(0) - ["refs"]=> - int(0) -} -]]> - - - - - - &reftitle.seealso; - - apcu_store - apcu_fetch - apcu_delete - - - - - diff --git a/reference/apcu/functions/apcu-sma-info.xml b/reference/apcu/functions/apcu-sma-info.xml deleted file mode 100644 index a59c0cd3d2..0000000000 --- a/reference/apcu/functions/apcu-sma-info.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - apcu_sma_info - - Devuelve información sobre la Asignación de Memoria Compartida de APCu - - - - &reftitle.description; - - arrayfalseapcu_sma_info - boollimited&false; - - - Devuelve información sobre la Asignación de Memoria Compartida de APCu. - - - - - &reftitle.parameters; - - - limited - - - Cuando el valor &false; es pasado (por omisión) a este argumento, - la función apcu_sma_info devuelve información - detallada sobre cada segmento. - - - - - - - - &reftitle.returnvalues; - - Un array de datos sobre la Asignación de Memoria Compartida; - &false; en caso de fallo. - - - - - &reftitle.examples; - - Un ejemplo con <function>apcu_sma_info</function> - - -]]> - - &example.outputs.similar; - - 1 - [seg_size] => 31457280 - [avail_mem] => 31448408 - [block_lists] => Array - ( - [0] => Array - ( - [0] => Array - ( - [size] => 31448408 - [offset] => 8864 - ) - - ) - - ) - -) -]]> - - - - - - &reftitle.seealso; - - - Directivas de configuración de APCu - - - - - - diff --git a/reference/apcu/functions/apcu-store.xml b/reference/apcu/functions/apcu-store.xml deleted file mode 100644 index 5204a45be6..0000000000 --- a/reference/apcu/functions/apcu-store.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - apcu_store - - Almacena una variable en la caché de datos - - - - &reftitle.description; - - boolapcu_store - stringkey - mixedvar - intttl0 - - - arrayapcu_store - arrayvalues - mixedunusedNULL - intttl0 - - - Almacena una variable en la caché de datos. - - - - A diferencia de muchos otros mecanismos en PHP, las variables almacenadas - utilizando apcu_store persistirán entre las peticiones (hasta que - sus valores sean retirados de la caché). - - - - - &reftitle.parameters; - - - key - - - Almacena la variable utilizando este nombre de clave. Cada clave es única en la caché, - almacenar un segundo valor con el mismo parámetro key - sobrescribirá el valor original. - - - - - var - - - La variable a almacenar. - - - - - ttl - - - Duración de vida; almacena la variable var en la caché durante - un tiempo de ttl segundos. Después de la expiración de - ttl, la variable almacenada será retirada de la caché (en la - próxima petición). Si no se pasa ningún valor al parámetro - ttl (o si el valor de ttl es - 0), la variable persistirá hasta que sea retirada - manualmente de la caché, o, de lo contrario, fallará al salir de la caché (durante un - borrado, reinicio, etc.). - - - - - values - - - Los nombres son proporcionados por las claves del array values, - las variables por los valores. - - - - - - - &reftitle.returnvalues; - - &return.success; - La segunda sintaxis devuelve un array con las claves erróneas. - - - - - &reftitle.examples; - - Un ejemplo con <function>apcu_store</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - apcu_add - apcu_fetch - apcu_delete - - - - - diff --git a/reference/apcu/ini.xml b/reference/apcu/ini.xml deleted file mode 100644 index 5e17d6f36e..0000000000 --- a/reference/apcu/ini.xml +++ /dev/null @@ -1,384 +0,0 @@ - - - -
- &reftitle.runtime; - &extension.runtime; - - Aunque los ajustes predeterminados de APCu funcionan correctamente en muchas - instalaciones, es útil considerar ajustar estos parámetros de configuración. - - - Una cuestión importante para la configuración de APCu es - cuál es el tamaño adecuado que debe asignarse en la memoria a APCu. - La directiva ini que controla este parámetro es apc.shm_size. - El párrafo a continuación es importante para responder a esta pregunta. - - - Una vez iniciado el servidor, el script apc.php, disponible con - la extensión, puede ser copiado en el document root y ejecutado por el - navegador. Este script proporciona un análisis detallado del funcionamiento interno - de APCu. Si la biblioteca GD está activada en PHP, entonces el script puede mostrar - gráficos pertinentes. - - - Si APCu está funcionando, el número de Cache full count (a la izquierda) - mostrará el número de veces que el caché ha alcanzado su capacidad máxima y ha tenido que - evacuar entradas para liberar memoria. Durante la evacuación, si - apc.ttl ha sido especificado, APCu intentará primero eliminar las - entradas expiradas, es decir, las entradas cuyo TTL ha expirado o las entradas - que no tienen TTL definido y que no han sido consultadas en los últimos - apc.ttl segundos. Si apc.ttl no ha sido - definido o si la eliminación de las entradas expiradas no ha liberado suficiente - espacio, APCu borrará la totalidad del caché. - - - El número de evacuaciones debe ser mínimo en un caché bien configurado. Si el - caché está constantemente lleno y por lo tanto liberado a la fuerza, el removimiento resultante tendrá - efectos perjudiciales en el rendimiento del script. La manera más sencilla - de reducir este número es asignar más memoria a APCu. - - - Cuando APCu es compilado con mmap (Memory Mapping), solo utilizará un - segmento de memoria, a diferencia del caso en que APCu es construido con - SHM (SysV Shared Memory) que utiliza varios segmentos de memoria. MMAP no tiene - un límite máximo como SHM en /proc/sys/kernel/shmmax. - En general, el uso de MMAP es recomendado ya que reclama la memoria - más rápidamente cuando el servidor web es reiniciado y reduce el impacto en - la asignación de memoria al inicio. - - - - Opciones de configuración de APCu - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - apc.enabled - "1" - INI_SYSTEM - - - - apc.shm_segments - "1" - INI_SYSTEM - - - - apc.shm_size - "32M" - INI_SYSTEM - - - - apc.entries_hint - 512 * apc.shm_size - INI_SYSTEM - Anteriormente a APCu 5.1.25, el valor predeterminado era 4096 - - - apc.ttl - "0" - INI_SYSTEM - - - - apc.gc_ttl - "3600" - INI_SYSTEM - - - - apc.mmap_file_mask - NULL - INI_SYSTEM - - - - apc.slam_defense - "0" - INI_SYSTEM - - - - apc.enable_cli - "0" - INI_SYSTEM - - - - apc.use_request_time - "0" - INI_ALL - Anteriormente a APCu 5.1.19, el valor predeterminado era 1. - - - apc.serializer - "php" - INI_SYSTEM - Anteriormente a APCu 5.1.15, el valor predeterminado era "default". - - - apc.coredump_unmap - "0" - INI_SYSTEM - - - - apc.preload_path - NULL - INI_SYSTEM - - - - -
- &ini.php.constants; -
- - &ini.descriptions.title; - - - - - apc.enabled - bool - - - - apc.enabled puede ser puesto a 0 para desactivar APC. - Esto puede ser útil cuando APC es compilado estáticamente en PHP - ya que no hay otra manera de desactivarlo (cuando APC es - compilado como DSO, la línea extension - en el fichero php.ini puede simplemente ser comentada). - - - - - - apc.shm_segments - int - - - - El número de segmentos de memoria compartida a asignar al caché de compilación - Si APC carece de memoria compartida pero que apc.shm_size - está puesto al valor máximo permitido por el sistema, entonces aumentar - este valor puede evitar que APC agote su memoria. - - - - - - apc.shm_size - string - - - - El tamaño de cada segmento de memoria compartida dado en notación abreviada - como se indica en esta FAQ. - Por defecto, algunos sistemas (incluyendo la mayoría de las variantes de BSD) - tienen un límite muy bajo para el tamaño de un segmento de memoria compartida. - - - - - - apc.entries_hint - int - - - - Un "indicio" sobre el número de variables distintas que pueden ser almacenadas. - Poner a cero o en caso de duda omitir. - - - - - - apc.ttl - int - - - - Considerar que las entradas de caché sin TTL explícito son expiradas si no han sido consultadas desde hace tantos segundos. En efecto, esto permite que estas - entradas sean oportunamente eliminadas durante una inserción en el caché, - o antes de una eliminación completa. Tenga en cuenta que debido a que la eliminación es - oportunista, las entradas pueden seguir siendo legibles incluso si son - más antiguas que apc.ttl segundos. Este parámetro no tiene ningún - efecto sobre las entradas de caché para las cuales un TTL explícito está especificado. - - - - - - apc.gc_ttl - int - - - - El número de segundos durante los cuales una entrada de caché puede - permanecer en la lista de recolección de basura después de haber sido retirada o invalidada. - Las entradas son elegibles para eliminación si su número de referencias es cero, o si exceden este límite de tiempo. - Si se establece en 0, la limpieza basada en el tiempo está desactivada, - y las entradas solo se eliminan cuando su número de referencias cae a cero. - - - - - - apc.mmap_file_mask - string - - - - Si APCu ha sido compilado con la opción MMAP usando - --enable-mmap, este parámetro recibe la máscara de - fichero de tipo mktemp-style a pasar al módulo mmap para determinar - si la región de la memoria usando mmap será guardada a través - de un fichero o por la de la memoria compartida. - En el caso de que el guardado se haga a través de un fichero, - la máscara será de la forma /tmp/apc.XXXXXX - (con exactamente 6 X). - Para usar shm_open/mmap de la norma POSIX, la máscara debe contener - .shm, como en el siguiente ejemplo: - /apc.shm.XXXXXX. Este parámetro puede ser definido por - /dev/zero para usar la interfaz - /dev/zero del núcleo con una memoria usando mmap - anónimamente. Dejar este parámetro indefinido forzará un mmap anónimo. - - - - - - apc.slam_defense - bool - - - - Al inicio o durante la modificación de un fichero en un servidor - muy ocupado, varios procesos pueden entrar en competencia - para poner en caché el mismo fichero al mismo tiempo. - Configurar apc.slam_defense en 1 - puede ayudar a evitar que varios procesos pongan en caché - el mismo fichero simultáneamente introduciendo un mecanismo - de probabilidad. Si la misma clave es intentada ser puesta en caché - en un corto lapso de tiempo por diferentes procesos, salta - la puesta en caché para el proceso actual para mitigar los posibles - problemas de puesta en caché. - - - - - - apc.enable_cli - int - - - - Principalmente usado para pruebas y depuración. Definir este - parámetro permite activar APC en la versión CLI de PHP. - Normalmente, no es ideal crear, alimentar y - destruir el caché APC en cada solicitud CLI. Sin embargo, en muchos escenarios de prueba es útil poder activar - fácilmente APC en la versión CLI de PHP. - - - - - - apc.serializer - string - - - - Este parámetro permite a APC usar un serializador de terceros - - - - - - apc.coredump_unmap - bool - - - - Activa la gestión por APC de señales, tales como SIGSEGV, que provocan - la escritura de ficheros core dump cuando son recibidas. Cuando estas - señales son recibidas, APC intentará desasignar el segmento de memoria - compartida reservado a mmap con el objetivo de excluirlo del fichero core - dump. Esta opción puede mejorar la estabilidad del sistema cuando - se reciben señales fatales y APC está configurado con un largo - segmento de memoria compartida. - - - - Esta opción es potencialmente peligrosa. Desasignar un segmento de - memoria compartida usado por mmap en el gestor de señales - fatales puede causar un comportamiento impredecible si ocurre un error fatal. - - - - - Aunque algunos núcleos pueden proporcionar la posibilidad de ignorar - muchos tipos de memoria compartida cuando generan un fichero - core dump, estas implementaciones también pueden ignorar importantes - segmentos de memoria compartida como el tablero de Apache. - - - - - - - apc.preload_path - string - - - - Opcional, define una ruta hacia el directorio donde APC cargará - los datos del caché al inicio. - - - - - - - apc.use_request_time - bool - - - - Usa el tiempo de inicio de la solicitud de la interfaz SAPI - para la duración de vida (TTL). - - - - -
- diff --git a/reference/apcu/reference.xml b/reference/apcu/reference.xml deleted file mode 100644 index 456f9bd944..0000000000 --- a/reference/apcu/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - &Functions; APCu - - &reference.apcu.entities.functions; - - - - diff --git a/reference/apcu/setup.xml b/reference/apcu/setup.xml deleted file mode 100644 index 24c7072539..0000000000 --- a/reference/apcu/setup.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - &reftitle.setup; - -
- &reftitle.install; - - &pecl.info; - &url.pecl.package;apcu. - - - - PHP 7 cuenta con un módulo separado (apcu-bc) para garantizar la - retrocompatibilidad con APC. - - - En modo retrocompatibilidad, APCu registra las funciones APC aplicables con prototipos retrocompatibles. - - - Cuando una función APC acepta el argumento cache_type, este último es - ignorado por la versión retrocompatible de la función y omitido del prototipo de la versión APCu. - - - - - A partir de PHP 8.0.0, apcu-bc ya no es aceptado. - - - - - Con Windows, APCu requiere un directorio temporal en el que el servidor web esté autorizado a - escribir. Se verifican sucesivamente las variables de entorno TMP, TEMP y USERPROFILE en este orden y - se termina intentando el directorio WINDOWS si ninguna de estas variables ha sido definida. - - - - - Para obtener más detalles técnicos sobre la implementación, consúltese el - - archivo TECHNOTES proporcionado por los desarrolladores - . - - - - Las fuentes de APCu están disponibles aquí. - -
- - &reference.apcu.ini; - -
- diff --git a/reference/cmark/book.xml b/reference/cmark/book.xml deleted file mode 100644 index 6987f7d2a0..0000000000 --- a/reference/cmark/book.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - CommonMark - CommonMark - - - &reftitle.intro; - - Esta extensión proporciona acceso a la implementación de referencia de CommonMark, una versión racionalizada de la sintaxis de Markdown con una especificación. - - - Análisis sintáctico: - - La extensión CommonMark proporciona una sencilla API de análisis sintáctico: - - - - - Renderizado: - - La extensión CommonMark proporciona una sencilla API de renderizado que soporta múltiples formatos: - - - - - - - - - AST: - - La extensión CommonMark implementa la visitación de los objetos CommonMark\NNode: - - - - - CQL: - - La extensión CommonMark proporciona una interfaz para CQL, CommonMark Query Language: - - - - - - &reference.cmark.setup; - &reference.cmark.constants; - &reference.cmark.commonmark.node.document; - &reference.cmark.commonmark.node.heading; - &reference.cmark.commonmark.node.paragraph; - &reference.cmark.commonmark.node.blockquote; - &reference.cmark.commonmark.node.bulletlist; - &reference.cmark.commonmark.node.orderedlist; - &reference.cmark.commonmark.node.item; - &reference.cmark.commonmark.node.text; - &reference.cmark.commonmark.node.text.strong; - &reference.cmark.commonmark.node.text.emphasis; - &reference.cmark.commonmark.node.thematicbreak; - &reference.cmark.commonmark.node.softbreak; - &reference.cmark.commonmark.node.linebreak; - &reference.cmark.commonmark.node.code; - &reference.cmark.commonmark.node.codeblock; - &reference.cmark.commonmark.node.htmlblock; - &reference.cmark.commonmark.node.htmlinline; - &reference.cmark.commonmark.node.image; - &reference.cmark.commonmark.node.link; - &reference.cmark.commonmark.node.customblock; - &reference.cmark.commonmark.node.custominline; - &reference.cmark.commonmark.node; - &reference.cmark.commonmark.interfaces.ivisitor; - &reference.cmark.commonmark.interfaces.ivisitable; - &reference.cmark.commonmark.parser; - &reference.cmark.commonmark.cql; - &reference.cmark.reference; - - - diff --git a/reference/cmark/commonmark.cql.xml b/reference/cmark/commonmark.cql.xml deleted file mode 100644 index f80a711e5e..0000000000 --- a/reference/cmark/commonmark.cql.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - La clase CommonMark\CQL - CommonMark\CQL - - - - -
- &reftitle.intro; - - El CommonMark Query Language es un DSL para describir cómo viajar a través de un árbol de nodos CommonMark implementado como un analizador y un compilador para un pequeño conjunto de instrucciones, y una máquina virtual para ejecutar estas instrucciones. - - - Rutas: - - En su forma más simplista, una consulta CQL combina las siguientes rutas y / para describir cómo viajar a través de un árbol: - - firstChild - lastChild - previous - next - parent - - Por ejemplo, /firstChild/lastChild viaja al último nodo hijo del primer nodo hijo. - - - - Bucle - - CQL puede ser instruido para bucles, por ejemplo a través de los hijos de, o los hermanos de un nodo particular, utilizando la ruta children, o siblings. Por ejemplo, /firstChild/children viajará a todos los hijos del primer nodo hijo. - - - - Subconsultas - - CQL puede ser instruido para viajar utilizando una subconsulta como [/firstChild]. Por ejemplo, /firstChild/children[/firstChild] viajará al primer nodo hijo de todos los hijos del primer nodo hijo. - - - - Restricciones de bucle - - Al buclar, CQL puede ser instruido para restringir la ruta recorrida a los nodos de un tipo particular. Por ejemplo /children(BlockQuote) viajará a los hijos de un nodo donde el tipo es BlockQuote. Los siguientes tipos son reconocidos (insensibles a mayúsculas y minúsculas): - - BlockQuote - List - Item - CodeBlock - HtmlBlock - CustomBlock - Paragraph - Heading - ThematicBreak - Text - SoftBreak - LineBreak - Code - HtmlInline - CustomInline - Emphasis - Strong - Link - Image - - Los tipos pueden ser utilizados como una unión, por ejemplo /children(BlockQuote|List) viajará a los hijos de un nodo donde el tipo es BlockQuote o List. Los tipos, o uniones de tipos, también pueden ser negados. Por ejemplo /children(~BlockQuote) viajará a los hijos de un nodo donde el tipo no es BlockQuote, y /children(~BlockQuote|Paragraph) viajará a los hijos de un nodo donde el tipo no es BlockQuote o Paragraph. - - - - Restricciones de rutas - - CQL puede ser instruido para crear un bucle para viajar a un nodo de un tipo particular, a una ruta particular. Por ejemplo, /firstChild(BlockQuote) viajará al primer nodo hijo donde el tipo es BlockQuote. Tenga en cuenta que como otros bucles para children y siblings, este tipo de ruta solo puede ser seguido por una subconsulta. - - - - Notas de implementación - - Aunque CQL ha sido implementado como parte de la extensión PHP CommonMark, está separado de PHP y no utiliza la máquina virtual de PHP o la representación interna de los valores. - - -
- - -
- &reftitle.classsynopsis; - - - - CommonMark\CQL - - - - - CommonMark\CQL - - - - - &Constructor; - - - &Methods; - - - - -
- -
- - &reference.cmark.commonmark.cql.construct; - &reference.cmark.commonmark.cql.invoke; - -
- diff --git a/reference/cmark/commonmark.interfaces.ivisitable.xml b/reference/cmark/commonmark.interfaces.ivisitable.xml deleted file mode 100644 index 906f92db8f..0000000000 --- a/reference/cmark/commonmark.interfaces.ivisitable.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - La interfaz CommonMark\Interfaces\IVisitable - CommonMark\Interfaces\IVisitable - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - CommonMark\Interfaces\IVisitable - - - - - final - CommonMark\Interfaces\IVisitable - - - - - - - - -
- -
- - &reference.cmark.commonmark.interfaces.ivisitable.accept; - -
- diff --git a/reference/cmark/commonmark.interfaces.ivisitor.xml b/reference/cmark/commonmark.interfaces.ivisitor.xml deleted file mode 100644 index f846c78a7d..0000000000 --- a/reference/cmark/commonmark.interfaces.ivisitor.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - La interfaz CommonMark\Interfaces\IVisitor - CommonMark\Interfaces\IVisitor - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - CommonMark\Interfaces\IVisitor - - - - - final - CommonMark\Interfaces\IVisitor - - - - &Constants; - - const - int - CommonMark\Interfaces\IVisitor::Done - - - const - int - CommonMark\Interfaces\IVisitor::Enter - - - const - int - CommonMark\Interfaces\IVisitor::Leave - - - &Methods; - - - - -
- -
- - &reference.cmark.commonmark.interfaces.ivisitor.enter; - &reference.cmark.commonmark.interfaces.ivisitor.leave; - -
- diff --git a/reference/cmark/commonmark.node.blockquote.xml b/reference/cmark/commonmark.node.blockquote.xml deleted file mode 100644 index b60d184768..0000000000 --- a/reference/cmark/commonmark.node.blockquote.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - BlockQuote CommonMark\Node concreto - CommonMark\Node\BlockQuote - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\BlockQuote - - - - - final - CommonMark\Node\BlockQuote - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
- -
- -
- - diff --git a/reference/cmark/commonmark.node.bulletlist.xml b/reference/cmark/commonmark.node.bulletlist.xml deleted file mode 100644 index 63aabb4f01..0000000000 --- a/reference/cmark/commonmark.node.bulletlist.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - BulletList CommonMark\Node concreto - CommonMark\Node\BulletList - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\BulletList - - - - - final - CommonMark\Node\BulletList - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - - &InheritedProperties; - - - &Properties; - - public - bool - tight - - - public - int - delimiter - - -&Constructor; - - - &InheritedMethods; - - - - - -
- -
- - &reference.cmark.commonmark.node.bulletlist.construct; - -
- - diff --git a/reference/cmark/commonmark.node.code.xml b/reference/cmark/commonmark.node.code.xml deleted file mode 100644 index 1ad1debff4..0000000000 --- a/reference/cmark/commonmark.node.code.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - Código CommonMark\Node concreto - CommonMark\Node\Code - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\Code - - - - - final - CommonMark\Node\Code - - - - extends - CommonMark\Node\Text - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - - &Constructor; - - - &InheritedMethods; - - - - - -
- -
- -
- - diff --git a/reference/cmark/commonmark.node.codeblock.xml b/reference/cmark/commonmark.node.codeblock.xml deleted file mode 100644 index 24245512cc..0000000000 --- a/reference/cmark/commonmark.node.codeblock.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - CodeBlock CommonMark\Node concreto - CommonMark\Node\CodeBlock - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\CodeBlock - - - - - final - CommonMark\Node\CodeBlock - - - - extends - CommonMark\Node\Text - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - - &Properties; - - public - stringnull - fence - - - &Constructor; - - - - &InheritedMethods; - - - - - -
- -
- - &reference.cmark.commonmark.node.codeblock.construct; - -
- - diff --git a/reference/cmark/commonmark.node.customblock.xml b/reference/cmark/commonmark.node.customblock.xml deleted file mode 100644 index 2eff24c957..0000000000 --- a/reference/cmark/commonmark.node.customblock.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - CustomBlock CommonMark\Node concreto - CommonMark\Node\CustomBlock - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\CustomBlock - - - - - final - CommonMark\Node\CustomBlock - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - - &InheritedProperties; - - - &Properties; - - public - stringnull - onEnter - - - public - stringnull - onLeave - - - &InheritedMethods; - - - - - -
- -
- -
- - diff --git a/reference/cmark/commonmark.node.custominline.xml b/reference/cmark/commonmark.node.custominline.xml deleted file mode 100644 index 777184f741..0000000000 --- a/reference/cmark/commonmark.node.custominline.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - CustomInline CommonMark\Node concreto - CommonMark\Node\CustomInline - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\CustomInline - - - - - final - CommonMark\Node\CustomInline - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &Properties; - - public - stringnull - onEnter - - - public - stringnull - onLeave - - - &InheritedMethods; - - - - - -
- -
- -
- - diff --git a/reference/cmark/commonmark.node.document.xml b/reference/cmark/commonmark.node.document.xml deleted file mode 100644 index 1bfdac6e65..0000000000 --- a/reference/cmark/commonmark.node.document.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Documento CommonMark\Node concreto - CommonMark\Node\Document - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\Document - - - - - final - CommonMark\Node\Document - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
- -
- -
- - diff --git a/reference/cmark/commonmark.node.heading.xml b/reference/cmark/commonmark.node.heading.xml deleted file mode 100644 index e1567d9be9..0000000000 --- a/reference/cmark/commonmark.node.heading.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Encabezado CommonMark\Node concreto - CommonMark\Node\Heading - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\Heading - - - - - final - CommonMark\Node\Heading - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - - &InheritedProperties; - - - &Properties; - - public - int - level - - - &Constructor; - - - &InheritedMethods; - - - - - -
- -
- - &reference.cmark.commonmark.node.heading.construct; -
- - diff --git a/reference/cmark/commonmark.node.htmlblock.xml b/reference/cmark/commonmark.node.htmlblock.xml deleted file mode 100644 index ccd1940e19..0000000000 --- a/reference/cmark/commonmark.node.htmlblock.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - HTMLBlock CommonMark\Node concreto - CommonMark\Node\HTMLBlock - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\HTMLBlock - - - - - final - CommonMark\Node\HTMLBlock - - - - extends - CommonMark\Node\Text - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - - &Constructor; - - - &InheritedMethods; - - - - - -
- -
- -
- - diff --git a/reference/cmark/commonmark.node.htmlinline.xml b/reference/cmark/commonmark.node.htmlinline.xml deleted file mode 100644 index ed5715f37c..0000000000 --- a/reference/cmark/commonmark.node.htmlinline.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - HTMLInline CommonMark\Node concreto - CommonMark\Node\HTMLInline - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\HTMLInline - - - - - final - CommonMark\Node\HTMLInline - - - - extends - CommonMark\Node\Text - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - -&Constructor; - - - &InheritedMethods; - - - - - -
- -
- -
- - diff --git a/reference/cmark/commonmark.node.image.xml b/reference/cmark/commonmark.node.image.xml deleted file mode 100644 index d2887ecdc8..0000000000 --- a/reference/cmark/commonmark.node.image.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Imagen CommonMark\Node concreta - CommonMark\Node\Image - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\Image - - - - - final - CommonMark\Node\Image - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &Properties; - - public - stringnull - url - - - public - stringnull - title - - - &Constructor; - - - &InheritedMethods; - - - - - -
-
- - &reference.cmark.commonmark.node.image.construct; - -
- - diff --git a/reference/cmark/commonmark.node.item.xml b/reference/cmark/commonmark.node.item.xml deleted file mode 100644 index 5fec1ad86a..0000000000 --- a/reference/cmark/commonmark.node.item.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Item CommonMark\Node concreto - CommonMark\Node\Item - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\Item - - - - - final - CommonMark\Node\Item - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
- -
- -
- - diff --git a/reference/cmark/commonmark.node.linebreak.xml b/reference/cmark/commonmark.node.linebreak.xml deleted file mode 100644 index e6b6e8afd3..0000000000 --- a/reference/cmark/commonmark.node.linebreak.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - LineBreak CommonMark\Node concreto - CommonMark\Node\LineBreak - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\LineBreak - - - - - final - CommonMark\Node\LineBreak - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
- -
- -
- - diff --git a/reference/cmark/commonmark.node.link.xml b/reference/cmark/commonmark.node.link.xml deleted file mode 100644 index 4fe5b205e5..0000000000 --- a/reference/cmark/commonmark.node.link.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Link CommonMark\Node concreto - CommonMark\Node\Link - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\Link - - - - - final - CommonMark\Node\Link - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - - &InheritedProperties; - - - &Properties; - - public - stringnull - url - - - public - stringnull - title - - - &Constructor; - - - &InheritedMethods; - - - - - -
- -
- - &reference.cmark.commonmark.node.link.construct; - -
- - diff --git a/reference/cmark/commonmark.node.orderedlist.xml b/reference/cmark/commonmark.node.orderedlist.xml deleted file mode 100644 index ac2dc114f5..0000000000 --- a/reference/cmark/commonmark.node.orderedlist.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - OrderedList CommonMark\Node concreto - CommonMark\Node\OrderedList - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\OrderedList - - - - - final - CommonMark\Node\OrderedList - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &Properties; - - public - bool - tight - - - public - int - delimiter - - - public - int - start - - - &Constructor; - - - &InheritedMethods; - - - - - -
- -
- - &reference.cmark.commonmark.node.orderedlist.construct; - -
- - diff --git a/reference/cmark/commonmark.node.paragraph.xml b/reference/cmark/commonmark.node.paragraph.xml deleted file mode 100644 index cecd9aca4e..0000000000 --- a/reference/cmark/commonmark.node.paragraph.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Paragraph CommonMark\Node concreto - CommonMark\Node\Paragraph - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\Paragraph - - - - - final - CommonMark\Node\Paragraph - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
- -
- -
- - diff --git a/reference/cmark/commonmark.node.softbreak.xml b/reference/cmark/commonmark.node.softbreak.xml deleted file mode 100644 index 7701f644ff..0000000000 --- a/reference/cmark/commonmark.node.softbreak.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - SoftBreak CommonMark\Node concreto - CommonMark\Node\SoftBreak - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\SoftBreak - - - - - final - CommonMark\Node\SoftBreak - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
- -
- -
- - diff --git a/reference/cmark/commonmark.node.text.emphasis.xml b/reference/cmark/commonmark.node.text.emphasis.xml deleted file mode 100644 index 6ab350149c..0000000000 --- a/reference/cmark/commonmark.node.text.emphasis.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Énfasis CommonMark\Node concreto - CommonMark\Node\Text\Emphasis - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\Text\Emphasis - - - - - final - CommonMark\Node\Text\Emphasis - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
- -
- -
- - diff --git a/reference/cmark/commonmark.node.text.strong.xml b/reference/cmark/commonmark.node.text.strong.xml deleted file mode 100644 index 816475b273..0000000000 --- a/reference/cmark/commonmark.node.text.strong.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Strong CommonMark\Node concreto - CommonMark\Node\Text\Strong - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\Text\Strong - - - - - final - CommonMark\Node\Text\Strong - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
- -
- -
- - diff --git a/reference/cmark/commonmark.node.text.xml b/reference/cmark/commonmark.node.text.xml deleted file mode 100644 index 1f4720dc3f..0000000000 --- a/reference/cmark/commonmark.node.text.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Text CommonMark\Node concreto - CommonMark\Node\Text - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\Text - - - - - final - CommonMark\Node\Text - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &Properties; - - public - stringnull - literal - - - &Constructor; - - - &InheritedMethods; - - - - - -
- -
- - &reference.cmark.commonmark.node.text.construct; - -
- - diff --git a/reference/cmark/commonmark.node.thematicbreak.xml b/reference/cmark/commonmark.node.thematicbreak.xml deleted file mode 100644 index 4f19c51fbb..0000000000 --- a/reference/cmark/commonmark.node.thematicbreak.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - ThematicBreak CommonMark\Node concreto - CommonMark\Node\ThematicBreak - - - -
- &reftitle.classsynopsis; - - - - CommonMark\Node\ThematicBreak - - - - - final - CommonMark\Node\ThematicBreak - - - - extends - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
- -
- -
- - diff --git a/reference/cmark/commonmark.node.xml b/reference/cmark/commonmark.node.xml deleted file mode 100644 index 5c3282e9f8..0000000000 --- a/reference/cmark/commonmark.node.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - CommonMark\Node abstracto - CommonMark\Node - - - - -
- &reftitle.intro; - - Representa un nodo abstracto, esta clase abstracta final no está destinada a ser utilizada directamente por el desarrollador. - -
- - -
- &reftitle.classsynopsis; - - - - CommonMark\Node - - - - - final - abstract - CommonMark\Node - - - - CommonMark\Interfaces\IVisitable - - - - Traversable - - - - - &Properties; - - public - readonly - Nodenull - parent - - - public - readonly - Nodenull - previous - - - public - readonly - Nodenull - next - - - public - readonly - Nodenull - lastChild - - - public - readonly - Nodenull - firstChild - - - public - readonly - int - startLine - - - public - readonly - int - endLine - - - public - readonly - int - startColumn - - - public - readonly - int - endColumn - - - &Methods; - - - - -
- -
- - &reference.cmark.commonmark.node.appendchild; - &reference.cmark.commonmark.node.prependchild; - &reference.cmark.commonmark.node.insertafter; - &reference.cmark.commonmark.node.insertbefore; - &reference.cmark.commonmark.node.replace; - &reference.cmark.commonmark.node.unlink; - &reference.cmark.commonmark.node.accept; - -
- diff --git a/reference/cmark/commonmark.parser.xml b/reference/cmark/commonmark.parser.xml deleted file mode 100644 index da2c57daa5..0000000000 --- a/reference/cmark/commonmark.parser.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - La clase CommonMark\Parser - CommonMark\Parser - - - - -
- &reftitle.intro; - - Proporciona un analizador incremental como alternativa a la simple función de análisis de la API de análisis sintáctico - -
- - -
- &reftitle.classsynopsis; - - - - CommonMark\Parser - - - - - final - CommonMark\Parser - - - - - &Constructor; - - - &Methods; - - - - -
- -
- - &reference.cmark.commonmark.parser.construct; - &reference.cmark.commonmark.parser.parse; - &reference.cmark.commonmark.parser.finish; - -
- diff --git a/reference/cmark/commonmark/cql/construct.xml b/reference/cmark/commonmark/cql/construct.xml deleted file mode 100644 index 258fffc32c..0000000000 --- a/reference/cmark/commonmark/cql/construct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - CommonMark\CQL::__construct - Construcción de CQL - - - - &reftitle.description; - - public CommonMark\CQL::__construct - stringquery - - - - - - - - - &reftitle.parameters; - - - query - - - Una string CQL. - - - - - - - - diff --git a/reference/cmark/commonmark/cql/invoke.xml b/reference/cmark/commonmark/cql/invoke.xml deleted file mode 100644 index 9cc0c7b037..0000000000 --- a/reference/cmark/commonmark/cql/invoke.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - CommonMark\CQL::__invoke - Ejecución de CQL - - - - &reftitle.description; - - public CommonMark\CQL::__invoke - CommonMark\Noderoot - callablehandler - - - Debe invocar la función CQL actual en el root dado, - ejecutando el handler dado a la entrada de un CommonMark\Node - - - - - - &reftitle.parameters; - - - root - - el nodo raíz de un árbol - - - - handler - - - Debe tener el prototipo: - - boolnullhandler - CommonMark\Noderoot - CommonMark\Nodeentering - - - Si handler no devuelve (void), o devuelve null, el CQL continuará ejecutándose - Si el gestor devuelve un valor verdadero, el CQL continuará ejecutándose - Si el gestor devuelve un valor falso, el CQL se detendrá - - - - - - - - - diff --git a/reference/cmark/commonmark/interfaces/ivisitable/accept.xml b/reference/cmark/commonmark/interfaces/ivisitable/accept.xml deleted file mode 100644 index 2295bc5ef0..0000000000 --- a/reference/cmark/commonmark/interfaces/ivisitable/accept.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - CommonMark\Interfaces\IVisitable::accept - Visitación - - - - &reftitle.description; - - abstract public voidCommonMark\Interfaces\IVisitable::accept - CommonMark\Interfaces\IVisitorvisitor - - - - - - &reftitle.parameters; - - - visitor - - - Un objeto que implementa CommonMark\Interfaces\IVisitor - - - - - - - - &reftitle.seealso; - - - - - - - - diff --git a/reference/cmark/commonmark/interfaces/ivisitor/enter.xml b/reference/cmark/commonmark/interfaces/ivisitor/enter.xml deleted file mode 100644 index bab2147ccd..0000000000 --- a/reference/cmark/commonmark/interfaces/ivisitor/enter.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - CommonMark\Interfaces\IVisitor::enter - Visitación - - - - &reftitle.description; - - abstract public intIVisitablenullCommonMark\Interfaces\IVisitor::enter - IVisitablevisitable - - - - - - &reftitle.parameters; - - - visitable - - - El CommonMark\Interfaces\IVisitable actual en curso de entrada - - - - - - - - &reftitle.returnvalues; - - Devolver CommonMark\Interfaces\IVisitor::Done provocará la salida del iterador subyacente. - - - Devolver CommonMark\Interfaces\IVisitor::Enter reinicializará el iterador subyacente al entrar en el IVisitable actual - - - Devolver CommonMark\Interfaces\IVisitor::Leave reinicializará el iterador subyacente al salir del actual IVisitable - - - Devolver un IVisitable reinicializará el iterador subyacente al entrar en el IVisitable dado - - - No devolver nada permitirá que el iterador subyacente continúe - - - - - &reftitle.seealso; - - - - - - - diff --git a/reference/cmark/commonmark/interfaces/ivisitor/leave.xml b/reference/cmark/commonmark/interfaces/ivisitor/leave.xml deleted file mode 100644 index 3843421a93..0000000000 --- a/reference/cmark/commonmark/interfaces/ivisitor/leave.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - CommonMark\Interfaces\IVisitor::leave - Visitación - - - - &reftitle.description; - - abstract public intIVisitablenullCommonMark\Interfaces\IVisitor::leave - IVisitablevisitable - - - - - - &reftitle.parameters; - - - visitable - - - El CommonMark\Interfaces\IVisitable actual en curso de salida - - - - - - - - &reftitle.returnvalues; - - Devolver CommonMark\Interfaces\IVisitor::Done provocará la salida del iterador subyacente. - - - Devolver CommonMark\Interfaces\IVisitor::Enter reinicializará el iterador subyacente al entrar en el IVisitable actual - - - Devolver CommonMark\Interfaces\IVisitor::Leave reinicializará el iterador subyacente al salir del IVisitable actual - - - Devolver un IVisitable reinicializará el iterador subyacente al entrar en el IVisitable dado - - - No devolver nada permitirá al iterador subyacente continuar - - - - - &reftitle.seealso; - - - - - - - diff --git a/reference/cmark/commonmark/node/accept.xml b/reference/cmark/commonmark/node/accept.xml deleted file mode 100644 index ec9a685de2..0000000000 --- a/reference/cmark/commonmark/node/accept.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - CommonMark\Node::accept - Visitación - - - - &reftitle.description; - - public voidCommonMark\Node::accept - CommonMark\Interfaces\IVisitorvisitor - - - - - - &reftitle.parameters; - - - visitor - - - Un objeto implementando CommonMark\Interfaces\IVisitor - - - - - - - - &reftitle.seealso; - - - - - - - - diff --git a/reference/cmark/commonmark/node/appendchild.xml b/reference/cmark/commonmark/node/appendchild.xml deleted file mode 100644 index a7a8aa7dc5..0000000000 --- a/reference/cmark/commonmark/node/appendchild.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - CommonMark\Node::appendChild - Manipulación del AST - - - - &reftitle.description; - - public CommonMark\NodeCommonMark\Node::appendChild - CommonMark\Nodechild - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - child - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - diff --git a/reference/cmark/commonmark/node/bulletlist/construct.xml b/reference/cmark/commonmark/node/bulletlist/construct.xml deleted file mode 100644 index d4738a8708..0000000000 --- a/reference/cmark/commonmark/node/bulletlist/construct.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - CommonMark\Node\BulletList::__construct - Construcción de BulletList - - - - &reftitle.description; - - public CommonMark\Node\BulletList::__construct - - - - public CommonMark\Node\BulletList::__construct - inttight - - - public CommonMark\Node\BulletList::__construct - inttight - intdelimiter - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/cmark/commonmark/node/codeblock/construct.xml b/reference/cmark/commonmark/node/codeblock/construct.xml deleted file mode 100644 index 310aad2225..0000000000 --- a/reference/cmark/commonmark/node/codeblock/construct.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - CommonMark\Node\CodeBlock::__construct - Construcción de CodeBlock - - - - &reftitle.description; - - public CommonMark\Node\CodeBlock::__construct - stringfence - stringliteral - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - fence - - - - - - - - literal - - - - - - - - - - - - - diff --git a/reference/cmark/commonmark/node/heading/construct.xml b/reference/cmark/commonmark/node/heading/construct.xml deleted file mode 100644 index dfe44ce549..0000000000 --- a/reference/cmark/commonmark/node/heading/construct.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - CommonMark\Node\Heading::__construct - Construcción de Heading - - - - &reftitle.description; - - public CommonMark\Node\Heading::__construct - - - - public CommonMark\Node\Heading::__construct - intlevel - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/cmark/commonmark/node/image/construct.xml b/reference/cmark/commonmark/node/image/construct.xml deleted file mode 100644 index c3bcee72cb..0000000000 --- a/reference/cmark/commonmark/node/image/construct.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - CommonMark\Node\Image::__construct - Construcción de Image - - - - &reftitle.description; - - public CommonMark\Node\Image::__construct - - - - public CommonMark\Node\Image::__construct - stringurl - - - public CommonMark\Node\Image::__construct - stringurl - stringtitle - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - url - - - - - - - - title - - - - - - - - - - - - - diff --git a/reference/cmark/commonmark/node/insertafter.xml b/reference/cmark/commonmark/node/insertafter.xml deleted file mode 100644 index 741f2f8e70..0000000000 --- a/reference/cmark/commonmark/node/insertafter.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - CommonMark\Node::insertAfter - Manipulación del AST - - - - &reftitle.description; - - public CommonMark\NodeCommonMark\Node::insertAfter - CommonMark\Nodesibling - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - sibling - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - diff --git a/reference/cmark/commonmark/node/insertbefore.xml b/reference/cmark/commonmark/node/insertbefore.xml deleted file mode 100644 index bce9a398a8..0000000000 --- a/reference/cmark/commonmark/node/insertbefore.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - CommonMark\Node::insertBefore - Manipulación del AST - - - - &reftitle.description; - - public CommonMark\NodeCommonMark\Node::insertBefore - CommonMark\Nodesibling - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - sibling - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - diff --git a/reference/cmark/commonmark/node/link/construct.xml b/reference/cmark/commonmark/node/link/construct.xml deleted file mode 100644 index 29cfc91848..0000000000 --- a/reference/cmark/commonmark/node/link/construct.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - CommonMark\Node\Link::__construct - Construcción de Link - - - - &reftitle.description; - - public CommonMark\Node\Link::__construct - - - - public CommonMark\Node\Link::__construct - stringurl - - - public CommonMark\Node\Link::__construct - stringurl - stringtitle - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - url - - - - - - - - title - - - - - - - - - - - - - diff --git a/reference/cmark/commonmark/node/orderedlist/construct.xml b/reference/cmark/commonmark/node/orderedlist/construct.xml deleted file mode 100644 index 425181207d..0000000000 --- a/reference/cmark/commonmark/node/orderedlist/construct.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - CommonMark\Node\OrderedList::__construct - Constructor OrderedList - - - - &reftitle.description; - - public CommonMark\Node\OrderedList::__construct - - - - public CommonMark\Node\OrderedList::__construct - inttight - - - public CommonMark\Node\OrderedList::__construct - inttight - intdelimiter - - - public CommonMark\Node\OrderedList::__construct - inttight - intdelimiter - intstart - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - tight - - - - - - - - delimiter - - - - - - - - start - - - - - - - - - - - - - diff --git a/reference/cmark/commonmark/node/prependchild.xml b/reference/cmark/commonmark/node/prependchild.xml deleted file mode 100644 index c9823df59f..0000000000 --- a/reference/cmark/commonmark/node/prependchild.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - CommonMark\Node::prependChild - Manipulación del AST - - - - &reftitle.description; - - public CommonMark\NodeCommonMark\Node::prependChild - CommonMark\Nodechild - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - child - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - diff --git a/reference/cmark/commonmark/node/replace.xml b/reference/cmark/commonmark/node/replace.xml deleted file mode 100644 index da40166944..0000000000 --- a/reference/cmark/commonmark/node/replace.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - CommonMark\Node::replace - Manipulación del AST - - - - &reftitle.description; - - public CommonMark\NodeCommonMark\Node::replace - CommonMark\Nodetarget - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - target - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - diff --git a/reference/cmark/commonmark/node/text/construct.xml b/reference/cmark/commonmark/node/text/construct.xml deleted file mode 100644 index 4c3d342411..0000000000 --- a/reference/cmark/commonmark/node/text/construct.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - CommonMark\Node\Text::__construct - Construcción de Text - - - - &reftitle.description; - - public CommonMark\Node\Text::__construct - - - - public CommonMark\Node\Text::__construct - stringliteral - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - literal - - - - - - - - - - - - - diff --git a/reference/cmark/commonmark/node/unlink.xml b/reference/cmark/commonmark/node/unlink.xml deleted file mode 100644 index d2f2e7edf4..0000000000 --- a/reference/cmark/commonmark/node/unlink.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - CommonMark\Node::unlink - Manipulación del AST - - - - &reftitle.description; - - public voidCommonMark\Node::unlink - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - diff --git a/reference/cmark/commonmark/parser/construct.xml b/reference/cmark/commonmark/parser/construct.xml deleted file mode 100644 index 67572247f0..0000000000 --- a/reference/cmark/commonmark/parser/construct.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - CommonMark\Parser::__construct - Analizar - - - - &reftitle.description; - - public CommonMark\Parser::__construct - intoptions - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - options - - - Una máscara de: - - - - - CommonMark\Parser\Normal - (int) - - - - - - - - - CommonMark\Parser\Normalize - (int) - - - - - - - - - CommonMark\Parser\ValidateUTF8 - (int) - - - - - - - - - CommonMark\Parser\Smart - (int) - - - - - - - - - - - - - - diff --git a/reference/cmark/commonmark/parser/finish.xml b/reference/cmark/commonmark/parser/finish.xml deleted file mode 100644 index af6f20511f..0000000000 --- a/reference/cmark/commonmark/parser/finish.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - CommonMark\Parser::finish - Analizar - - - - &reftitle.description; - - public CommonMark\NodeCommonMark\Parser::finish - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - diff --git a/reference/cmark/commonmark/parser/parse.xml b/reference/cmark/commonmark/parser/parse.xml deleted file mode 100644 index 00901823e7..0000000000 --- a/reference/cmark/commonmark/parser/parse.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - CommonMark\Parser::parse - Analizar - - - - &reftitle.description; - - public voidCommonMark\Parser::parse - stringbuffer - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - buffer - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - diff --git a/reference/cmark/configure.xml b/reference/cmark/configure.xml deleted file mode 100644 index 602ed719cd..0000000000 --- a/reference/cmark/configure.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - -
- &reftitle.install; - - - Utilice durante la compilación de PHP. - - - - Los usuarios de Windows deben incluir php_cmark.dll en &php.ini;. - - -
- diff --git a/reference/cmark/constants.xml b/reference/cmark/constants.xml deleted file mode 100644 index aa9e11d6fe..0000000000 --- a/reference/cmark/constants.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - &reftitle.constants; - - - - CommonMark\Parser\Normal - (int) - - - - - - - - - CommonMark\Parser\Normalize - (int) - - - - - - - - - CommonMark\Parser\Smart - (int) - - - - - - - - - CommonMark\Parser\ValidateUTF8 - (int) - - - - - - - - - CommonMark\Render\HardBreaks - (int) - - - - - - - - - CommonMark\Render\NoBreaks - (int) - - - - - - - - - CommonMark\Render\Normal - (int) - - - - - - - - - CommonMark\Render\Safe - (int) - - - - - - - - - CommonMark\Render\SourcePos - (int) - - - - - - - - - diff --git a/reference/cmark/functions/commonmark.parse.xml b/reference/cmark/functions/commonmark.parse.xml deleted file mode 100644 index 0018e7e723..0000000000 --- a/reference/cmark/functions/commonmark.parse.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - CommonMark\Parse - Análisis sintáctico - - - - &reftitle.description; - - CommonMark\NodeCommonMark\Parse - stringcontent - intoptions - - - Deberá analizar content - - - - - - &reftitle.parameters; - - - content - - - reducción de la carga string - - - - - options - - - Una máscara de: - - - - - CommonMark\Parser\Normal - (int) - - - - - - - - - CommonMark\Parser\Normalize - (int) - - - - - - - - - CommonMark\Parser\ValidateUTF8 - (int) - - - - - - - - - CommonMark\Parser\Smart - (int) - - - - - - - - - - - - - - &reftitle.returnvalues; - - Devolverá la raíz de CommonMark\Node - - - - - - diff --git a/reference/cmark/functions/commonmark.render.html.xml b/reference/cmark/functions/commonmark.render.html.xml deleted file mode 100644 index cce53ae346..0000000000 --- a/reference/cmark/functions/commonmark.render.html.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - CommonMark\Render\HTML - Genera un renderizado - - - - &reftitle.description; - - stringCommonMark\Render\HTML - CommonMark\Nodenode - intoptions - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - node - - - - - - - - options - - - Una máscara de: - - - - - CommonMark\Render\Normal - (int) - - - - - - - - - CommonMark\Render\SourcePos - (int) - - - - - - - - - CommonMark\Render\HardBreaks - (int) - - - - - - - - - CommonMark\Render\Safe - (int) - - - - - - - - - CommonMark\Render\NoBreaks - (int) - - - - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - diff --git a/reference/cmark/functions/commonmark.render.latex.xml b/reference/cmark/functions/commonmark.render.latex.xml deleted file mode 100644 index 0fec914f16..0000000000 --- a/reference/cmark/functions/commonmark.render.latex.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - CommonMark\Render\Latex - Genera un renderizado - - - - &reftitle.description; - - stringCommonMark\Render\Latex - CommonMark\Nodenode - intoptions - intwidth - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - node - - - - - - - - options - - - Una máscara de: - - - - - CommonMark\Render\Normal - (int) - - - - - - - - - CommonMark\Render\SourcePos - (int) - - - - - - - - - CommonMark\Render\HardBreaks - (int) - - - - - - - - - CommonMark\Render\Safe - (int) - - - - - - - - - CommonMark\Render\NoBreaks - (int) - - - - - - - - - - - width - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - diff --git a/reference/cmark/functions/commonmark.render.man.xml b/reference/cmark/functions/commonmark.render.man.xml deleted file mode 100644 index 16e3d61fd0..0000000000 --- a/reference/cmark/functions/commonmark.render.man.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - CommonMark\Render\Man - Genera un renderizado - - - - &reftitle.description; - - stringCommonMark\Render\Man - CommonMark\Nodenode - intoptions - intwidth - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - node - - - - - - - - options - - - Una máscara de: - - - - - CommonMark\Render\Normal - (int) - - - - - - - - - CommonMark\Render\SourcePos - (int) - - - - - - - - - CommonMark\Render\HardBreaks - (int) - - - - - - - - - CommonMark\Render\Safe - (int) - - - - - - - - - CommonMark\Render\NoBreaks - (int) - - - - - - - - - - - width - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - diff --git a/reference/cmark/functions/commonmark.render.xml b/reference/cmark/functions/commonmark.render.xml deleted file mode 100644 index 0a630e1458..0000000000 --- a/reference/cmark/functions/commonmark.render.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - CommonMark\Render - Genera un renderizado - - - - &reftitle.description; - - stringCommonMark\Render - CommonMark\Nodenode - intoptions - intwidth - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - node - - - - - - - - options - - - Una máscara de: - - - - - CommonMark\Render\Normal - (int) - - - - - - - - - CommonMark\Render\SourcePos - (int) - - - - - - - - - CommonMark\Render\HardBreaks - (int) - - - - - - - - - CommonMark\Render\Safe - (int) - - - - - - - - - CommonMark\Render\NoBreaks - (int) - - - - - - - - - - - width - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - diff --git a/reference/cmark/functions/commonmark.render.xml.xml b/reference/cmark/functions/commonmark.render.xml.xml deleted file mode 100644 index e43d342ca3..0000000000 --- a/reference/cmark/functions/commonmark.render.xml.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - CommonMark\Render\XML - Genera un rendimiento - - - - &reftitle.description; - - stringCommonMark\Render\XML - CommonMark\Nodenode - intoptions - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - node - - - - - - - - options - - - Una máscara de: - - - - - CommonMark\Render\Normal - (int) - - - - - - - - - CommonMark\Render\SourcePos - (int) - - - - - - - - - CommonMark\Render\HardBreaks - (int) - - - - - - - - - CommonMark\Render\Safe - (int) - - - - - - - - - CommonMark\Render\NoBreaks - (int) - - - - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - diff --git a/reference/cmark/reference.xml b/reference/cmark/reference.xml deleted file mode 100644 index 530e856b47..0000000000 --- a/reference/cmark/reference.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - - - &Functions; de CommonMark - - &reference.cmark.functions.commonmark.parse; - &reference.cmark.functions.commonmark.render; - &reference.cmark.functions.commonmark.render.html; - &reference.cmark.functions.commonmark.render.latex; - &reference.cmark.functions.commonmark.render.man; - &reference.cmark.functions.commonmark.render.xml; - - - - diff --git a/reference/cmark/setup.xml b/reference/cmark/setup.xml deleted file mode 100644 index 98545ceadf..0000000000 --- a/reference/cmark/setup.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - &reftitle.setup; - -
- &reftitle.required; - - La extensión CommonMark requiere la implementación de referencia (C) de cmark. - -
- -
- &reftitle.install; - - Las versiones de la extensión CommonMark están alojadas por PECL y el código fuente está alojado en - github, - la ruta de instalación más simple es la ruta PECL normal : - &url.pecl.package;cmark. - - - Los usuarios de Windows pueden descargar binarios de versiones precompiladas desde el sitio PECL. - - - - Los usuarios de Windows deben tomar la medida adicional de añadir cmark.dll (distribuido con las versiones de Windows) a su PATH. - - - -
- -
- diff --git a/reference/componere/book.xml b/reference/componere/book.xml deleted file mode 100644 index d55853c398..0000000000 --- a/reference/componere/book.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Componere - Componere - - - &reftitle.intro; - - Componere (latin, English: compose) se dirige a los entornos de producción y proporciona una API para - composición de las clases, parches y moldeado. - - - Composición: - - Componere\Definition se utiliza para definir (o redefinir) una clase en tiempo de ejecución; - La clase puede entonces registrarse, y en caso de redefinición reemplaza a la clase original - durante todo el tiempo que la clase Componere\Definition exista. - - - - - - Parcheado: - - Componere\Patch se utiliza para cambiar la clase de una instancia específica de un objeto en tiempo de ejecución; - Tras su aplicación, el parche permanecerá aplicado durante todo el tiempo que la clase Componere\Patch exista, y puede ser revertido explícitamente. - - - - - - Moldeado: - - Componere\ Las funciones de moldeado pueden moldear entre tipos compatibles definidos por el usuario; - Donde compatible significa Type es sub o super al tipo de object. - - - - - - - - &reference.componere.setup; - &reference.componere.componere.abstract.definition; - &reference.componere.componere.definition; - &reference.componere.componere.patch; - &reference.componere.componere.method; - &reference.componere.componere.value; - &reference.componere.reference; - - diff --git a/reference/componere/componere.abstract.definition.xml b/reference/componere/componere.abstract.definition.xml deleted file mode 100644 index efb5003f82..0000000000 --- a/reference/componere/componere.abstract.definition.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - La clase Componere\Abstract\Definition - Componere\Abstract\Definition - - - - -
- &reftitle.intro; - - Esta abstracta final representa una entrada de clase, y no debe ser usado por el programador. - -
- - -
- &reftitle.classsynopsis; - - - - Componere\Abstract\Definition - - - - - final - abstract - Componere\Abstract\Definition - - - - - &Methods; - - - - -
- -
- - &reference.componere.componere.abstract.entities.definition; - -
- diff --git a/reference/componere/componere.definition.xml b/reference/componere/componere.definition.xml deleted file mode 100644 index 46a7af7b0d..0000000000 --- a/reference/componere/componere.definition.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - - La clase Componere\Definition - Componere\Definition - - - - -
- &reftitle.intro; - - La clase Definition permite al programador construir y registrar un tipo en tiempo de ejecución. - - - En caso de que una Definition reemplace una clase existente, la clase existente será restaurada cuando la Definition sea destruida. - -
- - -
- &reftitle.classsynopsis; - - - - - Componere\Definition - - - - - - final - Componere\Definition - - - - extends - Componere\Abstract\Definition - - - - - Constructores - - - &Methods; - - - &InheritedMethods; - - - - - -
- -
- - &reference.componere.componere.definition.construct; - &reference.componere.componere.definition.addconstant; - &reference.componere.componere.definition.addproperty; - &reference.componere.componere.definition.register; - &reference.componere.componere.definition.isregistered; - &reference.componere.componere.definition.getclosure; - &reference.componere.componere.definition.getclosures; -
- diff --git a/reference/componere/componere.method.xml b/reference/componere/componere.method.xml deleted file mode 100644 index 8b4c8a4d1c..0000000000 --- a/reference/componere/componere.method.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - La clase Componere\Method - Componere\Method - - - - -
- &reftitle.intro; - - Un método representa una función con banderas de accesibilidad modificables - -
- - -
- &reftitle.classsynopsis; - - - - Componere\Method - - - - - final - Componere\Method - - - - - Constructor - - - &Methods; - - - - -
- -
- - &reference.componere.componere.method.construct; - &reference.componere.componere.method.setprivate; - &reference.componere.componere.method.setprotected; - &reference.componere.componere.method.setstatic; - &reference.componere.componere.method.getreflector; - -
- diff --git a/reference/componere/componere.patch.xml b/reference/componere/componere.patch.xml deleted file mode 100644 index e90696fa3d..0000000000 --- a/reference/componere/componere.patch.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - La clase Componere\Patch - Componere\Patch - - - - -
- &reftitle.intro; - - La clase Patch permite al programador cambiar el tipo de una instancia en tiempo de ejecución sin registrar una nueva Definition - - - Cuando se destruye un parche se revierte, de modo que los casos que fueron parcheados durante la vida del Parche son restaurados a su tipo formal. - -
- - -
- &reftitle.classsynopsis; - - - - Componere\Patch - - - - - final - Componere\Patch - - - - extends - Componere\Abstract\Definition - - - - - Constructores - - - &Methods; - - - &InheritedMethods; - - - - - -
- -
- - &reference.componere.componere.patch.construct; - &reference.componere.componere.patch.apply; - &reference.componere.componere.patch.revert; - &reference.componere.componere.patch.isapplied; - &reference.componere.componere.patch.derive; - &reference.componere.componere.patch.getclosure; - &reference.componere.componere.patch.getclosures; - -
- diff --git a/reference/componere/componere.value.xml b/reference/componere/componere.value.xml deleted file mode 100644 index 00d4ce8da4..0000000000 --- a/reference/componere/componere.value.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - La clase Componere\Value - Componere\Value - - - - -
- &reftitle.intro; - - Una clase Value representa una variable PHP de todos los tipos, incluyendo las indefinidas - -
- - -
- &reftitle.classsynopsis; - - - - Componere\Value - - - - - final - Componere\Value - - - - - Constructor - - - &Methods; - - - - -
- -
- - &reference.componere.componere.value.construct; - &reference.componere.componere.value.setprivate; - &reference.componere.componere.value.setprotected; - &reference.componere.componere.value.setstatic; - &reference.componere.componere.value.isprivate; - &reference.componere.componere.value.isprotected; - &reference.componere.componere.value.isstatic; - &reference.componere.componere.value.hasdefault; - -
- diff --git a/reference/componere/componere/abstract/definition/addinterface.xml b/reference/componere/componere/abstract/definition/addinterface.xml deleted file mode 100644 index ea2ab78f3f..0000000000 --- a/reference/componere/componere/abstract/definition/addinterface.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - Componere\Abstract\Definition::addInterface - Añadir Interface - - - - &reftitle.description; - - public DefinitionComponere\Abstract\Definition::addInterface - stringinterface - - - Implementará la interface dada en la definición actual - - - - - - &reftitle.parameters; - - - interface - - - El nombre de una interface insensible a las mayúsculas y minúsculas - - - - - - - - &reftitle.returnvalues; - - La definición actual - - - - - Excepciones - - - Lanzará RuntimeException si Definition se registró - - - - - - diff --git a/reference/componere/componere/abstract/definition/addmethod.xml b/reference/componere/componere/abstract/definition/addmethod.xml deleted file mode 100644 index 87e53b6eb2..0000000000 --- a/reference/componere/componere/abstract/definition/addmethod.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Componere\Abstract\Definition::addMethod - Añadir método - - - - &reftitle.description; - - public DefinitionComponere\Abstract\Definition::addMethod - stringname - Componere\Methodmethod - - - Creará o anulará un método en la definición actual. - - - - - - &reftitle.parameters; - - - name - - - El nombre del método insensible a las mayúsculas y minúsculas - - - - - method - - - Componere\Method que no se haya añadido previamente a otra Definition - - - - - - - - &reftitle.returnvalues; - - La Definition actual - - - - - Excepciones - - - Lanzará RuntimeException si Definition se registró - - - - - Lanzará RuntimeException si el método se añadió a otra definición - - - - - - - diff --git a/reference/componere/componere/abstract/definition/addtrait.xml b/reference/componere/componere/abstract/definition/addtrait.xml deleted file mode 100644 index 673d3081e8..0000000000 --- a/reference/componere/componere/abstract/definition/addtrait.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - Componere\Abstract\Definition::addTrait - Añadir rasgo - - - - &reftitle.description; - - public DefinitionComponere\Abstract\Definition::addTrait - stringtrait - - - Usará el rasgo dado para la definición actual - - - - - - &reftitle.parameters; - - - trait - - - El nombre del rasgo insensible a las mayúsculas y minúsculas - - - - - - - - &reftitle.returnvalues; - - La definición actual - - - - - Excepciones - - - Lanzará RuntimeException si Definition se registró - - - - - - - diff --git a/reference/componere/componere/abstract/definition/getreflector.xml b/reference/componere/componere/abstract/definition/getreflector.xml deleted file mode 100644 index e347456542..0000000000 --- a/reference/componere/componere/abstract/definition/getreflector.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - Componere\Abstract\Definition::getReflector - Reflection - - - - &reftitle.description; - - public ReflectionClassComponere\Abstract\Definition::getReflector - - - - Creará o devolverá una clase Reflection - - - - - - &reftitle.returnvalues; - - Una clase Reflection para la definición actual (en caché) - - - - - - diff --git a/reference/componere/componere/definition/addconstant.xml b/reference/componere/componere/definition/addconstant.xml deleted file mode 100644 index ea146583de..0000000000 --- a/reference/componere/componere/definition/addconstant.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - Componere\Definition::addConstant - Añade constante - - - - &reftitle.description; - - public DefinitionComponere\Definition::addConstant - stringname - Componere\Valuevalue - - - Declarará una constante de clase en la definición actual - - - - - &reftitle.parameters; - - - name - - - El nombre de la constante que distingue entre mayúsculas y minúsculas - - - - - value - - - El valor de la constante, no debe ser indefinido o estático - - - - - - - - &reftitle.returnvalues; - - La definición actual - - - - - Excepciones - - - Lanzará RuntimeException si Definition fué registrado - - - - - Lanzará RuntimeException si name ya está declarada como una constante - - - - - Lanzará RuntimeException si value es estática - - - - - Lanzará RuntimeException si value no está definida - - - - - - diff --git a/reference/componere/componere/definition/addproperty.xml b/reference/componere/componere/definition/addproperty.xml deleted file mode 100644 index 02bbc7405c..0000000000 --- a/reference/componere/componere/definition/addproperty.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Componere\Definition::addProperty - Añade propiedad - - - - &reftitle.description; - - public DefinitionComponere\Definition::addProperty - stringname - Componere\Valuevalue - - - Declarará una propiedad de clase sobre la definición actual - - - - - - &reftitle.parameters; - - - name - - - El nombre de la propiedad distingue mayúsculas y minúsculas - - - - - value - - - El valor por omisión de la propiedad - - - - - - - - &reftitle.returnvalues; - - La definición actual - - - - - Excepciones - - - Lanzará RuntimeException si Definition se registró - - - - - Lanzará RuntimeException si name ya está declarada como una propiedad - - - - - - diff --git a/reference/componere/componere/definition/construct.xml b/reference/componere/componere/definition/construct.xml deleted file mode 100644 index b323ac7e33..0000000000 --- a/reference/componere/componere/definition/construct.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - Componere\Definition::__construct - Constructor Definition - - - - &reftitle.description; - - public Componere\Definition::__construct - stringname - - - - public Componere\Definition::__construct - stringname - stringparent - - - - public Componere\Definition::__construct - stringname - arrayinterfaces - - - - public Componere\Definition::__construct - stringname - stringparent - arrayinterfaces - - - - - - &reftitle.parameters; - - - name - - - Un nombre de clase insensible a las mayúsculas y minúsculas - - - - - parent - - - Un nombre de clase insensible a las mayúsculas y minúsculas - - - - - interfaces - - - Un array de nombres de clase insensibles a las mayúsculas y minúsculas - - - - - - - - Excepciones - - - Lanzará InvalidArgumentException si se intenta reemplazar una clase interna - - - - - Lanzará InvalidArgumentException si se intenta sustituir una interface - - - - - Lanzará InvalidArgumentException si se intenta reemplazar un rasgo - - - - - Lanzará RuntimeException si una clase en interfaces no se puede encontrar - - - - - Lanzará RuntimeException si una clase en interfaces no es una interface - - - - - - diff --git a/reference/componere/componere/definition/getclosure.xml b/reference/componere/componere/definition/getclosure.xml deleted file mode 100644 index 7e51d3441b..0000000000 --- a/reference/componere/componere/definition/getclosure.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - Componere\Definition::getClosure - Obtener Cierre - - - - &reftitle.description; - - public ClosureComponere\Definition::getClosure - stringname - - - Devolverá un cierre para el método especificado por el nombre - - - - - - &reftitle.parameters; - - - name - - - El nombre del método insensible a las mayúsculas y minúsculas - - - - - - - - &reftitle.returnvalues; - - Un cierre vinculado al alcance correcto - - - - - Excepciones - - - Lanzará RuntimeException si Definition se registró - - - - - Lanzará RuntimeException si name no se pudo encontrar - - - - - - diff --git a/reference/componere/componere/definition/getclosures.xml b/reference/componere/componere/definition/getclosures.xml deleted file mode 100644 index a0f9bc6700..0000000000 --- a/reference/componere/componere/definition/getclosures.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - Componere\Definition::getClosures - Obtener Cierres - - - - &reftitle.description; - - public arrayComponere\Definition::getClosures - - - - Devolverá un array de cierres - - - - - - &reftitle.returnvalues; - - Devolverá todos los métodos como un array de objetos de cierre vinculados al alcance correcto - - - - - Excepciones - - - Lanzará RuntimeException si Definition se registró - - - - - - diff --git a/reference/componere/componere/definition/isregistered.xml b/reference/componere/componere/definition/isregistered.xml deleted file mode 100644 index 361d94b9e8..0000000000 --- a/reference/componere/componere/definition/isregistered.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - - Componere\Definition::isRegistered - Detección del estado - - - - &reftitle.description; - - public boolComponere\Definition::isRegistered - - - - Deberá detectar el estado de registro de Definition - - - - - &reftitle.returnvalues; - - Devolverá true si Definition está registrada - - - - - - diff --git a/reference/componere/componere/definition/register.xml b/reference/componere/componere/definition/register.xml deleted file mode 100644 index 7753058723..0000000000 --- a/reference/componere/componere/definition/register.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - Componere\Definition::register - Registro - - - - &reftitle.description; - - public voidComponere\Definition::register - - - - Registrará la Definition actual - - - - - - Excepciones - - - Lanzará RuntimeException si Definition fué registrada - - - - - - diff --git a/reference/componere/componere/method/construct.xml b/reference/componere/componere/method/construct.xml deleted file mode 100644 index 2bd5676ef9..0000000000 --- a/reference/componere/componere/method/construct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Componere\Method::__construct - Constructor Method - - - - &reftitle.description; - - public Componere\Method::__construct - Closureclosure - - - - - - &reftitle.parameters; - - - closure - - - - - - - - - - - - - diff --git a/reference/componere/componere/method/getreflector.xml b/reference/componere/componere/method/getreflector.xml deleted file mode 100644 index 8aaaf820b6..0000000000 --- a/reference/componere/componere/method/getreflector.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - Componere\Method::getReflector - Reflection - - - - &reftitle.description; - - public ReflectionMethodComponere\Method::getReflector - - - - Creará o devolverá un Método de Reflection - - - - - &reftitle.returnvalues; - - Un método de Reflection para el método actual (en caché) - - - - - - diff --git a/reference/componere/componere/method/setprivate.xml b/reference/componere/componere/method/setprivate.xml deleted file mode 100644 index 764116306a..0000000000 --- a/reference/componere/componere/method/setprivate.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - Componere\Method::setPrivate - Modificación de la accesibilidad - - - - &reftitle.description; - - public MethodComponere\Method::setPrivate - - - - - - &reftitle.returnvalues; - - El método actual - - - - - Excepciones - - - Lanzará RuntimeException si el nivel de acceso fue establecido previamente - - - - - - diff --git a/reference/componere/componere/method/setprotected.xml b/reference/componere/componere/method/setprotected.xml deleted file mode 100644 index 372adf0550..0000000000 --- a/reference/componere/componere/method/setprotected.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - Componere\Method::setProtected - Modificación de la accesibilidad - - - - &reftitle.description; - - public MethodComponere\Method::setProtected - - - - - - &reftitle.returnvalues; - - El método actual - - - - - Excepciones - - - Lanzará RuntimeException si el nivel de acceso fue establecido previamente - - - - - - - diff --git a/reference/componere/componere/method/setstatic.xml b/reference/componere/componere/method/setstatic.xml deleted file mode 100644 index 6354d88d64..0000000000 --- a/reference/componere/componere/method/setstatic.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - Componere\Method::setStatic - Modificación de la accesibilidad - - - - &reftitle.description; - - public MethodComponere\Method::setStatic - - - - - - &reftitle.returnvalues; - - El método actual - - - - - - diff --git a/reference/componere/componere/patch/apply.xml b/reference/componere/componere/patch/apply.xml deleted file mode 100644 index 937ec45143..0000000000 --- a/reference/componere/componere/patch/apply.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - Componere\Patch::apply - Aplicación - - - - &reftitle.description; - - public voidComponere\Patch::apply - - - - Aplicará el parche actual - - - - - - - diff --git a/reference/componere/componere/patch/construct.xml b/reference/componere/componere/patch/construct.xml deleted file mode 100644 index eaae265391..0000000000 --- a/reference/componere/componere/patch/construct.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - Componere\Patch::__construct - Constructor Patch - - - - &reftitle.description; - - public Componere\Patch::__construct - objectinstance - - - public Componere\Patch::__construct - objectinstance - arrayinterfaces - - - - - - &reftitle.parameters; - - - instance - - - El objetivo de este Patch - - - - - interfaces - - - Un array de nombres de clase insensibles a las mayúsculas y minúsculas - - - - - - - - Excepciones - - - Lanzará RuntimeException si una clase en interfaces no se puede encontrar - - - - - Lanzará RuntimeException si una clase en interfaces no es una interface - - - - - - diff --git a/reference/componere/componere/patch/derive.xml b/reference/componere/componere/patch/derive.xml deleted file mode 100644 index 3e3d184541..0000000000 --- a/reference/componere/componere/patch/derive.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - Componere\Patch::derive - Derivación del parche - - - - &reftitle.description; - - public PatchComponere\Patch::derive - objectinstance - - - Derivará un Patch (parche) para la instance (instancia) dada - - - - - - &reftitle.parameters; - - - instance - - - El objetivo del Parche derivado - - - - - - - - &reftitle.returnvalues; - - Patch (parche) para la instance (instancia) derivada del Patch (parche) actual - - - - - Excepciones - - - Lanzará InvalidArgumentException si instance no es compatible - - - - - - diff --git a/reference/componere/componere/patch/getclosure.xml b/reference/componere/componere/patch/getclosure.xml deleted file mode 100644 index 632e7198b2..0000000000 --- a/reference/componere/componere/patch/getclosure.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - Componere\Patch::getClosure - Obtener Cierre - - - - &reftitle.description; - - public ClosureComponere\Patch::getClosure - stringname - - - Devolverá un cierre para el método especificado por el nombre - - - - - - &reftitle.parameters; - - - name - - - El nombre del método insensible a las mayúsculas y minúsculas - - - - - - - - &reftitle.returnvalues; - - Un cierre vinculado al ámbito y objeto correctos - - - - - Excepciones - - - Lanzará RuntimeException si name no se pudo encontrar - - - - - - diff --git a/reference/componere/componere/patch/getclosures.xml b/reference/componere/componere/patch/getclosures.xml deleted file mode 100644 index 715c8aab75..0000000000 --- a/reference/componere/componere/patch/getclosures.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - Componere\Patch::getClosures - Obtener Cierres - - - - &reftitle.description; - - public arrayComponere\Patch::getClosures - - - - Devolverá un array de Cierres - - - - - - &reftitle.returnvalues; - - Devolverá todos los métodos como un array de objetos de cierre unidos al ámbito y objeto correctos - - - - - - diff --git a/reference/componere/componere/patch/isapplied.xml b/reference/componere/componere/patch/isapplied.xml deleted file mode 100644 index df7556e979..0000000000 --- a/reference/componere/componere/patch/isapplied.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - - - Componere\Patch::isApplied - Detección del estado - - - - &reftitle.description; - - public boolComponere\Patch::isApplied - - - - - - - - diff --git a/reference/componere/componere/patch/revert.xml b/reference/componere/componere/patch/revert.xml deleted file mode 100644 index 0ed7ac84e6..0000000000 --- a/reference/componere/componere/patch/revert.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - - Componere\Patch::revert - Reversión - - - - &reftitle.description; - - public voidComponere\Patch::revert - - - - Revertirá el parche actual - - - - - - diff --git a/reference/componere/componere/value/construct.xml b/reference/componere/componere/value/construct.xml deleted file mode 100644 index 4544a154ad..0000000000 --- a/reference/componere/componere/value/construct.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - Componere\Value::__construct - Constructor Value - - - - &reftitle.description; - - public Componere\Value::__construct - mixeddefault - - - - - - - - - &reftitle.parameters; - - - default - - - - - - - - - - - Excepciones - - - Lanzará InvalidArgumentException si default no tiene un valor adecuado - - - - - - - - diff --git a/reference/componere/componere/value/hasdefault.xml b/reference/componere/componere/value/hasdefault.xml deleted file mode 100644 index 009d084df2..0000000000 --- a/reference/componere/componere/value/hasdefault.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - Componere\Value::hasDefault - Interacción de Value - - - - &reftitle.description; - - public boolComponere\Value::hasDefault - - - - - - - - - - - diff --git a/reference/componere/componere/value/isprivate.xml b/reference/componere/componere/value/isprivate.xml deleted file mode 100644 index f174a3f2d6..0000000000 --- a/reference/componere/componere/value/isprivate.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - Componere\Value::isPrivate - Detección de accesibilidad - - - - &reftitle.description; - - public boolComponere\Value::isPrivate - - - - - - - - - - - diff --git a/reference/componere/componere/value/isprotected.xml b/reference/componere/componere/value/isprotected.xml deleted file mode 100644 index 44465dba58..0000000000 --- a/reference/componere/componere/value/isprotected.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - Componere\Value::isProtected - Detección de accesibilidad - - - - &reftitle.description; - - public boolComponere\Value::isProtected - - - - - - - - - - - diff --git a/reference/componere/componere/value/isstatic.xml b/reference/componere/componere/value/isstatic.xml deleted file mode 100644 index 6c9efaf332..0000000000 --- a/reference/componere/componere/value/isstatic.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - Componere\Value::isStatic - Detección de accesibilidad - - - - &reftitle.description; - - public boolComponere\Value::isStatic - - - - - - - - - - - diff --git a/reference/componere/componere/value/setprivate.xml b/reference/componere/componere/value/setprivate.xml deleted file mode 100644 index 0f14468498..0000000000 --- a/reference/componere/componere/value/setprivate.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - Componere\Value::setPrivate - Modificación de la accesibilidad - - - - &reftitle.description; - - public ValueComponere\Value::setPrivate - - - - - - - - - - &reftitle.returnvalues; - - El valor actual - - - - - Excepciones - - - Lanzará RuntimeException si el nivel de acceso fue establecido previamente - - - - - - - diff --git a/reference/componere/componere/value/setprotected.xml b/reference/componere/componere/value/setprotected.xml deleted file mode 100644 index d0a6d2a9a2..0000000000 --- a/reference/componere/componere/value/setprotected.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - Componere\Value::setProtected - Modificación de la accesibilidad - - - - &reftitle.description; - - public ValueComponere\Value::setProtected - - - - - - - - - - &reftitle.returnvalues; - - El valor actual - - - - - Excepciones - - - Lanzará RuntimeException si el nivel de acceso fue establecido previamente - - - - - - - diff --git a/reference/componere/componere/value/setstatic.xml b/reference/componere/componere/value/setstatic.xml deleted file mode 100644 index 1472bcfe28..0000000000 --- a/reference/componere/componere/value/setstatic.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - Componere\Value::setStatic - Modificación de la accesibilidad - - - - &reftitle.description; - - public ValueComponere\Value::setStatic - - - - - - - - - - &reftitle.returnvalues; - - El valor actual - - - - - - diff --git a/reference/componere/configure.xml b/reference/componere/configure.xml deleted file mode 100644 index ac3ff9974a..0000000000 --- a/reference/componere/configure.xml +++ /dev/null @@ -1,36 +0,0 @@ - - - - -
- &reftitle.install; - - - Use al compilar PHP. - - - - Los usuarios de Windows deben incluir php_componere.dll en &php.ini; - - -
- diff --git a/reference/componere/functions/componere.cast.xml b/reference/componere/functions/componere.cast.xml deleted file mode 100644 index d8ad5b0c11..0000000000 --- a/reference/componere/functions/componere.cast.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Componere\cast - Moldeado - - - - &reftitle.description; - - objectComponere\cast - stringtype - objectobject - - - - - &reftitle.parameters; - - - type - - - Un tipo definido por el usuario - - - - - object - - - Un objeto con un tipo definido por el usuario compatible con Type - - - - - - - - &reftitle.returnvalues; - - Un object de tipo Type, moldeado de object - - - - - &reftitle.errors; - - - Lanzará InvalidArgumentException si el tipo de object es o se deriva de una clase interna - - - - - Lanzará InvalidArgumentException si Type es una interface - - - - - Lanzará InvalidArgumentException si Type es un rasgo - - - - - Lanzará InvalidArgumentException si Type es una abstracta - - - - - Lanzará InvalidArgumentException si Type no es compatible con el tipo de object - - - - - - &reftitle.seealso; - - - - - - - diff --git a/reference/componere/functions/componere.cast_by_ref.xml b/reference/componere/functions/componere.cast_by_ref.xml deleted file mode 100644 index 3465b5c865..0000000000 --- a/reference/componere/functions/componere.cast_by_ref.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Componere\cast_by_ref - Moldeado - - - - &reftitle.description; - - objectComponere\cast_by_ref - stringtype - objectobject - - - - - &reftitle.parameters; - - - type - - - Un tipo definido por el usuario - - - - - object - - - Un objeto con un tipo definido por el usuario compatible con Type - - - - - - - - &reftitle.returnvalues; - - Un object de tipo Type, moldeado de object, donde los miembros son referencias a miembros de object - - - - - &reftitle.errors; - - - Lanzará InvalidArgumentException si el tipo de object es o se deriva de una clase interna - - - - - Lanzará InvalidArgumentException si Type es una interface - - - - - Lanzará InvalidArgumentException si Type es un rasgo - - - - - Lanzará InvalidArgumentException si Type es una abstracta - - - - - Lanzará InvalidArgumentException si Type no es compatible con el tipo de object - - - - - - &reftitle.seealso; - - - - - - - diff --git a/reference/componere/reference.xml b/reference/componere/reference.xml deleted file mode 100644 index c2cfbcca33..0000000000 --- a/reference/componere/reference.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - - - - - &Functions; Componere - - &reference.componere.functions.componere.cast; - &reference.componere.functions.componere.cast-by-ref; - - - - diff --git a/reference/componere/setup.xml b/reference/componere/setup.xml deleted file mode 100644 index 6d9dd94d28..0000000000 --- a/reference/componere/setup.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - &reftitle.setup; - -
- &reftitle.required; - - Se requiere Reflection - -
- -
- &reftitle.install; - - La fuente de Componere y las liberaciones están disponibles en - github - -
- -
- diff --git a/reference/cubrid/aliases.xml b/reference/cubrid/aliases.xml deleted file mode 100644 index 6814f26559..0000000000 --- a/reference/cubrid/aliases.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - Alias y Funciones Obsoletas de CUBRID - - &reference.cubrid.entities.oldaliases; - - - - - diff --git a/reference/cubrid/book.xml b/reference/cubrid/book.xml deleted file mode 100644 index 15363f3de0..0000000000 --- a/reference/cubrid/book.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - CUBRID - CUBRID - - - &reftitle.intro; - - Estas funciones permiten acceder a servidores de bases de datos CUBRID. Se puede encontrar más información sobre CUBRID en CUBRID. - - - La documentación de CUBRID se puede encontrar en Documentación de CUBRID. - - - - - &reference.cubrid.setup; - &reference.cubrid.constants; - &reference.cubrid.examples; - &reference.cubrid.reference; - &reference.cubrid.cubridmysql; - &reference.cubrid.aliases; - - - diff --git a/reference/cubrid/configure.xml b/reference/cubrid/configure.xml deleted file mode 100644 index b5bf67a19d..0000000000 --- a/reference/cubrid/configure.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - -
- &reftitle.install; - - - &pecl.info; - &url.pecl.package;cubrid. - - - &pecl.windows.download; - - - Para obtener información sobre la instalación manual en Linux y en Windows, por favor, - lea el fichero build-guide.html incluido en el paquete. - - -
- diff --git a/reference/cubrid/constants.xml b/reference/cubrid/constants.xml deleted file mode 100644 index 869c0da0d8..0000000000 --- a/reference/cubrid/constants.xml +++ /dev/null @@ -1,413 +0,0 @@ - - - - - - &reftitle.constants; - &extension.constants; - - Las constantes siguientes pueden ser utilizadas durante la ejecución - de consultas SQL. Pueden ser pasadas a las funciones cubrid_prepare - y cubrid_execute. - - Flags de ejecución SQL CUBRID - - - - Constante - Descripción - - - - - CUBRID_INCLUDE_OID - Determina si se debe recuperar el OID durante la - ejecución de la consulta. - - - CUBRID_ASYNC - Ejecuta la consulta en modo asíncrono. - - - CUBRID_EXEC_QUERY_ALL - - Ejecuta la consulta en modo síncrono. Este flag debe ser - definido durante la ejecución de consultas SQL múltiples. - - - -
-
- - - Las constantes siguientes pueden ser utilizadas durante la recuperación - de los resultados para especificar su comportamiento. Pueden ser pasadas a - las funciones cubrid_fetch - y cubrid_fetch_array. - - Flags de recuperación CUBRID - - - - Constante - Descripción - - - - - CUBRID_NUM - Recupera el resultado de la consulta en forma de array - numérico (con índices comenzando en 0). - - - CUBRID_ASSOC - Recupera el resultado de la consulta en forma de array - asociativo. - - - CUBRID_BOTH - Recupera el resultado de la consulta tanto en forma de array - numérico como de array asociativo (valor por defecto). - - - CUBRID_OBJECT - Recupera el resultado de la consulta en forma de objeto. - - - CUBRID_LOB - - La constante CUBRID_LOB puede ser utilizada cuando se desea - utilizar un objeto LOB. Puede ser pasada a las funciones - cubrid_fetch, - cubrid_fetch_row, - cubrid_fetch_array, - cubrid_fetch_assoc y - cubrid_fetch_object. - - - -
-
- - - Las constantes siguientes pueden ser utilizadas durante el posicionamiento del - cursor en los resultados de la consulta. Pueden ser pasadas a - o retornadas por la función cubrid_move_cursor. - - Flags de posicionamiento del cursor CUBRID - - - - Constante - Descripción - - - - - CUBRID_CURSOR_FIRST - Mueve el cursor actual a la primera posición del resultado. - - - CUBRID_CURSOR_CURRENT - Mueve el cursor actual a un valor por defecto si el origen - no está especificado. - - - CUBRID_CURSOR_LAST - Mueve el cursor actual a la última posición del resultado. - - - CUBRID_CURSOR_SUCCESS - El valor retornado por la función cubrid_move_cursor - en caso de éxito. Este flag fue eliminado desde la versión 8.4.1. - - - CUBRID_NO_MORE_DATA - El valor retornado por la función cubrid_move_cursor - si ocurre un error. Este flag fue eliminado desde la versión 8.4.1. - - - CUBRID_CURSOR_ERROR - El valor retornado por la función cubrid_move_cursor - si ocurre un error. Este flag fue eliminado desde la versión 8.4.1. - - - -
-
- - - Las constantes siguientes pueden ser utilizadas durante la definición - del modo auto-commit para la conexión a la base de datos. - Pueden ser pasadas a la función cubrid_set_autocommit - o retornadas por la función cubrid_get_autocommit. - - Flags CUBRID para el modo auto-commit - - - - Constante - Descripción - - - - - CUBRID_AUTOCOMMIT_TRUE - Activa el modo auto-commit. - - - CUBRID_AUTOCOMMIT_FALSE - Desactiva el modo auto-commit. - - - -
-
- - - Las constantes siguientes pueden ser utilizadas durante la definición - de parámetros a la base de datos. Pueden ser pasadas a - la función cubrid_set_db_parameter. - - Flags de parámetros CUBRID - - - - Constante - Descripción - - - - - CUBRID_PARAM_ISOLATION_LEVEL - Nivel de aislamiento de la transacción para la conexión - a la base de datos. - - - CUBRID_PARAM_LOCK_TIMEOUT - Tiempo de expiración de la transacción en segundos. - - - -
-
- - - Las constantes siguientes pueden ser utilizadas para definir el nivel - de aislamiento de la transacción. Pueden ser pasadas a la función - cubrid_set_db_parameter o retornadas por la función - cubrid_get_db_parameter. - - Flags CUBRID para el nivel de aislamiento - - - - Constante - Descripción - - - - - TRAN_COMMIT_CLASS_UNCOMMIT_INSTANCE - El nivel de aislamiento más bajo (1). - Una lectura de datos modificados, no repetibles, o - fantasmas puede ocurrir en el tuple y, además, una lectura - no repetible puede ocurrir en la tabla. - - - TRAN_COMMIT_CLASS_COMMIT_INSTANCE - Un nivel de aislamiento relativamente bajo (2). Una - lectura de datos modificados no puede ocurrir, - pero una lectura de datos no repetibles o fantasmas - puede ocurrir. - - - TRAN_REP_CLASS_UNCOMMIT_INSTANCE - El nivel de aislamiento por defecto para CUBRID (3). - Una lectura de datos modificados, no repetibles o fantasmas - puede ocurrir en el tuple, pero la lectura de datos repetibles - está asegurada para la tabla. - - - TRAN_REP_CLASS_COMMIT_INSTANCE - Un nivel de aislamiento relativamente bajo (4). Una lectura - de datos modificados no puede ocurrir, pero una lectura - de datos no repetibles o fantasmas puede ocurrir. - - - TRAN_REP_CLASS_REP_INSTANCE - Un nivel de aislamiento relativamente alto (5). Una lectura - de datos modificados o no repetibles no puede ocurrir, pero - una lectura de datos fantasmas puede ocurrir. - - - TRAN_SERIALIZABLE - El nivel de aislamiento más alto (6). Los problemas relacionados - con la concurrencia (i.e. lectura de datos modificados, no repetibles, fantasmas, - etc...) no puede ocurrir. - - - -
-
- - - Las constantes siguientes pueden ser utilizadas para recuperar las informaciones - de esquema. Pueden ser pasadas a la función - cubrid_schema. - - Flags para los esquemas CUBRID - - - - Constante - Descripción - - - - - CUBRID_SCH_CLASS - Recupera el nombre y el tipo de la tabla en CUBRID. - - - CUBRID_SCH_VCLASS - Recupera el nombre y el tipo de la vista en CUBRID. - - - CUBRID_SCH_QUERY_SPEC - Recupera la definición de la consulta para una vista. - - - CUBRID_SCH_ATTRIBUTE - Recupera los atributos de una columna de una tabla. - - - CUBRID_SCH_CLASS_ATTRIBUTE - Recupera los atributos de una tabla. - - - CUBRID_SCH_METHOD - Recupera el método de la instancia. El método de la instancia - es el método llamado por una instancia de clase. Es más - frecuentemente utilizado que un método de clase ya que la mayoría de - las operaciones son ejecutadas en la instancia. - - - CUBRID_SCH_CLASS_METHOD - Recupera el método de clase. El método de clase es - el método llamado por un objeto de la clase. Es habitualmente - utilizado para crear una nueva instancia de la clase o para - inicializarla. También es utilizado para acceder o actualizar - los atributos de la clase. - - - CUBRID_SCH_METHOD_FILE - Recupera las informaciones del archivo que define el método - de la tabla. - - - CUBRID_SCH_SUPERCLASS - Recupera el nombre y el tipo de la tabla de la cual - la tabla hereda sus atributos. - - - CUBRID_SCH_SUBCLASS - Recupera el nombre y el tipo de la tabla que hereda los atributos. - - - CUBRID_SCH_CONSTRAINT - Recupera las restricciones de la tabla. - - - CUBRID_SCH_TRIGGER - Recupera los triggers de la tabla. - - - CUBRID_SCH_CLASS_PRIVILEGE - Recupera las informaciones sobre los privilegios de la tabla. - - - CUBRID_SCH_ATTR_PRIVILEGE - Recupera las informaciones de privilegios de una columna. - - - CUBRID_SCH_DIRECT_SUPER_CLASS - Recupera la tabla super directa de la tabla. - - - CUBRID_SCH_PRIMARY_KEY - Recupera la clave primaria de la tabla. - - - CUBRID_SCH_IMPORTED_KEYS - Recupera las claves importadas de la tabla. - - - CUBRID_SCH_EXPORTED_KEYS - Recupera las claves exportadas de la tabla. - - - CUBRID_SCH_CROSS_REFERENCE - Recupera las referencias de los enlaces de 2 tablas. - - - -
-
- - - Las constantes siguientes pueden ser utilizadas durante el reporte de - errores. Pueden ser retornadas por la función - cubrid_error_code_facility. - - Código de facilidad de errores CUBRID - - - - Constante - Descripción - - - - - CUBRID_FACILITY_DBMS - El error ocurrió en la base de datos CUBRID. - - - CUBRID_FACILITY_CAS - El error ocurrió en el broker CUBRID. - - - CUBRID_FACILITY_CCI - El error ocurrió en el cci CUBRID. - - - CUBRID_FACILITY_CLIENT - El error ocurrió en el cliente PHP CUBRID. - - - -
-
-
- - diff --git a/reference/cubrid/cubridmysql.xml b/reference/cubrid/cubridmysql.xml deleted file mode 100644 index 82c6d6a1df..0000000000 --- a/reference/cubrid/cubridmysql.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - Funciones de compatibilidad CUBRID MySQL - - &reference.cubrid.entities.cubridmysql; - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-affected-rows.xml b/reference/cubrid/cubridmysql/cubrid-affected-rows.xml deleted file mode 100644 index 5f8f9915a8..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-affected-rows.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - - cubrid_affected_rows - Devolver el número de filas afectadas por la última sentencia SQL - - - - &reftitle.description; - - intcubrid_affected_rows - resourceconn_identifier - - - intcubrid_affected_rows - resourcereq_identifier - - - La función cubrid_affected_rows se usa para obtener el - número de filas afectadas por la última sentencia SQL (INSERT, DELETE, UPDATE). - - - - - &reftitle.parameters; - - - conn_identifier - La conexión CUBRID. Si no se especifica el identificador de - conexión, se asume el último enlace abierto por - cubrid_connect. - - - req_identifier - - - Identificador de petición. Podría ser devuelto desde cubrid_prepare o cubrid_execute. - Si el identificador de petición no se especifica, se asume el último identificador solicitado por - cubrid_prepare o cubrid_execute. - - - - - - - - &reftitle.returnvalues; - - El número de filas afectadas por la sentencia SQL, cuando el proceso tiene éxito. - - - -1, cuando la sentencia SQL no es INSERT, DELETE o UPDATE. - - - &false;, cuando el identificador de solicitud no está especificado, y no existe una última - petición. - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_affected_rows</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_execute - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-client-encoding.xml b/reference/cubrid/cubridmysql/cubrid-client-encoding.xml deleted file mode 100644 index 4b48eef5bc..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-client-encoding.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - cubrid_client_encoding - Devuelve el actual conjunto de caracteres de la conexión a CUBRID - - - - &reftitle.description; - - stringcubrid_client_encoding - resourceconn_identifier - - - Esta función devuelve el actual conjunto de caracteres de conexión a CUBRID y es similar - a la función CUBRID cubrid_get_charset. - - - - - &reftitle.parameters; - - - conn_identifier - Conexión CUBRID. Si no se especifica el identificador de conexión, se asumirá el último enlace abierto por cubrid_connect. - - - - - - &reftitle.returnvalues; - - Cadena que representa el conjunto de caracteres de la conexión a CUBRID; en caso de éxito. - - - &false; en caso de falla. - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_client_encoding</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_get_charset - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-close.xml b/reference/cubrid/cubridmysql/cubrid-close.xml deleted file mode 100644 index 707ea8ad0f..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-close.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - cubrid_close - Cerrar la conexión de CUBRID - - - - &reftitle.description; - - boolcubrid_close - resourceconn_identifier - - - La función cubrid_close termina la transacción - en proceso actual, cierra el gestor de conexión y se desconecta del - servidor. Si existe cualquier gestor de petición que no se haya cerrado todavía em este punto, - éste se cerrará. Es similar a la función de CUBRID - cubrid_disconnect. - - - - - &reftitle.parameters; - - - conn_identifier - El identificador de conexión de CUBRID. Si no se especifica el identificador de conexión, se asume la última conexión abierta por cubrid_connect. - - - - - - &reftitle.returnvalues; - - &true;, cuando el proceso es satisfactorio. - - - &false;, cuando el proceso es insatisfactorio. - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_close</function> - - -]]> - - - - - - &reftitle.seealso; - - cubrid_disconnect - cubrid_connect - cubrid_connect_with_url - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-data-seek.xml b/reference/cubrid/cubridmysql/cubrid-data-seek.xml deleted file mode 100644 index fbf84005a1..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-data-seek.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - - cubrid_data_seek - Mueve el puntero interno de la fila del resultado CUBRID - - - - &reftitle.description; - - boolcubrid_data_seek - resourceresult - introw_number - - - Esta función desplaza el puntero interno de las filas del - resultado CUBRID (asociado con el identificador especificado) para apuntar - al número de fila especificada. Hay funciones, como - cubrid_fetch_assoc, que utiliza el valor actualmente almacenado - del número de fila. - - - - - &reftitle.parameters; - - - result - El resultado. - - - row_number - Éste es el número de fila deseado del puntero del nuevo resultado. - - - - - - &reftitle.returnvalues; - - Devuelve &true; en caso de éxito o &false; en caso de error. - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_data_seek</function> - - -]]> - - &example.outputs; - - - string(1) "X" - [1]=> - string(5) "Mixed" -} -array(2) { - [0]=> - string(1) "M" - [1]=> - string(3) "Man" -} -array(2) { - [0]=> - string(1) "S" - [1]=> - string(6) "Silver" -} -]]> - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-db-name.xml b/reference/cubrid/cubridmysql/cubrid-db-name.xml deleted file mode 100644 index 2a571c889a..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-db-name.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - cubrid_db_name - Obtener el nombre de la base de datos desde los resultados de cubrid_list_dbs - - - - &reftitle.description; - - stringcubrid_db_name - arrayresult - intindex - - - Recupera el nombre de la base de datos desde una llamada a cubrid_list_dbs. - - - - - &reftitle.parameters; - - - result - - - El puntero resultado desde un llamada a cubrid_list_dbs. - - - - - index - - - El índice dentro del conjunto resultado. - - - - - - - - &reftitle.returnvalues; - - Devuelve el nombre de la base de datos en caso de éxito, y &false; en caso de fallo. Si se devuelve - &false;, use cubrid_error para determinar la naturaleza - del error. - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_db_name</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_list_dbs - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-errno.xml b/reference/cubrid/cubridmysql/cubrid-errno.xml deleted file mode 100644 index 227e42c696..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-errno.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - cubrid_errno - Devuelve el valor numérico del mensaje de error de la operación de CUBRID previa - - - - &reftitle.description; - - intcubrid_errno - resourceconn_identifier - - - Devuelve el número de error de la última función CUBRID. - - - La función cubrid_errno se usa para obtener el - código de error que ocurrió durante la ejecución de la API. Normalmente, - obtiene el error cuando la API devuelve false como su valor de retorno. - - - - - &reftitle.parameters; - - - conn_identifier - - - El identificador de conexión de CUBRID. Si el identificador de conexión no se - especifica, se asume la última conexión abierta por - cubrid_connect. - - - - - - - - &reftitle.returnvalues; - - Devuelve el número de error de la última función CUBRID, o 0 (cero) si no ocurrio ningún error. - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_errno</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_error - cubrid_error_code - cubrid_error_msg - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-error.xml b/reference/cubrid/cubridmysql/cubrid-error.xml deleted file mode 100644 index af0e475389..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-error.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - cubrid_error - Se usa para obtener el mensaje de error - - - - &reftitle.description; - - stringcubrid_error - resourceconnection - - - La función cubrid_error se usa para obtener el mensaje de - error que ocurrió durante el uso de la API CUBRID. Normalmente, obtiene el mensaje de - error cuando la API devuelve false como su valor de retorno. - - - - - &reftitle.parameters; - - - connection - La conexión CUBRID - - - - - - &reftitle.returnvalues; - - Mensaje de error que ocurrió. - - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_error</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_errno - cubrid_error_code - cubrid_error_msg - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-fetch-array.xml b/reference/cubrid/cubridmysql/cubrid-fetch-array.xml deleted file mode 100644 index 8843fe0ef5..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-fetch-array.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - - cubrid_fetch_array - Recupera una línea de resultado en forma de array asociativo, array numérico, o ambos - - - - &reftitle.description; - - arraycubrid_fetch_array - resourceresult - inttypeCUBRID_BOTH - - - La función cubrid_fetch_array se utiliza para recuperar - una sola línea desde el resultado de la consulta y devuelve - un array. El cursor se mueve automáticamente a la siguiente línea - una vez que el resultado ha sido recuperado. - - - - - &reftitle.parameters; - - - result - El parámetro Result proviene de una - llamada a la función cubrid_execute - - - type - Tipo del array recuperado: CUBRID_NUM, CUBRID_ASSOC, CUBRID_BOTH. - Si se necesita utilizar un objeto LOB, se puede utilizar CUBRID_LOB. - - - - - - - &reftitle.returnvalues; - - Devuelve un array de strings correspondiente a la línea - recuperada, cuando la operación tiene éxito. - - &false; cuando no hay más líneas, - NULL cuando ocurre un error. - - El tipo del array devuelto depende del tipo que se haya definido. - Utilizando CUBRID_BOTH (valor por defecto), se recuperará un array - que contiene tanto índices asociativos como numéricos; se puede elegir explícitamente este tipo a través del argumento type. - La variable type puede ser definida a uno de - los siguientes valores: - - CUBRID_NUM: Array numérico (comenzando en el índice 0) - CUBRID_ASSOC: Array asociativo - CUBRID_BOTH: Array asociativo y numérico (valor por defecto) - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_fetch_array</function> - - 10000"); - -printf("%-40s %-10s %-6s %-20s\n", "name", "area", "seats", "address"); -while ($row = cubrid_fetch_array($req, CUBRID_NUM)) { - printf("%-40s %-10s %-6s %-20s\n", $row[0], $row[1], $row[2], $row[3]); -} - -// Si se desea utilizar un objeto LOB, se puede utilizar -// cubrid_fetch_array($req, CUBRID_NUM | CUBRID_LOB) - -cubrid_close_request($req); - -cubrid_disconnect($conn); -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - cubrid_execute - cubrid_fetch - cubrid_fetch_row - cubrid_fetch_assoc - cubrid_fetch_object - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-fetch-assoc.xml b/reference/cubrid/cubridmysql/cubrid-fetch-assoc.xml deleted file mode 100644 index d31f2fffd9..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-fetch-assoc.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - cubrid_fetch_assoc - Devuelve un array asociativo correspondiente a la fila recuperada - - - - &reftitle.description; - - arraycubrid_fetch_assoc - resourceresult - inttype - - - Esta función devuelve un array asociativo correspondiente a la fila - recuperada, luego, mueve el puntero de datos interno a la siguiente fila. - La función devuelve &false; si no hay más resultados disponibles. - - - - - &reftitle.parameters; - - - result - El parámetro result - proviene de una llamada a la función cubrid_execute - - - type - El tipo solo puede ser CUBRID_LOB; este parámetro - será utilizado únicamente cuando se necesite utilizar un objeto LOB. - - - - - - &reftitle.returnvalues; - - Un array asociativo, en caso de éxito. - - - &false; cuando no hay más filas, NULL - si ocurre un error. - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_fetch_assoc</function> - - 10000"); - -printf("%-40s %-10s %-6s %-20s\n", "name", "area", "seats", "address"); -while ($row = cubrid_fetch_assoc($req)) { - printf("%-40s %-10s %-6s %-20s\n", - $row["name"], $row["area"], $row["seats"], $row["address"]); -} - -// Si se desea utilizar un objeto LOB, se puede utilizar -// cubrid_fetch_assoc($req, CUBRID_LOB) - -cubrid_close_request($req); - -cubrid_disconnect($conn); -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_execute - cubrid_fetch - cubrid_fetch_row - cubrid_fetch_array - cubrid_fetch_object - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-fetch-field.xml b/reference/cubrid/cubridmysql/cubrid-fetch-field.xml deleted file mode 100644 index f986fd9f69..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-fetch-field.xml +++ /dev/null @@ -1,192 +0,0 @@ - - - - - - cubrid_fetch_field - Devuelve un objeto con ciertas propiedades - - - - &reftitle.description; - - objectcubrid_fetch_field - resourceresult - intfield_offset0 - - - Esta función devuelve un objeto con ciertas propiedades de la columna - especificada. Las propiedades del objeto son: - - - - name - nombre de la columna - - - table - nombre de la tabla a la que pertenece la columna - - - def - valor predeterminado de la columna - - - max_length - longitud máxima de la columna - - - not_null - 1 si la columna no puede ser NULL - - - primary_key - 1 si la columna es una clave primaria - - - unique_key - 1 si la columna es clave única - - - multiple_key - 1 si la columna no es clave única - - - numeri - 1 si la columna es numérica - - - blob - 1 si la columna es un BLOB - - - type - el tipo de la columna - - - unsigned - 1 si la columna no tiene signo - - - zerofill - 1 si la columna se rellena con ceros - - - - - - &reftitle.parameters; - - - result - result proviene de una llamada a la función cubrid_execute - - - field_offset - El índice del campo numérico. Si el índice del campo no se especifica, se - recupera el siguiente campo (el que aún no ha sido recuperado por esta función). - field_offset comienza en 0. - - - - - - &reftitle.returnvalues; - - Un objeto con ciertas propiedades de la columna especificada, cuando el proceso tuvo éxito. - - - &false; en caso de error. - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_fetch_field</function> - -name); -printf("%-30s %s\n", "table:", $field->table); -printf("%-30s \"%s\"\n", "default value:", $field->def); -printf("%-30s %d\n", "max length:", $field->max_length); -printf("%-30s %d\n", "not null:", $field->not_null); -printf("%-30s %d\n", "primary key:", $field->primary_key); -printf("%-30s %d\n", "unique key:", $field->unique_key); -printf("%-30s %d\n", "multiple key:", $field->multiple_key); -printf("%-30s %d\n", "numeric:", $field->numeric); -printf("%-30s %d\n", "blob:", $field->blob); -printf("%-30s %s\n", "type:", $field->type); -printf("%-30s %d\n", "unsigned:", $field->unsigned); -printf("%-30s %d\n", "zerofill:", $field->zerofill); - -cubrid_close_request($req); - -cubrid_disconnect($conn); -?> -]]> - - &example.outputs; - - - string(5) "20001" - [1]=> - string(5) "16681" - [2]=> - string(3) "KOR" - [3]=> - string(9) "1988-9-30" -} - ---- Field Properties --- -name: athlete_code -table: game -default value: "" -max length: 0 -not null: 1 -primary key: 1 -unique key: 1 -multiple key: 0 -numeric: 1 -blob: 0 -type: integer -unsigned: 0 -zerofill: 0 -]]> - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-fetch-lengths.xml b/reference/cubrid/cubridmysql/cubrid-fetch-lengths.xml deleted file mode 100644 index 783e756ca8..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-fetch-lengths.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - cubrid_fetch_lengths - Devuelve una matriz con las longitudes de los valores de cada campo de la fila actual - - - - &reftitle.description; - - arraycubrid_fetch_lengths - resourceresult - - - Esta función devuelve una matriz numérica con las longitudes de los valores de - cada campo de la fila actual del conjunto de resultados o FALSE en - caso de fallo. - - - - Si el tipo de información del campo es BLOB/CLOB, se debería tomar su longitud usando cubrid_lob_size. - - - - - - &reftitle.parameters; - - - result - result proviene de una llamada a la función cubrid_execute - - - - - - &reftitle.returnvalues; - - Una matriz numérica, cuando el proceso tuvo éxito. - - - &false; en caso de error. - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_fetch_lengths</function> - - -]]> - - &example.outputs; - - 2004 - [1] => 20085 - [2] => 15118 - [3] => 30134 - [4] => AUS - [5] => G - [6] => 2004-8-20 -) -Array -( - [0] => 4 - [1] => 5 - [2] => 5 - [3] => 5 - [4] => 3 - [5] => 1 - [6] => 10 -) -]]> - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-fetch-object.xml b/reference/cubrid/cubridmysql/cubrid-fetch-object.xml deleted file mode 100644 index 28ce69bb8d..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-fetch-object.xml +++ /dev/null @@ -1,186 +0,0 @@ - - - - - - - cubrid_fetch_object - Recupera la siguiente línea y la devuelve como un objeto - - - - &reftitle.description; - - objectcubrid_fetch_object - resourceresult - stringclass_name - arrayparams - inttype - - - Esta función devuelve un objeto con los nombres de la columna - del conjunto de resultados como propiedades. Los valores de estas propiedades - se extraen de la línea actual del conjunto de resultados. - - - - - &reftitle.parameters; - - - result - El parámetro result proviene de una - llamada a la función cubrid_execute - - - class_name - - - El nombre de la clase a instanciar, definir las propiedades y devolver. - Si no se especifica, se devuelve un objeto stdClass. - - - - - params - - - Un array de parámetros opcionales a pasar al constructor - de la clase class_name. - - - - - type - - - El tipo solo puede ser CUBRID_LOB; este parámetro - solo se utilizará cuando se necesite usar - un objeto lob. - - - - - - - - &reftitle.returnvalues; - - Un objeto en caso de éxito. - - - &false; cuando no hay más líneas, NULL si ocurre un error. - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_fetch_object</function> - -s_name = $s; - $this->f_name = $f; - } -} - -var_dump(cubrid_fetch_object($res, 'demodb_code_construct', array('s_name', 'f_name'))); - -// Si se desea utilizar un objeto LOB, se puede usar -// cubrid_fetch_object($res, 'demodb_code_construct', array('s_name', 'f_name'), CUBRID_LOB) - -var_dump(cubrid_fetch_object($res)); - -cubrid_close_request($res); -cubrid_disconnect($conn); -?> -]]> - - &example.outputs; - - - string(1) "X" - ["f_name"]=> - string(5) "Mixed" -} -object(demodb_code)#1 (2) { - ["s_name"]=> - string(1) "W" - ["f_name"]=> - string(5) "Woman" -} -object(demodb_code_construct)#1 (2) { - ["s_name"]=> - string(6) "s_name" - ["f_name"]=> - string(6) "f_name" -} -object(stdClass)#1 (2) { - ["s_name"]=> - string(1) "B" - ["f_name"]=> - string(6) "Bronze" -} -]]> - - - - - - &reftitle.seealso; - - cubrid_execute - cubrid_fetch - cubrid_fetch_array - cubrid_fetch_assoc - cubrid_fetch_row - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-fetch-row.xml b/reference/cubrid/cubridmysql/cubrid-fetch-row.xml deleted file mode 100644 index 78c1f240f9..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-fetch-row.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - cubrid_fetch_row - Devuelve un array numérico con los valores de la fila actual - - - - &reftitle.description; - - arraycubrid_fetch_row - resourceresult - inttype - - - Esta función devuelve un array numérico con los valores de la fila - actual del conjunto de resultados, comenzando en 0 y desplaza - el puntero interno de datos. - - - - - &reftitle.parameters; - - - result - El argumento result - proviene de una llamada a la función cubrid_execute - - - type - El tipo solo puede ser CUBRID_LOB; este argumento - será utilizado únicamente cuando se necesite utilizar un - objeto lob. - - - - - - &reftitle.returnvalues; - - Un array numérico en caso de éxito. - - - &false; cuando no hay más filas, NULL si ocurre un error. - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_fetch_row</function> - - 10000"); - -printf("%-40s %-10s %-6s %-20s\n", "name", "area", "seats", "address"); -while ($row = cubrid_fetch_row($req)) { - printf("%-40s %-10s %-6s %-20s\n", $row[0], $row[1], $row[2], $row[3]); -} - -// Si se desea utilizar un objeto lob, se puede utilizar -// cubrid_fetch_row($req, CUBRID_LOB) - -cubrid_close_request($req); - -cubrid_disconnect($conn); -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_execute - cubrid_fetch - cubrid_fetch_array - cubrid_fetch_assoc - cubrid_fetch_object - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-field-flags.xml b/reference/cubrid/cubridmysql/cubrid-field-flags.xml deleted file mode 100644 index 963f0ea780..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-field-flags.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - cubrid_field_flags - Devuelve una string con los flags de la posición del campo proporcionado - - - - &reftitle.description; - - stringcubrid_field_flags - resourceresult - intfield_offset - - - Esta función devuelve una &string; con los flags de la posición - del campo proporcionado, separados por un espacio. Se puede utilizar la función - explode() para obtener cada flag. Los flags disponibles son: - not_null, primary_key, - unique_key, foreign_key, - auto_increment, shared, - reverse_index, reverse_unique y - timestamp. - - - - - &reftitle.parameters; - - - result - El parámetro result proviene de - la llamada a la función cubrid_execute - - - field_offset - La posición numérica del campo. - field_offset comienza en cero (0). Si - field_offset no existe, se emitirá un error de nivel - E_WARNING. - - - - - - &reftitle.returnvalues; - - Una &string; con los flags, en caso de éxito. - - - &false; si el valor de field_offset es inválido. - - - -1 si la consulta SQL no es de tipo SELECT. - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_field_flags</function> - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-field-len.xml b/reference/cubrid/cubridmysql/cubrid-field-len.xml deleted file mode 100644 index 6a20e91b71..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-field-len.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - cubrid_field_len - Devuelve la longitud máxima del campo especificado - - - - &reftitle.description; - - intcubrid_field_len - resourceresult - intfield_offset - - - Esta función devuelve la longitud máxima del campo especificado en caso de éxito, o FALSE en caso de fallo. - - - - - &reftitle.parameters; - - - result - result proviene de una llamada a la función cubrid_execute - - - field_offset - El índice de campo numérico. field_offset comienza en 0. Si field_offset no existe, se emitirá un error de nivel E_WARNING. - - - - - - &reftitle.returnvalues; - - La longitud máxima, cuando el proceso ha tenido éxito. - - - &false; en caso de error. - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_field_len</function> - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-field-name.xml b/reference/cubrid/cubridmysql/cubrid-field-name.xml deleted file mode 100644 index 3392fee479..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-field-name.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - cubrid_field_name - Devuelve el nombre del índice del campo especificado - - - - &reftitle.description; - - stringcubrid_field_name - resourceresult - intfield_offset - - - Esta función devuelve el nombre del índice del campo especificado en caso de éxito o - FALSE en caso de fallo. - - - - - &reftitle.parameters; - - - result - result proviene de una llamada a la función cubrid_execute - - - field_offset - - El índice de campo numérico. field_offset - comienza en 0. Si field_offset no existe, se - emitirá un error de nivel E_WARNING. - - - - - - - &reftitle.returnvalues; - - El nombre del índice del campo especificado, en caso de éxito. - - - &false; en caso de error. - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_field_name</function> - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-field-seek.xml b/reference/cubrid/cubridmysql/cubrid-field-seek.xml deleted file mode 100644 index 7552462cca..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-field-seek.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - - cubrid_field_seek - Mueve el cursor del conjunto de resultados al índece del campo especificado - - - - &reftitle.description; - - boolcubrid_field_seek - resourceresult - intfield_offset0 - - - Esta función mueve el cursor del conjunto de resultados al índece del campo especificado. - Este índice es usado por cubrid_fetch_field si - no se incluye un índice de campo. Devuelve TRUE en caso de éxito o FALSE en - caso de fallo. - - - - - &reftitle.parameters; - - - result - result proviene de una llamada a la función cubrid_execute - - - field_offset - - El índice de campo numérico. field_offset - comienza en 0. Si field_offset no existe, se emitirá - un error de nivel E_WARNING. - - - - - - - &reftitle.returnvalues; - - &true; en caso de éxito. - - - &false; en caso de error. - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_field_seek</function> - -name); -printf("%-30s %s\n", "table:", $field->table); -printf("%-30s \"%s\"\n", "default value:", $field->def); -printf("%-30s %d\n", "max length:", $field->max_length); -printf("%-30s %d\n", "not null:", $field->not_null); -printf("%-30s %d\n", "unique key:", $field->unique_key); -printf("%-30s %d\n", "multiple key:", $field->multiple_key); -printf("%-30s %d\n", "numeric:", $field->numeric); -printf("%-30s %s\n", "type:", $field->type); - -cubrid_close_request($req); - -cubrid_disconnect($conn); -?> -]]> - - &example.outputs; - - - string(5) "20001" - [1]=> - string(5) "16132" - [2]=> - string(3) "KOR" - [3]=> - string(9) "1988-09-30" -} - ---- Field Properties --- -name: athlete_code -table: game -default value: "" -max length: 0 -not null: 1 -unique key: 1 -multiple key: 0 -numeric: 1 -type: integer -]]> - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-field-table.xml b/reference/cubrid/cubridmysql/cubrid-field-table.xml deleted file mode 100644 index 935fff4570..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-field-table.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - cubrid_field_table - Devuelve el nombre de la tabla del campo especificado - - - - &reftitle.description; - - stringcubrid_field_table - resourceresult - intfield_offset - - - Esta función devuelve el nombre de la tabla del campo especificado. Esto es útil cuando se usan consultas SELECT largas con JOINS. - - - - - &reftitle.parameters; - - - result - - result proviene de una llamada a - cubrid_execute - - - - field_offset - - El desplazamiento del campo numérico. El field_offset - comienza en 0. Si field_offset no existe, también se emite - un error de nivel E_WARNING. - - - - - - - &reftitle.returnvalues; - - El nombre de la tabla del campo especificado, en caso de éxito. - - - &false; cuando field_offset tiene un valor no válido. - - - -1 si la sentencia SQL no es SELECT. - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_field_table</function> - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-field-type.xml b/reference/cubrid/cubridmysql/cubrid-field-type.xml deleted file mode 100644 index 6b218cac7a..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-field-type.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - cubrid_field_type - Devuelve el tipo de columna que se corresponde con el índice del campo dado - - - - &reftitle.description; - - stringcubrid_field_type - resourceresult - intfield_offset - - - Esta función devuelve el tipo de columna que se corresponde con el índice del - campo dado. El tipo de campo devuelto debería ser uno de los siguientes: - "int", "real", "string", etc. - - - - - &reftitle.parameters; - - - result - - result proviene de una llamada a - cubrid_execute - - - - field_offset - - El índice de campo numérico. field_offset - comienza en 0. Si field_offset no existe, se - emitirá un error de nivel E_WARNING. - - - - - - - &reftitle.returnvalues; - - El tipo de la columna, en caso de éxito. - - - &false; cuando field_offset no tiene un valor válido. - - - -1 si la sentencia SQL no es SELECT. - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_field_type</function> - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-list-dbs.xml b/reference/cubrid/cubridmysql/cubrid-list-dbs.xml deleted file mode 100644 index 44d1393700..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-list-dbs.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - cubrid_list_dbs - Devuelve una matriz con la lista de todas las bases de datos Cubrid existentes - - - - &reftitle.description; - - arraycubrid_list_dbs - resourceconn_identifier - - - Esta función devuelve una matriz con la lista de todas las bases de datos Cubrid - existentes. - - - - - &reftitle.parameters; - - - conn_identifier - La conexión CUBRID. - - - - - - &reftitle.returnvalues; - - Una matriz numérica con todas las bases de datos Cubrid existentes; en caso de éxito. - - - &false; en caso de fallo. - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_list_dbs</function> - - -]]> - - &example.outputs; - - - string(6) "demodb" -} -]]> - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-num-fields.xml b/reference/cubrid/cubridmysql/cubrid-num-fields.xml deleted file mode 100644 index b12d5e3304..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-num-fields.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - cubrid_num_fields - Devuelve el número de columnas en el conjunto de resultados - - - - &reftitle.description; - - intcubrid_num_fields - resourceresult - - - Esta función devuelve el número de columnas en el conjunto de resultados - en caso de éxito, o &false; si ocurre un error. - - - - - &reftitle.parameters; - - - result - El parámetro result proviene - de una llamada a la función cubrid_execute, - cubrid_query o - cubrid_prepare - - - - - - &reftitle.returnvalues; - - Número de columnas en caso de éxito. - - - -1 si la consulta SQL no es de tipo SELECT. - - - &false; si ocurre un error. - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_num_fields</function> - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-ping.xml b/reference/cubrid/cubridmysql/cubrid-ping.xml deleted file mode 100644 index a70ebc326e..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-ping.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - cubrid_ping - Hacer ping en una conexión al servidor o reconectar si no hay conexión - - - - &reftitle.description; - - boolcubrid_ping - resourceconn_identifier - - - Verifica si la conexión al servidor está funcionando.. - - - - - &reftitle.parameters; - - - conn_identifier - - - El identificador de conexión de CUBRID. Si el identificador de conexión no se - especifica, se asume la última conexión abierta por - cubrid_connect. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si la conexión al servidor CUBRID está funcionando, si no &false;. - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_ping</function> - - -]]> - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-query.xml b/reference/cubrid/cubridmysql/cubrid-query.xml deleted file mode 100644 index a0dd6e036d..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-query.xml +++ /dev/null @@ -1,182 +0,0 @@ - - - - - - - cubrid_query - Enviar una consulta CUBRID - - - - &reftitle.description; - - resourcecubrid_query - stringquery - resourceconn_identifier - - - cubrid_query envía una consulta única (no están soportadas consultas múltiples) a la - base de datos activa actual en el servidor que está asociado con el conn_identifier especificado. - - - - - &reftitle.parameters; - - - query - - - Una consulta SQL - - - La información dentro de la consulta debería estar adecuadamente escapada. - - - - - conn_identifier - - - La conexión CUBRID. Si el identificador de conexión no se especifica, - se asume la última conexión abierta por - cubrid_connect. - - - - - - - - &reftitle.returnvalues; - - Para SELECT, SHOW, DESCRIBE, EXPLAIN y otras sentencias que devuelven conjuntos de resultadosa, - cubrid_query devuelve un resource en caso de éxito, o &false; en caso de error. - - - Para otros tipos de sentencias SQL, INSERT, UPDATE, DELETE, DROP, etc, - cubrid_query devuelve &true; en caso de éxito o &false; en caso de error. - - - El recurso resultado devuelto debería ser pasado a cubrid_fetch_array, y a otras - funciones para tratar con las tablas de resultados, para acceder a la información devuelta. - - - Use cubrid_num_rows para averiguar cuántas filas fueron devueltas por una sentencia SELECT o - cubrid_affected_rows para averiguar cuántas filas fueron afectadas por una sentencia DELETE, INSERT, REPLACE, o UPDATE. - - - cubrid_query también podrá fallar y devolver &false; - si el usuario no tiene permiso para acceder a la/s tabla/s referenciada/s por la consulta. - - - - - &reftitle.examples; - - Consulta No Válida - - La siguiente consulta no es válida sintácticamente, por lo que cubrid_query fallará y devolverá &false;. - - - -]]> - - - - Consulta Válida - - La siguiente consulta es válida, por lo que cubrid_query devolverá un resource. - - - -]]> - - - - - - &reftitle.seealso; - - cubrid_connect - cubrid_error - cubrid_real_escape_string - cubrid_result - cubrid_fetch_assoc - cubrid_unbuffered_query - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-real-escape-string.xml b/reference/cubrid/cubridmysql/cubrid-real-escape-string.xml deleted file mode 100644 index 35a6d973a9..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-real-escape-string.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - cubrid_real_escape_string - Escapar caracteres especiales en una cadena para usarla en una sentencia SQL - - - - &reftitle.description; - - stringcubrid_real_escape_string - stringunescaped_string - resourceconn_identifier - - - Esta función devuelve la versión escapada de la cadena dada. - Escapará los siguientes caracteres: '. - - En general, las comillas simples se usan para encerrar strings. Las - comillas dobles se pueden usar también dependiendo del valor de ansi_quotes, - que es un parámetro relacionado con sentencias SQL. Si el valor de ansi_quotes value está - establecido a no, los strings encerrados entre comillas dobles se tratan como - strings, no como identificadores. El valor predeterminado es yes. - - Si quiere incluir una comilla simple como parte de una cadena de caracteres, introduzca - dos comillas simples en una fila. - - - - - &reftitle.parameters; - - - unescaped_string - La cadena que va a ser escapada. - - - conn_identifier - - La conexión CUBRID. Si el identificador de conexión no se especifica, se - asume el último enlace abierto por cubrid_connect. - - - - - - - &reftitle.returnvalues; - - La versión escapada de la cadena dada, en caso de éxito. - - - &false; en caso de fallo. - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_real_escape_string</function> - -?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~'; -$escaped_str = cubrid_real_escape_string($unescaped_str); - -$len = strlen($unescaped_str); - -@cubrid_execute($conn, "DROP TABLE cubrid_test"); -cubrid_execute($conn, "CREATE TABLE cubrid_test (t char($len))"); -cubrid_execute($conn, "INSERT INTO cubrid_test (t) VALUES('$escaped_str')"); - -$req = cubrid_execute($conn, "SELECT * FROM cubrid_test"); -$row = cubrid_fetch_assoc($req); - -var_dump($row); - -cubrid_close_request($req); -cubrid_disconnect($conn); -?> -]]> - - &example.outputs; - - - string(95) " !"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~" -} -]]> - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-result.xml b/reference/cubrid/cubridmysql/cubrid-result.xml deleted file mode 100644 index f15a5f4007..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-result.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - cubrid_result - Devuelve el valor de un campo específico de una fila específica - - - - &reftitle.description; - - stringcubrid_result - resourceresult - introw - mixedfield0 - - - Esta función devuelve el valor de un campo específico de una fila específica de - un conjunto de resultados. - - - - - &reftitle.parameters; - - - result - result proviene de una llamada a la función cubrid_execute - - - row - El número de fila del resultado que está siendo traído. Los números de fila comienzan en 0. - - - field - - El nombre o índice del campo dado por field que está siendo obtenido. - Puede ser el índice del campo, el nombre del campo, o la tabla del campo punto nombre - del campo (nombretabla.nombrecampo). Si el nombre de la columna ha sido apodado - ('select foo as bar from...'), use el alias en vez del nombre de la columna. - Si no está definido se trae el primer campo. - - - - - - - &reftitle.returnvalues; - - El valor de un campo específico, en caso de éxito (NULL si el valor es nulo). - - - &false; en caso de error. - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_result</function> - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/cubrid/cubridmysql/cubrid-unbuffered-query.xml b/reference/cubrid/cubridmysql/cubrid-unbuffered-query.xml deleted file mode 100644 index 50440d0d29..0000000000 --- a/reference/cubrid/cubridmysql/cubrid-unbuffered-query.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - cubrid_unbuffered_query - Realiza una consulta sin traer los resultados a memoria - - - - &reftitle.description; - - resourcecubrid_unbuffered_query - stringquery - resourceconn_identifier - - - Esta función realiza una consulta sin esperar a que todos los resultados de consulta hayan sido completados. Devolverá - cuando los resultados están siendo generados. - - - - - &reftitle.parameters; - - - query - Una consulta SQL. - - - conn_identifier - La conexión CUBRID. Si el identificador de conexión no se especifica, se asume el último enlace abierto por cubrid_connect. - - - - - - &reftitle.returnvalues; - - Para sentencias SELECT, SHOW, DESCRIBE o EXPLAIN devuelve un recurso identificador de petición en caso de éxito. - - - Para otro tipo de sentencias SQL, UPDATE, DELETE, DROP, etc,, devuelve &true; en caso de éxito. - - - &false; en caso de fallo. - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_unbuffered_query</function> - - -]]> - - - - - - &reftitle.notes; - - - Los beneficios de cubrid_unbuffered_query tienen - un coste: no se puede usar cubrid_num_rows y - cubrid_data_seek en un conjunto de resultados devueltos desde - cubrid_unbuffered_query. - - - - - - diff --git a/reference/cubrid/examples.xml b/reference/cubrid/examples.xml deleted file mode 100644 index 99e5be14cc..0000000000 --- a/reference/cubrid/examples.xml +++ /dev/null @@ -1,176 +0,0 @@ - - - - - &reftitle.examples; - El siguiente es un ejemplo sencillo que establece una conexión entre PHP y CUBRID. Esta conexión cubrirá la características más básicas y significativas. El siguiente código requiere conectarse a una base de datos CUBRID, lo que significa que CUBRID Server (servidor) y CUBRID Broker (agente) tienen que estar ejecutándose. - El ejemplo de abajo usa la base de datos demodb de ejemplo. Por defecto se crea durante la instalación. Asegúrese de que ha sido creada. - - - Ejemplo de Recuperación de Datos - - - - - - -
- - - "; - - while (list($clave, $nomcol) = each($columnas)) { - echo ""; - } - - echo ""; - - /** - * Obtener los resultados del conjunto de resultados. - */ - while ($fila = cubrid_fetch($resultado)) { - echo ""; - - for ($i = 0; $i < $número_campos; $i++) { - echo ""; - } - - echo ""; - } - } - /** - * El módulo de PHP en CUBRID se ejecuta en una arquitectura de 3 capas. Incluso cuando - * se llama a SELECT para el procesamiento de la transacción, es pasado como parte - * de la transacción. Por lo tanto, la transacción necesita ser reiniciada - * llamando a commit o incluso cuando se llamó a SELECT para un rendimiento - * pulido. - */ - cubrid_commit($cubrid_con); - cubrid_disconnect($cubrid_con); - ?> - - - ]]> - - - - Ejemplo de Inserción de Datos - - - - - - -
-
$nomcol
"; - echo $fila[$i]; - echo "
- - - - - ]]> - - - - - - diff --git a/reference/cubrid/functions/cubrid-bind.xml b/reference/cubrid/functions/cubrid-bind.xml deleted file mode 100644 index 32af906b67..0000000000 --- a/reference/cubrid/functions/cubrid-bind.xml +++ /dev/null @@ -1,327 +0,0 @@ - - - - - - - cubrid_bind - Vincular variables para una sentencia preparada como parámetros - - - - &reftitle.description; - - boolcubrid_bind - resourcereq_identifier - intbind_index - mixedbind_value - stringbind_value_type - - - La función cubrid_bind se usa para vincular valores a un - marcador de posición nominado o signo de interrogación correspondiente en la sentencia SQL que - fue pasada a cubrid_prepare. Si - no se da bind_value_type, string será lo - predeterminado. - - - - Si el tipo de datos a ser vinculados es BLOB/CLOB, CUBRID intentará mapear la - información como un flujo de PHP. Si el tipo real de valor vinculado no es un flujo, - CUBRID intentará convertirlo a cadena, y usarlo como la ruta completa y el nombre - de fichero de un fichero del sistema de ficheros cliente. - - - Si el tipo de datos a ser vinculados explícitamente es ENUM, el argumento - bind_value debería ser el elemento enum que esté en formato string. - - - En un entorno fragmentado de CUBRID, se debe incluir de bind_value_type en - la función cubrid_bind - - - - La siguiente tabla muestra los tipos de los valores sustitutos. - -
- Tipos de Datos de Vinculación de CUBRID - - - - Soporte - Tipo de Vinculación - Tipo SQL Correspondiente - - - - - Soportado - STRING - CHAR, VARCHAR - - - - NCHAR - NCHAR, NVARCHAR - - - - BIT - BIT, VARBIT - - - - NUMERIC or NUMBER - SHORT, INT, NUMERIC - - - - FLOAT - FLOAT - - - - DOUBLE - DOUBLE - - - - TIME - TIME - - - - DATE - DATE - - - - TIMESTAMP - TIMESTAMP - - - - OBJECT - OBJECT - - - - ENUM - ENUM - - - - BLOB - BLOB - - - - CLOB - CLOB - - - - NULL - NULL - - - No soportado - SET - SET - - - - MULTISET - MULTISET - - - - SEQUENCE - SEQUENCE - - - -
- - - - &reftitle.parameters; - - - req_identifier - Identificador de solicitud como resultado de - cubrid_prepare - - - bind_index - Índice de ubicación de los parámetros de vinculación. Comienza con 1. - - - bind_value - Valor actual para el vínculo. - - - bind_index - Un tipo de valor a vincular. (Es omitido por defecto. - Así, el sistema internamente usa una cadena por omisión. Sin embargo, se necesita - especificar el tipo exacto del valor como argumento cuando son de tipo NCHAR, - BIT, o BLOB/CLOB). - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.3.1 - - Añadido el soporte para tipos de datos BLOB/CLOB. - - - - - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_bind</function> - - -]]> - - &example.outputs; - - - - - - - Ejemplo de BLOB/CLOB de <function>cubrid_bind</function> - - -]]> - - - - - Ejemplo de BLOB/CLOB de <function>cubrid_bind</function> - - -]]> - - - - - - &reftitle.seealso; - - cubrid_execute - cubrid_prepare - - - - diff --git a/reference/cubrid/functions/cubrid-close-prepare.xml b/reference/cubrid/functions/cubrid-close-prepare.xml deleted file mode 100644 index 038e6f75be..0000000000 --- a/reference/cubrid/functions/cubrid-close-prepare.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - cubrid_close_prepare - Cerrar el gestor de solicitud - - - - &reftitle.description; - - boolcubrid_close_prepare - resourcereq_identifier - - - La función cubrid_close_prepare cierra el gestor de - solicitud dado por el argumento req_identifier, y - libera la región de memoria relacionada con el gestor. Es un alias de - cubrid_close_request. - - - - - &reftitle.parameters; - - - req_identifier - Identificador de solicitud. - - - - - - &reftitle.returnvalues; - - Devuelve &true; en caso de éxito. - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_close_prepare</function> - - -]]> - - - - - - &reftitle.seealso; - - cubrid_close_request - - - - diff --git a/reference/cubrid/functions/cubrid-close-request.xml b/reference/cubrid/functions/cubrid-close-request.xml deleted file mode 100644 index 5e315fbeca..0000000000 --- a/reference/cubrid/functions/cubrid-close-request.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - cubrid_close_request - Cerrar el gestor de solicitud - - - - &reftitle.description; - - boolcubrid_close_request - resourcereq_identifier - - - La función cubrid_close_request cierra el gestor de - solicitud dado por el argumento req_identifier, y - libera la región de memoria relacionada con el gestor. Es un alias de - cubrid_close_prepare. - - - - - &reftitle.parameters; - - - req_identifier - Identificador de solicitud. - - - - - - &reftitle.returnvalues; - - Devuelve &true; en caso de éxito. - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_close_request</function> - - -]]> - - - - - - &reftitle.seealso; - - cubrid_execute - - - - - diff --git a/reference/cubrid/functions/cubrid-col-get.xml b/reference/cubrid/functions/cubrid-col-get.xml deleted file mode 100644 index 8ebbfeeb95..0000000000 --- a/reference/cubrid/functions/cubrid-col-get.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - - cubrid_col_get - Recupera el contenido de los elementos de un tipo de colección utilizando el OID - - - - &reftitle.description; - - arraycubrid_col_get - resourceconn_identifier - stringoid - stringattr_name - - - La función cubrid_col_get se utiliza para recuperar el contenido - de los atributos de los elementos de un tipo de colección (set, multiset, sequence), - en forma de un &array;. - - - - - &reftitle.parameters; - - - - conn_identifier - - - - Identificador de conexión. - - - - - - oid - - - - OID de la instancia a utilizar para la lectura. - - - - - - attr_name - - - - Nombre del atributo que se desea leer desde la instancia. - - - - - - - - &reftitle.returnvalues; - - Un &array; (numérico, comenzando en 0) que contiene los elementos - deseados cuando la operación se ha realizado con éxito. - - - &false; (para distinguir los errores y el hecho de que los atributos tienen una - colección vacía o nula; en caso de error, se mostrará un mensaje de alerta; - en este caso, se puede recuperar el error utilizando la función - cubrid_error_code), cuando la operación ha fallado. - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_col_get</function> - - -]]> - - &example.outputs; - - - string(1) "1" - [1]=> - string(1) "2" - [2]=> - string(1) "3" -} -int(3) -]]> - - - - - diff --git a/reference/cubrid/functions/cubrid-col-size.xml b/reference/cubrid/functions/cubrid-col-size.xml deleted file mode 100644 index 9cc0a55aa1..0000000000 --- a/reference/cubrid/functions/cubrid-col-size.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - - cubrid_col_size - Obtener el número de elementos de la columna del tipo de colección usando OID - - - - &reftitle.description; - - intcubrid_col_size - resourceconn_identifier - stringoid - stringattr_name - - - La función cubrid_col_size se usa para obtener el - número de elementos de un atributo de tipo de colección (conjunto, multiconjunto, - secuencia). - - - - - &reftitle.parameters; - - - conn_identifier - Identificador de conexión. - - - oid - El OID de la instancia con la que se quiere trabajar. - - - attr_name - Nombre del atributo con el que se quiere trabajar. - - - - - - &reftitle.returnvalues; - - Número de elementos, cuando el proceso tiene éxito,&return.falseforfailure;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.3.1 - - Cambio del valor devuelto: cuando el proceso no tiene éxito devuelve false, no -1. - - - - - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_col_size</function> - - -]]> - - &example.outputs; - - - string(1) "1" - [1]=> - string(1) "2" - [2]=> - string(1) "3" -} -int(3) -]]> - - - - - diff --git a/reference/cubrid/functions/cubrid-column-names.xml b/reference/cubrid/functions/cubrid-column-names.xml deleted file mode 100644 index f6a311bbf1..0000000000 --- a/reference/cubrid/functions/cubrid-column-names.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - cubrid_column_names - Obtener los nombres de las columnas del resultado - - - - &reftitle.description; - - arraycubrid_column_names - resourcereq_identifier - - - La función cubrid_column_names se usa para obtener los - nombres de las columnas del resultado de la consulta usando req_identifier. - - - - - &reftitle.parameters; - - - req_identifier - Identificador de solicitud. - - - - - - &reftitle.returnvalues; - - Un array de valores de tipo string que contiene los nombres de las columnas, cuando el proceso tiene éxito, &return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_column_names</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_prepare - cubrid_execute - cubrid_column_types - - - - - diff --git a/reference/cubrid/functions/cubrid-column-types.xml b/reference/cubrid/functions/cubrid-column-types.xml deleted file mode 100644 index c59fb7ebb8..0000000000 --- a/reference/cubrid/functions/cubrid-column-types.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - cubrid_column_types - Obtener los tipos de columnas del resultado - - - - &reftitle.description; - - arraycubrid_column_types - resourcereq_identifier - - - La función cubrid_column_types obtiene los tipos de columnas de - los resultados de la consulta usando req_identifier. - - - - - &reftitle.parameters; - - - req_identifier - Identificador de solicitud. - - - - - - &reftitle.returnvalues; - - Un array de valores de tipo string que contiene los tipos de las columnas, cuando el proceso tiene éxito,&return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_column_types</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_column_names - cubrid_prepare - cubrid_execute - - - - - diff --git a/reference/cubrid/functions/cubrid-commit.xml b/reference/cubrid/functions/cubrid-commit.xml deleted file mode 100644 index dd2af3872b..0000000000 --- a/reference/cubrid/functions/cubrid-commit.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - - cubrid_commit - Consigna una transacción - - - - &reftitle.description; - - boolcubrid_commit - resourceconn_identifier - - La función cubrid_commit se usa para ejecutar el envío - de la transacción a la que apunta conn_handle, - actualmente en progreso. La conexión al servidor se cierra después de - llamar a la función cubrid_commit; sin embargo, - el gestor de conexión todavía es válido. - - - En CUBRID PHP, se deshabilita un modo de auto consigna por omisión para la administración de transacciones. - Se puede establecer usando cubrid_set_autocommit. - Se puede obtener su estado usando cubrid_get_autocommit. Antes de comenzar una transacción, - acuérdese de deshabilitar el modo de auto consigna. - - - - - &reftitle.parameters; - - - conn_identifier - Identificador de conexión. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_commit</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_rollback - cubrid_get_autocommit - cubrid_set_autocommit - - - - diff --git a/reference/cubrid/functions/cubrid-connect-with-url.xml b/reference/cubrid/functions/cubrid-connect-with-url.xml deleted file mode 100644 index c97acafcfd..0000000000 --- a/reference/cubrid/functions/cubrid-connect-with-url.xml +++ /dev/null @@ -1,242 +0,0 @@ - - - - - - cubrid_connect_with_url - Establecer el entorno para la conexión al servidor de CUBRID - - - - &reftitle.description; - - resourcecubrid_connect_with_url - stringconn_url - stringuserid - stringpasswd - boolnew_link&false; - - - La función cubrid_connect_with_url se usa para - establecer el entorno de conexión a su servidor usando la información - de conexión pasada con un argumento de cadena de url. Si la característica HA está - habilitada en CUBRID, se debe especificar la información de conexión del - servidor de emergencia, el cual se usa para la recuperación de fallos cuando sucede uno, en - el argumento de cadena de url de esta función. Si el nombre de usuario y la contraseña no se - dan se realizará la conexión "PUBLIC" por omisión. - - - <url> ::= CUBRID:<host>:<db_name>:<db_user>:<db_password>:[?<properties>] - - - <properties> ::= <property> [&<property>] - - - <properties> ::= alhosts=<alternative_hosts>[ &rctime=<time>] - - - <properties> ::= login_timeout=<milli_sec> - - - <properties> ::= query_timeout=<milli_sec> - - - <properties> ::= disconnect_on_query_timeout=true|false - - - <alternative_hosts> ::= <standby_broker1_host>:<port> [,<standby_broker2_host>:<port>] - - - <host> := HOSTNAME | IP_ADDR - - - <time> := SECOND - - - <milli_sec> := MILLI SECOND - - - host : Un nombre de host o dirección IP de la base de datos maestra - db_name : Un nombre de la base de datos - db_user : Un nombre del usuario de la base de datos - db_password : Una contraseña de usuario de la base de datos - - alhosts: Especifica la información del agente del servidor de emergencia, el cual se - usa para la recuperación de fallos cuando es imposible conectar al servidor activo. - Se pueden especificar múltiples agentes para la recuperación de fallos, y la conexión a los agentes - se intenta en el orden listado en alhosts - - rctime : Un intervalo entre los intentos de conexión al agente activo en - el que ocurrió el fallo. Después de que ocurra un fallo, el sistema se conecta al - agente especificado por althosts (recuperación de fallos), finaliza la transacción, y después - intenta conectarse al agente activo de la base de datos maestra cada rctime. - El valor predeterminado es 600 segundos. - - - login_timeout : Valor de tiempo de espera (unidad: mseg.) para la identificación en la base de datos. El valor - predeterminado es 0, lo que significa un aplazamiento infinito. - - - query_timeout : Valor de tiempo de espera (unidad: mseg.) para la solicitud de consulta. Cuando finaliza - el tiempo de espera, se envía al servidor un mensaje para cancelar la transferencia de la consulta. El valor - devuelto puede depender de de la configuración de disconnect_on_query_timeout; incluso si el - mensaje para cancelar una petición es enviado al servidor, tal peticioón puede realizarse. - - - disconnect_on_query_timeout : Configura un valor para establecer si devolver inmediantamente - un error de función que está siendo ejecutada al finalizar el tiempo de espera. El valor predeterminado es false. - - - - - ? y :, que son usados como identificadores - en el URL de conexión de PHP, no pueden ser incluidos en la contraseña. El siguiente es - un ejemplo de una contraseña que no es válida para usarla como URL de conexión ya que contiene - "?:". - - - $url = "CUBRID:localhost:33000:tdb:dba:12?:?login_timeout=100"; - - - Las contraseñas que contengan ? o : - se pueden pasar como un parámetro aparte. - - - $url = "CUBRID:localhost:33000:tbd:::?login_timeout=100"; - - - $conn = cubrid_connect_with_url($url, "dba", "12?"); - - - Si el usuario o la contraseña están vacíos no se podrá borrar ":". He aquí un - ejemplo: - - - $url = "CUBRID:localhost:33000:demodb:::"; - - - - - - &reftitle.parameters; - - - conn_url - Una cadena de caracteres que contiene la información de conexión al servidor. - - - userid - El nombre de usuario de la base de datos. - - - passwd - La contraseña del usuario. - - - new_link - Si se hace una segunda llamada a - cubrid_connect_with_url con los mismos argumentos, - no se establecerá una nueva conexión, en su lugar, se devolverá el identificador - de conexión de la conexión ya abierta. El - parámetro new_link modifica este comportamiento y - hace que cubrid_connect_with_url abra siempre una nueva - conexión, incluso si cubrid_connect_with_url fue - llamada antes con los mismos parámetros. - - - - - - &reftitle.returnvalues; - - El identificador de conexión, cuando el proceso tiene éxito,&return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_connect_with_url</function>, url sin propiedades - - -]]> - - - - - Ejemplo de <function>cubrid_connect_with_url</function>, url con propiedades - - -]]> - - - - - - &reftitle.seealso; - - cubrid_connect - cubrid_pconnect - cubrid_pconnect_with_url - cubrid_disconnect - cubrid_close - - - - - diff --git a/reference/cubrid/functions/cubrid-connect.xml b/reference/cubrid/functions/cubrid-connect.xml deleted file mode 100644 index 05ffea932f..0000000000 --- a/reference/cubrid/functions/cubrid-connect.xml +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - - cubrid_connect - Abrir una conexión al servidor CUBRID - - - - &reftitle.description; - - resourcecubrid_connect - stringhost - intport - stringdbname - stringuserid - stringpasswd - boolnew_link&false; - - - La función cubrid_connect se usa para establecer el - entorno para la conexión al servidor usando la dirección del servidor, - número de puerto, nombre de la base de datos, nombre de usuario, y contraseña. Si no - se dan el nombre de usuario y la contraseña, se realizará la conexión "PUBLIC" por - defecto. - - - - - &reftitle.parameters; - - - host - Nombre del host o dirección IP del servidor CAS de CUBRID. - - - port - Número de puerto del servidor CAS de CUBRID (BROKER_PORT configurado en $CUBRID/conf/cubrid_broker.conf). - - - dbname - Nombre de la base de datos. - - - userid - Nombre de usuario para la base de datos. Si no se da, el valor - por omisión es "public". - - - passwd - Contraseña del usuario. Si no se da, el valor por omisión es "". - - - new_link - Si se hace una segunda llamada a - cubrid_connect con los mismos argumentos, no se - establecerá una nueva conexión, en su lugar, se devolverá el identificador - de conexión de la conexión ya abierta. El - parámetro new_link modifica este comportamiento y - hace que cubrid_connect abra siempre una nueva conexión, - incluso si cubrid_connect fue llamada antes con los - mismos parámetros. - - - - - - &reftitle.returnvalues; - - El identificador de conexión, cuando el proceso tiene éxito,&return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_connect</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_pconnect - cubrid_connect_with_url - cubrid_pconnect_with_url - cubrid_disconnect - cubrid_close - - - - - diff --git a/reference/cubrid/functions/cubrid-current-oid.xml b/reference/cubrid/functions/cubrid-current-oid.xml deleted file mode 100644 index f70f9250a2..0000000000 --- a/reference/cubrid/functions/cubrid-current-oid.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - cubrid_current_oid - Obtener el OID de la posición del cursor actual - - - - &reftitle.description; - - stringcubrid_current_oid - resourcereq_identifier - - - La función cubrid_current_oid se usa para obtener el - oid de la posición del cursor actual desde el resultado de la consulta. Para usar - cubrid_current_oid, la consulta ejecutada debe ser una - consulta actualizable, y se debe incluir la opción CUBRID_INCLUDE_OID durante - la ejecución de la consulta. - - - - - &reftitle.parameters; - - - req_identifier - Identificador de solicitud. - - - - - - &reftitle.returnvalues; - - Oid de la posición del cursor actual, cuando el proceso tiene éxito,&return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_current_oid</function> - - -]]> - - &example.outputs; - - X - [f_name] => Mixed -) -]]> - - - - - - - &reftitle.seealso; - - cubrid_execute - - - - - diff --git a/reference/cubrid/functions/cubrid-disconnect.xml b/reference/cubrid/functions/cubrid-disconnect.xml deleted file mode 100644 index 9dac5a998a..0000000000 --- a/reference/cubrid/functions/cubrid-disconnect.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - cubrid_disconnect - Cerrar una conexión a una base de datos - - - - &reftitle.description; - - boolcubrid_disconnect - resourceconn_identifier - - - La función cubrid_disconnect cierra el gestor de - conexión y se desconecta del servidor. Si algún gestor de solicitud no se ha sido cerrado en este punto, - será cerrado. Es similar a la función de CUBRID compatible con MySQL cubrid_close. - - - - - &reftitle.parameters; - - - conn_identifier - Identificador de conexión. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_disconnect</function> - - -]]> - - - - - - &reftitle.seealso; - - cubrid_close - cubrid_connect - cubrid_connect_with_url - - - - - diff --git a/reference/cubrid/functions/cubrid-drop.xml b/reference/cubrid/functions/cubrid-drop.xml deleted file mode 100644 index dfaa964cb5..0000000000 --- a/reference/cubrid/functions/cubrid-drop.xml +++ /dev/null @@ -1,180 +0,0 @@ - - - - - - - cubrid_drop - Borrar una instancia usando OID - - - - &reftitle.description; - - boolcubrid_drop - resourceconn_identifier - stringoid - - - La función cubrid_drop se usa para borrar una - instancia de la base de datos usando el oid de la instancia. - - - - - &reftitle.parameters; - - - conn_identifier - Identificador de conexión. - - - oid - Oid de la instancia que se quiere borrar. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_drop</function> - - -]]> - - &example.outputs; - - - string(1) "1" - ["b"]=> - array(3) { - [0]=> - string(1) "1" - [1]=> - string(1) "2" - [2]=> - string(1) "3" - } - ["c"]=> - array(4) { - [0]=> - string(2) "11" - [1]=> - string(2) "22" - [2]=> - string(2) "33" - [3]=> - string(3) "333" - } - ["d"]=> - string(10) "a " -} - ---- Después de Drop: --- -array(4) { - ["a"]=> - string(1) "2" - ["b"]=> - array(3) { - [0]=> - string(1) "4" - [1]=> - string(1) "5" - [2]=> - string(1) "7" - } - ["c"]=> - array(4) { - [0]=> - string(2) "44" - [1]=> - string(2) "55" - [2]=> - string(2) "66" - [3]=> - string(3) "666" - } - ["d"]=> - string(10) "b " -} -]]> - - - - - - &reftitle.seealso; - - cubrid_is_instance - - - - - diff --git a/reference/cubrid/functions/cubrid-error-code-facility.xml b/reference/cubrid/functions/cubrid-error-code-facility.xml deleted file mode 100644 index d3bc08145a..0000000000 --- a/reference/cubrid/functions/cubrid-error-code-facility.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - cubrid_error_code_facility - Obtener el código de error del dispositivo - - - - &reftitle.description; - - intcubrid_error_code_facility - - - - La función cubrid_error_code_facility se usa para - obtener el código de dispositivo (nivel en el que ocurrió el error) desde el código - de error del error que ocurrió durante la ejecución de la API. Normalmente, se puede - obtener el código de error cuando la API devuelve false como valor de retorno. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Código de dispositivo del código de error que ocuriió: - CUBRID_FACILITY_DBMS, CUBRID_FACILITY_CAS, - CUBRID_FACILITY_CCI, CUBRID_FACILITY_CLIENT. - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_error_code_facility</function> - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - cubrid_error_code - cubrid_error_msg - - - - - diff --git a/reference/cubrid/functions/cubrid-error-code.xml b/reference/cubrid/functions/cubrid-error-code.xml deleted file mode 100644 index 94f4ebfc9a..0000000000 --- a/reference/cubrid/functions/cubrid-error-code.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - cubrid_error_code - Obtener el código de error de la llamada a una función más reciente - - - - &reftitle.description; - - intcubrid_error_code - - - - La función cubrid_error_code se usa para obtener el - código de error del error que ocurrión durante la ejecución de la API. Normalmente - obtiene el código de error cuando la API devuelve false como valor de retorno. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Código de error del error que ocurrió, o 0 (cero) si no - ocurre ningún error. - - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_error_code</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_error_code_facility - cubrid_error_msg - - - - - diff --git a/reference/cubrid/functions/cubrid-error-msg.xml b/reference/cubrid/functions/cubrid-error-msg.xml deleted file mode 100644 index ebf14806be..0000000000 --- a/reference/cubrid/functions/cubrid-error-msg.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - cubrid_error_msg - Obtener el último mensaje de error de la llamada a la función más reciente - - - - &reftitle.description; - - stringcubrid_error_msg - - - - La función cubrid_error_msg se usa para obtener el - mensaje de error que ocurrió durante la utilización de la API CUBRID. Normalmente obtiene - el mensaje de error cuando la API devuelve false como valor de retorno. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El mensaje de error que ocurrió. - - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_error_msg</function> - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - cubrid_error_code - cubrid_error_code_facility - - - - - diff --git a/reference/cubrid/functions/cubrid-execute.xml b/reference/cubrid/functions/cubrid-execute.xml deleted file mode 100644 index 12615b6028..0000000000 --- a/reference/cubrid/functions/cubrid-execute.xml +++ /dev/null @@ -1,195 +0,0 @@ - - - - - - - cubrid_execute - Ejecutar una sentencia SQL preparada - - - - &reftitle.description; - - resourcecubrid_execute - resourceconn_identifier - stringsql - intoption0 - - - boolcubrid_execute - resourcerequest_identifier - intoption0 - - - La función cubrid_execute se usa para ejecutar la - sentencia SQL dada. Ejecuta la consulta usando - conn_identifier y SQL, y luego devuelve el - gestor de solicitud creado. Se usa para la simple ejecución de la consulta, - donde el parámetro de enlace no es necesario. Además, la - función cubrid_execute se usa para ejecutar la - sentencia preparada por medio de cubrid_prepare y - cubrid_bind. En este momento se necesitan especificar - los argumentos request_identifier y - option. - - - El argumento option se usa para determinar si recibir el OID - después de la ejecución de la consulta y si ejecutar la consulta en modo síncrono - o asíncrono. Se pueden especificar CUBRID_INCLUDE_OID y CUBRID_ASYNC (o - CUBRID_EXEC_QUERY_ALL si se desea ejecutar múltiples sentencias SQL) usando - un operador OR a nivel de bit. Si no se especifica, ninguna de - ellas será seleccionada. Si la bandera CUBRID_EXEC_QUERY_ALL está activa, el modo - síncrono (sync_mode) se usa para devolver los resultados de la consulta, y en esos casos las - siguientes reglas serán aplicadas: - - - El valor devuelto es el resultado de la primera petición. - - Si sucede un error en la consulta, la ejecución se procesa como un - fallo. - - - En una consulta compuesta por c1, c2, c3, si sucede - un error en c2 después del éxito de la ejecución de c1, el resultado de c1 permanece - válido. Esto es, los éxitos previos en las ejecucuiones de consultas no se repiten - cuando sucede un error. - - - Si una consulta se ejecuta de forma satisfactoria, el resultado de la segunda consulta puede - obtenerse usando la función cubrid_next_result. - - - - Si el primer argumento es request_identifier para - ejecutar la función cubrid_prepare, se puede especificar - una opción, solamente CUBRID_ASYNC. - - - - - &reftitle.parameters; - - - conn_identifier - Identificador de conexión. - - - sql - SQL a ser ejecutado. - - - option - La opción de ejecución de la consulta CUBRID_INCLUDE_OID, CUBRID_ASYNC, CUBRID_EXEC_QUERY_ALL. - - - request_identifier - Identificador de cubrid_prepare. - - - - - - &reftitle.returnvalues; - - Gestor de solicitud, cuando el proceso tiene éxito y el primer parámetro es - conn_identifier; &true;, cuando el proceso tiene éxito y el primer argumento es - request_identifier,&return.falseforfailure;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.4.0 - - Añade CUBRID_EXEC_QUERY_ALL como opción nueva. - - - - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_execute</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_prepare - cubrid_bind - cubrid_next_result - cubrid_close_request - cubrid_commit - cubrid_rollback - - - - - diff --git a/reference/cubrid/functions/cubrid-fetch.xml b/reference/cubrid/functions/cubrid-fetch.xml deleted file mode 100644 index 6d5a990bab..0000000000 --- a/reference/cubrid/functions/cubrid-fetch.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - cubrid_fetch - Obtener la siguiente fila de un conjunto de resultados - - - - &reftitle.description; - - mixedcubrid_fetch - resourceresult - inttypeCUBRID_BOTH - - - La función cubrid_fetch se usa para obtener una única fila del resultado de la consulta. El cursor se mueve automáticamente a la siguiente columna después de obtener el resultado. - - - - - &reftitle.parameters; - - - result - result proviene de una llamada a la función cubrid_execute. - - - type - Tipo de array del resultado obtenido: CUBRID_NUM, CUBRID_ASSOC, - CUBRID_BOTH, CUBRID_OBJECT. Si se operan con objetos lob, se puede - usar CUBRID_LOB. - - - - - - &reftitle.returnvalues; - Un array de resultados u objeto, cuando el proceso tiene éxito. - &false;, cuando no existen más filas; NULL, cuando el proceso no tiene éxito. - El resultado se puede recibir como array o como objeto, por lo que se puede decidir qué tipo de datos usar estableciendo el argumento type. La variable type se puede establecer a uno de los siguientes valores: - - CUBRID_NUM : Array numérico (basado en 0) - CUBRID_ASSOC : Array asociativo - CUBRID_BOTH : Array numérico y asociativo (predeterminado) - CUBRID_OBJECT : Objeto que tiene el nombre del atributo como el nombre de la columna del resultado de la consulta - - Cuando se omite el argumento type, el resultado será recibido usando la opción predeterminada CUBRID_BOTH. Cuando se quiere recibir el resultado de la consulta como objeto, el nombre de la columna del resultado debe obedecer las reglas de nombres de los identificadores de PHP. Por ejemplo, un nombre de columna como "count(*)" no puede ser recibido como objeto. - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_fetch</function> - - 10000"); - -printf("%-40s %-10s %-6s %-20s\n", "name", "area", "seats", "address"); -while ($fila = cubrid_fetch($solicitud)) { - printf("%-40s %-10s %-6s %-20s\n", - $fila["name"], $fila["area"], $fila["seats"], $fila["address"]); -} - -// si se operan con objetos lob, se puede usar cubrid_fetch($solicitud, CUBRID_LOB) - -cubrid_close_request($solicitud); - -cubrid_disconnect($conexión); -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_execute - cubrid_fetch_array - cubrid_fetch_row - cubrid_fetch_assoc - cubrid_fetch_object - - - - - diff --git a/reference/cubrid/functions/cubrid-free-result.xml b/reference/cubrid/functions/cubrid-free-result.xml deleted file mode 100644 index aea3b0842a..0000000000 --- a/reference/cubrid/functions/cubrid-free-result.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - cubrid_free_result - Liberar la memoria ocupada por los datos del resultado - - - - &reftitle.description; - - boolcubrid_free_result - resourcereq_identifier - - - Esta función libera la memoria ocupada por los datos del resultado. Devuelve - &true; en caso de éxito o &false; en caso de error. Observe que sólo se puede liberar el - buffer de obtención del cliente, y si se quiere liberar toda la memoria, use la función - cubrid_close_request. - - - - - &reftitle.parameters; - - - req_identifier - Éste es el identificador de solicitud. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_free_result</function> - - -]]> - - &example.outputs; - - - string(5) "20005" - ["athlete"]=> - string(12) "Hayes Joanna" - ["host_year"]=> - string(4) "2004" - ["score"]=> - string(5) "12.37" - ["unit"]=> - string(4) "time" -} -]]> - - - - - - diff --git a/reference/cubrid/functions/cubrid-get-autocommit.xml b/reference/cubrid/functions/cubrid-get-autocommit.xml deleted file mode 100644 index 2e7f6f41d9..0000000000 --- a/reference/cubrid/functions/cubrid-get-autocommit.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - cubrid_get_autocommit - Recupera el modo auto-commit de la conexión - - - - &reftitle.description; - - boolcubrid_get_autocommit - resourceconn_identifier - - - La función cubrid_get_autocommit se utiliza - para recuperar el estado del modo auto-commit de la conexión - a la base de datos CUBRID. - - - En CUBRID 8.4.0, el modo auto-commit está desactivado por omisión para la - gestión de las transacciones. - - - En CUBRID 8.4.1, el modo auto-commit está activado por omisión para la - gestión de las transacciones. - - - - - &reftitle.parameters; - - - conn_identifier - Identificador de conexión. - - - - - - &reftitle.returnvalues; - - &true;, cuando el modo auto-commit está activo. - - - &false;, cuando el modo auto-commit está inactivo. - - - &null; Si ocurre un error. - - - - - &reftitle.seealso; - - cubrid_set_autocommit - cubrid_commit - - - - diff --git a/reference/cubrid/functions/cubrid-get-charset.xml b/reference/cubrid/functions/cubrid-get-charset.xml deleted file mode 100644 index f53fc3e804..0000000000 --- a/reference/cubrid/functions/cubrid-get-charset.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - cubrid_get_charset - Devolver el conjunto de caracteres de la conexión CUBRID actual - - - - &reftitle.description; - - stringcubrid_get_charset - resourceconn_identifier - - - Esta función devuelve el conjunto de caracteres de la conexión CUBRID actual y es similar - a la función de CUBRID compatible con MySQL - cubrid_client_encoding. - - - - - &reftitle.parameters; - - - conn_identifier - La conexión CUBRID. - - - - - - &reftitle.returnvalues; - - Una cadena que representa el conjunto de caracteres de la conexión CUBRID; en caso de éxito,&return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_get_charset</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_client_encoding - - - - - diff --git a/reference/cubrid/functions/cubrid-get-class-name.xml b/reference/cubrid/functions/cubrid-get-class-name.xml deleted file mode 100644 index 96822346c1..0000000000 --- a/reference/cubrid/functions/cubrid-get-class-name.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - cubrid_get_class_name - Obtener el nombre de la clase usando OID - - - - &reftitle.description; - - stringcubrid_get_class_name - resourceconn_identifier - stringoid - - - La función cubrid_get_class_name se usa para obtener el - nombre de la clase del oid. No funciona al seleccionar - datos desde las tablas del sistema, por ejemplo db_class. - - - - - &reftitle.parameters; - - - conn_identifier - Identificador de conexión. - - - oid - Oid de la instancia de la que se quiere comprobar su existencia. - - - - - - &reftitle.returnvalues; - - El nombre de la clase cuando el proceso tiene éxito,&return.falseforfailure;. - - - &false;, cuando el proceso no tiene éxito. - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_get_class_name</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_is_instance - cubrid_drop - - - - diff --git a/reference/cubrid/functions/cubrid-get-client-info.xml b/reference/cubrid/functions/cubrid-get-client-info.xml deleted file mode 100644 index b0729ea545..0000000000 --- a/reference/cubrid/functions/cubrid-get-client-info.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - cubrid_get_client_info - Devolver la versión de la biblioteca cliente - - - - &reftitle.description; - - stringcubrid_get_client_info - - - - Esta función devuelve una cadena que representa la versión de la biblioteca cliente. - - - - - &reftitle.parameters; - - - - - - - &reftitle.returnvalues; - - Una cadena que representa la versión de la biblioteca cliente; en caso de éxito,&return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_get_client_info</function> - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/cubrid/functions/cubrid-get-db-parameter.xml b/reference/cubrid/functions/cubrid-get-db-parameter.xml deleted file mode 100644 index cd314e8fb1..0000000000 --- a/reference/cubrid/functions/cubrid-get-db-parameter.xml +++ /dev/null @@ -1,257 +0,0 @@ - - - - - - cubrid_get_db_parameter - Devuelve los parámetros de la base de datos CUBRID - - - - &reftitle.description; - - arraycubrid_get_db_parameter - resourceconn_identifier - - - Esta función devuelve los parámetros de la base de datos CUBRID ,&return.falseforfailure;. - Devuelve un array asociativo con los valores de los siguientes - parámetros: - - - PARAM_ISOLATION_LEVEL - PARAM_LOCK_TIMEOUT - PARAM_MAX_STRING_LENGTH - PARAM_AUTO_COMMIT - - - Parámetros de la base de datos - - - - Parámetro - Descripción - - - - - PARAM_ISOLATION_LEVEL - El nivel de aislamiento de la transacción. - - - LOCK_TIMEOUT - CUBRID proporciona la característica de bloqueo de tiempo de espera, que establece el tiempo - de espera (en segundos) para el bloqueo hasta que el ajuste de bloqueo de transacción se - permite. El valor predeterminado del parámetro lock_timeout_in_secs es -1, lo que - significa que la aplicación cliente esperará indefinidamente hasta que se - permita el bloqueo de transacción. - - - - PARAM_AUTO_COMMIT - En CUBRID PHP, el modo de auto consigna es desabilitado por omisión por - el gestor de transacciones. Puede establecerse usando - la función cubrid_set_autocommit. - - - - -
- - - La siguiente tabla muestra los niveles de aislamiento desde 1 hasta 6. Consiste en - esquema de tabla (fila) y nivel de aislamiento: - - Niveles de Aislamiento Soportados por CUBRID - - - - Nombre - Descripción - - - - - SERIALIZABLE (6) - En este nivel de aislamiento, los problemas concernientes a la concurrencia (p.ej. - lectura basura, lectura no repetible, lectura fantasma, etc.) no - ocurren. - - - CLASE DE LECTURA REPETIBLE con INSTANCIAS DE LECTURA REPETIBLE (5) - Otra transacción T2 no puede actualizar el esquema de una tabla A mientras - la transacción T1 está viendo la tabla A. - La transacción T1 puede experimentar lectura fantasma para el registro R que fue - insertado por otra transacción T2 cuando está obtenido repetidamente un - registro especificado. - - - CLASE DE LECTURA REPETIBLE con INSTANCIAS CONSIGNADAS DE LECTURA (o ESTABILIDAD DE CURSOR) (4) - Otra transacción T2 no puede actualizar el esquema de una tabla A mientras - la transacción T1 está viendo la tabla A. - La transacción T1 puede experimentar lectura R (lectura no repetible) que fue - actualizada y consignada por otra transacción T2 cuando está obteniendo - repetidamente el registro R. - - - CLASE DE LECTURA REPETIBLE con INSTANCIAS NO CONSIGNADAS DE LECTURA (3) - Nivel de aislamiento predeterminado. Otra transacción T2 no puede actualizar - el esquema de la tabla A mientras la transacción T1 está viendo la tabla A. - La transacción T1 puede experimentar lectura R' (lectura basura) para el registro que - fue actualizado pero no consignado por otra transacción T2. - - - CLASE CONSIGNADA DE LECTURA con INSTANCIAS CONSIGNADAS DE LECTURA (2) - La transacción T1 puede experimentar lectura A' (lectura no repetible) para - la tabla que fue actualizada y consignada por otra transacción T2 - mientras que está viendo la tabla A repetidamente. La transacción T1 puede experimentar - lectura R' (lectura no repetible) para el registro que fue actualizado y - consignado por otra transacción T2 mientras se está obteniendo el registro - R repetidamente. - - - CLASE CONSIGNADA DE LECTURA con INSTANCIAS NO CONSIGNADAS DE LECTURA (1) - La transacción T1 puede experimentar lectura A' (lectura no repetible) para - la tabla que fue actualizada y consignada por otra transacción T2 - mientras que se ve repetidamente la tabla A. La transacción T1 puede experimentar - lectura R' (lectura basura) para el registro qeu fue actualizado pero no consignado - por otra transacción T2. - - - -
-
-
- - - &reftitle.parameters; - - - conn_identifier - - La conexión CUBRID. Si el identificador de conexión no se especifica, - se asume el último enlace abierto por cubrid_connect. - - - - - - - &reftitle.returnvalues; - - Una matriz asociativa con los parámetros de la base de datos CUBRID; en caso de éxito,&return.falseforfailure;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.4.0 - - Cambia LOCK_TIMEOUT a PARAM_LOCK_TIMEOUT, y MAX_STRING_LENGTH a - PARAM_MAX_STRING_LENGTH en el resultado. - - - - - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_get_db_parameter</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_set_db_parameter - cubrid_get_autocommit - - -
- diff --git a/reference/cubrid/functions/cubrid-get-query-timeout.xml b/reference/cubrid/functions/cubrid-get-query-timeout.xml deleted file mode 100644 index 404a923c09..0000000000 --- a/reference/cubrid/functions/cubrid-get-query-timeout.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - cubrid_get_query_timeout - Obtener el valor del tiempo de espera de consulta de la petición - - - - &reftitle.description; - - intcubrid_get_query_timeout - resourcereq_identifier - - - La función cubrid_get_query_timeout se usa para obtener - el tiempo de espera de consulta de la petición. - - - - - &reftitle.parameters; - - - req_identifier - Identificador de petición. - - - - - - &reftitle.returnvalues; - - Devuelve el valor de tiempo de espera de la consulta en milisegundos de la petición actual en caso de éxito,&return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_get_query_timeout</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_set_query_timeout - - - - diff --git a/reference/cubrid/functions/cubrid-get-server-info.xml b/reference/cubrid/functions/cubrid-get-server-info.xml deleted file mode 100644 index 36971dde79..0000000000 --- a/reference/cubrid/functions/cubrid-get-server-info.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - cubrid_get_server_info - Devolver la versión del servidor CUBRID - - - - &reftitle.description; - - stringcubrid_get_server_info - resourceconn_identifier - - - Esta función devuelve una cadena que representa la versión del servidor CUBRID. - - - - - &reftitle.parameters; - - - conn_identifier - La conexión CUBRID. - - - - - - &reftitle.returnvalues; - - Una cadena que representa la versión del servidor CUBRID; en caso de éxito,&return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_get_server_info</function> - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/cubrid/functions/cubrid-get.xml b/reference/cubrid/functions/cubrid-get.xml deleted file mode 100644 index 8a5a7947a0..0000000000 --- a/reference/cubrid/functions/cubrid-get.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - cubrid_get - Obtener una columna usando OID - - - - &reftitle.description; - - mixedcubrid_get - resourceconn_identifier - stringoid - mixedattr - - - La función cubrid_get se usa para obtener el atributo - de la instancia del oid dado. Se puede obtener - un solo atributo usando el tipo de datos de cadena para el - argumento attr, o muchos atributos usando el tipo de datos - array para el argumento attr. - - - - - &reftitle.parameters; - - - conn_identifier - Identificador de conexión. - - - oid - OID de la instancia que se quiere leer. - - - attr - Nombre del atributo que se quiere leer. - - - - - - - &reftitle.returnvalues; - - Contenido del atributo solicitado, cuando el proceso tiene éxito; Cuando - attr se establece al tipo de datos de cadena, el resultado es - devuelto como una cadena; cuando attr se establece como tipo - de datos array (númerico basado en 0), el resultado es devuelto como un - array asociativo. Cuanso se omite attr, entonces todos - los atributos se reciben como array. - - - &false; cuando el proceso no tiene éxito o el resultado es NULL (Si ocurre un error para - diferenciar una cadena vacía de NULL, se imprime un mensaje de advertencia. - Se puede comprobar el error usando cubrid_error_code) - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_get</function> - - -]]> - - &example.outputs; - - - string(1) "1" - ["b"]=> - array(3) { - [0]=> - string(1) "1" - [1]=> - string(1) "2" - [2]=> - string(1) "3" - } - ["c"]=> - array(4) { - [0]=> - string(2) "11" - [1]=> - string(2) "22" - [2]=> - string(2) "33" - [3]=> - string(3) "333" - } - ["d"]=> - string(10) "a " -} -]]> - - - - - - &reftitle.seealso; - - cubrid_put - - - - - diff --git a/reference/cubrid/functions/cubrid-insert-id.xml b/reference/cubrid/functions/cubrid-insert-id.xml deleted file mode 100644 index 12ed28b9a5..0000000000 --- a/reference/cubrid/functions/cubrid-insert-id.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - - cubrid_insert_id - Devuelve el ID generado por la última columna actualizada AUTO_INCREMENT - - - - &reftitle.description; - - stringcubrid_insert_id - resourceconn_identifier - - - La función cubrid_insert_id recupera el ID - generado para la columna AUTO_INCREMENT que fue actualizada por la consulta - INSERT previa. Devuelve 0 si la consulta previa no generó nuevas - filas, o FALSE en caso de error. - - - - - CUBRID soporta AUTO_INCREMENT para más de una columna en una tabla. En - la mayoría de los casos, habrá una única columna AUTO_INCREMENT en una tabla. Si - hay varias columnas AUTO_INCREMENT, esta función no debería ser - usada aunque devuelva un valor. - - - - - - &reftitle.parameters; - - - conn_identifier - El Identificador de conexión previamente obtenido por una llamada a - cubrid_connect. - - - - - - - &reftitle.returnvalues; - - Un string representa el ID generado para una columna AUTO:INCREMENT por la - consulta previa, en caso de éxito. - - - 0, si la consulta previa no generó nuevas filas. - - - &false; en caso de fallo. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.4.0 - - Cambia el valor devuelto de un array a un string; elimina el primer - parámetro class_name. - - - - - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_insert_id</function> - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/cubrid/functions/cubrid-is-instance.xml b/reference/cubrid/functions/cubrid-is-instance.xml deleted file mode 100644 index 065cea7cad..0000000000 --- a/reference/cubrid/functions/cubrid-is-instance.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - cubrid_is_instance - Comprobar si existe la instancia apuntada por OID - - - - &reftitle.description; - - intcubrid_is_instance - resourceconn_identifier - stringoid - - - La función cubrid_is_instance se usa para comprobar - si existe la instancia apuntada por el oid dado - o no. - - - - - &reftitle.parameters; - - - conn_identifier - Identificador de conexión. - - - oid - OID de la instancia que se quiere comprobar su existencia. - - - - - - &reftitle.returnvalues; - - 1, si tal instancia existe; - - - 0, si tal instancia no existe; - - - -1, en caso de error - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_is_instance</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_drop - cubrid_get_class_name - - - - - diff --git a/reference/cubrid/functions/cubrid-lob-close.xml b/reference/cubrid/functions/cubrid-lob-close.xml deleted file mode 100644 index 4202a353bc..0000000000 --- a/reference/cubrid/functions/cubrid-lob-close.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - cubrid_lob_close - Cerrar información BLOB/CLOB - - - - &reftitle.description; - - boolcubrid_lob_close - arraylob_identifier_array - - - cubrid_lob_close se usa para cerrar todos los BLOB/CLOB - devueltos desde cubrid_lob_get. - - - - - &reftitle.parameters; - - - lob_identifier_array - Array de identificadores LOB devuelto desde cubrid_lob_get. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_lob_close</function> - - -]]> - - - - - - &reftitle.seealso; - - cubrid_lob_get - cubrid_lob_size - cubrid_lob_export - cubrid_lob_send - - - - - diff --git a/reference/cubrid/functions/cubrid-lob-export.xml b/reference/cubrid/functions/cubrid-lob-export.xml deleted file mode 100644 index 2b89740f73..0000000000 --- a/reference/cubrid/functions/cubrid-lob-export.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - cubrid_lob_export - Exporta datos BLOB/CLOB a un fichero - - - - &reftitle.description; - - boolcubrid_lob_export - resourceconn_identifier - resourcelob_identifier - stringpath_name - - - La función cubrid_lob_export se utiliza para recuperar - los datos BLOB/CLOB desde la base de datos CUBRID, y guardar sus contenidos - en un fichero. Para utilizar esta función, es necesario utilizar primero la - función cubrid_lob_get para recuperar las informaciones de - los BLOB/CLOB desde CUBRID. - - - - - &reftitle.parameters; - - - conn_identifier - Identificador de conexión. - - - lob_identifier - Identificador LOB. - - - path_name - Ruta hacia el fichero. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_lob_export</function> - - -]]> - - - - - - &reftitle.seealso; - - cubrid_lob_get - cubrid_lob_close - cubrid_lob_size - cubrid_lob_send - - - - - diff --git a/reference/cubrid/functions/cubrid-lob-get.xml b/reference/cubrid/functions/cubrid-lob-get.xml deleted file mode 100644 index b038f99f1d..0000000000 --- a/reference/cubrid/functions/cubrid-lob-get.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - cubrid_lob_get - Recupera los datos BLOB/CLOB - - - - &reftitle.description; - - arraycubrid_lob_get - resourceconn_identifier - stringsql - - - La función cubrid_lob_get se utiliza para recuperar - los datos de información meta BLOB/CLOB desde la base de datos CUBRID - (CUBRID recupera los BLOB/CLOB ejecutando una consulta SQL), y devuelve - todos los LOBs en forma de un array de recursos. Asegúrese - de que el SQL recupere únicamente una columna y que el tipo de datos - sea BLOB o CLOB. - - - Tenga en cuenta que el uso de la función - cubrid_lob_close libera los LOBs si ya no son necesarios. - - - - - &reftitle.parameters; - - - conn_identifier - Identificador de conexión. - - - sql - Consulta SQL a ejecutar. - - - - - - &reftitle.returnvalues; - - Devuelve un array de recursos LOB en caso de éxito,&return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_lob_get</function> - - -]]> - - - - - - &reftitle.seealso; - - cubrid_lob_close - cubrid_lob_size - cubrid_lob_export - cubrid_lob_send - - - - - diff --git a/reference/cubrid/functions/cubrid-lob-send.xml b/reference/cubrid/functions/cubrid-lob-send.xml deleted file mode 100644 index b8e39be524..0000000000 --- a/reference/cubrid/functions/cubrid-lob-send.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - cubrid_lob_send - Lee los datos BLOB/CLOB y los envía al navegador - - - - &reftitle.description; - - boolcubrid_lob_send - resourceconn_identifier - resourcelob_identifier - - - La función cubrid_lob_send lee datos BLOB/CLOB - y los pasa al navegador. Para utilizar esta función, es necesario utilizar - primero la función cubrid_lob_get para recuperar las - informaciones de los BLOB/CLOB desde CUBRID. - - - - - &reftitle.parameters; - - - conn_identifier - Identificador de conexión. - - - lob_identifier - Identificador LOB. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_lob_send</function> - - -]]> - - - - - - &reftitle.seealso; - - cubrid_lob_get - cubrid_lob_close - cubrid_lob_size - cubrid_lob_export - - - - - diff --git a/reference/cubrid/functions/cubrid-lob-size.xml b/reference/cubrid/functions/cubrid-lob-size.xml deleted file mode 100644 index 4071d87ac3..0000000000 --- a/reference/cubrid/functions/cubrid-lob-size.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - cubrid_lob_size - Recupera el tamaño de los datos BLOB/CLOB - - - - &reftitle.description; - - stringcubrid_lob_size - resourcelob_identifier - - - La función cubrid_lob_size se utiliza para recuperar - el tamaño de los datos BLOB/CLOB. - - - - - &reftitle.parameters; - - - lob_identifier - Identificador LOB. - - - - - - &reftitle.returnvalues; - - Una cadena representando el tamaño de los datos LOB, cuando - la operación ha tenido éxito,&return.falseforfailure;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.4.0 - - El tipo del valor devuelto ha cambiado. - Antes era un entero, ahora es una - cadena de caracteres. - - - - - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_lob_size</function> - - -]]> - - - - - - &reftitle.seealso; - - cubrid_lob_get - cubrid_lob_close - cubrid_lob_export - cubrid_lob_send - - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-bind.xml b/reference/cubrid/functions/cubrid-lob2-bind.xml deleted file mode 100644 index 069446408d..0000000000 --- a/reference/cubrid/functions/cubrid-lob2-bind.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - - cubrid_lob2_bind - Asocia un objeto LOB o una cadena de caracteres a un objeto LOB - como argumento de una consulta preparada - - - - &reftitle.description; - - boolcubrid_lob2_bind - resourcereq_identifier - intbind_index - mixedbind_value - stringbind_value_type - - - La función cubrid_lob2_bind se utiliza para asociar - datos BLOB/CLOB a un marcador correspondiente en una consulta SQL - pasada a la función cubrid_prepare. Si el argumento - bind_value_type no se proporciona, la cadena será - por omisión "BLOB". Pero si se utiliza primero la función - cubrid_lob2_new, el argumento bind_value_type - será consistente con el argumento type en - la función cubrid_lob2_new. - - - - - &reftitle.parameters; - - - req_identifier - - - Identificador de la petición, resultado de la función cubrid_prepare. - - - - - bind_index - - - Posición de los argumentos asociados. Comienza en 1. - - - - - bind_value - - - Valor actual para la asociación. - - - - - bind_value_type - - - Debe ser "BLOB" o "CLOB" y no es sensible a mayúsculas/minúsculas. - Si no se proporciona, el valor por omisión será "BLOB". - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_lob2_bind</function> - - -]]> - - - - - - &reftitle.seealso; - - cubrid_lob2_new - cubrid_lob2_close - - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-close.xml b/reference/cubrid/functions/cubrid-lob2-close.xml deleted file mode 100644 index d5fb6c6c01..0000000000 --- a/reference/cubrid/functions/cubrid-lob2-close.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - cubrid_lob2_close - Cierra un objeto LOB - - - - &reftitle.description; - - boolcubrid_lob2_close - resourcelob_identifier - - - La función cubrid_lob2_close se utiliza para cerrar - un objeto LOB, devuelto por la función cubrid_lob2_new - o recuperado desde el conjunto de resultados. - - - - - &reftitle.parameters; - - - lob_identifier - - - Un identificador LOB, resultado de la función - cubrid_lob2_new o recuperado - desde el conjunto de resultados. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - cubrid_lob2_new - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-export.xml b/reference/cubrid/functions/cubrid-lob2-export.xml deleted file mode 100644 index ffe4b13a6c..0000000000 --- a/reference/cubrid/functions/cubrid-lob2-export.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - - cubrid_lob2_export - Exporta un objeto LOB a un fichero - - - - &reftitle.description; - - boolcubrid_lob2_export - resourcelob_identifier - stringfile_name - - - La función cubrid_lob2_export se utiliza - para guardar los datos BLOB/CLOB en un fichero. Para utilizar - esta función, primero debe utilizarse la función - cubrid_lob2_new o recuperarse un objeto LOB desde la - base de datos CUBRID. Si el fichero no existe, la operación fallará. - Esta función no modificará la posición del cursor del objeto LOB. - Opera sobre el objeto LOB en su totalidad. - - - - - &reftitle.parameters; - - - lob_identifier - - - Un identificador LOB resultante de la función - cubrid_lob2_new o recuperado desde el juego de resultados. - - - - - filename - - - Nombre del fichero en el cual se desean guardar los datos BLOB/CLOB. - La ruta hacia el fichero también puede ser especificada. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>cubrid_lob2_export</function> ejemplo - - -]]> - - - - - - &reftitle.seealso; - - cubrid_lob2_new - cubrid_lob2_close - cubrid_lob2_import - cubrid_lob2_bind - - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-import.xml b/reference/cubrid/functions/cubrid-lob2-import.xml deleted file mode 100644 index ec9e2e3951..0000000000 --- a/reference/cubrid/functions/cubrid-lob2-import.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - cubrid_lob2_import - Importa datos BLOB/CLOB desde un fichero - - - - &reftitle.description; - - boolcubrid_lob2_import - resourcelob_identifier - stringfile_name - - - La función cubrid_lob2_import se utiliza para importar - datos BLOB/CLOB desde un fichero. Para utilizar esta función, primero - debe utilizarse la función cubrid_lob2_new o - recuperarse un objeto LOB desde la base de datos CUBRID. Si el fichero no existe, - la operación fallará. Esta función no afecta a la posición del cursor - en el objeto LOB; opera sobre el objeto LOB en su totalidad. - - - - - &reftitle.parameters; - - - lob_identifier - - - Un identificador LOB, resultado de la función - cubrid_lob2_new o recuperado desde el juego de - resultados. - - - - - filename - - - El nombre del fichero desde el cual los datos BLOB/CLOB deben - ser importados. La ruta hacia el fichero también es soportada. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_lob2_export</function> - - -]]> - - - - - - &reftitle.seealso; - - cubrid_lob2_new - cubrid_lob2_close - cubrid_lob2_export - cubrid_lob2_bind - - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-new.xml b/reference/cubrid/functions/cubrid-lob2-new.xml deleted file mode 100644 index 8f584ee52c..0000000000 --- a/reference/cubrid/functions/cubrid-lob2-new.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - cubrid_lob2_new - Crea un nuevo objeto LOB - - - - &reftitle.description; - - resourcecubrid_lob2_new - resourceconn_identifier - stringtype"BLOB" - - - La función cubrid_lob2_new se utiliza para crear - un nuevo objeto LOB (tanto BLOB como CLOB). - Esta función debe ser utilizada antes de vincular un objeto LOB. - - - - - &reftitle.parameters; - - - conn_identifier - - - Un identificador de conexión. Si no se especifica, se utilizará la última - conexión abierta con la función cubrid_connect o - la función cubrid_connect_with_url. - - - - - type - - - Puede ser "BLOB" o "CLOB", y no es sensible a mayúsculas/minúsculas. - El valor por omisión es "BLOB". - - - - - - - &reftitle.returnvalues; - - Un identificador LOB en caso de éxito,&return.falseforfailure;. - - - - - &reftitle.seealso; - - cubrid_lob2_close - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-read.xml b/reference/cubrid/functions/cubrid-lob2-read.xml deleted file mode 100644 index 4ce81c3d92..0000000000 --- a/reference/cubrid/functions/cubrid-lob2-read.xml +++ /dev/null @@ -1,165 +0,0 @@ - - - - - - - cubrid_lob2_read - Lee datos BLOB/CLOB - - - - &reftitle.description; - - stringcubrid_lob2_read - resourcelob_identifier - intlen - - - La función cubrid_lob2_read - lee len bytes desde los datos LOB, - y devuelve los bytes leídos. - - - - - &reftitle.parameters; - - - lob_identifier - - - Un identificador LOB, resultado de la función - cubrid_lob2_new o recuperado desde el conjunto - de resultados. - - - - - len - - - Cantidad de datos a leer desde los datos LOB. - - - - - - - - &reftitle.returnvalues; - - Devuelve el contenido como &string;, - &false; cuando no hay más datos, - o &null; si ocurre un error. - - - - - &reftitle.examples; - - Ejemplo 1 con <function>cubrid_lob2_read</function> - - -]]> - - - - - Ejemplo 2 con <function>cubrid_lob2_read</function> - - -]]> - - - - - - &reftitle.seealso; - - cubrid_lob2_write - cubrid_lob2_seek - cubrid_lob2_seek64 - cubrid_lob2_tell - cubrid_lob2_tell64 - cubrid_lob2_size - cubrid_lob2_size64 - - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-seek.xml b/reference/cubrid/functions/cubrid-lob2-seek.xml deleted file mode 100644 index 7130c720c2..0000000000 --- a/reference/cubrid/functions/cubrid-lob2-seek.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - - - cubrid_lob2_seek - Desplaza el cursor de un objeto LOB - - - - &reftitle.description; - - boolcubrid_lob2_seek - resourcelob_identifier - intoffset - intoriginCUBRID_CURSOR_CURRENT - - - La función cubrid_lob2_seek se utiliza - para desplazar la posición del cursor de un objeto LOB según el - argumento offset especificado, y en la dirección - indicada por el argumento origin. - - - Para definir el argumento origin, puede utilizarse la - constante CUBRID_CURSOR_FIRST para desplazar la posición del cursor - offset unidades hacia adelante desde el inicio. - En este caso, offset debe ser un valor positivo. - - - Si se utiliza la constante CUBRID_CURSOR_CURRENT para el parámetro - origin, puede desplazarse hacia adelante o hacia atrás. - El argumento offset puede ser negativo o positivo. - - - Si se utiliza la constante CUBRID_CURSOR_LAST para el parámetro - origin, puede desplazarse hacia atrás - offset unidades desde el final del objeto LOB; - el argumento offset solo puede ser positivo en este caso. - - - - - &reftitle.parameters; - - - lob_identifier - - - Un identificador LOB, resultado de la función - cubrid_lob2_new o recuperado desde el conjunto de resultados. - - - - - offset - - - Número de unidades a utilizar para desplazar el cursor. - - - - - origin - - Este parámetro puede tomar los siguientes valores: - CUBRID_CURSOR_FIRST: Se desplaza hacia adelante desde el inicio. - CUBRID_CURSOR_CURRENT: Se desplaza hacia adelante o hacia atrás, desde la posición actual. - CUBRID_CURSOR_LAST: Se desplaza hacia atrás desde el final del objeto LOB. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_lob2_seek</function> - - -]]> - - - - - - &reftitle.seealso; - - cubrid_lob2_read - cubrid_lob2_write - cubrid_lob2_seek64 - cubrid_lob2_tell - cubrid_lob2_tell64 - cubrid_lob2_size - cubrid_lob2_size64 - - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-seek64.xml b/reference/cubrid/functions/cubrid-lob2-seek64.xml deleted file mode 100644 index 319809605f..0000000000 --- a/reference/cubrid/functions/cubrid-lob2-seek64.xml +++ /dev/null @@ -1,165 +0,0 @@ - - - - - - - cubrid_lob2_seek64 - Desplaza el cursor de un objeto LOB - - - - &reftitle.description; - - boolcubrid_lob2_seek64 - resourcelob_identifier - stringoffset - intoriginCUBRID_CURSOR_CURRENT - - - La función cubrid_lob2_seek64 se utiliza - para desplazar la posición del cursor en un objeto LOB de un valor - proporcionado por el argumento offset, en la dirección - proporcionada por el argumento origin. - Si la posición offset es mayor que la capacidad - de almacenamiento de un entero, puede utilizarse esta función. - - - Para definir el argumento origin, puede - utilizarse la constante CUBRID_CURSOR_FIRST para definir la posición - del cursor a la que se añaden offset unidades - desde el principio. En este caso, offset debe ser un valor - positivo. - - - Si se utiliza CUBRID_CURSOR_CURRENT para el argumento origin, - puede desplazarse hacia atrás, así como hacia adelante. Y el argumento - offset podrá ser positivo o negativo. - - - Si se utiliza la constante CUBRID_CURSOR_LAST para el argumento - origin, puede desplazarse hacia atrás de - offset unidades desde el final del objeto LOB y - el argumento offset solo podrá ser positivo. - - - - Si se utiliza esta función para desplazar la posición del cursor de un - objeto LOB, debe pasarse el argumento offset - en forma de string. - - - - - - &reftitle.parameters; - - - lob_identifier - - - Un identificador LOB, recuperado desde la función - cubrid_lob2_new o desde el conjunto de resultados. - - - - - offset - - - Número de unidades de desplazamiento del cursor. - - - - origin - - Este argumento puede tomar los siguientes valores: - CUBRID_CURSOR_FIRST: desplaza el cursor hacia adelante partiendo del principio. - CUBRID_CURSOR_CURRENT: desplaza el cursor hacia atrás y hacia adelante desde la posición actual. - CUBRID_CURSOR_LAST: desplaza el cursor hacia atrás desde el final del objeto LOB. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_lob2_seek64</function> - - -]]> - - - - - - &reftitle.seealso; - - cubrid_lob2_read - cubrid_lob2_write - cubrid_lob2_seek - cubrid_lob2_tell - cubrid_lob2_tell64 - cubrid_lob2_size - cubrid_lob2_size64 - - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-size.xml b/reference/cubrid/functions/cubrid-lob2-size.xml deleted file mode 100644 index 0629597c88..0000000000 --- a/reference/cubrid/functions/cubrid-lob2-size.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - cubrid_lob2_size - Obtiene el tamaño de un objeto LOB - - - - &reftitle.description; - - intcubrid_lob2_size - resourcelob_identifier - - - La función cubrid_lob2_size se utiliza para obtener - el tamaño de un objeto LOB. - - - - - &reftitle.parameters; - - - lob_identifier - - - Un identificador LOB, obtenido desde la función - cubrid_lob2_new o desde el conjunto de resultados. - - - - - - - - &reftitle.returnvalues; - - Devuelve el tamaño del objeto LOB en caso de éxito,&return.falseforfailure;. - - - - - &reftitle.seealso; - - cubrid_lob2_read - cubrid_lob2_write - cubrid_lob2_seek - cubrid_lob2_seek64 - cubrid_lob2_tell - cubrid_lob2_tell64 - cubrid_lob2_size64 - - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-size64.xml b/reference/cubrid/functions/cubrid-lob2-size64.xml deleted file mode 100644 index f6586f0f5c..0000000000 --- a/reference/cubrid/functions/cubrid-lob2-size64.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - cubrid_lob2_size64 - Recupera el tamaño de un objeto LOB - - - - &reftitle.description; - - stringcubrid_lob2_size64 - resourcelob_identifier - - - La función cubrid_lob2_size64 se utiliza para recuperar - el tamaño de un objeto LOB. Si el tamaño del objeto LOB es mayor - que la capacidad de almacenamiento de un entero, puede utilizarse esta función, - y devolverá el tamaño en forma de string. - - - - - &reftitle.parameters; - - - lob_identifier - - - Un identificador LOB, recuperado desde la función - cubrid_lob2_new o desde el conjunto de resultados. - - - - - - - - &reftitle.returnvalues; - - Devuelve el tamaño de un objeto LOB en forma de string en caso de éxito,&return.falseforfailure;. - - - - - &reftitle.seealso; - - cubrid_lob2_read - cubrid_lob2_write - cubrid_lob2_seek - cubrid_lob2_seek64 - cubrid_lob2_tell - cubrid_lob2_tell64 - cubrid_lob2_size - - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-tell.xml b/reference/cubrid/functions/cubrid-lob2-tell.xml deleted file mode 100644 index 7823afc636..0000000000 --- a/reference/cubrid/functions/cubrid-lob2-tell.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - cubrid_lob2_tell - Recupera la posición del cursor en un objeto LOB - - - - &reftitle.description; - - intcubrid_lob2_tell - resourcelob_identifier - - - La función cubrid_lob2_tell se utiliza - para recuperar la posición del cursor en el objeto LOB. - - - - - &reftitle.parameters; - - - lob_identifier - - - Un identificador LOB, recuperado desde la función - cubrid_lob2_new o desde el juego de resultados. - - - - - - - - &reftitle.returnvalues; - - Devuelve la posición del cursor en el objeto LOB en caso de éxito,&return.falseforfailure;. - - - - - &reftitle.seealso; - - cubrid_lob2_read - cubrid_lob2_write - cubrid_lob2_seek - cubrid_lob2_seek64 - cubrid_lob2_tell64 - cubrid_lob2_size - cubrid_lob2_size64 - - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-tell64.xml b/reference/cubrid/functions/cubrid-lob2-tell64.xml deleted file mode 100644 index 9190afa096..0000000000 --- a/reference/cubrid/functions/cubrid-lob2-tell64.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - cubrid_lob2_tell64 - Recupera la posición del cursor en el objeto LOB - - - - &reftitle.description; - - stringcubrid_lob2_tell64 - resourcelob_identifier - - - La función cubrid_lob2_tell64 se utiliza - para recuperar la posición del cursor en el objeto LOB. Si la - longitud del objeto LOB es mayor que la capacidad de almacenamiento - de un entero, puede utilizarse esta función y devolverá la información - en forma de string. - - - - - &reftitle.parameters; - - - lob_identifier - - - Un identificador LOB, recuperado desde la función - cubrid_lob2_new o desde el conjunto de resultados. - - - - - - - - &reftitle.returnvalues; - - Devuelve la posición del cursor en el objeto LOB, en forma de - string en caso de éxito,&return.falseforfailure;. - - - - - &reftitle.seealso; - - cubrid_lob2_read - cubrid_lob2_write - cubrid_lob2_seek - cubrid_lob2_seek64 - cubrid_lob2_tell - cubrid_lob2_size - cubrid_lob2_size64 - - - - - diff --git a/reference/cubrid/functions/cubrid-lob2-write.xml b/reference/cubrid/functions/cubrid-lob2-write.xml deleted file mode 100644 index 9c6980c3c6..0000000000 --- a/reference/cubrid/functions/cubrid-lob2-write.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - - cubrid_lob2_write - Escribe en un objeto LOB - - - - &reftitle.description; - - boolcubrid_lob2_write - resourcelob_identifier - stringbuf - - - La función cubrid_lob2_write lee los datos - desde el argumento buf y los almacena en el objeto LOB. - Tenga en cuenta que esta función solo puede añadir caracteres actualmente. - - - - - &reftitle.parameters; - - - lob_identifier - - - Un identificador LOB, obtenido desde la función - cubrid_lob2_new o desde el conjunto de resultados. - - - - - buf - - - Los datos que deben ser escritos en el objeto LOB. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo 1 con <function>cubrid_lob2_write</function> - - -]]> - - - - - Ejemplo 2 con <function>cubrid_lob2_write</function> - - -]]> - - - - - - &reftitle.seealso; - - cubrid_lob2_read - cubrid_lob2_seek - cubrid_lob2_seek64 - cubrid_lob2_tell - cubrid_lob2_tell64 - cubrid_lob2_size - cubrid_lob2_size64 - - - - - diff --git a/reference/cubrid/functions/cubrid-lock-read.xml b/reference/cubrid/functions/cubrid-lock-read.xml deleted file mode 100644 index 939be63f06..0000000000 --- a/reference/cubrid/functions/cubrid-lock-read.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - cubrid_lock_read - Coloca un bloqueo de lectura sobre el OID proporcionado - - - - &reftitle.description; - - boolcubrid_lock_read - resourceconn_identifier - stringoid - - - La función cubrid_lock_read se utiliza para colocar - un bloqueo de lectura sobre la instancia apuntada por el oid proporcionado. - - - - - &reftitle.parameters; - - - conn_identifier - Identificador de conexión. - - - oid - OID de la instancia cuya lectura se desea bloquear. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_lock_read</function> - - -]]> - -&example.outputs; - - - string(1) "1" - ["b"]=> - array(3) { - [0]=> - string(1) "1" - [1]=> - string(1) "2" - [2]=> - string(1) "3" - } - ["c"]=> - array(4) { - [0]=> - string(2) "11" - [1]=> - string(2) "22" - [2]=> - string(2) "33" - [3]=> - string(3) "333" - } - ["d"]=> - string(10) "a " -} -]]> - - - - - - &reftitle.seealso; - - cubrid_lock_write - - - - - diff --git a/reference/cubrid/functions/cubrid-lock-write.xml b/reference/cubrid/functions/cubrid-lock-write.xml deleted file mode 100644 index 69c548f598..0000000000 --- a/reference/cubrid/functions/cubrid-lock-write.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - - cubrid_lock_write - Coloca un bloqueo de escritura en el OID proporcionado - - - - &reftitle.description; - - boolcubrid_lock_write - resourceconn_identifier - stringoid - - - La función cubrid_lock_write se utiliza para colocar un - bloqueo de escritura en la instancia apuntada por el oid proporcionado. - - - - - &reftitle.parameters; - - - conn_identifier - Identificador de conexión. - - - oid - OID de la instancia sobre la que se desea colocar un bloqueo de escritura. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_lock_write</function> - - -]]> - - &example.outputs; - - - string(1) "1" - [1]=> - string(1) "2" - [2]=> - string(1) "3" -} -array(3) { - [0]=> - string(1) "2" - [1]=> - string(1) "4" - [2]=> - string(1) "8" -} -]]> - - - - - - &reftitle.seealso; - - cubrid_lock_read - - - - - diff --git a/reference/cubrid/functions/cubrid-move-cursor.xml b/reference/cubrid/functions/cubrid-move-cursor.xml deleted file mode 100644 index c0397cdc23..0000000000 --- a/reference/cubrid/functions/cubrid-move-cursor.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - - cubrid_move_cursor - Desplaza el cursor en el resultado - - - - &reftitle.description; - - boolcubrid_move_cursor - resourcereq_identifier - intoffset - intoriginCUBRID_CURSOR_CURRENT - - - La función cubrid_move_cursor se utiliza para desplazar el - cursor actual según el parámetro req_identifier - con el valor del parámetro offset y en la dirección - definida por el parámetro origin argumento. Para definir - el argumento origin, se puede utilizar CUBRID_CURSOR_FIRST para - la primera parte del resultado, CUBRID_CURSOR_CURRENT para la posición actual del resultado, - o CUBRID_CURSOR_LAST para la última parte del resultado. Si el argumento origin - no es explícitamente designado, entonces la función utilizará CUBRID_CURSOR_CURRENT como valor por omisión. - - - Si el valor actual del desplazamiento del cursor está más allá de los límites válidos, entonces - el cursor se desplaza a la siguiente posición después del intervalo válido del cursor. Por ejemplo, - si se desplaza 20 unidades en el resultado cuyo tamaño es de 10, entonces el cursor - se colocará en la 11ª posición y devolverá CUBRID_NO_MORE_DATA. - - - - - &reftitle.parameters; - - - req_identifier - Identificador de la consulta. - - - offset - Número de unidades que se desean utilizar para el desplazamiento. - - - origin - Objetivo donde se desea desplazar el cursor, ya sea CUBRID_CURSOR_FIRST, CUBRID_CURSOR_CURRENT, CUBRID_CURSOR_LAST. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_move_cursor</function> - - -]]> - - &example.outputs; - - - string(1) "G" - [1]=> - string(4) "Gold" -} -array(2) { - [0]=> - string(1) "X" - [1]=> - string(5) "Mixed" -} -array(2) { - [0]=> - string(1) "M" - [1]=> - string(3) "Man" -} -]]> - - - - - - &reftitle.seealso; - - cubrid_execute - - - - - diff --git a/reference/cubrid/functions/cubrid-next-result.xml b/reference/cubrid/functions/cubrid-next-result.xml deleted file mode 100644 index 64ef0fca83..0000000000 --- a/reference/cubrid/functions/cubrid-next-result.xml +++ /dev/null @@ -1,180 +0,0 @@ - - - - - - - cubrid_next_result - Recupera el resultado de la siguiente consulta durante la ejecución - de múltiples consultas SQL - - - - &reftitle.description; - - boolcubrid_next_result - resourceresult - - - La función cubrid_next_result se utiliza para - recuperar los resultados de la siguiente consulta si se ejecutan múltiples consultas SQL - y el flag CUBRID_EXEC_QUERY_ALL está definido al - utilizar la función cubrid_execute. - - - - - &reftitle.parameters; - - - result - - - El argumento result proviene de la llamada a la - función cubrid_execute - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_next_result</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_execute - - - - - diff --git a/reference/cubrid/functions/cubrid-num-cols.xml b/reference/cubrid/functions/cubrid-num-cols.xml deleted file mode 100644 index bf85749ed6..0000000000 --- a/reference/cubrid/functions/cubrid-num-cols.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - cubrid_num_cols - Obtiene el número de columnas del conjunto de resultados - - - - &reftitle.description; - - intcubrid_num_cols - resourceresult - - - La función cubrid_num_cols se utiliza para obtener - el número de columnas desde el resultado de la consulta. Solo puede ser utilizada - cuando la consulta es de tipo SELECT. - - - - - &reftitle.parameters; - - - result - El resultado. - - - - - - &reftitle.returnvalues; - - Número de columnas en caso de éxito. - - - &false;, si la consulta SQL no es de tipo SELECT. - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_num_cols</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_execute - cubrid_num_rows - - - - - diff --git a/reference/cubrid/functions/cubrid-num-rows.xml b/reference/cubrid/functions/cubrid-num-rows.xml deleted file mode 100644 index 9bb51158fd..0000000000 --- a/reference/cubrid/functions/cubrid-num-rows.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - - cubrid_num_rows - Obtiene el número de filas de un conjunto de resultados - - - - &reftitle.description; - - intcubrid_num_rows - resourceresult - - - La función cubrid_num_rows se utiliza para obtener - el número de filas desde el conjunto de resultados. Solo puede ser utilizada - cuando la consulta es de tipo SELECT. Cuando se desea obtener - este tipo de valor para una consulta de tipo INSERT, UPDATE o DELETE, debe utilizarse - la función cubrid_affected_rows. - - - Nota: La función cubrid_num_rows solo puede ser utilizada - en consultas síncronas; devuelve 0 en consultas asíncronas. - - - - - &reftitle.parameters; - - - result - - - El argumento result proviene - de una llamada a la función cubrid_execute, - la función cubrid_query o la función - cubrid_prepare. - - - - - - - - &reftitle.returnvalues; - - Número de filas en caso de éxito. - - - 0 cuando la consulta se ha realizado en modo asíncrono. - - - -1, si la consulta SQL no es de tipo SELECT. - - - &false; si ocurre un error. - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_num_rows</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_execute - cubrid_num_cols - cubrid_affected_rows - - - - - diff --git a/reference/cubrid/functions/cubrid-pconnect-with-url.xml b/reference/cubrid/functions/cubrid-pconnect-with-url.xml deleted file mode 100644 index cfc469990b..0000000000 --- a/reference/cubrid/functions/cubrid-pconnect-with-url.xml +++ /dev/null @@ -1,256 +0,0 @@ - - - - - - - cubrid_pconnect_with_url - Establece una conexión persistente con un servidor CUBRID - - - - &reftitle.description; - - resourcecubrid_pconnect_with_url - stringconn_url - stringuserid - stringpasswd - - - Establece una conexión persistente con un servidor CUBRID. - - - cubrid_pconnect_with_url funciona de manera similar a la - función cubrid_connect_with_url, con dos diferencias principales. - - - En primer lugar, al establecer la conexión, la función intentará encontrar - un enlace (persistente) ya abierto con el mismo host, en el mismo puerto, en la - misma base de datos dbname y utilizando el mismo userid. Si se encuentra una conexión - de este tipo, su identificador será devuelto en lugar de abrir una nueva conexión. - - - A continuación, la conexión al servidor CUBRID no se cerrará cuando finalice - el script. En su lugar, la conexión permanecerá abierta para su uso futuro (la función - cubrid_close o la función cubrid_disconnect no cerrarán la conexión - establecida por la función cubrid_pconnect_with_url). - - - Este tipo de enlace se denominaba anteriormente 'persistente'. - - - <url> ::= CUBRID:<host>:<db_name>:<db_user>:<db_password>:[?<properties>] - - - <properties> ::= <property> [&<property>] - - - <properties> ::= alhosts=<alternative_hosts>[ &rctime=<time>] - - - <properties> ::= login_timeout=<milli_sec> - - - <properties> ::= query_timeout=<milli_sec> - - - <properties> ::= disconnect_on_query_timeout=true|false - - - <alternative_hosts> ::= <standby_broker1_host>:<port> [,<standby_broker2_host>:<port>] - - - <host> := HOSTNAME | IP_ADDR - - - <time> := SECOND - - - <milli_sec> := MILLI SECOND - - - host : Un nombre de host o una dirección IP del servidor maestro de la base de datos - db_name : Un nombre de base de datos - db_user : Un nombre de usuario de la base de datos - db_password : Una contraseña para el usuario de la base de datos - autocommit : El modo auto-commit de la conexión a la base de datos - - alhosts : Especifica la información del broker del servidor, que será utilizado como punto de salida - cuando no sea posible conectarse al servidor activo. Se pueden especificar varios brokers en este caso, - y la conexión a los brokers se intentará en el orden de la configuración alhosts - - - rctime : Un intervalo de tiempo para esperar antes de intentar una conexión con un broker cuando ocurre un error. - Después de que ocurra un error, el sistema intentará conectarse a un broker especificado por - althosts, terminará la transacción, y luego intentará conectarse al broker activo del servidor maestro - de la base de datos. El valor por omisión es de 600 segundos. - - - login_timeout : Valor del tiempo máximo de espera (unidad: milisegundo) para la identificación - a la base de datos. Por omisión, este valor es 0, lo que significa que se espera indefinidamente. - - - query_timeout : Valor del tiempo máximo de espera (unidad: milisegundo) para la ejecución - de la consulta. Una vez alcanzado este valor, se envía un mensaje para cancelar la consulta - enviada al servidor. El valor devuelto puede depender de la configuración de disconnect_on_query_timeout; - incluso si el mensaje para cancelar la consulta ha sido enviado al servidor, la consulta puede tener éxito. - - - disconnect_on_query_timeout : Configura un valor que determina si se debe devolver - inmediatamente un error para las funciones ejecutadas después del tiempo máximo de espera. - El valor por omisión es &false;. - - - - - Los caracteres ? y : - utilizados como identificadores en las URLs de conexión PHP no pueden - ser incluidos en la contraseña. A continuación se muestra un ejemplo de contraseña - inválida, ya que utiliza los caracteres "?:" en la URL de conexión. - - - $url = "CUBRID:localhost:33000:tdb:dba:12?:?login_timeout=100"; - - - Las contraseñas que contienen el carácter ? o el - carácter : pueden ser pasadas como argumento separado. - - - $url = "CUBRID:localhost:33000:tbd:::?login_timeout=100"; - - - $conn = cubrid_pconnect_with_url ($url, "dba", "12?"); - - - Si el nombre de usuario o la contraseña están vacíos, no se deben - eliminar los ":"; a continuación se muestra un ejemplo: - - - $url = "CUBRID:localhost:33000:demodb:::"; - - - - - - &reftitle.parameters; - - - conn_url - - - Un &string; que contiene la información de conexión para el servidor. - - - - - userid - - - Nombre de usuario para la base de datos. - - - - - passwd - - - Contraseña para el usuario. - - - - - - - - &reftitle.returnvalues; - - Identificador de conexión, cuando el proceso tiene éxito,&return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_pconnect_with_url</function> sin propiedades - - -]]> - - - - - Ejemplo de <function>cubrid_pconnect_with_url</function> con URL y propiedades - - -]]> - - - - - - &reftitle.seealso; - - cubrid_connect - cubrid_connect_with_url - cubrid_pconnect - cubrid_disconnect - cubrid_close - - - - - diff --git a/reference/cubrid/functions/cubrid-pconnect.xml b/reference/cubrid/functions/cubrid-pconnect.xml deleted file mode 100644 index f8ae0b27ae..0000000000 --- a/reference/cubrid/functions/cubrid-pconnect.xml +++ /dev/null @@ -1,189 +0,0 @@ - - - - - cubrid_pconnect - Establece una conexión persistente con un servidor CUBRID - - - - &reftitle.description; - - resourcecubrid_pconnect - stringhost - intport - stringdbname - stringuserid - stringpasswd - - - Establece una conexión persistente con un servidor CUBRID. - - - cubrid_pconnect funciona de manera similar a - cubrid_connect con dos diferencias principales. - - - En primer lugar, al establecer la conexión, la función intentará primero - encontrar un enlace (persistente) ya abierto con el mismo nombre de host, - en el mismo puerto, utilizando la misma base de datos dbname y el mismo - userid. Si se encuentra un enlace de este tipo, su identificador será - devuelto en lugar de abrir una nueva conexión. - - - En segundo lugar, la conexión con el servidor CUBRID no se cerrará cuando - finalice el script. En su lugar, el enlace permanecerá abierto para su - uso futuro (cubrid_close o - cubrid_disconnect no cerrarán los enlaces establecidos - con cubrid_pconnect). - - - Este tipo de enlace se denominaba anteriormente 'persistente'. - - - - - &reftitle.parameters; - - - host - - - Nombre del host o dirección IP del servidor CUBRID CAS. - - - - - port - - - Número de puerto del servidor CUBRID CAS (BROKER_PORT configurado en $CUBRID/conf/cubrid_broker.conf). - - - - - dbname - - - Nombre de la base de datos. - - - - - userid - - - Nombre de usuario para la base de datos. - - - - - passwd - - - Contraseña asociada al nombre de usuario. - - - - - - - - &reftitle.returnvalues; - - Identificador de conexión en caso de éxito,&return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_pconnect</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_connect - cubrid_connect_with_url - cubrid_pconnect_with_url - cubrid_disconnect - cubrid_close - - - - - diff --git a/reference/cubrid/functions/cubrid-prepare.xml b/reference/cubrid/functions/cubrid-prepare.xml deleted file mode 100644 index 45bf98a86e..0000000000 --- a/reference/cubrid/functions/cubrid-prepare.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - cubrid_prepare - Prepara una consulta SQL para su ejecución - - - - &reftitle.description; - - resourcecubrid_prepare - resourceconn_identifier - stringprepare_stmt - intoption0 - - - La función cubrid_prepare compila una consulta SQL para un - gestor de conexión dado y devuelve un gestor que representa la consulta precompilada. - - - Una consulta preparada puede ser ejecutada varias veces, lo cual resulta eficiente - para la ejecución repetida o para el procesamiento de grandes volúmenes de datos. - Solo se puede utilizar una única consulta, y un parámetro puede marcarse con un - signo de interrogación (?) en el lugar apropiado de la consulta - SQL. Se añade un parámetro al vincular un valor en la cláusula VALUES - de una sentencia INSERT o en la cláusula WHERE. - Tenga en cuenta que un valor solo puede ser vinculado a un parámetro utilizando la - función cubrid_bind. - - - - - &reftitle.parameters; - - - conn_identifier - Identificador de conexión. - - - prepare_stmt - Consulta preparada. - - - option - OID devuelto por la opción CUBRID_INCLUDE_OID. - - - - - - &reftitle.returnvalues; - - Identificador de consulta en caso de éxito,&return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_prepare</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_execute - cubrid_bind - - - - - diff --git a/reference/cubrid/functions/cubrid-put.xml b/reference/cubrid/functions/cubrid-put.xml deleted file mode 100644 index f7d17d6396..0000000000 --- a/reference/cubrid/functions/cubrid-put.xml +++ /dev/null @@ -1,147 +0,0 @@ - - - - - - - cubrid_put - Actualiza una columna según su OID - - - - &reftitle.description; - - boolcubrid_put - resourceconn_identifier - stringoid - stringattr - mixedvalue - - - La función cubrid_put se utiliza para actualizar - un atributo de la instancia señalada por el oid proporcionado. - - - Puede actualizarse un solo atributo utilizando un &string; en el parámetro - attr. En este caso, puede utilizarse un &integer;, un número de punto flotante, o un &string; como value. Para actualizar varios atributos, debe omitirse el parámetro attr y definirse el argumento value utilizando un array asociativo. - - - - - &reftitle.parameters; - - - conn_identifier - Identificador de conexión. - - - oid - OID de la instancia que se desea actualizar. - - - attr - Nombre del atributo que se desea actualizar. - - - value - Nuevo valor que se desea asignar al atributo. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_put</function> - - -]]> - - &example.outputs; - - - string(1) "1" - [1]=> - string(1) "2" - [2]=> - string(1) "3" -} -array(3) { - [0]=> - string(1) "2" - [1]=> - string(1) "4" - [2]=> - string(1) "8" -} -]]> - - - - - - &reftitle.seealso; - - cubrid_get - cubrid_set_add - cubrid_set_drop - cubrid_seq_insert - cubrid_seq_drop - cubrid_seq_put - - - - - diff --git a/reference/cubrid/functions/cubrid-rollback.xml b/reference/cubrid/functions/cubrid-rollback.xml deleted file mode 100644 index d5bcdb6e3e..0000000000 --- a/reference/cubrid/functions/cubrid-rollback.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - - cubrid_rollback - Anula una transacción - - - - &reftitle.description; - - boolcubrid_rollback - resourceconn_identifier - - - La función cubrid_rollback anula la transacción en curso - señalada por el argumento conn_identifier. - - - La conexión al servidor se cierra después de la llamada a la función - cubrid_rollback. Sin embargo, el gestor de conexión - permanece activo. - - - - - &reftitle.parameters; - - - conn_identifier - Identificador de conexión. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_rollback</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_commit - cubrid_disconnect - - - - - diff --git a/reference/cubrid/functions/cubrid-schema.xml b/reference/cubrid/functions/cubrid-schema.xml deleted file mode 100644 index 9a310793b0..0000000000 --- a/reference/cubrid/functions/cubrid-schema.xml +++ /dev/null @@ -1,629 +0,0 @@ - - - - - - - cubrid_schema - Recupera información sobre un esquema - - - - &reftitle.description; - - arraycubrid_schema - resourceconn_identifier - intschema_type - stringclass_name - stringattr_name - - - La función cubrid_schema se utiliza para - recuperar información de un esquema desde la base de datos. - Para recuperar la información de una clase particular, - debe definirse class_name, - para recuperar la información sobre un atributo particular (solo - utilizable con CUBRID_SCH_ATTR_PRIVILEGE), - debe definirse attr_name. - - - - El resultado de la función cubrid_schema se devuelve en forma de un array - de 2 dimensiones (columna (array asociativo) * filas (array numérico)). - Las tablas siguientes muestran los tipos de un esquema así como la estructura - de una columna del array resultante, según el tipo de esquema solicitado. - - - - Composición del resultado para cada tipo - - - - Esquema - Número de columna - Nombre de la columna - Valor - - - - - CUBRID_SCH_CLASS - 1 - NAME - - - - - 2 - TYPE - 0:system class 1:vclass 2:class - - - - CUBRID_SCH_VCLASS - 1 - NAME - - - - - 2 - TYPE - 1:vclass - - - - CUBRID_SCH_QUERY_SPEC - 1 - QUERY_SPEC - - - - - CUBRID_SCH_ATTRIBUTE / CUBRID_SCH_CLASS_ATTRIBUTE - 1 - ATTR_NAME - - - - - 2 - DOMAIN - - - - - 3 - SCALE - - - - - 4 - PRECISION - - - - - 5 - INDEXED - 1:indexed - - - - 6 - NOT NULL - 1:not null - - - - 7 - SHARED - 1:shared - - - - 8 - UNIQUE - 1:unique - - - - 9 - DEFAULT - - - - - 10 - ATTR_ORDER - base:1 - - - - 11 - CLASS_NAME - - - - - 12 - SOURCE_CLASS - - - - - 13 - IS_KEY - 1:key - - - - CUBRID_SCH_METHOD / CUBRID_SCH_CLASS_METHOD - 1 - NAME - - - - - 2 - RET_DOMAIN - - - - - 3 - ARG_DOMAIN - - - - - CUBRID_SCH_METHOD_FILE - 1 - METHOD_FILE - - - - - CUBRID_SCH_SUPERCLASS / CUBRID_SCH_DIRECT_SUPER_CLASS / CUBRID_SCH_SUBCLASS - 1 - CLASS_NAME - - - - - 2 - TYPE - 0:system class 1:vclass 2:class - - - - CUBRID_SCH_CONSTRAINT - 1 - TYPE - 0:unique 1:index 2:reverse unique 3:reverse index - - - - 2 - NAME - - - - - 3 - ATTR_NAME - - - - - 4 - NUM_PAGES - - - - - 5 - NUM_KEYS - - - - - 6 - PRIMARY_KEY - 1:primary key - - - - 7 - KEY_ORDER - base:1 - - - - CUBRID_SCH_TRIGGER - 1 - NAME - - - - - 2 - STATUS - - - - - 3 - EVENT - - - - - 4 - TARGET_CLASS - - - - - 5 - TARGET_ATTR - - - - - 6 - ACTION_TIME - - - - - 7 - ACTION - - - - - 8 - PRIORITY - - - - - 9 - CONDITION_TIME - - - - - 10 - CONDITION - - - - - CUBRID_SCH_CLASS_PRIVILEGE / CUBRID_SCH_ATTR_PRIVILEGE - 1 - CLASS_NAME / ATTR_NAME - - - - - 2 - PRIVILEGE - - - - - 3 - GRANTABLE - - - - - CUBRID_SCH_PRIMARY_KEY - 1 - CLASS_NAME - - - - - 2 - ATTR_NAME - - - - - 3 - KEY_SEQ - base:1 - - - - 4 - KEY_NAME - - - - - CUBRID_SCH_IMPORTED_KEYS / CUBRID_SCH_EXPORTED_KEYS / CUBRID_SCH_CROSS_REFERENCE - 1 - PKTABLE_NAME - - - - - 2 - PKCOLUMN_NAME - - - - - 3 - FKTABLE_NAME - base:1 - - - - 4 - FKCOLUMN_NAME - - - - - 5 - KEY_SEQ - base:1 - - - - 6 - UPDATE_ACTION - 0:cascade 1:restrict 2:no action 3:set null - - - - 7 - DELETE_ACTION - 0:cascade 1:restrict 2:no action 3:set null - - - - 8 - FK_NAME - - - - - 9 - PK_NAME - - - - -
- -
- - - &reftitle.parameters; - - - conn_identifier - Identificador de conexión. - - - schema_type - Datos del esquema a recuperar. - - - class_name - Clase para la cual se desea conocer el esquema. - - - attr_name - Atributo para el cual se desea conocer el esquema. - - - - - - &reftitle.returnvalues; - - Un array que contiene la información sobre el esquema en caso de éxito,&return.falseforfailure;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.3.1 - - Modificación del valor devuelto: cuando la función falla, - el valor devuelto es ahora &false; en lugar de -1. - - - - - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_schema</function> - - -]]> - - &example.outputs; - - - array(4) { - ["CLASS_NAME"]=> - string(4) "game" - ["ATTR_NAME"]=> - string(12) "athlete_code" - ["KEY_SEQ"]=> - string(1) "3" - ["KEY_NAME"]=> - string(41) "pk_game_host_year_event_code_athlete_code" - } - [1]=> - array(4) { - ["CLASS_NAME"]=> - string(4) "game" - ["ATTR_NAME"]=> - string(10) "event_code" - ["KEY_SEQ"]=> - string(1) "2" - ["KEY_NAME"]=> - string(41) "pk_game_host_year_event_code_athlete_code" - } - [2]=> - array(4) { - ["CLASS_NAME"]=> - string(4) "game" - ["ATTR_NAME"]=> - string(9) "host_year" - ["KEY_SEQ"]=> - string(1) "1" - ["KEY_NAME"]=> - string(41) "pk_game_host_year_event_code_athlete_code" - } -} - ---- Foreign Keys --- -array(2) { - [0]=> - array(9) { - ["PKTABLE_NAME"]=> - string(7) "athlete" - ["PKCOLUMN_NAME"]=> - string(4) "code" - ["FKTABLE_NAME"]=> - string(4) "game" - ["FKCOLUMN_NAME"]=> - string(12) "athlete_code" - ["KEY_SEQ"]=> - string(1) "1" - ["UPDATE_RULE"]=> - string(1) "1" - ["DELETE_RULE"]=> - string(1) "1" - ["FK_NAME"]=> - string(20) "fk_game_athlete_code" - ["PK_NAME"]=> - string(15) "pk_athlete_code" - } - [1]=> - array(9) { - ["PKTABLE_NAME"]=> - string(5) "event" - ["PKCOLUMN_NAME"]=> - string(4) "code" - ["FKTABLE_NAME"]=> - string(4) "game" - ["FKCOLUMN_NAME"]=> - string(10) "event_code" - ["KEY_SEQ"]=> - string(1) "1" - ["UPDATE_RULE"]=> - string(1) "1" - ["DELETE_RULE"]=> - string(1) "1" - ["FK_NAME"]=> - string(18) "fk_game_event_code" - ["PK_NAME"]=> - string(13) "pk_event_code" - } -} - ---- Column Attribute --- -array(1) { - [0]=> - array(13) { - ["ATTR_NAME"]=> - string(4) "area" - ["DOMAIN"]=> - string(1) "7" - ["SCALE"]=> - string(1) "2" - ["PRECISION"]=> - string(2) "10" - ["INDEXED"]=> - string(1) "0" - ["NON_NULL"]=> - string(1) "0" - ["SHARED"]=> - string(1) "0" - ["UNIQUE"]=> - string(1) "0" - ["DEFAULT"]=> - NULL - ["ATTR_ORDER"]=> - string(1) "4" - ["CLASS_NAME"]=> - string(7) "stadium" - ["SOURCE_CLASS"]=> - string(7) "stadium" - ["IS_KEY"]=> - string(1) "0" - } -} -]]> - - - - -
- diff --git a/reference/cubrid/functions/cubrid-seq-drop.xml b/reference/cubrid/functions/cubrid-seq-drop.xml deleted file mode 100644 index 5589c5e9ec..0000000000 --- a/reference/cubrid/functions/cubrid-seq-drop.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - - cubrid_seq_drop - Elimina un elemento de una secuencia - - - - &reftitle.description; - - boolcubrid_seq_drop - resourceconn_identifier - stringoid - stringattr_name - intindex - - - La función cubrid_seq_drop se utiliza para eliminar - un elemento de la base de datos basándose en la secuencia de tipos - de atributos proporcionada. - - - - - &reftitle.parameters; - - - conn_identifier - Identificador de conexión. - - - oid - OID de la instancia a utilizar. - - - attr_name - Nombre del atributo desde el cual debe eliminarse el elemento. - - - index - Índice del elemento a eliminar (comenzando en 1). - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_seq_drop</function> - - -]]> - - &example.outputs; - - - string(2) "11" - [1]=> - string(2) "22" - [2]=> - string(2) "33" - [3]=> - string(3) "333" -} -array(3) { - [0]=> - string(2) "11" - [1]=> - string(2) "22" - [2]=> - string(2) "33" -} -]]> - - - - - - &reftitle.seealso; - - cubrid_seq_insert - cubrid_seq_put - - - - - diff --git a/reference/cubrid/functions/cubrid-seq-insert.xml b/reference/cubrid/functions/cubrid-seq-insert.xml deleted file mode 100644 index 7285ced866..0000000000 --- a/reference/cubrid/functions/cubrid-seq-insert.xml +++ /dev/null @@ -1,147 +0,0 @@ - - - - - cubrid_seq_insert - Inserta un elemento en una secuencia - - - - &reftitle.description; - - boolcubrid_seq_insert - resourceconn_identifier - stringoid - stringattr_name - intindex - stringseq_element - - - La función cubrid_seq_insert se utiliza para - insertar un elemento en una secuencia de tipos de atributos. - - - - - &reftitle.parameters; - - - conn_identifier - Identificador de conexión. - - - oid - OID de la instancia a utilizar. - - - attr_name - Nombre del atributo a insertar. - - - index - Posición del elemento para su inserción (comenzando en 1). - - - seq_element - Contenido del elemento a insertar. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_seq_insert</function> - - -]]> - - &example.outputs; - - - string(2) "11" - [1]=> - string(2) "22" - [2]=> - string(2) "33" - [3]=> - string(3) "333" -} -array(5) { - [0]=> - string(2) "11" - [1]=> - string(2) "22" - [2]=> - string(2) "33" - [3]=> - string(3) "333" - [4]=> - string(2) "44" -} -]]> - - - - - - &reftitle.seealso; - - cubrid_seq_drop - cubrid_seq_put - - - - - diff --git a/reference/cubrid/functions/cubrid-seq-put.xml b/reference/cubrid/functions/cubrid-seq-put.xml deleted file mode 100644 index 4b3a13f6fe..0000000000 --- a/reference/cubrid/functions/cubrid-seq-put.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - - cubrid_seq_put - Actualiza el valor de un elemento de una secuencia - - - - &reftitle.description; - - boolcubrid_seq_put - resourceconn_identifier - stringoid - stringattr_name - intindex - stringseq_element - - - La función cubrid_seq_put se utiliza para - actualizar el contenido de un elemento en una secuencia de tipos - de atributos. - - - - - &reftitle.parameters; - - - conn_identifier - Identificador de conexión. - - - oid - OID de la instancia a utilizar. - - - attr_name - Nombre del atributo a utilizar. - - - index - Índice (comenzando en 1) del elemento a actualizar. - - - seq_element - Nuevo contenido a colocar en el elemento. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_seq_put</function> - - -]]> - - &example.outputs; - - - string(2) "11" - [1]=> - string(2) "22" - [2]=> - string(2) "33" - [3]=> - string(3) "333" -} -array(4) { - [0]=> - string(3) "111" - [1]=> - string(2) "22" - [2]=> - string(2) "33" - [3]=> - string(3) "333" -} -]]> - - - - - - &reftitle.seealso; - - cubrid_seq_drop - cubrid_seq_insert - - - - - diff --git a/reference/cubrid/functions/cubrid-set-add.xml b/reference/cubrid/functions/cubrid-set-add.xml deleted file mode 100644 index 757d20603a..0000000000 --- a/reference/cubrid/functions/cubrid-set-add.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - cubrid_set_add - Inserta un único elemento para definir el tipo de una columna - - - - &reftitle.description; - - boolcubrid_set_add - resourceconn_identifier - stringoid - stringattr_name - stringset_element - - - La función cubrid_set_add se utiliza para insertar - un único elemento en un conjunto de tipos de atributos. - - - - - &reftitle.parameters; - - - conn_identifier - Identificador de conexión. - - - oid - OID de la instancia a utilizar. - - - attr_name - Nombre del atributo en el cual el nuevo elemento será insertado. - - - set_element - Contenido del elemento a insertar. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_set_add</function> - - -]]> - - &example.outputs; - - - string(1) "1" - [1]=> - string(1) "2" - [2]=> - string(1) "3" -} -array(4) { - [0]=> - string(1) "1" - [1]=> - string(1) "2" - [2]=> - string(1) "3" - [3]=> - string(1) "4" -} -]]> - - - - - - &reftitle.seealso; - - cubrid_seq_drop - - - - - diff --git a/reference/cubrid/functions/cubrid-set-autocommit.xml b/reference/cubrid/functions/cubrid-set-autocommit.xml deleted file mode 100644 index 797b26727e..0000000000 --- a/reference/cubrid/functions/cubrid-set-autocommit.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - cubrid_set_autocommit - Define el modo auto-commit para la conexión - - - - &reftitle.description; - - boolcubrid_set_autocommit - resourceconn_identifier - boolmode - - - La función cubrid_set_autocommit se utiliza para - definir el modo auto-commit para la conexión a la base de datos CUBRID. - - - En CUBRID PHP, el modo auto-commit está desactivado por omisión para la gestión - de transacciones. Cuando el modo auto-commit pasa de Off a On, todos los - trabajos pendientes son automáticamente validados. - - - - - &reftitle.parameters; - - - conn_identifier - Identificador de conexión. - - - mode - - El modo auto-commit. Las constantes siguientes pueden ser utilizadas: - - CUBRID_AUTOCOMMIT_FALSE - CUBRID_AUTOCOMMIT_TRUE - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - cubrid_get_autocommit - cubrid_commit - - - - diff --git a/reference/cubrid/functions/cubrid-set-db-parameter.xml b/reference/cubrid/functions/cubrid-set-db-parameter.xml deleted file mode 100644 index 36c131804b..0000000000 --- a/reference/cubrid/functions/cubrid-set-db-parameter.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - - cubrid_set_db_parameter - Define los parámetros de la base de datos CUBRID - - - - &reftitle.description; - - boolcubrid_set_db_parameter - resourceconn_identifier - intparam_type - intparam_value - - - La función cubrid_set_db_parameter se utiliza - para definir los parámetros de la base de datos CUBRID. Puede - definir los siguientes parámetros de la base de datos CUBRID: - - - PARAM_ISOLATION_LEVEL - PARAM_LOCK_TIMEOUT - - - - - El modo auto-commit puede ser definido utilizando la función - cubrid_set_autocommit. - - - - - - &reftitle.parameters; - - - conn_identifier - - La conexión CUBRID. Si el identificador de conexión no es especificado, - se utilizará el último enlace abierto por la función - cubrid_connect. - - - - param_type - Tipo de parámetro de la base de datos. - - - param_value - Nivel de aislamiento (1-6) o el valor del tiempo de espera (en segundos). - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_get_db_parameter</function> - - -]]> - - &example.outputs; - - - int(3) - ["PARAM_LOCK_TIMEOUT"]=> - int(-1) - ["PARAM_MAX_STRING_LENGTH"]=> - int(1073741823) - ["PARAM_AUTO_COMMIT"]=> - int(0) -} -array(4) { - ["PARAM_ISOLATION_LEVEL"]=> - int(2) - ["PARAM_LOCK_TIMEOUT"]=> - int(-1) - ["PARAM_MAX_STRING_LENGTH"]=> - int(1073741823) - ["PARAM_AUTO_COMMIT"]=> - int(1) -} -]]> - - - - - - &reftitle.seealso; - - cubrid_get_db_parameter - cubrid_set_autocommit - - - - diff --git a/reference/cubrid/functions/cubrid-set-drop.xml b/reference/cubrid/functions/cubrid-set-drop.xml deleted file mode 100644 index 4c87b1bfde..0000000000 --- a/reference/cubrid/functions/cubrid-set-drop.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - - cubrid_set_drop - Elimina un elemento - - - - &reftitle.description; - - boolcubrid_set_drop - resourceconn_identifier - stringoid - stringattr_name - stringset_element - - - La función cubrid_set_drop se utiliza para - eliminar un elemento de un atributo dado de la base de datos. - - - - - &reftitle.parameters; - - - conn_identifier - Identificador de conexión. - - - oid - OID de la instancia a utilizar. - - - attr_name - Nombre del atributo desde el cual se eliminará el elemento. - - - set_element - Contenido del elemento a eliminar. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_set_drop</function> - - -]]> - -&example.outputs; - - - string(1) "1" - [1]=> - string(1) "2" - [2]=> - string(1) "3" -} -array(2) { - [0]=> - string(1) "2" - [1]=> - string(1) "3" -} -]]> - - - - - - &reftitle.seealso; - - cubrid_set_add - - - - - diff --git a/reference/cubrid/functions/cubrid-set-query-timeout.xml b/reference/cubrid/functions/cubrid-set-query-timeout.xml deleted file mode 100644 index 4ca65d56d5..0000000000 --- a/reference/cubrid/functions/cubrid-set-query-timeout.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - cubrid_set_query_timeout - Define el tiempo máximo de ejecución de una consulta - - - - &reftitle.description; - - boolcubrid_set_query_timeout - resourcereq_identifier - inttimeout - - - La función cubrid_set_query_timeout se utiliza para definir - el tiempo máximo de ejecución de una consulta. - - - - - &reftitle.parameters; - - - req_identifier - - - Identificador de consulta. - - - - - timeout - - - Tiempo máximo, en milisegundos. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - cubrid_get_query_timeout - - - - diff --git a/reference/cubrid/functions/cubrid-version.xml b/reference/cubrid/functions/cubrid-version.xml deleted file mode 100644 index bb027d3bf3..0000000000 --- a/reference/cubrid/functions/cubrid-version.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - cubrid_version - Obtener la versión del módulo de PHP de CUBRID - - - - &reftitle.description; - - stringcubrid_version - - - - La función cubrid_version se usa para obtener la versión - del módulo de PHP de CUBRID. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Información de la versión (p.ej. "8.3.1.0001"). - - - - - &reftitle.examples; - - Ejemplo de <function>cubrid_version</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - cubrid_error_code - cubrid_error_code_facility - - - - - - diff --git a/reference/cubrid/oldaliases/cubrid-load-from-glo.xml b/reference/cubrid/oldaliases/cubrid-load-from-glo.xml deleted file mode 100644 index 4218a399e9..0000000000 --- a/reference/cubrid/oldaliases/cubrid-load-from-glo.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - cubrid_load_from_glo - Liga una donnée - - - - &reftitle.description; - - intcubrid_load_from_glo - resourceconn_identifier - stringoid - stringfile_name - - - La función cubrid_load_from_glo se utiliza para - leer una donnée desde una instancia glo, y la guarda en un fichero - dado. - - - - - &reftitle.parameters; - - - conn_identifier - Identificador de conexión. - - - oid - Oid de la instancia glo desde la cual se desea leer la donnée. - - - file_name - Nombre del fichero donde se debe realizar la guarda de la donnée. - - - - - - &reftitle.returnvalues; - - &true; cuando el proceso es un éxito. - - - &false; cuando el proceso ha fallado. - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_load_from_glo</function> - - -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - cubrid_load_from_glo - - - - - Esta función ha sido eliminada desde CUBRID 3.1. - - - - - - &reftitle.seealso; - - cubrid_new_glo - cubrid_save_to_glo - cubrid_send_glo - - - - - diff --git a/reference/cubrid/oldaliases/cubrid-new-glo.xml b/reference/cubrid/oldaliases/cubrid-new-glo.xml deleted file mode 100644 index 7f01f9f332..0000000000 --- a/reference/cubrid/oldaliases/cubrid-new-glo.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - - cubrid_new_glo - Crea una instancia glo - - - - &reftitle.description; - - stringcubrid_new_glo - resourceconn_identifier - stringclass_name - stringfile_name - - - La función cubrid_new_glo se utiliza para crear una - instancia glo en la clase solicitada (clase glo). - El glo creado es de tipo LO y se almacena en el fichero - file_name. - - - - - &reftitle.parameters; - - - conn_identifier - Identificador de conexión. - - - class_name - Nombre de la clase en la que se desea crear el glo. - - - file_name - El nombre del fichero en el que se desea guardar el nuevo glo creado. - - - - - - &reftitle.returnvalues; - - OID de la instancia creada en caso de éxito. - - - &false; en caso de fallo. - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_new_glo</function> - - -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - cubrid_new_glo - - - - - Esta función ha sido eliminada desde CUBRID 3.1. - - - - - - &reftitle.seealso; - - cubrid_save_to_glo - cubrid_load_from_glo - cubrid_send_glo - - - - - diff --git a/reference/cubrid/oldaliases/cubrid-save-to-glo.xml b/reference/cubrid/oldaliases/cubrid-save-to-glo.xml deleted file mode 100644 index a287061a5e..0000000000 --- a/reference/cubrid/oldaliases/cubrid-save-to-glo.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - - cubrid_save_to_glo - Guarda un fichero en una instancia glo - - - - &reftitle.description; - - intcubrid_save_to_glo - resourceconn_identifier - stringoid - stringfile_name - - - La función cubrid_save_to_glo se utiliza para guardar - un fichero en una instancia glo. - - - - - &reftitle.parameters; - - - conn_identifier - Identificador de conexión. - - - oid - Oid de la instancia glo en la que se guardará el fichero. - - - file_name - El nombre del fichero a guardar. - - - - - - &reftitle.returnvalues; - - &true; en caso de éxito. - - - &false; en caso de fallo. - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_save_to_glo</function> - - -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - cubrid_save_to_glo - - - - - Esta función ha sido eliminada desde CUBRID 3.1. - - - - - - &reftitle.seealso; - - cubrid_new_glo - cubrid_load_from_glo - cubrid_send_glo - - - - - diff --git a/reference/cubrid/oldaliases/cubrid-send-glo.xml b/reference/cubrid/oldaliases/cubrid-send-glo.xml deleted file mode 100644 index 57a5202702..0000000000 --- a/reference/cubrid/oldaliases/cubrid-send-glo.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - cubrid_send_glo - Lee los datos desde una instancia glo - - - - &reftitle.description; - - intcubrid_send_glo - resourceconn_identifier - stringoid - - - La función cubrid_send_glo se utiliza para - leer los datos desde una instancia glo y los envía a la salida - estándar de PHP. - - - - - &reftitle.parameters; - - - conn_identifier - Identificador de conexión. - - - oid - Oid de la instancia glo desde la cual se leen los datos. - - - - - - &reftitle.returnvalues; - - &true; en caso de éxito. - - - &false; en caso de fallo. - - - - - &reftitle.examples; - - Ejemplo con <function>cubrid_send_glo</function> - - -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - cubrid_send_glo - - - - - Esta función ha sido eliminada desde CUBRID 3.1. - - - - - - &reftitle.seealso; - - cubrid_new_glo - cubrid_save_to_glo - cubrid_load_from_glo - - - - - diff --git a/reference/cubrid/reference.xml b/reference/cubrid/reference.xml deleted file mode 100644 index 82fffc29be..0000000000 --- a/reference/cubrid/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - &Functions; de CUBRID - - &reference.cubrid.entities.functions; - - - - diff --git a/reference/cubrid/setup.xml b/reference/cubrid/setup.xml deleted file mode 100644 index 50dfd4303f..0000000000 --- a/reference/cubrid/setup.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - &reftitle.setup; - -
- &reftitle.required; - - Para que estas funciones estén disponibles, se debe instalar CUBRID, y compilar la Biblioteca de PHP de CUBRID con soporte para CUBRID. - -
- - &reference.cubrid.configure; - -
- &reftitle.runtime; - - No existe configuración en tiempo de ejecución. - -
- -
- &reftitle.resources; - - En CUBRID se usan cuatro tipos de recursos. El primero es un identificador - de enlace para una conexión de base de datos, el segundo es un recurso que - guarda el resultado de una consulta, y los dos últimos son recursos que guardan - los resultados de una consulta de tipos de datos BLOB/CLOB. - -
- identificador de conexión - - Un identificador de conexión devuelto por cubrid_connect, - cubrid_connect_with_url, - cubrid_pconnect y - cubrid_pconnect_with_url. - -
-
- identificador de solicitud - - Un identificador de solicitud devuelto por cubrid_prepare y cubrid_execute. - -
-
- identificador LOB - - Un identificador LOB devuelto por cubrid_lob_get. - -
-
- identificador LOB2 - - Un identificador LOB devuelto por cubrid_lob2_new u obtenido - de un conjunto de resultados. - -
- -
- -
- diff --git a/reference/dbase/book.xml b/reference/dbase/book.xml deleted file mode 100644 index 3b34726e96..0000000000 --- a/reference/dbase/book.xml +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - - - dBase - - - - &reftitle.intro; - - - &pecl.moved-ver;5.3.0. - - - - Estas funciones permiten acceder a los registros de las bases - de datos en formato dBase (dbf). - - - - Se recomienda no utilizar los ficheros dBase como base de datos de producción. Utilice - SQLite o mejor opte por un verdadero - servidor SQL; - MySQL o - PostgreSQL - son opciones comunes en PHP. El soporte dBase está presente en PHP - únicamente para permitir la importación y exportación de datos - desde y hacia su base de datos, ya que este formato de fichero - es habitualmente comprendido por los programas de hoja de cálculo de Windows. - - - - - A partir de dbase 7.0.0 las bases de datos son automáticamente bloqueadas - via flock. No había soporte para el bloqueo - previamente, por lo que dos procesos de servidor web concurrentes modificando el mismo - fichero dBase probablemente habrían arruinado su base de datos. Esto puede ocurrir incluso con dbase 7.0.0+ en sistemas que implementan el bloqueo - a nivel de proceso con las SAPIs multithreaded. - - - - Los ficheros dBase son simples ficheros secuenciales, con un - número de registros fijo. Los registros son añadidos - al final del fichero y los registros borrados son - conservados hasta que se llame a la función - dbase_pack. - - - Solo se soportan los ficheros dbf niveles 3 (dBASE III+) - 5 (dBASE V). - Los tipos de campos dBase disponibles son: - - Tipo de campos disponible - - - - Campo - Tipo dBase - Formato - Información complementaria - - - - - M - Memo - n/a - Este tipo no es soportado por PHP, y será ignorado - - - D - Date - YYYYMMDD - El tamaño del campo está limitado a 8 - - - T - DateTime - YYYYMMDDhhmmss.uuu - (FoxPro) No se realizan verificaciones de validez. Disponible a partir de dbase 7.0.0. - - - N - Number - Un número - - Se debe declarar un tamaño y una precisión (el número de dígitos - después del punto decimal). - - - - F - Float - Un número flotante - Idéntico a N. - - - C - &string; - Una cadena de caracteres - - Se debe declarar un tamaño. Al recuperar los - datos, la cadena será completada con espacios para alcanzar el - tamaño declarado. Las cadenas demasiado largas serán truncadas silenciosamente - al guardar. - - - - L - &boolean; - - T o Y para &true;, - F o N para &false;, - ? para no inicializada. - - - A partir de dbase 7.0.0, devuelto como bool (&true; o &false;), - o &null; para los campos no inicializados - Anteriormente, devuelto como int (1 o 0). - - - - -
-
- - - A partir de dbase 7.0.0 los campos nullable son soportados para las bases de - datos DBASE_TYPE_FOXPRO. Si un campo es nullable, - pasar &null; definirá el flag respectivo, y al recuperarlo - el valor del campo será &null;. - - - - - No hay soporte para índices o campos memo. - - -
- - - &reference.dbase.setup; - &reference.dbase.constants; - &reference.dbase.reference; - -
- - diff --git a/reference/dbase/configure.xml b/reference/dbase/configure.xml deleted file mode 100644 index 884ddd28c3..0000000000 --- a/reference/dbase/configure.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - - - -
- &reftitle.install; - - &pecl.info; - &url.pecl.package;dbase. - -
- - diff --git a/reference/dbase/constants.xml b/reference/dbase/constants.xml deleted file mode 100644 index f0a2eae628..0000000000 --- a/reference/dbase/constants.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - - - DBASE_VERSION - (string) - - - - La versión de la extensión - (Disponible a partir de dbase 7.0.0) - - - - - - DBASE_RDONLY - (int) - - - - Abre una base de datos en modo de solo lectura. Utilizado con dbase_open. - (Disponible a partir de dbase 7.0.0) - - - - - - DBASE_RDWR - (int) - - - - Abre una base de datos en modo de lectura y escritura. - Utilizado con dbase_open. - (Disponible a partir de dbase 7.0.0) - - - - - - DBASE_TYPE_DBASE - (int) - - - - Crea una base de datos de estilo dBASE. Utilizado con dbase_create. - (Disponible a partir de dbase 7.0.0) - - - - - - DBASE_TYPE_FOXPRO - (int) - - - - Crea una base de datos de estilo FoxPro. Utilizado con dbase_create. - (Disponible a partir de dbase 7.0.0) - - - - - - - diff --git a/reference/dbase/functions/dbase-add-record.xml b/reference/dbase/functions/dbase-add-record.xml deleted file mode 100644 index 96de98d0c9..0000000000 --- a/reference/dbase/functions/dbase-add-record.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - - - dbase_add_record - Añade un registro en una base de datos dBase - - - &reftitle.description; - - booldbase_add_record - resourcedatabase - arraydata - - - dbase_add_record añade los datos proporcionados en la - base de datos dBase especificada. - - - - &reftitle.parameters; - - - - database - - - El recurso de base de datos, devuelto por - dbase_open o dbase_create. - - - - - data - - - Un array de datos indexado. El número de elementos debe ser igual - al número de campos en la base de datos, de lo contrario la función - dbase_add_record fallará. - - - - Si se utiliza dbase_get_record para devolver - un valor para este argumento, no se olvide de reinicializar la clave nombrada - deleted. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL dbase 7.0.0 - - database es ahora un resource - en lugar de un int. - - - - - - - - - &reftitle.examples; - - - Inserción de un registro en una base de datos dBase - - -]]> - - - - - - &reftitle.seealso; - - - dbase_delete_record - dbase_replace_record - - - - - - diff --git a/reference/dbase/functions/dbase-close.xml b/reference/dbase/functions/dbase-close.xml deleted file mode 100644 index e09221358a..0000000000 --- a/reference/dbase/functions/dbase-close.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - - - dbase_close - Cierra una base dBase - - - &reftitle.description; - - booldbase_close - resourcedatabase - - - dbase_close cierra la base de datos correspondiente al - recurso database. - - - - &reftitle.parameters; - - - - database - - - El recurso de base de datos, devuelto por - dbase_open o dbase_create. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL dbase 7.0.0 - - database es ahora un resource - en lugar de un int. - - - - - - - - - &reftitle.examples; - - - Cierra un fichero de base de datos dBase - - -]]> - - - - - - &reftitle.seealso; - - - dbase_open - dbase_create - - - - - - diff --git a/reference/dbase/functions/dbase-create.xml b/reference/dbase/functions/dbase-create.xml deleted file mode 100644 index f0615f8ec5..0000000000 --- a/reference/dbase/functions/dbase-create.xml +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - - - dbase_create - Crea una base de datos dBase - - - &reftitle.description; - - resourcedbase_create - stringpath - arrayfields - inttypeDBASE_TYPE_DBASE - - - dbase_create crea una base de - datos dBase con la definición proporcionada. - Si el fichero ya existe, no se trunca. - dbase_pack puede ser llamado para forzar una troncación. - - ¬e.open-basedir.func; - - - - &reftitle.parameters; - - - - path - - - La ruta de acceso a la base de datos. Puede ser una ruta relativa o absoluta - al fichero donde dBase almacenará sus datos. - - - - - fields - - - Un array de arrays, cada array describe el formato de un campo de la - base de datos. Cada campo está compuesto por un nombre, un carácter - que indica el tipo de campo y opcionalmente, una longitud, una precisión - y un flag nullable. - Los campos soportados se enumeran en la - sección de introducción. - - - - Los nombres de los campos están limitados en longitud y no deben - exceder los 10 caracteres. - - - - - - type - - - El tipo de base de datos a crear. Puede ser - DBASE_TYPE_DBASE o - DBASE_TYPE_FOXPRO. - - - - - - - - &reftitle.returnvalues; - - Devuelve un recurso de base de datos si la base de datos - ha sido creada con éxito, o &false; si ocurre un error. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL dbase 7.0.0 - - El parámetro type ha sido añadido. - - - - PECL dbase 7.0.0 - - dbase_identifier es ahora un resource - en lugar de un int. - - - - - - - - - &reftitle.examples; - - - Creación de un fichero de base de datos dBase - - -]]> - - - - - - &reftitle.seealso; - - - dbase_open - dbase_close - - - - - - diff --git a/reference/dbase/functions/dbase-delete-record.xml b/reference/dbase/functions/dbase-delete-record.xml deleted file mode 100644 index 72e23970a5..0000000000 --- a/reference/dbase/functions/dbase-delete-record.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - - - dbase_delete_record - Borra un registro en una base dBase - - - - &reftitle.description; - - booldbase_delete_record - resourcedatabase - intnumber - - - dbase_delete_record marca el registro - record para el borrado, en la base - dbase_identifier. - - - - Para borrar realmente el registro de la base de datos, se debe - llamar a la función dbase_pack. - - - - - - &reftitle.parameters; - - - - database - - - El recurso de base de datos, devuelto por - dbase_open o dbase_create. - - - - - number - - - Un entero comprendido entre 1 y el número máximo de registros en - la base de datos (tal como devuelto por la función - dbase_numrecords). - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL dbase 7.0.0 - - database es ahora un resource - en lugar de un int. - - - - - - - - - &reftitle.seealso; - - - dbase_add_record - dbase_replace_record - - - - - - diff --git a/reference/dbase/functions/dbase-get-header-info.xml b/reference/dbase/functions/dbase-get-header-info.xml deleted file mode 100644 index 813d128394..0000000000 --- a/reference/dbase/functions/dbase-get-header-info.xml +++ /dev/null @@ -1,177 +0,0 @@ - - - - - - - - dbase_get_header_info - Recupera información de encabezado de una base de datos dBase - - - &reftitle.description; - - arraydbase_get_header_info - resourcedatabase - - - dbase_get_header_info devuelve información sobre - la estructura de las columnas de la base de datos referenciada por el recurso - database. - - - - &reftitle.parameters; - - - - database - - - El recurso de base de datos, devuelto por - dbase_open o dbase_create. - - - - - - - - &reftitle.returnvalues; - - Un array indexado con una entrada para cada columna de la base de datos. - El índice del array comienza en 0. - - - Cada elemento del array contiene un array asociativo que contiene la información - sobre las columnas, como se describe aquí: - - - name - - - El nombre de la columna - - - - - type - - - El nombre legible del tipo de la columna (i.e. date, - boolean, etc.) - Los tipos de campos soportados están enumerados en la - sección de introducción. - - - - - length - - - El número de bytes que puede contener esta columna - - - - - precision - - - El número de decimales para la columna - - - - - format - - - Un formato printf sugerido para la columna - - - - - offset - - - La posición de la columna desde el inicio de la línea - - - - - - - Si la información de encabezado de la base de datos no puede ser leída, &false; es devuelto. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL dbase 7.0.0 - - database es ahora un resource - en lugar de un int. - - - - - - - - - &reftitle.examples; - - - Muestra la información de encabezado para un fichero de base de datos dBase - - -]]> - - - - - - - diff --git a/reference/dbase/functions/dbase-get-record-with-names.xml b/reference/dbase/functions/dbase-get-record-with-names.xml deleted file mode 100644 index 7cd4c53e25..0000000000 --- a/reference/dbase/functions/dbase-get-record-with-names.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - - - dbase_get_record_with_names - - Lee un registro en una base dBase, en forma de array asociativo - - - - &reftitle.description; - - arraydbase_get_record_with_names - resourcedatabase - intnumber - - - Recupera un registro de una base de datos dBase como un array asociativo. - - - - &reftitle.parameters; - - - - database - - - El recurso de base de datos, devuelto por - dbase_open o dbase_create. - - - - - number - - - El índice del registro entre 1 y - dbase_numrecords($dbase_identifier). - - - - - - - - &reftitle.returnvalues; - - El registro, en forma de array asociativo. Esto incluye - también una clave llamada deleted que se define - a 1 si el registro ha sido marcado para eliminación - (ver la función dbase_delete_record). - Por consiguiente, no es posible recuperar el valor de un campo llamado - deleted con esta función. - - &dbase.type-conversion; - - En caso de error, dbase_get_record_with_names - devuelve &false;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECl dbase 7.0.0 - - database es ahora un resource - en lugar de un int. - - - - - - - - - &reftitle.examples; - - - Lista todos los miembros registrados en la base de datos - - -]]> - - - - - - &reftitle.seealso; - - - dbase_get_record - - - - - - diff --git a/reference/dbase/functions/dbase-get-record.xml b/reference/dbase/functions/dbase-get-record.xml deleted file mode 100644 index c09dbea479..0000000000 --- a/reference/dbase/functions/dbase-get-record.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - - dbase_get_record - Lee un registro en una base dBase - - - &reftitle.description; - - arraydbase_get_record - resourcedatabase - intnumber - - - dbase_get_record devuelve los datos del registro record en un array. - - - - &reftitle.parameters; - - - - database - - - El recurso de la base de datos, devuelto por - dbase_open o dbase_create. - - - - - number - - - El índice del registro entre 1 y - dbase_numrecords($dbase_identifier). - - - - - - - - &reftitle.returnvalues; - - Un array indexado con el registro. Este array incluye asimismo - una clave asociada llamada deleted que se define a 1 - si el registro ha sido marcado para eliminación (ver - dbase_delete_record). - - &dbase.type-conversion; - - En caso de error, dbase_get_record devuelve &false;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL dbase 7.0.0 - - database es ahora un resource - en lugar de un int. - - - - - - - - - &reftitle.seealso; - - - dbase_get_record_with_names - - - - - - diff --git a/reference/dbase/functions/dbase-numfields.xml b/reference/dbase/functions/dbase-numfields.xml deleted file mode 100644 index 55e2379df8..0000000000 --- a/reference/dbase/functions/dbase-numfields.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - - dbase_numfields - Cuenta el número de campos de una base dBase - - - &reftitle.description; - - intdbase_numfields - resourcedatabase - - - dbase_numfields devuelve el número de campos (columnas) - de la base de datos dbase_identifier. - - - - Los campos están numerados de 0 a dbase_numfields($db)-1, - mientras que los registros están numerados de 1 a - dbase_numrecords($db). - - - - - &reftitle.parameters; - - - - database - - - El recurso de base de datos, devuelto por - dbase_open o dbase_create. - - - - - - - - &reftitle.returnvalues; - - El número de campos de la base de datos, o &false; si ocurre un error. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL dbase 7.0.0 - - database es ahora un resource - en lugar de un int. - - - - - - - - - &reftitle.examples; - - - Ejemplo con <function>dbase_numfields</function> - - -]]> - - - - - - &reftitle.seealso; - - - dbase_numrecords - - - - - - diff --git a/reference/dbase/functions/dbase-numrecords.xml b/reference/dbase/functions/dbase-numrecords.xml deleted file mode 100644 index 4088503b85..0000000000 --- a/reference/dbase/functions/dbase-numrecords.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - - dbase_numrecords - Cuenta el número de registros en una base dBase - - - &reftitle.description; - - intdbase_numrecords - resourcedatabase - - - Recupera el número de registros (filas) en la base especificada. - - - - Los registros marcados como eliminados también se cuentan. - - - - - Los números de campo están numerados de 0 a - dbase_numfields($db)-1, mientras que los números - de registros están numerados de 1 a - dbase_numrecords($db). - - - - - &reftitle.parameters; - - - - database - - - Un recurso de base de datos, devuelto por - dbase_open o dbase_create. - - - - - - - - &reftitle.returnvalues; - - El número de registros en la base de datos o &false; si ocurre un error. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL dbase 7.0.0 - - El parámetro database es ahora un - resource en lugar de un int. - - - - - - - - - &reftitle.examples; - - - Lectura de todos los registros de la base de datos - - -]]> - - - - - - &reftitle.seealso; - - - dbase_numfields - - - - - - diff --git a/reference/dbase/functions/dbase-open.xml b/reference/dbase/functions/dbase-open.xml deleted file mode 100644 index 7fbd2c1382..0000000000 --- a/reference/dbase/functions/dbase-open.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - - - dbase_open - Abre una base dBase - - - &reftitle.description; - - resourcefalsedbase_open - stringpath - intmode - - - dbase_open abre una base de datos dBase - con un modo de acceso dado. - - ¬e.open-basedir.func; - - - &reftitle.parameters; - - - - path - - - La ruta hacia la base de datos. Puede ser una ruta relativa o absoluta - hacia el fichero donde dBase almacenará sus datos. - - - - - mode - - - Un entero correspondiente al utilizado para la llamada al sistema - open() (Típicamente, 0 significa solo lectura, 1 - significa solo escritura, y 2 significa lectura y escritura). - - - - No se puede abrir un fichero dBase en modo solo escritura, ya que la función - fallará al leer la información de encabezado y, por lo tanto, no se puede utilizar 1 como mode. - - - - A partir de dbase 7.0.0 DBASE_RDONLY y - DBASE_RDWR pueden ser utilizados, respectivamente, - para definir el mode. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un recurso de base de datos en caso de éxito, - &return.falseforfailure;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL dbase 7.0.0 - - El valor devuelto es ahora un resource - en lugar de un int. - - - - - - - - - &reftitle.examples; - - - Apertura de un fichero de base de datos dBase - - -]]> - - - - - - - &reftitle.seealso; - - - dbase_create - dbase_close - - - - - - diff --git a/reference/dbase/functions/dbase-pack.xml b/reference/dbase/functions/dbase-pack.xml deleted file mode 100644 index 254ea7d2dc..0000000000 --- a/reference/dbase/functions/dbase-pack.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - - - dbase_pack - Compacta una base dBase - - - &reftitle.description; - - booldbase_pack - resourcedatabase - - - dbase_pack compacta la base de datos - dbase_identifier (borrado definitivo - de todos los registros marcados para el borrado - utilizando la función dbase_delete_record). - Téngase en cuenta que el fichero será truncado después de una compactación exitosa - (a diferencia del comando PACK de dBASE III). - - - - &reftitle.parameters; - - - - database - - - El recurso database, devuelto por - dbase_open o dbase_create. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL dbase 7.0.0 - - database es ahora - un resource en lugar de un int. - - - - - - - - - &reftitle.examples; - - - Vacía una base de datos dBase - - -]]> - - - - - - - &reftitle.seealso; - - - dbase_delete_record - - - - - - diff --git a/reference/dbase/functions/dbase-replace-record.xml b/reference/dbase/functions/dbase-replace-record.xml deleted file mode 100644 index d85f8a43a2..0000000000 --- a/reference/dbase/functions/dbase-replace-record.xml +++ /dev/null @@ -1,175 +0,0 @@ - - - - - - - - dbase_replace_record - Reemplaza un registro en una base dBase - - - &reftitle.description; - - booldbase_replace_record - resourcedatabase - arraydata - intnumber - - - Reemplaza el registro pasado en la base de datos con los datos proporcionados. - - - - &reftitle.parameters; - - - - database - - - El recurso de la base de datos, devuelto por - dbase_open o dbase_create. - - - - - data - - - Un array indexado de datos. El número de elementos debe ser igual - al número de campos en la base de datos, de lo contrario la función - dbase_replace_record fallará. - - - - Si se utiliza dbase_get_record para devolver el valor - de este argumento, no se olvide de reinicializar la clave nombrada - deleted. - - - - - - number - - - Un entero entre 1 y el número total de registros en la - base de datos (como devuelto por la función - dbase_numrecords). - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL dbase 7.0.0 - - El argumento database es ahora - una resource en lugar de un int. - - - - - - - - - &reftitle.examples; - - - Actualización de un registro en una base de datos - - -]]> - - - - - - - &reftitle.notes; - - - Los resultados de los campos &boolean; son elementos de valor de tipo &integer; - (0 o 1) cuando se recuperan mediante - dbase_get_record o - dbase_get_record_with_names. Si se reescriben, - esto hará que el valor se convierta en 0, por lo que se deben - tomar precauciones para ajustar correctamente los valores. - - - - - - &reftitle.seealso; - - - dbase_add_record - dbase_delete_record - - - - - - diff --git a/reference/dbase/reference.xml b/reference/dbase/reference.xml deleted file mode 100644 index d4a5d6dd55..0000000000 --- a/reference/dbase/reference.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - - &Functions; dBase - - -
- &reftitle.examples; - - La mayoría de los ejemplos de esta documentación requieren una base de datos dBase. Se utilizará /tmp/test.dbf - que es creada en el ejemplo de la función dbase_create. - -
- -
- - &reference.dbase.entities.functions; - -
- - diff --git a/reference/dbase/setup.xml b/reference/dbase/setup.xml deleted file mode 100644 index c4ed76f20e..0000000000 --- a/reference/dbase/setup.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - - - &reftitle.setup; - - - &reference.dbase.configure; - - - -
- &reftitle.resources; - - A partir de dbase 7.0.0, el tipo de recurso dbase está definido, - el cual es devuelto por dbase_open y - dbase_create. - -
- - -
- - diff --git a/reference/dio/book.xml b/reference/dio/book.xml deleted file mode 100644 index f1e945b740..0000000000 --- a/reference/dio/book.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - - Direct IO - - - - &reftitle.intro; - - PHP soporta las funciones Direct IO, tal como se describe en - el estándar Posix (Sección 6) para realizar funciones - I/O de bajo nivel en comparación con las funciones - C-Language stream I/O (fopen, - fread,..). El uso de las funciones - DIO debe considerarse únicamente cuando se requiere un control directo - de un dispositivo. En todos los demás casos, - las funciones estándar del sistema - de archivos son más adecuadas. - - - - - &reference.dio.setup; - &reference.dio.constants; - &reference.dio.reference; - - - - diff --git a/reference/dio/configure.xml b/reference/dio/configure.xml deleted file mode 100644 index 66b6200455..0000000000 --- a/reference/dio/configure.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - - -
- &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;dio. - -
- - diff --git a/reference/dio/constants.xml b/reference/dio/constants.xml deleted file mode 100644 index f1aa668e11..0000000000 --- a/reference/dio/constants.xml +++ /dev/null @@ -1,356 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - - - F_DUPFD - (int) - - - - - - - - F_GETFD - (int) - - - - - - - - F_GETFL - (int) - - - - - - - - F_GETLK - (int) - - - - - - - - F_GETOWN - (int) - - - - - - - - F_RDLCK - (int) - - - - - - - - F_SETFL - (int) - - - - - - - - F_SETLK - (int) - - - - - - - - F_SETLKW - (int) - - - - - - - - F_SETOWN - (int) - - - - - - - - F_UNLCK - (int) - - - - - - - - F_WRLCK - (int) - - - - - - - - O_APPEND - (int) - - - - - - - - O_ASYNC - (int) - - - - - - - - O_CREAT - (int) - - - - - - - - O_EXCL - (int) - - - - - - - - O_NDELAY - (int) - - - - - - - - O_NOCTTY - (int) - - - - - - - - O_NONBLOCK - (int) - - - - - - - - O_RDONLY - (int) - - - - - - - - O_RDWR - (int) - - - - - - - - O_SYNC - (int) - - - - - - - - O_TRUNC - (int) - - - - - - - - O_WRONLY - (int) - - - - - - - - S_IRGRP - (int) - - - - - - - - S_IROTH - (int) - - - - - - - - S_IRUSR - (int) - - - - - - - - S_IRWXG - (int) - - - - - - - - S_IRWXO - (int) - - - - - - - - S_IRWXU - (int) - - - - - - - - S_IWGRP - (int) - - - - - - - - S_IWOTH - (int) - - - - - - - - S_IWUSR - (int) - - - - - - - - S_IXGRP - (int) - - - - - - - - S_IXOTH - (int) - - - - - - - - S_IXUSR - (int) - - - - - - - - - diff --git a/reference/dio/functions/dio-close.xml b/reference/dio/functions/dio-close.xml deleted file mode 100644 index 1744097663..0000000000 --- a/reference/dio/functions/dio-close.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - dio_close - Cierra el descriptor de fichero fd - - - &reftitle.description; - - voiddio_close - resourcefd - - - La función dio_close cierra el descriptor de fichero - fd. - - - - &reftitle.parameters; - - - - fd - - - Descriptor de fichero devuelto por dio_open. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.examples; - - - Cerrando un descriptor de fichero - - -]]> - - - - - - &reftitle.seealso; - - - dio_open - - - - - - diff --git a/reference/dio/functions/dio-fcntl.xml b/reference/dio/functions/dio-fcntl.xml deleted file mode 100644 index 855d9a5235..0000000000 --- a/reference/dio/functions/dio-fcntl.xml +++ /dev/null @@ -1,183 +0,0 @@ - - - - - - - dio_fcntl - Lleva a cabo la función fcntl de la biblioteca C en el fichero fd - - - &reftitle.description; - - mixeddio_fcntl - resourcefd - intcmd - mixedargs - - - La función dio_fcntl realiza la operación - especificada por cmd sobre el descriptor de - fichero fd. Algunos comandos requieren que se - proporcionen parámetros adicionales en args. - - - - &reftitle.parameters; - - - - fd - - - Descriptor de fichero devuelto por dio_open. - - - - - cmd - - - Puede ser una de las siguientes operaciones: - - - - F_SETLK - Se asigna o quita el bloqueo. Si está bloqueado - por otro proceso, dio_fcntl devuelve - -1. - - - - - F_SETLKW - como F_SETLK, - pero en caso de que esté bloqueado por otro proceso, - dio_fcntl espera a que éste se libere. - - - - - F_GETLK - dio_fcntl - devuelve un array asociativo (como se describe a continuación) si algún proceso - previene el bloqueo. Si no hubiera impedimento, se asignará la - clave "type" a F_UNLCK. - - - - - F_DUPFD - encuentra el número de descriptor más - bajo disponible que sea igual o superior a args - y lo devuelve. - - - - - F_SETFL - Establece al descriptor de fichero las - banderas especificadas en args, de entre - O_APPEND, O_NONBLOCK o - O_ASYNC. Para usar O_ASYNC - debe usarse la extensión PCNTL. - - - - - - - - args - - - args es un array asociativo, cuando - cmd sea F_SETLK o - F_SETLKW, con las siguientes claves: - - - - start - posición donde comienza el bloqueo - - - - - length - tamaño del area bloqueada. Cero significa hasta - el final del fichero - - - - - whence - Desde dónde se contabiliza l_start: puede ser - SEEK_SET, - SEEK_END y SEEK_CUR - - - - - type - tipo de bloqueo: puede ser - F_RDLCK (bloqueo de lectura), - F_WRLCK (bloqueo de escritura) o - F_UNLCK (desbloqueo) - - - - - - - - - - - &reftitle.returnvalues; - - Devuelve el resultado de la llamada a C. - - - - &reftitle.examples; - - - Bloqueando y desbloqueando - -F_WRLCK)) == -1) { - // parece el descriptor de fichero está bloqueado - echo "No se puede desbloquear. Pertenece a algún otro proceso."; -} else { - echo "Bloqueo/desbloqueo con éxito"; -} - -dio_close($fd); -?> -]]> - - - - - - - &reftitle.notes; - ¬e.no-windows; - - - - diff --git a/reference/dio/functions/dio-open.xml b/reference/dio/functions/dio-open.xml deleted file mode 100644 index bc4630e95a..0000000000 --- a/reference/dio/functions/dio-open.xml +++ /dev/null @@ -1,179 +0,0 @@ - - - - - - - - dio_open - - Abre (crea si fuera necesario) un fichero a un nivel más bajo que el permitido por - flujos de entrada y salida de las bibliotecas en C - - - - &reftitle.description; - - resourcedio_open - stringfilename - intflags - intmode0 - - - dio_open abre un fichero y devuelve su descriptor - de fichero. - - - - &reftitle.parameters; - - - - filename - - - Ruta del fichero a abrir. - - - - - flags - - - El parámetro flags es una máscara OR de bits - compuesta a partir de las siguientes banderas. Estos valores - tienen que incluir alguno de entre - O_RDONLY, O_WRONLY, - o O_RDWR. Además, podría incluir cualquier - combinación del resto de banderas de la lista. - - - - O_RDONLY - abre el fichero con acceso de lectura. - - - - - O_WRONLY - abre el fichero con acceso de escritura. - - - - - O_RDWR - abre el fichero con acceso de lectura y - de escritura. - - - - - O_CREAT - crea el fichero, si no existiera - ya. - - - - - O_EXCL - si tanto O_CREAT - como O_EXCL están habilitados, y el fichero - existe, dio_open fallará. - - - - - O_TRUNC - si el fichero existe, y está abierto - con sólo escritura, se truncará a cero. - - - - - O_APPEND - las operaciones de escritura añaden los - datos al final del fichero. - - - - - O_NONBLOCK - asigna el modo no bloqueante. - - - - - O_NOCTTY - previene que el SO asigne al fichero - abierto como el terminal controlador del proceso cuando se abra - un fichero de dispositivo TTY. - - - - - - - - mode - - - Si flags contiene - O_CREAT, mode establecerá - los permisos del ficher (permisos - de creación). mode es necesario para un correcto - funcionamiento cuando O_CREAT se especifica en - flags, y se ignorará en cualquier otro caso. - - - Los permisos que realmente se asignan al fichero creado se verán - afectados por el umask del proceso, como - suele suceder. - - - - - - - - &reftitle.returnvalues; - - Descriptor de fichero o &false; en caso de error. - - - - &reftitle.examples; - - Abrir un descriptor de fichero - - -]]> - - - - - &reftitle.seealso; - - - dio_close - - - - - - diff --git a/reference/dio/functions/dio-read.xml b/reference/dio/functions/dio-read.xml deleted file mode 100644 index 9c15b2985d..0000000000 --- a/reference/dio/functions/dio-read.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - dio_read - Leer bytes de un descriptor de fichero - - - &reftitle.description; - - stringdio_read - resourcefd - intlen1024 - - - La función dio_read lee y devuelve - len bytes de fichero con descriptor - fd. - - - - &reftitle.parameters; - - - - fd - - - El fichero descriptor devuelto pordio_open. - - - - - len - - - El número de bytes a leer. Si no se especifica la lectura - es de bloques de 1K - dio_read - - - - - - - - &reftitle.returnvalues; - - La bytes leídos desde fd. - - - - &reftitle.seealso; - - - dio_write - - - - - - diff --git a/reference/dio/functions/dio-seek.xml b/reference/dio/functions/dio-seek.xml deleted file mode 100644 index 5bfbcc5be7..0000000000 --- a/reference/dio/functions/dio-seek.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - dio_seek - Salta a una posición del descriptor de fichero desde donde proceda - - - &reftitle.description; - - intdio_seek - resourcefd - intpos - intwhenceSEEK_SET - - - dio_seek se usa para cambiar la posición del fichero - del descriptor de fichero proporcionado. - - - - &reftitle.parameters; - - - - fd - - - Descriptor de fichero devuelto por dio_open. - - - - - pos - - - Nueva posición. - - - - - whence - - - Indica cómo interpretar la posición pos: - - - - SEEK_SET (por omisión) - indica que - pos se contabiliza a partir del comienzo - del fichero. - - - - - SEEK_CUR - indica que - pos se contabiliza a partir de la posición - actual del fichero. Este valor puede ser positivo o negativo. - - - - - SEEK_END - Indica que - pos contabiliza caracteres a partir del final - del fichero. Un valor negativo especifica una posición perteneciente al - contenido del fichero; un valor positivo especifica una posición que - supera el final. Si éste fuera el caso, y se escribieran datos, se - rellenaría el fichero con ceros hasta alcanzar la posición que - proceda. - - - - - - - - - - - &reftitle.returnvalues; - - - - - &reftitle.examples; - - - Posicionamiento de un fichero - - -]]> - - - - - - - diff --git a/reference/dio/functions/dio-stat.xml b/reference/dio/functions/dio-stat.xml deleted file mode 100644 index c6cfd7c21b..0000000000 --- a/reference/dio/functions/dio-stat.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - dio_stat - - Consulta información de estado del descriptor de fichero fd - - - - &reftitle.description; - - arraydio_stat - resourcefd - - - dio_stat devuelve información sobre el descriptor de - fichero proporcionado. - - - - &reftitle.parameters; - - - - fd - - - Descriptor de fichero devuelto por dio_open. - - - - - - - - &reftitle.returnvalues; - - Devuelve un array asociativo con las siguientes claves: - - - - "device" - dispositivo - - - - - "inode" - nodo-i - - - - - "mode" - modo - - - - - "nlink" - número de enlaces duros - - - - - "uid" - id de usuario - - - - - "gid" - id de grupo - - - - - "device_type" - tipo de dispositivo (si es un nodo-i de dispositivo) - - - - - "size" - tamaño total en bytes - - - - - "blocksize" - tamaño de bloque - - - - - "blocks" - número de bloques asignados - - - - - "atime" - fecha de último acceso - - - - - "mtime" - fecha de última modificación - - - - - "ctime" - fecha de último cambio - - - - En caso de error, dio_stat devuelve &null;. - - - - - diff --git a/reference/dio/functions/dio-tcsetattr.xml b/reference/dio/functions/dio-tcsetattr.xml deleted file mode 100644 index 2858cc90a9..0000000000 --- a/reference/dio/functions/dio-tcsetattr.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - dio_tcsetattr - - Establece los atributos de terminal y la velocidad de transmisión para un puerto serie - - - - &reftitle.description; - - booldio_tcsetattr - resourcefd - arrayoptions - - - dio_tcsetattr establece los atributos de terminal y la velocidad de - transmisión del fd abierto. - - - - &reftitle.parameters; - - - - fd - - - El descriptor de fichero devuelto por dio_open. - - - - - options - - - Las opciones disponibles actualmente son: - - - - 'baud' - velocidad de transmisión del puerto - puede ser 38400,19200,9600,4800,2400,1800, - 1200,600,300,200,150,134,110,75 o 50, el valor por omisión es 9600. - - - - - 'bits' - bits de datos - puede ser 8,7,6 o 5. El valor por omisión es 8. - - - - - 'stop' - bits de parada - puede ser 1 o 2. El valor por omisión es 1. - - - - - 'parity' - puede ser 0,1 o 2. El valor por omisión es 0. - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.examples; - - Establecer la velocidad de transmisión en un puerto serie - - 9600, - 'bits' => 8, - 'stop' => 1, - 'parity' => 0 -)); - -while (true) { - $data = dio_read($fd, 256); - if ($data !== null && $data !== '') { - echo $data; - } -} - -?> -]]> - - - - - - &reftitle.notes; - ¬e.no-windows; - - - diff --git a/reference/dio/functions/dio-truncate.xml b/reference/dio/functions/dio-truncate.xml deleted file mode 100644 index c2b3206df8..0000000000 --- a/reference/dio/functions/dio-truncate.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - dio_truncate - - Trunca un descriptor de fichero fd a un determinado número de bytes - - - - &reftitle.description; - - booldio_truncate - resourcefd - intoffset - - - dio_truncate trunca un fichero a, como mucho, un tamaño de - offset bytes. - - - Si el fichero excediera este tamaño, el contenido extra se - perdería. Si fuera inferior en tamaño, no se especifica si el fichero - se mantiene sin cambios o si se completa. En este último caso, la parte - completada se haría con ceros. - - - - &reftitle.parameters; - - - - fd - - - Descriptor de fichero devuelto por dio_open. - - - - - offset - - - Tamaño en bytes. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.notes; - ¬e.no-windows; - - - - diff --git a/reference/dio/functions/dio-write.xml b/reference/dio/functions/dio-write.xml deleted file mode 100644 index 7c4ace76fa..0000000000 --- a/reference/dio/functions/dio-write.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - dio_write - - Escribe datos en el descriptor de fichero con un truncado opcional - - - - &reftitle.description; - - intdio_write - resourcefd - stringdata - intlen0 - - - dio_write escriba hasta len - bytes de data al fichero fd. - - - - &reftitle.parameters; - - - - fd - - - Descriptor de fichero devuelto por dio_open. - - - - - data - - - Datos a escribir. - - - - - len - - - Longitud en bytes de los datos a escribir. Si no se especifica, la función - escribe todos los datos al fichero especificado. - - - - - - - - &reftitle.returnvalues; - - Devuelve el número de bytes escritos en fd. - - - - &reftitle.seealso; - - - dio_read - - - - - - diff --git a/reference/dio/reference.xml b/reference/dio/reference.xml deleted file mode 100644 index a28710400d..0000000000 --- a/reference/dio/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - - &Functions; de Direct IO - - &reference.dio.entities.functions; - - - diff --git a/reference/dio/setup.xml b/reference/dio/setup.xml deleted file mode 100644 index eff1dd1103..0000000000 --- a/reference/dio/setup.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - - - &reftitle.setup; - - - &reference.dio.configure; - - - -
- &reftitle.resources; - - Un tipo de recurso es definido por esta extensión: - un puntero de fichero, retornado por la función - dio_open. - -
- - -
- - diff --git a/reference/ds/book.xml b/reference/ds/book.xml deleted file mode 100644 index c6c4f1fa47..0000000000 --- a/reference/ds/book.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Estructuras de datos - - - - &reftitle.intro; - - Estructuras de datos eficientes para PHP 7, proporcionadas como alternativa a los &array;. - - - Ver este post de blog - para benchmarks, discusiones y preguntas frecuentes. - - - - &reference.ds.setup; - &reference.ds.examples; - - &reference.ds.ds.collection; - &reference.ds.ds.hashable; - - &reference.ds.ds.sequence; - &reference.ds.ds.vector; - &reference.ds.ds.deque; - - &reference.ds.ds.map; - &reference.ds.ds.pair; - &reference.ds.ds.set; - &reference.ds.ds.stack; - &reference.ds.ds.queue; - &reference.ds.ds.priorityqueue; - - - - diff --git a/reference/ds/ds.collection.xml b/reference/ds/ds.collection.xml deleted file mode 100644 index 5176a0f071..0000000000 --- a/reference/ds/ds.collection.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - La interfaz Collection - Ds\Collection - - - - -
- &reftitle.intro; - - Ds\Collection es la interfaz base que cubre las funcionalidades - comunes a todas las estructuras de datos de esta biblioteca. Garantiza que todas las estructuras - son recorribles, contables y pueden ser convertidas en json utilizando json_encode. - -
- - -
- &reftitle.interfacesynopsis; - - - - Ds\Collection - - - extends - Countable - - - IteratorAggregate - - - JsonSerializable - - - &Methods; - - - &InheritedMethods; - - - - - - - - - - - - - -
- -
- &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL ds 1.4.0 - - Collection implementa - JsonSerializable en lugar de Serializable. (Este cambio fue añadido al polyfill en la versión 1.4.1.) - - - - - -
- -
- - &reference.ds.ds.entities.collection; - -
- - diff --git a/reference/ds/ds.deque.xml b/reference/ds/ds.deque.xml deleted file mode 100644 index e934b0fa34..0000000000 --- a/reference/ds/ds.deque.xml +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - - La clase Deque - Ds\Deque - - - - -
- &reftitle.intro; - - Un Deque (pronunciado “deck”) es una secuencia de valores - en un búfer contiguo que crece y se contrae automáticamente. - El nombre es una abreviación inglesa común de “double-ended queue” (cola de doble final) y es usado - internamente por Ds\Queue. - - - Dos punteros son usados para mantener el seguimiento de una cabecera y una cola. Los punteros pueden - “envolver alrededor” el final del búfer, lo cual evita la necesidad de mover otros - valores alrededor para hacer un espacio. Esto permite que hacer cambios y deshacer cambios sean muy rápidos —  - algo en que Ds\Vector no puede competir. - - - Accediendo a un valor por el índice requiere una traducción entre el índice y su - posición correspondiente en el búfer: ((cabecera + posición) % capacidad). - -
- - -
- Fortalezas - - - Soporta la sintaxis array (corchetes). - Utiliza menos memoria total que un &array; para el mismo número de valores. - Automáticamente libera la memoria asignada cuando su tamaño cae lo suficientemente bajo. - - get, - set, - push, - pop, - shift, y - unshift son todos O(1). - - - -
- -
- Debilidades - - - La capacidad debe ser una potencia de 2. - - insert y - remove son O(n). - - - -
- -
- &reftitle.classsynopsis; - - - - Ds\Deque - - - - - Ds\Deque - - - - Ds\Sequence - - - ArrayAccess - - - - &Constants; - - const - int - Ds\Deque::MIN_CAPACITY - 8 - - - &Methods; - - - - - - -
- - -
- &reftitle.constants; - - - - Ds\Deque::MIN_CAPACITY - - - - - - -
- - -
- &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL ds 1.3.0 - - La clase ahora implementa ArrayAccess. - - - - - - -
- -
- - &reference.ds.ds.entities.deque; - -
- - diff --git a/reference/ds/ds.hashable.xml b/reference/ds/ds.hashable.xml deleted file mode 100644 index f2d5a393b3..0000000000 --- a/reference/ds/ds.hashable.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - La interface Hashable - Ds\Hashable - - - - -
- &reftitle.intro; - - Hashable es una interface que permite a los objetos ser usados como claves. - Esta es una alternativa a spl_object_hash, - la cual determina el hash de un objeto basado en su gestor: - estos significa que dos objetos que son considerados iguales por una implícita - definición no serán tratados como iguales debido a que no son la misma instancia. - - - hash es utilizada para devolver un valor escalar para ser usado como - el valor hash del objeto, el cual determina donde este va en la tabla hash. - Aunque este valor no tiene que ser único, los objetos los cuales son iguales deben - tener el mismo valor hash. - - - equals es utilizada para determinar si dos objetos son iguales. - Está garantizado que el objeto de comparación será una instancia de la misma clase - que el sujeto. - - -
- - -
- &reftitle.interfacesynopsis; - - - - Ds\Hashable - - &Methods; - - - - -
- -
- - &reference.ds.ds.entities.hashable; - -
- - diff --git a/reference/ds/ds.map.xml b/reference/ds/ds.map.xml deleted file mode 100644 index 4b58b87e69..0000000000 --- a/reference/ds/ds.map.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - - La clase Map - Ds\Map - - - - -
- &reftitle.intro; - - Un Map es una colección secuencial de pares clave-valor, casi identico a un - &array; usado en un contexto similar. Las claves pueden ser de cualquier tipo, pero deben ser únicos. - Los valores se reemplazan si se agregan al mapa usando la misma clave. - -
- - - -
- Fortalezas - - - Las claves y valores pueden ser de cualquer tipo, incluyendo objetos. - Soporta la sintaxis array (corchetes). - Se mantiene el orden de inserción. - El rendimiento y la eficiencia de memoria son muy similares al de un &array;. - Automáticamente libera la memoria asignada cuando su tamaño cae lo suficientemente bajo. - - -
- -
- Debilidades - - - No puede ser convertido a un array cuando los objetos son usados como claves. - - -
- - -
- &reftitle.classsynopsis; - - - - Ds\Map - - - - - Ds\Map - - - - Ds\Collection - - - ArrayAccess - - - - &Constants; - - const - int - Ds\Map::MIN_CAPACITY - 8 - - - &Methods; - - - - -
- - -
- &reftitle.constants; - - - - Ds\Map::MIN_CAPACITY - - - - - - -
- - -
- &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL ds 1.3.0 - - La clase ahora implementa ArrayAccess. - - - - PECL ds 1.2.0 - - Ds\Map::MIN_CAPACITY cambió de 16 a 8. - - - - - - -
- -
- - &reference.ds.ds.entities.map; - -
- - diff --git a/reference/ds/ds.pair.xml b/reference/ds/ds.pair.xml deleted file mode 100644 index 59df75f9f1..0000000000 --- a/reference/ds/ds.pair.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - La clase Pair - Ds\Pair - - - - -
- &reftitle.intro; - - Un par es usado por Ds\Map para emparejar las claves con valores. - -
- - -
- &reftitle.classsynopsis; - - - - Ds\Pair - - - - - Ds\Pair - - - - JsonSerializable - - - - - &Methods; - - - - - - - - - -
- -
- - &reference.ds.ds.entities.pair; - -
- - diff --git a/reference/ds/ds.priorityqueue.xml b/reference/ds/ds.priorityqueue.xml deleted file mode 100644 index 78cbbabff8..0000000000 --- a/reference/ds/ds.priorityqueue.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - La clase PriorityQueue - Ds\PriorityQueue - - - - -
- &reftitle.intro; - - Una PriorityQueue es muy similar a una Queue. Los valores son empujados en la cola - con una prioridad asignada, y el valor con la prioridad más alta estará - siempre en la cabeza de la cola. - - - Implementado utilizando un montículo máximo. - - - - "Primero en entrar, primero en salir" se preserva para los valores con la misma prioridad. - - - - - Iterar sobre una PriorityQueue es destructivo, equivalente a operaciones de desapilamiento sucesivas hasta que la cola esté vacía. - - -
- - -
- &reftitle.classsynopsis; - - - - Ds\PriorityQueue - - - - - Ds\PriorityQueue - - - - Ds\Collection - - - - &Constants; - - const - int - Ds\PriorityQueue::MIN_CAPACITY - 8 - - - &Methods; - - - - -
- - -
- &reftitle.constants; - - - - Ds\PriorityQueue::MIN_CAPACITY - - - - - - -
- - -
- - &reference.ds.ds.entities.priorityqueue; - -
- - diff --git a/reference/ds/ds.queue.xml b/reference/ds/ds.queue.xml deleted file mode 100644 index b612b8674a..0000000000 --- a/reference/ds/ds.queue.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - La clase Queue - Ds\Queue - - - - -
- &reftitle.intro; - - Una Queue es una colección "primero en entrar, primero en salir" o "FIFO" que - solo permite el acceso al valor en la cabeza de la cola e itera en este orden, - de manera destructiva. - -
- - -
- &reftitle.classsynopsis; - - - - Ds\Queue - - - - - Ds\Queue - - - - Ds\Collection - - - ArrayAccess - - - - &Constants; - - const - int - Ds\Queue::MIN_CAPACITY - 8 - - - &Methods; - - - - -
- - -
- &reftitle.constants; - - - - Ds\Queue::MIN_CAPACITY - - - - - - -
- - -
- &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL ds 1.3.0 - - Esta clase implementa ahora ArrayAccess. - - - - - - -
- -
- - &reference.ds.ds.entities.queue; - -
- - diff --git a/reference/ds/ds.sequence.xml b/reference/ds/ds.sequence.xml deleted file mode 100644 index 1a6e63cb19..0000000000 --- a/reference/ds/ds.sequence.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - La interfaz Sequence - Ds\Sequence - - - - -
- &reftitle.intro; - - Una Sequence describe el comportamiento de los valores dispuestos en una sola dimensión lineal. - Algunos lenguajes se refieren a esto como una "Lista". Es similar a un array que utiliza - claves enteras incrementales, con la excepción de algunas características: - - Los valores siempre serán indexados como [0, 1, 2, …, size - 1]. - Solo los valores por índice en el rango [0, size - 1] están permitidos. - - - - Casos de uso: - - En cualquier lugar donde se utilizaría un array como lista (sin preocuparse por las claves). - Una alternativa más eficiente a - SplDoublyLinkedList y - SplFixedArray. - - - -
- - -
- &reftitle.interfacesynopsis; - - - - Ds\Sequence - - - extends - Ds\Collection - - - ArrayAccess - - - &Methods; - - - &InheritedMethods; - - - - - - - - - - - - - - - - - - - -
- -
- &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL ds 1.3.0 - - Esta interfaz ahora extiende ArrayAccess. - - - - - - -
- -
- - &reference.ds.ds.entities.sequence; - -
- - diff --git a/reference/ds/ds.set.xml b/reference/ds/ds.set.xml deleted file mode 100644 index 0946c3ddb7..0000000000 --- a/reference/ds/ds.set.xml +++ /dev/null @@ -1,169 +0,0 @@ - - - - - La clase Set - Ds\Set - - - - -
- &reftitle.intro; - - Un Set es una secuencia de valores únicos. Esta implementación utiliza la misma tabla de hash que - Ds\Map, donde los valores se utilizan como claves y el valor mapeado se ignora. - -
- - -
- Fortalezas - - - Los valores pueden ser de cualquier tipo, incluyendo objetos. - Soporte de la sintaxis de array (corchetes). - El orden de inserción se preserva. - Libera automáticamente la memoria asignada cuando su tamaño se vuelve suficientemente pequeño. - - add, - remove y - contains son todos de complejidad O(1). - - - -
- -
- Debilidades - - - No soporta: - push, - pop, - insert, - shift, o - unshift. - - - get es de complejidad O(n) si hay valores eliminados - en el búfer antes del índice accedido, O(1) en caso contrario. - - - -
- -
- &reftitle.classsynopsis; - - - - Ds\Set - - - - - Ds\Set - - - - Ds\Collection - - - ArrayAccess - - - - &Constants; - - const - int - Ds\Set::MIN_CAPACITY - 8 - - - &Methods; - - - - -
- - -
- &reftitle.constants; - - - - Ds\Set::MIN_CAPACITY - - - - - - -
- - -
- &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL ds 1.3.0 - - Esta clase implementa ahora ArrayAccess. - - - - PECL ds 1.2.7 - - Se añadió el método Ds\Set::map. - - - - PECL ds 1.2.0 - - Ds\Set::MIN_CAPACITY cambió de 16 a 8. - - - - - - -
- -
- - &reference.ds.ds.entities.set; - -
- - diff --git a/reference/ds/ds.stack.xml b/reference/ds/ds.stack.xml deleted file mode 100644 index 89b5b105ba..0000000000 --- a/reference/ds/ds.stack.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - La clase Stack - Ds\Stack - - - - -
- &reftitle.intro; - - Una Stack es una colección "último en entrar, primero en salir" o "LIFO" que - solo permite el acceso al valor en la parte superior de la estructura e itera en este - orden, de manera destructiva. - - - Utiliza un Ds\Vector internamente. - -
- - -
- &reftitle.classsynopsis; - - - - Ds\Stack - - - - - Ds\Stack - - - - Ds\Collection - - - ArrayAccess - - - - - &Methods; - - - - -
- -
- &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL ds 1.3.0 - - Esta clase ahora implementa ArrayAccess. - - - - - - -
- -
- - &reference.ds.ds.entities.stack; - -
- - diff --git a/reference/ds/ds.vector.xml b/reference/ds/ds.vector.xml deleted file mode 100644 index e1d2a43997..0000000000 --- a/reference/ds/ds.vector.xml +++ /dev/null @@ -1,160 +0,0 @@ - - - - - - - La clase Vector - Ds\Vector - - - - -
- &reftitle.intro; - - Un Vector es una secuencia de valores en un buffer que crece y se encoge automáticamente. Esta es la más eficiente estructura secuencial debido a que el índice de un valor es un mapeo directo a su índice en el buffer, y el factor de crecimiento no está ligado a un multiplo o exponente específico. - -
- - - -
- Fortalezas - - - Soporta la sintaxis array (corchetes). - Usa menos memoria general que un &array; para el mismo número de valores. - Automáticamente libera la memoria asignada cuando su tamaño cae lo suficientemente bajo. - La capacidad no tiene que ser una potencia de 2. - - get, - set, - push, - pop son todos O(1). - - - -
- -
- Debilidades - - - - shift, - unshift, - insert y - remove son todos O(n). - - - -
- -
- &reftitle.classsynopsis; - - - - - Ds\Vector - - - - - - Ds\Vector - Ds\Sequence - ArrayAccess - - - - &Constants; - - const - int - Ds\Vector::MIN_CAPACITY - 8 - - - &Methods; - - - - - - -
- - -
- &reftitle.constants; - - - - Ds\Vector::MIN_CAPACITY - - - - - - -
- - -
- &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL ds 1.3.0 - - La clase ahora implementa ArrayAccess. - - - - PECL ds 1.2.0 - - Ds\Vector::MIN_CAPACITY cambió de 10 a 8. - - - - - - -
- -
- - &reference.ds.ds.entities.vector; - -
- - diff --git a/reference/ds/ds/collection/clear.xml b/reference/ds/ds/collection/clear.xml deleted file mode 100644 index 6388e059d7..0000000000 --- a/reference/ds/ds/collection/clear.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - Ds\Collection::clear - Eliminar todos los valores - - - - &reftitle.description; - - public voidDs\Collection::clear - - - - Eliminar todos los valores de la colección. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <function>Ds\Collection::clear</function> example - -clear(); -print_r($collection); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 -) -Ds\Vector Object -( -) -]]> - - - - - - - diff --git a/reference/ds/ds/collection/copy.xml b/reference/ds/ds/collection/copy.xml deleted file mode 100644 index 8c38aeca02..0000000000 --- a/reference/ds/ds/collection/copy.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - Ds\Collection::copy - Devuelve una copia superficial de la colección - - - - &reftitle.description; - - public Ds\CollectionDs\Collection::copy - - - - Devuelve una copia superficial de la colección. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una copia superficial de la colección. - - - - - &reftitle.examples; - - <function>Ds\Collection::copy</function> ejemplo - -copy(); - -$b->push(4); - -print_r($a); -print_r($b); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 -) -Ds\Vector Object -( - [0] => 1 - [1] => 2 - [2] => 3 - [3] => 4 -) -]]> - - - - - - - diff --git a/reference/ds/ds/collection/isempty.xml b/reference/ds/ds/collection/isempty.xml deleted file mode 100644 index e2d9d16367..0000000000 --- a/reference/ds/ds/collection/isempty.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - Ds\Collection::isEmpty - Indica si la colección está vacía - - - - &reftitle.description; - - public boolDs\Collection::isEmpty - - - - Indica si la colección está vacía. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si la colección está vacía, &false; en caso contrario. - - - - - &reftitle.examples; - - <function>Ds\Collection::isEmpty</function> ejemplo - -isEmpty()); -var_dump($b->isEmpty()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/collection/toarray.xml b/reference/ds/ds/collection/toarray.xml deleted file mode 100644 index 79443c1047..0000000000 --- a/reference/ds/ds/collection/toarray.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - Ds\Collection::toArray - - Convierte la colección en un &array; - - - - - &reftitle.description; - - public arrayDs\Collection::toArray - - - - Convierte la colección en un &array;. - - - - La conversión a un &array; aún no es soportada. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un &array; que contiene todos los valores en el mismo orden que la colección. - - - - - &reftitle.examples; - - <function>Ds\Collection::toArray</function> ejemplo - -toArray()); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - diff --git a/reference/ds/ds/deque/allocate.xml b/reference/ds/ds/deque/allocate.xml deleted file mode 100644 index 333adf237d..0000000000 --- a/reference/ds/ds/deque/allocate.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Ds\Deque::allocate - Asigna suficiente memoria para una capacidad requerida - - - - &reftitle.description; - - public voidDs\Deque::allocate - intcapacity - - - Asegura que se asigne suficiente memoria para una capacidad requerida. - Esto elimina la necesidad de reasignar el búfer interno a medida que se añaden valores. - - - - - &reftitle.parameters; - - - capacity - - - El número de valores para los cuales se debe asignar la capacidad. - - - - La capacidad permanecerá igual si este valor es inferior o igual a la - capacidad actual. - - - - - La capacidad siempre se redondeará a la potencia de 2 más cercana. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Deque::allocate</function> - -capacity()); - -$deque->allocate(100); -var_dump($deque->capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/deque/apply.xml b/reference/ds/ds/deque/apply.xml deleted file mode 100644 index 2bc7ee32a5..0000000000 --- a/reference/ds/ds/deque/apply.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - Ds\Deque::apply - Actualiza todos los valores aplicando una retrollamada a cada valor - - - - &reftitle.description; - - public voidDs\Deque::apply - callablecallback - - - Actualiza todos los valores aplicando un callback - a cada valor en la deque. - - - - - &reftitle.parameters; - - - callback - - - - - mixed - callback - mixedvalue - - - - Un callable a aplicar a cada valor en la deque. - - - - La retrollamada debe aceptar un valor y devolver lo que el valor debe ser reemplazado por. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Deque::apply</function> - -apply(function($value) { return $value * 2; }); - -print_r($deque); -?> -]]> - - &example.outputs.similar; - - 2 - [1] => 4 - [2] => 6 -) -]]> - - - - - - - diff --git a/reference/ds/ds/deque/capacity.xml b/reference/ds/ds/deque/capacity.xml deleted file mode 100644 index 3ff955fbf0..0000000000 --- a/reference/ds/ds/deque/capacity.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Ds\Deque::capacity - Devuelve la capacidad actual - - - - &reftitle.description; - - public intDs\Deque::capacity - - - - Devuelve la capacidad actual. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La capacidad actual. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Deque::capacity</function> - -capacity()); - -$deque->push(...range(1, 50)); -var_dump($deque->capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/deque/clear.xml b/reference/ds/ds/deque/clear.xml deleted file mode 100644 index 31f97dd43c..0000000000 --- a/reference/ds/ds/deque/clear.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Ds\Deque::clear - Elimina todos los valores del deque - - - - &reftitle.description; - - public voidDs\Deque::clear - - - - Elimina todos los valores del deque. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Deque::clear</function> - -clear(); -print_r($deque); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 -) -Ds\Deque Object -( -) -]]> - - - - - - - diff --git a/reference/ds/ds/deque/construct.xml b/reference/ds/ds/deque/construct.xml deleted file mode 100644 index b077a47a4a..0000000000 --- a/reference/ds/ds/deque/construct.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Ds\Deque::__construct - Crea una nueva instancia - - - - &reftitle.description; - - public Ds\Deque::__construct - mixedvalues - - - Crea una nueva instancia, utilizando un objeto traversable - o un &array; para los valores iniciales. - - - - - &reftitle.parameters; - - - values - - - Un objeto traversable o un &array; a utilizar para los valores iniciales. - - - - - - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Deque::__construct</function> - - -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - diff --git a/reference/ds/ds/deque/contains.xml b/reference/ds/ds/deque/contains.xml deleted file mode 100644 index a51ac912bc..0000000000 --- a/reference/ds/ds/deque/contains.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - Ds\Deque::contains - Determina si el deque contiene valores dados - - - - &reftitle.description; - - public boolDs\Deque::contains - mixedvalues - - - Determina si el deque contiene todos los valores. - - - - - &reftitle.parameters; - - - values - - - Los valores a verificar. - - - - - - - - &reftitle.returnvalues; - - &false; si uno de los valores proporcionados no está en el deque, - &true; en caso contrario. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Deque::contains</function> - -contains('a')); // true -var_dump($deque->contains('a', 'b')); // true -var_dump($deque->contains('c', 'd')); // false - -var_dump($deque->contains(...['c', 'b', 'a'])); // true - -// Siempre estricto -var_dump($deque->contains(1)); // true -var_dump($deque->contains('1')); // false - -var_dump($deque->contains(...[])); // true -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/deque/copy.xml b/reference/ds/ds/deque/copy.xml deleted file mode 100644 index 967b06dcbd..0000000000 --- a/reference/ds/ds/deque/copy.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Ds\Deque::copy - Devuelve una copia superficial de la deque - - - - &reftitle.description; - - public Ds\DequeDs\Deque::copy - - - - Devuelve una copia superficial de la deque. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Una copia superficial de la deque. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Deque::copy</function> - -copy(); - -$b->push(4); - -print_r($a); -print_r($b); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 -) -Ds\Deque Object -( - [0] => 1 - [1] => 2 - [2] => 3 - [3] => 4 -) -]]> - - - - - - - diff --git a/reference/ds/ds/deque/count.xml b/reference/ds/ds/deque/count.xml deleted file mode 100644 index 25ec4e51e6..0000000000 --- a/reference/ds/ds/deque/count.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - - Ds\Deque::count - Devuelve el número de valores en la colección - - - - &reftitle.description; - - Ver Countable::count - - - - - - diff --git a/reference/ds/ds/deque/filter.xml b/reference/ds/ds/deque/filter.xml deleted file mode 100644 index 0c067dc912..0000000000 --- a/reference/ds/ds/deque/filter.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - Ds\Deque::filter - - Crear un nuevo deque utilizando un callable para - determinar qué valores incluir - - - - - &reftitle.description; - - public Ds\DequeDs\Deque::filter - callablecallback - - - Crear un nuevo deque utilizando un callable para - determinar qué valores incluir. - - - - - &reftitle.parameters; - - - - callback - - - - - bool - callback - mixedvalue - - - - Un callable opcional que devuelve &true; si el valor debe ser incluido, &false; en caso contrario. - - - Si no se proporciona ninguna función de retrollamada, solo se incluirán los valores que sean &true; - (ver conversión en booléen). - - - - - - - - - &reftitle.returnvalues; - - Un nuevo deque que contiene todos los valores para los cuales - el callback ha devuelto &true;, o todos los valores que - se convierten en &true; si no se ha proporcionado un callback. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Deque::filter</function> con una función de retrollamada - -filter(function($value) { - return $value % 2 == 0; -})); -?> -]]> - - &example.outputs.similar; - - - int(2) - [1]=> - int(4) -} -]]> - - - - Ejemplo de <function>Ds\Deque::filter</function> sin una función de retrollamada - -filter()); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - string(1) "a" - [2]=> - bool(true) -} -]]> - - - - - - - diff --git a/reference/ds/ds/deque/find.xml b/reference/ds/ds/deque/find.xml deleted file mode 100644 index 66ce330a8c..0000000000 --- a/reference/ds/ds/deque/find.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - Ds\Deque::find - - Intenta encontrar el índice de un valor. - - - - - &reftitle.description; - - public mixedDs\Deque::find - mixedvalue - - - Devuelve el índice del valor, o &false; si no se encuentra. - - - - - - &reftitle.parameters; - - - value - - - El valor a encontrar. - - - - - - - - &reftitle.returnvalues; - - El índice del valor, o &false; si no se encuentra. - - - - Los valores serán comparados por valor y por tipo. - - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Deque::find</function> - -find("a")); // 0 -var_dump($deque->find("b")); // false -var_dump($deque->find("1")); // false -var_dump($deque->find(1)); // 1 -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/deque/first.xml b/reference/ds/ds/deque/first.xml deleted file mode 100644 index e4c8fee334..0000000000 --- a/reference/ds/ds/deque/first.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - Ds\Deque::first - Devuelve el primer valor de la deque - - - - &reftitle.description; - - public mixedDs\Deque::first - - - - Devuelve el primer valor de la deque. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el primer valor de la deque. - - - - - &reftitle.errors; - - UnderflowException si está vacía. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Deque::first</function> - -first()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/deque/get.xml b/reference/ds/ds/deque/get.xml deleted file mode 100644 index 3fda1d28fe..0000000000 --- a/reference/ds/ds/deque/get.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - Ds\Deque::get - Devuelve el valor en un índice dado - - - - &reftitle.description; - - public mixedDs\Deque::get - intindex - - - Devuelve el valor en un índice dado. - - - - - - &reftitle.parameters; - - - index - - - El índice al que se desea acceder, comenzando en 0. - - - - - - - - &reftitle.returnvalues; - - El valor en el índice solicitado. - - - - - &reftitle.errors; - - OutOfRangeException si el índice no es válido. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Deque::get</function> - -get(0)); -var_dump($deque->get(1)); -var_dump($deque->get(2)); -?> -]]> - - &example.outputs.similar; - - - - - - Ejemplo de <function>Ds\Deque::get</function> utilizando la sintaxis de array - - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/deque/insert.xml b/reference/ds/ds/deque/insert.xml deleted file mode 100644 index 1a4e70735c..0000000000 --- a/reference/ds/ds/deque/insert.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - Ds\Deque::insert - Inserta valores en un índice dado - - - - &reftitle.description; - - public voidDs\Deque::insert - intindex - mixedvalues - - - Inserta valores en el deque en un índice dado. - - - - - - &reftitle.parameters; - - - index - - - Inserta en el índice dado. 0 <= index <= count - - - - Se puede insertar en el índice igual al número de valores. - - - - - - values - - - El o los valores a insertar. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - OutOfRangeException si el índice no es válido. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Deque::insert</function> - -insert(0, "e"); // [e] -$deque->insert(1, "f"); // [e, f] -$deque->insert(2, "g"); // [e, f, g] -$deque->insert(0, "a", "b"); // [a, b, e, f, g] -$deque->insert(2, ...["c", "d"]); // [a, b, c, d, e, f, g] - -var_dump($deque); -?> -]]> - - &example.outputs.similar; - - - string(1) "a" - [1]=> - string(1) "b" - [2]=> - string(1) "c" - [3]=> - string(1) "d" - [4]=> - string(1) "e" - [5]=> - string(1) "f" - [6]=> - string(1) "g" -} -]]> - - - - - - - diff --git a/reference/ds/ds/deque/isempty.xml b/reference/ds/ds/deque/isempty.xml deleted file mode 100644 index c69434ff84..0000000000 --- a/reference/ds/ds/deque/isempty.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Ds\Deque::isEmpty - Indica si la deque está vacía - - - - &reftitle.description; - - public boolDs\Deque::isEmpty - - - - Indica si la deque está vacía. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si la deque está vacía, &false; en caso contrario. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Deque::isEmpty</function> - -isEmpty()); -var_dump($b->isEmpty()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/deque/join.xml b/reference/ds/ds/deque/join.xml deleted file mode 100644 index 139bffce09..0000000000 --- a/reference/ds/ds/deque/join.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Ds\Deque::join - Reúne todos los valores en un string - - - - &reftitle.description; - - public stringDs\Deque::join - stringglue - - - Reúne todos los valores en un string utilizando un separador opcional entre cada valor. - - - - - &reftitle.parameters; - - - glue - - - Un string opcional para separar cada valor. - - - - - - - - &reftitle.returnvalues; - - Todos los valores del deque reunidos en un string. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Deque::join</function> utilizando un string separador - -join("|")); -?> -]]> - - &example.outputs.similar; - - - - - - Ejemplo de <function>Ds\Deque::join</function> sin string separador - -join()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/deque/jsonserialize.xml b/reference/ds/ds/deque/jsonserialize.xml deleted file mode 100644 index 0bea31678e..0000000000 --- a/reference/ds/ds/deque/jsonserialize.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - Ds\Deque::jsonSerialize - Devuelve una representación que puede ser convertida en JSON - - - - &reftitle.description; - - Ver JsonSerializable::jsonSerialize - - - - No debería ser necesario llamar a esto directamente. - - - - - - - diff --git a/reference/ds/ds/deque/last.xml b/reference/ds/ds/deque/last.xml deleted file mode 100644 index d51a32f527..0000000000 --- a/reference/ds/ds/deque/last.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - Ds\Deque::last - Devuelve el último valor - - - - &reftitle.description; - - public mixedDs\Deque::last - - - - Devuelve el último valor del deque. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El último valor del deque. - - - - - &reftitle.errors; - - UnderflowException si está vacío. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Deque::last</function> - -last()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/deque/map.xml b/reference/ds/ds/deque/map.xml deleted file mode 100644 index 877fff1f18..0000000000 --- a/reference/ds/ds/deque/map.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - Ds\Deque::map - Devuelve el resultado de la aplicación de una retrollamada a cada valor - - - - &reftitle.description; - - public Ds\DequeDs\Deque::map - callablecallback - - - Devuelve el resultado de la aplicación de callback a - cada valor de la deque. - - - - - &reftitle.parameters; - - - callback - - - - - mixed - callback - mixedvalue - - - - Una callable a aplicar a cada valor de la deque. - - - - La retrollamada debe tomar un argumento y devolver el nuevo valor. - - - - - - - - - &reftitle.returnvalues; - - El resultado de la aplicación de callback a cada valor - de la deque. - - - - Los valores de la instancia actual no serán afectados. - - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Deque::map</function> - -map(function($value) { return $value * 2; })); -print_r($deque); -?> -]]> - - &example.outputs.similar; - - 2 - [1] => 4 - [2] => 6 -) -Ds\Deque Object -( - [0] => 1 - [1] => 2 - [2] => 3 -) -]]> - - - - - - - diff --git a/reference/ds/ds/deque/merge.xml b/reference/ds/ds/deque/merge.xml deleted file mode 100644 index f23200655d..0000000000 --- a/reference/ds/ds/deque/merge.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - Ds\Deque::merge - Devuelve el resultado de la adición de todos los valores dados al deque - - - - &reftitle.description; - - public Ds\DequeDs\Deque::merge - mixedvalues - - - Devuelve el resultado de la adición de todos los valores dados al deque. - - - - - - &reftitle.parameters; - - - values - - - Un objeto traversable o un &array;. - - - - - - - - &reftitle.returnvalues; - - El resultado de la adición de todos los valores dados al deque, - efectivamente el mismo que añadir los valores a una copia, y luego devolver esta copia. - - - - La instancia actual no será afectada. - - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Deque::merge</function> - -merge([4, 5, 6])); -var_dump($deque); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) - [3]=> - int(4) - [4]=> - int(5) - [5]=> - int(6) -} -object(Ds\Deque)#1 (3) { - [0]=> - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - diff --git a/reference/ds/ds/deque/pop.xml b/reference/ds/ds/deque/pop.xml deleted file mode 100644 index a3c6e508b4..0000000000 --- a/reference/ds/ds/deque/pop.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Ds\Deque::pop - Elimina y devuelve el último valor - - - - &reftitle.description; - - public mixedDs\Deque::pop - - - - Elimina y devuelve el último valor. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El último valor eliminado. - - - - - &reftitle.errors; - - UnderflowException si está vacío. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Deque::pop</function> - -pop()); -var_dump($deque->pop()); -var_dump($deque->pop()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/deque/push.xml b/reference/ds/ds/deque/push.xml deleted file mode 100644 index 642653bbe4..0000000000 --- a/reference/ds/ds/deque/push.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - Ds\Deque::push - Añade valores al final del deque - - - - &reftitle.description; - - public voidDs\Deque::push - mixedvalues - - - Añade los valores al final del deque. - - - - - - &reftitle.parameters; - - - values - - - Los valores a añadir. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Deque::push</function> - -push("a"); -$deque->push("b"); -$deque->push("c", "d"); -$deque->push(...["e", "f"]); - -print_r($deque); -?> -]]> - - &example.outputs.similar; - - a - [1] => b - [2] => c - [3] => d - [4] => e - [5] => f -) -]]> - - - - - - - diff --git a/reference/ds/ds/deque/reduce.xml b/reference/ds/ds/deque/reduce.xml deleted file mode 100644 index 93583bfbf4..0000000000 --- a/reference/ds/ds/deque/reduce.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - Ds\Deque::reduce - Reduce el deque a un solo valor utilizando una función de retrollamada - - - - &reftitle.description; - - public mixedDs\Deque::reduce - callablecallback - mixedinitial - - - Reduce el deque a un solo valor utilizando una función de retrollamada. - - - - - - &reftitle.parameters; - - - callback - - - - mixedcallback - mixedcarry - mixedvalue - - - - carry - - - El valor de retorno de la retrollamada anterior, o initial si - es la primera iteración. - - - - - value - - - El valor de la iteración actual. - - - - - - - - - initial - - - El valor inicial del valor de retorno. Puede ser &null;. - - - - - - - - &reftitle.returnvalues; - - El valor de retorno de la retrollamada final. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Deque::reduce</function> con un valor inicial - -reduce($callback, 5)); - -// Iteraciones: -// -// $carry = $initial = 5 -// -// $carry = $carry * 1 = 5 -// $carry = $carry * 2 = 10 -// $carry = $carry * 3 = 30 -?> -]]> - - &example.outputs.similar; - - - - - - Ejemplo de <function>Ds\Deque::reduce</function> sin valor inicial - -reduce(function($carry, $value) { - return $carry + $value + 5; -})); - -// Iteraciones: -// -// $carry = $initial = null -// -// $carry = $carry + 1 + 5 = 6 -// $carry = $carry + 2 + 5 = 13 -// $carry = $carry + 3 + 5 = 21 -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/deque/remove.xml b/reference/ds/ds/deque/remove.xml deleted file mode 100644 index bf7a124322..0000000000 --- a/reference/ds/ds/deque/remove.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - Ds\Deque::remove - Elimina y devuelve un valor por índice - - - - &reftitle.description; - - public mixedDs\Deque::remove - intindex - - - Elimina y devuelve un valor por índice. - - - - - - &reftitle.parameters; - - - index - - - El índice del valor a eliminar. - - - - - - - - &reftitle.returnvalues; - - El valor que ha sido eliminado. - - - - - &reftitle.errors; - - OutOfRangeException si el índice no es válido. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Deque::remove</function> - -remove(1)); -var_dump($deque->remove(0)); -var_dump($deque->remove(0)); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/deque/reverse.xml b/reference/ds/ds/deque/reverse.xml deleted file mode 100644 index 1586df4b6e..0000000000 --- a/reference/ds/ds/deque/reverse.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Ds\Deque::reverse - - Invierte el deque en su lugar - - - - - &reftitle.description; - - public voidDs\Deque::reverse - - - - Invierte el deque en su lugar. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Deque::reverse</function> - -reverse(); - -print_r($deque); -?> -]]> - - &example.outputs.similar; - - c - [1] => b - [2] => a -) -]]> - - - - - - - diff --git a/reference/ds/ds/deque/reversed.xml b/reference/ds/ds/deque/reversed.xml deleted file mode 100644 index af88d50f15..0000000000 --- a/reference/ds/ds/deque/reversed.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - Ds\Deque::reversed - Devuelve una copia invertida - - - - &reftitle.description; - - public Ds\DequeDs\Deque::reversed - - - - Devuelve una copia invertida del deque. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Una copia invertida del deque. - - - - La instancia actual no se ve afectada. - - - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Deque::reversed</function> - -reversed()); -print_r($deque); -?> -]]> - - &example.outputs.similar; - - c - [1] => b - [2] => a -) -Ds\Deque Object -( - [0] => a - [1] => b - [2] => c -) -]]> - - - - - - - diff --git a/reference/ds/ds/deque/rotate.xml b/reference/ds/ds/deque/rotate.xml deleted file mode 100644 index 1abc5c0070..0000000000 --- a/reference/ds/ds/deque/rotate.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Ds\Deque::rotate - Rota el deque un cierto número de rotaciones - - - - &reftitle.description; - - public voidDs\Deque::rotate - introtations - - - Rota el deque un cierto número de rotaciones, lo que equivale a llamar sucesivamente - $deque->push($deque->shift()) si el número de rotaciones es positivo, o - $deque->unshift($deque->pop()) si es negativo. - - - - - - &reftitle.parameters; - - - rotations - - - El número de veces que el deque debe ser rotado. - - - - - - - - &reftitle.returnvalues; - - &return.void;. El deque de la instancia actual será rotado. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Deque::rotate</function> - -rotate(1); // "a" es desplazado, luego empujado. -print_r($deque); - -$deque->rotate(2); // "b" y "c" son ambos desplazados, luego empujados. -print_r($deque); -?> -]]> - - &example.outputs.similar; - - b - [1] => c - [2] => d - [3] => a -) -Ds\Deque Object -( - [0] => d - [1] => a - [2] => b - [3] => c -) -]]> - - - - - - - diff --git a/reference/ds/ds/deque/set.xml b/reference/ds/ds/deque/set.xml deleted file mode 100644 index 8e15583f3a..0000000000 --- a/reference/ds/ds/deque/set.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - Ds\Deque::set - Actualiza un valor en un índice dado - - - - &reftitle.description; - - public voidDs\Deque::set - intindex - mixedvalue - - - Actualiza un valor en un índice dado. - - - - - - &reftitle.parameters; - - - index - - - El índice del valor a actualizar. - - - - - value - - - El nuevo valor. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - OutOfRangeException si el índice no es válido. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Deque::set</function> - -set(1, "_"); -print_r($deque); -?> -]]> - - &example.outputs.similar; - - a - [1] => _ - [2] => c -) -]]> - - - - Ejemplo de <function>Ds\Deque::set</function> utilizando la sintaxis de array - - -]]> - - &example.outputs.similar; - - a - [1] => _ - [2] => c -) -]]> - - - - - - - diff --git a/reference/ds/ds/deque/shift.xml b/reference/ds/ds/deque/shift.xml deleted file mode 100644 index 8e40b4d560..0000000000 --- a/reference/ds/ds/deque/shift.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Ds\Deque::shift - Elimina y devuelve el primer valor - - - - &reftitle.description; - - public mixedDs\Deque::shift - - - - Elimina y devuelve el primer valor. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El primer valor, que ha sido eliminado. - - - - - &reftitle.errors; - - UnderflowException si está vacío. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Deque::shift</function> - -shift()); -var_dump($deque->shift()); -var_dump($deque->shift()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/deque/slice.xml b/reference/ds/ds/deque/slice.xml deleted file mode 100644 index 790cdfeb0c..0000000000 --- a/reference/ds/ds/deque/slice.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - Ds\Deque::slice - - Devuelve un sub-deque de un rango dado - - - - - &reftitle.description; - - public Ds\DequeDs\Deque::slice - intindex - intlength - - - Crear un sub-deque de un rango dado. - - - - - - &reftitle.parameters; - - - index - - - El índice en el que comienza el sub-deque. - - - Si es positivo, el sub-deque comenzará en este índice en el deque. - Si es negativo, el sub-deque comenzará a esta distancia del final. - - - - - length - - - Si se proporciona una longitud y es positiva, el sub-deque resultante - tendrá hasta ese número de valores. - - Si la longitud provoca un desbordamiento, solo se incluirán - los valores hasta el final del deque. - - Si se proporciona una longitud y es negativa, el sub-deque - se detendrá a esa cantidad de valores del final. - - Si no se proporciona una longitud, el sub-deque - contendrá todos los valores entre el índice y el - final del deque. - - - - - - - - &reftitle.returnvalues; - - Un sub-deque del rango dado. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Deque::slice</function> - -slice(2)); - -// Recorte a partir de 1, para una longitud de 3 -print_r($deque->slice(1, 3)); - -// Recorte a partir de 1 en adelante -print_r($deque->slice(1)); - -// Recorte a partir de 2 hacia atrás -print_r($deque->slice(-2)); - -// Recorte de 1 a 1 del final -print_r($deque->slice(1, -1)); -?> -]]> - - &example.outputs.similar; - - c - [1] => d - [2] => e -) -Ds\Deque Object -( - [0] => b - [1] => c - [2] => d -) -Ds\Deque Object -( - [0] => b - [1] => c - [2] => d - [3] => e -) -Ds\Deque Object -( - [0] => d - [1] => e -) -Ds\Deque Object -( - [0] => b - [1] => c - [2] => d -) - -]]> - - - - - - - diff --git a/reference/ds/ds/deque/sort.xml b/reference/ds/ds/deque/sort.xml deleted file mode 100644 index 8a8d3c8969..0000000000 --- a/reference/ds/ds/deque/sort.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - Ds\Deque::sort - - Ordena el deque en su lugar - - - - - &reftitle.description; - - public voidDs\Deque::sort - callablecomparator - - - Ordena el deque en su lugar, utilizando una función comparator opcional. - - - - - - &reftitle.parameters; - - - comparator - - &sort.callback.description; - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Deque::sort</function> - -sort(); - -print_r($deque); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 - [3] => 4 - [4] => 5 -) -]]> - - - - Ejemplo de <function>Ds\Deque::sort</function> utilizando un comparador - -sort(function($a, $b) { - return $b <=> $a; -}); - -print_r($deque); -?> -]]> - - &example.outputs.similar; - - 5 - [1] => 4 - [2] => 3 - [3] => 2 - [4] => 1 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/deque/sorted.xml b/reference/ds/ds/deque/sorted.xml deleted file mode 100644 index e7dd78b899..0000000000 --- a/reference/ds/ds/deque/sorted.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - Ds\Deque::sorted - Devuelve una copia ordenada - - - - &reftitle.description; - - public Ds\DequeDs\Deque::sorted - callablecomparator - - - Devuelve una copia ordenada del deque, utilizando una función comparator opcional. - - - - - - &reftitle.parameters; - - - comparator - - &sort.callback.description; - - - - - - - &reftitle.returnvalues; - - Devuelve una copia ordenada del deque. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Deque::sorted</function> - -sorted()); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 - [3] => 4 - [4] => 5 -) -]]> - - - - Ejemplo de <function>Ds\Deque::sorted</function> utilizando un comparador - -sorted(function($a, $b) { - return $b <=> $a; -}); - -print_r($sorted); -?> -]]> - - &example.outputs.similar; - - 5 - [1] => 4 - [2] => 3 - [3] => 2 - [4] => 1 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/deque/sum.xml b/reference/ds/ds/deque/sum.xml deleted file mode 100644 index e8735d38c8..0000000000 --- a/reference/ds/ds/deque/sum.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - Ds\Deque::sum - Devuelve la suma de todos los valores del deque - - - - &reftitle.description; - - public intfloatDs\Deque::sum - - - - Devuelve la suma de todos los valores del deque. - - - - Los arrays y los objetos se consideran iguales a cero durante el cálculo de la suma. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La suma de todos los valores del deque como float o int - dependiendo de los valores del deque. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Deque::sum</function> con un entero - -sum()); -?> -]]> - - &example.outputs.similar; - - - - - - Ejemplo de <function>Ds\Deque::sum</function> con un número de punto flotante - -sum()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/deque/toarray.xml b/reference/ds/ds/deque/toarray.xml deleted file mode 100644 index 860312bbf8..0000000000 --- a/reference/ds/ds/deque/toarray.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Ds\Deque::toArray - - Convierte el deque en un &array; - - - - - &reftitle.description; - - public arrayDs\Deque::toArray - - - - Convierte el deque en un &array;. - - - - La conversión en un &array; aún no es soportada. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un &array; que contiene todas las valores en el mismo orden que el deque. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Deque::toArray</function> - -toArray()); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - diff --git a/reference/ds/ds/deque/unshift.xml b/reference/ds/ds/deque/unshift.xml deleted file mode 100644 index d3c744c15d..0000000000 --- a/reference/ds/ds/deque/unshift.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Ds\Deque::unshift - Añade valores al inicio del deque - - - - &reftitle.description; - - public voidDs\Deque::unshift - mixedvalues - - - Añade los valores al inicio del deque, desplazando todos los valores actuales - hacia adelante para hacer espacio para los nuevos valores. - - - - - - &reftitle.parameters; - - - values - - - Los valores a añadir al inicio del deque. - - - Los valores serán añadidos en el mismo orden en que son - pasados. - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Deque::unshift</function> - -unshift("a"); -$deque->unshift("b", "c"); - -print_r($deque); -?> -]]> - - &example.outputs.similar; - - b - [1] => c - [2] => a - [3] => 1 - [4] => 2 - [5] => 3 -) -]]> - - - - - - - diff --git a/reference/ds/ds/hashable/equals.xml b/reference/ds/ds/hashable/equals.xml deleted file mode 100644 index c72d8d64ad..0000000000 --- a/reference/ds/ds/hashable/equals.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Ds\Hashable::equals - Determina si un objeto es igual a la instancia actual - - - - &reftitle.description; - - abstract public boolDs\Hashable::equals - objectobj - - - Determina si otro objeto es igual a la instancia actual. - - - - Este método permite utilizar objetos como claves en estructuras tales como - Ds\Map y Ds\Set, o cualquier otra - estructura de búsqueda que respete esta interfaz. - - - - - Se garantiza que obj es una instancia de la misma clase. - - - - - - Es importante que los objetos que son iguales tengan también el mismo valor de hash. - Ver Ds\Hashable::hash. - - - - - - - &reftitle.parameters; - - - obj - - - El objeto a comparar con la instancia actual, que siempre es una instancia de - la misma clase. - - - - - - - - &reftitle.returnvalues; - - &true; si los objetos son iguales, de lo contrario &false;. - - - - - - diff --git a/reference/ds/ds/hashable/hash.xml b/reference/ds/ds/hashable/hash.xml deleted file mode 100644 index 4f83b549b3..0000000000 --- a/reference/ds/ds/hashable/hash.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - Ds\Hashable::hash - Devuelve un valor escalar para usar como valor de hash - - - - &reftitle.description; - - abstract public mixedDs\Hashable::hash - - - - Devuelve un valor escalar para usar como valor de hash de los objetos. - - - Mientras que el valor de hash no defina la igualdad, todos los objetos que son iguales según Ds\Hashable::equals - deben tener el mismo valor de hash. Los valores de hash de los objetos iguales no tienen que ser únicos, por ejemplo - se podría simplemente devolver &true; para todos los objetos y nada se rompería - la única - implicación sería que las tablas de hash se convertirían en listas enlazadas porque todos - los objetos serían hasheados en el mismo cubo. Es por lo tanto muy importante - que se elija un buen valor de hash, como un ID o una dirección de correo electrónico. - - - - Este método permite usar objetos como claves en estructuras tales como - Ds\Map y Ds\Set, o cualquier otra - estructura de búsqueda que respete esta interfaz. - - - - - No elija un valor que podría cambiar en el objeto, como una propiedad pública. - Las búsquedas en las tablas de hash fallarían porque el hash ha cambiado. - - - - - - Todos los objetos que son iguales deben tener el mismo valor de hash. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un valor escalar para usar como valor de hash de este objeto. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Hashable::hash</function> - -name = $name; - $this->email = $email; - } - - /** - * Debe devolver el mismo valor para todos los objetos iguales, pero no tiene que - * ser único. Este valor no será utilizado para determinar la igualdad. - */ - public function hash() - { - return $this->email; - } - - /** - * Determina la igualdad, generalmente durante una búsqueda en una tabla de hash para determinar - * si la clave del cubo coincide con la clave de búsqueda. El hash debe ser igual si - * los objetos son iguales, de lo contrario esta determinación no se alcanzaría. - */ - public function equals($obj): bool - { - return $this->name === $obj->name - && $this->email === $obj->email; - } -} -?> -]]> - - - - - - - diff --git a/reference/ds/ds/map/allocate.xml b/reference/ds/ds/map/allocate.xml deleted file mode 100644 index 950723cbb4..0000000000 --- a/reference/ds/ds/map/allocate.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Ds\Map::allocate - Asigna suficiente memoria para una capacidad requerida - - - - &reftitle.description; - - public voidDs\Map::allocate - intcapacity - - - Asigna suficiente memoria para una capacidad requerida. - - - - - - &reftitle.parameters; - - - capacity - - - El número de valores para los cuales la capacidad debe ser asignada. - - - - La capacidad permanecerá igual si este valor es inferior o igual a la - capacidad actual. - - - - - La capacidad será siempre redondeada a la potencia de 2 más cercana. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Map::allocate</function> - -capacity()); - -$map->allocate(100); -var_dump($map->capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/map/apply.xml b/reference/ds/ds/map/apply.xml deleted file mode 100644 index cd968c3dc7..0000000000 --- a/reference/ds/ds/map/apply.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - Ds\Map::apply - Actualiza todos los valores aplicando una retrollamada a cada valor - - - - &reftitle.description; - - public voidDs\Map::apply - callablecallback - - - Actualiza todos los valores aplicando una callback a - cada valor del mapa. - - - - - &reftitle.parameters; - - - callback - - - - - mixed - callback - mixedkey - mixedvalue - - - - Un callable a aplicar a cada valor del mapa. - - - - La retrollamada debe devolver lo que el valor debe ser reemplazado por. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Map::apply</function> - - 1, "b" => 2, "c" => 3]); -$map->apply(function($key, $value) { return $value * 2; }); - -print_r($map); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => a - [value] => 2 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 4 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 6 - ) - -) -]]> - - - - - - - diff --git a/reference/ds/ds/map/capacity.xml b/reference/ds/ds/map/capacity.xml deleted file mode 100644 index c0f9b3239e..0000000000 --- a/reference/ds/ds/map/capacity.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - Ds\Map::capacity - Devuelve la capacidad actual - - - - &reftitle.description; - - public intDs\Map::capacity - - - - Devuelve la capacidad actual. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La capacidad actual. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Map::capacity</function> - -capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/map/clear.xml b/reference/ds/ds/map/clear.xml deleted file mode 100644 index bb4c4f3324..0000000000 --- a/reference/ds/ds/map/clear.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - Ds\Map::clear - Elimina todos los valores - - - - &reftitle.description; - - public voidDs\Map::clear - - - - Elimina todos los valores del mapa. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Map::clear</function> - - 1, - "b" => 2, - "c" => 3, -]); -print_r($map); - -$map->clear(); -print_r($map); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => a - [value] => 1 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 3 - ) - -) -Ds\Map Object -( -) -]]> - - - - - - - diff --git a/reference/ds/ds/map/construct.xml b/reference/ds/ds/map/construct.xml deleted file mode 100644 index 03e7952662..0000000000 --- a/reference/ds/ds/map/construct.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - Ds\Map::__construct - Crear una nueva instancia - - - - &reftitle.description; - - public Ds\Map::__construct - mixedvalues - - - Crear una nueva instancia, utilizando un objeto traversable - o un &array; para los values iniciales. - - - - - - &reftitle.parameters; - - - values - - - Un objeto traversable o un &array; a utilizar para los valores iniciales. - - - - - - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Map::__construct</function> - - 1, "b" => 2, "c" => 3]); -var_dump($map); -?> -]]> - - &example.outputs.similar; - - - object(Ds\Pair)#1 (2) { - ["key"]=> - string(1) "a" - ["value"]=> - int(1) - } - [1]=> - object(Ds\Pair)#3 (2) { - ["key"]=> - string(1) "b" - ["value"]=> - int(2) - } - [2]=> - object(Ds\Pair)#4 (2) { - ["key"]=> - string(1) "c" - ["value"]=> - int(3) - } -} -]]> - - - - - - - diff --git a/reference/ds/ds/map/copy.xml b/reference/ds/ds/map/copy.xml deleted file mode 100644 index f1867d7aea..0000000000 --- a/reference/ds/ds/map/copy.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Ds\Map::copy - Devuelve una copia superficial del mapa - - - - &reftitle.description; - - public Ds\MapDs\Map::copy - - - - Devuelve una copia superficial del mapa. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una copia superficial del mapa. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Map::copy</function> - - 1, - "b" => 2, - "c" => 3, -]); - -print_r($map->copy()); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => a - [value] => 1 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 3 - ) - -) -]]> - - - - - - - diff --git a/reference/ds/ds/map/count.xml b/reference/ds/ds/map/count.xml deleted file mode 100644 index 9d69c60932..0000000000 --- a/reference/ds/ds/map/count.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - - Ds\Map::count - Devuelve el número de valores en el mapa - - - - &reftitle.description; - - Ver Countable::count - - - - - - diff --git a/reference/ds/ds/map/diff.xml b/reference/ds/ds/map/diff.xml deleted file mode 100644 index 8811ab43e9..0000000000 --- a/reference/ds/ds/map/diff.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - Ds\Map::diff - Crear un nuevo map utilizando claves que no están en otro map - - - - &reftitle.description; - - public Ds\MapDs\Map::diff - Ds\Mapmap - - - Devuelve el resultado de la eliminación de todas las claves de la instancia actual que están - presentes en un map dado. - - - A \ B = {x ∈ A | x ∉ B} - - - - - &reftitle.parameters; - - - map - - - El map que contiene las claves a excluir del map resultante. - - - - - - - - &reftitle.returnvalues; - - El resultado de la eliminación de todas las claves de la instancia actual que están - presentes en un map dado. - - - - - &reftitle.seealso; - - - Complemento en Wikipedia - - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Map::diff</function> - - 1, "b" => 2, "c" => 3]); -$b = new \Ds\Map(["b" => 4, "c" => 5, "d" => 6]); - -var_dump($a->diff($b)); -?> -]]> - - &example.outputs.similar; - - - object(Ds\Pair)#4 (2) { - ["key"]=> - string(1) "a" - ["value"]=> - int(1) - } -} -]]> - - - - - - - diff --git a/reference/ds/ds/map/filter.xml b/reference/ds/ds/map/filter.xml deleted file mode 100644 index f5346db4ca..0000000000 --- a/reference/ds/ds/map/filter.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - - Ds\Map::filter - - Crear un nuevo mapa utilizando un callable para determinar qué pares incluir - - - - - &reftitle.description; - - public Ds\MapDs\Map::filter - callablecallback - - - Crear un nuevo mapa utilizando un callable para determinar qué pares incluir. - - - - - - &reftitle.parameters; - - - callback - - - - bool - callback - mixedkey - mixedvalue - - - - Un callable opcional que devuelve &true; si el par debe ser incluido, &false; en caso contrario. - - - Si no se proporciona ninguna función de retrollamada, solo se incluirán los valores que sean &true; - (ver conversión en booléen). - - - - - - - - &reftitle.returnvalues; - - Un nuevo mapa que contiene todos los pares para los cuales - el callback ha devuelto &true;, o todas las claves que - se convierten en &true; si no se proporciona un callback. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Map::filter</function> utilizando una función de retrollamada - -filter(function($key, $value) { - return $key % 2 == 0; -})); -?> -]]> - - &example.outputs.similar; - - - object(Ds\Pair)#2 (2) { - ["key"]=> - int(0) - ["value"]=> - string(1) "a" - } - [1]=> - object(Ds\Pair)#4 (2) { - ["key"]=> - int(2) - ["value"]=> - string(1) "c" - } - [2]=> - object(Ds\Pair)#5 (2) { - ["key"]=> - int(4) - ["value"]=> - string(1) "e" - } -} -]]> - - - - Ejemplo de <function>Ds\Map::filter</function> sin función de retrollamada - - 0, "b" => 1, "c" => true, "d" => false]); - -var_dump($map->filter()); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - string(1) "a" - [2]=> - bool(true) -} -]]> - - - - - - - diff --git a/reference/ds/ds/map/first.xml b/reference/ds/ds/map/first.xml deleted file mode 100644 index 01a21c7a4f..0000000000 --- a/reference/ds/ds/map/first.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Ds\Map::first - Devuelve la primera pareja del mapa - - - - &reftitle.description; - - public Ds\PairDs\Map::first - - - - Devuelve la primera pareja del mapa. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La primera pareja del mapa. - - - - - &reftitle.errors; - - UnderflowException si está vacío. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Map::first</function> - - 1, "b" => 2, "c" => 3]); -var_dump($map->first()); -?> -]]> - - &example.outputs.similar; - - - string(1) "a" - ["value"]=> - int(1) -} -]]> - - - - - - - diff --git a/reference/ds/ds/map/get.xml b/reference/ds/ds/map/get.xml deleted file mode 100644 index 0afcb6625e..0000000000 --- a/reference/ds/ds/map/get.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - Ds\Map::get - Devuelve el valor para una clave dada - - - - &reftitle.description; - - public mixedDs\Map::get - mixedkey - mixeddefault - - - Devuelve el valor para una clave dada, o un valor por defecto opcional si la clave - no ha podido ser encontrada. - - - - - Las claves de tipo object son soportadas. - - Si un objeto implementa Ds\Hashable, - la igualdad será determinada por la función equals del objeto. - - Si un objeto no implementa Ds\Hashable, - los objetos deben ser referencias a la misma instancia para ser considerados iguales. - - - - - - Asimismo, se puede utilizar la sintaxis de array para acceder a los valores por clave, por ejemplo $map["clé"]. - - - - - - Atención al uso de la sintaxis de array. Las claves escalares serán coercionadas a - enteros por el motor. Por ejemplo, $map["1"] intentará acceder a int(1), - mientras que $map->get("1") buscará correctamente la clave de string. - - - Ver array. - - - - - - - &reftitle.parameters; - - - key - - - La clave a buscar. - - - - - default - - - El valor por defecto opcional, devuelto si la clave no ha podido ser encontrada. - - - - - - - - &reftitle.returnvalues; - - El valor mapeado a la clave dada, o el valor por defecto - si se proporciona y la clave no ha podido ser encontrada en el mapa. - - - - - &reftitle.errors; - - OutOfBoundsException si la clave no ha podido ser encontrada - y ningún valor por defecto ha sido proporcionado. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Map::get</function> - - 1, "b" => 2, "c" => 3]); - -var_dump($map->get("a")); // 1 -var_dump($map->get("d", 10)); // 10 (usar por defecto) -?> -]]> - - &example.outputs.similar; - - - - - - Ejemplo de <function>Ds\Map::get</function> utilizando la sintaxis de array - - 1, "b" => 2, "c" => 3]); - -var_dump($map["a"]); // 1 -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/map/haskey.xml b/reference/ds/ds/map/haskey.xml deleted file mode 100644 index 532317d90a..0000000000 --- a/reference/ds/ds/map/haskey.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Ds\Map::hasKey - Determina si el mapa contiene una clave dada - - - - &reftitle.description; - - public boolDs\Map::hasKey - mixedkey - - - Determina si el mapa contiene una clave dada. - - - - - - &reftitle.parameters; - - - key - - - La clave a buscar. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si la clave ha sido encontrada, de lo contrario &false;. - - - - - &reftitle.examples; - - <function>Ds\Map::hasKey</function> example - - 1, "b" => 2, "c" => 3]); - -var_dump($map->hasKey("a")); // true -var_dump($map->hasKey("e")); // false -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/map/hasvalue.xml b/reference/ds/ds/map/hasvalue.xml deleted file mode 100644 index 4ed199e117..0000000000 --- a/reference/ds/ds/map/hasvalue.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Ds\Map::hasValue - Determina si el mapa contiene un valor dado - - - - &reftitle.description; - - public boolDs\Map::hasValue - mixedvalue - - - Determina si el mapa contiene un valor dado. - - - - - - &reftitle.parameters; - - - value - - - El valor a buscar. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si el valor ha sido encontrado, de lo contrario &false;. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Map::hasValue</function> - - 1, "b" => 2, "c" => 3]); - -var_dump($map->hasValue(1)); // true -var_dump($map->hasValue(4)); // false -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/map/intersect.xml b/reference/ds/ds/map/intersect.xml deleted file mode 100644 index c8dd24282a..0000000000 --- a/reference/ds/ds/map/intersect.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - Ds\Map::intersect - Crear un nuevo mapa intersectando las claves con otro mapa - - - - &reftitle.description; - - public Ds\MapDs\Map::intersect - Ds\Mapmap - - - Crear un nuevo mapa que contiene las parejas de la instancia actual cuyas claves - están también presentes en el map dado. - - En otras palabras, devuelve una copia de la instancia actual con todas las claves eliminadas que - no están también en el otro map. - - - A ∩ B = {x : x ∈ A ∧ x ∈ B} - - - - - Los valores de la instancia actual serán conservados. - - - - - - &reftitle.parameters; - - - map - - - El otro mapa, que contiene las claves a intersectar. - - - - - - - - &reftitle.returnvalues; - - La intersección de las claves de la instancia actual y de otro map. - - - - - &reftitle.seealso; - - - Intersección en Wikipedia - - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Map::intersect</function> - - 1, "b" => 2, "c" => 3]); -$b = new \Ds\Map(["b" => 4, "c" => 5, "d" => 6]); - -var_dump($a->intersect($b)); -?> -]]> - - &example.outputs.similar; - - - object(Ds\Pair)#4 (2) { - ["key"]=> - string(1) "b" - ["value"]=> - int(2) - } - [1]=> - object(Ds\Pair)#5 (2) { - ["key"]=> - string(1) "c" - ["value"]=> - int(3) - } -} -]]> - - - - - - - diff --git a/reference/ds/ds/map/isempty.xml b/reference/ds/ds/map/isempty.xml deleted file mode 100644 index 0a4d324bb5..0000000000 --- a/reference/ds/ds/map/isempty.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Ds\Map::isEmpty - Indica si el mapa está vacío - - - - &reftitle.description; - - public boolDs\Map::isEmpty - - - - Indica si el mapa está vacío. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si el mapa está vacío, de lo contrario &false;. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Map::isEmpty</function> - - 1, "b" => 2, "c" => 3]); -$b = new \Ds\Map(); - -var_dump($a->isEmpty()); -var_dump($b->isEmpty()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/map/jsonserialize.xml b/reference/ds/ds/map/jsonserialize.xml deleted file mode 100644 index 93edf07e68..0000000000 --- a/reference/ds/ds/map/jsonserialize.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - Ds\Map::jsonSerialize - Devuelve una representación que puede ser convertida en JSON - - - - &reftitle.description; - - Ver JsonSerializable::jsonSerialize - - - - Nunca debería ser necesario llamar a esto directamente. - - - - - - - diff --git a/reference/ds/ds/map/keys.xml b/reference/ds/ds/map/keys.xml deleted file mode 100644 index 31cb1c86b3..0000000000 --- a/reference/ds/ds/map/keys.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Ds\Map::keys - Devuelve un conjunto de las claves del mapa - - - - &reftitle.description; - - public Ds\SetDs\Map::keys - - - - Devuelve un conjunto que contiene todas las claves del mapa, en el mismo orden. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un conjunto Ds\Set que contiene todas las claves del mapa. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Map::keys</function> - - 1, "b" => 2, "c" => 3]); -var_dump($map->keys()); -?> -]]> - - &example.outputs.similar; - - - string(1) "a" - [1]=> - string(1) "b" - [2]=> - string(1) "c" -} -]]> - - - - - - - diff --git a/reference/ds/ds/map/ksort.xml b/reference/ds/ds/map/ksort.xml deleted file mode 100644 index 1255503e30..0000000000 --- a/reference/ds/ds/map/ksort.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - - Ds\Map::ksort - - Ordena el mapa en el lugar por clave - - - - - &reftitle.description; - - public voidDs\Map::ksort - callablecomparator - - - Ordena el mapa en el lugar por clave, utilizando una función comparator opcional. - - - - - - &reftitle.parameters; - - - comparator - - &sort.callback.description; - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Map::ksort</function> - - 2, "c" => 3, "a" => 1]); -$map->ksort(); - -print_r($map); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => a - [value] => 1 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 3 - ) - -) -]]> - - - - Ejemplo de <function>Ds\Map::ksort</function> utilizando un comparador - - "x", 2 => "y", 0 => "z"]); - -// Reverse -$map->ksort(function($a, $b) { - return $b <=> $a; -}); - -print_r($map); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => 2 - [value] => y - ) - - [1] => Ds\Pair Object - ( - [key] => 1 - [value] => x - ) - - [2] => Ds\Pair Object - ( - [key] => 0 - [value] => z - ) - -) -]]> - - - - - - - - diff --git a/reference/ds/ds/map/ksorted.xml b/reference/ds/ds/map/ksorted.xml deleted file mode 100644 index 1a2c6028ee..0000000000 --- a/reference/ds/ds/map/ksorted.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - Ds\Map::ksorted - Devuelve una copia, ordenada por clave - - - - &reftitle.description; - - public Ds\MapDs\Map::ksorted - callablecomparator - - - Devuelve una copia ordenada por clave, utilizando una función comparator opcional. - - - - - - &reftitle.parameters; - - - comparator - - &sort.callback.description; - - - - - - - &reftitle.returnvalues; - - Devuelve una copia del mapa, ordenada por clave. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Map::ksorted</function> - - 2, "c" => 3, "a" => 1]); - -print_r($map->ksorted()); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => a - [value] => 1 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 3 - ) - -) -]]> - - - - Ejemplo de <function>Ds\Map::ksorted</function> utilizando un comparador - - "x", 2 => "y", 0 => "z"]); - -// Invertir -$sorted = $map->ksorted(function($a, $b) { - return $b <=> $a; -}); - -print_r($sorted); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => 2 - [value] => y - ) - - [1] => Ds\Pair Object - ( - [key] => 1 - [value] => x - ) - - [2] => Ds\Pair Object - ( - [key] => 0 - [value] => z - ) - -) -]]> - - - - - - - - diff --git a/reference/ds/ds/map/last.xml b/reference/ds/ds/map/last.xml deleted file mode 100644 index 7bc83578d5..0000000000 --- a/reference/ds/ds/map/last.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Ds\Map::last - Devuelve el último par del mapa - - - - &reftitle.description; - - public Ds\PairDs\Map::last - - - - Devuelve el último par del mapa. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el último par del mapa. - - - - - &reftitle.errors; - - UnderflowException si está vacío. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Map::last</function> - - 1, "b" => 2, "c" => 3]); -var_dump($map->last()); -?> -]]> - - &example.outputs.similar; - - - string(1) "c" - ["value"]=> - int(3) -} -]]> - - - - - - - diff --git a/reference/ds/ds/map/map.xml b/reference/ds/ds/map/map.xml deleted file mode 100644 index e49cfb5f63..0000000000 --- a/reference/ds/ds/map/map.xml +++ /dev/null @@ -1,147 +0,0 @@ - - - - - - Ds\Map::map - Devuelve el resultado de la aplicación de una retrollamada a cada valor - - - - &reftitle.description; - - public Ds\MapDs\Map::map - callablecallback - - - Devuelve el resultado de la aplicación de un callback a - cada valor del mapa. - - - - - &reftitle.parameters; - - - callback - - - - mixed - callback - mixedkey - mixedvalue - - - - Un callable a aplicar a cada valor del mapa. - - - - La retrollamada debe devolver aquello a lo que la clave será mappada - en el mapa resultante. - - - - - - - - - &reftitle.returnvalues; - - El resultado de la aplicación de un callback a cada valor del - mapa. - - - - Las claves y los valores de la instancia actual no serán afectados. - - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Map::map</function> - - 1, "b" => 2, "c" => 3]); - -print_r($map->map(function($key, $value) { return $value * 2; })); -print_r($map); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => a - [value] => 2 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 4 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 6 - ) - -) -Ds\Map Object -( - [0] => Ds\Pair Object - ( - [key] => a - [value] => 1 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 3 - ) - -) -]]> - - - - - - - diff --git a/reference/ds/ds/map/merge.xml b/reference/ds/ds/map/merge.xml deleted file mode 100644 index d412054bc8..0000000000 --- a/reference/ds/ds/map/merge.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - Ds\Map::merge - Devuelve el resultado de la adición de todas las asociaciones dadas - - - - &reftitle.description; - - public Ds\MapDs\Map::merge - mixedvalues - - - Devuelve el resultado de la adición de todas las asociaciones de un objeto traversable - dado o de un &array; con sus valores correspondientes, combinados con la instancia actual. - - - - - Los valores de la instancia actual serán sobrescritos por los proporcionados cuando las claves sean iguales. - - - - - - - &reftitle.parameters; - - - values - - - Un objeto traversable o un &array;. - - - - - - - - &reftitle.returnvalues; - - El resultado de la asociación de todas las claves de un objeto traversable - dado o de un &array; con sus valores correspondientes, combinados con la instancia actual. - - - - La instancia actual no será afectada. - - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Map::merge</function> - - 1, "b" => 2, "c" => 3]); - -print_r($map->merge(["a" => 10, "e" => 50])); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => a - [value] => 10 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 3 - ) - - [3] => Ds\Pair Object - ( - [key] => e - [value] => 50 - ) - -) -]]> - - - - - - - diff --git a/reference/ds/ds/map/pairs.xml b/reference/ds/ds/map/pairs.xml deleted file mode 100644 index 1c3bd641e9..0000000000 --- a/reference/ds/ds/map/pairs.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - Ds\Map::pairs - Devuelve una secuencia que contiene todas las parejas del mapa - - - - &reftitle.description; - - public Ds\SequenceDs\Map::pairs - - - - Devuelve una Ds\Sequence que contiene todas las parejas del mapa. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Ds\Sequence que contiene todas las parejas del mapa. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Map::pairs</function> - - 1, "b" => 2, "c" => 3]); - -var_dump($map->pairs()); -?> -]]> - - &example.outputs.similar; - - - object(Ds\Pair)#5 (2) { - ["key"]=> - string(1) "a" - ["value"]=> - int(1) - } - [1]=> - object(Ds\Pair)#6 (2) { - ["key"]=> - string(1) "b" - ["value"]=> - int(2) - } - [2]=> - object(Ds\Pair)#7 (2) { - ["key"]=> - string(1) "c" - ["value"]=> - int(3) - } -} -]]> - - - - - - - diff --git a/reference/ds/ds/map/put.xml b/reference/ds/ds/map/put.xml deleted file mode 100644 index 443966d43e..0000000000 --- a/reference/ds/ds/map/put.xml +++ /dev/null @@ -1,255 +0,0 @@ - - - - - - Ds\Map::put - Asocia una clave a un valor - - - - &reftitle.description; - - public voidDs\Map::put - mixedkey - mixedvalue - - - Asocia una clave a un valor, - sobrescribiendo una asociación previa si existe. - - - - - Las claves de tipo object son soportadas. - - Si un objeto implementa Ds\Hashable, - la igualdad será determinada por la función equals del objeto. - - Si un objeto no implementa Ds\Hashable, - los objetos deben ser referencias a la misma instancia para ser considerados iguales. - - - - - - Asimismo, se puede utilizar la sintaxis de array para asociar valores por clave, por ejemplo $map["clave"] = $valor. - - - - - - Atención al uso de la sintaxis de array. Las claves escalares serán coercionadas a - enteros por el motor. Por ejemplo, $map["1"] intentará acceder a - int(1), mientras que $map->get("1") - buscará correctamente la clave de string. - - - Ver arrays. - - - - - - - &reftitle.parameters; - - - key - - - La clave a asociar al valor. - - - - - value - - - El valor a asociar a la clave. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Map::put</function> - -put("a", 1); -$map->put("b", 2); -$map->put("c", 3); - -print_r($map); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => a - [value] => 1 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 3 - ) - -) -]]> - - - - Ejemplo de <function>Ds\Map::put</function> utilizando objetos como clave - -value = $value; - } - - public function hash() - { - return $this->value; - } - - public function equals($obj): bool - { - return $this->value === $obj->value; - } -} - -$map = new \Ds\Map(); - -$obj = new \ArrayIterator([]); - -// Utilizar la misma instancia varias veces sobrescribirá el valor anterior. -$map->put($obj, 1); -$map->put($obj, 2); - -// Utilizar varias instancias del mismo objeto creará nuevas asociaciones. -$map->put(new \stdClass(), 3); -$map->put(new \stdClass(), 4); - -// Utilizar varias instancias de objetos iguales sobrescribirá los valores anteriores. -$map->put(new \HashableObject(1), 5); -$map->put(new \HashableObject(1), 6); -$map->put(new \HashableObject(2), 7); -$map->put(new \HashableObject(2), 8); - -var_dump($map); -?> -]]> - - &example.outputs.similar; - - - object(Ds\Pair)#7 (2) { - ["key"]=> - object(ArrayIterator)#2 (1) { - ["storage":"ArrayIterator":private]=> - array(0) { - } - } - ["value"]=> - int(2) - } - [1]=> - object(Ds\Pair)#8 (2) { - ["key"]=> - object(stdClass)#3 (0) { - } - ["value"]=> - int(3) - } - [2]=> - object(Ds\Pair)#9 (2) { - ["key"]=> - object(stdClass)#4 (0) { - } - ["value"]=> - int(4) - } - [3]=> - object(Ds\Pair)#10 (2) { - ["key"]=> - object(HashableObject)#5 (1) { - ["value":"HashableObject":private]=> - int(1) - } - ["value"]=> - int(6) - } - [4]=> - object(Ds\Pair)#11 (2) { - ["key"]=> - object(HashableObject)#6 (1) { - ["value":"HashableObject":private]=> - int(2) - } - ["value"]=> - int(8) - } -} -]]> - - - - - - - diff --git a/reference/ds/ds/map/putAll.xml b/reference/ds/ds/map/putAll.xml deleted file mode 100644 index 0155185d89..0000000000 --- a/reference/ds/ds/map/putAll.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - Ds\Map::putAll - Asocia todas las parejas clave-valor de un objeto traversable o de un array - - - - &reftitle.description; - - public voidDs\Map::putAll - mixedpairs - - - Asocia todas las pairs clave-valor de un objeto traversable o de un &array;. - - - - - Las claves de tipo object son soportadas. - - Si un objeto implementa Ds\Hashable, - la igualdad será determinada por la función equals del objeto. - - Si un objeto no implementa Ds\Hashable, - los objetos deben ser referencias a la misma instancia para ser considerados iguales. - - - - - - - &reftitle.parameters; - - - pairs - - - Un objeto traversable o &array;. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Map::putAll</function> - -putAll([ - "a" => 1, - "b" => 2, - "c" => 3, -]); - -print_r($map); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => a - [value] => 1 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 3 - ) - -) -]]> - - - - - - - - diff --git a/reference/ds/ds/map/reduce.xml b/reference/ds/ds/map/reduce.xml deleted file mode 100644 index e7f8caa39f..0000000000 --- a/reference/ds/ds/map/reduce.xml +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - Ds\Map::reduce - Reduce el mapa a un solo valor utilizando una retrollamada - - - - &reftitle.description; - - public mixedDs\Map::reduce - callablecallback - mixedinitial - - - Reduce el mapa a un solo valor utilizando una retrollamada. - - - - - - &reftitle.parameters; - - - callback - - - - mixedcallback - mixedcarry - mixedkey - mixedvalue - - - - carry - - - El valor de retorno de la retrollamada anterior, o initial si - es la primera iteración. - - - - - key - - - La clave de la iteración actual. - - - - - value - - - El valor de la iteración actual. - - - - - - - - - initial - - - El valor inicial del valor de retorno. Puede ser &null;. - - - - - - - - &reftitle.returnvalues; - - El valor de retorno de la retrollamada final. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Map::reduce</function> con valor inicial - - 1, "b" => 2, "c" => 3]); - -$callback = function($carry, $key, $value) { - return $carry * $value; -}; - -var_dump($map->reduce($callback, 5)); - -// Iteraciones: -// -// $carry = $initial = 5 -// -// $carry = $carry * 1 = 5 -// $carry = $carry * 2 = 10 -// $carry = $carry * 3 = 30 -?> -]]> - - &example.outputs.similar; - - - - - - Ejemplo de <function>Ds\Map::reduce</function> sin valor inicial - - 1, "b" => 2, "c" => 3]); - -var_dump($map->reduce(function($carry, $key, $value) { - return $carry + $value + 5; -})); - -// Iteraciones: -// -// $carry = $initial = null -// -// $carry = $carry + 1 + 5 = 6 -// $carry = $carry + 2 + 5 = 13 -// $carry = $carry + 3 + 5 = 21 -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/map/remove.xml b/reference/ds/ds/map/remove.xml deleted file mode 100644 index d3c05ae278..0000000000 --- a/reference/ds/ds/map/remove.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - Ds\Map::remove - Elimina y devuelve un valor por clave - - - - &reftitle.description; - - public mixedDs\Map::remove - mixedkey - mixeddefault - - - Elimina y devuelve un valor por clave, o devuelve un valor por defecto opcional si la clave - no ha podido ser encontrada. - - - - - Las claves de tipo object son soportadas. - - Si un objeto implementa Ds\Hashable, - la igualdad será determinada por la función equals del objeto. - - Si un objeto no implementa Ds\Hashable, - los objetos deben ser referencias a la misma instancia para ser considerados iguales. - - - - - - Asimismo, se puede utilizar la sintaxis de array para acceder a los valores por clave, por ejemplo $map["clé"]. - - - - - - Atención al uso de la sintaxis de array. Las claves escalares serán forzadas a - enteros por el motor. Por ejemplo, $map["1"] intentará acceder a - int(1), mientras que $map->get("1") - buscará correctamente la clave de string. - - - Ver arrays. - - - - - - - &reftitle.parameters; - - - key - - - La clave a eliminar. - - - - - default - - - El valor por defecto opcional, devuelto si la clave no ha podido ser encontrada. - - - - - - - - &reftitle.returnvalues; - - El valor que ha sido eliminado, o el default - valor si ha sido proporcionado y la key no ha podido ser encontrada en el mapa. - - - - - &reftitle.errors; - - OutOfBoundsException si la clave no ha sido encontrada - y ningún valor por defecto ha sido proporcionado. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Map::remove</function> - - 1, "b" => 2, "c" => 3]); - -var_dump($map->remove("a")); // 1 -var_dump($map->remove("e", 10)); // 10 (uso del valor por defecto) -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/map/reverse.xml b/reference/ds/ds/map/reverse.xml deleted file mode 100644 index 771fd5bf40..0000000000 --- a/reference/ds/ds/map/reverse.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Ds\Map::reverse - - Invierte el mapa en su lugar - - - - - &reftitle.description; - - public voidDs\Map::reverse - - - - Invierte el mapa en su lugar. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Map::reverse</function> - - 1, "b" => 2, "c" => 3]); -$map->reverse(); - -print_r($map); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => c - [value] => 3 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => a - [value] => 1 - ) - -) -]]> - - - - - - - diff --git a/reference/ds/ds/map/reversed.xml b/reference/ds/ds/map/reversed.xml deleted file mode 100644 index 5759286ac2..0000000000 --- a/reference/ds/ds/map/reversed.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Ds\Map::reversed - Devuelve una copia invertida - - - - &reftitle.description; - - public Ds\MapDs\Map::reversed - - - - Devuelve una copia invertida del mapa. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Una copia invertida del mapa. - - - - La instancia actual no se ve afectada. - - - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Map::reversed</function> - - 1, "b" => 2, "c" => 3]); - -print_r($map->reversed()); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => c - [value] => 3 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => a - [value] => 1 - ) - -) -]]> - - - - - - - diff --git a/reference/ds/ds/map/skip.xml b/reference/ds/ds/map/skip.xml deleted file mode 100644 index d6bcce0339..0000000000 --- a/reference/ds/ds/map/skip.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - Ds\Map::skip - Devuelve el par a un índice de posición dado - - - - &reftitle.description; - - public Ds\PairDs\Map::skip - intposition - - - Devuelve el par a un índice dado basado en cero position. - - - - - - &reftitle.parameters; - - - position - - - El índice de posición basado en cero a devolver. - - - - - - - - &reftitle.returnvalues; - - Devuelve el Ds\Pair a la position dada. - - - - - &reftitle.errors; - - OutOfRangeException si la posición no es válida. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Map::skip</function> - - 1, "b" => 2, "c" => 3]); - -var_dump($map->skip(1)); -?> -]]> - - &example.outputs.similar; - - - string(1) "b" - ["value"]=> - int(2) -} -]]> - - - - - - - diff --git a/reference/ds/ds/map/slice.xml b/reference/ds/ds/map/slice.xml deleted file mode 100644 index 2e75f048bd..0000000000 --- a/reference/ds/ds/map/slice.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - Ds\Map::slice - - Devuelve un subconjunto del mapa definido por un índice de inicio y una longitud - - - - - &reftitle.description; - - public Ds\MapDs\Map::slice - intindex - intlength - - - Devuelve un subconjunto del mapa definido por un index de inicio y una longitud length. - - - - - - &reftitle.parameters; - - - index - - - El índice desde el cual comienza el rango. - - - Si es positivo, el rango comenzará en este índice en el mapa. - Si es negativo, el rango comenzará a esta distancia del final. - - - - - length - - - Si se da una longitud y es positiva, el mapa resultante - tendrá hasta tantas parejas. - - Si se da una longitud y es negativa, el rango - terminará a tantas parejas del final. - - Si la longitud provoca un desbordamiento, solo - las parejas hasta el final del mapa serán incluidas. - - Si no se proporciona una longitud, el mapa resultante - contendrá todas las parejas entre el índice y el final del mapa. - - - - - - - - &reftitle.returnvalues; - - Un subconjunto del mapa definido por un índice de inicio y una longitud. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Map::slice</function> - - 1, "b" => 2, "c" => 3, "d" => 4, "e" => 5]); - -// Slice desde 2 en adelante -print_r($map->slice(2)->toArray()); - -// Slice desde 1, con una longitud de 3 -print_r($map->slice(1, 3)->toArray()); - -// Slice desde 1 en adelante -print_r($map->slice(1)->toArray()); - -// Slice desde 2 desde el final en adelante -print_r($map->slice(-2)->toArray()); - -// Slice desde 1 hasta 1 desde el final -print_r($map->slice(1, -1)->toArray()); -?> -]]> - - &example.outputs.similar; - - 3 - [d] => 4 - [e] => 5 -) -Array -( - [b] => 2 - [c] => 3 - [d] => 4 -) -Array -( - [b] => 2 - [c] => 3 - [d] => 4 - [e] => 5 -) -Array -( - [d] => 4 - [e] => 5 -) -Array -( - [b] => 2 - [c] => 3 - [d] => 4 -) -]]> - - - - - - - diff --git a/reference/ds/ds/map/sort.xml b/reference/ds/ds/map/sort.xml deleted file mode 100644 index f56bc0637e..0000000000 --- a/reference/ds/ds/map/sort.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - Ds\Map::sort - - Ordena el mapa en el lugar por valor - - - - - &reftitle.description; - - public voidDs\Map::sort - callablecomparator - - - Ordena el mapa en el lugar por valor, utilizando una función comparator opcional. - - - - - - &reftitle.parameters; - - - comparator - - &sort.callback.description; - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Map::sort</function> - - 2, "b" => 3, "c" => 1]); -$map->sort(); - -print_r($map); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => c - [value] => 1 - ) - - [1] => Ds\Pair Object - ( - [key] => a - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => b - [value] => 3 - ) - -) -]]> - - - - Ejemplo de <function>Ds\Map::sort</function> utilizando un comparador - - 2, "b" => 3, "c" => 1]); - -$map->sort(function($a, $b) { - return $b <=> $a; -}); - -print_r($map); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => b - [value] => 3 - ) - - [1] => Ds\Pair Object - ( - [key] => a - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 1 - ) - -) -]]> - - - - - - - - diff --git a/reference/ds/ds/map/sorted.xml b/reference/ds/ds/map/sorted.xml deleted file mode 100644 index e91837267b..0000000000 --- a/reference/ds/ds/map/sorted.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - Ds\Map::sorted - Devuelve una copia, ordenada por valor - - - - &reftitle.description; - - public Ds\MapDs\Map::sorted - callablecomparator - - - Devuelve una copia, ordenada por valor utilizando una función comparator opcional. - - - - - - &reftitle.parameters; - - - comparator - - &sort.callback.description; - - - - - - - &reftitle.returnvalues; - - Devuelve una copia del mapa, ordenada por valor. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Map::sort</function> - - 2, "b" => 3, "c" => 1]); - -print_r($map->sorted()); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => c - [value] => 1 - ) - - [1] => Ds\Pair Object - ( - [key] => a - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => b - [value] => 3 - ) - -) -]]> - - - - Ejemplo de <function>Ds\Map::sort</function> utilizando un comparador - - 2, "b" => 3, "c" => 1]); - -// Invertir -$sorted = $map->sorted(function($a, $b) { - return $b <=> $a; -}); - -print_r($sorted); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => b - [value] => 3 - ) - - [1] => Ds\Pair Object - ( - [key] => a - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 1 - ) - -) -]]> - - - - - - - - diff --git a/reference/ds/ds/map/sum.xml b/reference/ds/ds/map/sum.xml deleted file mode 100644 index 831dd76308..0000000000 --- a/reference/ds/ds/map/sum.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - Ds\Map::sum - Devuelve la suma de todos los valores del mapa - - - - &reftitle.description; - - public intfloatDs\Map::sum - - - - Devuelve la suma de todos los valores del mapa. - - - - Los arrays y los objetos se consideran iguales a cero en el cálculo de la suma. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La suma de todos los valores del mapa como float o int - dependiendo de los valores del mapa. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Map::sum</function> con enteros - - 1, "b" => 2, "c" => 3]); -var_dump($map->sum()); -?> -]]> - - &example.outputs.similar; - - - - - - Ejemplo de <function>Ds\Map::sum</function> con números de punto flotante - - 1, "b" => 2.5, "c" => 3]); -var_dump($map->sum()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/map/toarray.xml b/reference/ds/ds/map/toarray.xml deleted file mode 100644 index a6ac25bed2..0000000000 --- a/reference/ds/ds/map/toarray.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - Ds\Map::toArray - - Convierte el mapa en un &array; - - - - - &reftitle.description; - - public arrayDs\Map::toArray - - - - Convierte el mapa en un &array;. - - - - Los mapas con claves no escalares no pueden ser convertidos en &array;. - - - - - Un &array; tratará todas las claves numéricas como enteros, - por ejemplo "1" y 1 como claves en el mapa - resultará solo en 1 siendo incluido en el array. - - - - - La conversión en &array; aún no es soportada. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un &array; conteniendo todos los valores en el mismo orden que el mapa. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Map::toArray</function> - - 1, - "b" => 2, - "c" => 3, -]); - -var_dump($map->toArray()); -?> -]]> - - &example.outputs.similar; - - - int(1) - ["b"]=> - int(2) - ["c"]=> - int(3) -} -]]> - - - - - - - diff --git a/reference/ds/ds/map/union.xml b/reference/ds/ds/map/union.xml deleted file mode 100644 index c4965a9f41..0000000000 --- a/reference/ds/ds/map/union.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - Ds\Map::union - Crear un nuevo mapa utilizando los valores de la instancia actual y de otro mapa - - - - &reftitle.description; - - public Ds\MapDs\Map::union - Ds\Mapmap - - - Crear un nuevo mapa que contiene los pares de la instancia actual así como los pares de otro map. - - - A ∪ B = {x: x ∈ A ∨ x ∈ B} - - - - - Los valores de la instancia actual serán sobrescritos por aquellos proporcionados cuando las claves sean iguales. - - - - - - - &reftitle.parameters; - - - map - - - El otro mapa, a combinar con la instancia actual. - - - - - - - - &reftitle.returnvalues; - - Un nuevo mapa que contiene todos los pares de la instancia actual así como de otro map. - - - - - &reftitle.seealso; - - - Unión en Wikipedia - - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Map::union</function> - - 1, "b" => 2, "c" => 3]); -$b = new \Ds\Map(["b" => 3, "c" => 4, "d" => 5]); - -print_r($a->union($b)); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => a - [value] => 1 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 3 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 4 - ) - - [3] => Ds\Pair Object - ( - [key] => d - [value] => 5 - ) - -) -]]> - - - - - - - diff --git a/reference/ds/ds/map/values.xml b/reference/ds/ds/map/values.xml deleted file mode 100644 index 3b628f0cc5..0000000000 --- a/reference/ds/ds/map/values.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Ds\Map::values - Devuelve una secuencia de los valores del mapa - - - - &reftitle.description; - - public Ds\SequenceDs\Map::values - - - - Devuelve una secuencia que contiene todos los valores del mapa, en el mismo orden. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Una Ds\Sequence que contiene todos los valores del mapa. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Map::values</function> - - 1, "b" => 2, "c" => 3]); -var_dump($map->values()); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - diff --git a/reference/ds/ds/map/xor.xml b/reference/ds/ds/map/xor.xml deleted file mode 100644 index 42b582115e..0000000000 --- a/reference/ds/ds/map/xor.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - Ds\Map::xor - Crear un nuevo mapa utilizando las claves de la instancia actual o de otro mapa, pero no de ambos - - - - &reftitle.description; - - public Ds\MapDs\Map::xor - Ds\Mapmap - - - Crear un nuevo mapa que contiene las claves de la instancia actual así como de otro map, - pero no de ambos. - - - A ⊖ B = {x : x ∈ (A \ B) ∪ (B \ A)} - - - - - &reftitle.parameters; - - - map - - - El otro mapa. - - - - - - - - &reftitle.returnvalues; - - Un nuevo mapa que contiene las claves de la instancia actual así como de otro map, - pero no de ambos. - - - - - &reftitle.seealso; - - - Diferencia simétrica en Wikipedia - - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Map::xor</function> - - 1, "b" => 2, "c" => 3]); -$b = new \Ds\Map(["b" => 4, "c" => 5, "d" => 6]); - -print_r($a->xor($b)); -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => a - [value] => 1 - ) - - [1] => Ds\Pair Object - ( - [key] => d - [value] => 6 - ) - -) -]]> - - - - - - - diff --git a/reference/ds/ds/pair/clear.xml b/reference/ds/ds/pair/clear.xml deleted file mode 100644 index 546986c7d0..0000000000 --- a/reference/ds/ds/pair/clear.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Ds\Pair::clear - Elimina todos los valores - - - - &reftitle.description; - - public voidDs\Pair::clear - - - - Elimina todos los valores del par. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Pair::clear</function> - -clear(); -print_r($pair); -?> -]]> - - &example.outputs.similar; - - a - [value] => 1 -) -Ds\Pair Object -( -) -]]> - - - - - - - diff --git a/reference/ds/ds/pair/construct.xml b/reference/ds/ds/pair/construct.xml deleted file mode 100644 index 91fe63d4cf..0000000000 --- a/reference/ds/ds/pair/construct.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - Ds\Pair::__construct - Crear una nueva instancia - - - - &reftitle.description; - - public Ds\Pair::__construct - mixedkey - mixedvalue - - - Crear una nueva instancia utilizando una clave y un valor dados. - - - - - - &reftitle.parameters; - - - key - - - La clave. - - - - - value - - - El valor. - - - - - - - - - - - diff --git a/reference/ds/ds/pair/copy.xml b/reference/ds/ds/pair/copy.xml deleted file mode 100644 index 4dca83b816..0000000000 --- a/reference/ds/ds/pair/copy.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Ds\Pair::copy - Devuelve una copia superficial del par - - - - &reftitle.description; - - public Ds\PairDs\Pair::copy - - - - Devuelve una copia superficial del par. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una copia superficial del par. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Pair::copy</function> - -copy(); - -$a->key = "x"; - -print_r($a); -print_r($b); -?> -]]> - - &example.outputs.similar; - - x - [value] => 1 -) -Ds\Pair Object -( - [key] => a - [value] => 1 -) -]]> - - - - - - - diff --git a/reference/ds/ds/pair/isempty.xml b/reference/ds/ds/pair/isempty.xml deleted file mode 100644 index e34164debd..0000000000 --- a/reference/ds/ds/pair/isempty.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Ds\Pair::isEmpty - Indica si la pareja está vacía - - - - &reftitle.description; - - public boolDs\Pair::isEmpty - - - - Indica si la pareja está vacía. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si la pareja está vacía, de lo contrario &false;. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Pair::isEmpty</function> - -isEmpty()); -var_dump($b->isEmpty()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/pair/jsonserialize.xml b/reference/ds/ds/pair/jsonserialize.xml deleted file mode 100644 index e7bc6e9852..0000000000 --- a/reference/ds/ds/pair/jsonserialize.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - Ds\Pair::jsonSerialize - Devuelve una representación que puede ser convertida en JSON - - - - &reftitle.description; - - Ver JsonSerializable::jsonSerialize - - - - No debería ser necesario llamar a esto directamente. - - - - - - - diff --git a/reference/ds/ds/pair/toarray.xml b/reference/ds/ds/pair/toarray.xml deleted file mode 100644 index 745af1a175..0000000000 --- a/reference/ds/ds/pair/toarray.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Ds\Pair::toArray - - Convierte la pareja en un &array; - - - - - &reftitle.description; - - public arrayDs\Pair::toArray - - - - Convierte la pareja en un &array;. - - - - La conversión en &array; aún no es soportada. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un &array; que contiene todos los valores en el mismo orden que la pareja. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Pair::toArray</function> - -toArray()); -?> -]]> - - &example.outputs.similar; - - - string(1) "a" - ["value"]=> - int(1) -} -]]> - - - - - - - diff --git a/reference/ds/ds/priorityqueue/allocate.xml b/reference/ds/ds/priorityqueue/allocate.xml deleted file mode 100644 index 9862b043e5..0000000000 --- a/reference/ds/ds/priorityqueue/allocate.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Ds\PriorityQueue::allocate - Asigna suficiente memoria para una capacidad requerida - - - - &reftitle.description; - - public voidDs\PriorityQueue::allocate - intcapacity - - - Asegura que se asigne suficiente memoria para una capacidad requerida. - Esto elimina la necesidad de reasignar el búfer interno a medida que se añaden valores. - - - - - &reftitle.parameters; - - - capacity - - - El número de valores para los cuales se debe asignar la capacidad. - - - - La capacidad permanecerá igual si este valor es inferior o igual a la - capacidad actual. - - - - - La capacidad siempre se redondeará a la potencia de 2 más cercana. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\PriorityQueue::allocate</function> - -capacity()); - -$queue->allocate(100); -var_dump($queue->capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/priorityqueue/capacity.xml b/reference/ds/ds/priorityqueue/capacity.xml deleted file mode 100644 index a256ceff9a..0000000000 --- a/reference/ds/ds/priorityqueue/capacity.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - Ds\PriorityQueue::capacity - Devuelve la capacidad actual - - - - &reftitle.description; - - public intDs\PriorityQueue::capacity - - - - Devuelve la capacidad actual. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La capacidad actual. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\PriorityQueue::capacity</function> - -capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/priorityqueue/clear.xml b/reference/ds/ds/priorityqueue/clear.xml deleted file mode 100644 index 75d48bf6d1..0000000000 --- a/reference/ds/ds/priorityqueue/clear.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Ds\PriorityQueue::clear - Elimina todos los valores - - - - &reftitle.description; - - public voidDs\PriorityQueue::clear - - - - Elimina todos los valores de la cola. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\PriorityQueue::clear</function> - -push("a", 5); -$queue->push("b", 15); -$queue->push("c", 10); - -$queue->clear(); -print_r($queue); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/priorityqueue/construct.xml b/reference/ds/ds/priorityqueue/construct.xml deleted file mode 100644 index bb4f8088c7..0000000000 --- a/reference/ds/ds/priorityqueue/construct.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Ds\PriorityQueue::__construct - Crear una nueva instancia - - - - &reftitle.description; - - public Ds\PriorityQueue::__construct - - - - Crear una nueva instancia. - - - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\PriorityQueue::__construct</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/priorityqueue/copy.xml b/reference/ds/ds/priorityqueue/copy.xml deleted file mode 100644 index fb5ae29e15..0000000000 --- a/reference/ds/ds/priorityqueue/copy.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Ds\PriorityQueue::copy - Devuelve una copia superficial de la cola - - - - &reftitle.description; - - public Ds\PriorityQueueDs\PriorityQueue::copy - - - - Devuelve una copia superficial de la cola. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una copia superficial de la cola. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\PriorityQueue::copy</function> - -push("a", 5); -$queue->push("b", 15); -$queue->push("c", 10); - -print_r($queue->copy()); -?> -]]> - - &example.outputs.similar; - - b - [1] => c - [2] => a -) -]]> - - - - - - - diff --git a/reference/ds/ds/priorityqueue/count.xml b/reference/ds/ds/priorityqueue/count.xml deleted file mode 100644 index 8a64d9fbf4..0000000000 --- a/reference/ds/ds/priorityqueue/count.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - Ds\PriorityQueue::count - Devuelve el número de valores en la cola - - - - &reftitle.description; - - Ver Countable::count - - - - - diff --git a/reference/ds/ds/priorityqueue/isempty.xml b/reference/ds/ds/priorityqueue/isempty.xml deleted file mode 100644 index 304e97afd2..0000000000 --- a/reference/ds/ds/priorityqueue/isempty.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Ds\PriorityQueue::isEmpty - Indica si la cola está vacía - - - - &reftitle.description; - - public boolDs\PriorityQueue::isEmpty - - - - Indica si la cola está vacía. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si la cola está vacía, de lo contrario &false;. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\PriorityQueue::isEmpty</function> - -push("a", 5); -$a->push("b", 15); -$a->push("c", 10); - -var_dump($a->isEmpty()); -var_dump($b->isEmpty()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/priorityqueue/jsonserialize.xml b/reference/ds/ds/priorityqueue/jsonserialize.xml deleted file mode 100644 index 442bd1e791..0000000000 --- a/reference/ds/ds/priorityqueue/jsonserialize.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - Ds\PriorityQueue::jsonSerialize - Devuelve una representación que puede ser convertida en JSON - - - - &reftitle.description; - - Ver JsonSerializable::jsonSerialize - - - - Nunca debería ser necesario llamar a esto directamente. - - - - - - diff --git a/reference/ds/ds/priorityqueue/peek.xml b/reference/ds/ds/priorityqueue/peek.xml deleted file mode 100644 index 2ffaae781d..0000000000 --- a/reference/ds/ds/priorityqueue/peek.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Ds\PriorityQueue::peek - Devuelve el valor al frente de la cola - - - - &reftitle.description; - - public mixedDs\PriorityQueue::peek - - - - Devuelve el valor al frente de la cola, pero no lo elimina. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el valor al frente de la cola. - - - - - &reftitle.errors; - - UnderflowException si está vacía. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\PriorityQueue::peek</function> - -push("a", 5); -$queue->push("b", 15); -$queue->push("c", 10); - -var_dump($queue->peek()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/priorityqueue/pop.xml b/reference/ds/ds/priorityqueue/pop.xml deleted file mode 100644 index a3c2275c40..0000000000 --- a/reference/ds/ds/priorityqueue/pop.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - Ds\PriorityQueue::pop - Elimina y devuelve el valor con la prioridad más alta - - - - &reftitle.description; - - public mixedDs\PriorityQueue::pop - - - - Elimina y devuelve el valor al frente de la cola, es decir, el valor - con la prioridad más alta. - - - - Los valores con prioridad igual se tratan en FIFO (primero en entrar, primero en salir). - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El valor eliminado que estaba al frente de la cola. - - - - - &reftitle.errors; - - UnderflowException si está vacío. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\PriorityQueue::pop</function> - -push("a", 5); -$queue->push("b", 15); -$queue->push("c", 10); - -print_r($queue->pop()); -print_r($queue->pop()); -print_r($queue->pop()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/priorityqueue/push.xml b/reference/ds/ds/priorityqueue/push.xml deleted file mode 100644 index 179f1c50a9..0000000000 --- a/reference/ds/ds/priorityqueue/push.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Ds\PriorityQueue::push - Añade valores a la cola - - - - &reftitle.description; - - public voidDs\PriorityQueue::push - mixedvalue - intpriority - - - Añade un value con una priority dada a la cola. - - - - - - &reftitle.parameters; - - - value - - - El valor a añadir a la cola. - - - - - priority - - - La prioridad asociada al valor. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\PriorityQueue::push</function> - -push("a", 5); -$queue->push("b", 15); -$queue->push("c", 10); - -print_r($queue->pop()); -print_r($queue->pop()); -print_r($queue->pop()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/priorityqueue/toarray.xml b/reference/ds/ds/priorityqueue/toarray.xml deleted file mode 100644 index 190ae95989..0000000000 --- a/reference/ds/ds/priorityqueue/toarray.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Ds\PriorityQueue::toArray - - Convierte la cola en un &array;. - - - - - &reftitle.description; - - public arrayDs\PriorityQueue::toArray - - - - Convierte la cola en un &array;. - - - - Este método no es destructivo. - - - - - La conversión en un &array; aún no es soportada. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un &array; que contiene todos los valores en el mismo orden que la cola. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\PriorityQueue::toArray</function> - -push("a", 5); -$queue->push("b", 15); -$queue->push("c", 10); - -var_dump($queue->toArray()); -?> -]]> - - &example.outputs.similar; - - - string(1) "b" - [1]=> - string(1) "c" - [2]=> - string(1) "a" -} -]]> - - - - - - - diff --git a/reference/ds/ds/queue/allocate.xml b/reference/ds/ds/queue/allocate.xml deleted file mode 100644 index 106c58a3e7..0000000000 --- a/reference/ds/ds/queue/allocate.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - Ds\Queue::allocate - Asigna suficiente memoria para una capacidad requerida - - - - &reftitle.description; - - public voidDs\Queue::allocate - intcapacity - - - Asegura que se asigne suficiente memoria para una capacidad requerida. - Esto elimina la necesidad de reasignar el búfer interno a medida que se añaden valores. - - - - La capacidad siempre se redondeará a la potencia de 2 más cercana. - - - - - - &reftitle.parameters; - - - capacity - - - El número de valores para los cuales se debe asignar la capacidad. - - - - La capacidad permanecerá igual si este valor es inferior o igual a la - capacidad actual. - - - - - La capacidad siempre se redondeará a la potencia de 2 más cercana. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Queue::allocate</function> - -capacity()); - -$queue->allocate(100); -var_dump($queue->capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/queue/capacity.xml b/reference/ds/ds/queue/capacity.xml deleted file mode 100644 index 4a8c57a23b..0000000000 --- a/reference/ds/ds/queue/capacity.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Ds\Queue::capacity - Devuelve la capacidad actual - - - - &reftitle.description; - - public intDs\Queue::capacity - - - - Devuelve la capacidad actual. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La capacidad actual. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Queue::capacity</function> - -capacity()); - -$queue->push(...range(1, 50)); -var_dump($queue->capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/queue/clear.xml b/reference/ds/ds/queue/clear.xml deleted file mode 100644 index 42f562bc0a..0000000000 --- a/reference/ds/ds/queue/clear.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Ds\Queue::clear - Elimina todos los valores - - - - &reftitle.description; - - public voidDs\Queue::clear - - - - Elimina todos los valores de la cola. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Queue::clear</function> - -clear(); -print_r($queue); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 -) -Ds\Queue Object -( -) -]]> - - - - - - - diff --git a/reference/ds/ds/queue/construct.xml b/reference/ds/ds/queue/construct.xml deleted file mode 100644 index 7cf8e4913c..0000000000 --- a/reference/ds/ds/queue/construct.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Ds\Queue::__construct - Crear una nueva instancia - - - - &reftitle.description; - - public Ds\Queue::__construct - mixedvalues - - - Crear una nueva instancia utilizando un objeto traversable - o un &array; para los values iniciales. - - - - - &reftitle.parameters; - - - values - - - Un objeto traversable o un &array; para los valores iniciales. - - - - - - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Queue::__construct</function> - - -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - diff --git a/reference/ds/ds/queue/copy.xml b/reference/ds/ds/queue/copy.xml deleted file mode 100644 index 3635d4f325..0000000000 --- a/reference/ds/ds/queue/copy.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - Ds\Queue::copy - Devuelve una copia superficial de la cola - - - - &reftitle.description; - - public Ds\QueueDs\Queue::copy - - - - Devuelve una copia superficial de la cola. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una copia superficial de la cola. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Queue::copy</function> - -copy(); - -// Cambiar la copia no afecta al original -$b->push(4); - -print_r($a); -print_r($b); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 -) -Ds\Queue Object -( - [0] => 1 - [1] => 2 - [2] => 3 - [3] => 4 -) -]]> - - - - - - - diff --git a/reference/ds/ds/queue/count.xml b/reference/ds/ds/queue/count.xml deleted file mode 100644 index 281c30ee94..0000000000 --- a/reference/ds/ds/queue/count.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - - Ds\Queue::count - Devuelve el número de valores en la cola - - - - &reftitle.description; - - Ver Countable::count - - - - - - diff --git a/reference/ds/ds/queue/isempty.xml b/reference/ds/ds/queue/isempty.xml deleted file mode 100644 index af1b68639a..0000000000 --- a/reference/ds/ds/queue/isempty.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Ds\Queue::isEmpty - Indica si la cola está vacía - - - - &reftitle.description; - - public boolDs\Queue::isEmpty - - - - Indica si la cola está vacía. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si la cola está vacía, de lo contrario &false;. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Queue::isEmpty</function> - -isEmpty()); -var_dump($b->isEmpty()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/queue/jsonserialize.xml b/reference/ds/ds/queue/jsonserialize.xml deleted file mode 100644 index a356fb0e02..0000000000 --- a/reference/ds/ds/queue/jsonserialize.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - - - - Ds\Queue::jsonSerialize - Regresa una representacion que puede ser convertida a JSON - - - - &reftitle.description; - - Veáse JsonSerializable::jsonSerialize - - - - Nunca debería necesitar llamar esta función directamente. - - - - - - - diff --git a/reference/ds/ds/queue/peek.xml b/reference/ds/ds/queue/peek.xml deleted file mode 100644 index 2705c64c1f..0000000000 --- a/reference/ds/ds/queue/peek.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Ds\Queue::peek - Devuelve el valor al frente de la cola - - - - &reftitle.description; - - public mixedDs\Queue::peek - - - - Devuelve el valor al frente de la cola, pero no lo elimina. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el valor al frente de la cola. - - - - - &reftitle.errors; - - UnderflowException si está vacía. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Queue::peek</function> - -push("a"); -$queue->push("b"); -$queue->push("c"); - -var_dump($queue->peek()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/queue/pop.xml b/reference/ds/ds/queue/pop.xml deleted file mode 100644 index edcad05dca..0000000000 --- a/reference/ds/ds/queue/pop.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Ds\Queue::pop - Elimina y devuelve el valor al frente de la cola - - - - &reftitle.description; - - public mixedDs\Queue::pop - - - - Elimina y devuelve el valor al frente de la cola. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El valor eliminado que estaba al frente de la cola. - - - - - &reftitle.errors; - - UnderflowException. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Queue::pop</function> - -push("a"); -$queue->push("b"); -$queue->push("c"); - -var_dump($queue->pop()); -var_dump($queue->pop()); -var_dump($queue->pop()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/queue/push.xml b/reference/ds/ds/queue/push.xml deleted file mode 100644 index c0382806ff..0000000000 --- a/reference/ds/ds/queue/push.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - Ds\Queue::push - Añade un elemento a la cola - - - - &reftitle.description; - - public voidDs\Queue::push - mixedvalues - - - Añade valores en la cola. - - - - - - &reftitle.parameters; - - - values - - - Los valores a añadir a la cola. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Queue::push</function> - -push("a"); -$queue->push("b"); -$queue->push("c", "d"); -$queue->push(...["e", "f"]); - -print_r($queue); -?> -]]> - - &example.outputs.similar; - - a - [1] => b - [2] => c - [3] => d - [4] => e - [5] => f -) -]]> - - - - - - - - diff --git a/reference/ds/ds/queue/toarray.xml b/reference/ds/ds/queue/toarray.xml deleted file mode 100644 index b6bb31fc29..0000000000 --- a/reference/ds/ds/queue/toarray.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - - Ds\Queue::toArray - - Convierte la cola en un &array; - - - - - &reftitle.description; - - public arrayDs\Queue::toArray - - - - Convierte la cola en un &array;. - - - - Un casting a un &array; no se soporta todavía. - - - - - Este método no es destructivo. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un &array; conteniendo todos los elementos en el mismo orden que la cola. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Queue::toArray</function> - -toArray()); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - - diff --git a/reference/ds/ds/sequence/allocate.xml b/reference/ds/ds/sequence/allocate.xml deleted file mode 100644 index c7445ae52a..0000000000 --- a/reference/ds/ds/sequence/allocate.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - Ds\Sequence::allocate - Asigna suficiente memoria para una capacidad requerida - - - - &reftitle.description; - - abstract public voidDs\Sequence::allocate - intcapacity - - - Asegura que se asigne suficiente memoria para una capacidad requerida. - Esto elimina la necesidad de reasignar el búfer interno a medida que se añaden valores. - - - - - &reftitle.parameters; - - - capacity - - - El número de valores para los cuales se debe asignar la capacidad. - - - - La capacidad permanecerá igual si este valor es inferior o igual a la - capacidad actual. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Sequence::allocate</function> - -capacity()); - -$vector->allocate(100); -var_dump($sequence->capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/sequence/apply.xml b/reference/ds/ds/sequence/apply.xml deleted file mode 100644 index 53bdd6685c..0000000000 --- a/reference/ds/ds/sequence/apply.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - Ds\Sequence::apply - Actualiza todos los valores aplicando una retrollamada a cada valor - - - - &reftitle.description; - - abstract public voidDs\Sequence::apply - callablecallback - - - Actualiza todos los valores aplicando una callback a - cada valor en la secuencia. - - - - - &reftitle.parameters; - - - callback - - - - - mixed - callback - mixedvalue - - - - Un callable a aplicar a cada valor del mapa. - - - - La retrollamada debe devolver el valor por el cual debe ser reemplazado. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Sequence::apply</function> - -apply(function($value) { return $value * 2; }); - -print_r($sequence); -?> -]]> - - &example.outputs.similar; - - 2 - [1] => 4 - [2] => 6 -) -]]> - - - - - - - diff --git a/reference/ds/ds/sequence/capacity.xml b/reference/ds/ds/sequence/capacity.xml deleted file mode 100644 index 2adbd666b2..0000000000 --- a/reference/ds/ds/sequence/capacity.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Ds\Sequence::capacity - Devuelve la capacidad actual - - - - &reftitle.description; - - abstract public intDs\Sequence::capacity - - - - Devuelve la capacidad actual. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La capacidad actual. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Sequence::capacity</function> - -capacity()); - -$sequence->push(...range(1, 50)); -var_dump($sequence->capacity()); - -$sequence[] = "a"; -var_dump($sequence->capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/sequence/contains.xml b/reference/ds/ds/sequence/contains.xml deleted file mode 100644 index fab7dd0d44..0000000000 --- a/reference/ds/ds/sequence/contains.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - Ds\Sequence::contains - Determina si la secuencia contiene valores dados - - - - &reftitle.description; - - abstract public boolDs\Sequence::contains - mixedvalues - - - Determina si la secuencia contiene todos los valores. - - - - - &reftitle.parameters; - - - values - - - Los valores a verificar. - - - - - - - - &reftitle.returnvalues; - - &false; si uno de los values proporcionados no está en la - secuencia, &true; en caso contrario. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Sequence::contains</function> - -contains('a')); // true -var_dump($sequence->contains('a', 'b')); // true -var_dump($sequence->contains('c', 'd')); // false - -var_dump($sequence->contains(...['c', 'b', 'a'])); // true - -// Siempre estricto -var_dump($sequence->contains(1)); // true -var_dump($sequence->contains('1')); // false - -var_dump($sequence->contains(...[])); // true -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/sequence/filter.xml b/reference/ds/ds/sequence/filter.xml deleted file mode 100644 index cadc714fd2..0000000000 --- a/reference/ds/ds/sequence/filter.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - Ds\Sequence::filter - - Crear una nueva secuencia utilizando un callable para - determinar qué valores incluir - - - - - &reftitle.description; - - abstract public Ds\SequenceDs\Sequence::filter - callablecallback - - - Crear una nueva secuencia utilizando un callable para - determinar qué valores incluir. - - - - - &reftitle.parameters; - - - - callback - - - - - bool - callback - mixedvalue - - - - Un callable opcional que devuelve &true; si el par debe ser incluido, &false; en caso contrario. - - - Si no se proporciona ninguna función de retrollamada, solo se incluirán los valores que son &true; - (ver conversión en booléen). - - - - - - - - - &reftitle.returnvalues; - - Una nueva secuencia que contiene todos los pares para los cuales - el callback ha devuelto &true;, o todos los valores que - se convierten en &true; si no se ha proporcionado un callback. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Sequence::filter</function> utilizando una función de retrollamada - -filter(function($value) { - return $value % 2 == 0; -})); -?> -]]> - - &example.outputs.similar; - - - int(2) - [1]=> - int(4) -} -]]> - - - - Ejemplo de <function>Ds\Sequence::filter</function> sin función de retrollamada - -filter()); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - string(1) "a" - [2]=> - bool(true) -} -]]> - - - - - - - diff --git a/reference/ds/ds/sequence/find.xml b/reference/ds/ds/sequence/find.xml deleted file mode 100644 index f370b6742e..0000000000 --- a/reference/ds/ds/sequence/find.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - Ds\Sequence::find - - Intenta encontrar el índice de un valor. - - - - - &reftitle.description; - - abstract public mixedDs\Sequence::find - mixedvalue - - - Devuelve el índice del valor, o &false; si no se encuentra. - - - - - - &reftitle.parameters; - - - value - - - El valor a encontrar. - - - - - - - - &reftitle.returnvalues; - - El índice del valor, o &false; si no se encuentra. - - - - Los valores serán comparados por valor y por tipo. - - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Sequence::find</function> - -find("a")); // 0 -var_dump($sequence->find("b")); // false -var_dump($sequence->find("1")); // false -var_dump($sequence->find(1)); // 1 -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/sequence/first.xml b/reference/ds/ds/sequence/first.xml deleted file mode 100644 index d4811ff05a..0000000000 --- a/reference/ds/ds/sequence/first.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - Ds\Sequence::first - Devuelve el primer valor de la secuencia - - - - &reftitle.description; - - abstract public mixedDs\Sequence::first - - - - Devuelve el primer valor de la secuencia. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el primer valor de la secuencia. - - - - - &reftitle.errors; - - UnderflowException si está vacío. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Sequence::first</function> - -first()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/sequence/get.xml b/reference/ds/ds/sequence/get.xml deleted file mode 100644 index 98433ee417..0000000000 --- a/reference/ds/ds/sequence/get.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - Ds\Sequence::get - Devuelve el valor en un índice dado - - - - &reftitle.description; - - abstract public mixedDs\Sequence::get - intindex - - - Devuelve el valor en un índice dado. - - - - - - &reftitle.parameters; - - - index - - - El índice al que se desea acceder, comenzando en 0. - - - - - - - - &reftitle.returnvalues; - - El valor en el índice solicitado. - - - - - &reftitle.errors; - - OutOfRangeException si el índice no es válido. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Sequence::get</function> - -get(0)); -var_dump($sequence->get(1)); -var_dump($sequence->get(2)); -?> -]]> - - &example.outputs.similar; - - - - - - Ejemplo de <function>Ds\Sequence::get</function> utilizando la sintaxis de array - - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/sequence/insert.xml b/reference/ds/ds/sequence/insert.xml deleted file mode 100644 index 9864c3c0f6..0000000000 --- a/reference/ds/ds/sequence/insert.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - Ds\Sequence::insert - Inserta valores en un índice dado - - - - &reftitle.description; - - abstract public voidDs\Sequence::insert - intindex - mixedvalues - - - Inserta valores en la secuencia en un índice dado. - - - - - - &reftitle.parameters; - - - index - - - El índice en el cual insertar. 0 <= index <= count - - - - Es posible insertar en el índice igual al número de valores. - - - - - - values - - - El o los valores a insertar. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - OutOfRangeException si el índice no es válido. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Sequence::insert</function> - -insert(0, "e"); // [e] -$sequence->insert(1, "f"); // [e, f] -$sequence->insert(2, "g"); // [e, f, g] -$sequence->insert(0, "a", "b"); // [a, b, e, f, g] -$sequence->insert(2, ...["c", "d"]); // [a, b, c, d, e, f, g] - -var_dump($sequence); -?> -]]> - - &example.outputs.similar; - - - string(1) "a" - [1]=> - string(1) "b" - [2]=> - string(1) "c" - [3]=> - string(1) "d" - [4]=> - string(1) "e" - [5]=> - string(1) "f" - [6]=> - string(1) "g" -} -]]> - - - - - - - diff --git a/reference/ds/ds/sequence/join.xml b/reference/ds/ds/sequence/join.xml deleted file mode 100644 index 64c43f8126..0000000000 --- a/reference/ds/ds/sequence/join.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Ds\Sequence::join - Reúne todos los valores en un string - - - - &reftitle.description; - - abstract public stringDs\Sequence::join - stringglue - - - Reúne todos los valores en un string utilizando un separador opcional entre cada valor. - - - - - &reftitle.parameters; - - - glue - - - Un string opcional para separar cada valor. - - - - - - - - &reftitle.returnvalues; - - Todos los valores de la secuencia reunidos en un string. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Sequence::join</function> con un string separador - -join("|")); -?> -]]> - - &example.outputs.similar; - - - - - - Ejemplo de <function>Ds\Sequence::join</function> sin string separador - -join()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/sequence/last.xml b/reference/ds/ds/sequence/last.xml deleted file mode 100644 index 893f389e2d..0000000000 --- a/reference/ds/ds/sequence/last.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - Ds\Sequence::last - Devuelve el último valor - - - - &reftitle.description; - - abstract public mixedDs\Sequence::last - - - - Devuelve el último valor de la secuencia. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El último valor de la secuencia. - - - - - &reftitle.errors; - - UnderflowException si está vacío. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Sequence::last</function> - -last()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/sequence/map.xml b/reference/ds/ds/sequence/map.xml deleted file mode 100644 index 2a13099b22..0000000000 --- a/reference/ds/ds/sequence/map.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - Ds\Sequence::map - Devuelve el resultado de la aplicación de una retrollamada a cada valor - - - - &reftitle.description; - - abstract public Ds\SequenceDs\Sequence::map - callablecallback - - - Devuelve el resultado de la aplicación de callback a - cada valor de la deque. - - - - - &reftitle.parameters; - - - callback - - - - - mixed - callback - mixedvalue - - - - Una callable a aplicar a cada valor de la deque. - - - - La retrollamada debe tomar un argumento y devolver el nuevo valor. - - - - - - - - - &reftitle.returnvalues; - - El resultado de la aplicación de callback a cada valor - de la deque. - - - - Los valores de la instancia actual no se verán afectados. - - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Sequence::map</function> - -map(function($value) { return $value * 2; })); -print_r($sequence); -?> -]]> - - &example.outputs.similar; - - 2 - [1] => 4 - [2] => 6 -) -Ds\Vector Object -( - [0] => 1 - [1] => 2 - [2] => 3 -) -]]> - - - - - - - diff --git a/reference/ds/ds/sequence/merge.xml b/reference/ds/ds/sequence/merge.xml deleted file mode 100644 index 1a1c1036d4..0000000000 --- a/reference/ds/ds/sequence/merge.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - Ds\Sequence::merge - Devuelve el resultado de la adición de todos los valores de la secuencia - - - - &reftitle.description; - - abstract public Ds\SequenceDs\Sequence::merge - mixedvalues - - - Devuelve el resultado de la adición de todos los valores de la secuencia. - - - - - - &reftitle.parameters; - - - values - - - Un objeto traversable o un &array;. - - - - - - - - &reftitle.returnvalues; - - El resultado de la adición de todos los valores dados a la secuencia, - efectivamente el mismo que añadir los valores a una copia, y luego devolver esta copia. - - - - La instancia actual no será afectada. - - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Sequence::merge</function> - -merge([4, 5, 6])); -var_dump($sequence); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) - [3]=> - int(4) - [4]=> - int(5) - [5]=> - int(6) -} -object(Ds\Vector)#1 (3) { - [0]=> - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - diff --git a/reference/ds/ds/sequence/pop.xml b/reference/ds/ds/sequence/pop.xml deleted file mode 100644 index 40db793b39..0000000000 --- a/reference/ds/ds/sequence/pop.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Ds\Sequence::pop - Elimina y devuelve el último valor - - - - &reftitle.description; - - abstract public mixedDs\Sequence::pop - - - - Elimina y devuelve el último valor. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El último valor eliminado. - - - - - &reftitle.errors; - - UnderflowException si está vacío. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Sequence::pop</function> - -pop()); -var_dump($sequence->pop()); -var_dump($sequence->pop()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/sequence/push.xml b/reference/ds/ds/sequence/push.xml deleted file mode 100644 index b85defa56f..0000000000 --- a/reference/ds/ds/sequence/push.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - Ds\Sequence::push - Añade valores al final de la secuencia - - - - &reftitle.description; - - abstract public voidDs\Sequence::push - mixedvalues - - - Añade valores al final de la secuencia. - - - - - - &reftitle.parameters; - - - values - - - Los valores a añadir. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Sequence::push</function> - -push("a"); -$sequence->push("b"); -$sequence->push("c", "d"); -$sequence->push(...["e", "f"]); - -print_r($sequence); -?> -]]> - - &example.outputs.similar; - - a - [1] => b - [2] => c - [3] => d - [4] => e - [5] => f -) -]]> - - - - - - - diff --git a/reference/ds/ds/sequence/reduce.xml b/reference/ds/ds/sequence/reduce.xml deleted file mode 100644 index 92ed842b05..0000000000 --- a/reference/ds/ds/sequence/reduce.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - Ds\Sequence::reduce - Reduce la secuencia a un solo valor utilizando una función de retrollamada - - - - &reftitle.description; - - abstract public mixedDs\Sequence::reduce - callablecallback - mixedinitial - - - Reduce la secuencia a un solo valor utilizando una función de retrollamada. - - - - - - &reftitle.parameters; - - - callback - - - - mixedcallback - mixedcarry - mixedvalue - - - - carry - - - El valor de retorno de la retrollamada anterior, o initial si - es la primera iteración. - - - - - value - - - El valor de la iteración actual. - - - - - - - - - initial - - - El valor inicial del valor de retorno. Puede ser &null;. - - - - - - - - &reftitle.returnvalues; - - El valor de retorno de la retrollamada final. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Sequence::reduce</function> con un valor inicial - -reduce($callback, 5)); - -// Iteraciones: -// -// $carry = $initial = 5 -// -// $carry = $carry * 1 = 5 -// $carry = $carry * 2 = 10 -// $carry = $carry * 3 = 30 -?> -]]> - - &example.outputs.similar; - - - - - - Ejemplo de <function>Ds\Sequence::reduce</function> sin valor inicial - -reduce(function($carry, $value) { - return $carry + $value + 5; -})); - -// Iteraciones: -// -// $carry = $initial = null -// -// $carry = $carry + 1 + 5 = 6 -// $carry = $carry + 2 + 5 = 13 -// $carry = $carry + 3 + 5 = 21 -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/sequence/remove.xml b/reference/ds/ds/sequence/remove.xml deleted file mode 100644 index 794d928806..0000000000 --- a/reference/ds/ds/sequence/remove.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - Ds\Sequence::remove - Elimina y devuelve un valor por índice - - - - &reftitle.description; - - abstract public mixedDs\Sequence::remove - intindex - - - Elimina y devuelve un valor por índice. - - - - - - &reftitle.parameters; - - - index - - - El índice del valor a eliminar. - - - - - - - - &reftitle.returnvalues; - - El valor que ha sido eliminado. - - - - - &reftitle.errors; - - OutOfRangeException si el índice no es válido. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Sequence::remove</function> - -remove(1)); -var_dump($sequence->remove(0)); -var_dump($sequence->remove(0)); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/sequence/reverse.xml b/reference/ds/ds/sequence/reverse.xml deleted file mode 100644 index eea1e7bc6f..0000000000 --- a/reference/ds/ds/sequence/reverse.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Ds\Sequence::reverse - - Invierte la secuencia en el lugar - - - - - &reftitle.description; - - abstract public voidDs\Sequence::reverse - - - - Invierte la secuencia en el lugar. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Sequence::reverse</function> - -reverse(); - -print_r($sequence); -?> -]]> - - &example.outputs.similar; - - c - [1] => b - [2] => a -) -]]> - - - - - - - diff --git a/reference/ds/ds/sequence/reversed.xml b/reference/ds/ds/sequence/reversed.xml deleted file mode 100644 index bb08e90ea7..0000000000 --- a/reference/ds/ds/sequence/reversed.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - Ds\Sequence::reversed - Devuelve una copia invertida - - - - &reftitle.description; - - abstract public Ds\SequenceDs\Sequence::reversed - - - - Devuelve una copia invertida de la secuencia. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Una copia invertida de la secuencia. - - - - La instancia actual no se ve afectada. - - - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Sequence::reversed</function> - -reversed()); -print_r($sequence); -?> -]]> - - &example.outputs.similar; - - c - [1] => b - [2] => a -) -Ds\Vector Object -( - [0] => a - [1] => b - [2] => c -) -]]> - - - - - - - diff --git a/reference/ds/ds/sequence/rotate.xml b/reference/ds/ds/sequence/rotate.xml deleted file mode 100644 index 462c3e7476..0000000000 --- a/reference/ds/ds/sequence/rotate.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Ds\Sequence::rotate - Rota la secuencia un número dado de rotaciones - - - - &reftitle.description; - - abstract public voidDs\Sequence::rotate - introtations - - - Rota la secuencia un cierto número de rotaciones, lo que equivale a llamar sucesivamente - $deque->push($deque->shift()) si el número de rotaciones es positivo, o - $deque->unshift($deque->pop()) si es negativo. - - - - - - &reftitle.parameters; - - - rotations - - - El número de veces que la secuencia debe ser rotada. - - - - - - - - &reftitle.returnvalues; - - &return.void;. La secuencia de la instancia actual será rotada. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Sequence::rotate</function> - -rotate(1); // "a" es desplazado, luego empujado. -print_r($sequence); - -$sequence->rotate(2); // "b" y "c" son ambos desplazados, luego empujados. -print_r($sequence); -?> -]]> - - &example.outputs.similar; - - b - [1] => c - [2] => d - [3] => a -) -Ds\Vector Object -( - [0] => d - [1] => a - [2] => b - [3] => c -) -]]> - - - - - - - diff --git a/reference/ds/ds/sequence/set.xml b/reference/ds/ds/sequence/set.xml deleted file mode 100644 index 51b41870b6..0000000000 --- a/reference/ds/ds/sequence/set.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - Ds\Sequence::set - Actualiza un valor en un índice dado - - - - &reftitle.description; - - abstract public voidDs\Sequence::set - intindex - mixedvalue - - - Actualiza un valor en un índice dado. - - - - - - &reftitle.parameters; - - - index - - - El índice del valor a actualizar. - - - - - value - - - El nuevo valor. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - OutOfRangeException si el índice no es válido. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Sequence::set</function> - -set(1, "_"); -print_r($sequence); -?> -]]> - - &example.outputs.similar; - - a - [1] => _ - [2] => c -) -]]> - - - - Ejemplo de <function>Ds\Sequence::set</function> utilizando la sintaxis de array - - -]]> - - &example.outputs.similar; - - a - [1] => _ - [2] => c -) -]]> - - - - - - - diff --git a/reference/ds/ds/sequence/shift.xml b/reference/ds/ds/sequence/shift.xml deleted file mode 100644 index 734a21c098..0000000000 --- a/reference/ds/ds/sequence/shift.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Ds\Sequence::shift - Elimina y devuelve el primer valor - - - - &reftitle.description; - - abstract public mixedDs\Sequence::shift - - - - Elimina y devuelve el primer valor. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El primer valor, que ha sido eliminado. - - - - - &reftitle.errors; - - UnderflowException si está vacío. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Sequence::shift</function> - -shift()); -var_dump($sequence->shift()); -var_dump($sequence->shift()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/sequence/slice.xml b/reference/ds/ds/sequence/slice.xml deleted file mode 100644 index 52ed093439..0000000000 --- a/reference/ds/ds/sequence/slice.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - Ds\Sequence::slice - - Devuelve una subsecuencia de un rango dado - - - - - &reftitle.description; - - abstract public Ds\SequenceDs\Sequence::slice - intindex - intlength - - - Crear una subsecuencia de un rango dado. - - - - - - &reftitle.parameters; - - - index - - - El índice en el que comienza la subsecuencia. - - - Si es positivo, el sub-deque comenzará en este índice en el deque. - Si es negativo, el sub-deque comenzará a esta distancia del final. - - - - - length - - - Si se da una longitud y es positiva, el sub-deque resultante - tendrá hasta tantos valores. - - Si la longitud causa un desbordamiento, solo - los valores hasta el final del deque serán incluidos. - - Si se da una longitud y es negativa, el sub-deque - se detendrá a tantos valores del final. - - Si no se proporciona una longitud, el sub-deque - contendrá todos los valores entre el índice y el - final de la secuencia. - - - - - - - - &reftitle.returnvalues; - - Una subsecuencia del rango dado. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Sequence::slice</function> - -slice(2)); - -// Recorte a partir de 1, para una longitud de 3 -print_r($sequence->slice(1, 3)); - -// Recorte a partir de 1 en adelante -print_r($sequence->slice(1)); - -// Recorte a partir de 2 hacia atrás -print_r($sequence->slice(-2)); - -// Recorte de 1 a 1 del final -print_r($sequence->slice(1, -1)); -?> -]]> - - &example.outputs.similar; - - c - [1] => d - [2] => e -) -Ds\Vector Object -( - [0] => b - [1] => c - [2] => d -) -Ds\Vector Object -( - [0] => b - [1] => c - [2] => d - [3] => e -) -Ds\Vector Object -( - [0] => d - [1] => e -) -Ds\Vector Object -( - [0] => b - [1] => c - [2] => d -) - -]]> - - - - - - - diff --git a/reference/ds/ds/sequence/sort.xml b/reference/ds/ds/sequence/sort.xml deleted file mode 100644 index d1e34c6019..0000000000 --- a/reference/ds/ds/sequence/sort.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - Ds\Sequence::sort - - Ordena la secuencia en su lugar - - - - - &reftitle.description; - - abstract public voidDs\Sequence::sort - callablecomparator - - - Ordena la secuencia en su lugar, utilizando una función de comparación opcional comparator. - - - - - - &reftitle.parameters; - - - comparator - - &sort.callback.description; - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Sequence::sort</function> - -sort(); - -print_r($sequence); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 - [3] => 4 - [4] => 5 -) -]]> - - - - Ejemplo de <function>Ds\Sequence::sort</function> utilizando un comparador - -sort(function($a, $b) { - return $b <=> $a; -}); - -print_r($sequence); -?> -]]> - - &example.outputs.similar; - - 5 - [1] => 4 - [2] => 3 - [3] => 2 - [4] => 1 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/sequence/sorted.xml b/reference/ds/ds/sequence/sorted.xml deleted file mode 100644 index 1aee889638..0000000000 --- a/reference/ds/ds/sequence/sorted.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - Ds\Sequence::sorted - Devuelve una copia ordenada - - - - &reftitle.description; - - abstract public Ds\SequenceDs\Sequence::sorted - callablecomparator - - - Devuelve una copia ordenada de la secuencia, utilizando una función de comparación opcional comparator. - - - - - - &reftitle.parameters; - - - comparator - - &sort.callback.description; - - - - - - - &reftitle.returnvalues; - - Devuelve una copia ordenada de la secuencia. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Sequence::sorted</function> - -sorted()); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 - [3] => 4 - [4] => 5 -) -]]> - - - - Ejemplo de <function>Ds\Sequence::sorted</function> utilizando un comparador - -sorted(function($a, $b) { - return $b <=> $a; -}); - -print_r($sorted); -?> -]]> - - &example.outputs.similar; - - 5 - [1] => 4 - [2] => 3 - [3] => 2 - [4] => 1 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/sequence/sum.xml b/reference/ds/ds/sequence/sum.xml deleted file mode 100644 index b25a1065c1..0000000000 --- a/reference/ds/ds/sequence/sum.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - Ds\Sequence::sum - Devuelve la suma de todos los valores de la secuencia - - - - &reftitle.description; - - abstract public intfloatDs\Sequence::sum - - - - Devuelve la suma de todos los valores de la secuencia. - - - - Los arrays y los objetos se consideran iguales a cero en el cálculo de la suma. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La suma de todos los valores de la secuencia como float o int - dependiendo de los valores de la secuencia. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Sequence::sum</function> con un entero - -sum()); -?> -]]> - - &example.outputs.similar; - - - - - - Ejemplo de <function>Ds\Sequence::sum</function> con un número de punto flotante - -sum()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/sequence/unshift.xml b/reference/ds/ds/sequence/unshift.xml deleted file mode 100644 index 03669e5a40..0000000000 --- a/reference/ds/ds/sequence/unshift.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Ds\Sequence::unshift - Añade valores al inicio de la secuencia - - - - &reftitle.description; - - abstract public voidDs\Sequence::unshift - mixedvalues - - - Añade valores al inicio de la secuencia, desplazando todos los valores actuales - hacia adelante para hacer espacio para los nuevos valores. - - - - - - &reftitle.parameters; - - - values - - - Los valores a añadir al inicio de la secuencia. - - - Varios valores serán añadidos en el mismo orden en que son - pasados. - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Sequence::unshift</function> - -unshift("a"); -$sequence->unshift("b", "c"); - -print_r($sequence); -?> -]]> - - &example.outputs.similar; - - b - [1] => c - [2] => a - [3] => 1 - [4] => 2 - [5] => 3 -) -]]> - - - - - - - diff --git a/reference/ds/ds/set/add.xml b/reference/ds/ds/set/add.xml deleted file mode 100644 index 35da023cf4..0000000000 --- a/reference/ds/ds/set/add.xml +++ /dev/null @@ -1,201 +0,0 @@ - - - - - - Ds\Set::add - Añade valores a la secuencia - - - - &reftitle.description; - - public voidDs\Set::add - mixedvalues - - - Añade todos los valores dados al conjunto que no hayan sido ya añadidos. - - - - Los valores de tipo object son soportados. - - Si un objeto implementa Ds\Hashable, - la igualdad será determinada por la función equals del objeto. - - Si un objeto no implementa Ds\Hashable, - los objetos deben ser referencias a la misma instancia para ser considerados iguales. - - - - - Todas las comparaciones son estrictas (tipo y valor). - - - - - - &reftitle.parameters; - - - values - - - Los valores a añadir a la secuencia. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Set::add</function> utilizando enteros - -add(1); -$set->add(1); -$set->add(2); -$set->add(3); - -// Las comparaciones estrictas no tratarían estos valores de la misma manera que int(1) -$set->add("1"); -$set->add(true); - -var_dump($set); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) - [3]=> - string(1) "1" - [4]=> - bool(true) -} -]]> - - - - Ejemplo de <function>Ds\Set::add</function> utilizando objetos - -value = $value; - } - - public function hash() - { - return $this->value; - } - - public function equals($obj): bool - { - return $this->value === $obj->value; - } -} - -$set = new \Ds\Set(); - -$obj = new \ArrayIterator([]); - -// Añadir la misma instancia varias veces solo añadirá la primera. -$set->add($obj); -$set->add($obj); - -// Añadir varias instancias del mismo objeto añadirá todas las instancias. -$set->add(new \stdClass()); -$set->add(new \stdClass()); - -// Añadir varias instancias de objetos hashables iguales solo añadirá la primera. -$set->add(new \HashableObject(1)); -$set->add(new \HashableObject(1)); -$set->add(new \HashableObject(2)); -$set->add(new \HashableObject(2)); - -var_dump($set); -?> -]]> - - &example.outputs.similar; - - - object(ArrayIterator)#2 (1) { - ["storage":"ArrayIterator":private]=> - array(0) { - } - } - [1]=> - object(stdClass)#3 (0) { - } - [2]=> - object(stdClass)#4 (0) { - } - [3]=> - object(HashableObject)#5 (1) { - ["value":"HashableObject":private]=> - int(1) - } - [4]=> - object(HashableObject)#6 (1) { - ["value":"HashableObject":private]=> - int(2) - } -} -]]> - - - - - - - diff --git a/reference/ds/ds/set/allocate.xml b/reference/ds/ds/set/allocate.xml deleted file mode 100644 index 948fbd60b9..0000000000 --- a/reference/ds/ds/set/allocate.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Ds\Set::allocate - Asigna suficiente memoria para una capacidad requerida - - - - &reftitle.description; - - public voidDs\Set::allocate - intcapacity - - - Asigna suficiente memoria para una capacidad requerida. - - - - - - &reftitle.parameters; - - - capacity - - - El número de valores para los cuales la capacidad debe ser asignada. - - - - La capacidad permanecerá igual si este valor es inferior o igual a la - capacidad actual. - - - - - La capacidad siempre será redondeada a la potencia de 2 más cercana. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Set::allocate</function> - -capacity()); - -$set->allocate(100); -var_dump($set->capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/set/capacity.xml b/reference/ds/ds/set/capacity.xml deleted file mode 100644 index 8f840efa8a..0000000000 --- a/reference/ds/ds/set/capacity.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Ds\Set::capacity - Devuelve la capacidad actual - - - - &reftitle.description; - - public intDs\Set::capacity - - - - Devuelve la capacidad actual. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La capacidad actual. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Set::capacity</function> - -capacity()); - -$set->add(...range(1, 50)); -var_dump($set->capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/set/clear.xml b/reference/ds/ds/set/clear.xml deleted file mode 100644 index d706076af2..0000000000 --- a/reference/ds/ds/set/clear.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Ds\Set::clear - Elimina todos los valores - - - - &reftitle.description; - - public voidDs\Set::clear - - - - Elimina todos los valores de la secuencia. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Set::clear</function> - -clear(); -print_r($set); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 -) -Ds\Set Object -( -) -]]> - - - - - - - diff --git a/reference/ds/ds/set/construct.xml b/reference/ds/ds/set/construct.xml deleted file mode 100644 index ec283a8b37..0000000000 --- a/reference/ds/ds/set/construct.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - Ds\Set::__construct - Crea una nueva instancia - - - - &reftitle.description; - - public Ds\Set::__construct - mixedvalues[] - - - Crea una nueva instancia, utilizando un objeto traversable - o un &array; para los valores iniciales. - - - - - - &reftitle.parameters; - - - values - - - Un objeto traversable o un &array; a utilizar para los valores iniciales. - - - - - - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Set::__construct</function> - - -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - diff --git a/reference/ds/ds/set/contains.xml b/reference/ds/ds/set/contains.xml deleted file mode 100644 index 6cb50bc634..0000000000 --- a/reference/ds/ds/set/contains.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - Ds\Set::contains - Determina si el conjunto contiene todos los valores - - - - &reftitle.description; - - public boolDs\Set::contains - mixedvalues - - - Determina si el conjunto contiene todos los valores. - - - - - Los valores de tipo object son soportados. - - Si un objeto implementa Ds\Hashable, - la igualdad será determinada por la función equals del objeto. - - Si un objeto no implementa Ds\Hashable, - los objetos deben ser referencias a la misma instancia para ser considerados iguales. - - - - - Todas las comparaciones son estrictas (tipo y valor). - - - - - - - &reftitle.parameters; - - - values - - - Los valores a verificar. - - - - - - - - &reftitle.returnvalues; - - &false; si uno de los valores proporcionados no está en - la secuencia, de lo contrario &true;. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Set::contains</function> - -contains(1)); // true -var_dump($set->contains(1, 2)); // true -var_dump($set->contains(...[1, 2])); // true - -var_dump($set->contains("1")); // false -var_dump($set->contains(...[1, 2, 3, 4])); // false - -var_dump($set->contains(...[])); // true -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/set/copy.xml b/reference/ds/ds/set/copy.xml deleted file mode 100644 index dca5ddffba..0000000000 --- a/reference/ds/ds/set/copy.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - Ds\Set::copy - Devuelve una copia superficial de la secuencia - - - - &reftitle.description; - - public Ds\SetDs\Set::copy - - - - Devuelve una copia superficial de la secuencia. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una copia superficial de la secuencia. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Set::copy</function> - -copy(); - -// Cambiar la copia no afecta al original -$b->add(4); - -print_r($a); -print_r($b); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 -) -Ds\Set Object -( - [0] => 1 - [1] => 2 - [2] => 3 - [3] => 4 -) -]]> - - - - - - - diff --git a/reference/ds/ds/set/count.xml b/reference/ds/ds/set/count.xml deleted file mode 100644 index cf8baf92e4..0000000000 --- a/reference/ds/ds/set/count.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - - Ds\Set::count - Devuelve el número de valores en la secuencia - - - - &reftitle.description; - - Ver Countable::count - - - - - - diff --git a/reference/ds/ds/set/diff.xml b/reference/ds/ds/set/diff.xml deleted file mode 100644 index 769b1025b2..0000000000 --- a/reference/ds/ds/set/diff.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Ds\Set::diff - Crear un nuevo conjunto utilizando valores que no están en otra secuencia - - - - &reftitle.description; - - public Ds\SetDs\Set::diff - Ds\Setset - - - Crear un nuevo conjunto utilizando valores que no están en otra secuencia. - - - A \ B = {x ∈ A | x ∉ B} - - - - - &reftitle.parameters; - - - set - - - El conjunto que contiene los valores a excluir. - - - - - - - - &reftitle.returnvalues; - - Un nuevo conjunto que contiene todos los valores que no estaban en el otro set. - - - - - &reftitle.seealso; - - - Complemento en Wikipedia - - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Set::diff</function> - -diff($b)); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) -} -]]> - - - - - - - diff --git a/reference/ds/ds/set/filter.xml b/reference/ds/ds/set/filter.xml deleted file mode 100644 index aff051da88..0000000000 --- a/reference/ds/ds/set/filter.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - Ds\Set::filter - - Crear un nuevo conjunto utilizando un callable - para determinar qué valores incluir - - - - - &reftitle.description; - - public Ds\SetDs\Set::filter - callablecallback - - - Crear un nuevo conjunto utilizando un callable para - determinar qué valores incluir. - - - - - - &reftitle.parameters; - - - callback - - - - bool - callback - mixedvalue - - - - Un callable opcional que devuelve &true; si el par debe ser incluido, &false; en caso contrario. - - - Si no se proporciona ninguna función de retrollamada, solo se incluirán los valores que son &true; - (ver conversión en booléen). - - - - - - - - &reftitle.returnvalues; - - Un nuevo conjunto que contiene todos los pares para los cuales - el callback ha devuelto &true;, o todos los valores que - se convierten en &true; si no se ha proporcionado un callback. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Set::filter</function> utilizando una función de retrollamada - -filter(function($value) { - return $value % 2 == 0; -})); -?> -]]> - - &example.outputs.similar; - - - int(2) - [1]=> - int(4) -} -]]> - - - - Ejemplo de <function>Ds\Set::filter</function> sin función de retrollamada - -filter()); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - string(1) "a" - [2]=> - bool(true) -} -]]> - - - - - - - diff --git a/reference/ds/ds/set/first.xml b/reference/ds/ds/set/first.xml deleted file mode 100644 index 34e52ddd61..0000000000 --- a/reference/ds/ds/set/first.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Ds\Set::first - Devuelve el primer valor de la secuencia - - - - &reftitle.description; - - public mixedDs\Set::first - - - - Devuelve el primer valor de la secuencia. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El primer valor de la secuencia. - - - - - &reftitle.errors; - - UnderflowException si está vacío. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Set::first</function> - -first()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/set/get.xml b/reference/ds/ds/set/get.xml deleted file mode 100644 index c96b60b15f..0000000000 --- a/reference/ds/ds/set/get.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - Ds\Set::get - Devuelve el valor en un índice dado - - - - &reftitle.description; - - public mixedDs\Set::get - intindex - - - Devuelve el valor en un índice dado. - - - - - - &reftitle.parameters; - - - index - - - El índice al que se accede, comenzando en 0. - - - - - - - - &reftitle.returnvalues; - - El valor en el índice solicitado. - - - - - &reftitle.errors; - - OutOfRangeException si el índice es inválido. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Set::get</function> - -get(0)); -var_dump($set->get(1)); -var_dump($set->get(2)); -?> -]]> - - &example.outputs.similar; - - - - - - Ejemplo de <function>Ds\Set::get</function> utilizando la sintaxis de array - - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/set/intersect.xml b/reference/ds/ds/set/intersect.xml deleted file mode 100644 index a02be15c75..0000000000 --- a/reference/ds/ds/set/intersect.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Ds\Set::intersect - Crear un nuevo conjunto utilizando valores comunes con otra secuencia - - - - &reftitle.description; - - public Ds\SetDs\Set::intersect - Ds\Setset - - - Crear un nuevo conjunto utilizando valores comunes con otro set. - - En otras palabras, devuelve una copia de la instancia actual con todos los valores eliminados - que no están en el otro set. - - - A ∩ B = {x : x ∈ A ∧ x ∈ B} - - - - - &reftitle.parameters; - - - set - - - La otra secuencia. - - - - - - - - &reftitle.returnvalues; - - La intersección de la instancia actual y otro set. - - - - - &reftitle.seealso; - - - Intersección en Wikipedia - - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Set::intersect</function> - -intersect($b)); -?> -]]> - - &example.outputs.similar; - - - int(3) -} -]]> - - - - - - - diff --git a/reference/ds/ds/set/isempty.xml b/reference/ds/ds/set/isempty.xml deleted file mode 100644 index 53c4c0e458..0000000000 --- a/reference/ds/ds/set/isempty.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Ds\Set::isEmpty - Indica si el conjunto está vacío - - - - &reftitle.description; - - public boolDs\Set::isEmpty - - - - Indica si el conjunto está vacío. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si el conjunto está vacío, de lo contrario &false;. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Set::isEmpty</function> - -isEmpty()); -var_dump($b->isEmpty()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/set/join.xml b/reference/ds/ds/set/join.xml deleted file mode 100644 index dec9357990..0000000000 --- a/reference/ds/ds/set/join.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Ds\Set::join - Reúne todos los valores en un string - - - - &reftitle.description; - - public stringDs\Set::join - stringglue - - - Reúne todos los valores en un string utilizando un separador opcional entre cada valor. - - - - - &reftitle.parameters; - - - glue - - - Un string opcional para separar cada valor. - - - - - - - - &reftitle.returnvalues; - - Todos los valores del conjunto reunidos en un string. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Set::join</function> con un string separador - -join("|")); -?> -]]> - - &example.outputs.similar; - - - - - - Ejemplo de <function>Ds\Set::join</function> sin un string separador - -join()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/set/jsonserialize.xml b/reference/ds/ds/set/jsonserialize.xml deleted file mode 100644 index 97643e2ae4..0000000000 --- a/reference/ds/ds/set/jsonserialize.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - Ds\Set::jsonSerialize - Devuelve una representación que puede ser convertida en JSON - - - - &reftitle.description; - - Ver JsonSerializable::jsonSerialize - - - - No debería ser necesario llamar a esto directamente. - - - - - - - diff --git a/reference/ds/ds/set/last.xml b/reference/ds/ds/set/last.xml deleted file mode 100644 index 27b89a978a..0000000000 --- a/reference/ds/ds/set/last.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Ds\Set::last - Devuelve el último valor de la secuencia - - - - &reftitle.description; - - public mixedDs\Set::last - - - - Devuelve el último valor de la secuencia. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El último valor de la secuencia. - - - - - &reftitle.errors; - - UnderflowException si está vacío. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Set::last</function> - -last()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/set/map.xml b/reference/ds/ds/set/map.xml deleted file mode 100644 index 5bd58d590c..0000000000 --- a/reference/ds/ds/set/map.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - Ds\Set::map - Devuelve el resultado de la aplicación de una retrollamada a cada valor - - - - &reftitle.description; - - public Ds\SetDs\Set::map - callablecallback - - - Devuelve el resultado de la aplicación de una retrollamada a - cada valor del conjunto. - - - - - &reftitle.parameters; - - - callback - - - La retrollamada a aplicar a cada valor del conjunto debe tener la siguiente firma: - - mixed - callback - mixedvalue - - - - - - - - - &reftitle.returnvalues; - - Devuelve un nuevo objeto Ds\Set donde cada valor - es el resultado de la aplicación de la retrollamada a cada valor - del conjunto. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Ds\Set::map</methodname> - -map(function($value) { return $value * 2; })); -var_dump($set); -?> -]]> - - &example.outputs.similar; - - - int(2) - [1]=> - int(4) - [2]=> - int(6) -} -object(Ds\Set)#1 (3) { - [0]=> - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - diff --git a/reference/ds/ds/set/merge.xml b/reference/ds/ds/set/merge.xml deleted file mode 100644 index 99b555bdb7..0000000000 --- a/reference/ds/ds/set/merge.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - Ds\Set::merge - Devuelve el resultado de la adición de todos los valores de la secuencia - - - - &reftitle.description; - - public Ds\SetDs\Set::merge - mixedvalues - - - Devuelve el resultado de la adición de todos los valores de la secuencia. - - - - - - &reftitle.parameters; - - - values - - - Un objeto traversable o un &array;. - - - - - - - - &reftitle.returnvalues; - - El resultado de la adición de todos los valores dados a la secuencia, - efectivamente el mismo que añadir los valores a una copia, y luego devolver esta copia. - - - - La instancia actual no será afectada. - - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Set::merge</function> - -merge([3, 4, 5])); -var_dump($set); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) - [3]=> - int(4) - [4]=> - int(5) -} -object(Ds\Set)#1 (3) { - [0]=> - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - diff --git a/reference/ds/ds/set/reduce.xml b/reference/ds/ds/set/reduce.xml deleted file mode 100644 index 891291b005..0000000000 --- a/reference/ds/ds/set/reduce.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - Ds\Set::reduce - Reduce el conjunto a un solo valor utilizando una función de retrollamada - - - - &reftitle.description; - - public mixedDs\Set::reduce - callablecallback - mixedinitial - - - Reduce el conjunto a un solo valor utilizando una función de retrollamada. - - - - - - &reftitle.parameters; - - - callback - - - - mixedcallback - mixedcarry - mixedvalue - - - - carry - - - El valor de retorno de la retrollamada anterior, o initial si - es la primera iteración. - - - - - value - - - El valor de la iteración actual. - - - - - - - - - initial - - - El valor inicial del valor de retorno. Puede ser &null;. - - - - - - - - &reftitle.returnvalues; - - El valor de retorno de la retrollamada final. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Set::reduce</function> con valor inicial - -reduce($callback, 5)); - -// Iteraciones: -// -// $carry = $initial = 5 -// -// $carry = $carry * 1 = 5 -// $carry = $carry * 2 = 10 -// $carry = $carry * 3 = 30 -?> -]]> - - &example.outputs.similar; - - - - - - Ejemplo de <function>Ds\Set::reduce</function> sin valor inicial - -reduce(function($carry, $value) { - return $carry + $value + 5; -})); - -// Iteraciones: -// -// $carry = $initial = null -// -// $carry = $carry + 1 + 5 = 6 -// $carry = $carry + 2 + 5 = 13 -// $carry = $carry + 3 + 5 = 21 -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/set/remove.xml b/reference/ds/ds/set/remove.xml deleted file mode 100644 index 3067beb574..0000000000 --- a/reference/ds/ds/set/remove.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - Ds\Set::remove - Elimina todos los valores dados de la secuencia - - - - &reftitle.description; - - public voidDs\Set::remove - mixedvalues - - - Elimina todos los values dados de la secuencia, ignorando aquellos que no están en la secuencia. - - - - - - &reftitle.parameters; - - - values - - - Los valores a eliminar. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Set::remove</function> - -remove(1); // Elimina 1 -$set->remove(1, 2); // No encuentra 1, pero elimina 2 -$set->remove(...[3, 4]); // Elimina 3 y 4 - -var_dump($set); -?> -]]> - - &example.outputs.similar; - - - int(5) -} -]]> - - - - - - - diff --git a/reference/ds/ds/set/reverse.xml b/reference/ds/ds/set/reverse.xml deleted file mode 100644 index 0db799d01d..0000000000 --- a/reference/ds/ds/set/reverse.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Ds\Set::reverse - - Invierte el conjunto en su lugar - - - - - &reftitle.description; - - public voidDs\Set::reverse - - - - Invierte el conjunto en su lugar. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Set::reverse</function> - -reverse(); - -print_r($set); -?> -]]> - - &example.outputs.similar; - - c - [1] => b - [2] => a -) -]]> - - - - - - - diff --git a/reference/ds/ds/set/reversed.xml b/reference/ds/ds/set/reversed.xml deleted file mode 100644 index 3af9e5c5d7..0000000000 --- a/reference/ds/ds/set/reversed.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - Ds\Set::reversed - Devuelve una copia invertida - - - - &reftitle.description; - - public Ds\SetDs\Set::reversed - - - - Devuelve una copia invertida de la secuencia. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Una copia invertida de la secuencia. - - - - La instancia actual no se ve afectada. - - - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Set::reversed</function> - -reversed()); -print_r($set); -?> -]]> - - &example.outputs.similar; - - c - [1] => b - [2] => a -) -Ds\Set Object -( - [0] => a - [1] => b - [2] => c -) -]]> - - - - - - - diff --git a/reference/ds/ds/set/slice.xml b/reference/ds/ds/set/slice.xml deleted file mode 100644 index 20a83c94a3..0000000000 --- a/reference/ds/ds/set/slice.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - Ds\Set::slice - - Devuelve un subconjunto de un rango dado - - - - - &reftitle.description; - - public Ds\SetDs\Set::slice - intindex - intlength - - - Crea un subconjunto de un rango dado. - - - - - - &reftitle.parameters; - - - index - - - El índice en el que comienza la subsecuencia. - - - Si es positivo, la subsecuencia comenzará en este índice en la secuencia. - Si es negativo, la subsecuencia comenzará a esta distancia del final. - - - - - length - - - Si se proporciona una longitud y es positiva, la subsecuencia resultante - tendrá hasta tantos valores. - - Si la longitud provoca un desbordamiento, solo - los valores hasta el final del conjunto serán incluidos. - - Si se proporciona una longitud y es negativa, la subsecuencia - se detendrá a tantos valores del final. - - Si no se proporciona una longitud, la subsecuencia - contendrá todos los valores entre el índice y el - final de la secuencia. - - - - - - - - &reftitle.returnvalues; - - Un subconjunto del conjunto dado. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Set::slice</function> - -slice(2)); - -// Corte a partir de 1, para una longitud de 3 -print_r($set->slice(1, 3)); - -// Corte a partir de 1 en adelante -print_r($set->slice(1)); - -// Corte a partir de 2 hacia atrás -print_r($set->slice(-2)); - -// Corte de 1 a 1 del final -print_r($set->slice(1, -1)); -?> -]]> - - &example.outputs.similar; - - c - [1] => d - [2] => e -) -Ds\Set Object -( - [0] => b - [1] => c - [2] => d -) -Ds\Set Object -( - [0] => b - [1] => c - [2] => d - [3] => e -) -Ds\Set Object -( - [0] => d - [1] => e -) -Ds\Set Object -( - [0] => b - [1] => c - [2] => d -) - -]]> - - - - - - - diff --git a/reference/ds/ds/set/sort.xml b/reference/ds/ds/set/sort.xml deleted file mode 100644 index 6e1ce522be..0000000000 --- a/reference/ds/ds/set/sort.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - Ds\Set::sort - - Ordena el conjunto en el lugar - - - - - &reftitle.description; - - public voidDs\Set::sort - callablecomparator - - - Ordena el conjunto en el lugar, utilizando una función comparator opcional. - - - - - - &reftitle.parameters; - - - comparator - - &sort.callback.description; - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Set::sort</function> - -sort(); - -print_r($set); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 - [3] => 4 - [4] => 5 -) -]]> - - - - Ejemplo de <function>Ds\Set::sort</function> - -sort(function($a, $b) { - return $b <=> $a; -}); - -print_r($set); -?> -]]> - - &example.outputs.similar; - - 5 - [1] => 4 - [2] => 3 - [3] => 2 - [4] => 1 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/set/sorted.xml b/reference/ds/ds/set/sorted.xml deleted file mode 100644 index 3781697c86..0000000000 --- a/reference/ds/ds/set/sorted.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - Ds\Set::sorted - Devuelve una copia ordenada - - - - &reftitle.description; - - public Ds\SetDs\Set::sorted - callablecomparator - - - Devuelve una copia ordenada de la secuencia, utilizando una función comparator opcional. - - - - - - &reftitle.parameters; - - - comparator - - &sort.callback.description; - - - - - - - &reftitle.returnvalues; - - Devuelve una copia ordenada de la secuencia. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Set::sorted</function> - -sorted()); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 - [3] => 4 - [4] => 5 -) -]]> - - - - Ejemplo de <function>Ds\Set::sorted</function> utilizando un comparador - -sorted(function($a, $b) { - return $b <=> $a; -}); - -print_r($sorted); -?> -]]> - - &example.outputs.similar; - - 5 - [1] => 4 - [2] => 3 - [3] => 2 - [4] => 1 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/set/sum.xml b/reference/ds/ds/set/sum.xml deleted file mode 100644 index 34e96e5c01..0000000000 --- a/reference/ds/ds/set/sum.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - Ds\Set::sum - Devuelve la suma de todos los valores de la secuencia - - - - &reftitle.description; - - public intfloatDs\Set::sum - - - - Devuelve la suma de todos los valores de la secuencia. - - - - Los arrays y los objetos se consideran iguales a cero durante el cálculo de la suma. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La suma de todos los valores del conjunto como float o int - dependiendo de los valores de la secuencia. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Set::sum</function> con un entero - -sum()); -?> -]]> - - &example.outputs.similar; - - - - - - Ejemplo de <function>Ds\Set::sum</function> con un número de punto flotante - -sum()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/set/toarray.xml b/reference/ds/ds/set/toarray.xml deleted file mode 100644 index bf6086220c..0000000000 --- a/reference/ds/ds/set/toarray.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Ds\Set::toArray - - Convierte el conjunto en un &array; - - - - - &reftitle.description; - - public arrayDs\Set::toArray - - - - Convierte el conjunto en un &array;. - - - - La conversión en un &array; aún no es soportada. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un &array; que contiene todos los valores en el mismo orden que la secuencia. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Set::toArray</function> - -toArray()); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - diff --git a/reference/ds/ds/set/union.xml b/reference/ds/ds/set/union.xml deleted file mode 100644 index cf3ed66dc4..0000000000 --- a/reference/ds/ds/set/union.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - Ds\Set::union - Crear un nuevo conjunto utilizando los valores de la instancia actual y de otro conjunto - - - - &reftitle.description; - - public Ds\SetDs\Set::union - Ds\Setset - - - Crear un nuevo conjunto que contiene los valores de la instancia actual así - como los valores de otro set. - - - A ∪ B = {x: x ∈ A ∨ x ∈ B} - - - - - &reftitle.parameters; - - - set - - - El otro conjunto, a combinar con la instancia actual. - - - - - - - - &reftitle.returnvalues; - - Un nuevo conjunto que contiene todos los valores de la instancia actual así como de otro set. - - - - - &reftitle.seealso; - - - Unión en Wikipedia - - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Set::union</function> - -union($b)); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) - [3]=> - int(4) - [4]=> - int(5) -} -]]> - - - - - - - diff --git a/reference/ds/ds/set/xor.xml b/reference/ds/ds/set/xor.xml deleted file mode 100644 index 1ab0979e8f..0000000000 --- a/reference/ds/ds/set/xor.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - Ds\Set::xor - Crear un nuevo conjunto utilizando los valores de la instancia actual o de otro conjunto, pero no de ambos - - - - &reftitle.description; - - public Ds\SetDs\Set::xor - Ds\Setset - - - Crear un nuevo conjunto que contiene los valores de la instancia actual - o de otro set, - - - A ⊖ B = {x : x ∈ (A \ B) ∪ (B \ A)} - - - - - &reftitle.parameters; - - - set - - - El otro conjunto. - - - - - - - - &reftitle.returnvalues; - - Un nuevo conjunto que contiene los valores de la instancia actual o de otro set, - pero no de ambos. - - - - - &reftitle.seealso; - - - Diferencia simétrica en Wikipedia - - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Set::xor</function> - -xor($b)); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(4) - [3]=> - int(5) -} -]]> - - - - - - - diff --git a/reference/ds/ds/stack/allocate.xml b/reference/ds/ds/stack/allocate.xml deleted file mode 100644 index d8e79a5a92..0000000000 --- a/reference/ds/ds/stack/allocate.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - Ds\Stack::allocate - Asigna suficiente memoria para una capacidad requerida - - - - &reftitle.description; - - public voidDs\Stack::allocate - intcapacity - - - Asegura que se asigne suficiente memoria para una capacidad requerida. - Esto elimina la necesidad de reasignar el búfer interno a medida que se añaden valores. - - - - - &reftitle.parameters; - - - capacity - - - El número de valores para los cuales se debe asignar la capacidad. - - - - La capacidad permanecerá igual si este valor es inferior o igual a la - capacidad actual. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/ds/ds/stack/capacity.xml b/reference/ds/ds/stack/capacity.xml deleted file mode 100644 index e2e49c5bd3..0000000000 --- a/reference/ds/ds/stack/capacity.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Ds\Stack::capacity - Devuelve la capacidad actual - - - - &reftitle.description; - - public intDs\Stack::capacity - - - - Devuelve la capacidad actual. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La capacidad actual. - - - - - - - diff --git a/reference/ds/ds/stack/clear.xml b/reference/ds/ds/stack/clear.xml deleted file mode 100644 index efb4efb122..0000000000 --- a/reference/ds/ds/stack/clear.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Ds\Stack::clear - Elimina todos los valores - - - - &reftitle.description; - - public voidDs\Stack::clear - - - - Elimina todos los valores de la pila. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Stack::clear</function> - -clear(); -print_r($stack); -?> -]]> - - &example.outputs.similar; - - 3 - [1] => 2 - [2] => 1 -) -Ds\Stack Object -( -) -]]> - - - - - - - diff --git a/reference/ds/ds/stack/construct.xml b/reference/ds/ds/stack/construct.xml deleted file mode 100644 index d30399c641..0000000000 --- a/reference/ds/ds/stack/construct.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Ds\Stack::__construct - Crear una nueva instancia - - - - &reftitle.description; - - public Ds\Stack::__construct - mixedvalues - - - Crear una nueva instancia, utilizando un objeto traversable - o un &array; para los values iniciales. - - - - - &reftitle.parameters; - - - values - - - Un objeto traversable o un &array; a utilizar para los valores iniciales. - - - - - - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Stack::__construct</function> - - -]]> - - &example.outputs.similar; - - 3 - [1] => 2 - [2] => 1 -) -]]> - - - - - - - diff --git a/reference/ds/ds/stack/copy.xml b/reference/ds/ds/stack/copy.xml deleted file mode 100644 index 9dc56cb42c..0000000000 --- a/reference/ds/ds/stack/copy.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - Ds\Stack::copy - Devuelve una copia superficial de la pila - - - - &reftitle.description; - - public Ds\StackDs\Stack::copy - - - - Devuelve una copia superficial de la pila. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una copia superficial de la pila. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Stack::copy</function> - -copy(); - -// Cambiar la copia no afecta al original -$b->push(4); - -print_r($a); -print_r($b); -?> -]]> - - &example.outputs.similar; - - 3 - [1] => 2 - [2] => 1 -) -Ds\Stack Object -( - [0] => 4 - [1] => 3 - [2] => 2 - [3] => 1 -) -]]> - - - - - - - diff --git a/reference/ds/ds/stack/count.xml b/reference/ds/ds/stack/count.xml deleted file mode 100644 index 51fc09e4c5..0000000000 --- a/reference/ds/ds/stack/count.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - - Ds\Stack::count - Devuelve el número de valores en la pila - - - - &reftitle.description; - - Ver Countable::count - - - - - - diff --git a/reference/ds/ds/stack/isempty.xml b/reference/ds/ds/stack/isempty.xml deleted file mode 100644 index f3ee4704bf..0000000000 --- a/reference/ds/ds/stack/isempty.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Ds\Stack::isEmpty - Indica si la pila está vacía - - - - &reftitle.description; - - public boolDs\Stack::isEmpty - - - - Indica si la pila está vacía. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si la pila está vacía, de lo contrario &false;. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Stack::isEmpty</function> - -isEmpty()); -var_dump($b->isEmpty()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/stack/jsonserialize.xml b/reference/ds/ds/stack/jsonserialize.xml deleted file mode 100644 index b55ff8b893..0000000000 --- a/reference/ds/ds/stack/jsonserialize.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - Ds\Stack::jsonSerialize - Devuelve una representación que puede ser convertida en JSON - - - - &reftitle.description; - - Ver JsonSerializable::jsonSerialize - - - - No debería ser necesario llamar a esto directamente. - - - - - - diff --git a/reference/ds/ds/stack/peek.xml b/reference/ds/ds/stack/peek.xml deleted file mode 100644 index a68ecfb763..0000000000 --- a/reference/ds/ds/stack/peek.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Ds\Stack::peek - Devuelve el valor en la parte superior de la pila - - - - &reftitle.description; - - public mixedDs\Stack::peek - - - - Devuelve el valor en la parte superior de la pila, pero no lo elimina. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El valor en la parte superior de la pila. - - - - - &reftitle.errors; - - UnderflowException si está vacía. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Stack::peek</function> - -push("a"); -$stack->push("b"); -$stack->push("c"); - -var_dump($stack->peek()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/stack/pop.xml b/reference/ds/ds/stack/pop.xml deleted file mode 100644 index 69e18c9780..0000000000 --- a/reference/ds/ds/stack/pop.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Ds\Stack::pop - Elimina y devuelve el valor en la parte superior de la pila - - - - &reftitle.description; - - public mixedDs\Stack::pop - - - - Elimina y devuelve el valor en la parte superior de la pila. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El valor eliminado que estaba en la parte superior de la pila. - - - - - &reftitle.errors; - - UnderflowException si está vacío. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Stack::pop</function> - -push("a"); -$stack->push("b"); -$stack->push("c"); - -var_dump($stack->pop()); -var_dump($stack->pop()); -var_dump($stack->pop()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/stack/push.xml b/reference/ds/ds/stack/push.xml deleted file mode 100644 index 9be483f918..0000000000 --- a/reference/ds/ds/stack/push.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - Ds\Stack::push - Añade valores a la pila - - - - &reftitle.description; - - public voidDs\Stack::push - mixedvalues - - - Añade los values a la pila. - - - - - - &reftitle.parameters; - - - values - - - Los valores a añadir a la pila. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Stack::push</function> - -push("a"); -$stack->push("b"); -$stack->push("c", "d"); -$stack->push(...["e", "f"]); - -print_r($stack); -?> -]]> - - &example.outputs.similar; - - a - [1] => b - [2] => c - [3] => d - [4] => e - [5] => f -) -]]> - - - - - - - diff --git a/reference/ds/ds/stack/toarray.xml b/reference/ds/ds/stack/toarray.xml deleted file mode 100644 index d76832ae89..0000000000 --- a/reference/ds/ds/stack/toarray.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Ds\Stack::toArray - - Convierte la pila en un &array; - - - - - &reftitle.description; - - public arrayDs\Stack::toArray - - - - Convierte la pila en un &array;. - - - - La conversión en &array; no está aún soportada. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un &array; que contiene todos los valores en el mismo orden que la pila. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Stack::toArray</function> - -toArray()); -?> -]]> - - &example.outputs.similar; - - - int(3) - [1]=> - int(2) - [2]=> - int(1) -} -]]> - - - - - - - diff --git a/reference/ds/ds/vector/allocate.xml b/reference/ds/ds/vector/allocate.xml deleted file mode 100644 index 401133db5b..0000000000 --- a/reference/ds/ds/vector/allocate.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - Ds\Vector::allocate - Asigna suficiente memoria para una capacidad requerida - - - - &reftitle.description; - - public voidDs\Vector::allocate - intcapacity - - - Asegura que se asigne suficiente memoria para una capacidad requerida. - Esto elimina la necesidad de reasignar el búfer interno a medida que se añaden valores. - - - - - &reftitle.parameters; - - - capacity - - - El número de valores para los cuales se debe asignar la capacidad. - - - - La capacidad permanecerá igual si este valor es inferior o igual a la - capacidad actual. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Vector::allocate</function> - -capacity()); - -$vector->allocate(100); -var_dump($vector->capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/vector/apply.xml b/reference/ds/ds/vector/apply.xml deleted file mode 100644 index 46180acc68..0000000000 --- a/reference/ds/ds/vector/apply.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - Ds\Vector::apply - Cambia todos los valores aplicando una función de retrollamada a cada valor - - - - &reftitle.description; - - public voidDs\Vector::apply - callablecallback - - - Cambia todos los valores aplicando un callback a - cada valor en el vector. - - - - - &reftitle.parameters; - - - callback - - - - - mixed - callback - mixedvalue - - - - Un callable a aplicar a cada valor del vector. - - - - La función de retrollamada debe devolver el valor por el cual debe ser reemplazado. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Vector::apply</function> - -apply(function($value) { return $value * 2; }); - -print_r($vector); -?> -]]> - - &example.outputs.similar; - - 2 - [1] => 4 - [2] => 6 -) -]]> - - - - - - - diff --git a/reference/ds/ds/vector/capacity.xml b/reference/ds/ds/vector/capacity.xml deleted file mode 100644 index 46e522dbdb..0000000000 --- a/reference/ds/ds/vector/capacity.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Ds\Vector::capacity - Devuelve la capacidad actual - - - - &reftitle.description; - - public intDs\Vector::capacity - - - - Devuelve la capacidad actual. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La capacidad actual. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Vector::capacity</function> - -capacity()); - -$vector->push(...range(1, 50)); -var_dump($vector->capacity()); - -$vector[] = "a"; -var_dump($vector->capacity()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/vector/clear.xml b/reference/ds/ds/vector/clear.xml deleted file mode 100644 index 7c50fd39b7..0000000000 --- a/reference/ds/ds/vector/clear.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Ds\Vector::clear - Elimina todos los valores - - - - &reftitle.description; - - public voidDs\Vector::clear - - - - Elimina todos los valores del vector. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Vector::clear</function> - -clear(); -print_r($vector); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 -) -Ds\Vector Object -( -) -]]> - - - - - - - diff --git a/reference/ds/ds/vector/construct.xml b/reference/ds/ds/vector/construct.xml deleted file mode 100644 index b3f6eefe44..0000000000 --- a/reference/ds/ds/vector/construct.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Ds\Vector::__construct - Crea una nueva instancia - - - - &reftitle.description; - - public Ds\Vector::__construct - mixedvalues - - - Crea una nueva instancia, utilizando un objeto traversable - o un &array; para los valores iniciales. - - - - - &reftitle.parameters; - - - values - - - Un objeto traversable o un &array; a utilizar para los valores iniciales. - - - - - - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Vector::__construct</function> - - -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - diff --git a/reference/ds/ds/vector/contains.xml b/reference/ds/ds/vector/contains.xml deleted file mode 100644 index 84249c1837..0000000000 --- a/reference/ds/ds/vector/contains.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - Ds\Vector::contains - Determina si el vector contiene valores dados - - - - &reftitle.description; - - public boolDs\Vector::contains - mixedvalues - - - Determina si el vector contiene todos los valores. - - - - - &reftitle.parameters; - - - values - - - Los valores a verificar. - - - - - - - - &reftitle.returnvalues; - - &false; si uno de los valores proporcionados no está en el - vector, de lo contrario &true;. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Vector::contains</function> - -contains('a')); // true -var_dump($vector->contains('a', 'b')); // true -var_dump($vector->contains('c', 'd')); // false - -var_dump($vector->contains(...['c', 'b', 'a'])); // true - -// Siempre estricto -var_dump($vector->contains(1)); // true -var_dump($vector->contains('1')); // false - -var_dump($vector->contains(...[])); // true -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/vector/copy.xml b/reference/ds/ds/vector/copy.xml deleted file mode 100644 index fca3086ceb..0000000000 --- a/reference/ds/ds/vector/copy.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - Ds\Vector::copy - Devuelve una copia superficial del vector - - - - &reftitle.description; - - public Ds\VectorDs\Vector::copy - - - - Devuelve una copia superficial del vector. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una copia superficial del vector. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Vector::copy</function> - -copy(); - -// Cambiar la copia no afecta al original -$b->push(4); - -print_r($a); -print_r($b); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 -) -Ds\Vector Object -( - [0] => 1 - [1] => 2 - [2] => 3 - [3] => 4 -) -]]> - - - - - - - diff --git a/reference/ds/ds/vector/count.xml b/reference/ds/ds/vector/count.xml deleted file mode 100644 index b4b74e0466..0000000000 --- a/reference/ds/ds/vector/count.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - - Ds\Vector::count - Devuelve el número de valores en la colección - - - - &reftitle.description; - - Ver Countable::count - - - - - - diff --git a/reference/ds/ds/vector/filter.xml b/reference/ds/ds/vector/filter.xml deleted file mode 100644 index 2229420e4a..0000000000 --- a/reference/ds/ds/vector/filter.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - Ds\Vector::filter - - Crear un nuevo vector utilizando un callable para - determinar qué valores incluir - - - - - &reftitle.description; - - public Ds\VectorDs\Vector::filter - callablecallback - - - Crear una nueva secuencia utilizando un callable para - determinar qué valores incluir. - - - - - &reftitle.parameters; - - - - callback - - - - - bool - callback - mixedvalue - - - - Un callable opcional que devuelve &true; si el par debe ser incluido, &false; en caso contrario. - - - Si no se proporciona ninguna función de retrollamada, solo se incluirán los valores que son &true; - (ver conversión en booléen). - - - - - - - - - &reftitle.returnvalues; - - Un nuevo vector que contiene todos los pares para los cuales - el callback ha devuelto &true;, o todos los valores que - se convierten en &true; si no se ha proporcionado un callback. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Vector::filter</function> con una función de retrollamada - -filter(function($value) { - return $value % 2 == 0; -})); -?> -]]> - - &example.outputs.similar; - - - int(2) - [1]=> - int(4) -} -]]> - - - - Ejemplo de <function>Ds\Vector::filter</function> sin función de retrollamada - -filter()); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - string(1) "a" - [2]=> - bool(true) -} -]]> - - - - - - - diff --git a/reference/ds/ds/vector/find.xml b/reference/ds/ds/vector/find.xml deleted file mode 100644 index a6b9ade146..0000000000 --- a/reference/ds/ds/vector/find.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - Ds\Vector::find - - Intenta encontrar el índice de un valor. - - - - - &reftitle.description; - - public mixedDs\Vector::find - mixedvalue - - - Devuelve el índice del valor, o &false; si no se encuentra. - - - - - - &reftitle.parameters; - - - value - - - El valor a encontrar. - - - - - - - - &reftitle.returnvalues; - - El índice del valor, o &false; si no se encuentra. - - - - Los valores serán comparados por valor y por tipo. - - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Vector::find</function> - -find("a")); // 0 -var_dump($vector->find("b")); // false -var_dump($vector->find("1")); // false -var_dump($vector->find(1)); // 1 -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/vector/first.xml b/reference/ds/ds/vector/first.xml deleted file mode 100644 index 971548c415..0000000000 --- a/reference/ds/ds/vector/first.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - Ds\Vector::first - Devuelve el primer valor en el vector - - - - &reftitle.description; - - public mixedDs\Vector::first - - - - Devuelve el primer valor en el vector. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El primer valor en el vector. - - - - - &reftitle.errors; - - UnderflowException si está vacío. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Vector::first</function> - -first()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/vector/get.xml b/reference/ds/ds/vector/get.xml deleted file mode 100644 index ba8e50537f..0000000000 --- a/reference/ds/ds/vector/get.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - Ds\Vector::get - Devuelve el valor en un índice dado - - - - &reftitle.description; - - public mixedDs\Vector::get - intindex - - - Devuelve el valor en un índice dado. - - - - - - &reftitle.parameters; - - - index - - - El índice al que se accede, comenzando en 0. - - - - - - - - &reftitle.returnvalues; - - El valor en el índice solicitado. - - - - - &reftitle.errors; - - OutOfRangeException si el índice no es válido. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Vector::get</function> - -get(0)); -var_dump($vector->get(1)); -var_dump($vector->get(2)); -?> -]]> - - &example.outputs.similar; - - - - - - Ejemplo de <function>Ds\Vector::get</function> utilizando la sintaxis de array - - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/vector/insert.xml b/reference/ds/ds/vector/insert.xml deleted file mode 100644 index df1675d935..0000000000 --- a/reference/ds/ds/vector/insert.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - Ds\Vector::insert - Inserta valores en un índice dado - - - - &reftitle.description; - - public voidDs\Vector::insert - intindex - mixedvalues - - - Inserta valores en el vector en un índice dado. - - - - - - &reftitle.parameters; - - - index - - - El índice en el cual insertar. 0 <= index <= count - - - - Es posible insertar en el índice igual al número de valores. - - - - - - values - - - El o los valores a insertar. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - OutOfRangeException si el índice no es válido. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Vector::insert</function> - -insert(0, "e"); // [e] -$vector->insert(1, "f"); // [e, f] -$vector->insert(2, "g"); // [e, f, g] -$vector->insert(0, "a", "b"); // [a, b, e, f, g] -$vector->insert(2, ...["c", "d"]); // [a, b, c, d, e, f, g] - -var_dump($vector); -?> -]]> - - &example.outputs.similar; - - - string(1) "a" - [1]=> - string(1) "b" - [2]=> - string(1) "c" - [3]=> - string(1) "d" - [4]=> - string(1) "e" - [5]=> - string(1) "f" - [6]=> - string(1) "g" -} -]]> - - - - - - - diff --git a/reference/ds/ds/vector/isempty.xml b/reference/ds/ds/vector/isempty.xml deleted file mode 100644 index d0fd554992..0000000000 --- a/reference/ds/ds/vector/isempty.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Ds\Vector::isEmpty - Indica si el vector está vacío - - - - &reftitle.description; - - public boolDs\Vector::isEmpty - - - - Indica si el vector está vacío. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si el vector está vacío, de lo contrario &false;. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Vector::isEmpty</function> - -isEmpty()); -var_dump($b->isEmpty()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/vector/join.xml b/reference/ds/ds/vector/join.xml deleted file mode 100644 index fefa0adda8..0000000000 --- a/reference/ds/ds/vector/join.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Ds\Vector::join - Reúne todos los valores en un string - - - - &reftitle.description; - - public stringDs\Vector::join - stringglue - - - Reúne todos los valores en un string utilizando un separador opcional entre cada valor. - - - - - &reftitle.parameters; - - - glue - - - Un string opcional para separar cada valor. - - - - - - - - &reftitle.returnvalues; - - Todos los valores de la secuencia reunidos en un string. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Vector::join</function> con un string separador - -join("|")); -?> -]]> - - &example.outputs.similar; - - - - - - Ejemplo de <function>Ds\Vector::join</function> sin string separador - -join()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/vector/jsonserialize.xml b/reference/ds/ds/vector/jsonserialize.xml deleted file mode 100644 index b85486795a..0000000000 --- a/reference/ds/ds/vector/jsonserialize.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - Ds\Vector::jsonSerialize - Devuelve una representación que puede ser convertida en JSON - - - - &reftitle.description; - - Ver JsonSerializable::jsonSerialize - - - - Nunca debería ser necesario llamar a esto directamente. - - - - - - - diff --git a/reference/ds/ds/vector/last.xml b/reference/ds/ds/vector/last.xml deleted file mode 100644 index bae2b544e8..0000000000 --- a/reference/ds/ds/vector/last.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - Ds\Vector::last - Devuelve el último valor - - - - &reftitle.description; - - public mixedDs\Vector::last - - - - Devuelve el último valor en el vector. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El último valor en el vector. - - - - - &reftitle.errors; - - UnderflowException si está vacío. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Vector::last</function> - -last()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/vector/map.xml b/reference/ds/ds/vector/map.xml deleted file mode 100644 index 1758315d90..0000000000 --- a/reference/ds/ds/vector/map.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - Ds\Vector::map - Devuelve el resultado de la aplicación de una retrollamada a cada valor - - - - &reftitle.description; - - public Ds\VectorDs\Vector::map - callablecallback - - - Devuelve el resultado de la aplicación de una callback a - cada valor del vector. - - - - - &reftitle.parameters; - - - callback - - - - - mixed - callback - mixedvalue - - - - Una retrollamada a aplicar a cada valor de la deque. - - - - La retrollamada debe tomar un argumento y devolver el nuevo valor. - - - - - - - - - &reftitle.returnvalues; - - El resultado de la aplicación de callback a cada valor - del vector. - - - - Los valores de la instancia actual no se verán afectados. - - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Vector::map</function> - -map(function($value) { return $value * 2; })); -print_r($vector); -?> -]]> - - &example.outputs.similar; - - 2 - [1] => 4 - [2] => 6 -) -Ds\Vector Object -( - [0] => 1 - [1] => 2 - [2] => 3 -) -]]> - - - - - - - diff --git a/reference/ds/ds/vector/merge.xml b/reference/ds/ds/vector/merge.xml deleted file mode 100644 index 47480e6618..0000000000 --- a/reference/ds/ds/vector/merge.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - Ds\Vector::merge - Devuelve el resultado de la adición de todos los valores dados al vector - - - - &reftitle.description; - - public Ds\VectorDs\Vector::merge - mixedvalues - - - Devuelve el resultado de la adición de todos los valores dados al vector. - - - - - - &reftitle.parameters; - - - values - - - Un objeto traversable o un &array;. - - - - - - - - &reftitle.returnvalues; - - El resultado de la adición de todos los valores dados al vector, - efectivamente el mismo que añadir los valores a una copia, y luego devolver esta copia. - - - - La instancia actual no será afectada. - - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Vector::merge</function> - -merge([4, 5, 6])); -var_dump($vector); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) - [3]=> - int(4) - [4]=> - int(5) - [5]=> - int(6) -} -object(Ds\Vector)#1 (3) { - [0]=> - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - diff --git a/reference/ds/ds/vector/pop.xml b/reference/ds/ds/vector/pop.xml deleted file mode 100644 index b21f1a493a..0000000000 --- a/reference/ds/ds/vector/pop.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Ds\Vector::pop - Elimina y devuelve el último valor - - - - &reftitle.description; - - public mixedDs\Vector::pop - - - - Elimina y devuelve el último valor. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El último elemento eliminado. - - - - - &reftitle.errors; - - UnderflowException si está vacío. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Vector::pop</function> - -pop()); -var_dump($vector->pop()); -var_dump($vector->pop()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/vector/push.xml b/reference/ds/ds/vector/push.xml deleted file mode 100644 index e6193e88c9..0000000000 --- a/reference/ds/ds/vector/push.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - Ds\Vector::push - Añade valores al final del vector - - - - &reftitle.description; - - public voidDs\Vector::push - mixedvalues - - - Añade valores al final del vector. - - - - - - &reftitle.parameters; - - - values - - - Los valores a añadir. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Vector::push</function> - -push("a"); -$vector->push("b"); -$vector->push("c", "d"); -$vector->push(...["e", "f"]); - -print_r($vector); -?> -]]> - - &example.outputs.similar; - - a - [1] => b - [2] => c - [3] => d - [4] => e - [5] => f -) -]]> - - - - - - - diff --git a/reference/ds/ds/vector/reduce.xml b/reference/ds/ds/vector/reduce.xml deleted file mode 100644 index 2d8ebb89d2..0000000000 --- a/reference/ds/ds/vector/reduce.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - Ds\Vector::reduce - Reduce el vector a un solo valor utilizando una retrollamada - - - - &reftitle.description; - - public mixedDs\Vector::reduce - callablecallback - mixedinitial - - - Reduce el vector a un solo valor utilizando una retrollamada. - - - - - - &reftitle.parameters; - - - callback - - - - mixedcallback - mixedcarry - mixedvalue - - - - carry - - - El valor de retorno de la retrollamada anterior, o initial si - es la primera iteración. - - - - - value - - - El valor de la iteración actual. - - - - - - - - - initial - - - El valor inicial del valor de retorno. Puede ser &null;. - - - - - - - - &reftitle.returnvalues; - - El valor de retorno de la retrollamada final. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Vector::reduce</function> con valor inicial - -reduce($callback, 5)); - -// Iteraciones: -// -// $carry = $initial = 5 -// -// $carry = $carry * 1 = 5 -// $carry = $carry * 2 = 10 -// $carry = $carry * 3 = 30 -?> -]]> - - &example.outputs.similar; - - - - - - Ejemplo de <function>Ds\Vector::reduce</function> sin valor inicial - -reduce(function($carry, $value) { - return $carry + $value + 5; -})); - -// Iteraciones: -// -// $carry = $initial = null -// -// $carry = $carry + 1 + 5 = 6 -// $carry = $carry + 2 + 5 = 13 -// $carry = $carry + 3 + 5 = 21 -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/vector/remove.xml b/reference/ds/ds/vector/remove.xml deleted file mode 100644 index ef04b777ba..0000000000 --- a/reference/ds/ds/vector/remove.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - Ds\Vector::remove - Elimina y devuelve un valor por índice - - - - &reftitle.description; - - public mixedDs\Vector::remove - intindex - - - Elimina y devuelve un valor por índice. - - - - - - &reftitle.parameters; - - - index - - - El índice del valor a eliminar. - - - - - - - - &reftitle.returnvalues; - - El valor que ha sido eliminado. - - - - - &reftitle.errors; - - OutOfRangeException si el índice no es válido. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Vector::remove</function> - -remove(1)); -var_dump($vector->remove(0)); -var_dump($vector->remove(0)); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/vector/reverse.xml b/reference/ds/ds/vector/reverse.xml deleted file mode 100644 index d1b84ddfe8..0000000000 --- a/reference/ds/ds/vector/reverse.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Ds\Vector::reverse - - Invertir el vector en su lugar - - - - - &reftitle.description; - - public voidDs\Vector::reverse - - - - Invierte el vector en su lugar. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Vector::reverse</function> - -reverse(); - -print_r($vector); -?> -]]> - - &example.outputs.similar; - - c - [1] => b - [2] => a -) -]]> - - - - - - - diff --git a/reference/ds/ds/vector/reversed.xml b/reference/ds/ds/vector/reversed.xml deleted file mode 100644 index 7b133a1eb8..0000000000 --- a/reference/ds/ds/vector/reversed.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - Ds\Vector::reversed - Devuelve una copia invertida - - - - &reftitle.description; - - public Ds\VectorDs\Vector::reversed - - - - Devuelve una copia invertida del vector. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Una copia invertida del vector. - - - - La instancia actual no se ve afectada. - - - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Vector::reversed</function> - -reversed()); -print_r($vector); -?> -]]> - - &example.outputs.similar; - - c - [1] => b - [2] => a -) -Ds\Vector Object -( - [0] => a - [1] => b - [2] => c -) -]]> - - - - - - - diff --git a/reference/ds/ds/vector/rotate.xml b/reference/ds/ds/vector/rotate.xml deleted file mode 100644 index b9d825d8ca..0000000000 --- a/reference/ds/ds/vector/rotate.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Ds\Vector::rotate - Rota el vector un cierto número de rotaciones - - - - &reftitle.description; - - public voidDs\Vector::rotate - introtations - - - Rota el vector un cierto número de rotaciones, lo que equivale a llamar sucesivamente - $vector->push($vector->shift()) si el número de rotaciones es positivo, o - $vector->unshift($vector->pop()) si es negativo. - - - - - - &reftitle.parameters; - - - rotations - - - El número de veces que el vector debe ser rotado. - - - - - - - - &reftitle.returnvalues; - - &return.void;. El vector de la instancia actual será rotado. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Vector::rotate</function> - -rotate(1); // "a" es desplazado, luego empujado. -print_r($vector); - -$vector->rotate(2); // ambos son desplazados, luego empujados. -print_r($vector); -?> -]]> - - &example.outputs.similar; - - b - [1] => c - [2] => d - [3] => a -) -Ds\Vector Object -( - [0] => d - [1] => a - [2] => b - [3] => c -) -]]> - - - - - - - diff --git a/reference/ds/ds/vector/set.xml b/reference/ds/ds/vector/set.xml deleted file mode 100644 index 9e3ec26edb..0000000000 --- a/reference/ds/ds/vector/set.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - Ds\Vector::set - Cambia un valor en un índice dado - - - - &reftitle.description; - - public voidDs\Vector::set - intindex - mixedvalue - - - Cambia un valor en un índice dado. - - - - - - &reftitle.parameters; - - - index - - - El índice del valor a actualizar. - - - - - value - - - El nuevo valor. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - OutOfRangeException si el índice no es válido. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Vector::set</function> - -set(1, "_"); -print_r($vector); -?> -]]> - - &example.outputs.similar; - - a - [1] => _ - [2] => c -) -]]> - - - - Ejemplo de <function>Ds\Vector::set</function> utilizando la sintaxis de array - - -]]> - - &example.outputs.similar; - - a - [1] => _ - [2] => c -) -]]> - - - - - - - diff --git a/reference/ds/ds/vector/shift.xml b/reference/ds/ds/vector/shift.xml deleted file mode 100644 index 16db1205f3..0000000000 --- a/reference/ds/ds/vector/shift.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Ds\Vector::shift - Elimina y devuelve el primer valor - - - - &reftitle.description; - - public mixedDs\Vector::shift - - - - Elimina y devuelve el primer valor. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El primer valor, que ha sido eliminado. - - - - - &reftitle.errors; - - UnderflowException si está vacío. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Vector::shift</function> - -shift()); -var_dump($vector->shift()); -var_dump($vector->shift()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/vector/slice.xml b/reference/ds/ds/vector/slice.xml deleted file mode 100644 index 23b14117c2..0000000000 --- a/reference/ds/ds/vector/slice.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - - Ds\Vector::slice - - Devuelve un sub-vector de un rango dado - - - - - &reftitle.description; - - public Ds\VectorDs\Vector::slice - intindex - intlength - - - Crea un sub-vector de un rango dado. - - - - - - &reftitle.parameters; - - - index - - - El índice en el que comienza el sub-vector. - - - Si es positivo, el sub-vector comenzará en este índice en el vector. - Si es negativo, el sub-vector comenzará a esta distancia del final. - - - - - length - - - Si se proporciona una longitud y es positiva, el sub-vector resultante - tendrá hasta ese número de valores. - - Si la longitud provoca un desbordamiento, solo - los valores hasta el final del vector serán incluidos. - - Si se proporciona una longitud y es negativa, el sub-vector - se detendrá a ese número de valores del final. - - Si no se proporciona una longitud, el sub-vector - contendrá todos los valores entre el índice y el - final del vector. - - - - - - - - &reftitle.returnvalues; - - Un sub-vector del rango dado. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Vector::slice</function> - -slice(2)); - -// Recorte a partir de 1, para una longitud de 3 -print_r($vector->slice(1, 3)); - -// Recorte a partir de 1 en adelante -print_r($vector->slice(1)); - -// Recorte a partir de 2 hacia atrás -print_r($vector->slice(-2)); - -// Recorte de 1 a 1 del final -print_r($vector->slice(1, -1)); -?> -]]> - - &example.outputs.similar; - - c - [1] => d - [2] => e -) -Ds\Vector Object -( - [0] => b - [1] => c - [2] => d -) -Ds\Vector Object -( - [0] => b - [1] => c - [2] => d - [3] => e -) -Ds\Vector Object -( - [0] => d - [1] => e -) -Ds\Vector Object -( - [0] => b - [1] => c - [2] => d -) - -]]> - - - - - - - diff --git a/reference/ds/ds/vector/sort.xml b/reference/ds/ds/vector/sort.xml deleted file mode 100644 index 09460e9188..0000000000 --- a/reference/ds/ds/vector/sort.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - Ds\Vector::sort - - Ordena el vector en su lugar - - - - - &reftitle.description; - - public voidDs\Vector::sort - callablecomparator - - - Ordena el vector en su lugar, utilizando una función comparator opcional. - - - - - - &reftitle.parameters; - - - comparator - - &sort.callback.description; - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Vector::sort</function> - -sort(); - -print_r($vector); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 - [3] => 4 - [4] => 5 -) -]]> - - - - Ejemplo de <function>Ds\Vector::sort</function> utilizando un comparador - -sort(function($a, $b) { - return $b <=> $a; -}); - -print_r($vector); -?> -]]> - - &example.outputs.similar; - - 5 - [1] => 4 - [2] => 3 - [3] => 2 - [4] => 1 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/vector/sorted.xml b/reference/ds/ds/vector/sorted.xml deleted file mode 100644 index a476c2bad6..0000000000 --- a/reference/ds/ds/vector/sorted.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - Ds\Vector::sorted - Devuelve una copia ordenada - - - - &reftitle.description; - - public Ds\VectorDs\Vector::sorted - callablecomparator - - - Devuelve una copia ordenada del vector, utilizando una función comparator opcional. - - - - - - &reftitle.parameters; - - - comparator - - &sort.callback.description; - - - - - - - &reftitle.returnvalues; - - Devuelve una copia ordenada del vector. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Vector::sorted</function> - -sorted()); -?> -]]> - - &example.outputs.similar; - - 1 - [1] => 2 - [2] => 3 - [3] => 4 - [4] => 5 -) -]]> - - - - Ejemplo de <function>Ds\Vector::sorted</function> utilizando un comparador - -sorted(function($a, $b) { - return $b <=> $a; -}); - -print_r($sorted); -?> -]]> - - &example.outputs.similar; - - 5 - [1] => 4 - [2] => 3 - [3] => 2 - [4] => 1 -) -]]> - - - - - - - - diff --git a/reference/ds/ds/vector/sum.xml b/reference/ds/ds/vector/sum.xml deleted file mode 100644 index 24fff6ec5b..0000000000 --- a/reference/ds/ds/vector/sum.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - Ds\Vector::sum - Devuelve la suma de todos los valores del vector - - - - &reftitle.description; - - public intfloatDs\Vector::sum - - - - Devuelve la suma de todos los valores del vector. - - - - Los arrays y los objetos se consideran iguales a cero durante el cálculo de la suma. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La suma de todos los valores del vector como float o int - dependiendo de los valores del vector. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Vector::sum</function> con un entero - -sum()); -?> -]]> - - &example.outputs.similar; - - - - - - Ejemplo de <function>Ds\Vector::sum</function> con un número de punto flotante - -sum()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/ds/ds/vector/toarray.xml b/reference/ds/ds/vector/toarray.xml deleted file mode 100644 index 47b98ec8fa..0000000000 --- a/reference/ds/ds/vector/toarray.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Ds\Vector::toArray - - Convierte el vector en &array; - - - - - &reftitle.description; - - public arrayDs\Vector::toArray - - - - Convierte el vector en un &array;. - - - - La conversión en &array; aún no es soportada. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un &array; que contiene todos los valores en el mismo orden que el vector. - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Vector::toArray</function> - -toArray()); -?> -]]> - - &example.outputs.similar; - - - int(1) - [1]=> - int(2) - [2]=> - int(3) -} -]]> - - - - - - - diff --git a/reference/ds/ds/vector/unshift.xml b/reference/ds/ds/vector/unshift.xml deleted file mode 100644 index 9049cf9754..0000000000 --- a/reference/ds/ds/vector/unshift.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Ds\Vector::unshift - Añade valores al inicio del vector - - - - &reftitle.description; - - public voidDs\Vector::unshift - mixedvalues - - - Añade valores al inicio del vector, desplazando todos los valores actuales - hacia adelante para hacer espacio para los nuevos valores. - - - - - - &reftitle.parameters; - - - values - - - Los valores a añadir al inicio del vector. - - - Múltiples valores pueden ser añadidos en el mismo orden en que son - pasados. - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>Ds\Vector::unshift</function> - -unshift("a"); -$vector->unshift("b", "c"); - -print_r($vector); -?> -]]> - - &example.outputs.similar; - - b - [1] => c - [2] => a - [3] => 1 - [4] => 2 - [5] => 3 -) -]]> - - - - - - - diff --git a/reference/ds/examples.xml b/reference/ds/examples.xml deleted file mode 100644 index 06167655de..0000000000 --- a/reference/ds/examples.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - &reftitle.examples; - - Vector - -push('a'); -$vector->push('b', 'c'); - -$vector[] = 'd'; - -print_r($vector); - -?> -]]> - - &example.outputs.similar; - - a - [1] => b - [2] => c - [3] => d -) -]]> - - - - Map - -put('a', 1); -$map->put('b', 2); - -$map['c'] = 3; - -print_r($map); - -?> -]]> - - &example.outputs.similar; - - Ds\Pair Object - ( - [key] => a - [value] => 1 - ) - - [1] => Ds\Pair Object - ( - [key] => b - [value] => 2 - ) - - [2] => Ds\Pair Object - ( - [key] => c - [value] => 3 - ) - -) -]]> - - - - - diff --git a/reference/ds/setup.xml b/reference/ds/setup.xml deleted file mode 100644 index 38b7588234..0000000000 --- a/reference/ds/setup.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - &reftitle.setup; - -
- &reftitle.required; - - PHP 7 es requerido por la extensión y el polyfill de compatibilidad. - -
- -
- &reftitle.install; - - La forma más sencilla de instalar la extensión es a través de PECL - - - - - - - Asimismo, se puede construir directamente a partir de la fuente: - - - - - - - - - - Si se utiliza Composer, se recomienda encarecidamente incluir - php-ds/php-ds - en el proyecto para que el código sea siempre funcional en un entorno donde la extensión - no esté instalada. La extensión tendrá prioridad si está instalada. - - -
- -
- - diff --git a/reference/eio/book.xml b/reference/eio/book.xml deleted file mode 100644 index 7dbc563e3e..0000000000 --- a/reference/eio/book.xml +++ /dev/null @@ -1,186 +0,0 @@ - - - - - - Eio - Eio - - - &reftitle.intro; - - Esta extensión proporciona E/S POSIX asíncrona a través de - la biblioteca de C libeio - escrita por Marc Lehmann. - - - ¬e.no-windows.extension; - - - - - - Es importante tener en cuenta que cada solicitud se ejecuta en un hilo, y el - orden de ejecución continua de peticiones en cola es basicamente - impredecible. Por ejemplo, el siguiente trozo de código es incorrecto. - - - - - Peticiones incorrectas - -]]> - - - - En el ejemplo de arriba la petición eio_rename puede finalizar - antes que eio_symlink. Para corregirlo se podría llamar a eio_rename - en la llamada de retorno de eio_symlink: - - Llamar a una petición desde una llamada de retorno de petición - - ]]> - - - - Alternativamente, podría querer crear un grupo de peticiones: - - - Llamar a una petición desde una llamada de retorno de petición - -]]> - - - El grupo es un tipo especial de peticion que podría acumular un conjunto de peticiones - eio regulares. Se podría usar para crear una petición - compleja para abrir, leer y cerrar un fichero. - - - Desde la versión 0.3.0 alfa, una variable usada internamete en las comunicaciones con - libeio, podía ser recuperada con - eio_get_event_stream. La variable se podría usar - para vincularse a un bucle de eventos soportado por alguna otra extensión. Se podría - organizar un sencillo bucle de eventos donde eio y libevent trabajaran juntos: - - Usar eio con libevent - -]]> - - - - - - &reference.eio.setup; - &reference.eio.constants; - &reference.eio.examples; - &reference.eio.reference; - - - diff --git a/reference/eio/configure.xml b/reference/eio/configure.xml deleted file mode 100644 index e7a46b09d1..0000000000 --- a/reference/eio/configure.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - -
- &reftitle.install; - - - &pecl.info; - &url.pecl.package;eio. - - - Para información sobre la instalación manual, - lea el fichero INSTALL incluido en el paquete. - - -
- diff --git a/reference/eio/constants.xml b/reference/eio/constants.xml deleted file mode 100644 index 073509d614..0000000000 --- a/reference/eio/constants.xml +++ /dev/null @@ -1,680 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - Constantes de prioridad de petición: - - - - - - EIO_PRI_MIN - (int) - - - - Prioridad de petición mínima. - - - - - - EIO_PRI_DEFAULT - (int) - - - - Prioridad de petición predeterminada. - - - - - - EIO_PRI_MAX - (int) - - - - Prioridad de petición máxima. - - - - - - - - El argumento whence de eio_seek: - - - - EIO_SEEK_SET - (int) - - - - El índice es establecido para espcificar el número de bytes (offset). - - - - - - EIO_SEEK_CUR - (int) - - - - El índice es establecido a su ubicación actual más offset bytes. - - - - - - EIO_SEEK_END - (int) - - - - El índice es establecido a el tamaño del fichero más offset bytes. - - - - - - - - Banderas usadas con eio_readdir: - - - - - - EIO_READDIR_DENTS - (int) - - - - Bandera eio_readdir. Si se especifica, el argumento resultante de la llamada de retorno - se convierte en un array con las siguientes claves: - 'names' - array de nombres de directorios - 'dents' - array de structura eio_dirent-como - los arrays pero teniendo las siguientes claves: - 'name' - el nombre del directorio; - 'type' - una de las constantes - EIO_DT_*; - 'inode' - el número de inodo, si está disponible, de otro modo - sin especificar. - - - - - - EIO_READDIR_DIRS_FIRST - (int) - - - - Cuando se especifica esta bandera, los nombres serán devueltos en un orden - donde probablemente los directorios vallan primero, en un orden de estadísticas óptimo. - - - - - - EIO_READDIR_STAT_ORDER - (int) - - - - Cuando se especifica esta bandera, los nombres serán devueltos en un orden - apropiado para realizar estadísticas (stat) con cada uno. Cuando se planea usar - la función stat para realizar estadísticas de todos los archivos del directorio dado, el - orden devuelto probablemente sea - más rápido. - - - - - - EIO_READDIR_FOUND_UNKNOWN - (int) - - - - - - - - - - - - - EIO_DT_UNKNOWN - (int) - - - - Tipo de nodo desconocido (muy común). Se necistan más estadísticas (stat). - - - - - - EIO_DT_FIFO - (int) - - - - Tipo de nodo FIFO. - - - - - - EIO_DT_CHR - (int) - - - - Tipo de nodo. - - - - - - EIO_DT_MPC - (int) - - - - Tipo de nodo de dispositivo de caracteres multiplexado (v7+coherent). - - - - - - EIO_DT_DIR - (int) - - - - Tipo de nodo de directorio. - - - - - - EIO_DT_NAM - (int) - - - - Tipo de nodo de fichero Xenix nominado especial. - - - - - - EIO_DT_BLK - (int) - - - - Tipo de nodo. - - - - - - EIO_DT_MPB - (int) - - - - Dispositivo de bloqueo multiplexado (v7+coherent). - - - - - - EIO_DT_REG - (int) - - - - Tipo de nodo. - - - - - - EIO_DT_NWK - (int) - - - - - - - - - EIO_DT_CMP - (int) - - - - Tipo de nodo especial de red HP-UX. - - - - - - EIO_DT_LNK - (int) - - - - Tipo de nodo de vínculo. - - - - - - EIO_DT_SOCK - (int) - - - - Tipo de nodo socket. - - - - - - EIO_DT_DOOR - (int) - - - - Tipo de nodo de puerta de Solaris. - - - - - - EIO_DT_WHT - (int) - - - - Tipo de nodo. - - - - - - EIO_DT_MAX - (int) - - - - Valor de tipo de nodo más alto. - - - - - - - - - - Modo de acceso para el argumento flags de - eio_open: - - - - - - EIO_O_RDONLY - (int) - - - - - - - - - EIO_O_WRONLY - (int) - - - - - - - - - EIO_O_RDWR - (int) - - - - - - - - - EIO_O_NONBLOCK - (int) - - - - - - - - - EIO_O_APPEND - (int) - - - - - - - - - EIO_O_CREAT - (int) - - - - - - - - - EIO_O_TRUNC - (int) - - - - - - - - - EIO_O_EXCL - (int) - - - - - - - - - EIO_O_FSYNC - (int) - - - - - - - - - - - - Banderas del argumento mode de eio_open: - - - - - - EIO_S_IRUSR - (int) - - - - - - - - - EIO_S_IWUSR - (int) - - - - - - - - - EIO_S_IXUSR - (int) - - - - - - - - - EIO_S_IRGRP - (int) - - - - - - - - - EIO_S_IWGRP - (int) - - - - - - - - - EIO_S_IXGRP - (int) - - - - - - - - - EIO_S_IROTH - (int) - - - - - - - - - EIO_S_IWOTH - (int) - - - - - - - - - EIO_S_IXOTH - (int) - - - - - - - - - EIO_S_IFREG - (int) - - - - - - - - - EIO_S_IFCHR - (int) - - - - - - - - - EIO_S_IFBLK - (int) - - - - - - - - - EIO_S_IFIFO - (int) - - - - - - - - - EIO_S_IFSOCK - (int) - - - - - - - - - - - - - Banderas de eio_sync_file_range: - - - - - - EIO_SYNC_FILE_RANGE_WAIT_BEFORE - (int) - - - - - - - - - EIO_SYNC_FILE_RANGE_WRITE - (int) - - - - - - - - - EIO_SYNC_FILE_RANGE_WAIT_AFTER - (int) - - - - - - - - - - - - - Banderas de eio_fallocate: - - - - - EIO_FALLOC_FL_KEEP_SIZE - (int) - - - - - - - - - - - - - Las constantes EIO_S_I* tienen el mismo significado que sus - homónimos S_I* de POSIX. - - - - - - EIO_SYNC_FILE_*tienen el mismo significado que sus - homónimos SYNC_FILE_**. - - - - - - EIO_O_*tienen el mismo significado que sus - homónimos O_*de POSIX. - - - - diff --git a/reference/eio/examples.xml b/reference/eio/examples.xml deleted file mode 100644 index 423d873ca4..0000000000 --- a/reference/eio/examples.xml +++ /dev/null @@ -1,304 +0,0 @@ - - - - - - &reftitle.examples; - - Cancelar una petición - - -]]> - - &example.outputs.similar; - - - - - - - Llamar a <function>eio_chmod</function> - - -]]> - - &example.outputs.similar; - - - - - - - Realizar una petición personalizada - - 1001, - 'data_modified' => "mis datos personalizados", - ); - - return $resultado; -} - -$datos = "mis_datos_personalizados"; -$petición = eio_custom("mi_personalizada", EIO_PRI_DEFAULT, "mi_llamada_retorno_personalizada", $datos); -var_dump($petición); -eio_event_loop(); -?> -]]> - - &example.outputs.similar; - - - - - - - - Agrupar peticiones - - 0); - - // Crear una petición eio_read() y añadirla al grupo - $petición = eio_read($mi_df_fichero, 4, 0, EIO_PRI_DEFAULT, "mi_grupo_llamada_retorno_fichero_leído"); - eio_grp_add($grupo, $petición); -} - -/* Se llama cuando eio_read() termina */ -function mi_grupo_llamada_retorno_fichero_leído($datos, $resultado) { - global $mi_df_fichero, $grupo; - - var_dump($resultado); - - // Crear una petición eio_close() y añadirla al grupo - $petición = eio_close($mi_df_fichero); - eio_grp_add($grupo, $petición); -} - -$grupo = eio_grp("mi_grupo_hecho", "mis_datos_grupo"); - -// Crear una petición eio_open() y añadirla al grupo -$petición = eio_open($nombre_fichero_temp, EIO_O_RDWR | EIO_O_APPEND , NULL, - EIO_PRI_DEFAULT, "mi_grupo_llamada_retorno_fichero_abierto", NULL); -eio_grp_add($grupo, $petición); -var_dump($grupo); - -eio_event_loop(); -?> -]]> - - &example.outputs.similar; - - - - - - - - Emplear eio con la extensión libevent - -]]> - - &example.outputs.similar; - - - - - - - Emplear eio con la extensión event -add(); - -// Añadir trabajos de eio -eio_nop(EIO_PRI_DEFAULT, function () { - echo "eio_nop\n"; -}); - -// Añadir eventos -$timer = Event::timer($base, function () { - echo "2 segundos transcurridos\n"; -}); -$timer->add(2); - -// Despachar eventos. -$base->dispatch(); -?> -]]> - - &example.outputs.similar; - - - - - - - diff --git a/reference/eio/functions/eio-busy.xml b/reference/eio/functions/eio-busy.xml deleted file mode 100644 index ec5b041085..0000000000 --- a/reference/eio/functions/eio-busy.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - eio_busy - Incrementar artificialmente la carga. Podría ser útil en pruebas, - evaluaciones comparativas - - - - &reftitle.description; - - resourceeio_busy - intdelay - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_busy incrementa artificialmente la carga tomanto - delay segundos para ejecutarse. Puede usarse para depuración, - o evaluaciones comparativas. - - - - - &reftitle.parameters; - - - delay - - - Retraso en segundos - - - - - pri - - &eio.request.pri.values; - - - - callback - - - Esta llamada de retorno se llama cuando está hecho todo el grupo de peticiones. - - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - eio_busy devuelve un recurso de petición en caso de éxito,&return.falseforfailure;. - - - - &reftitle.seealso; - - eio_nop - - - - - diff --git a/reference/eio/functions/eio-cancel.xml b/reference/eio/functions/eio-cancel.xml deleted file mode 100644 index 48037147b9..0000000000 --- a/reference/eio/functions/eio-cancel.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - - eio_cancel - Cancelar una petición - - - - &reftitle.description; - - voideio_cancel - resourcereq - - - eio_cancel cancela una petición especificada por - req - - - - - &reftitle.parameters; - - - req - - - El recurso de petición - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>eio_cancel</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - eio_grp_cancel - - - - - diff --git a/reference/eio/functions/eio-chmod.xml b/reference/eio/functions/eio-chmod.xml deleted file mode 100644 index 702da7d9c9..0000000000 --- a/reference/eio/functions/eio-chmod.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - eio_chmod - Cambiar los permisos de fichero/directorio - - - - &reftitle.description; - - resourceeio_chmod - stringpath - intmode - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_chmod cambia los permisos de un fichero o directorio. Los - nuevos permisos son especificados mediandte mode. - - - - - - &reftitle.parameters; - - - path - - - La ruta al fichero o directorio objetivo - - &eio.warn.relpath; - - - - mode - - - Los nuevos permisos. P.ej. 0644. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - eio_chmod devuelve un recurso de petición en caso de éxito,&return.falseforfailure;. - - - - - &reftitle.seealso; - - eio_chown - - - - - diff --git a/reference/eio/functions/eio-chown.xml b/reference/eio/functions/eio-chown.xml deleted file mode 100644 index 5bc2d087ce..0000000000 --- a/reference/eio/functions/eio-chown.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - eio_chown - Cambiar el propietario de un fichero/directorio - - - - &reftitle.description; - - resourceeio_chown - stringpath - intuid - intgid-1 - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_chown cambia el propietario de un fichero o directorio. - El nuevo propietario es especificado por uid, y el grupo - por gid. - - - - - &reftitle.parameters; - - - path - - - La ruta al fichero o directorio. - - &eio.warn.relpath; - - - - uid - - - El ID de usuario. Se ignora si es aigual a -1. - - - - - gid - - - El ID de grupo. Se ignora si es aigual a -1. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - eio_chown devuelve un recurso de petición en caso de éxito,&return.falseforfailure;. - - - - - - &reftitle.seealso; - - eio_chmod - - - - - diff --git a/reference/eio/functions/eio-close.xml b/reference/eio/functions/eio-close.xml deleted file mode 100644 index 9bcf02c767..0000000000 --- a/reference/eio/functions/eio-close.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - eio_close - Cerrar un fichero - - - - &reftitle.description; - - resourceeio_close - mixedfd - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_close cierra el fichero especificado por - fd. - - - - - - &reftitle.parameters; - - - fd - - - Un flujo, un recurso Socket, o un descriptor numérico de fichero. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - eio_close devuelve un recurso de petición en caso de éxito,&return.falseforfailure;. - - - - - &reftitle.seealso; - - eio_open - - - - - diff --git a/reference/eio/functions/eio-custom.xml b/reference/eio/functions/eio-custom.xml deleted file mode 100644 index 9347beb1b2..0000000000 --- a/reference/eio/functions/eio-custom.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - - eio_custom - Ejecutar una petición personalizada como cualquier otra llamada eio_* - - - - &reftitle.description; - - resourceeio_custom - callableexecute - intpri - callablecallback - mixeddataNULL - - - eio_custom ejecuta una función personalizada especificada por - execute procesándola igual que cualquier otra llamada eio_*. - - - - - - - &reftitle.parameters; - - - execute - - - Especifica la función de petición que debería coincidir con el siguiente prototipo: - - - callback es una llamada de retorno de finalización de evento que debería coincidir con el siguiente - prototipo: - - - data son los datos pasados a - execute mediante el argumento data - sin modificaciones - result valor devuelto por execute - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - eio_custom devuelve un recurso de petición en caso de éxito,&return.falseforfailure;. - - - - - - - &reftitle.examples; - - Ejemplo de <function>eio_custom</function> - - 1001, - 'datos_modificados' => "mis datos personalizados", - ); - - return $resultado; -} - -$datos = "mis_datos_personalizados"; -$petición = eio_custom("mi_personalizada", EIO_PRI_DEFAULT, "mi_llamada_retorno_personalizada", $datos); -var_dump($petición); -eio_event_loop(); -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/eio/functions/eio-dup2.xml b/reference/eio/functions/eio-dup2.xml deleted file mode 100644 index 01f6928ebf..0000000000 --- a/reference/eio/functions/eio-dup2.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - eio_dup2 - Duplicar un descriptor de fichero - - - - &reftitle.description; - - resourceeio_dup2 - mixedfd - mixedfd2 - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - - eio_dup2 duplica un descriptor de fichero. - - - - - - &reftitle.parameters; - - - fd - - - Un flujo, un recurso Socket, o un descriptor de fichero numérico origen - - - - - fd2 - - - Un flujo, un recurso Socket, o un descriptor de fichero numérico objetivo - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - eio_dup2 devuelve un recurso de petición en caso de éxito,&return.falseforfailure;. - - - - - diff --git a/reference/eio/functions/eio-event-loop.xml b/reference/eio/functions/eio-event-loop.xml deleted file mode 100644 index fb38094e8c..0000000000 --- a/reference/eio/functions/eio-event-loop.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - eio_event_loop - Monitorizar libeio hasta que todas las peticiones sean procesadas - - - - &reftitle.description; - - booleio_event_loop - - - - eio_event_loop monitoriza libeio hasta que todas las peticiones sean procesadas. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - eio_event_loop devuelve &true; en caso de éxito,&return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo de <function>eio_event_loop</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - - &reftitle.seealso; - - eio_poll - - - - - diff --git a/reference/eio/functions/eio-fallocate.xml b/reference/eio/functions/eio-fallocate.xml deleted file mode 100644 index b0c281b9c7..0000000000 --- a/reference/eio/functions/eio-fallocate.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - eio_fallocate - Permitir al llamador manipular directamente el espacio de disco - asignado a un fichero - - - - &reftitle.description; - - resourceeio_fallocate - mixedfd - intmode - intoffset - intlength - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - - - eio_fallocate permite al llamador manipular directamente el espacio de disco asignado al - fichero especificado por el descriptor de fichero fd para el rango de bytes - empezando por offset y continuando - length bytes. - - - - El fichero debería abrirse para lectura - Se debería usar OR entre - EIO_O_CREAT y - EIO_O_WRONLY o EIO_O_RDWR - - - - - - - &reftitle.parameters; - - - fd - - - Un flujo, un recurso Socket, o un descriptor numérico de fichero, p.ej., devuelto por eio_open. - - - - - mode - - Actualmente sólo está soportada una bandera para el modo: - EIO_FALLOC_FL_KEEP_SIZE (lo mismo que la constante POSIX - FALLOC_FL_KEEP_SIZE). - - - - - offset - - - Especifica el inicio del rango de bytes. - - - - - length - - - Especifica la longitud del rango de bytes. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - eio_fallocate devuelve un recurso de petición en caso de éxito,&return.falseforfailure;. - - - - - diff --git a/reference/eio/functions/eio-fchmod.xml b/reference/eio/functions/eio-fchmod.xml deleted file mode 100644 index 7f0a0d0d0e..0000000000 --- a/reference/eio/functions/eio-fchmod.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - eio_fchmod - Cambiar los permisos de un fichero - - - - &reftitle.description; - - resourceeio_fchmod - mixedfd - intmode - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_fchmod cambia los permisos del fichero especificado - por el descriptor de fichero fd. - - - - - - &reftitle.parameters; - - - fd - - - Un flujo, un recurso Socket, o un descriptor numérico de fichero, p.ej., devuelto por eio_open. - - - - - mode - - - Los nuevos permisos. P.ej. 0644. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - eio_fchmod devuelve un recurso de petición en caso de éxito,&return.falseforfailure;. - - - - - &reftitle.seealso; - - eio_fchown - - - - - diff --git a/reference/eio/functions/eio-fchown.xml b/reference/eio/functions/eio-fchown.xml deleted file mode 100644 index 82c449770d..0000000000 --- a/reference/eio/functions/eio-fchown.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - eio_fchown - Cambiar el propietario del fichero - - - - &reftitle.description; - - resourceeio_fchown - mixedfd - intuid - intgid-1 - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_fchown cambia el propietario del fichero especificado por - el descriptor de fichero fd. - - - - - - &reftitle.parameters; - - - fd - - - Un flujo, un recurso Socket, o un descriptor numérico de fichero. - - - - - uid - - - El ID de ususario. Se ignora si es igual a -1. - - - - - gid - - - El ID de grupo. Se ignora si es igual a -1. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - eio_fchown devuelve un recurso de petición en caso de éxito,&return.falseforfailure;. - - - - - &reftitle.seealso; - - eio_fchmod - - - - - diff --git a/reference/eio/functions/eio-fdatasync.xml b/reference/eio/functions/eio-fdatasync.xml deleted file mode 100644 index 02154e4564..0000000000 --- a/reference/eio/functions/eio-fdatasync.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - eio_fdatasync - Sincronizar el estado de ficheros que están en memoria con un dispositivo de almacenamiento - - - - &reftitle.description; - - resourceeio_fdatasync - mixedfd - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_fdatasync sincroniza el estado de ficheros que están en memoria con un dispositivo de almacenamiento. - - - - - - &reftitle.parameters; - - - fd - - - Un flujo, un recurso Socket, o un descriptor numérico de fichero, p.ej., devuelto por eio_open. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - eio_fdatasync devuelve un recurso de petición en caso de éxito,&return.falseforfailure;. - - - - - diff --git a/reference/eio/functions/eio-fstat.xml b/reference/eio/functions/eio-fstat.xml deleted file mode 100644 index e736fea44a..0000000000 --- a/reference/eio/functions/eio-fstat.xml +++ /dev/null @@ -1,174 +0,0 @@ - - - - - eio_fstat - Obtener el estado de un fichero - - - - &reftitle.description; - - resourceeio_fstat - mixedfd - intpri - callablecallback - mixeddata - - - eio_fstat devuelve la información del estado de un fichero en - el argumento result de callback - - - - - - &reftitle.parameters; - - - fd - - - Un flujo, un recurso Socket, o un descriptor numérico de fichero. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - eio_fstat devuelve un recurso de petición en caso de éxito,&return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo de <function>eio_fstat</function> - - $resultado, - 'file'=> $datos - ); - // Solicitar la información de las estadísticas - eio_fstat($resultado, EIO_PRI_DEFAULT, "my_res_cb", $d); - // Procesar la/s petición/es - eio_event_loop(); -} - -// Abrir el fichero temporal -eio_open($nombre_fichero_temp, EIO_O_RDONLY, NULL, EIO_PRI_DEFAULT, - "my_open_cb", $nombre_fichero_temp); -eio_event_loop(); -?> -]]> - - &example.outputs.similar; - - - int(2050) - ["st_ino"]=> - int(2489159) - ["st_mode"]=> - int(33188) - ["st_nlink"]=> - int(1) - ["st_uid"]=> - int(1000) - ["st_gid"]=> - int(100) - ["st_rdev"]=> - int(0) - ["st_blksize"]=> - int(4096) - ["st_blocks"]=> - int(0) - ["st_atime"]=> - int(1318239506) - ["st_mtime"]=> - int(1318239506) - ["st_ctime"]=> - int(1318239506) -} -]]> - - - - - - - &reftitle.seealso; - - eio_lstat - eio_stat - - - - - diff --git a/reference/eio/functions/eio-fstatvfs.xml b/reference/eio/functions/eio-fstatvfs.xml deleted file mode 100644 index 209c981bff..0000000000 --- a/reference/eio/functions/eio-fstatvfs.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - eio_fstatvfs - Obtener las estadísticas del sistema de ficheros - - - - &reftitle.description; - - resourceeio_fstatvfs - mixedfd - intpri - callablecallback - mixeddata - - - eio_fstatvfs devuelve las estadísticas del sistema de ficheros en - el parámetro result de callback. - - - - - - &reftitle.parameters; - - - fd - - - Un descriptor de fichero de un fichero del sistema de ficheros abierto. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - eio_fstatvfs devuelve un recurso de petición en caso de éxito,&return.falseforfailure;. - - - - - &reftitle.seealso; - - eio_statvfs - - - - - diff --git a/reference/eio/functions/eio-fsync.xml b/reference/eio/functions/eio-fsync.xml deleted file mode 100644 index 4d911a893c..0000000000 --- a/reference/eio/functions/eio-fsync.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - eio_fsync - Sincronizar el estado de un fichero en memoria con un dispositivo de almacenamiento - - - - &reftitle.description; - - resourceeio_fsync - mixedfd - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - Sincroniza el estado de un fichero en memoria con un dispositivo de almacenamiento - - - - - - &reftitle.parameters; - - - fd - - - Un flujo, un recurso Socket, o un descriptor numérico de fichero. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - eio_fsync devuelve un recurso de petición en caso de éxito,&return.falseforfailure;. - - - - - - &reftitle.seealso; - - eio_sync - - - - - diff --git a/reference/eio/functions/eio-ftruncate.xml b/reference/eio/functions/eio-ftruncate.xml deleted file mode 100644 index 1764f235c3..0000000000 --- a/reference/eio/functions/eio-ftruncate.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - eio_ftruncate - Truncar un fichero - - - - &reftitle.description; - - resourceeio_ftruncate - mixedfd - intoffset0 - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_ftruncate hace que un fichero regular referenciado por - el descriptor de fichero fd sea truncado a exactamente - length bytes. - - - - - - &reftitle.parameters; - - - fd - - - Un flujo, un recurso Socket, o un descriptor numérico de fichero. - - - - - offset - - - Índice desde el principio del fichero. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - eio_ftruncate devuelve un recurso de petición en caso de éxito,&return.falseforfailure;. - - - - - - &reftitle.seealso; - - eio_truncate - - - - - diff --git a/reference/eio/functions/eio-futime.xml b/reference/eio/functions/eio-futime.xml deleted file mode 100644 index 0aee311456..0000000000 --- a/reference/eio/functions/eio-futime.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - eio_futime - Cambiar los momentos de último y acceso y modificación de un fichero - - - - &reftitle.description; - - resourceeio_futime - mixedfd - floatatime - floatmtime - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - - eio_futime cambia los momentos de último acceso y modificación de un - fichero. - - - - - - &reftitle.parameters; - - - fd - - - Un flujo, un recurso Socket, o un descriptor numérico de fichero, p.ej., devuelto por eio_open. - - - - - atime - - - Momento de acceso - - - - - mtime - - - Momento de modificación - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - eio_futime devuelve un recurso de petición en caso de éxito,&return.falseforfailure;. - - - - - &reftitle.seealso; - - eio_utime - - - - - diff --git a/reference/eio/functions/eio-get-event-stream.xml b/reference/eio/functions/eio-get-event-stream.xml deleted file mode 100644 index 99a959c4c7..0000000000 --- a/reference/eio/functions/eio-get-event-stream.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - eio_get_event_stream - Obtiene un flujo que representa una variable usada en comnunicaciones internas con libeio - - - - &reftitle.description; - - mixedeio_get_event_stream - - - - eio_get_event_stream adquiere un flujo que representa una - variable usada en comunicaciones internas con libeio. Se podría usar para vinculaciones - con algún bucle de eventos proporcionado por otra extensión PECL, por ejemplo - libevent. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - eio_get_event_stream devuelve un flujo en caso de éxito; - de otro modo devuelve &null; - - - - - &reftitle.examples; - - Usar eio con libevent - - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/eio/functions/eio-get-last-error.xml b/reference/eio/functions/eio-get-last-error.xml deleted file mode 100644 index 0aa6a01174..0000000000 --- a/reference/eio/functions/eio-get-last-error.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - eio_get_last_error - Retorna un string describiendo el último error asociado con el recurso solicitado - - - - &reftitle.description; - - stringeio_get_last_error - resourcereq - - - eio_get_last_error retorna un string describiendo el último error asociado con el argumento - req. - - - - - &reftitle.parameters; - - - req - - - El recurso solicitado. - - - - - - - - &reftitle.returnvalues; - - eio_get_last_error retorna un string describiendo el último error con el recurso solicitado - especificado por el argumento req. - - &warn.experimental.func; - - - diff --git a/reference/eio/functions/eio-grp-add.xml b/reference/eio/functions/eio-grp-add.xml deleted file mode 100644 index 645d00696c..0000000000 --- a/reference/eio/functions/eio-grp-add.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - - eio_grp_add - Añadir una petición al grupo de peticiones - - - - &reftitle.description; - - voideio_grp_add - resourcegrp - resourcereq - - - eio_grp_add añade una petición al grupo de peticiones. - - - - - - &reftitle.parameters; - - - grp - - - El recurso de grupo de peticiones devuelto por eio_grp - - - - - req - - - El recurso de petición - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Agrupar peticiones - 0); - - // Crear una petición eio_read() y añadirla al grupo - // Pasar el descriptor del fichero a la llamada de retorno - $petición = eio_read($resultado, 4, 0, - EIO_PRI_DEFAULT, "mi_llamada_retorno_grupo_fichero_leído", $resultado); - eio_grp_add($grupo, $petición); -} - -/* Es llamada cuando eio_read() termina */ -function mi_llamada_retorno_grupo_fichero_leído($datos, $resultado) { - global $grupo; - - // Leer bytes - var_dump($resultado); - - // Crear una petición eio_close() y añadirla al grupo - // $datos debería contener el descriptor del fichero - $petición = eio_close($datos); - eio_grp_add($grupo, $petición); -} - -// Crear un grupo de peticiones -$grupo = eio_grp("mi_grupo_hecho", $nombre_fichero_temp); -var_dump($grupo); - -// Crear una petición eio_open() y añadirla al grupo -$petición = eio_open($nombre_fichero_temp, EIO_O_RDWR | EIO_O_APPEND , NULL, - EIO_PRI_DEFAULT, "mi_llamada_retorno_fichero_abierto", NULL); -eio_grp_add($grupo, $petición); - -// Procesar las peticiones -eio_event_loop(); -?> -]]> - &example.outputs.similar; - - - - - - &reftitle.seealso; - - eio_grp - eio_grp_cancel - eio_grp_limit - - - - - diff --git a/reference/eio/functions/eio-grp-cancel.xml b/reference/eio/functions/eio-grp-cancel.xml deleted file mode 100644 index b90c296320..0000000000 --- a/reference/eio/functions/eio-grp-cancel.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - eio_grp_cancel - Cancelar un grupo de peticiones - - - - &reftitle.description; - - voideio_grp_cancel - resourcegrp - - - eio_grp_cancel cancela un grupo de peticiones especificadas por - el recurso de grupo de peticiones grp. - - - - - - &reftitle.parameters; - - - grp - - - El recurso de grupo de peticiones devuelto por eio_grp. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - eio_grp - eio_grp_add - - - - - diff --git a/reference/eio/functions/eio-grp-limit.xml b/reference/eio/functions/eio-grp-limit.xml deleted file mode 100644 index 130ad7e595..0000000000 --- a/reference/eio/functions/eio-grp-limit.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - eio_grp_limit - Establecer el límite de un grupo - - - - &reftitle.description; - - voideio_grp_limit - resourcegrp - intlimit - - - Número límite de peticiones en un grupo de peticiones. - - - - - - &reftitle.parameters; - - - grp - - - El recurso de grupo de peticiones. - - - - - limit - - - El número de peticiones del grupo. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - eio_grp_add - - - - - diff --git a/reference/eio/functions/eio-grp.xml b/reference/eio/functions/eio-grp.xml deleted file mode 100644 index 4d079cb3ec..0000000000 --- a/reference/eio/functions/eio-grp.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - - eio_grp - Crear un grupo de peticiones - - - - &reftitle.description; - - resourceeio_grp - callablecallback - stringdataNULL - - - eio_grp crea un grupo de peticiones. - - - - - - &reftitle.parameters; - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - eio_grp devuelve un recurso de grupo de peticiones en caso de éxito,&return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo de <function>eio_grp</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - eio_grp_cancel - eio_grp_add - - - - - diff --git a/reference/eio/functions/eio-init.xml b/reference/eio/functions/eio-init.xml deleted file mode 100644 index a9cf55fd0c..0000000000 --- a/reference/eio/functions/eio-init.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - eio_init - (Re-)inicializa Eio - - - - &reftitle.description; - - voideio_init - - - - eio_init (re-)inicializa Eio. Asigna memoria para estructuras internas de libeio y Eio. Se puede llamar a eio_init antes de usar las funciones de Eio. De otro modo, será invocada internamente la primera vez que se invoque a una función de Eio en un proceso. - - - - Esta función fue eliminada en la versión 3.0.0RC1 de la extensión eio para PHP versión 8 y superiores. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/eio/functions/eio-link.xml b/reference/eio/functions/eio-link.xml deleted file mode 100644 index fc79c3ce32..0000000000 --- a/reference/eio/functions/eio-link.xml +++ /dev/null @@ -1,160 +0,0 @@ - - - - - - - eio_link - Crear un enlace duro par un fichero - - - - &reftitle.description; - - resourceeio_link - stringpath - stringnew_path - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_link crea el enlace duro dado por - new_path para un fichero especificado por - path. - - - - - - &reftitle.parameters; - - - path - - - La ruta del fichero origen. - - - - - new_path - - - La ruta del fichero destino. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo de <function>eio_link</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - eio_symlink - - - - - diff --git a/reference/eio/functions/eio-lstat.xml b/reference/eio/functions/eio-lstat.xml deleted file mode 100644 index da860deca4..0000000000 --- a/reference/eio/functions/eio-lstat.xml +++ /dev/null @@ -1,161 +0,0 @@ - - - - - - - eio_lstat - Obtener el estado de un fichero - - - - &reftitle.description; - - resourceeio_lstat - stringpath - intpri - callablecallback - mixeddataNULL - - - eio_lstat devuelve la información del estado de un fichero en - el argumento result de callback - - - - - - &reftitle.parameters; - - - path - - - La ruta de archivo - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - eio_lstat devuelve un recurso de petición en caso de éxito o &false; en caso de error. - - - - - &reftitle.examples; - - Ejemplo de <function>eio_lstat</function> - - -]]> - - &example.outputs.similar; - - - int(2050) - ["st_ino"]=> - int(2099197) - ["st_mode"]=> - int(33188) - ["st_nlink"]=> - int(1) - ["st_uid"]=> - int(1000) - ["st_gid"]=> - int(100) - ["st_rdev"]=> - int(0) - ["st_blksize"]=> - int(4096) - ["st_blocks"]=> - int(0) - ["st_atime"]=> - int(1318235777) - ["st_mtime"]=> - int(1318235777) - ["st_ctime"]=> - int(1318235777) -} -]]> - - - - - - - &reftitle.seealso; - - eio_stat - eio_fstat - - - - - diff --git a/reference/eio/functions/eio-mkdir.xml b/reference/eio/functions/eio-mkdir.xml deleted file mode 100644 index db33c8caae..0000000000 --- a/reference/eio/functions/eio-mkdir.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - eio_mkdir - Crear un directorio - - - - &reftitle.description; - - resourceeio_mkdir - stringpath - intmode - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_mkdir crea un directorio con el acceso especificado por - mode. - - - - - - &reftitle.parameters; - - - path - - - La ruta del nuevo directorio. - - - - - mode - - - Modo de acceso, p.ej. 0755 - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - eio_mkdir devuelve un recurso de petición en caso de éxito,&return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo de <function>eio_mkdir</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - eio_rmdir - - - - - diff --git a/reference/eio/functions/eio-mknod.xml b/reference/eio/functions/eio-mknod.xml deleted file mode 100644 index d6a4f3b3d5..0000000000 --- a/reference/eio/functions/eio-mknod.xml +++ /dev/null @@ -1,222 +0,0 @@ - - - - - - - eio_mknod - Crear un fichero especial u ordinario - - - - &reftitle.description; - - resourceeio_mknod - stringpath - intmode - intdev - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - - eio_mknod crea un fichero ordinario o especial (a menudo). - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - path - - - Ruta del nuevo nodo (fichero). - - - - - mode - - - Especifica tanto los permisos a usar como el tipo de nodo a ser - creado. Debería ser una combinación (usando el operador OR) de uno de los - tipos de fichero listados abajo y los permisos para el nuevo nodo (p.ej. 0640). - - Los tipos de ficheros posibles son: EIO_S_IFREG (fichero regular), - EIO_S_IFCHR (fichero de carácter), - EIO_S_IFBLK (fichero especial de bloqueo), - EIO_S_IFIFO (FIFO - tubería nominada) y - EIO_S_IFSOCK (socket de dominio UNIX). - - Para especificar permisos se podrían usar constantes - EIO_S_I*. - - - - - dev - - - Si el tipo de fichero es EIO_S_IFCHR o - EIO_S_IFBLK, dev especifica el número mayor y - menor del recién creado fichero especial de dispositivo. De otro modo - dev es ignorado. Véase la página del manual mknod(2) para - más detalles. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - eio_mknod devuelve un recurso de petición en caso de éxito,&return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo de <function>eio_mknod</function> - - -]]> - - &example.outputs.similar; - - - int(17) - [1]=> - int(2337608) - [2]=> - int(4096) - [3]=> - int(1) - [4]=> - int(1000) - [5]=> - int(100) - [6]=> - int(0) - [7]=> - int(0) - [8]=> - int(1318241261) - [9]=> - int(1318241261) - [10]=> - int(1318241261) - [11]=> - int(4096) - [12]=> - int(0) - ["dev"]=> - int(17) - ["ino"]=> - int(2337608) - ["mode"]=> - int(4096) - ["nlink"]=> - int(1) - ["uid"]=> - int(1000) - ["gid"]=> - int(100) - ["rdev"]=> - int(0) - ["size"]=> - int(0) - ["atime"]=> - int(1318241261) - ["mtime"]=> - int(1318241261) - ["ctime"]=> - int(1318241261) - ["blksize"]=> - int(4096) - ["blocks"]=> - int(0) -} -eio_mknod_ok -]]> - - - - - - &reftitle.seealso; - - eio_open - - - - - diff --git a/reference/eio/functions/eio-nop.xml b/reference/eio/functions/eio-nop.xml deleted file mode 100644 index f0a0af2412..0000000000 --- a/reference/eio/functions/eio-nop.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - eio_nop - No hace nada, sólo recorre el ciclo de peticiones entero - - - - &reftitle.description; - - resourceeio_nop - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_nop no hace nada, sólo recorre el ciclo de - peticiones entero. Podría ser util al depurar. - - - - - - &reftitle.parameters; - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - eio_nop devuelve un recurso de petición en caso de éxito,&return.falseforfailure;. - - - - - &reftitle.seealso; - - eio_busy - - - - - diff --git a/reference/eio/functions/eio-npending.xml b/reference/eio/functions/eio-npending.xml deleted file mode 100644 index f2c49a0a00..0000000000 --- a/reference/eio/functions/eio-npending.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - eio_npending - Devolver el número de peticiones, excepto las no manejadas - - - - &reftitle.description; - - inteio_npending - - - - eio_npending devuelve el número de peticiones, excepto las no manejadas. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - eio_npending devuelve el número de peticiones, excepto las - no manejadas. - - - - - &reftitle.seealso; - - eio_nreqs - eio_nready - eio_nthreads - - - - - diff --git a/reference/eio/functions/eio-nready.xml b/reference/eio/functions/eio-nready.xml deleted file mode 100644 index e8165b7c01..0000000000 --- a/reference/eio/functions/eio-nready.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - eio_nready - Devolver el número de peticiones aún no tratadas - - - - &reftitle.description; - - inteio_nready - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - eio_nready devuelve el número de peticiones aún no tratadas - - - - - &reftitle.seealso; - - eio_nreqs - eio_nthreads - - - - - diff --git a/reference/eio/functions/eio-nreqs.xml b/reference/eio/functions/eio-nreqs.xml deleted file mode 100644 index 2db19ae9a3..0000000000 --- a/reference/eio/functions/eio-nreqs.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - eio_nreqs - Devuelve el número de peticiones a ser procesadas - - - - &reftitle.description; - - inteio_nreqs - - - - eio_nreqs se podría llamar en un bucle personalizado al llamar a - eio_poll. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - eio_nreqs devuelve el número de peticiones a ser procesadas. - - - - - &reftitle.examples; - - Ejepmlo de <function>eio_nreqs</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - eio_poll - eio_nready - - - - - diff --git a/reference/eio/functions/eio-nthreads.xml b/reference/eio/functions/eio-nthreads.xml deleted file mode 100644 index dbba50a08e..0000000000 --- a/reference/eio/functions/eio-nthreads.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - eio_nthreads - Devuelve el número de hilos actualmente en uso - - - - &reftitle.description; - - inteio_nthreads - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - eio_nthreads devuelve el número de hilos actualmente en - uso. - - - - - &reftitle.seealso; - - eio_npending - eio_nready - eio_nreqs - eio_set_max_idle - eio_set_max_parallel - eio_set_min_parallel - - - - - diff --git a/reference/eio/functions/eio-open.xml b/reference/eio/functions/eio-open.xml deleted file mode 100644 index 0515ca4a03..0000000000 --- a/reference/eio/functions/eio-open.xml +++ /dev/null @@ -1,179 +0,0 @@ - - - - - - eio_open - Abre un fichero - - - - &reftitle.description; - - resourceeio_open - stringpath - intflags - intmode - intpri - callablecallback - mixeddataNULL - - - eio_open abre un fichero especificado por el argumento - path con el modo de acceso especificado por - el argumento mode con los - flags dados. - - - - - - &reftitle.parameters; - - - path - - - Ruta hacia el fichero a abrir. - - - Con algunas APIs (i.e. PHP-FPM), la llamada - puede fallar si no se especifica la ruta completa. - - - - - - - flags - - - Una constante entre las constantes EIO_O_*, - o bien una combinación de estas constantes. Las constantes - EIO_O_* tienen el mismo significado que las - constantes correspondientes O_* definidas en - el archivo de encabezados C fnctl.h. Por omisión, vale - EIO_O_RDWR. - - - - - mode - - - Una constante entre las constantes EIO_S_I*, o bien - una combinación de estas constantes (vía el operador OR). - Las constantes tienen el mismo significado que las constantes correspondientes - S_I* definidas en el archivo de encabezados C sys/stat.h. - Requerido si se crea un fichero. De lo contrario, será ignorado. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variables arbitrarias a pasar a la función de devolución de llamada - callback. - - - - - - - - &reftitle.returnvalues; - - eio_open devuelve un descriptor de fichero - en el argumento result de la función de - devolución de llamada callback en caso de éxito; - de lo contrario, result valdrá -1. - - - - - &reftitle.examples; - - Ejemplo con <function>eio_open</function> - - 0); - - if ($result > 0) { - // Cierra el fichero - eio_close($result, EIO_PRI_DEFAULT, "my_close_cb", $data); - eio_event_loop(); - } -} - -// Crea un nuevo fichero para lectura y escritura -// No permite a grupos y otros hacer nada con este fichero -eio_open($temp_filename, EIO_O_CREAT | EIO_O_RDWR, EIO_S_IRUSR | EIO_S_IWUSR, - EIO_PRI_DEFAULT, "my_file_opened_callback", $temp_filename); -eio_event_loop(); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - eio_mknod - - - - - diff --git a/reference/eio/functions/eio-poll.xml b/reference/eio/functions/eio-poll.xml deleted file mode 100644 index f1f4d1fc49..0000000000 --- a/reference/eio/functions/eio-poll.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - eio_poll - Puede ser llamada siempre que existan peticiones pendientes que necesitan ser finalizadas - - - - &reftitle.description; - - inteio_poll - - - - eio_poll se puede usar para implementar un bucle de eventos especial. - Para esto, podria usarse eio_nreqs para comprobar si existen - peticiones no procesadas. - - - Aplicable solamente al implementar bucles de eventos del espacio de usuario. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Si cualquier invocación a una petición devuelve un valor distinto de cero, devuelve ese valor. - De otro modo devuelve 0. - - - - - &reftitle.examples; - - Ejemplo de <function>eio_poll</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - eio_nreqs - - - - - diff --git a/reference/eio/functions/eio-read.xml b/reference/eio/functions/eio-read.xml deleted file mode 100644 index c86b35cf00..0000000000 --- a/reference/eio/functions/eio-read.xml +++ /dev/null @@ -1,177 +0,0 @@ - - - - - - - eio_read - Leer de un descriptor de fichero en un índice dado - - - - &reftitle.description; - - resourceeio_read - mixedfd - intlength - intoffset - intpri - callablecallback - mixeddataNULL - - - eio_read lee hasta length - bytes desde el descriptor de fichero fd empezando en - offset. Los bytes leídos son almacenados en el - argumento result de callback. - - - - - - &reftitle.parameters; - - - fd - - - Un flujo, un recurso Socket, o un descriptor numérico de fichero. - - - - - length - - - El número máximo de bytes a leer. - - - - - offset - - - El índice dentro del fichero. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - eio_read almacena los bytes leídos en el - argumento result de la función - callback. - - - - - &reftitle.examples; - - Ejemplo de <function>eio_read</function> - - 0) { - // Leer 5 bytes empezando desde el tercero - eio_read($resultado, 5, 2, EIO_PRI_DEFAULT, "mi_llamada_retorno_read", $resultado); - eio_event_loop(); - } else { - // eio_open() falló - unlink($datos); - } -} - -// Abrir el fichero para leer y escribir -eio_open($nombre_fichero_temp, EIO_O_RDWR, NULL, - EIO_PRI_DEFAULT, "mi_llamada_retorno_fichero abierto", $nombre_fichero_temp); -eio_event_loop(); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - eio_open - eio_write - eio_close - eio_event_loop - - - - - diff --git a/reference/eio/functions/eio-readahead.xml b/reference/eio/functions/eio-readahead.xml deleted file mode 100644 index dd937b001f..0000000000 --- a/reference/eio/functions/eio-readahead.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - eio_readahead - Realiza una lectura anticipada del fichero en la caché de páginas - - - - &reftitle.description; - - resourceeio_readahead - mixedfd - intoffset - intlength - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_readahead rellena la caché de página con información de un fichero, por lo que lecturas posteriores de - ese fichero no bloquearán la E/S del disco. Véase la página del manual READAHEAD(2) para más detalles. - - - - - - &reftitle.parameters; - - - fd - - - Un flujo, un recurso Socket, o un descriptor numérico de fichero. - - - - - offset - - - El punto de inicio desde el cual se va a leer la información. - - - - - length - - - El número de bytes a leer. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - eio_readahead devuelve un recurso de petición en caso de éxito,&return.falseforfailure;. - - - - - diff --git a/reference/eio/functions/eio-readdir.xml b/reference/eio/functions/eio-readdir.xml deleted file mode 100644 index 1ad2f31220..0000000000 --- a/reference/eio/functions/eio-readdir.xml +++ /dev/null @@ -1,483 +0,0 @@ - - - - - - - eio_readdir - Leer un directorio al completo - - - - &reftitle.description; - - resourceeio_readdir - stringpath - intflags - intpri - callablecallback - stringdataNULL - - - Leer un directorio al completo (mediante las llamadas al sistema de opendir, - readdir y closedir) y devuelve o los nombres o un array en - el argumento result de la función callback, - dependiendo del argumento flags. - - - - - - &reftitle.parameters; - - - path - - - La ruta del directorio. - - - - - flags - - - Una combinación de constantes EIO_READDIR_*. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - eio_readdir devuelve un recurso de petición en caso de éxito,&return.falseforfailure;. - Establece el argumento result de - la función callback function según - el parámetro flags: - - - - - - - - EIO_READDIR_DENTS - (int) - - - - Bandera eio_readdir. Si se especifica, el argumento resultante de la llamada de retorno - se convierte en un array con las siguientes claves: - 'names' - array de nombres de directorios - 'dents' - array de structura eio_dirent-como - los arrays pero teniendo las siguientes claves: - 'name' - el nombre del directorio; - 'type' - una de las constantes - EIO_DT_*; - 'inode' - el número de inodo, si está disponible, de otro modo - sin especificar; - - - - - - EIO_READDIR_DIRS_FIRST - (int) - - - - Cuando se especifica esta bandera, los nombres serán devueltos en un orden - donde probablemente los directorios vallan primero, en un orden de estadísticas óptimo. - - - - - - EIO_READDIR_STAT_ORDER - (int) - - - - Cuando se especifica esta bandera, los nombres serán devueltos en un orden - apropiado para realizar estadísticas (stat) con cada uno. Cuando se planea usar - la función stat para realizar estadísticas de todos los archivos del directorio dado, el - orden devuelto probablemente sea - más rápido. - - - - - - EIO_READDIR_FOUND_UNKNOWN - (int) - - - - - - - - - - - - Tipos de nodos: - - - - - - EIO_DT_UNKNOWN - (int) - - - - Tipo de nodo desconocido(muy común). Se necistan más estadísticas (stat). - - - - - - EIO_DT_FIFO - (int) - - - - Tipo de nodo FIFO - - - - - - EIO_DT_CHR - (int) - - - - Tipo de nodo - - - - - - EIO_DT_MPC - (int) - - - - Tipo de nodo de dispositivo de caracteres multiplexado (v7+coherent) - - - - - - EIO_DT_DIR - (int) - - - - Tipo de nodo de directorio - - - - - - EIO_DT_NAM - (int) - - - - Tipo de nodo de fichero Xenix nominado especial - - - - - - EIO_DT_BLK - (int) - - - - Tipo de nodo - - - - - - EIO_DT_MPB - (int) - - - - Dispositivo de bloqueo multiplexado (v7+coherent) - - - - - - EIO_DT_REG - (int) - - - - Tipo de nodo - - - - - - EIO_DT_NWK - (int) - - - - - - - - - EIO_DT_CMP - (int) - - - - Tipo de noto especial de red HP-UX - - - - - - EIO_DT_LNK - (int) - - - - Tipo de nodo de vínculo - - - - - - EIO_DT_SOCK - (int) - - - - Tipo de nodo socket - - - - - - EIO_DT_DOOR - (int) - - - - Tipo de nodo de puerta de Solaris - - - - - - EIO_DT_WHT - (int) - - - - Tipo de nodo - - - - - - EIO_DT_MAX - (int) - - - - Valor de tipo de nodo más alto - - - - - - - - - - - - &reftitle.examples; - - Ejemplo de <function>eio_readdir</function> - - -]]> - - &example.outputs.similar; - - - array(7) { - [0]=> - string(7) "archive" - [1]=> - string(8) "articles" - [2]=> - string(8) "incoming" - [3]=> - string(7) "innfeed" - [4]=> - string(8) "outgoing" - [5]=> - string(8) "overview" - [6]=> - string(3) "tmp" - } - ["dents"]=> - array(7) { - [0]=> - array(3) - { - ["name"]=> - string(7) - "archive" - ["type"]=> - int(4) - ["inode"]=> - int(393265) - } - [1]=> - array(3) - { - ["name"]=> - string(8) - "articles" - ["type"]=> - int(4) - ["inode"]=> - int(393266) - } - [2]=> - array(3) - { - ["name"]=> - string(8) - "incoming" - ["type"]=> - int(4) - ["inode"]=> - int(393267) - } - [3]=> - array(3) - { - ["name"]=> - string(7) - "innfeed" - ["type"]=> - int(4) - ["inode"]=> - int(393269) - } - [4]=> - array(3) - { - ["name"]=> - string(8) - "outgoing" - ["type"]=> - int(4) - ["inode"]=> - int(393270) - } - [5]=> - array(3) - { - ["name"]=> - string(8) - "overview" - ["type"]=> - int(4) - ["inode"]=> - int(393271) - } - [6]=> - array(3) - { - ["name"]=> - string(3) - "tmp" - ["type"]=> - int(4) - ["inode"]=> - int(393272) - } - } -} -]]> - - - - - - - diff --git a/reference/eio/functions/eio-readlink.xml b/reference/eio/functions/eio-readlink.xml deleted file mode 100644 index 17bd23b6f5..0000000000 --- a/reference/eio/functions/eio-readlink.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - - eio_readlink - Leer el valor de un enlace simbólico - - - - &reftitle.description; - - resourceeio_readlink - stringpath - intpri - callablecallback - mixeddataNULL - - - - - - - - - &reftitle.parameters; - - - path - - - La ruta del enlace simbólico fuente - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - eio_readlink devuelve un recurso de petición en caso de éxito,&return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo de <function>eio_readlink</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - eio_symlink - - - - - diff --git a/reference/eio/functions/eio-realpath.xml b/reference/eio/functions/eio-realpath.xml deleted file mode 100644 index 22e3d34086..0000000000 --- a/reference/eio/functions/eio-realpath.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - - eio_realpath - Obtener el nombre de ruta absoluto canonizado - - - - &reftitle.description; - - resourceeio_realpath - stringpath - intpri - callablecallback - stringdataNULL - - - eio_realpath devuelve el nombre de ruta absoluto - canonizado en el argumento result de la - función callback. - - - - - - &reftitle.parameters; - - - path - - - EL nombre abreviado - - - - - - pri - - - - - - - - callback - - - - - - - - data - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo de<function>eio_realpath</function> - - -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/eio/functions/eio-rename.xml b/reference/eio/functions/eio-rename.xml deleted file mode 100644 index 2e779b6462..0000000000 --- a/reference/eio/functions/eio-rename.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - eio_rename - Cambiar el nombre o la ubicación de un fichero - - - - &reftitle.description; - - resourceeio_rename - stringpath - stringnew_path - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_rename renombra o mueve un fichero a una nueva ubicación. - - - - - - &reftitle.parameters; - - - path - - - La ruta de origen - - - - - new_path - - - La ruta destino - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - eio_rename devuelve un recurso de petición en caso de éxito,&return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo de <function>eio_rename</function> - - -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/eio/functions/eio-rmdir.xml b/reference/eio/functions/eio-rmdir.xml deleted file mode 100644 index 5816044059..0000000000 --- a/reference/eio/functions/eio-rmdir.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - - eio_rmdir - Eliminar un directorio - - - - &reftitle.description; - - resourceeio_rmdir - stringpath - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_rmdir elimina un directorio. - - - - - - &reftitle.parameters; - - - path - - - La ruta del directorio - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - eio_rmdir devuelve un recurso de petición en caso de éxito,&return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo de <function>eio_rmdir</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - eio_mkdir - - - - - diff --git a/reference/eio/functions/eio-seek.xml b/reference/eio/functions/eio-seek.xml deleted file mode 100644 index 392ffab0c3..0000000000 --- a/reference/eio/functions/eio-seek.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - eio_seek - Reposiciona el cursor de un fichero abierto - - - - &reftitle.description; - - resourceeio_seek - mixedfd - intoffset - intwhence - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_seek reposiciona el desplazamiento del fichero abierto asociado al flujo, - a la instancia de Socket, o al descriptor de fichero especificado por fd - al valor del argumento offset conforme - a la directiva whence. - - - - - &reftitle.parameters; - - - fd - - - Un flujo, una Socket, o un descriptor de fichero numérico - - - - - offset - - - Punto de partida desde el cual los datos comenzarán a ser leídos. - - - - - whence - - - Los valores de whence son : - - EIO_SEEK_SET - Posiciona a offset bytes. - EIO_SEEK_CUR - Posiciona a la posición actual más offset. - EIO_SEEK_END - Posiciona al final del fichero más offset. - - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria a pasar a la función de devolución de llamada - callback. - - - - - - - - &reftitle.returnvalues; - - eio_seek devuelve el recurso solicitado - en caso de éxito,&return.falseforfailure;. - - - - - diff --git a/reference/eio/functions/eio-sendfile.xml b/reference/eio/functions/eio-sendfile.xml deleted file mode 100644 index 851b7824f6..0000000000 --- a/reference/eio/functions/eio-sendfile.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - - eio_sendfile - Transferir información entre descriptores de ficheros - - - - &reftitle.description; - - resourceeio_sendfile - mixedout_fd - mixedin_fd - intoffset - intlength - intpri - callablecallback - stringdata - - - eio_sendfile copia información entre un descriptor de fichero - y otror. Véase la página del manual SENDFILE(2) para más detalles. - - - - - - &reftitle.parameters; - - - out_fd - - - Un flujo de salida, un recurso Socket, o un descriptor de fichero. Debería ser abierto para escritura. - - - - - in_fd - - - Un flujo de entrada, un recurso Socket, o un descriptor de fichero. Debería ser abierto para lectura. - - - - - offset - - - El índice dentro del fichero fuente. - - - - - length - - - El número de bytes a copiar. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - eio_sendfile devuelve un recurso de petición en caso de éxito,&return.falseforfailure;. - - - - - diff --git a/reference/eio/functions/eio-set-max-idle.xml b/reference/eio/functions/eio-set-max-idle.xml deleted file mode 100644 index 4bd2d0c86b..0000000000 --- a/reference/eio/functions/eio-set-max-idle.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - eio_set_max_idle - Establecer el número máximo de hilos parados - - - - &reftitle.description; - - voideio_set_max_idle - intnthreads - - - - - - - - - &reftitle.parameters; - - - nthreads - - - El número de hilo parados. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - eio_nthreads - eio_set_min_parallel - eio_set_max_parallel - - - - - diff --git a/reference/eio/functions/eio-set-max-parallel.xml b/reference/eio/functions/eio-set-max-parallel.xml deleted file mode 100644 index f42116b1b2..0000000000 --- a/reference/eio/functions/eio-set-max-parallel.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - eio_set_max_parallel - Esteblecer el máximo de hilos paralelos - - - - &reftitle.description; - - voideio_set_max_parallel - intnthreads - - - - - - - - - &reftitle.parameters; - - - nthreads - - - El número de hilos paralelos. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - eio_nthreads - eio_set_max_idle - eio_set_min_parallel - - - - - diff --git a/reference/eio/functions/eio-set-max-poll-reqs.xml b/reference/eio/functions/eio-set-max-poll-reqs.xml deleted file mode 100644 index 9c0015208c..0000000000 --- a/reference/eio/functions/eio-set-max-poll-reqs.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - eio_set_max_poll_reqs - Establecer el máximo número de peticiones procesadas en una monitorización - - - - &reftitle.description; - - voideio_set_max_poll_reqs - intnreqs - - - - - - - - - &reftitle.parameters; - - - nreqs - - - El número de peticiones - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/eio/functions/eio-set-max-poll-time.xml b/reference/eio/functions/eio-set-max-poll-time.xml deleted file mode 100644 index 13bafb6ff2..0000000000 --- a/reference/eio/functions/eio-set-max-poll-time.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - eio_set_max_poll_time - Establecer el tiempo máximo de monitorización - - - - &reftitle.description; - - voideio_set_max_poll_time - floatnseconds - - - La monitorización se detiene si toma más de nseconds - segundos. - - - - - - &reftitle.parameters; - - - nseconds - - - El número de segundos - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/eio/functions/eio-set-min-parallel.xml b/reference/eio/functions/eio-set-min-parallel.xml deleted file mode 100644 index c549e2a8ec..0000000000 --- a/reference/eio/functions/eio-set-min-parallel.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - eio_set_min_parallel - Esteblecer el número de hilos paralelos mínimo - - - - &reftitle.description; - - voideio_set_min_parallel - stringnthreads - - - - - - - - - &reftitle.parameters; - - - nthreads - - - El número de hilos paralelos. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - eio_nthreads - eio_set_max_idle - eio_set_max_parallel - - - - - diff --git a/reference/eio/functions/eio-stat.xml b/reference/eio/functions/eio-stat.xml deleted file mode 100644 index b8aa6ebfa2..0000000000 --- a/reference/eio/functions/eio-stat.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - - eio_stat - Obtener el estado de un fichero - - - - &reftitle.description; - - resourceeio_stat - stringpath - intpri - callablecallback - mixeddataNULL - - - eio_stat devuelve la información del estado de un fichero en - el argumento result de callback - - - - - - &reftitle.parameters; - - - path - - - La ruta de archivo - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - eio_statdevuelve un recurso de petición en caso de éxito o - &false; en caso de error. En caso de éxito asigna el argumento result de - callback a un array. - - - - - &reftitle.examples; - - Ejemplo de <function>eio_stat</function> - - -]]> - - &example.outputs.similar; - - - int(2050) - ["st_ino"]=> - int(2489173) - ["st_mode"]=> - int(33188) - ["st_nlink"]=> - int(1) - ["st_uid"]=> - int(1000) - ["st_gid"]=> - int(100) - ["st_rdev"]=> - int(0) - ["st_blksize"]=> - int(4096) - ["st_blocks"]=> - int(0) - ["st_atime"]=> - int(1318250380) - ["st_mtime"]=> - int(1318250380) - ["st_ctime"]=> - int(1318250380) -} -]]> - - - - - - &reftitle.seealso; - - eio_lstat - eio_fstat - - - - - diff --git a/reference/eio/functions/eio-statvfs.xml b/reference/eio/functions/eio-statvfs.xml deleted file mode 100644 index c632273861..0000000000 --- a/reference/eio/functions/eio-statvfs.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - - eio_statvfs - Obtener las estadísticas del sistema de ficheros - - - - &reftitle.description; - - resourceeio_statvfs - stringpath - intpri - callablecallback - mixeddata - - - eio_statvfs devuelve la información de las estadísticas del sistema de ficheros en - el argumento result de callback - - - - - &reftitle.parameters; - - - path - - - El nombre de ruta de cualquier fichero dentro del sistema de ficheros montado - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - eio_statvfs devuelve un recurso de petición en caso de éxito,&return.falseforfailure;. - En caso de éxito asigna el argumento result de - callback a un array. - - - - - &reftitle.examples; - - Ejemplo de <function>eio_statvfs</function> - - -]]> - - &example.outputs.similar; - - - int(4096) - ["f_frsize"]=> - int(4096) - ["f_blocks"]=> - int(262144) - ["f_bfree"]=> - int(262111) - ["f_bavail"]=> - int(262111) - ["f_files"]=> - int(1540815) - ["f_ffree"]=> - int(1540743) - ["f_favail"]=> - int(1540743) - ["f_fsid"]=> - int(0) - ["f_flag"]=> - int(4102) - ["f_namemax"]=> - int(255) -} -]]> - - - - - - - diff --git a/reference/eio/functions/eio-symlink.xml b/reference/eio/functions/eio-symlink.xml deleted file mode 100644 index 39a8b1873f..0000000000 --- a/reference/eio/functions/eio-symlink.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - - eio_symlink - Crear un enlace simbólico - - - - &reftitle.description; - - resourceeio_symlink - stringpath - stringnew_path - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - - eio_symlink crea un enlace simbólico - new_path hacia path. - - - - - - &reftitle.parameters; - - - path - - - La ruta fuente - - - - - new_path - - - La ruta destino - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - eio_symlink devuelve un recurso de petición en caso de éxito,&return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo de <function>eio_symlink</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - eio_link - - - - - diff --git a/reference/eio/functions/eio-sync-file-range.xml b/reference/eio/functions/eio-sync-file-range.xml deleted file mode 100644 index f1a739db10..0000000000 --- a/reference/eio/functions/eio-sync-file-range.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - - eio_sync_file_range - Sincornizar un segmento de fichero con el disco - - - - &reftitle.description; - - resourceeio_sync_file_range - mixedfd - intoffset - intnbytes - intflags - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_sync_file_range permite un control preciso al sincronizar el fichero abierto mencionado por el descriptor - de fichero fd con el disco. - - - - - - &reftitle.parameters; - - - fd - - - El descriptor de fichero - - - - - offset - - - El byte de inicio del rango del archivo a ser sincronizado - - - - - nbytes - - - Especifica la longitud del rango a ser sincronizado, en bytes. Si - nbytes es cero, son sicronizados todos los bytes desde - offset hasta el final del fichero. - - - - - flags - - - Una máscara de bits. Puede incluir cualquiera de los siguientes valores: - EIO_SYNC_FILE_RANGE_WAIT_BEFORE, - EIO_SYNC_FILE_RANGE_WRITE, - EIO_SYNC_FILE_RANGE_WAIT_AFTER. Estas banderas tienen - el mismo significado que sus homónimas SYNC_FILE_RANGE_* - (véase la página del manual SYNC_FILE_RANGE(2)). - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - eio_sync_file_range devuelve un recurso de petición en caso de éxito,&return.falseforfailure;. - - - - - diff --git a/reference/eio/functions/eio-sync.xml b/reference/eio/functions/eio-sync.xml deleted file mode 100644 index 105cd50685..0000000000 --- a/reference/eio/functions/eio-sync.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - eio_sync - Consignar el caché de buffer cache al disco - - - - &reftitle.description; - - resourceeio_sync - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - eio_sync devuelve un recurso de petición en caso de éxito,&return.falseforfailure;. - - - - - diff --git a/reference/eio/functions/eio-syncfs.xml b/reference/eio/functions/eio-syncfs.xml deleted file mode 100644 index 4d2ed08845..0000000000 --- a/reference/eio/functions/eio-syncfs.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - eio_syncfs - Realizar una llamada al sistema de syncfs de Linux si está disponible - - - - &reftitle.description; - - resourceeio_syncfs - mixedfd - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - - - - - - - &reftitle.parameters; - - - fd - - - Descriptor de fichero - - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - eio_syncfs devuelve un recurso de petición en caso de éxito,&return.falseforfailure;. - - - - - - diff --git a/reference/eio/functions/eio-truncate.xml b/reference/eio/functions/eio-truncate.xml deleted file mode 100644 index 95e7d8ea1d..0000000000 --- a/reference/eio/functions/eio-truncate.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - eio_truncate - Truncar un fichero - - - - &reftitle.description; - - resourceeio_truncate - stringpath - intoffset0 - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_truncate hace que el fichero nominado por path sea truncado al - tamaño de exactamente length bytes - - - - - - &reftitle.parameters; - - - path - - - Ruta del fichero. - - - - - offset - - - Índice desde el principio del fichero. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - eio_truncate devuelve un recurso de petición en caso de éxito,&return.falseforfailure;. - - - - - &reftitle.seealso; - - eio_ftruncate - - - - - diff --git a/reference/eio/functions/eio-unlink.xml b/reference/eio/functions/eio-unlink.xml deleted file mode 100644 index 4d34190fe6..0000000000 --- a/reference/eio/functions/eio-unlink.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - eio_unlink - Borrar un nombre y posiblemente el fichero al que se refiere - - - - &reftitle.description; - - resourceeio_unlink - stringpath - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_unlink borra un nombre del sistema de ficheros. - - - - - - &reftitle.parameters; - - - path - - - Ruta del fichero. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - eio_unlink devuelve un recurso de petición en caso de éxito,&return.falseforfailure;. - - - - - diff --git a/reference/eio/functions/eio-utime.xml b/reference/eio/functions/eio-utime.xml deleted file mode 100644 index b72d437f74..0000000000 --- a/reference/eio/functions/eio-utime.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - eio_utime - Cambiar los momentos de último y acceso y modificación de un fichero - - - - &reftitle.description; - - resourceeio_utime - stringpath - floatatime - floatmtime - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - - - - - - - &reftitle.parameters; - - - path - - - Ruta del fichero. - - - - - atime - - - Momento de acceso - - - - - mtime - - - Momento de modificación - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - eio_utime devuelve un recurso de petición en caso de éxito,&return.falseforfailure;. - - - - - &reftitle.seealso; - - eio_futime - - - - - diff --git a/reference/eio/functions/eio-write.xml b/reference/eio/functions/eio-write.xml deleted file mode 100644 index a20d5e2094..0000000000 --- a/reference/eio/functions/eio-write.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - - eio_write - Escribir en un fichero - - - - &reftitle.description; - - resourceeio_write - mixedfd - stringstr - intlength0 - intoffset0 - intpriEIO_PRI_DEFAULT - callablecallbackNULL - mixeddataNULL - - - eio_write escribe hasta length - bytes desde str en el índice offset - desde el principo del fichero. - - - - - - &reftitle.parameters; - - - fd - - - Un flujo, un recurso Socket, o un descriptor numérico de fichero, p.ej., devuelto por eio_open. - - - - - str - - - La cadena fuente - - - - - length - - - Número máximo de bytes a escribir. - - - - - offset - - - ïndice desde el principio del fichero. - - - - - pri - - &eio.request.pri.values; - - - - callback - - &eio.callback.proto; - - - - data - - - Variable arbitraria pasada a callback. - - - - - - - - &reftitle.returnvalues; - - eio_write devuelve un recurso de petición en caso de éxito,&return.falseforfailure;. - - - - - &reftitle.seealso; - - eio_open - - - - - diff --git a/reference/eio/reference.xml b/reference/eio/reference.xml deleted file mode 100644 index c87e52fe5e..0000000000 --- a/reference/eio/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - &Functions; Eio - - &reference.eio.entities.functions; - - - - diff --git a/reference/eio/setup.xml b/reference/eio/setup.xml deleted file mode 100644 index e1e8831347..0000000000 --- a/reference/eio/setup.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - &reftitle.setup; - -
- &reftitle.required; - - Esta extensión contiene la biblioteca - libeio. Asimismo, no es necesario - instalarla por separado. - -
- - - &reference.eio.configure; - - - -
- &reftitle.resources; - - Existen dos tipos de recursos en esta extensión: las peticiones y los grupos de peticiones. - -
- - -
- diff --git a/reference/ev/book.xml b/reference/ev/book.xml deleted file mode 100644 index 03a7c272d8..0000000000 --- a/reference/ev/book.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - Ev - Ev - - &reftitle.intro; - - Esta extensión proporciona una interfaz a la biblioteca - libev, un bucle de eventos - de alto rendimiento, escrito en C. - - - ¬e.no-windows.extension; - - - Libev es un bucle de eventos: registra - un interés por ciertos eventos (como un descriptor de fichero - que se vuelve legible, o un tiempo de espera máximo que ocurre), - gestiona las fuentes de estos eventos y proporciona al programa - dichos eventos. - - - Para lograr esto, toma un control más o menos total - del proceso (o hilo) ejecutando un gestor de bucle - de eventos, luego los comunica mediante un mecanismo de función - de retrollamada. - - - El registro de intereses por ciertos eventos se realiza mediante - observadores, luego, devuelve el control a libev iniciando estos - observadores. - - - Para más detalles, consulte la - documentación de libev. - - - - &reference.ev.setup; - &reference.ev.examples; - &reference.ev.watchers; - &reference.ev.watcher-callbacks; - &reference.ev.periodic-modes; - &reference.ev.ev; - &reference.ev.evcheck; - &reference.ev.evchild; - &reference.ev.evembed; - &reference.ev.evfork; - &reference.ev.evidle; - &reference.ev.evio; - &reference.ev.evloop; - &reference.ev.evperiodic; - &reference.ev.evprepare; - &reference.ev.evsignal; - &reference.ev.evstat; - &reference.ev.evtimer; - &reference.ev.evwatcher; - - - diff --git a/reference/ev/configure.xml b/reference/ev/configure.xml deleted file mode 100644 index a09bc76cd6..0000000000 --- a/reference/ev/configure.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - -
- &reftitle.install; - - - &pecl.info; - &url.pecl.package;ev - - - Para obtener más información sobre la instalación manual, - se recomienda leer el fichero INSTALL.md incluido - en los fuentes del paquete. - -
- diff --git a/reference/ev/ev.xml b/reference/ev/ev.xml deleted file mode 100644 index 0cfaa22fdb..0000000000 --- a/reference/ev/ev.xml +++ /dev/null @@ -1,800 +0,0 @@ - - - - - La clase Ev - Ev - - -
- &reftitle.intro; - - La clase Ev es una clase estática que proporciona acceso al bucle por defecto - así como a algunas operaciones comunes. - -
- -
- &reftitle.classsynopsis; - - - - - Ev - - - - - final - Ev - - - - &Constants; - - - const - int - Ev::FLAG_AUTO - 0 - - - const - int - Ev::FLAG_NOENV - 16777216 - - - const - int - Ev::FLAG_FORKCHECK - 33554432 - - - const - int - Ev::FLAG_NOINOTIFY - 1048576 - - - const - int - Ev::FLAG_SIGNALFD - 2097152 - - - const - int - Ev::FLAG_NOSIGMASK - 4194304 - - - const - int - Ev::RUN_NOWAIT - 1 - - - const - int - Ev::RUN_ONCE - 2 - - - const - int - Ev::BREAK_CANCEL - 0 - - - const - int - Ev::BREAK_ONE - 1 - - - const - int - Ev::BREAK_ALL - 2 - - - const - int - Ev::MINPRI - -2 - - - const - int - Ev::MAXPRI - 2 - - - const - int - Ev::READ - 1 - - - const - int - Ev::WRITE - 2 - - - const - int - Ev::TIMER - 256 - - - const - int - Ev::PERIODIC - 512 - - - const - int - Ev::SIGNAL - 1024 - - - const - int - Ev::CHILD - 2048 - - - const - int - Ev::STAT - 4096 - - - const - int - Ev::IDLE - 8192 - - - const - int - Ev::PREPARE - 16384 - - - const - int - Ev::CHECK - 32768 - - - const - int - Ev::EMBED - 65536 - - - const - int - Ev::CUSTOM - 16777216 - - - const - int - Ev::ERROR - 2147483648 - - - const - int - Ev::BACKEND_SELECT - 1 - - - const - int - Ev::BACKEND_POLL - 2 - - - const - int - Ev::BACKEND_EPOLL - 4 - - - const - int - Ev::BACKEND_KQUEUE - 8 - - - const - int - Ev::BACKEND_DEVPOLL - 16 - - - const - int - Ev::BACKEND_PORT - 32 - - - const - int - Ev::BACKEND_ALL - 63 - - - const - int - Ev::BACKEND_MASK - 65535 - - - &Methods; - - - -
- -
- &reftitle.constants; - - - Flags pasados para crear un bucle: - - - - - Ev::FLAG_AUTO - - - - El valor por defecto de los flags. - - - - - - Ev::FLAG_NOENV - - - - Si este flag se utiliza (o si el programa ejecuta - setuid o setgid), libev - no va a mirar la variable de entorno - LIBEV_FLAGS. De lo contrario (comportamiento por defecto), - LIBEV_FLAGS va a sobrescribir completamente el - flag si se encuentra. Útil para pruebas de rendimiento - y para la búsqueda de bugs. - - - - - - Ev::FLAG_FORKCHECK - - - - Hace que libev verifique si existe un fork en cada iteración, - en lugar de llamar manualmente al método - EvLoop::fork. Este mecanismo funciona - llamando a getpid() en cada iteración de - la bucle, y así, va a ralentizar el bucle de eventos que - poseen muchas iteraciones, pero habitualmente, - este ralentizamiento no es notable. La configuración de este flag - no puede ser sobrescrita o especificada en la variable - de entorno LIBEV_FLAGS. - - - - - - Ev::FLAG_NOINOTIFY - - - - Cuando este flag está especificado, libev - no va a intentar utilizar la API inotify - para estos watchers - ev_stat. - Este flag puede ser útil para conservar los descriptores de - ficheros inotify, sabiendo que de lo contrario, cada bucle utilizando los - watchers ev_stat va a consumir un manejador - inotify. - - - - - - Ev::FLAG_SIGNALFD - - - - Cuando este flag está especificado, libev - va a intentar utilizar la API signalfd - para estos watchers - ev_signal - (y - ev_child). - Esta API entrega las señales de forma asíncrona, lo que - la hace más rápida, y puede permitir la recuperación de datos - de señales en espera. También puede simplificar la gestión - de señales con hilos, sabiendo que las señales son propiedades bloqueadas - en los hilos. Signalfd - no será utilizado por defecto. - - - - - - Ev::FLAG_NOSIGMASK - - - - Cuando este flag está especificado, libev - no va a modificar la máscara de señal. Esto significa - que se debe asegurar que las señales están desbloqueadas - antes de recibirlas. - - - Este comportamiento es útil para la gestión personalizada de señales, - o la gestión de señales únicamente en hilos específicos. - - - - - - - - Flags a pasar a - Ev::run, - o a EvLoop::run - - - - - Ev::RUN_NOWAIT - - - - Significa que el bucle de eventos va a mirar si hay nuevos - eventos presentes, va a gestionar estos nuevos eventos, - y todos los eventos especiales, pero no va a esperar y - bloquear el proceso en el caso de que no haya eventos, - y va a retornar después de una iteración del bucle. A veces - es útil poner en cola y gestionar los nuevos eventos - durante cálculos largos, y esto, para mantener el programa activo. - - - - - - Ev::RUN_ONCE - - - - Significa que el bucle de eventos va a mirar si hay nuevos - eventos presentes (y esperar, si es necesario), y va a gestionarlos, - ellos y los especiales. Va a bloquear el proceso hasta que al - menos un evento llegue (que puede ser un evento interno de libev, - también, no está garantizado que una función de callback registrada por - el usuario sea llamada), y va a retornar después de una iteración - del bucle. - - - - - - - - Flags pasados a - Ev::stop, - o a - EvLoop::stop - - - - - Ev::BREAK_CANCEL - - - - Cancela la operación de cancelación. - - - - - - Ev::BREAK_ONE - - - - Retorna la llamada más profunda a - Ev::run - (o EvLoop::run). - - - - - - Ev::BREAK_ALL - - - - Retorna la llamada más cercana a - Ev::run - (o EvLoop::run). - - - - - - - - Prioridades de Watcher: - - - - - Ev::MINPRI - - - - Prioridad mínima permitida para un watcher. - - - - - - Ev::MAXPRI - - - - Prioridad máxima permitida para un watcher. - - - - - - - - Máscaras de bytes de eventos (recibidos): - - - - - Ev::READ - - - - El descriptor de fichero en el watcher - EvIo se ha vuelto accesible - en lectura. - - - - - - Ev::WRITE - - - - El descriptor de fichero en el watcher - EvIo se ha vuelto accesible - en escritura. - - - - - - Ev::TIMER - - - - El watcher EvTimer - ha alcanzado su tiempo máximo de espera. - - - - - - Ev::PERIODIC - - - - El watcher EvPeriodic - ha alcanzado su tiempo máximo de espera. - - - - - - Ev::SIGNAL - - - - Una señal especificada en - EvSignal::__construct - ha sido recibida. - - - - - - Ev::CHILD - - - - El pid especificado en - EvChild::__construct - ha recibido una modificación de estado. - - - - - - Ev::STAT - - - - La ruta especificada en el watcher - EvStat ha modificado sus - atributos. - - - - - - Ev::IDLE - - - - El watcher EvIdle funciona cuando - no tiene ninguna otra tarea que hacer con los otros watchers. - - - - - - Ev::PREPARE - - - - Todos los watchers EvPrepare - son llamados justo antes del inicio de - Ev::run. Así, los watchers - EvPrepare son los últimos watchers - en ser llamados antes del reposo del bucle de eventos, - o la puesta en cola de los nuevos eventos. - - - - - - Ev::CHECK - - - - Todos los watchers EvCheck - son puestos en cola justo después de que - Ev::run haya recuperado - los nuevos eventos, pero antes, todas las - funciones de callback de todos los eventos recibidos - son puestas en cola. Así, los watchers - EvCheck serán llamados antes que cualquier - otro watcher de misma prioridad o de prioridad más baja - en una iteración del bucle de eventos. - - - - - - Ev::EMBED - - - - El bucle de eventos embebido especificado en el - watcher EvEmbed necesita - toda la atención. - - - - - - Ev::CUSTOM - - - - Aún no enviado (o utilizado) por - libev, pero puede ser - libremente utilizado por los usuarios - libev para señalar los watchers - (i.e. vía el método EvWatcher::feed). - - - - - - Ev::ERROR - - - - Ha ocurrido un error desconocido, el watcher se ha detenido. Esto puede - ocurrir porque el watcher no ha podido ser iniciado correctamente - porque libev ha excedido la memoria asignada, un - descriptor de fichero ha sido cerrado, u otro problema. - Libev considera esto como bugs - de la aplicación. Ver también - la anatomía - de un watcher - - - - - - - - Flags de Backend: - - - - - Ev::BACKEND_SELECT - - - - select(2) backend - - - - - - Ev::BACKEND_POLL - - - - poll(2) backend - - - - - - Ev::BACKEND_EPOLL - - - - Backend epoll(7) específico de Linux - para, a la vez, los kernels antes y después de 2.6.9. - - - - - - Ev::BACKEND_KQUEUE - - - - Backend kqueue utilizado en la - mayoría de los sistemas BSD. El watcher EvEmbed - puede ser utilizado para embeber un bucle (con el - backend kqueue) en otro. Actualmente, un bucle puede - intentar crear un bucle de eventos con el backend - kqueue y utilizarlo únicamente para los - sockets. - - - - - - Ev::BACKEND_DEVPOLL - - - - Backend Solaris 8. Actualmente no implementado. - - - - - - Ev::BACKEND_PORT - - - - Mecanismo de puerto de eventos Solaris con buen rendimiento. - - - - - - Ev::BACKEND_ALL - - - - Prueba todos los backends (incluyendo los corruptos). - No se recomienda utilizarlo explícitamente. - Los operadores de bits deberían ser aplicados aquí - (i.e. Ev::BACKEND_ALL & ~ - Ev::BACKEND_KQUEUE). - Utilice el método - Ev::recommendedBackends o no - especifique ningún backend. - - - - - - Ev::BACKEND_MASK - - - - No es un backend, sino una máscara para seleccionar todos - los bits de un backend desde el valor de - flags para representar en una - máscara cualquier backend (i.e. al modificar - la variable de entorno LIBEV_FLAGS). - - - - - - - - - Para el bucle por defecto, durante la fase de inicialización - del módulo, Ev registra llamadas a - ev_loop_fork - vía pthread_atfork (si está disponible). - - - - - Hay métodos que proporcionan acceso a la - bucle de eventos por defecto - en la clase Ev - (i.e. Ev::iteration, - Ev::depth, etc.) Para los - bucles personalizados (creados con - EvLoop::__construct), estos - valores pueden ser accesibles vía las propiedades y los - métodos correspondientes de la clase - EvLoop. - - - La instancia del bucle de eventos por defecto puede ser recuperada - vía el método EvLoop::defaultLoop. - - -
- -
- - &reference.ev.entities.ev; - -
- diff --git a/reference/ev/ev/backend.xml b/reference/ev/ev/backend.xml deleted file mode 100644 index 058550efdc..0000000000 --- a/reference/ev/ev/backend.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - Ev::backend - Devuelve un integer que describe el backend utilizado por libev - - - &reftitle.description; - - final - public - static - int - Ev::backend - - - - Devuelve un integer que describe el backend utilizado por libev. - Ver los - flags de Backend. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve un integer (máscara de bytes) que describe el backend utilizado por - libev. - - - - &reftitle.seealso; - - - EvEmbed - - - Ev::embeddableBackends - - - Ev::recommendedBackends - - - Ev::supportedBackends - - - Los flags de Backend - - - - - diff --git a/reference/ev/ev/depth.xml b/reference/ev/ev/depth.xml deleted file mode 100644 index 112ac353c3..0000000000 --- a/reference/ev/ev/depth.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - Ev::depth - Retorna la profundidad de recursión - - - &reftitle.description; - - final - public - static - int - Ev::depth - - - - El número de veces que el método Ev::run - ha sido invocado, menos el número de veces que el método - Ev::run ha finalizado normalmente, en otras - palabras, la profundidad de recursión. Fuera de - Ev::run, este número vale 0. - En una función de retrollamada, este número vale 1, - mientras que el método Ev::run sea invocado - recursivamente (o desde otro hilo), en cuyo caso, será superior. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - ev_depth retorna la profundidad de recursión - del bucle por omisión. - - - - &reftitle.seealso; - - - Ev::iteration - - - - - diff --git a/reference/ev/ev/embeddablebackends.xml b/reference/ev/ev/embeddablebackends.xml deleted file mode 100644 index 30bf633536..0000000000 --- a/reference/ev/ev/embeddablebackends.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - Ev::embeddableBackends - Devuelve el conjunto de backends que pueden ser encapsulados en otros bucles de eventos - - - &reftitle.description; - - final - public - static - int - Ev::embeddableBackends - - - - Devuelve el conjunto de backends que pueden ser encapsulados en otros bucles de eventos. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve una máscara de octetos que puede contener los - flags de backend - combinados con el operador OR. - - - - &reftitle.examples; - - Encapsula un bucle creado con el backend kqueue en el bucle por defecto - - -]]> - - - - - &reftitle.seealso; - - - EvEmbed - - - Ev::recommendedBackends - - - Ev::supportedBackends - - - Los flags de Backend - - - Los ejemplos - - - - - diff --git a/reference/ev/ev/feedsignal.xml b/reference/ev/ev/feedsignal.xml deleted file mode 100644 index 1123b1891b..0000000000 --- a/reference/ev/ev/feedsignal.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Ev::feedSignal - Simula la recepción de una señal - - - &reftitle.description; - - final - public - static - void - Ev::feedSignal - - int - signum - - - - Simula la recepción de una señal. Es seguro llamar a esta función - en cualquier momento, desde cualquier contexto, incluyendo desde - un gestor de señales, o desde un hilo aleatorio. Su principal - utilización es personalizar el gestor de señales en el proceso. - - - A diferencia del método Ev::feedSignalEvent, - este método funciona según la loop que ha registrado la señal. - - - - &reftitle.parameters; - - - - signum - - - - Número de la señal. Ver la página man de signal(7) - para más detalles. Se pueden utilizar las constantes exportadas - por la extensión pcntl. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - Ev::feedSignalEvent - - - - - diff --git a/reference/ev/ev/feedsignalevent.xml b/reference/ev/ev/feedsignalevent.xml deleted file mode 100644 index 2732bd897e..0000000000 --- a/reference/ev/ev/feedsignalevent.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - Ev::feedSignalEvent - Simula un evento de señal en el bucle por omisión - - - &reftitle.description; - - final - public - static - void - Ev::feedSignalEvent - - int - signum - - - - Simula un evento de señal en el bucle por omisión. - Ev reaccionará a esta llamada como si la señal especificada por - el argumento signal hubiera ocurrido. - - - - &reftitle.parameters; - - - - signum - - - - Número de la señal. Ver la página man de signal(7) - para más detalles. Ver también las constantes exportadas por - la extensión pcntl. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - Ev::feedSignal - - - - - diff --git a/reference/ev/ev/iteration.xml b/reference/ev/ev/iteration.xml deleted file mode 100644 index ec33cf97e1..0000000000 --- a/reference/ev/ev/iteration.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - Ev::iteration - Devuelve el número de veces que el bucle de eventos por omisión - ha sido solicitado para un nuevo evento - - - &reftitle.description; - - final - public - static - int - Ev::iteration - - - - Devuelve el número de veces que el bucle de eventos por omisión - ha sido solicitado para un nuevo evento. Puede ser útil como - contador de generación. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve el número de solicitudes del bucle de eventos - por omisión. - - - - &reftitle.seealso; - - - Ev::depth - - - - - diff --git a/reference/ev/ev/now.xml b/reference/ev/ev/now.xml deleted file mode 100644 index f40fe5bcfb..0000000000 --- a/reference/ev/ev/now.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Ev::now - Devuelve el tiempo de inicio de la última iteración del bucle de eventos por omisión - - - &reftitle.description; - - final - public - static - float - Ev::now - - - - Devuelve el tiempo de inicio de la última iteración del bucle de eventos por omisión. - Es el tiempo en el que se basan los temporizadores (EvTimer y - EvPeriodic), y referirse a este es a menudo más rápido que - llamar al método Ev::time. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve el número de segundos que representan el tiempo de inicio de la última iteración - del bucle de eventos por omisión. - - - - &reftitle.seealso; - - - Ev::nowUpdate - - - - - diff --git a/reference/ev/ev/nowupdate.xml b/reference/ev/ev/nowupdate.xml deleted file mode 100644 index 16387fea52..0000000000 --- a/reference/ev/ev/nowupdate.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - Ev::nowUpdate - Establece el tiempo actual solicitándolo al kernel; actualiza el - tiempo devuelto por Ev::now durante la ejecución - - - &reftitle.description; - - final - public - static - void - Ev::nowUpdate - - - - Establece el tiempo actual solicitándolo al kernel; actualiza el tiempo - devuelto por el método Ev::now durante - la ejecución. Esta es una operación costosa, y se realiza habitualmente - automáticamente en el método Ev::run. - - - Este método es raramente útil, pero cuando las funciones de retrollamada - de evento se ejecutan durante mucho tiempo sin entrar en un bucle de evento, - actualizar libev con el tiempo actual es una buena idea. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - Ev::now - - - - - diff --git a/reference/ev/ev/recommendedbackends.xml b/reference/ev/ev/recommendedbackends.xml deleted file mode 100644 index 47cc0ba1cb..0000000000 --- a/reference/ev/ev/recommendedbackends.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - Ev::recommendedBackends - Devuelve una máscara de octetos de backends recomendados - para la plataforma actual - - - &reftitle.description; - - final - public - static - int - Ev::recommendedBackends - - - - Devuelve un conjunto de todos los backends compilados en este binario de - libev, y también recomendados para esta - plataforma, lo que significa que deberían funcionar para la - mayoría de los tipos de descriptor de ficheros. Este conjunto es generalmente - más pequeño que el devuelto por la función - ev_supported_backends, sabiendo que, por ejemplo, - kqueue está roto en los sistemas BSD - y no será auto-detectado hasta que no sea requerido explícitamente. - Es el conjunto de backends que libev utilizará - cuando ninguno sea solicitado explícitamente. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve una máscara de octetos que contiene los - flags de backends - combinados utilizando el operador OR. - - - - &reftitle.examples; - - Encapsula un bucle en otro - - -]]> - - - - - &reftitle.seealso; - - - EvEmbed - - - Ev::embeddableBackends - - - Ev::supportedBackends - - - Los flags de Backend - - - Los ejemplos - - - - - diff --git a/reference/ev/ev/resume.xml b/reference/ev/ev/resume.xml deleted file mode 100644 index 4cc6fd89a8..0000000000 --- a/reference/ev/ev/resume.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Ev::resume - Reanuda el bucle de eventos por defecto previamente detenido - - - &reftitle.description; - - final - public - static - void - Ev::resume - - - - Los métodos Ev::suspend y - Ev::resume suspenden y reanudan - un bucle. - - - Todos los watchers timer serán suspendidos durante el tiempo entre - la suspensión y la reanudación - y todos los watchers periodic serán - reprogramados (y perderán todos los eventos que hayan ocurrido - durante el tiempo de esta suspensión). - - - Tras la llamada al método Ev::suspend, - no está permitido llamar a una función en el bucle proporcionado - distinto del método Ev::resume. - Además, no está permitido llamar al método - Ev::resume sin una llamada previa al - método Ev::suspend. - - - La llamada a una suspensión/reanudación - tiene como efecto secundario la actualización del tiempo del bucle de eventos - (ver el método Ev::nowUpdate). - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - Ev::suspend - - - - - diff --git a/reference/ev/ev/run.xml b/reference/ev/ev/run.xml deleted file mode 100644 index 8ef642c418..0000000000 --- a/reference/ev/ev/run.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - Ev::run - Inicia la verificación de eventos y llama a las funciones de retrollamada para el bucle por defecto - - - &reftitle.description; - - final - public - static - void - Ev::run - - int - flags - - - - Inicia la verificación de eventos y llama a las funciones de retrollamada - para el bucle por defecto. Retorna cuando una función - de retrollamada llama al método Ev::stop, o cuando - los flags son diferentes de cero (en cuyo caso, el valor retornado - será &true;), o bien cuando no hay más observadores activos que - referencian el bucle (EvWatcher::keepalive vale - &true;), en cuyo caso, el valor retornado será &false;. El valor retornado - puede generalmente ser interpretado como: si &true;, aún hay trabajo por hacer. - - - - &reftitle.parameters; - - - - flags - - - - El parámetro opcional flags - puede ser uno de los siguientes valores: - - - Lista de valores posibles de <parameter>flags</parameter> - - - - - - flags - - Descripción - - - - - - 0 - - El comportamiento por omisión, descrito arriba - - - - Ev::RUN_ONCE - - Bloquea al menos un (pone en espera, pero no bucla más) - - - - Ev::RUN_NOWAIT - - No bloquea en absoluto (recupera/gestiona los eventos - pero no espera) - - - -
-
- - Ver las - constantes de flags de ejecución. - -
-
-
-
- - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - Ev::stop - - - EvLoop::run - - - -
- diff --git a/reference/ev/ev/sleep.xml b/reference/ev/ev/sleep.xml deleted file mode 100644 index 3d1b330f39..0000000000 --- a/reference/ev/ev/sleep.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - Ev::sleep - Bloquea el proceso durante un número de segundos proporcionado - - - &reftitle.description; - - final - public - static - void - Ev::sleep - - float - seconds - - - - Bloquea el proceso durante un número de segundos proporcionado. - - - - &reftitle.parameters; - - - - seconds - - - - Número de segundos - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/ev/stop.xml b/reference/ev/ev/stop.xml deleted file mode 100644 index 311b49f9c4..0000000000 --- a/reference/ev/ev/stop.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - Ev::stop - Detiene el bucle de eventos predeterminado - - - &reftitle.description; - - final - public - static - void - Ev::stop - - int - how - - - - Detiene el bucle de eventos predeterminado. - - - - &reftitle.parameters; - - - - how - - - - Una constante - entre las constantes Ev::BREAK_*. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - Ev::run - - - - - diff --git a/reference/ev/ev/supportedbackends.xml b/reference/ev/ev/supportedbackends.xml deleted file mode 100644 index 5e100252d6..0000000000 --- a/reference/ev/ev/supportedbackends.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - Ev::supportedBackends - Devuelve el conjunto de backends soportados por la configuración actual de libev - - - &reftitle.description; - - final - public - static - int - Ev::supportedBackends - - - - Devuelve el conjunto de backends soportados por la configuración actual de libev. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve una máscara de bits que puede contener los - flags de backend - combinados utilizando el operador OR. - - - - &reftitle.examples; - - Bucle integrado creado con el backend kqueue en el bucle por defecto - - -]]> - - - - - &reftitle.seealso; - - - EvEmbed - - - Ev::recommendedBackends - - - Ev::embeddableBackends - - - Los flags de backend - - - Los ejemplos - - - - - diff --git a/reference/ev/ev/suspend.xml b/reference/ev/ev/suspend.xml deleted file mode 100644 index 64c3b1f418..0000000000 --- a/reference/ev/ev/suspend.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - Ev::suspend - Suspende el bucle de eventos predeterminado - - - &reftitle.description; - - final - public - static - void - Ev::suspend - - - - Los métodos Ev::suspend y - Ev::resume suspenden y reanudan - el bucle predeterminado. - - - Todos los temporizadores de los observadores serán suspendidos entre una - suspensión y una reanudación, - y todos los observadores periódicos - serán actualizados (asimismo, todos los eventos ocurridos durante - esta suspensión se perderán). - - - Tras una llamada al método Ev::suspend, - no está permitido llamar a una función en el bucle proporcionado - distinta del método Ev::resume. Asimismo, - no está permitido llamar al método Ev::resume - sin una llamada previa al método Ev::suspend. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - Ev::resume - - - - - diff --git a/reference/ev/ev/time.xml b/reference/ev/ev/time.xml deleted file mode 100644 index d005dd962e..0000000000 --- a/reference/ev/ev/time.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - Ev::time - Devuelve el tiempo actual desde la época Unix - - - &reftitle.description; - - final - public - static - float - Ev::time - - - - Devuelve el tiempo actual desde la época Unix. - Se recomienda utilizar el método Ev::now. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve el tiempo actual, en número de segundos, desde la época Unix. - - - - &reftitle.seealso; - - - Ev::now - - - - - diff --git a/reference/ev/ev/verify.xml b/reference/ev/ev/verify.xml deleted file mode 100644 index daccf899a0..0000000000 --- a/reference/ev/ev/verify.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Ev::verify - Efectúa verificaciones internas de consistencia (para la depuración) - - - &reftitle.description; - - final - public - static - void - Ev::verify - - - - Efectúa verificaciones internas de consistencia (para la depuración de - libev) y finaliza el programa si se encuentra una estructura - de datos corrompida. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/evcheck.xml b/reference/ev/evcheck.xml deleted file mode 100644 index 1c4c6078a7..0000000000 --- a/reference/ev/evcheck.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - La clase EvCheck - EvCheck - - -
- &reftitle.intro; - - Los observadores EvPrepare y - EvCheck se utilizan habitualmente juntos. - El observador EvPrepare será llamado antes de - los bloques del proceso, mientras que el observador EvCheck - será llamado después. - - - No está permitido llamar al método EvLoop::run - o a un método/función similar que entre en el bucle del evento - actual desde el observador EvPrepare, - o desde el observador EvCheck. Sin embargo, - esto es posible para todos los demás bucles que no sean el actual. - La razón es que no es necesario verificar la recursión - en estos observadores, es decir, la secuencia siguiente será siempre: - EvPrepare -> bloqueo -> EvCheck, - por lo tanto, tener un observador para cada uno no es útil, sabiendo que siempre serán llamados - juntos al llamar al bloqueo. - - - El propósito principal es integrar otros mecanismos de eventos en - la biblioteca libev, con un uso avanzado. - Pueden ser utilizados, por ejemplo, para monitorear los cambios - de variables, implementar observadores personalizados, integrar net-snmp - o una biblioteca adicional, y mucho más. También pueden ser útiles para almacenar en caché datos, y querer mostrarlos después - del bloqueo. - - - Se recomienda proporcionar una prioridad alta a EvCheck - (Ev::MAXPRI) para asegurarse de que se ejecutará - antes que cualquier otro observador en la cola (a diferencia de lo que ocurre con - el observador EvPrepare). - - - Además, los observadores EvCheck no deben - activar/alimentar eventos. Aunque libev - admite esto, pueden ser ejecutados antes de que los otros observadores - EvCheck terminen sus trabajos. - -
- -
- &reftitle.classsynopsis; - - - - - EvCheck - - - - - EvCheck - - - extends - EvWatcher - - - - - &InheritedProperties; - - &Methods; - - - &InheritedMethods; - - - -
-
- - &reference.ev.entities.evcheck; - -
- diff --git a/reference/ev/evcheck/construct.xml b/reference/ev/evcheck/construct.xml deleted file mode 100644 index 5ede87dc40..0000000000 --- a/reference/ev/evcheck/construct.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - EvCheck::__construct - Construye el objeto de observación EvCheck - - - &reftitle.description; - - public - EvCheck::__construct - - callable - callback - - - mixed - data - - - int - priority - - - - Construye el objeto de observación EvCheck. - - - - &reftitle.parameters; - - - - callback - - - - Ver las - retrollamadas de las observaciones. - - - - - - data - - - - Datos personalizados asociados con el observador. - - - - - - priority - - - - Prioridad del observador - - - - - - - - &reftitle.seealso; - - - EvPrepare - - - EvLoop::check - - - - - diff --git a/reference/ev/evcheck/createstopped.xml b/reference/ev/evcheck/createstopped.xml deleted file mode 100644 index 638066056b..0000000000 --- a/reference/ev/evcheck/createstopped.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - EvCheck::createStopped - Crea una instancia de un observador EvCheck detenido - - - &reftitle.description; - - final - public - static - object - EvCheck::createStopped - - string - callback - - - string - data - - - string - priority - - - - Crea una instancia de un observador EvCheck detenido. - - - - &reftitle.parameters; - - - - callback - - - - Ver las - retrollamadas de los - observadores. - - - - - - data - - - - Datos personalizados para asociar con el observador. - - - - - - priority - - - - Prioridad del observador - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto EvCheck en caso de éxito. - - - - &reftitle.seealso; - - - EvPrepare - - - - - diff --git a/reference/ev/evchild.xml b/reference/ev/evchild.xml deleted file mode 100644 index 8d4c595390..0000000000 --- a/reference/ev/evchild.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - La clase EvChild - EvChild - - -
- &reftitle.intro; - - Los watchers EvChild se activan cuando el - proceso recibe un SIGCHLD en respuesta a cambios de estado de los hijos (típicamente, cuando un hijo - muere o termina). Está permitido instalar un watcher - EvChild después de que el hijo haya sido forkeado - (lo que implica que ya debe existir), siempre que el bucle - de eventos no haya comenzado (o continuado desde un watcher), es decir, - forkear y luego registrar inmediatamente un watcher para el hijo es - el método correcto, pero forkear y registrar un watcher después de algunas - iteraciones del bucle de eventos o en la próxima invocación - de la función de retrollamada no es el método correcto. - - - Solo está permitido registrar watchers - EvChild en el - bucle por defecto. - -
- -
- &reftitle.classsynopsis; - - - - - EvChild - - - - - EvChild - - - extends - EvWatcher - - - - &Properties; - - public - pid - - - public - rpid - - - public - rstatus - - &InheritedProperties; - - &Methods; - - - &InheritedMethods; - - - -
- -
- &reftitle.properties; - - - - pid - - - - Solo lectura. - El ID del proceso relacionado - con los watchers, o 0 que significa todos los IDs - de proceso. - - - - - - rpid - - - - Solo lectura. El ID del proceso que ha detectado - un cambio de estado. - - - - - - rstatus - - - - Solo lectura. - El estado de salida del proceso - causado por rpid. - - - - -
- -
- - &reference.ev.entities.evchild; - -
- diff --git a/reference/ev/evchild/construct.xml b/reference/ev/evchild/construct.xml deleted file mode 100644 index 0686e811e6..0000000000 --- a/reference/ev/evchild/construct.xml +++ /dev/null @@ -1,161 +0,0 @@ - - - - - - EvChild::__construct - Construye el objeto de observación EvChild - - - &reftitle.description; - - public - EvChild::__construct - - int - pid - - - bool - trace - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Construye el objeto observador EvChild. - - - Llama a la retrollamada cuando se recibe un cambio de estado de un proceso - cuyo ID pid (o de cualquier PID - si vale 0) (un cambio de estado ocurre cuando el proceso - termina o es eliminado, o cuando el parámetro trace - vale &true;, cuando el proceso es detenido o continuado). En otras palabras, - cuando el proceso recibe un SIGCHLD, Ev - recuperará todos los estados de salida/espera para todos los hijos - modificados/zombies y llamará a la retrollamada. - - - Es válido instalar un observador en el hijo después de que un - EvChild haya salido, pero antes de que el bucle - de eventos haya iniciado su siguiente iteración. Por ejemplo, - primero, se llama a fork, luego el nuevo proceso - hijo puede salir, y solo entonces, un observador - EvChild es instalado en el padre para el - nuevo PID. - - - Se podrá acceder a los estados de salida/de traza así como a los - pid utilizando las propiedades - rstatus y rpid del objeto observador. - - - El número de observadores PID por PID - no está limitado. Todos serán llamados. - - - El método EvChild::createStopped - no inicia (activa) el nuevo observador creado. - - - - &reftitle.parameters; - - - - pid - - - - Espera los cambios de estado de los procesos PID (o cualquier proceso - si PID vale 0). - - - - - - trace - - - - Si vale &false;, solo activa el observador cuando el proceso - termina. De lo contrario (&true;), activa el observador cuando el - proceso es detenido o continuado. - - - - - - callback - - - - Ver las - retrollamadas de los observadores. - - - - - - data - - - - Datos personalizados asociados con el observador. - - - - - - priority - - - - Retrollamadas del observador - - - - - - - - &reftitle.seealso; - - - EvLoop::child - - - - - diff --git a/reference/ev/evchild/createstopped.xml b/reference/ev/evchild/createstopped.xml deleted file mode 100644 index 3f15db53ed..0000000000 --- a/reference/ev/evchild/createstopped.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - EvChild::createStopped - Crea una instancia del observador detenido EvChild - - - &reftitle.description; - - final - public - static - object - EvChild::createStopped - - int - pid - - - bool - trace - - - callable - callback - - - mixed - data - - - int - priority - - - - Idéntico a EvChild::__construct, - pero no inicia automáticamente el observador. - - - - &reftitle.parameters; - - - - pid - - - - Idéntico al utilizado para - EvChild::__construct - - - - - - trace - - - - Idéntico al utilizado para - EvChild::__construct - - - - - - callback - - - - Ver las funciones - de retrollamada de los observadores. - - - - - - data - - - - Datos personalizados asociados con el observador. - - - - - - priority - - - - Prioridad de - el observador - - - - - - - - &reftitle.returnvalues; - - - - - &reftitle.seealso; - - - EvChild::__construct - - - EvLoop::child - - - - - - diff --git a/reference/ev/evchild/set.xml b/reference/ev/evchild/set.xml deleted file mode 100644 index 940e04423f..0000000000 --- a/reference/ev/evchild/set.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - EvChild::set - Configura el observador - - - &reftitle.description; - - public - void - EvChild::set - - int - pid - - - bool - trace - - - - - - &reftitle.parameters; - - - - pid - - - - Idéntico al utilizado para - EvChild::__construct - - - - - - trace - - - - Idéntico al utilizado para - EvChild::__construct - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EvChild::__construct - - - - - diff --git a/reference/ev/evembed.xml b/reference/ev/evembed.xml deleted file mode 100644 index 6cb2bf0472..0000000000 --- a/reference/ev/evembed.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - La clase EvEmbed - EvEmbed - - -
- &reftitle.intro; - - Utilizado para integrar un bucle de eventos en otro. - -
- -
- &reftitle.classsynopsis; - - - - - EvEmbed - - - - - EvEmbed - - - extends - EvWatcher - - - - &Properties; - - public - embed - - &Methods; - - - &InheritedMethods; - - - -
- -
- &reftitle.properties; - - - - is_active - - - - - - - - data - - - - - - - - is_pending - - - - - - - - priority - - - - - - - - embed - - - - - - -
- -
- - &reference.ev.entities.evembed; - -
- diff --git a/reference/ev/evembed/construct.xml b/reference/ev/evembed/construct.xml deleted file mode 100644 index 0b63234bb0..0000000000 --- a/reference/ev/evembed/construct.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - EvEmbed::__construct - Construye un objeto EvEmbed - - - &reftitle.description; - - public - EvEmbed::__construct - - object - other - - - callable - callback - - - mixed - data - - - int - priority - - - - Se trata de un tipo de watcher avanzado que permite integrar un bucle - de eventos en otro (actualmente, solo los eventos IO son - soportados en el bucle interno, otros tipos de watcher no deben - ser utilizados). - - - Ver la - - documentación libev para más detalles. - - - Este watcher es más útil en sistemas - BSD donde kqueue no es utilizado, - para poder manejar un gran número de sockets. Ver el ejemplo a continuación. - - - - &reftitle.parameters; - - - - other - - - - Una instancia de EvLoop. El bucle a integrar; - debe ser encapsulable (ver el método - Ev::embeddableBackends). - - - - - - callback - - - - Ver las - funciones de retrollamada de los Watcher. - - - - - - data - - - - Datos personalizados para asociar con el watcher. - - - - - - priority - - - - Prioridad del Watcher - - - - - - - - &reftitle.examples; - - - Encapsulamiento de un bucle creado con el gestor kqueue en el bucle por omisión - - -]]> - - - - - &reftitle.seealso; - - - Ev::embeddableBackends - - - - - diff --git a/reference/ev/evembed/createstopped.xml b/reference/ev/evembed/createstopped.xml deleted file mode 100644 index a23596f3ae..0000000000 --- a/reference/ev/evembed/createstopped.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - EvEmbed::createStopped - Crea un objeto EvEmbed watcher detenido - - - &reftitle.description; - - final - public - static - void - EvEmbed::createStopped - - object - other - - - callable - callback - - - mixed - data - - - int - priority - - - - Idéntico al método - EvEmbed::__construct, pero no inicia - automáticamente el watcher. - - - - &reftitle.parameters; - - - - other - - - - Idéntico al argumento del método - EvEmbed::__construct - - - - - - callback - - - - Ver las - retrollamadas de los Watcher. - - - - - - data - - - - Datos personalizados para asociar con el watcher. - - - - - - priority - - - - Prioridad del Watcher - - - - - - - &reftitle.returnvalues; - - Retorna un objeto EvEmbed detenido en caso de éxito. - - - - &reftitle.seealso; - - - EvEmbed::__construct - - - Ev::embeddableBackends - - - - - diff --git a/reference/ev/evembed/set.xml b/reference/ev/evembed/set.xml deleted file mode 100644 index fc7a42b6a2..0000000000 --- a/reference/ev/evembed/set.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - EvEmbed::set - Configura el watcher - - - &reftitle.description; - - public - void - EvEmbed::set - - object - other - - - - Configura el watcher para utilizar el objeto - other del bucle de eventos. - - - - &reftitle.parameters; - - - - other - - - - Idéntico al argumento del método - EvEmbed::__construct - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/evembed/sweep.xml b/reference/ev/evembed/sweep.xml deleted file mode 100644 index aac969309a..0000000000 --- a/reference/ev/evembed/sweep.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - EvEmbed::sweep - Barre, una sola vez y de forma no bloqueante, el bucle interno - - - &reftitle.description; - - public - void - EvEmbed::sweep - - - - Barre, una sola vez y de forma no bloqueante, el bucle interno. - Funciona de la misma manera que lo siguiente, pero de una forma más - apropiada para los bucles internos: - -start(Ev::RUN_NOWAIT); -?> -]]> - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EvWatcher::start - - - - - diff --git a/reference/ev/evfork.xml b/reference/ev/evfork.xml deleted file mode 100644 index 6ac4fa52fd..0000000000 --- a/reference/ev/evfork.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - La clase EvFork - EvFork - - -
- &reftitle.intro; - - Los observadores Fork son llamados cuando un - fork() ha sido detectado (habitualmente, porque - señalado a libev al llamar al método - EvLoop::fork). La invocación se - realiza antes de que el bucle de eventos bloquee el siguiente - y antes de la llamada de los observadores EvCheck, - y solo en el hijo después del fork. Tenga en cuenta que si alguien - llama a EvLoop::fork en el proceso incorrecto, el gestor de fork será llamado también. - -
- -
- &reftitle.classsynopsis; - - - - - EvFork - - - - - EvFork - - - extends - EvWatcher - - - - - &InheritedProperties; - - &Methods; - - - &InheritedMethods; - - - -
-
- - &reference.ev.entities.evfork; - -
- diff --git a/reference/ev/evfork/construct.xml b/reference/ev/evfork/construct.xml deleted file mode 100644 index 4123e05213..0000000000 --- a/reference/ev/evfork/construct.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - EvFork::__construct - Construye el objeto observador EvFork - - - &reftitle.description; - - public - EvFork::__construct - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Construye el objeto observador EvFork y arranca el observador automáticamente. - - - - &reftitle.parameters; - - - - callback - - - - Véase también las - funciones de retrollamada para - los observadores. - - - - - - data - - - - Datos personalizados asociados al observador. - - - - - - priority - - - - Prioridad del observador - - - - - - - - &reftitle.seealso; - - - EvLoop::fork - - - EvCheck - - - - - diff --git a/reference/ev/evfork/createstopped.xml b/reference/ev/evfork/createstopped.xml deleted file mode 100644 index 20e4503ae3..0000000000 --- a/reference/ev/evfork/createstopped.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - EvFork::createStopped - Crea una instancia detenida de la clase observadora EvFork - - - &reftitle.description; - - final - public - static - object - EvFork::createStopped - - string - callback - - - string - data - - - string - priority - - - - Idéntico al método - EvFork::__construct pero - no inicia automáticamente el observador. - - - - &reftitle.parameters; - - - - callback - - - - Ver las - retrollamadas de observadores. - - - - - - data - - - - Datos personalizados asociados con el observador. - - - - - - priority - - - - Prioridad de observador - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto EvFork (detenido) en caso de éxito. - - - - &reftitle.seealso; - - - EvFork::__construct - - - - - diff --git a/reference/ev/evidle.xml b/reference/ev/evidle.xml deleted file mode 100644 index 085a08abf5..0000000000 --- a/reference/ev/evidle.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - La clase EvIdle - EvIdle - - -
- &reftitle.intro; - - Los observadores EvIdle lanzan los eventos - cuando ningún otro evento con la misma (o superior) prioridad - está pendiente (EvPrepare, EvCheck - y otros observadores EvIdle no cuentan - como eventos). - - - Asimismo, mientras el proceso está gestionando sockets o - tiempos de espera máximos (o incluso señales) de la misma prioridad (o - de prioridad superior), no se lanzará. Pero cuando el proceso - está inactivo (o solo hay observadores con prioridad baja pendientes), los observadores EvIdle serán llamados - una vez por iteración del bucle de eventos - y esto, mientras - no se detengan, o el proceso no reciba más eventos - y se ocupe así de gestionar trabajos con prioridad superior. - - - Además de mantener el proceso no bloqueante (lo cual es útil a veces), - los observadores EvIdle son un buen lugar - para realizar "trabajos en pseudo-segundo plano", - o reprogramar trabajos después de que el bucle de eventos haya gestionado - los eventos excepcionales. - - - El efecto más notable es que, mientras los observadores - idle estén activos, el proceso - no se bloqueará al esperar nuevos - eventos. - -
- -
- &reftitle.classsynopsis; - - - - - EvIdle - - - - - EvIdle - - - extends - EvWatcher - - - - - &InheritedProperties; - - &Methods; - - - &InheritedMethods; - - - -
- -
- - &reference.ev.entities.evidle; - -
- diff --git a/reference/ev/evidle/construct.xml b/reference/ev/evidle/construct.xml deleted file mode 100644 index c8f52f3233..0000000000 --- a/reference/ev/evidle/construct.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - EvIdle::__construct - Construye el objeto observador EvIdle - - - &reftitle.description; - - public - EvIdle::__construct - - callable - callback - - - mixed - data - - - int - priority - - - - Construye el objeto observador EvIdle e inicia automáticamente - el observador. - - - - &reftitle.parameters; - - - - callback - - - - Ver las - funciones de retrollamada de los - observadores. - - - - - - data - - - - Datos personalizados asociados con el observador. - - - - - - priority - - - - Prioridad del observador - - - - - - - - &reftitle.seealso; - - - EvIdle::createStopped - - - EvLoop::idle - - - - - - diff --git a/reference/ev/evidle/createstopped.xml b/reference/ev/evidle/createstopped.xml deleted file mode 100644 index 622e8f68e6..0000000000 --- a/reference/ev/evidle/createstopped.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - EvIdle::createStopped - Crea una instancia de un objeto observador EvIdle - - - &reftitle.description; - - final - public - static - object - EvIdle::createStopped - - string - callback - - - mixed - data - - - int - priority - - - - Idéntico al método EvIdle::__construct - pero no inicia automáticamente el observador. - - - - &reftitle.parameters; - - - - callback - - - - Ver las - retrollamadas de los - observadores. - - - - - - data - - - - Datos personalizados con el observador. - - - - - - priority - - - - Prioridad del observador - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto EvIdle en caso de éxito. - - - - &reftitle.seealso; - - - EvIdle::__construct - - - EvLoop::idle - - - - - diff --git a/reference/ev/evio.xml b/reference/ev/evio.xml deleted file mode 100644 index 6cab5d67c8..0000000000 --- a/reference/ev/evio.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - La clase EvIo - EvIo - - -
- &reftitle.intro; - - Los observadores EvIo verifican si un descriptor - de fichero (o un socket, o un flujo que pueda ser convertido en descriptor - de fichero numérico) está disponible para lectura o escritura en cada - iteración del bucle de eventos, o, más precisamente, cuando la - lectura no va a bloquear el proceso, y cuando la escritura va - a permitir escribir datos. Este comportamiento se denomina - nivel de activación porque los eventos se - mantienen mientras persista la condición. Para detener la recepción - de eventos, simplemente se debe detener el observador. - - - El número de eventos de lectura/escritura de los observadores por - fd es ilimitado. Establecer todos los - descriptores de ficheros en modo no bloqueante es generalmente - una buena idea (aunque no es obligatorio). - - - Otra cosa a tener en cuenta es que es muy fácil recibir - notificaciones falsas de sistema listo para lectura, es decir, la función - de retrollamada puede ser llamada con Ev::READ - pero una subsiguiente read() puede bloquearse - debido a que no hay datos. Es muy simple - encontrarse en esta situación. Por lo tanto, se recomienda siempre - utilizar I/O no bloqueante: una read() - adicional que devuelva EAGAIN (o similar) - es preferible a un programa que espera la llegada de datos. - - - Si por alguna razón no es posible ejecutar el - fd en modo no bloqueante, entonces, por separado, - se debe volver a verificar si el descriptor de fichero está realmente listo. - Algunos usuarios utilizan además SIGALRM - y un temporizador de intervalo, solo para asegurarse de que no haya - bloqueos infinitos. - - - Se recomienda siempre utilizar el modo no bloqueante. - -
- -
- &reftitle.classsynopsis; - - - - - EvIo - - - - - EvIo - - - extends - EvWatcher - - - - &Properties; - - public - fd - - - public - events - - &InheritedProperties; - - &Methods; - - - &InheritedMethods; - - - -
- -
- &reftitle.properties; - - - - fd - - - - - - - - events - - - - - - -
- -
- - &reference.ev.entities.evio; - -
- diff --git a/reference/ev/evio/construct.xml b/reference/ev/evio/construct.xml deleted file mode 100644 index 80ec32efb2..0000000000 --- a/reference/ev/evio/construct.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - EvIo::__construct - Construye un nuevo objeto EvIo - - - &reftitle.description; - - public - EvIo::__construct - - mixed - fd - - - int - events - - - callable - callback - - - mixed - data - - - int - priority - - - - Construye un nuevo objeto EvIo y arranca el observador automáticamente. - - - - &reftitle.parameters; - - - - fd - - - - Puede ser un flujo abierto con la función - fopen o cualquier función similar, - descriptores de ficheros o sockets. - - - - - - events - - - - Ev::READ y/o Ev::WRITE. - Ver las - máscaras de octetos. - - - - - - callback - - - - Ver las - funciones de retrollamada de los observadores. - - - - - - data - - - - Datos personalizados asociados con el observador. - - - - - - priority - - - - Prioridad del observador - - - - - - - - &reftitle.seealso; - - - EvIo::createStopped - - - EvLoop::io - - - - - diff --git a/reference/ev/evio/createstopped.xml b/reference/ev/evio/createstopped.xml deleted file mode 100644 index c860e86ccc..0000000000 --- a/reference/ev/evio/createstopped.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - EvIo::createStopped - Crea un objeto observador EvIo detenido - - - &reftitle.description; - - final - public - static - EvIo - EvIo::createStopped - - mixed - fd - - - int - events - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Idéntico al método - EvIo::__construct pero - no inicia automáticamente el observador. - - - - &reftitle.parameters; - - - - fd - - - - Idéntico al método - EvIo::__construct - - - - - - events - - - - Idéntico al método - EvIo::__construct - - - - - - callback - - - - Ver las - funciones de retrollamada de los observadores. - - - - - - data - - - - Datos personalizados asociados con el observador. - - - - - - priority - - - - Prioridad del observador - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto EvIo en caso de éxito. - - - - &reftitle.seealso; - - - EvIo::__construct - - - EvLoop::io - - - - - diff --git a/reference/ev/evio/set.xml b/reference/ev/evio/set.xml deleted file mode 100644 index 4ee46cbc05..0000000000 --- a/reference/ev/evio/set.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - EvIo::set - Configura el observador - - - &reftitle.description; - - public - void - EvIo::set - - mixed - fd - - - int - events - - - - Configura el observador EvIo. - - - - &reftitle.parameters; - - - - fd - - - - Idéntico al método - EvIo::__construct - - - - - - events - - - - Idéntico al método - EvIo::__construct - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/evloop.xml b/reference/ev/evloop.xml deleted file mode 100644 index c618a54f53..0000000000 --- a/reference/ev/evloop.xml +++ /dev/null @@ -1,235 +0,0 @@ - - - - - La clase EvLoop - EvLoop - - -
- &reftitle.intro; - - Representa un bucle de eventos que siempre es distinto del - bucle por defecto. A diferencia del - bucle por defecto, no puede gestionar los - watchers EvChild. - - - Al utilizar hilos, se debe crear un bucle por hilo, - y utilizar el bucle por defecto en el hilo - padre. - - - El bucle de eventos por defecto es inicializado - automáticamente por Ev. Es accesible a través de los - métodos de la clase Ev o mediante el método - EvLoop::defaultLoop. - -
- -
- &reftitle.classsynopsis; - - - - - EvLoop - - - - - final - EvLoop - - - - &Properties; - - public - data - - - public - backend - - - public - is_default_loop - - - public - iteration - - - public - pending - - - public - io_interval - - - public - timeout_interval - - - public - depth - - &Methods; - - - - -
- -
- &reftitle.properties; - - - - data - - - - Datos personalizados para adjuntar al bucle - - - - - - backend - - - - Solo lectura. - Los - flags del backend - que indican el backend de eventos en uso. - - - - - - is_default_loop - - - - Solo lectura. - &true; si es el bucle de eventos por defecto. - - - - - - iteration - - - - El contador de iteración actual del bucle. Ver el método - Ev::iteration. - - - - - - pending - - - - El número de watchers pendientes. - 0 indica que no hay watchers pendientes. - - - - - - io_interval - - - - Un valor alto para io_interval permite a - libev pasar más tiempo recolectando - los eventos EvIo, así, más eventos - pueden ser gestionados por iteración, pero esto aumentará la - latencia. Los tiempos de espera máximos (tanto para - EvPeriodic como para EvTimer) - no se verán afectados. Establecer esta opción a un valor - distinto de cero introducirá una llamada adicional a sleep() - en la mayoría de las iteraciones del bucle. - El tiempo de pausa asegura que libev - no consultará EvIo más de una vez - durante este intervalo, en promedio. La mayoría de los programas - pueden beneficiarse estableciendo - io_interval a un valor cercano a - 0.1, lo cual es generalmente suficiente para los - servidores interactivos (y no destinados a juegos). Generalmente - no tiene sentido establecer este valor a menos de - 0.01, ya que se acerca a la - granularidad a nivel de tiempos de la mayoría de los sistemas. - - - Ver también las - - funciones que controlan los bucles de eventos. - - - - - - timeout_interval - - - - Un valor alto para timeout_interval permite a - libev pasar más tiempo recolectando los - tiempos de espera máximos, pero como consecuencia aumenta - la latencia, el estrés y la inexactitud (la función de retrollamada - del watcher será llamada más tarde). Los watchers EvIo - no se verán afectados. Establecer este valor a un valor no - nulo no introducirá ninguna sobrecarga adicional a - libev. Ver también las - - funciones que controlan los bucles de eventos. - - - - - - depth - - - - La profundidad de la recursión. Ver el método - Ev::depth. - - - - -
- -
- - &reference.ev.entities.evloop; - -
- diff --git a/reference/ev/evloop/backend.xml b/reference/ev/evloop/backend.xml deleted file mode 100644 index 9c4c5c0577..0000000000 --- a/reference/ev/evloop/backend.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - EvLoop::backend - Retorna un integer que describe el backend utilizado por libev - - - &reftitle.description; - - public - int - EvLoop::backend - - - - Idéntico al método Ev::backend, - pero para la instancia del ciclo. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retorna un integer que describe el backend utilizado por libev. - Ver el método Ev::backend. - - - - &reftitle.seealso; - - - Ev::backend - - - - - diff --git a/reference/ev/evloop/check.xml b/reference/ev/evloop/check.xml deleted file mode 100644 index f07716b965..0000000000 --- a/reference/ev/evloop/check.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - EvLoop::check - Crea un objeto EvCheck asociado con la instancia del bucle de eventos actual - - - &reftitle.description; - - final - public - EvCheck - EvLoop::check - - string - callback - - - string - data - - - string - priority - - - - Crea un objeto EvCheck asociado con la instancia del bucle de eventos actual. - - - - &reftitle.parameters; - - Todos los argumentos tienen el mismo significado que para el método - EvCheck::__construct. - - - - &reftitle.returnvalues; - - Devuelve un objeto EvCheck en caso de éxito. - - - - &reftitle.seealso; - - - EvCheck::__construct - - - - - diff --git a/reference/ev/evloop/child.xml b/reference/ev/evloop/child.xml deleted file mode 100644 index 6c14c04968..0000000000 --- a/reference/ev/evloop/child.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - EvLoop::child - Crea un objeto EvChild asociado con el bucle de eventos actual - - - &reftitle.description; - - final - public - EvChild - EvLoop::child - - string - pid - - - string - trace - - - string - callback - - - string - data - - - string - priority - - - - Crea un objeto EvChild asociado con el bucle de eventos actual. - - - - &reftitle.parameters; - - Todos los argumentos tienen el mismo significado que para el método - EvChild::__construct. - - - - &reftitle.returnvalues; - - Devuelve un objeto EvChild en caso de éxito. - - - - &reftitle.seealso; - - - EvChild::__construct - - - - - diff --git a/reference/ev/evloop/construct.xml b/reference/ev/evloop/construct.xml deleted file mode 100644 index b3ec021806..0000000000 --- a/reference/ev/evloop/construct.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - EvLoop::__construct - Construye un objeto de bucle de eventos - - - &reftitle.description; - - public - EvLoop::__construct - - int - flags - - - mixed - data - NULL - - - float - io_interval - 0.0 - - - float - timeout_interval - 0.0 - - - - Construye el objeto de bucle de eventos. - - - - &reftitle.parameters; - - - - flags - - - - Uno de los - flags de bucle - de eventos - - - - - - data - - - - Datos personalizados para asociar con el bucle. - - - - - - io_interval - - - - Ver la función - io_interval - - - - - - timeout_interval - - - - Ver la función - timeout_interval - - - - - - - - &reftitle.seealso; - - - EvLoop::defaultLoop - - - - - diff --git a/reference/ev/evloop/defaultloop.xml b/reference/ev/evloop/defaultloop.xml deleted file mode 100644 index cea1e391bf..0000000000 --- a/reference/ev/evloop/defaultloop.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - - EvLoop::defaultLoop - Devuelve o crea el bucle de eventos por omisión - - - &reftitle.description; - - public - static - EvLoop - EvLoop::defaultLoop - - int - flags - Ev::FLAG_AUTO - - - mixed - data - NULL - - - float - io_interval - 0. - - - float - timeout_interval - 0. - - - - Si el bucle de eventos por omisión no está creado, el método - EvLoop::defaultLoop lo crea con los parámetros - especificados. De lo contrario, devolverá la instancia del objeto correspondiente - previamente creado ignorando todos los parámetros. - - - - &reftitle.parameters; - - - - flags - - - - Uno de los - flags de bucle de eventos - - - - - - data - - - - Datos personalizados para asociar con el bucle. - - - - - - io_collect_interval - - - - Ver la función - io_interval - - - - - - timeout_collect_interval - - - - Ver la función - timeout_interval - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto EvLoop en caso de éxito. - - - - &reftitle.seealso; - - - EvLoop::__construct - - - - - diff --git a/reference/ev/evloop/embed.xml b/reference/ev/evloop/embed.xml deleted file mode 100644 index a7da590830..0000000000 --- a/reference/ev/evloop/embed.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - EvLoop::embed - Crea una instancia del observador EvEmbed asociado con el objeto EvLoop actual - - - &reftitle.description; - - final - public - EvEmbed - EvLoop::embed - - string - other - - - string - callback - - - string - data - - - string - priority - - - - Crea una instancia del observador - EvEmbed asociado con el objeto - EvLoop actual. - - - - &reftitle.parameters; - - Todos los argumentos tienen el mismo significado que para el método - EvEmbed::__construct. - - - - &reftitle.returnvalues; - - Devuelve el objeto EvEmbed en caso de éxito. - - - - &reftitle.seealso; - - - EvEmbed::__construct - - - - - diff --git a/reference/ev/evloop/fork.xml b/reference/ev/evloop/fork.xml deleted file mode 100644 index 77e2e8ca99..0000000000 --- a/reference/ev/evloop/fork.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - EvLoop::fork - Crea un objeto EvFork watcher asociado con la instancia del bucle de eventos actual - - - &reftitle.description; - - final - public - EvFork - EvLoop::fork - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Crea un objeto EvFork watcher asociado con la instancia del bucle de eventos actual - - - - &reftitle.parameters; - - Todos los parámetros tienen el mismo significado que los de la función - EvFork::__construct. - - - - &reftitle.returnvalues; - - Devuelve el objeto EvFork en caso de éxito. - - - - &reftitle.seealso; - - - EvFork::__construct - - - - - diff --git a/reference/ev/evloop/idle.xml b/reference/ev/evloop/idle.xml deleted file mode 100644 index 97e5a8ce35..0000000000 --- a/reference/ev/evloop/idle.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - EvLoop::idle - Crea un objeto EvIdle watcher asociado con la instancia del bucle - de eventos actual - - - &reftitle.description; - - final - public - EvIdle - EvLoop::idle - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Crea un objeto EvIdle watcher asociado con la instancia del bucle - de eventos actual - - - - &reftitle.parameters; - - Todos los parámetros tienen el mismo significado que los de la función - EvIdle::__construct - - - - &reftitle.returnvalues; - - Devuelve un objeto EvIdle en caso de éxito. - - - - &reftitle.seealso; - - - EvIdle::__construct - - - - - diff --git a/reference/ev/evloop/invokepending.xml b/reference/ev/evloop/invokepending.xml deleted file mode 100644 index cd5361907e..0000000000 --- a/reference/ev/evloop/invokepending.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - EvLoop::invokePending - Invoca todos los watchers pendientes mientras sus estados - de cola no sean reinicializados - - - &reftitle.description; - - public - void - EvLoop::invokePending - - - - Invoca todos los watchers pendientes mientras sus estados - de cola no sean reinicializados. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/evloop/io.xml b/reference/ev/evloop/io.xml deleted file mode 100644 index ac9332975a..0000000000 --- a/reference/ev/evloop/io.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - EvLoop::io - Crea un objeto EvIo watcher asociado con la instancia del bucle de eventos actual - - - &reftitle.description; - - final - public - EvIo - EvLoop::io - - mixed - fd - - - int - events - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Crea un objeto EvIo watcher asociado con la instancia del bucle de eventos actual. - - - - &reftitle.parameters; - - Todos los parámetros tienen el mismo significado que los del método - EvIo::__construct. - - - - &reftitle.returnvalues; - - Devuelve un objeto EvIo en caso de éxito. - - - - &reftitle.seealso; - - - EvIo::__construct - - - - - diff --git a/reference/ev/evloop/loopfork.xml b/reference/ev/evloop/loopfork.xml deleted file mode 100644 index 3e192123df..0000000000 --- a/reference/ev/evloop/loopfork.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - EvLoop::loopFork - Debe ser llamado después de un fork - - - &reftitle.description; - - public - void - EvLoop::loopFork - - - - Debe ser llamado después de un fork en el hijo, - y antes de entrar o continuar el bucle de eventos. Una alternativa - es utilizar la constante Ev::FLAG_FORKCHECK - que llama a esta función automáticamente, con una pérdida de - rendimiento (consulte la documentación - libev). - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/evloop/now.xml b/reference/ev/evloop/now.xml deleted file mode 100644 index 2296333223..0000000000 --- a/reference/ev/evloop/now.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - EvLoop::now - Devuelve el "event loop time" actual - - - &reftitle.description; - - public - float - EvLoop::now - - - - Devuelve el "event loop time" actual, que es la duración durante - la cual el bucle de eventos recibe eventos y - inicia sus análisis. Este timestamp no cambia mientras las - retrollamadas están en ejecución, y es también el tiempo - base utilizado para los temporizadores relativos. Puede considerarse - como el timestamp del evento en curso (o más exactamente, - el utilizado por libev). - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve el timestamp del bucle de eventos, en segundos. - - - - &reftitle.seealso; - - - Ev::now - - - - - diff --git a/reference/ev/evloop/nowupdate.xml b/reference/ev/evloop/nowupdate.xml deleted file mode 100644 index ab704bc058..0000000000 --- a/reference/ev/evloop/nowupdate.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - EvLoop::nowUpdate - Establece el tiempo actual solicitándolo al kernel y actualiza el tiempo devuelto por EvLoop::now durante la ejecución - - - &reftitle.description; - - public - void - EvLoop::nowUpdate - - - - Establece el tiempo actual solicitándolo al kernel y actualiza el tiempo devuelto por EvLoop::now durante la ejecución. - Se trata de una operación costosa en términos de rendimiento que normalmente se ejecuta automáticamente en el método EvLoop::run. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EvLoop::now - - - Ev::nowUpdate - - - - - diff --git a/reference/ev/evloop/periodic.xml b/reference/ev/evloop/periodic.xml deleted file mode 100644 index cfef923401..0000000000 --- a/reference/ev/evloop/periodic.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - EvLoop::periodic - Crea un objeto EvPeriodic watcher asociado con la instancia del - bucle de eventos actual - - - &reftitle.description; - - final - public - EvPeriodic - EvLoop::periodic - - float - offset - - - float - interval - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Crea un objeto EvPeriodic watcher asociado con la instancia del - bucle de eventos actual. - - - - &reftitle.parameters; - - Todos los parámetros tienen el mismo significado que los de la método - EvPeriodic::__construct. - - - - &reftitle.returnvalues; - - Devuelve un objeto EvPeriodic en caso de éxito. - - - - &reftitle.seealso; - - - EvPeriodic::__construct - - - - - diff --git a/reference/ev/evloop/prepare.xml b/reference/ev/evloop/prepare.xml deleted file mode 100644 index f4c567bc31..0000000000 --- a/reference/ev/evloop/prepare.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - EvLoop::prepare - Crea un objeto EvPrepare watcher asociado con la instancia del bucle de eventos actual - - - &reftitle.description; - - final - public - EvPrepare - EvLoop::prepare - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Crea un objeto EvPrepare watcher asociado con la instancia del bucle de eventos actual. - - - - &reftitle.parameters; - - Todos los parámetros tienen el mismo significado que los de la función - EvPrepare. - - - - &reftitle.returnvalues; - - Devuelve un objeto EvPrepare en caso de éxito. - - - - &reftitle.seealso; - - - EvPrepare::__construct - - - - - diff --git a/reference/ev/evloop/resume.xml b/reference/ev/evloop/resume.xml deleted file mode 100644 index 6bd9d53f70..0000000000 --- a/reference/ev/evloop/resume.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - EvLoop::resume - Reanuda un bucle de eventos previamente detenido - - - &reftitle.description; - - public - void - EvLoop::resume - - - - Los métodos EvLoop::suspend - y EvLoop::resume suspenden y - reanudan un bucle. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EvLoop::suspend - - - Ev::resume - - - - - diff --git a/reference/ev/evloop/run.xml b/reference/ev/evloop/run.xml deleted file mode 100644 index 392dd778d2..0000000000 --- a/reference/ev/evloop/run.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - EvLoop::run - Comienza a verificar los eventos y a llamar a las funciones de retrollamada de la bucle - - - &reftitle.description; - - public - void - EvLoop::run - - int - flags - 0 - - - - Comienza a verificar los eventos y a llamar a las funciones de retrollamada - para la bucle de evento actual. El método se detiene cuando una - función de retrollamada llama al método Ev::stop - o cuando los flags son diferentes de cero (en cuyo caso, el valor - devuelto es &true;) o cuando no hay ningún watcher activo que referencie - la bucle (EvWatcher::keepalive vale &true;), - en cuyo caso, el valor devuelto será &false;. - El valor devuelto puede generalmente ser interpretado como - si &true;, aún hay trabajo por hacer. - - - - &reftitle.parameters; - - - - flags - - - - El argumento opcional flags - puede tomar uno de los valores siguientes: - - - Lista de valores posibles para <parameter>flags</parameter> - - - - - - flags - - Descripción - - - - - - 0 - - El comportamiento por omisión, descrito anteriormente - - - - Ev::RUN_ONCE - - No bloquear más de un evento (espera, pero no bucla) - - - - Ev::RUN_NOWAIT - - Sin bloqueo (recupera, gestiona los eventos, pero no espera) - - - -
-
- - Ver las - constantes de los flags - de ejecución. - -
-
-
-
- - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EvLoop::stop - - - Ev::run - - - -
- diff --git a/reference/ev/evloop/signal.xml b/reference/ev/evloop/signal.xml deleted file mode 100644 index 232f37de80..0000000000 --- a/reference/ev/evloop/signal.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - EvLoop::signal - Crea un objeto EvSignal watcher asociado con la instancia del - bucle de eventos actual - - - &reftitle.description; - - final - public - EvSignal - EvLoop::signal - - int - signum - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Crea un objeto EvSignal watcher asociado con la instancia del - bucle de eventos actual. - - - - &reftitle.parameters; - - Todos los argumentos tienen el mismo significado que los de la método - EvSignal::__construct. - - - - &reftitle.returnvalues; - - Devuelve un objeto EvSignal en caso de éxito. - - - - &reftitle.seealso; - - - EvSignal::__construct - - - - - diff --git a/reference/ev/evloop/stat.xml b/reference/ev/evloop/stat.xml deleted file mode 100644 index 83e44efac4..0000000000 --- a/reference/ev/evloop/stat.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - EvLoop::stat - Crea un objeto EvStat watcher asociado con la instancia del bucle de eventos actual - - - &reftitle.description; - - final - public - EvStat - EvLoop::stat - - string - path - - - float - interval - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Crea un objeto EvStat watcher asociado con la instancia del bucle de eventos actual. - - - - &reftitle.parameters; - - Todos los parámetros tienen el mismo significado que los de la función - EvSignal::__construct. - - - - &reftitle.returnvalues; - - Devuelve un objeto EvStat en caso de éxito. - - - - &reftitle.seealso; - - - EvSignal::__construct - - - - - diff --git a/reference/ev/evloop/stop.xml b/reference/ev/evloop/stop.xml deleted file mode 100644 index 15caf67f35..0000000000 --- a/reference/ev/evloop/stop.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - EvLoop::stop - Detiene el bucle de eventos - - - &reftitle.description; - - public - void - EvLoop::stop - - int - how - - - - Detiene el bucle de eventos. - - - - &reftitle.parameters; - - - - how - - - - Una constante - Ev::BREAK_*. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EvLoop::run - - - Ev::stop - - - - - diff --git a/reference/ev/evloop/suspend.xml b/reference/ev/evloop/suspend.xml deleted file mode 100644 index 854bb298e5..0000000000 --- a/reference/ev/evloop/suspend.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - EvLoop::suspend - Suspende el bucle - - - &reftitle.description; - - public - void - EvLoop::suspend - - - - Los métodos EvLoop::suspend - y EvLoop::resume suspenden - y reanudan un bucle. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EvLoop::resume - - - Ev::suspend - - - - - diff --git a/reference/ev/evloop/timer.xml b/reference/ev/evloop/timer.xml deleted file mode 100644 index 7b6977d949..0000000000 --- a/reference/ev/evloop/timer.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - EvLoop::timer - Crea un objeto EvTimer watcher asociado con la instancia del bucle de eventos actual - - - &reftitle.description; - - final - public - EvTimer - EvLoop::timer - - float - after - - - float - repeat - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Crea un objeto EvTimer watcher asociado con la instancia del bucle de eventos actual. - - - - &reftitle.parameters; - - Todos los argumentos tienen el mismo significado que los de la función - EvTimer::__construct. - - - - &reftitle.returnvalues; - - Devuelve el objeto EvTimer en caso de éxito. - - - - &reftitle.seealso; - - - EvTimer::__construct - - - - - diff --git a/reference/ev/evloop/verify.xml b/reference/ev/evloop/verify.xml deleted file mode 100644 index 0fb16b427d..0000000000 --- a/reference/ev/evloop/verify.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - EvLoop::verify - Realiza verificaciones de consistencia interna (para la depuración) - - - &reftitle.description; - - public - void - EvLoop::verify - - - - Realiza verificaciones de consistencia interna (para la depuración - de libev) y detiene el programa si se encuentran estructuras - de datos corruptas. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - Ev::verify - - - - - diff --git a/reference/ev/evperiodic.xml b/reference/ev/evperiodic.xml deleted file mode 100644 index 483aec48cf..0000000000 --- a/reference/ev/evperiodic.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - La clase EvPeriodic - EvPeriodic - - -
- &reftitle.intro; - - Los observadores periódicos son una especie de temporizadores, pero son muy - versátiles. - - - A diferencia de EvTimer, los observadores - EvPeriodic no se basan en un tiempo real - (o un tiempo relativo, el tiempo físico que transcurre), sino en un tiempo - de reloj (tiempo absoluto, calendario o de reloj). La diferencia es - que un tiempo de reloj puede ser más rápido o más lento que un tiempo - real, y los saltos en el tiempo no son raros (por ejemplo, durante un ajuste). - - - Un observador EvPeriodic puede ser configurado para - ser lanzado después de puntos específicos en el tiempo. Por ejemplo, - si un observador EvPeriodic está configurado para - lanzarse "en 10 segundos" (es decir, - EvLoop::now + 10.0, - es decir, un tiempo absoluto, y no un retraso), y el reloj del sistema - se reinicia a enero del año pasado, - entonces tomará un año o más para lanzar el evento (a diferencia - de EvTimer que se lanzará 10 - segundos después de su inicio, ya que utiliza un retraso máximo relativo). - - - Al igual que con los temporizadores, se garantiza que la función de retrollamada sea - llamada únicamente cuando el punto en el tiempo en el que se supone que debe lanzarse - haya pasado. Si varios temporizadores se vuelven listos al mismo tiempo - durante la misma iteración del bucle, entonces aquellos con valores de retraso - máximo más cercanos serán llamados antes que aquellos con valores de retraso - máximo más lejanos (pero esto ya no es cierto cuando una función de retrollamada - llama recursivamente al método EvLoop::run). - -
- -
- &reftitle.classsynopsis; - - - - - EvPeriodic - - - - - EvPeriodic - - - extends - EvWatcher - - - - &Properties; - - public - offset - - - public - interval - - &InheritedProperties; - - &Methods; - - - &InheritedMethods; - - - -
- -
- &reftitle.properties; - - - - offset - - - - Al repetirse, contendrá el valor de la posición, de lo contrario, - será el punto absoluto en el tiempo (el valor de la posición - pasado al método EvPeriodic::set, - aunque libev puede modificar este valor - para una mejor estabilidad numérica). - - - - - - interval - - - - El valor del intervalo actual. Puede ser modificado en cualquier momento, - pero los cambios no surten efecto hasta que el temporizador - periódico no se lance, o cuando se llame al método - EvPeriodic::again. - - - - -
- -
- - &reference.ev.entities.evperiodic; - -
- diff --git a/reference/ev/evperiodic/again.xml b/reference/ev/evperiodic/again.xml deleted file mode 100644 index 8a04dc2004..0000000000 --- a/reference/ev/evperiodic/again.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - EvPeriodic::again - Detiene y reinicia el observador periódico - - - &reftitle.description; - - public - void - EvPeriodic::again - - - - Detiene y reinicia el observador periódico. Esto solo es útil - cuando los atributos han cambiado. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EvTimer::again - - - - - diff --git a/reference/ev/evperiodic/at.xml b/reference/ev/evperiodic/at.xml deleted file mode 100644 index ced1674fcf..0000000000 --- a/reference/ev/evperiodic/at.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - EvPeriodic::at - Devuelve el tiempo absoluto en el que este watcher será llamado la próxima vez - - - &reftitle.description; - - public - float - EvPeriodic::at - - - - Devuelve el tiempo absoluto en el que este watcher será llamado la próxima vez. - Esto no es lo mismo que el argumento de posición del método - EvPeriodic::set o el método - EvPeriodic::__construct, pero funciona también en - modo intervalo. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve el tiempo absoluto en el que este watcher será llamado la próxima vez, - en segundos. - - - - diff --git a/reference/ev/evperiodic/construct.xml b/reference/ev/evperiodic/construct.xml deleted file mode 100644 index 6e05a505b6..0000000000 --- a/reference/ev/evperiodic/construct.xml +++ /dev/null @@ -1,202 +0,0 @@ - - - - - - EvPeriodic::__construct - Construye un objeto watcher EvPeriodic - - - &reftitle.description; - - public - EvPeriodic::__construct - - float - offset - - - string - interval - - - callable - reschedule_cb - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Construye un objeto watcher EvPeriodic y lo inicia automáticamente. - El método EvPeriodic::createStopped - crea un watcher periódico detenido. - - - - &reftitle.parameters; - - - - offset - - - - Ver los - modos de operación del watcher periódico - - - - - - interval - - - - Ver los - modos de operación del watcher periódico - - - - - - reschedule_cb - - - - Función de retrollamada Reschedule. Puede pasarse el valor &null;. - Ver los - modos de operación del watcher periódico - - - - - - callback - - - - Ver las - funciones de retrollamada de los Watchers . - - - - - - data - - - - Datos personalizados para asociar con el watcher. - - - - - - priority - - - - Prioridad del Watcher - - - - - - - - &reftitle.examples; - - - Temporizador periódico. Utilizando la retrollamada de replanificación - - - -]]> - - - - Temporizador periódico. Llamado cada 10.5 segundos - - -]]> - - - - Watcher cada hora - - -]]> - - - - - &reftitle.seealso; - - - Los modos de operación del watcher periódico - - - EvTimer - - - EvPeriodic::createStopped - - - - - diff --git a/reference/ev/evperiodic/createstopped.xml b/reference/ev/evperiodic/createstopped.xml deleted file mode 100644 index 3e563d1ba0..0000000000 --- a/reference/ev/evperiodic/createstopped.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - EvPeriodic::createStopped - Crea un watcher EvPeriodic detenido - - - &reftitle.description; - - final - public - static - EvPeriodic - EvPeriodic::createStopped - - float - offset - - - float - interval - - - callable - reschedule_cb - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Crea un objeto EvPeriodic. A diferencia del método - EvPeriodic::__construct, este método - no inicia el watcher automáticamente. - - - - &reftitle.parameters; - - - - offset - - - - Ver - modos de operación del watcher periódico - - - - - - interval - - - - Ver los - modos de operación del watcher periódico - - - - - - reschedule_cb - - - - Función de retrollamada Reschedule. Puede pasarse el valor &null;. - Ver los - modos de operación del watcher periódico - - - - - - callback - - - - Ver las - funciones de retrollamada de los Watchers. - - - - - - data - - - - Datos personalizados para asociar con el watcher. - - - - - - priority - - - - Prioridad del Watcher - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto watcher EvPeriodic en caso de éxito. - - - - &reftitle.seealso; - - - EvPeriodic::__construct - - - EvTimer::createStopped - - - - - diff --git a/reference/ev/evperiodic/set.xml b/reference/ev/evperiodic/set.xml deleted file mode 100644 index 7130b70543..0000000000 --- a/reference/ev/evperiodic/set.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - EvPeriodic::set - Configura el watcher - - - &reftitle.description; - - public - void - EvPeriodic::set - - float - offset - - - float - interval - - - - (Re-)Configura el watcher EvPeriodic. - - - - &reftitle.parameters; - - - - offset - - - - El mismo significado que para el método - EvPeriodic::__construct. - Ver los - modos de operación del watcher periódico - - - - - - interval - - - - El mismo significado que para el método - EvPeriodic::__construct. - Ver los - modos de operación del watcher periódico - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/evprepare.xml b/reference/ev/evprepare.xml deleted file mode 100644 index 7aebd0df93..0000000000 --- a/reference/ev/evprepare.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - La clase EvPrepare - EvPrepare - - -
- -
- -
- &reftitle.classsynopsis; - - - - - EvPrepare - - - - - EvPrepare - - - extends - EvWatcher - - - - - &InheritedProperties; - - &Methods; - - - &InheritedMethods; - - - -
-
- - &reference.ev.entities.evprepare; - -
- diff --git a/reference/ev/evprepare/construct.xml b/reference/ev/evprepare/construct.xml deleted file mode 100644 index 38acacf147..0000000000 --- a/reference/ev/evprepare/construct.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - EvPrepare::__construct - Construye un objeto watcher EvPrepare - - - &reftitle.description; - - public - EvPrepare::__construct - - string - callback - - - string - data - - - string - priority - - - - Construye un objeto watcher EvPrepare. - Inicia el watcher automáticamente. Si se necesita - un watcher detenido, se debe utilizar el método - EvPrepare::createStopped. - - - - &reftitle.parameters; - - - - callback - - - - Ver las - retrollamadas de los Watchers. - - - - - - data - - - - Datos personalizados para asociar con el watcher. - - - - - - priority - - - - Prioridad del Watcher - - - - - - - - &reftitle.seealso; - - - EvCheck - - - - - diff --git a/reference/ev/evprepare/createstopped.xml b/reference/ev/evprepare/createstopped.xml deleted file mode 100644 index 59ca32d16a..0000000000 --- a/reference/ev/evprepare/createstopped.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - EvPrepare::createStopped - Crea una instancia detenida del watcher EvPrepare - - - &reftitle.description; - - final - public - static - EvPrepare - EvPrepare::createStopped - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Crea una instancia detenida del watcher EvPrepare. A diferencia - del método EvPrepare::__construct, - este método no inicia el watcher automáticamente. - - - - &reftitle.parameters; - - - - callback - - - - Ver las - funciones de retrollamada de los Watchers. - - - - - - data - - - - Datos personalizados para asociar con el watcher. - - - - - - priority - - - - Prioridad del Watcher - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto EvPrepare en caso de éxito. - - - - &reftitle.seealso; - - - EvPrepare::__construct - - - EvWatcher::start - - - - - diff --git a/reference/ev/evsignal.xml b/reference/ev/evsignal.xml deleted file mode 100644 index 807a42f56d..0000000000 --- a/reference/ev/evsignal.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - La clase EvSignal - EvSignal - - -
- &reftitle.intro; - - Los watchers EvSignal lanzarán un evento - cuando el proceso reciba una señal específica una o varias veces. - A pesar de que las señales sean asíncronas, - libev intentará hacer lo posible para - entregar las señales de forma síncrona, es decir, al igual que cualquier - otro evento. - - - No hay límite para el número de watchers para la misma señal, - pero solo en la misma loop, es decir, se puede vigilar - SIGINT en la loop por defecto, y para - SIGIO en otra loop, pero no está permitido vigilar SIGINT tanto en - la loop por defecto como en otra loop al mismo tiempo. - En este momento, SIGCHLD está permanentemente - vinculado a la loop por defecto. - - - Si es posible y está soportado, libev instalará su - manejador con SA_RESTART (o equivalente) activado, - por lo tanto, las llamadas al sistema no deberían ser interrumpidas. En el caso - de un problema con las llamadas al sistema que se vieran interrumpidas por - señales, todas las señales pueden ser bloqueadas en un watcher - EvCheck y desbloqueadas en un watcher - EvPrepare. - -
- -
- &reftitle.classsynopsis; - - - - - EvSignal - - - - - EvSignal - - - extends - EvWatcher - - - - &Properties; - - public - signum - - &InheritedProperties; - - &Methods; - - - &InheritedMethods; - - - -
- -
- &reftitle.properties; - - - - signum - - - - El número de la señal. Ver las constantes exportadas por la extensión - pcntl. Ver también la página del manual para - signal(7). - - - - -
- -
- - &reference.ev.entities.evsignal; - -
- diff --git a/reference/ev/evsignal/construct.xml b/reference/ev/evsignal/construct.xml deleted file mode 100644 index 962905f818..0000000000 --- a/reference/ev/evsignal/construct.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - EvSignal::__construct - Construye un objeto watcher EvSignal - - - &reftitle.description; - - public - EvSignal::__construct - - int - signum - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Construye un objeto watcher EvSignal y lo inicia automáticamente. - Para un watcher de señal detenido, utilice en su lugar el método - EvSignal::createStopped. - - - - &reftitle.parameters; - - - - signum - - - - Número de la señal. Consulte las constantes exportadas por la extensión - pcntl. Consulte también la página del manual del sistema - signal(7). - - - - - - callback - - - - Consulte las - funciones de retrollamada de los Watchers. - - - - - - data - - - - Datos personalizados para asociar con el watcher. - - - - - - priority - - - - Prioridad del Watcher - - - - - - - - &reftitle.examples; - - Gestión de una señal SIGTERM - -stop(); -}); - -Ev::run(); -?> -]]> - - - - - &reftitle.seealso; - - - EvSignal::createStopped - - - - - diff --git a/reference/ev/evsignal/createstopped.xml b/reference/ev/evsignal/createstopped.xml deleted file mode 100644 index 7e3055bb5c..0000000000 --- a/reference/ev/evsignal/createstopped.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - EvSignal::createStopped - Crea un objeto watcher EvSignal detenido - - - &reftitle.description; - - final - public - static - EvSignal - EvSignal::createStopped - - int - signum - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Crea un objeto watcher EvSignal detenido. A diferencia del método - EvSignal::__construct, este método - no inicia automáticamente el watcher. - - - - &reftitle.parameters; - - - - signum - - - - Número de la señal. Ver las constantes exportadas por la extensión - pcntl. Ver también la página del manual del sistema - signal(7). - - - - - - callback - - - - Ver las - funciones de retrollamada de los Watchers. - - - - - - data - - - - Datos personalizados para asociar con el watcher. - - - - - - priority - - - - Prioridad del Watcher - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto EvSignal en caso de éxito. - - - - &reftitle.seealso; - - - EvWatcher::start - - - EvSignal::__construct - - - - - diff --git a/reference/ev/evsignal/set.xml b/reference/ev/evsignal/set.xml deleted file mode 100644 index 757fdad70c..0000000000 --- a/reference/ev/evsignal/set.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - EvSignal::set - Configura el observador - - - &reftitle.description; - - public - void - EvSignal::set - - int - signum - - - - Configura el observador. - - - - &reftitle.parameters; - - - - signum - - - - Número de la señal. Idéntico al del constructor - EvSignal::__construct. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/evstat.xml b/reference/ev/evstat.xml deleted file mode 100644 index 5389ddce2c..0000000000 --- a/reference/ev/evstat.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - La clase EvStat - EvStat - - -
- &reftitle.intro; - - La clase EvStat supervisa - un fichero del sistema de ficheros para detectar cualquier modificación - de sus atributos. Invoca el comando stat() - en esta ruta, a intervalos regulares (o cuando el sistema operativo notifica una modificación) - y verifica si ha sido modificado desde la última vez, llamando a la - función de retrollamada si es el caso. - - - La ruta no necesita existir: el cambio de "la ruta existe" - a "la ruta no existe" es una modificación de estado como cualquier otra. - La condición "la ruta no existe" está indicada por el valor 0 del - elemento 'nlink' (devolvido por el método - EvStat::attr). - - - La ruta no debe terminar con un slash, ni contener componentes - especiales como '.' o ... - La ruta debe ser absoluta: si es relativa, y el directorio de trabajo - cambia, entonces el comportamiento será indefinido. - - - Dado que no hay una interfaz de notificación de cambios portable, - la implementación portable simplemente invoca el comando - stat() en la ruta para verificar las modificaciones. - Para este caso, un intervalo regular puede ser especificado. Si se especifica, - un intervalo de 0.0 (altamente recomendado) entonces - un valor predeterminado no especificado será utilizado (alrededor de 5 segundos, - y puede ser modificado dinámicamente). libev - también impondrá un intervalo mínimo que actualmente está alrededor - de 0.1, lo cual es ampliamente suficiente. - - - Este tipo de observador no está previsto para un gran número de observadores - EvStat, dado que incluso con las notificaciones - del sistema sobre modificaciones soportadas por el sistema operativo, esto consume muchos - recursos. - -
- -
- &reftitle.classsynopsis; - - - - - EvStat - - - - - EvStat - - - extends - EvWatcher - - - - &Properties; - - public - path - - - public - interval - - &InheritedProperties; - - &Methods; - - - &InheritedMethods; - - - -
- -
- &reftitle.properties; - - - - interval - - - - Solo lectura. La rapidez con la que - una modificación debe ser detectada; normalmente, debe valer - 0.0 para dejar que libev - elija un buen valor. - - - - - - path - - - - Solo lectura. La ruta hacia el fichero - del cual se desean supervisar las modificaciones de estado. - - - - -
- -
- - &reference.ev.entities.evstat; - -
- diff --git a/reference/ev/evstat/attr.xml b/reference/ev/evstat/attr.xml deleted file mode 100644 index 18e1653962..0000000000 --- a/reference/ev/evstat/attr.xml +++ /dev/null @@ -1,188 +0,0 @@ - - - - - - - EvStat::attr - Devuelve el valor más reciente detectado por Ev - - - &reftitle.description; - - public - array - EvStat::attr - - - - Devuelve un array de los valores más recientes detectados por Ev. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve un array de los valores más recientes detectados por Ev - (sin el stat actual): - - Lista de claves del array devuelto por el método <methodname>EvStat::attr</methodname> - - - - Clave - Descripción - - - - - - 'dev' - - ID del dispositivo que contiene el fichero - - - - 'ino' - - número de inodos - - - - 'mode' - - protección - - - - 'nlink' - - número de enlaces duros - - - - 'uid' - - ID del usuario del propietario - - - - 'size' - - tamaño total, en bytes - - - - 'gid' - - ID del grupo del propietario - - - - 'rdev' - - ID del dispositivo (si fichero especial) - - - - 'blksize' - - tamaño del bloque para un sistema de ficheros I/O - - - - 'blocks' - - número de bloques 512B asignados - - - - 'atime' - - Fecha/hora del último acceso - - - - 'ctime' - - Fecha/Hora de la última modificación de estado - - - - 'mtime' - - Fecha/hora de la última modificación - - - -
-
- - Consulte la página del manual sobre stat(2) - para más detalles. - -
- - &reftitle.examples; - - Monitoreo de cambios en /var/log/messages - -attr(); - - if ($attr['nlink']) { - printf("Tamaño actual: %ld\n", $attr['size']); - printf("atime actual: %ld\n", $attr['atime']); - printf("mtime actual: %ld\n", $attr['mtime']); - } else { - fprintf(STDERR, "¡El fichero `messages` no está presente!"); - $w->stop(); - } -}); - -Ev::run(); -?> -]]> - - - - - &reftitle.seealso; - - - EvStat::prev - - - EvStat::stat - - - -
- diff --git a/reference/ev/evstat/construct.xml b/reference/ev/evstat/construct.xml deleted file mode 100644 index 4b5dbe03d6..0000000000 --- a/reference/ev/evstat/construct.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - EvStat::__construct - Construye un objeto EvStat watcher - - - &reftitle.description; - - public - EvStat::__construct - - string - path - - - float - interval - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Construye un objeto EvStat watcher e inicia el watcher automáticamente. - - - - &reftitle.parameters; - - - - path - - - - La ruta de acceso para la cual se espera una modificación de estado. - - - - - - interval - - - - Intervalo de detección de una modificación; debe valer normalmente - 0.0 para dejar que libev - elija el valor adecuado. - - - - - - callback - - - - Ver las - retrollamadas Watcher. - - - - - - data - - - - Datos personalizados para asociar con el watcher. - - - - - - priority - - - - Las prioridades del Watcher - - - - - - - - &reftitle.examples; - - - Monitoreo de cambios en el directorio /var/log/messages - -attr(); - - if ($attr['nlink']) { - printf("Tamaño actual: %ld\n", $attr['size']); - printf("Hora de último acceso: %ld\n", $attr['atime']); - printf("Hora de última modificación: %ld\n", $attr['mtime']); - } else { - fprintf(STDERR, "¡El fichero `messages` no está presente!"); - $w->stop(); - } -}); - -?> -]]> - - - - - diff --git a/reference/ev/evstat/createstopped.xml b/reference/ev/evstat/createstopped.xml deleted file mode 100644 index 36a5a0bb95..0000000000 --- a/reference/ev/evstat/createstopped.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - EvStat::createStopped - Crea un objeto EvStat watcher detenido - - - &reftitle.description; - - final - public - static - void - EvStat::createStopped - - string - path - - - float - interval - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Crea un objeto EvStat watcher, pero no lo inicia automáticamente - (a diferencia del método EvStat::__construct). - - - - &reftitle.parameters; - - - - path - - - - La ruta de acceso para la cual se debe esperar un cambio de estado. - - - - - - interval - - - - Intervalo de detección de la modificación; debe normalmente valer - 0.0 para dejar que libev - elija un buen valor. - - - - - - callback - - - - Ver las - funciones de retrollamada Watcher. - - - - - - data - - - - Datos personalizados para asociar con el watcher. - - - - - - priority - - - - las prioridades del Watcher - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto EvStat watcher detenido en caso de éxito. - - - - &reftitle.seealso; - - - EvStat::__construct - - - EvWatcher::start - - - - - diff --git a/reference/ev/evstat/prev.xml b/reference/ev/evstat/prev.xml deleted file mode 100644 index f4efc04e07..0000000000 --- a/reference/ev/evstat/prev.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - EvStat::prev - Devuelve el conjunto anterior devuelto por EvStat::attr - - - &reftitle.description; - - public - void - EvStat::prev - - - - Idéntico al método EvStat::attr - pero devuelve el conjunto anterior de valores. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve un array con la misma estructura que el array devuelto por - el método EvStat::attr. El array contendrá - los valores detectados previamente. - - - - &reftitle.seealso; - - - EvStat::attr - - - EvStat::stat - - - - - diff --git a/reference/ev/evstat/set.xml b/reference/ev/evstat/set.xml deleted file mode 100644 index 4a5492647f..0000000000 --- a/reference/ev/evstat/set.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - EvStat::set - Configura el watcher - - - &reftitle.description; - - public - void - EvStat::set - - string - path - - - float - interval - - - - Configura el watcher. - - - - &reftitle.parameters; - - - - path - - - - La ruta de acceso para la cual se esperará un cambio de estado. - - - - - - interval - - - - Intervalo de detección de modificaciones; debe normalmente valer - 0.0 para dejar que libev - elija un buen valor. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/evstat/stat.xml b/reference/ev/evstat/stat.xml deleted file mode 100644 index a93bd613be..0000000000 --- a/reference/ev/evstat/stat.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - EvStat::stat - Inicializa la llamada a stat - - - &reftitle.description; - - public - bool - EvStat::stat - - - - Inicializa la llamada a stat (actualización de la caché interna). - El comando llamará a stat (usando lstat) - en la ruta de acceso especificada path en el observador - y establecerá los valores encontrados. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve &true; si path existe. De lo contrario, &false;. - - - - &reftitle.seealso; - - - EvStat::attr - - - EvStat::prev - - - - - diff --git a/reference/ev/evtimer.xml b/reference/ev/evtimer.xml deleted file mode 100644 index 412a073c33..0000000000 --- a/reference/ev/evtimer.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - La clase EvTimer - EvTimer - - -
- &reftitle.intro; - - Los observadores EvTimer son observadores relativamente - simples que generan un evento después de un tiempo especificado y, opcionalmente, - se repiten a intervalos regulares. - - - Los temporizadores se basan en tiempo real, por lo que si un temporizador - programa un evento que finaliza después de una hora y se reinicia el reloj del sistema - a enero del año pasado, volverá a estar fuera de tiempo - después de una hora (aproximadamente). "Aproximadamente" porque la detección de - saltos en el tiempo es difícil y ciertas inexactitudes son inevitables. - - - Se garantiza que la función de retrollamada se llamará solo después de que - expire el tiempo de espera máximo (y no exactamente en ese momento preciso, - por lo que en sistemas con una resolución de reloj baja, puede introducirse - un pequeño retraso). Si varios temporizadores están listos durante la misma - iteración del bucle, el que tenga el valor de tiempo de espera máximo más cercano - se invocará antes que otro con la misma prioridad pero con un valor de tiempo - de espera más lejano (aunque esto ya no es cierto cuando una función de retrollamada - llama recursivamente al método EvLoop::run). - - - El temporizador en sí hará todo lo posible para no derivar, pero si un temporizador - está configurado para ejecutarse cada 10 segundos, entonces - normalmente se ejecutará exactamente cada 10 segundos. - Sin embargo, si el script no puede mantener el temporizador porque tarda más - que sus 10 segundos, el temporizador no podrá ejecutarse - más de una vez por iteración del bucle de eventos. - -
- -
- &reftitle.classsynopsis; - - - - - EvTimer - - - - - EvTimer - - - extends - EvWatcher - - - - &Properties; - - public - repeat - - - public - remaining - - &InheritedProperties; - - &Methods; - - - &InheritedMethods; - - - -
- -
- &reftitle.properties; - - - - repeat - - - - Si esta propiedad vale 0.0, entonces se detendrá automáticamente - una vez alcanzado el tiempo de espera máximo. Si es positivo, entonces el temporizador - se configurará automáticamente para ejecutarse cada segundo siguiente, hasta que - no se detenga manualmente. - - - - - - remaining - - - - Devuelve el tiempo restante antes de que el temporizador se ejecute. - Si el temporizador está activo, entonces este tiempo será relativo al tiempo - del bucle de eventos actual, de lo contrario, será relativo al valor del - tiempo de espera máximo configurado actualmente. - - - Asimismo, después de instanciar un EvTimer - con un valor de after en - 5.0 y un valor de repeat - en 7.0, remaining devolverá - 5.0. Cuando el temporizador se inicia y pasa un - segundo, remaining devolverá - 4.0. Cuando el temporizador expire y se reinicie, - devolverá aproximadamente 7.0 - (probablemente un poco menos, ya que la invocación de la función de retrollamada - también lleva algo de tiempo), y así sucesivamente. - - - - -
- -
- - &reference.ev.entities.evtimer; - -
- diff --git a/reference/ev/evtimer/again.xml b/reference/ev/evtimer/again.xml deleted file mode 100644 index 93511d4cce..0000000000 --- a/reference/ev/evtimer/again.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - EvTimer::again - Reinicia el watcher Timer - - - &reftitle.description; - - public - void - EvTimer::again - - - - Este método funciona como si el Timer hubiera terminado y reinicia su ciclo. - La semántica exacta es: - - - - - si el Timer está en espera, su estado se limpia. - - - - - si el Timer está en ejecución, pero no debe reiniciarse, entonces se detendrá - (como si hubiera terminado normalmente). - - - - - si el Timer debe reiniciarse, el método lo iniciará si es necesario (con el - valor repeat), o reiniciará el Timer al valor de la - variable repeat. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EvWatcher::stop - - - - - diff --git a/reference/ev/evtimer/construct.xml b/reference/ev/evtimer/construct.xml deleted file mode 100644 index ff6f967292..0000000000 --- a/reference/ev/evtimer/construct.xml +++ /dev/null @@ -1,217 +0,0 @@ - - - - - - EvTimer::__construct - Construye un objeto EvTimer watcher - - - &reftitle.description; - - public - EvTimer::__construct - - float - after - - - float - repeat - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Construye un objeto EvTimer watcher. - - - - &reftitle.parameters; - - - - after - - - - Configura el tiempo para lanzar el trigger después de - after segundos. - - - - - - repeat - - - - Si este argumento vale 0.0, entonces el watcher - se detendrá automáticamente cuando se alcance el tiempo máximo de espera. Si este argumento es positivo, entonces el timer lanzará automáticamente el trigger cada segundo siguiente, hasta que se detenga manualmente. - - - - - - callback - - - - Ver las - funciones de retrollamada Watcher. - - - - - - data - - - - Datos personalizados asociados con el watcher. - - - - - - priority - - - - Las prioridades del Watcher - - - - - - - - &reftitle.examples; - - timers simples - -stop(); - // Detiene el watcher si llamadas posteriores causan más de 10 iteraciones - Ev::iteration() >= 10 and $w->stop(); -}); - -// Crea un timer detenido. Estará inactivo hasta que no se inicie manualmente -$w_stopped = EvTimer::createStopped(10, 5, function($w) { - echo "Función de retrollamada del timer creado detenido\n"; - - // Detiene el watcher después de 2 iteraciones - Ev::iteration() >= 2 and $w->stop(); -}); - -// Bucle mientras Ev::stop() es llamado o mientras todos los watchers no se detienen -Ev::run(); - -// Inicia y bloquea si está en funcionamiento -$w_stopped->start(); -echo "Ejecución de una sola iteración\n"; -Ev::run(Ev::RUN_ONCE); - -echo "Reinicia el segundo watcher y intenta manejar los mismos eventos, pero no bloquea\n"; -$w2->again(); -Ev::run(Ev::RUN_NOWAIT); - -$w = new EvTimer(10, 0, function() {}); -echo "Ejecución de un bucle bloqueante\n"; -Ev::run(); -echo "FIN\n"; -?> -]]> - - &example.outputs.similar; - - - - - - - &reftitle.seealso; - - - EvTimer::createStopped - - - EvPeriodic - - - ev_timer - repetición de un tiempo de espera máximo - - - Ser inteligente con los tiempos de espera máximo - - - - - diff --git a/reference/ev/evtimer/createstopped.xml b/reference/ev/evtimer/createstopped.xml deleted file mode 100644 index 96efe35d2b..0000000000 --- a/reference/ev/evtimer/createstopped.xml +++ /dev/null @@ -1,173 +0,0 @@ - - - - - - EvTimer::createStopped - Crea un objeto EvTimer watcher detenido - - - &reftitle.description; - - final - public - static - EvTimer - EvTimer::createStopped - - float - after - - - float - repeat - - - callable - callback - - - mixed - data - &null; - - - int - priority - 0 - - - - Crea un objeto EvTimer watcher detenido. A diferencia del método - EvTimer::__construct, este método no - inicia automáticamente el watcher. - - - - &reftitle.parameters; - - - - after - - - - Configura el tiempo para lanzar un trigger después de - after segundos. - - - - - - repeat - - - - Si este parámetro vale 0.0, entonces el watcher - se detendrá automáticamente una vez alcanzado el tiempo máximo de espera. - Si este parámetro es positivo, entonces el timer lanzará automáticamente - el trigger cada segundo siguiente, hasta que se detenga manualmente. - - - - - - callback - - - - Ver las - funciones de retrollamada Watcher. - - - - - - data - - - - Datos personales asociados al watcher. - - - - - - priority - - - - Las prioridades del Watcher - - - - - - - &reftitle.returnvalues; - - Retorna un objeto EvTimer watcher en caso de éxito. - - - - &reftitle.examples; - - Monitoreo de modificaciones en /var/log/messages. - Detecta actualizaciones olvidadas añadiendo un segundo de demora - -stop(); - - $stat = $w->data; - - // 1 segundo después de la modificación más reciente del fichero - printf("Tamaño actual: %ld\n", $stat->attr()['size']); -}); - -$stat = new EvStat("/var/log/messages", 0., function () use ($timer) { - // Reinicia el watcher timer - $timer->again(); -}); - -$timer->data = $stat; - -Ev::run(); -?> -]]> - - - - - &reftitle.seealso; - - - EvTimer::__construct - - - EvPeriodic - - - - - diff --git a/reference/ev/evtimer/set.xml b/reference/ev/evtimer/set.xml deleted file mode 100644 index 6e25dcb469..0000000000 --- a/reference/ev/evtimer/set.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - EvTimer::set - Configura el observador - - - &reftitle.description; - - public - void - EvTimer::set - - float - after - - - float - repeat - - - - Configura el observador - - - - &reftitle.parameters; - - - - after - - - - Configura el temporizador del trigger para que se lance después de - after segundos. - - - - - - repeat - - - - Si este argumento vale 0.0, entonces el observador será - automáticamente detenido si se alcanza el tiempo de espera máximo. - Si este argumento es positivo, entonces el temporizador lanzará automáticamente - el trigger en cada segundo siguiente, hasta que no sea detenido manualmente. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/evwatcher.xml b/reference/ev/evwatcher.xml deleted file mode 100644 index 30edd2400c..0000000000 --- a/reference/ev/evwatcher.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - La clase EvWatcher - EvWatcher - - -
- &reftitle.intro; - - La clase EvWatcher es una clase base - para todos los watchers (EvCheck, EvChild - etc.). Dado que el constructor de la clase EvWatcher - es abstract, no se puede - (y no se debe) crear objetos EvWatcher directamente. - -
- -
- &reftitle.classsynopsis; - - - - - EvWatcher - - - - - abstract - EvWatcher - - - - &Properties; - - public - is_active - - - public - data - - - public - is_pending - - - public - priority - - &Methods; - - - - -
- -
- &reftitle.properties; - - - - is_active - - - - Solo lectura. &true; si el watcher está - activo, &false; en caso contrario. - - - - - - data - - - - Datos de usuario personalizados asociados con el watcher - - - - - - is_pending - - - - Solo lectura. Si el watcher está pendiente, - es decir, si el watcher tiene eventos pendientes, pero su función - de retrollamada aún no ha sido llamada, &false; en caso contrario. Mientras el - watcher esté pendiente (pero no activo), otro no puede - modificar sus prioridades. - - - - - - priority - - - - &integer; - Rango de Ev::MINPRI a Ev::MAXPRI. - Los watchers pendientes con una prioridad alta serán llamados - antes que los watchers con una prioridad baja, pero la prioridad no puede - hacer que un watcher nunca sea ejecutado (excepto para los watchers - EvIdle). - Los watchers EvIdle proporcionan funcionalidades - para suprimir la invocación cuando hay eventos con una prioridad - más alta pendientes. - - - - -
- -
- - &reference.ev.entities.evwatcher; - -
- diff --git a/reference/ev/evwatcher/clear.xml b/reference/ev/evwatcher/clear.xml deleted file mode 100644 index 0d66c6d235..0000000000 --- a/reference/ev/evwatcher/clear.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - EvWatcher::clear - Borra el estado de espera del observador - - - &reftitle.description; - - public - int - EvWatcher::clear - - - - Si el observador está en espera, este método borra su estado - de espera (pending) y devuelve su bitset - revents (como si su función de retrollamada hubiera sido invocada). - Si el observador no está en espera, este método no hará nada, - y devolverá 0. - - - Algunas veces, es útil interrogar un observador en lugar de esperar - a que su función de retrollamada sea invocada, y esto es precisamente lo que permite - hacer este método. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - En el caso de que el observador esté en espera, devuelve el bitset - revents, como si su función de retrollamada fuera invocada. - De lo contrario, devuelve 0. - - - - - diff --git a/reference/ev/evwatcher/construct.xml b/reference/ev/evwatcher/construct.xml deleted file mode 100644 index 458cf39db3..0000000000 --- a/reference/ev/evwatcher/construct.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - - EvWatcher::__construct - Constructor de objeto observador - - - &reftitle.description; - - abstract - public - EvWatcher::__construct - - - - EvWatcher::__construct es un constructor - de objeto observador, implementado en las clases derivadas. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - diff --git a/reference/ev/evwatcher/feed.xml b/reference/ev/evwatcher/feed.xml deleted file mode 100644 index d3520db0d1..0000000000 --- a/reference/ev/evwatcher/feed.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - EvWatcher::feed - Alimenta los revents proporcionados en el bucle de eventos - - - &reftitle.description; - - public - void - EvWatcher::feed - - int - revents - - - - Alimenta los revents proporcionados en el bucle de eventos, - como si el evento especificado hubiera ocurrido en el observador. - - - - &reftitle.parameters; - - - - revents - - - - Máscara de bits del observador - de recepción de eventos. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/evwatcher/getloop.xml b/reference/ev/evwatcher/getloop.xml deleted file mode 100644 index 6b7bcf250f..0000000000 --- a/reference/ev/evwatcher/getloop.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - EvWatcher::getLoop - Retorna el bucle responsable del observador - - - &reftitle.description; - - public - EvLoop - EvWatcher::getLoop - - - - Retorna el bucle responsable del observador. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Retorna un objeto EvLoop - responsable del observador. - - - - diff --git a/reference/ev/evwatcher/invoke.xml b/reference/ev/evwatcher/invoke.xml deleted file mode 100644 index 49d2c29882..0000000000 --- a/reference/ev/evwatcher/invoke.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - EvWatcher::invoke - Invoca la función de retrollamada del observador con - el mascara de bits de los eventos recibidos proporcionados - - - &reftitle.description; - - public - void - EvWatcher::invoke - - int - revents - - - - Invoca la función de retrollamada del observador con - el mascara de bits de los eventos recibidos proporcionados. - - - - &reftitle.parameters; - - - - revents - - - - Mascara de bits del observador - que recibe los eventos. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/evwatcher/keepalive.xml b/reference/ev/evwatcher/keepalive.xml deleted file mode 100644 index 162568d983..0000000000 --- a/reference/ev/evwatcher/keepalive.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - EvWatcher::keepalive - Mantiene el bucle activo - - - &reftitle.description; - - public - bool - EvWatcher::keepalive - - bool - value - - - - Mantiene el bucle activo. Con un parámetro value - definido a &false;, el Watcher no evitará que los métodos - Ev::run/EvLoop::run - se detengan incluso si el Watcher está activo. - - - Los Watchers tienen, por omisión, un parámetro - value definido a &true;. - - - Limpiar el estado "keepalive" es útil al regresar de los métodos - Ev::run/EvLoop::run, - en cuyo caso el Watcher ya no es deseado. Puede ser un Watcher de socket UDP - que continúa funcionando durante mucho tiempo. - - - - &reftitle.parameters; - - - - value - - - - Si es &false;, el Watcher no evitará que los métodos - Ev::run/EvLoop::run - terminen, incluso si el Watcher está activo. - - - - - - - &reftitle.returnvalues; - - Devuelve el estado anterior. - - - - &reftitle.examples; - - Registra un Watcher E/S para sockets UDP - -keepalive(FALSE); -?> -]]> - - - - - diff --git a/reference/ev/evwatcher/setcallback.xml b/reference/ev/evwatcher/setcallback.xml deleted file mode 100644 index ce1737e9f2..0000000000 --- a/reference/ev/evwatcher/setcallback.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - EvWatcher::setCallback - Establece una nueva retrollamada para el watcher - - - &reftitle.description; - - public - void - EvWatcher::setCallback - - callable - callback - - - - Establece una nueva retrollamada para el watcher. - - - - &reftitle.parameters; - - - - callback - - - - Ver las - retrollamadas para los Watchers. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/ev/evwatcher/start.xml b/reference/ev/evwatcher/start.xml deleted file mode 100644 index 76d5dc8c5a..0000000000 --- a/reference/ev/evwatcher/start.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - EvWatcher::start - Inicia el Watcher - - - &reftitle.description; - - public - void - EvWatcher::start - - - - Marca el Watcher como activo. Tenga en cuenta que solo los Watchers activos - recibirán los eventos. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EvWatcher::stop - - - - - diff --git a/reference/ev/evwatcher/stop.xml b/reference/ev/evwatcher/stop.xml deleted file mode 100644 index 52f1f66a5e..0000000000 --- a/reference/ev/evwatcher/stop.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - EvWatcher::stop - Detiene el Watcher - - - &reftitle.description; - - public - void - EvWatcher::stop - - - - Marca el Watcher como inactivo. Tenga en cuenta que solo los Watchers activos - recibirán los eventos. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EvWatcher::start - - - - - diff --git a/reference/ev/examples.xml b/reference/ev/examples.xml deleted file mode 100644 index 86781bbb30..0000000000 --- a/reference/ev/examples.xml +++ /dev/null @@ -1,439 +0,0 @@ - - - - - - - &reftitle.examples; - - Ejemplo de temporizadores - -stop(); - // Detiene el watcher si las próximas llamadas provocan más de 10 iteraciones - Ev::iteration() >= 10 and $w->stop(); -}); - -// Crea un temporizador detenido. Permanecerá inactivo hasta que lo iniciemos manualmente -$w_stopped = EvTimer::createStopped(10, 5, function($w) { - echo "Función de retorno de un temporizador creado detenido\n"; - - // Detiene el watcher después de 2 iteraciones - Ev::iteration() >= 2 and $w->stop(); -}); - -// Bucle mientras Ev::stop() no sea llamado o todos los watchers no estén detenidos -Ev::run(); - -// Inicia y verifica si funciona -$w_stopped->start(); -echo "Ejecuta una sola iteración\n"; -Ev::run(Ev::RUN_ONCE); - -echo "Reinicia el segundo watcher e intenta manejar el mismo evento, pero no bloquea\n"; -$w2->again(); -Ev::run(Ev::RUN_NOWAIT); - -$w = new EvTimer(10, 0, function() {}); -echo "Ejecutando un bucle bloqueante\n"; -Ev::run(); -echo "FIN\n"; -?> -]]> - - &example.outputs.similar; - - - - - - Temporizador periódico. Alerta cada 10.5 segundos - - -]]> - - - - Temporizador periódico. Uso de la función de retorno de reprogramación - - - -]]> - - - - Temporizador periódico. Alerta cada 10.5 segundos, comenzando ahora - - -]]> - - - - Espera a que STDIN sea accesible para lectura - - -]]> - - - - Uso de algunas E/S asíncronas para acceder a un socket - -stop(); - // Detiene el watcher write - $w->stop(); - - $in = "HEAD / HTTP/1.1\r\n"; - $in .= "Host: google.co.uk\r\n"; - $in .= "Connection: Close\r\n\r\n"; - - if (!socket_write($socket, $in, strlen($in))) { - trigger_error("Fallo al escribir $in en el socket", E_USER_ERROR); - } - - $read_watcher = new EvIo($socket, Ev::READ, function ($w, $re) - use ($socket, $e_nonblocking) - { - // El socket es accesible para lectura. recv() recibió 20 bytes usando el modo no bloqueante - $ret = socket_recv($socket, $out, 20, MSG_DONTWAIT); - - if ($ret) { - echo $out; - } elseif ($ret === 0) { - // Todo ha sido leído - $w->stop(); - socket_close($socket); - return; - } - - // Se capturan EINPROGRESS, EAGAIN, o EWOULDBLOCK - if (in_array(socket_last_error(), $e_nonblocking)) { - return; - } - - $w->stop(); - socket_close($socket); - }); - - Ev::run(); -}); - -$result = socket_connect($socket, $address, $service_port); - -Ev::run(); -?> -]]> - - &example.outputs.similar; - - - - - - Encapsula un bucle dentro de otro - - -]]> - - - - Encapsula un bucle creado con el backend kqueue en el bucle por defecto - - -]]> - - - - Manejo de la señal SIGTERM - -stop(); -}); - -Ev::run(); -?> -]]> - - - - Monitoreo de cambios en /var/log/messages - -attr(); - - if ($attr['nlink']) { - printf("Tamaño actual: %ld\n", $attr['size']); - printf("atime actual: %ld\n", $attr['atime']); - printf("mtime actual: %ld\n", $attr['mtime']); - } else { - fprintf(STDERR, "¡El fichero `messages` ya no está aquí!"); - $w->stop(); - } -}); - -Ev::run(); -?> -]]> - - - - Monitoreo de cambios en /var/log/messages. Se observan cambios con un segundo de retraso - -stop(); - - $stat = $w->data; - - // 1 segundo después de la última modificación de un fichero - printf("Tamaño actual: %ld\n", $stat->attr()['size']); -}); - -$stat = new EvStat("/var/log/messages", 0., function () use ($timer) { - // Reinicia el watcher timer - $timer->again(); -}); - -$timer->data = $stat; - -Ev::run(); -?> -]]> - - - - Cambio de estado de un proceso - -stop(); - - printf("El proceso %d ha salido con estado %d\n", $w->rpid, $w->rstatus); - }); - - Ev::run(); - - // Protección contra Zombies - pcntl_wait($status); -} else { - // Se bifurca el hijo - exit(2); -} -?> -]]> - - - - - diff --git a/reference/ev/periodic-modes.xml b/reference/ev/periodic-modes.xml deleted file mode 100644 index a9ec3b0b9a..0000000000 --- a/reference/ev/periodic-modes.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - Modos de operación periódica de un watcher - - El watcher EvPeriodic funciona en diferentes - modos según los parámetros offset, - interval y reschedule_cb. - - - - - El modo Temporizador absoluto. En este modo, - interval = 0, - reschedule_cb = &null;. - La llamada se realizará a la hora del reloj offset - y no se repetirá. No se ajustará cuando ocurra un salto en el tiempo, - por lo tanto, si debe ejecutarse el 1 de enero de 2014, - se ejecutará cuando la hora del sistema sea alcanzada o superada. - - - - - El modo Temporizador con repetición por intervalo. - En este modo, interval > 0, - reschedule_cb = &null; ; el watcher será programado - automáticamente para finalizar en la próxima duración - offset + N * interval - (para un entero N) y luego se repite, independientemente - de los saltos en el tiempo. - - - Puede utilizarse para crear temporizadores que no derivan respetando - el reloj del sistema: - - -]]> - - Esto no significa que siempre habrá 3600 segundos - entre cada llamada, sino solo que la función de retrollamada será llamada - cuando el reloj del sistema muestre una hora completa (UTC). - - - La clase EvPeriodic intentará ejecutar la función - de retrollamada en este modo a la próxima hora posible donde - time = offset (mod - interval), independientemente de los saltos en el tiempo. - - - - - El modo reprogramación manual. En este modo, - reschedule_cb es un callable. - - - interval y offset - serán ambos ignorados. En su lugar, cada vez que el watcher periódico - esté programado, la función de retrollamada de reprogramación (reschedule_cb) - será llamada con el watcher primero y el tiempo actual como segundo argumento. - - - Esta función de retrollamada no debe detener ni destruir - este watcher periódico, ni otro, y no debe - llamar a funciones o métodos de bucle de eventos. Para detenerlo, - devuelva 1e30 y deténgalo después. Un watcher - EvPrepare puede ser utilizado para realizar esta tarea. - - - Debe devolver la próxima hora de llamada, basada en el valor - del tiempo pasado (el valor de tiempo más pequeño debe ser superior - o igual al segundo argumento). Será llamada, habitualmente, justo después - de que la función de retrollamada sea lanzada, pero posiblemente en otros momentos. - - - Utilización de retrollamada de reprogramación - - -]]> - - - - - - diff --git a/reference/ev/setup.xml b/reference/ev/setup.xml deleted file mode 100644 index 9464fef3b1..0000000000 --- a/reference/ev/setup.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - &reftitle.setup; - -
- &reftitle.required; - - La biblioteca libev está incluida en - esta extensión. No es necesario instalarla por separado. - -
-
- &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;ev. - -
-
- diff --git a/reference/ev/watcher-callbacks.xml b/reference/ev/watcher-callbacks.xml deleted file mode 100644 index 3b442f8dc5..0000000000 --- a/reference/ev/watcher-callbacks.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - Las funciones de retrollamada de un Watcher - - Todos los watchers pueden estar activos (esperando eventos) o inactivos - (en pausa). Solo los watchers activos pueden tener sus funciones de retrollamada - llamadas. Todas las funciones de retrollamada serán llamadas con al menos dos - argumentos: - watcher - el watcher, y revents, - una máscara de eventos recibidos. - - - Las funciones de retrollamada de los watchers son pasadas a los constructores de los watchers - (una clase derivada de EvWatcher - - EvCheck::__construct, EvChild::__construct - etc.). Una función de retrollamada de un watcher debe coincidir con el siguiente prototipo: - - - void - callback - - object - watcher - NULL - - - int - revents - NULL - - - - - - watcher - - - - La instancia del watcher (de una clase que extiende EvWatcher). - - - - - - revents - - - - Un watcher que recibe los eventos. - - - - - - Cada tipo de watcher tiene un byte asociado en - revents, por lo tanto, se puede utilizar la misma - función de retrollamada para varios watchers. La máscara de eventos - se nombra según el tipo, es decir, - EvChild (o EvLoop::child) define - Ev::CHILD, EvPrepare (o - EvLoop::prepare) define Ev::PREPARE, - EvPeriodic (o EvLoop::periodic) - define Ev::PERIODIC y así sucesivamente, con la excepción de los - eventos de E/S (que pueden definir tanto los bytes - Ev::READ como Ev::WRITE). - - - diff --git a/reference/ev/watchers.xml b/reference/ev/watchers.xml deleted file mode 100644 index 83acf82a75..0000000000 --- a/reference/ev/watchers.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - Watchers - - Un watcher es un objeto creado para registrar particularidades de un evento. - Por ejemplo, el código siguiente espera que - STDIN se vuelva accesible en lectura: - - -]]> - - - - Todos los constructores de los watchers inician automáticamente los watchers. - El método createStopped detiene un watcher (i.e. - EvIo::createStopped). - - - Tenga en cuenta que un watcher se detendrá automáticamente cuando el objeto watcher sea - destruido. Sin embargo, los objetos watchers devueltos por los constructores - o los métodos de fábrica serán conservados. - - - Tenga en cuenta también que todos los métodos que modifican las propiedades - de un watcher (set, priority etc.) - detienen y reinician automáticamente el watcher si está activo, lo que - significa que los eventos pendientes se perderán. - - - Ver también: - Las funciones de retrollamada de los Watchers. - - - diff --git a/reference/event/book.xml b/reference/event/book.xml deleted file mode 100644 index aa4e147a72..0000000000 --- a/reference/event/book.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - Event - Event - - &reftitle.intro; - - Esta es una extensión para planificar eficientemente las I/O, los tiempos - y los señales basados en eventos utilizando el mejor mecanismo I/O disponible - en una plataforma específica. Se trata de un portaje de libevent para la - infraestructura PHP. - - - - Se observa que el soporte para Windows fue introducido en - event-1.9.0. - - - - La versión 1.0.0 introduce una nueva API - orientada a objetos (rompiendo así la compatibilidad ascendente), así como - el soporte para libevent 2+, incluyendo las escuchas HTTP, DNS, OpenSSL - y eventos. - - - - Se observa que event-1.0.0 y versiones superiores - no son compatibles con versiones anteriores. - - - - &reference.event.setup; - &reference.event.examples; - &reference.event.event.flags; - &reference.event.event.persistence; - &reference.event.event.callbacks; - &reference.event.event.constructing.signal.events; - &reference.event.event; - &reference.event.eventbase; - &reference.event.eventbuffer; - &reference.event.eventbufferevent; - &reference.event.eventbufferevent.about.callbacks; - &reference.event.eventconfig; - &reference.event.eventdnsbase; - &reference.event.eventhttp; - &reference.event.eventhttpconnection; - &reference.event.eventhttprequest; - &reference.event.eventlistener; - &reference.event.eventsslcontext; - &reference.event.eventutil; - &reference.event.eventexception; - - - diff --git a/reference/event/configure.xml b/reference/event/configure.xml deleted file mode 100644 index 3f12bbfa16..0000000000 --- a/reference/event/configure.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - -
- &reftitle.install; - - - &pecl.info; - &url.pecl.package;event - -
- diff --git a/reference/event/event.callbacks.xml b/reference/event/event.callbacks.xml deleted file mode 100644 index 1182bd67e4..0000000000 --- a/reference/event/event.callbacks.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - Funciones de retrollamada de eventos - - Si una función de retrollamada está registrada para un evento, será llamada cuando el evento se active. Para asociar una función de retrollamada con un evento, se debe pasar con un tipo callable al método Event::__construct, Event::set, o cualquier otro método factorial como Event::timer. - - - Una función de retrollamada de evento debe corresponder al siguiente prototipo: - - - void - callback - - mixed - fd - &null; - - - int - what - - - mixed - arg - &null; - - - - - - fd - - - - Un descriptor de fichero, un recurso de flujo, o un socket asociado con el evento. Para los eventos de tipo señal, fd corresponde al número de la señal. - - - - - - what - - - - Máscara de bits de todos los eventos lanzados. - - - - - - arg - - - - Datos de usuario personalizados. - - - - - - El método Event::timer espera una función de retrollamada que corresponda al siguiente prototipo: - - - void - callback - - mixed - arg - &null; - - - - - - arg - - - - Datos de usuario personalizados. - - - - - - El método Event::signal espera una función de retrollamada que corresponda al siguiente prototipo: - - - void - callback - - int - signum - - - mixed - arg - &null; - - - - - - signum - - - - El número de la señal lanzada (i.e. SIGTERM). - - - - - - arg - - - - Datos de usuario personalizados. - - - - - - diff --git a/reference/event/event.constructing.signal.events.xml b/reference/event/event.constructing.signal.events.xml deleted file mode 100644 index 760f6bff6e..0000000000 --- a/reference/event/event.constructing.signal.events.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Construcción de un evento de tipo señal - - Un evento puede también supervisar las señales de estilo POSIX. - Para construir un gestor para una señal, utilice el método - Event::__construct con el flag - Event::SIGNAL o el método factorial - Event::signal. - - - Gestión de una señal <literal>SIGTERM</literal> - -base = $base; - $this->ev = Event::signal($base, SIGTERM, array($this, 'eventSighandler')); - $this->ev->add(); - } - - public function eventSighandler($no, $c) { - echo "Caught signal $no\n"; - $this->base->exit(); - } -} - -$base = new EventBase(); -$c = new MyEventSignal($base); - -$base->loop(); -?> -]]> - - - - Tenga en cuenta que las funciones de retrollamada de una señal se ejecutan en el bucle de eventos después de que la señal haya ocurrido, por lo tanto, es más seguro para la señal llamar a funciones desde el bucle que no se supone que se llamen desde un gestor de señales POSIX clásico. - - - - Véase también la - - programación de red fácil, portable y no bloqueante con Libevent; Construcción de un evento de tipo señal. - - - - diff --git a/reference/event/event.flags.xml b/reference/event/event.flags.xml deleted file mode 100644 index f491c67c8e..0000000000 --- a/reference/event/event.flags.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - Los flags de eventos - - Event::READ - Este flag indica que el evento se activa cuando el descriptor de fichero proporcionado (generalmente un recurso de flujo o un socket) está listo para ser leído. - - - Event::WRITE - Este flag indica que el evento se activa cuando el descriptor de fichero proporcionado (generalmente un recurso de flujo o un socket) está listo para ser leído. - - - Event::SIGNAL - Este flag se utiliza para implementar la detección de señales. Ver la creación de un evento de tipo señal a continuación. - - - Event::TIMEOUT - Este flag indica que el evento se activa después de la expiración de un tiempo límite. El flag Event::TIMEOUT se ignora durante la construcción de un evento: un tiempo límite puede ser definido al añadir el evento, o no. Se define en el argumento $what de la función de retrollamada cuando se alcanza el tiempo límite. - - - Ver también - - la programación de red fácil, portable y no bloqueante con Libevent; los trabajos con los eventos y sus flags - - - - diff --git a/reference/event/event.persistence.xml b/reference/event/event.persistence.xml deleted file mode 100644 index cf8c62b7be..0000000000 --- a/reference/event/event.persistence.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - Acerca de la persistencia de eventos - - Por omisión, tan pronto como un evento pendiente se vuelve activo (porque su descriptor de fichero está listo para ser leído o escrito, o porque su tiempo de espera máximo ha sido alcanzado), ya no está pendiente una vez que su función de retrollamada es ejecutada. Asimismo, para volver a poner el evento en estado pendiente, una manera es llamar al método Event::add en la función de retrollamada. - - - Si el flag Event::PERSIST está definido en el evento, entonces es persistente. Esto significa que el evento permanece en estado pendiente incluso cuando su función de retrollamada es activada. El método Event::del puede ser llamado para pasarlo a estado no pendiente. - - - El tiempo de espera máximo en un evento persistente es reinicializado tan pronto como su función de retrollamada es ejecutada. Así, si un evento tiene los flags Event::READ | Event::PERSIST y un tiempo de espera fijado a 5 segundos, el evento se vuelve activo: - - - - - Cuando el socket o el descriptor de fichero está listo para la lectura. - - - - - Cuando han pasado 5 segundos desde la última activación del evento. - - - - - Ver también - - la programación de red rápida, portable y no bloqueante con Libevent; Acerca de los eventos persistentes - - - diff --git a/reference/event/event.xml b/reference/event/event.xml deleted file mode 100644 index d0e87dd622..0000000000 --- a/reference/event/event.xml +++ /dev/null @@ -1,223 +0,0 @@ - - - - - La clase Event - Event - - -
- &reftitle.intro; - - La clase Event representa y lanza un evento - sobre un descriptor de fichero que se ha vuelto listo para una lectura o una escritura; - un descriptor de fichero se vuelve listo para una lectura o una escritura - (I/O únicamente); un tiempo de espera expirado; una señal ocurriendo; - un evento lanzado por el usuario. - - - Cada evento está asociado con un EventBase. - Sin embargo, el evento nunca será lanzado hasta que no haya sido - añadido (a través del método Event::add). - Un evento añadido permanece en un estado de espera - hasta que el evento registrado ocurra, pasándolo así a un estado activo. Para gestionar los eventos, el usuario - debe registrar una función de retrollamada que será llamada cuando el evento - se vuelva activo. Si el evento está configurado como persistente, - permanecerá en espera. Si no es persistente, ya no estará en espera - cuando su función de retrollamada sea ejecutada. El método Event::del - elimina el evento, y ya no estará en espera. - Al llamar al método Event::add, será añadido - de nuevo. - -
- -
- &reftitle.classsynopsis; - - - - - Event - - - - - final - Event - - - - &Constants; - - const - int - Event::ET - 32 - - - const - int - Event::PERSIST - 16 - - - const - int - Event::READ - 2 - - - const - int - Event::WRITE - 4 - - - const - int - Event::SIGNAL - 8 - - - const - int - Event::TIMEOUT - 1 - - &Properties; - - public - readonly - bool - pending - - &Methods; - - - -
- -
- &reftitle.properties; - - - - pending - - - - Si el evento está en espera. Ver la sección : - Acerca de la persistencia de los eventos. - - - - -
- - -
- &reftitle.constants; - - - - Event::ET - - - - Indica que el evento debe ser lanzado, si la base de evento - subyacente soporta este tipo de evento. Esto afecta la semántica - de Event::READ y de Event::WRITE. - - - - - - Event::PERSIST - - - - Indica que el evento es persistente. Ver la sección : - Acerca de la persistencia de los eventos. - - - - - - Event::READ - - - - Este flag indica que un evento se vuelve activo cuando el descriptor - de fichero proporcionado (normalmente, un recurso de flujo o un socket) - está listo para una lectura. - - - - - - Event::WRITE - - - - Este flag indica que un evento se vuelve activo cuando el descriptor - de fichero proporcionado (normalmente, un recurso de flujo o un socket) - está listo para una escritura. - - - - - - Event::SIGNAL - - - - Utilizado para implementar una detección de señal. Ver la sección a continuación - sobre la construcción de un evento de tipo señal. - - - - - - Event::TIMEOUT - - - - Este flag indica que un evento se vuelve activo después de la expiración - de este tiempo de espera máximo. - - - El flag Event::TIMEOUT es ignorado durante la - construcción de un evento: puede ser indicado o no durante la - adición del evento. Debe ser definido en el argumento $what de la función de retrollamada - cuando un tiempo de espera máximo haya ocurrido. - - - - -
- -
- - &reference.event.entities.event; - -
- diff --git a/reference/event/event/add.xml b/reference/event/event/add.xml deleted file mode 100644 index df8fb77055..0000000000 --- a/reference/event/event/add.xml +++ /dev/null @@ -1,160 +0,0 @@ - - - - - - - Event::add - Pone un evento en espera - - - &reftitle.description; - - public - bool - Event::add - - float - timeout - - - - Pone un evento en espera. Un evento que no tiene el estado en espera nunca se lanzará, y la retrollamada del evento nunca se llamará. Utilizando Event::del un evento puede ser reprogramado por el usuario cuando lo desee. - - - Si Event::add es llamado en un evento ya en espera, libevent lo dejará en espera y lo reprogramará con el nuevo timeout (si se da). En el caso de que el timeout no esté especificado, Event::add no tiene ningún efecto. - - - - - &reftitle.parameters; - - - - timeout - - - - Timeout en segundos. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Adición de una señal personalizada - -base = $base; - $this->ev = Event::signal($base, SIGTERM, array($this, 'eventSighandler')); - $this->ev->add(); - } - public function eventSighandler($no, $c) { - echo "Señal atrapada $no\n"; - $this->base->exit(); - } -} - -$base = new EventBase(); -$c = new MyEventSignal($base); - -$base->loop(); -?> -]]> - - &example.outputs.similar; - - - - - - - Adición de un temporizador - -delTimer(); -}, $n); -$e->add($n); -$base->loop(); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Event::add - Event::del - Event::signal - Event::timer - - - - diff --git a/reference/event/event/addsignal.xml b/reference/event/event/addsignal.xml deleted file mode 100644 index 4e508c62f5..0000000000 --- a/reference/event/event/addsignal.xml +++ /dev/null @@ -1,36 +0,0 @@ - - - - - - - Event::addSignal - &Alias; Event::add - - - &reftitle.description; - - &info.method.alias; Event::add - - - - diff --git a/reference/event/event/addtimer.xml b/reference/event/event/addtimer.xml deleted file mode 100644 index 43d1d6927c..0000000000 --- a/reference/event/event/addtimer.xml +++ /dev/null @@ -1,36 +0,0 @@ - - - - - - - Event::addTimer - &Alias; Event::add - - - &reftitle.description; - - &info.method.alias; Event::add - - - - diff --git a/reference/event/event/construct.xml b/reference/event/event/construct.xml deleted file mode 100644 index e1e71cf56c..0000000000 --- a/reference/event/event/construct.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - - Event::__construct - Construye un objeto Event - - - &reftitle.description; - - public - Event::__construct - - EventBase - base - - - mixed - fd - - - int - what - - - callable - cb - - - mixed - arg - NULL - - - - Construye un objeto Event. - - - - &reftitle.parameters; - - - - base - - - - La base de evento a asociar. - - - - - - fd - - - - Recurso de flujo, recurso de socket, o descriptor numérico de fichero. Para los eventos timer, pase como valor -1. Para los eventos de tipo señal, pase el número de la señal, i.e. SIGHUP. - - - - - - what - - - - Flags de eventos. Ver los flags de eventos para más detalles. - - - - - - cb - - - - La función de retrollamada del evento. Ver las funciones de retrollamada de eventos para más detalles. - - - - - - arg - - - - Datos personalizados. Si se especifican, serán pasados a la función de retrollamada cuando el evento haya lanzado los triggers. - - - - - - - &reftitle.seealso; - - - Event::signal - - - Event::timer - - - - - diff --git a/reference/event/event/del.xml b/reference/event/event/del.xml deleted file mode 100644 index 89233fca01..0000000000 --- a/reference/event/event/del.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - Event::del - Elimina un evento de la lista de eventos monitoreados - - - &reftitle.description; - - public - bool - Event::del - - - - Elimina un evento del conjunto de eventos monitoreados. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - Event::add - - - - - diff --git a/reference/event/event/delsignal.xml b/reference/event/event/delsignal.xml deleted file mode 100644 index 52eab1dc02..0000000000 --- a/reference/event/event/delsignal.xml +++ /dev/null @@ -1,36 +0,0 @@ - - - - - - - Event::delSignal - &Alias; Event::del - - - &reftitle.description; - - &info.method.alias; Event::del - - - - diff --git a/reference/event/event/deltimer.xml b/reference/event/event/deltimer.xml deleted file mode 100644 index 92022471bd..0000000000 --- a/reference/event/event/deltimer.xml +++ /dev/null @@ -1,36 +0,0 @@ - - - - - - - Event::delTimer - &Alias; Event::del - - - &reftitle.description; - - &info.method.alias; Event::del - - - - diff --git a/reference/event/event/free.xml b/reference/event/event/free.xml deleted file mode 100644 index b1ade28d5b..0000000000 --- a/reference/event/event/free.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - Event::free - Elimina un evento de la lista de eventos vigilados y libera los recursos asociados - - - &reftitle.description; - - public - void - Event::free - - - - Elimina un evento de la lista de eventos vigilados por libevent y libera los recursos asignados a ese evento. - - - - El método Event::free - no destruye actualmente el objeto en sí. Para destruir el objeto completamente, llame a la función unset - o asigne el valor &null;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - Event::__construct - - - - - diff --git a/reference/event/event/getsupportedmethods.xml b/reference/event/event/getsupportedmethods.xml deleted file mode 100644 index 5daa300688..0000000000 --- a/reference/event/event/getsupportedmethods.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - Event::getSupportedMethods - Devuelve un array que contiene los nombres de los métodos soportados - por esta versión de Libevent - - - &reftitle.description; - - public - static - array - Event::getSupportedMethods - - - - Devuelve un array que contiene los nombres de los métodos soportados - por esta versión de Libevent. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve un array. - - - - &reftitle.seealso; - - - EventConfig - - - - - diff --git a/reference/event/event/pending.xml b/reference/event/event/pending.xml deleted file mode 100644 index bb412b2cff..0000000000 --- a/reference/event/event/pending.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - Event::pending - Detecta si el evento está pendiente o programado - - - &reftitle.description; - - public - bool - Event::pending - - int - flags - - - - Detecta si el evento está pendiente o programado. - - - - &reftitle.parameters; - - - - flags - - - - Una o más de las siguientes constantes: - Event::READ, - Event::WRITE, - Event::TIMEOUT, - Event::SIGNAL. - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si el evento está pendiente o programado, - &false; en caso contrario. - - - - diff --git a/reference/event/event/set.xml b/reference/event/event/set.xml deleted file mode 100644 index 790dd5fe2b..0000000000 --- a/reference/event/event/set.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - Event::set - Reconfigurar el evento - - - &reftitle.description; - - public - bool - Event::set - - EventBase - base - - - mixed - fd - - - int - what - - - callable - cb - - - mixed - arg - - - - Reconfigurar el evento. Téngase en cuenta que esta función no llama a la función obsoleta event_set de libevent. En su lugar, llama a la función event_assign. - - - - &reftitle.parameters; - - - - base - - - - La base de evento a asociar. - - - - - - fd - - - - Un recurso de flujo, un recurso de socket, o un descriptor numérico de fichero. Para los eventos de tipo temporizador pase -1. - Para los eventos de tipo señal pase el número de la señal, por ejemplo SIGHUP. - - - - - - what - - - - Ver los - flags de eventos. - - - - - - cb - - - - La función de retrollamada del evento. Ver las - funciones de retrollamada de eventos. - - - - - - arg - - - - Datos personalizados a asociar con el evento. Serán pasados a la función de retrollamada cuando el evento se active. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/event/setpriority.xml b/reference/event/event/setpriority.xml deleted file mode 100644 index b9fc626d4a..0000000000 --- a/reference/event/event/setpriority.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - Event::setPriority - Define la prioridad del evento - - - &reftitle.description; - - public - bool - Event::setPriority - - int - priority - - - - Define la prioridad del evento. - - - - &reftitle.parameters; - - - - priority - - - - La prioridad del evento. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/event/settimer.xml b/reference/event/event/settimer.xml deleted file mode 100644 index 92dafd599f..0000000000 --- a/reference/event/event/settimer.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - Event::setTimer - Reconfigurar un evento timer - - - &reftitle.description; - - public - bool - Event::setTimer - - EventBase - base - - - callable - cb - - - mixed - arg - - - - Reconfigurar un evento timer. Téngase en cuenta que este método - no llama a la función obsoleta event_set - de libevent. En su lugar, llama a la función - event_assign. - - - - &reftitle.parameters; - - - - base - - - - La base de evento a asociar. - - - - - - cb - - - - La función de retrollamada del evento timer. Ver las - funciones de retrollamada de eventos. - - - - - - arg - - - - Datos personalizados. Si se especifican, serán pasados a la función - de retrollamada cuando el evento dispare los triggers. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - Event::__construct - - - Event::timer - - - - - diff --git a/reference/event/event/signal.xml b/reference/event/event/signal.xml deleted file mode 100644 index 89186aed01..0000000000 --- a/reference/event/event/signal.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - - Event::signal - Construye un objeto de evento de señal - - - &reftitle.description; - - public - static - Event - Event::signal - - EventBase - base - - - int - signum - - - callable - cb - - - mixed - arg - - - - Construye un objeto de evento de señal. Es un método simple para - crear un evento de señal. Tenga en cuenta que el método genérico - Event::__construct también puede construir un - objeto de evento de señal. - - - - &reftitle.parameters; - - - - base - - - - El objeto de base de evento asociado. - - - - - - signum - - - - El número de la señal. - - - - - - cb - - - - La función de retrollamada del evento de señal. Ver las - funciones de retrollamada de eventos. - - - - - - arg - - - - Datos personalizados. Si se especifican, serán pasados a la función - de retrollamada cuando el evento lance los triggers. - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto de evento en caso de éxito, &false; de lo contrario. - - - - &reftitle.seealso; - - - La construcción de eventos de señal - - - - - diff --git a/reference/event/event/timer.xml b/reference/event/event/timer.xml deleted file mode 100644 index 5a4ca2663f..0000000000 --- a/reference/event/event/timer.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - Event::timer - Construye un objeto de evento timer - - - &reftitle.description; - - public - static - Event - Event::timer - - EventBase - base - - - callable - cb - - - mixed - arg - - - - Construye un objeto de evento timer. Se trata de un método simple para - crear un evento timer. Téngase en cuenta que el método genérico - Event::__construct también puede construir objetos - de eventos signal. - - - - &reftitle.parameters; - - - - base - - - - El objeto de base de evento asociado. - - - - - - cb - - - - La función de retrollamada de evento signal. Ver las - funciones de retrollamada de eventos. - - - - - - arg - - - - Datos personalizados. Si se especifican, serán pasados a la función - de retrollamada cuando el evento lance los triggers. - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto de evento en caso de éxito, &false; en caso contrario. - - - - diff --git a/reference/event/eventbase.xml b/reference/event/eventbase.xml deleted file mode 100644 index 5b412e7f24..0000000000 --- a/reference/event/eventbase.xml +++ /dev/null @@ -1,214 +0,0 @@ - - - - - - La clase EventBase - EventBase - - -
- &reftitle.intro; - - La clase EventBase representa la estructura - base de un evento libevent. Contiene un conjunto de eventos - y puede verificar cuáles son los eventos activos. - - - Cada evento base tiene un método o un - backend utilizado para determinar cuáles - son los eventos listos. Estos métodos son : - select, poll, epoll, - kqueue, devpoll, evport - y win32. - - - Para configurar un evento base a utilizar, o evitar un backend específico, - la clase EventConfig puede ser utilizada. - - - - No destruya el objeto EventBase - hasta que los recursos asociados a los objetos Event - no sean liberados. De lo contrario, esto llevará a resultados totalmente indefinidos. - - -
- -
- &reftitle.classsynopsis; - - - - - EventBase - - - - - final - EventBase - - - - &Constants; - - const - int - EventBase::LOOP_ONCE - 1 - - - const - int - EventBase::LOOP_NONBLOCK - 2 - - - const - int - EventBase::NOLOCK - 1 - - - const - int - EventBase::STARTUP_IOCP - 4 - - - const - int - EventBase::NO_CACHE_TIME - 8 - - - const - int - EventBase::EPOLL_USE_CHANGELIST - 16 - - &Methods; - - - -
- -
- &reftitle.constants; - - - - EventBase::LOOP_ONCE - - - - Flag utilizado con el método EventBase::loop - que significa: "bloqueo mientras libevent tiene un evento activo, luego, - salida una vez que todos los eventos activos han ejecutado sus - funciones de retrollamada". - - - - - - EventBase::LOOP_NONBLOCK - - - - Flag utilizado con el método EventBase::loop - que significa: "no bloquear: ver qué eventos están listos actualmente, - ejecutar sus funciones de retrollamada con una prioridad alta, luego, salir". - - - - - - EventBase::NOLOCK - - - - Flag de configuración. No bloquear la base del evento, incluso si - un bloqueo había sido puesto en su lugar. - - - - - - EventBase::STARTUP_IOCP - - - - Flag de configuración específico de Windows. Activa el repartidor IOCP - al inicio. - - - - - - EventBase::NO_CACHE_TIME - - - - Flag de configuración. En lugar de verificar el tiempo actual cada vez - que el bucle de eventos está listo para ejecutar la función de retrollamada, - el tiempo será verificado cada vez que el tiempo máximo de espera para la - función de retrollamada sea alcanzado. - - - - - - EventBase::EPOLL_USE_CHANGELIST - - - - Si se utiliza el backend epoll, este flag - significa que es seguro utilizar el código interno de modificación de lista - interna a Libevent para agrupar los añadidos y las supresiones con el fin - de intentar minimizar el número de llamadas al sistema. - - - El hecho de definir este flag hace que el código sea más rápido, pero puede - enfrentarse a un bug de Linux: no es seguro utilizar este flag - en presencia de fds clonados por dup() o una de sus variantes. - Esto produciría un comportamiento extraño y muy difícil de diagnosticar. - - - Este flag también puede ser activado definiendo la variable de entorno - EVENT_EPOLL_USE_CHANGELIST. - - - Este flag no tiene ningún efecto si se utiliza con un backend diferente a - epoll. - - - - -
- -
- - &reference.event.entities.eventbase; - -
- diff --git a/reference/event/eventbase/construct.xml b/reference/event/eventbase/construct.xml deleted file mode 100644 index c1a08554d5..0000000000 --- a/reference/event/eventbase/construct.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - EventBase::__construct - Construye un objeto EventBase - - - &reftitle.description; - - public - EventBase::__construct - - EventConfig - cfg - - - - Construye un objeto EventBase. - - - - &reftitle.parameters; - - - - cfg - - - - Opcional - Un objeto EventConfig. - - - - - - - &reftitle.errors; - - Si EventBase no puede ser construido con la configuración proporcionada, - se lanzará una excepción de tipo EventException. - - - - &reftitle.seealso; - - - EventConfig - - - - - diff --git a/reference/event/eventbase/dispatch.xml b/reference/event/eventbase/dispatch.xml deleted file mode 100644 index f632743a84..0000000000 --- a/reference/event/eventbase/dispatch.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - EventBase::dispatch - Despacha eventos pendientes - - - &reftitle.description; - - public - void - EventBase::dispatch - - - - Espara a que los eventos estén activos y ejecuta sus llamadas de retorno. Hace lo mismo que - EventBase::loop - pero sin flags definidas. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBase::loop - - - - - diff --git a/reference/event/eventbase/exit.xml b/reference/event/eventbase/exit.xml deleted file mode 100644 index ac96468d2e..0000000000 --- a/reference/event/eventbase/exit.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - EventBase::exit - Detiene el envío de los eventos - - - &reftitle.description; - - public - bool - EventBase::exit - - float - timeout - - - - Le indica al evento base que pare el envío de los eventos, opcionamente después de un número de segundos dado. - - - - &reftitle.parameters; - - - - timeout - - - - Número opcional de segundos después de los cuales el evento base deberá parar el - envío de eventos. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBase::stop - - - - - diff --git a/reference/event/eventbase/free.xml b/reference/event/eventbase/free.xml deleted file mode 100644 index da40d5d401..0000000000 --- a/reference/event/eventbase/free.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - EventBase::free - Libera los recursos asignados para el evento base - - - &reftitle.description; - - public - void - EventBase::free - - - - Libera los recursos asignados por libevent para el objeto - EventBase. - - - - El método EventBase::free no destruye - el objeto mismo. Para destruir el objeto completamente, llame a la función - unset o asignele el valor &null;. - - - Este método no libera, ni desasocia ningún evento que esté actualmente - asociado con el objeto EventBase, ni cierra ninguno de sus - sockets; tenga esto en cuenta. - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventBase::__construct - - - - - diff --git a/reference/event/eventbase/getfeatures.xml b/reference/event/eventbase/getfeatures.xml deleted file mode 100644 index 332f8c2fe1..0000000000 --- a/reference/event/eventbase/getfeatures.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - EventBase::getFeatures - Devuelve una máscara de las funcionalidades soportadas - - - &reftitle.description; - - public - int - EventBase::getFeatures - - - - Devuelve una máscara de las funcionalidades soportadas. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve un entero que representa una máscara de las funcionalidades soportadas. - Consulte las constantes - EventConfig::FEATURE_*. - - - - &reftitle.examples; - - Ejemplo con <function>EventBase::getFeatures</function> - -avoidMethod("select")) { - echo "Desactivación del método 'select'\n"; -} - -$base = new EventBase($cfg); - -echo "funcionalidades:\n"; -$features = $base->getFeatures(); -($features & EventConfig::FEATURE_ET) and print "ET - edge-triggered IO\n"; -($features & EventConfig::FEATURE_O1) and print "O1 - O(1) operation for adding/deleting events\n"; -($features & EventConfig::FEATURE_FDS) and print "FDS - arbitrary file descriptor types, and not just sockets\n"; -?> -]]> - - - - - &reftitle.seealso; - - - EventBase::getMethod - - - EventConfig - - - - - diff --git a/reference/event/eventbase/getmethod.xml b/reference/event/eventbase/getmethod.xml deleted file mode 100644 index c7412e6432..0000000000 --- a/reference/event/eventbase/getmethod.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - - EventBase::getMethod - Devuelve el método de evento utilizado - - - &reftitle.description; - - public - string - EventBase::getMethod - - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - String que representa el método de evento utilizado (backend). - - - - &reftitle.examples; - - - Ejemplo con <function>EventBase::getMethod</function> - -avoidMethod("select")) { - echo "Método `select' evitado\n"; -} - -// Crear un evento base asociado con el config -$base = new EventBase($cfg); -echo "Método de evento utilizado: ", $base->getMethod(), PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - &reftitle.seealso; - - - EventBase::getFeatures - - - - - diff --git a/reference/event/eventbase/gettimeofdaycached.xml b/reference/event/eventbase/gettimeofdaycached.xml deleted file mode 100644 index 25b63c7f91..0000000000 --- a/reference/event/eventbase/gettimeofdaycached.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - EventBase::getTimeOfDayCached - Devuelve el tiempo del evento base actual - - - &reftitle.description; - - public - float - EventBase::getTimeOfDayCached - - - - En caso de éxito devuelve el tiempo actual(como el devuelto por - gettimeofday() - ), mirando el valor en la caché dentro de - base - si es posible, y llamando a - gettimeofday() - o - clock_gettime() - si no hay tiempo disponible en la caché. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve el actual tiempo de - event base - . En caso de error devuelve &null;. - - - - diff --git a/reference/event/eventbase/gotexit.xml b/reference/event/eventbase/gotexit.xml deleted file mode 100644 index 088943a9b0..0000000000 --- a/reference/event/eventbase/gotexit.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - EventBase::gotExit - Verifica si se ha solicitado que el bucle de eventos salga - - - &reftitle.description; - - public - bool - EventBase::gotExit - - - - Verifica si se ha solicitado que el bucle de eventos salga mediante - el método EventBase::exit. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve &true; si se ha solicitado que el bucle de eventos salga - mediante el método EventBase::exit. - &false; en caso contrario. - - - - &reftitle.seealso; - - - EventBase::exit - - - EventBase::stop - - - EventBase::gotStop - - - - - diff --git a/reference/event/eventbase/gotstop.xml b/reference/event/eventbase/gotstop.xml deleted file mode 100644 index e714756d44..0000000000 --- a/reference/event/eventbase/gotstop.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - EventBase::gotStop - Verifica si se ha solicitado que la iteración de eventos se detenga - - - &reftitle.description; - - public - bool - EventBase::gotStop - - - - Verifica si se ha solicitado que la iteración de eventos se detenga - mediante el método EventBase::stop. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve &true; si se ha solicitado que la iteración de eventos - se detenga mediante el método EventBase::stop. - &false; en caso contrario. - - - - &reftitle.seealso; - - EventBase::exit - EventBase::stop - EventBase::gotExit - - - - diff --git a/reference/event/eventbase/loop.xml b/reference/event/eventbase/loop.xml deleted file mode 100644 index 064bfe54b0..0000000000 --- a/reference/event/eventbase/loop.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - EventBase::loop - Distribuye los eventos en espera - - - &reftitle.description; - - public - bool - EventBase::loop - - int - flags - - - - Espera a que los eventos se vuelvan activos, luego, - ejecuta sus funciones de retrollamada. - - - - - - - &reftitle.parameters; - - - - flags - - - - Banderas opcionales. Una constante EventBase::LOOP_*. - Ver las constantes EventBase. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBase::dispatch - - - - - diff --git a/reference/event/eventbase/priorityinit.xml b/reference/event/eventbase/priorityinit.xml deleted file mode 100644 index e7d9b078d6..0000000000 --- a/reference/event/eventbase/priorityinit.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - EventBase::priorityInit - Define el número de prioridades por evento base - - - &reftitle.description; - - public - bool - EventBase::priorityInit - - int - n_priorities - - - - Define el número de prioridades por evento base. - - - - &reftitle.parameters; - - - - n_priorities - - - - El número de prioridades por evento base. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - Event::setPriority - - - - - diff --git a/reference/event/eventbase/reinit.xml b/reference/event/eventbase/reinit.xml deleted file mode 100644 index b7cd783f8a..0000000000 --- a/reference/event/eventbase/reinit.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - - EventBase::reInit - Reinicializa el evento base (después de un 'fork') - - - &reftitle.description; - - public - bool - EventBase::reInit - - - - Reinicializa el evento base. Debe ser llamado después de un 'fork'. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/eventbase/stop.xml b/reference/event/eventbase/stop.xml deleted file mode 100644 index 98fdf27281..0000000000 --- a/reference/event/eventbase/stop.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - EventBase::stop - Solicita a event_base que detenga la emisión de eventos - - - &reftitle.description; - - public - bool - EventBase::stop - - - - Solicita a event_base que detenga la emisión de eventos - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBase::exit - - - EventBase::gotStop - - - - - diff --git a/reference/event/eventbuffer.xml b/reference/event/eventbuffer.xml deleted file mode 100644 index 54d0e357e4..0000000000 --- a/reference/event/eventbuffer.xml +++ /dev/null @@ -1,228 +0,0 @@ - - - - - - La clase EventBuffer - EventBuffer - - -
- &reftitle.intro; - - La clase EventBuffer representa - "evbuffer" de Libevent, una utilidad para las I/O bufferizadas. - - - Los buffers de eventos son generalmente útiles para realizar la - parte buffer de una red I/O bufferizada. - -
- -
- &reftitle.classsynopsis; - - - - - EventBuffer - - - - - EventBuffer - - - - &Constants; - - const - int - EventBuffer::EOL_ANY - 0 - - - const - int - EventBuffer::EOL_CRLF - 1 - - - const - int - EventBuffer::EOL_CRLF_STRICT - 2 - - - const - int - EventBuffer::EOL_LF - 3 - - - const - int - EventBuffer::PTR_SET - 0 - - - const - int - EventBuffer::PTR_ADD - 1 - - &Properties; - - public - readonly - int - length - - - public - readonly - int - contiguous_space - - &Methods; - - - -
- -
- &reftitle.properties; - - - - length - - - - El número de bytes almacenados en un buffer de eventos. - - - - - - contiguous_space - - - - El número de bytes almacenados de manera contigua al inicio del buffer. - Los bytes en un buffer pueden estar almacenados en varias partes - separadas de la memoria; esta propiedad devuelve el número de bytes - actualmente almacenados en la primera parte. - - - - -
- - -
- &reftitle.constants; - - - - EventBuffer::EOL_ANY - - - - El fin de línea es una secuencia de números que representan un retorno de carro - y una nueva línea. Este formato no es muy útil; existe solo por razones de compatibilidad ascendente. - - - - - - EventBuffer::EOL_CRLF - - - - El fin de línea es un retorno de carro opcional, seguido de una nueva - línea. (En otras palabras, es "\r\n" - o "\n"). Este formato es útil para analizar - los protocolos de Internet basados en texto; el estándar requiere - "\r\n" pero algunos clientes proporcionan solo - "\n". - - - - - - EventBuffer::EOL_CRLF_STRICT - - - - El fin de línea es un simple retorno de carro, seguido de una - simple nueva línea (también conocido como "\r\n". - Los valores ASCII son 0x0D 0x0A). - - - - - - EventBuffer::EOL_LF - - - - El fin de línea es un simple carácter de nueva línea (también conocido - como "\n". El valor ASCII es 0x0A). - - - - - - EventBuffer::PTR_SET - - - - Flag utilizado como argumento del método - EventBuffer::setPosition. Si este flag es especificado, - la posición del puntero es movida a una posición absoluta del buffer. - - - - - - EventBuffer::PTR_ADD - - - - Idéntico a EventBuffer::PTR_SET, - excepto que este flag hace que el método - EventBuffer::setPosition - se mueva a una posición hacia atrás en relación con el número - de bytes especificado (en lugar de definir una posición absoluta). - - - - -
- -
- - &reference.event.entities.eventbuffer; - -
- diff --git a/reference/event/eventbuffer/add.xml b/reference/event/eventbuffer/add.xml deleted file mode 100644 index c11aaee780..0000000000 --- a/reference/event/eventbuffer/add.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - EventBuffer::add - Añade datos al final de un buffer de eventos - - - &reftitle.description; - - public - bool - EventBuffer::add - - string - data - - - - Añade datos al final de un buffer de eventos. - - - - &reftitle.parameters; - - - - data - - - - String que se añadirá al final del buffer. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBuffer::addBuffer - - - - - diff --git a/reference/event/eventbuffer/addbuffer.xml b/reference/event/eventbuffer/addbuffer.xml deleted file mode 100644 index b9f7530342..0000000000 --- a/reference/event/eventbuffer/addbuffer.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - EventBuffer::addBuffer - Desplaza todos los datos del búfer proporcionado al EventBuffer actual - - - &reftitle.description; - - public - bool - EventBuffer::addBuffer - - EventBuffer - buf - - - - Desplaza todos los datos del búfer proporcionado por el argumento - buf al final del EventBuffer - actual. Se trata de una adición destructiva. Los datos del primer búfer - son desplazados al otro. Sin embargo, no se produce ninguna copia en memoria. - - - - &reftitle.parameters; - - - - buf - - - - El objeto EventBuffer de origen. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBuffer::add - - - - - diff --git a/reference/event/eventbuffer/appendfrom.xml b/reference/event/eventbuffer/appendfrom.xml deleted file mode 100644 index 03b4a07348..0000000000 --- a/reference/event/eventbuffer/appendfrom.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - - EventBuffer::appendFrom - Mueve el número de bytes especificados desde un buffer fuente, al - final del buffer actual - - - &reftitle.description; - - public - int - EventBuffer::appendFrom - - EventBuffer - buf - - - int - len - - - - Mueve el número de bytes especificados desde un buffer fuente, al final del - buffer actual. Si hay menos bytes, mueve todos los bytes - disponibles del buffer fuente. - - - - &reftitle.parameters; - - - - buf - - - - Buffer fuente. - - - - - - len - - - - - - - - - &reftitle.returnvalues; - - Devuelve el número de bytes leídos. - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL event 1.6.0 - - Renombrado de EventBuffer::appendFrom(nombre - antiguo del método) a EventBuffer::appendFrom. - - - - - - - - &reftitle.seealso; - - - EventBuffer::copyout - - - EventBuffer::drain - - - EventBuffer::pullup - - - EventBuffer::readLine - - - EventBuffer::read - - - - - diff --git a/reference/event/eventbuffer/construct.xml b/reference/event/eventbuffer/construct.xml deleted file mode 100644 index 4f84e79cc6..0000000000 --- a/reference/event/eventbuffer/construct.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - - - EventBuffer::__construct - Construye el objeto EventBuffer - - - &reftitle.description; - - public - EventBuffer::__construct - - - - Construye el objeto EventBuffer - - - - &reftitle.parameters; - &no.function.parameters; - - - diff --git a/reference/event/eventbuffer/copyout.xml b/reference/event/eventbuffer/copyout.xml deleted file mode 100644 index 58ce3b2d4c..0000000000 --- a/reference/event/eventbuffer/copyout.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - EventBuffer::copyout - Copia el número de bytes especificado desde el inicio del búfer - - - &reftitle.description; - - public - int - EventBuffer::copyout - - string - data - - - int - max_bytes - - - - Funciona de la misma manera que el método - EventBuffer::read, pero no vacía los - datos del búfer. Es decir, el método copia los primeros - max_bytes bytes desde el inicio del búfer - en el argumento data. Si hay menos de - max_bytes bytes disponibles, el método - copia todos los bytes presentes. - - - - &reftitle.parameters; - - - - data - - - - String de salida. - - - - - - max_bytes - - - - El número de bytes a copiar. - - - - - - - &reftitle.returnvalues; - - Devuelve el número de bytes copiados, o - -1 si ocurre un error. - - - - &reftitle.seealso; - - - EventBuffer::read - - - EventBuffer::appendFrom - - - - - diff --git a/reference/event/eventbuffer/drain.xml b/reference/event/eventbuffer/drain.xml deleted file mode 100644 index b471d2041f..0000000000 --- a/reference/event/eventbuffer/drain.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - EventBuffer::drain - Elimina un número especificado de bytes desde el inicio del búfer - sin copiar los datos - - - &reftitle.description; - - public - bool - EventBuffer::drain - - int - len - - - - Funciona de la misma manera que el método - EventBuffer::read excepto que - los datos eliminados no son copiados: solo se eliminan - del inicio del búfer. - - - - &reftitle.parameters; - - - - len - - - - El número de bytes a eliminar del búfer. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBuffer::read - - - EventBuffer::appendFrom - - - - - diff --git a/reference/event/eventbuffer/enablelocking.xml b/reference/event/eventbuffer/enablelocking.xml deleted file mode 100644 index 5e411b6c46..0000000000 --- a/reference/event/eventbuffer/enablelocking.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - EventBuffer::enableLocking - - - - &reftitle.description; - - public - void - EventBuffer::enableLocking - - - - Se activa el bloqueo del EventBuffer, permitiendo - así su uso seguro por varios hilos simultáneamente. Cuando el bloqueo está activado, - el bloqueo se coloca cuando se llaman las funciones de retrollamada. - Este comportamiento puede provocar bloqueos si no se tiene cuidado. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - Evbuffers and Thread-safety - - - - - diff --git a/reference/event/eventbuffer/expand.xml b/reference/event/eventbuffer/expand.xml deleted file mode 100644 index 7a4ef1551f..0000000000 --- a/reference/event/eventbuffer/expand.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - EventBuffer::expand - Reserva espacio en el buffer - - - &reftitle.description; - - public - bool - EventBuffer::expand - - int - len - - - - Modifica el último bloque de memoria del buffer, o añade un nuevo bloque, de modo - que el buffer es ahora suficientemente grande para contener - len - bytes sin añadir espacios suplementarios. - - - - &reftitle.parameters; - - - - len - - - - El número de bytes a reservar del buffer - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/eventbuffer/freeze.xml b/reference/event/eventbuffer/freeze.xml deleted file mode 100644 index ab4f10db37..0000000000 --- a/reference/event/eventbuffer/freeze.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - EventBuffer::freeze - Evita que las llamadas puedan modificar un buffer de eventos - - - &reftitle.description; - - public - bool - EventBuffer::freeze - - bool - at_front - - - - Evita que las llamadas puedan modificar un buffer de eventos - - - - &reftitle.parameters; - - - - at_front - - - - Permite desactivar cambios en el principio o final del buffer. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBuffer::unfreeze - - - - - diff --git a/reference/event/eventbuffer/lock.xml b/reference/event/eventbuffer/lock.xml deleted file mode 100644 index 19b5490749..0000000000 --- a/reference/event/eventbuffer/lock.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - EventBuffer::lock - Bloquea un buffer - - - &reftitle.description; - - public - void - EventBuffer::lock - - - - Bloquea un buffer. Puede ser utilizado junto con - EventBuffer::unlock - para que un conjunto de operaciones sean atómicas, p.e. thread-safe. Notar que no se - necesita bloquear buffers para operaciones - individuales . - Cuando el bloqueo está activo (ver - EventBuffer::enableLocking - ), las operaciones individuales en buffers de eventos ya son atómicas. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventBuffer::unlock - - - - - diff --git a/reference/event/eventbuffer/prepend.xml b/reference/event/eventbuffer/prepend.xml deleted file mode 100644 index 9bd2c939bf..0000000000 --- a/reference/event/eventbuffer/prepend.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - EventBuffer::prepend - Añade datos al principio del buffer - - - &reftitle.description; - - public - bool - EventBuffer::prepend - - string - data - - - - Añade datos al principio del buffer. - - - - &reftitle.parameters; - - - - data - - - - String a añadir al principio del buffer. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBuffer::prependBuffer - - - EventBuffer::add - - - EventBuffer::addBuffer - - - - - diff --git a/reference/event/eventbuffer/prependbuffer.xml b/reference/event/eventbuffer/prependbuffer.xml deleted file mode 100644 index 88e45f59fb..0000000000 --- a/reference/event/eventbuffer/prependbuffer.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - EventBuffer::prependBuffer - Desplaza todos los datos desde el buffer fuente hacia el inicio - del buffer actual - - - &reftitle.description; - - public - bool - EventBuffer::prependBuffer - - EventBuffer - buf - - - - Funciona exactamente como el método - EventBuffer::addBuffer, excepto que desplaza los datos al inicio del buffer. - - - - &reftitle.parameters; - - - - buf - - - - Buffer fuente. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBuffer::add - - - EventBuffer::addBuffer - - - EventBuffer::prepend - - - - - diff --git a/reference/event/eventbuffer/pullup.xml b/reference/event/eventbuffer/pullup.xml deleted file mode 100644 index f8f2f523cb..0000000000 --- a/reference/event/eventbuffer/pullup.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - - EventBuffer::pullup - Serializa los datos del buffer y devuelve el contenido del - buffer en forma de string - - - &reftitle.description; - - public - string - EventBuffer::pullup - - int - size - - - - Serializa los primeros size bytes del buffer, - los copia o los mueve según sea necesario para asegurar que sean contiguos - y ocupen la misma parte de la memoria. Si el tamaño es negativo, la función - lineariza la totalidad del buffer. - - - - La llamada al método EventBuffer::pullup - con un tamaño muy grande ralentiza la ejecución, ya que puede potencialmente - necesitar copiar el contenido entero del buffer. - - - - - &reftitle.parameters; - - - - size - - - - El número de bytes que deben ser contiguos en el buffer. - - - - - - - &reftitle.returnvalues; - - Si size es superior al número de bytes del buffer, - la función devolverá &null;. De lo contrario, EventBuffer::pullup - devolverá un string. - - - - &reftitle.seealso; - - - EventBuffer::copyout - - - EventBuffer::drain - - - EventBuffer::read - - - EventBuffer::readLine - - - EventBuffer::appendFrom - - - - - diff --git a/reference/event/eventbuffer/read.xml b/reference/event/eventbuffer/read.xml deleted file mode 100644 index 875f6c71b1..0000000000 --- a/reference/event/eventbuffer/read.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - EventBuffer::read - Lee los datos de un evbuffer y vacía los bytes leídos - - - &reftitle.description; - - public - string - EventBuffer::read - - int - max_bytes - - - - Lee los primeros max_bytes bytes desde el búfer - y vacía los bytes leídos. Si el argumento max_bytes - representa más bytes de los disponibles en el búfer, - todos los bytes disponibles serán leídos. - - - - &reftitle.parameters; - - - - max_bytes - - - - El número máximo de bytes a leer desde el búfer. - - - - - - - &reftitle.returnvalues; - - Devuelve el string leído, o &false; si ocurre un error. - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL event 1.6.0 - - El método EventBuffer::read - fue renombrado a EventBuffer::read. - EventBuffer::read - ahora toma solo un argumento: max_bytes - ; ahora devuelve un string en lugar de un integer. - - - - - - - - &reftitle.seealso; - - - EventBuffer::copyout - - - EventBuffer::drain - - - EventBuffer::pullup - - - EventBuffer::readLine - - - EventBuffer::appendFrom - - - - - diff --git a/reference/event/eventbuffer/readfrom.xml b/reference/event/eventbuffer/readfrom.xml deleted file mode 100644 index 41e61e8083..0000000000 --- a/reference/event/eventbuffer/readfrom.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - - EventBuffer::readFrom - Lee datos desde un fichero y los coloca al final del búfer - - - &reftitle.description; - - public - int - EventBuffer::read - - mixed - fd - - - int - howmuch - - - - Lee datos desde el fichero fd - y los coloca al final del búfer. - - - - &reftitle.parameters; - - - - fd - - - - Un socket, un flujo, o un descriptor de fichero numérico. - - - - - - howmuch - - - - Número máximo de bytes a leer. - - - - - - - &reftitle.returnvalues; - - Devuelve el número de bytes leídos, o &false; si ocurre un error. - - - - &reftitle.seealso; - - - EventBuffer::copyout - - - EventBuffer::drain - - - EventBuffer::pullup - - - EventBuffer::readLine - - - EventBuffer::appendFrom - - - - - diff --git a/reference/event/eventbuffer/readline.xml b/reference/event/eventbuffer/readline.xml deleted file mode 100644 index 9650404f54..0000000000 --- a/reference/event/eventbuffer/readline.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - EventBuffer::readLine - Extrae una línea desde el inicio del búfer - - - &reftitle.description; - - public - string - EventBuffer::readLine - - int - eol_style - - - - Extrae una línea desde el inicio del búfer y la devuelve - en una nueva string asignada. Si no hay una línea completa - para leer, el método devuelve &null;. La terminación de la línea - no está incluida en la string copiada. - - - - &reftitle.parameters; - - - - eol_style - - - - Una constante - EventBuffer:EOL_*. - - - - - - - &reftitle.returnvalues; - - En caso de éxito, devuelve la línea leída desde el búfer, - &null; en caso contrario. - - - - &reftitle.seealso; - - - EventBuffer::copyout - - - EventBuffer::drain - - - EventBuffer::pullup - - - EventBuffer::read - - - EventBuffer::appendFrom - - - - - diff --git a/reference/event/eventbuffer/search.xml b/reference/event/eventbuffer/search.xml deleted file mode 100644 index 904a8d1f32..0000000000 --- a/reference/event/eventbuffer/search.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - - EventBuffer::search - Busca en el búfer una ocurrencia de un string - - - &reftitle.description; - - public - mixed - EventBuffer::search - - string - what - - - int - start - -1 - - - int - end - -1 - - - - Busca en el búfer una ocurrencia del string - what. El método devuelve la posición - numérica del string buscado, o &false; si el string - no ha podido ser encontrado. - - - Si el argumento start es proporcionado, será la posición - desde la cual la búsqueda debe comenzar; de lo contrario, la búsqueda - se realizará desde el inicio del string. Si el argumento - end es proporcionado, la búsqueda se realizará - entre las posiciones de inicio y fin del búfer. - - - - &reftitle.parameters; - - - - what - - - - String a buscar. - - - - - - start - - - - Posición de inicio de la búsqueda. - - - - - - end - - - - Posición de fin de la búsqueda. - - - - - - - &reftitle.returnvalues; - - Devuelve la posición numérica de la primera ocurrencia del - string en el búfer, o &false; si el string no ha sido encontrado. - - &return.falseproblem; - - - &reftitle.examples; - - Ejemplo con <function>EventBuffer::search</function> - -search($str, $p); - if ($p === FALSE) { - break; - } - ++$total; - ++$p; - } - - return $total; -} - -$buf = new EventBuffer(); -$buf->add("Some string within a string inside another string"); -var_dump(count_instances($buf, "str")); -?> -]]> - - &example.outputs.similar; - - - - - - - &reftitle.seealso; - - - EventBuffer::searchEol - - - - - diff --git a/reference/event/eventbuffer/searcheol.xml b/reference/event/eventbuffer/searcheol.xml deleted file mode 100644 index 1cea385f73..0000000000 --- a/reference/event/eventbuffer/searcheol.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - EventBuffer::searchEol - Busca en el búfer una ocurrencia de fin de línea - - - &reftitle.description; - - public - mixed - EventBuffer::searchEol - - int - start - -1 - - - int - eol_style - - EventBuffer::EOL_ANY - - - - - Busca en el búfer una ocurrencia de fin de línea especificada por - el argumento eol_style. El método devuelve - la posición numérica del string, o &false; si el string no ha sido - encontrado. - - - Si el argumento start es proporcionado, representa - la posición donde la búsqueda comenzará; de lo contrario, la búsqueda - se realizará desde el inicio del string. Si el argumento end - es proporcionado, la búsqueda se realizará entre las posiciones de inicio - y fin del búfer. - - - - &reftitle.parameters; - - - - start - - - - Posición de inicio de la búsqueda. - - - - - - eol_style - - - - Una constante - EventBuffer:EOL_*. - - - - - - - &reftitle.returnvalues; - - Devuelve la posición numérica de la primera ocurrencia del - símbolo de fin de línea en el búfer, o bien &false; si - no ha sido encontrado. - - &return.falseproblem; - - - &reftitle.seealso; - - - EventBuffer::search - - - - - diff --git a/reference/event/eventbuffer/substr.xml b/reference/event/eventbuffer/substr.xml deleted file mode 100644 index 6331e07a50..0000000000 --- a/reference/event/eventbuffer/substr.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - EventBuffer::substr - Sustrae una porción de los datos del búfer - - - &reftitle.description; - - public - string - EventBuffer::substr - - int - start - - - int - length - - - - Sustrae una cantidad de length bytes - del búfer, comenzando en la posición start. - - - - &reftitle.parameters; - - - - start - - - - La posición de inicio de los datos a sustraer. - - - - - - length - - - - Número máximo de bytes a sustraer. - - - - - - - &reftitle.returnvalues; - - Devuelve los datos sustraídos en forma de string - en caso de éxito, o bien &false; si ocurre un error. - - - - &reftitle.seealso; - - - EventBuffer::read - - - - - diff --git a/reference/event/eventbuffer/unfreeze.xml b/reference/event/eventbuffer/unfreeze.xml deleted file mode 100644 index 2d05e6c7ba..0000000000 --- a/reference/event/eventbuffer/unfreeze.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - EventBuffer::unfreeze - Re-activa las llamadas que permiten modificar un buffer de eventos - - - &reftitle.description; - - public - bool - EventBuffer::unfreeze - - bool - at_front - - - - Re-activa las llamadas que permiten modificar un buffer de eventos. - - - - &reftitle.parameters; - - - - at_front - - - - Si se deben activar los eventos al principio o al final del buffer. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBuffer::freeze - - - - - diff --git a/reference/event/eventbuffer/unlock.xml b/reference/event/eventbuffer/unlock.xml deleted file mode 100644 index 080eda01d0..0000000000 --- a/reference/event/eventbuffer/unlock.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - EventBuffer::unlock - Libera un bloqueo adquirido con EventBuffer::lock - - - &reftitle.description; - - public - bool - EventBuffer::unlock - - - - Libera un bloqueo adquirido con el método - EventBuffer::lock. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBuffer::lock - - - - - diff --git a/reference/event/eventbuffer/write.xml b/reference/event/eventbuffer/write.xml deleted file mode 100644 index 5ac120bb7c..0000000000 --- a/reference/event/eventbuffer/write.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - - - EventBuffer::write - Escribe el contenido del buffer en un fichero o en un socket - - - &reftitle.description; - - public - int - EventBuffer::write - - mixed - fd - - - int - howmuch - - - - Escribe el contenido del buffer en un descriptor de fichero. El buffer - será vaciado después de la escritura exitosa de los últimos octetos. - - - - &reftitle.parameters; - - - - fd - - - - Recurso de socket, flujo, o un descriptor numérico de fichero asociado con un socket. - - - - - - howmuch - - - - El número máximo de octetos a escribir. - - - - - - - &reftitle.returnvalues; - - Devuelve el número de octetos escritos, o &false; en caso de error. - - - - &reftitle.seealso; - - - EventBuffer::read - - - - - diff --git a/reference/event/eventbufferevent.about.callbacks.xml b/reference/event/eventbufferevent.about.callbacks.xml deleted file mode 100644 index 66afa9791d..0000000000 --- a/reference/event/eventbufferevent.about.callbacks.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - Acerca de las funciones de retrollamada del buffer de eventos - - Un objeto de la clase EventBufferEvent - representa un buffer de eventos. - La naturaleza asíncrona de I/O realizada por Libevent implica que un socket - (o cualquier otro tipo de descriptor de ficheros) no siempre está disponible. Event invoca las funciones de retrollamada correspondientes cuando - el recurso se vuelve disponible para una lectura o una escritura, - o cuando ocurren eventos (i.e. un error, un fin de línea, - etc.). - - - Las funciones de retrollamada de lectura y escritura deben corresponder - al siguiente prototipo: - - - void - callback - - EventBufferEvent - bev - &null; - - - mixed - arg - &null; - - - - - - bev - - - - Objeto EventBufferEvent asociado. - - - - - - arg - - - - Variable personalizada adjunta a todas las funciones de retrollamada - a través del método EventBufferEvent::__construct - o del método EventBufferEvent::setCallbacks. - - - - - - Una función de retrollamada de evento debe corresponder al siguiente prototipo: - - - void - callback - - EventBufferEvent - bev - &null; - - - int - events - 0 - - - mixed - arg - &null; - - - - - - bev - - - - Objeto EventBufferEvent asociado. - - - - - - events - - - - Máscara de bits de eventos: - EventBufferEvent::READING, - EventBufferEvent::WRITING, - EventBufferEvent::EOL, - EventBufferEvent::ERROR y - EventBufferEvent::TIMEOUT. Ver las - constantes EventBufferEvent. - - - - - - arg - - - - Variable personalizada adjunta a todas las funciones de retrollamada a través - del método EventBufferEvent::__construct o - del método EventBufferEvent::setCallbacks. - - - - - - diff --git a/reference/event/eventbufferevent.xml b/reference/event/eventbufferevent.xml deleted file mode 100644 index 96a868dc19..0000000000 --- a/reference/event/eventbufferevent.xml +++ /dev/null @@ -1,374 +0,0 @@ - - - - - - La clase EventBufferEvent - EventBufferEvent - - -
- &reftitle.intro; - - Representa un buffer de eventos Libevent. - - - Normalmente, una aplicación desea poner en buffer datos además de simplemente responder a eventos. Cuando se desea escribir datos, por ejemplo, el mecanismo habitual se asemeja a: - - - - - Se decide que se desea escribir datos en una conexión; coloque estos datos en un buffer. - - - - - Se espera a que la conexión se vuelva accesible en escritura. - - - - - Se escribe la mayor cantidad de datos posible. - - - - - Se recuerda la cantidad escrita, y si aún hay más datos para escribir, se espera a que la conexión vuelva a ser accesible en escritura. - - - - - Este mecanismo de bufferización de E/S es lo suficientemente común como para que Libevent proporcione un mecanismo genérico para ello. Un buffer de eventos consta de un transporte subyacente (como un socket), un buffer de lectura y un buffer de escritura. En lugar de un evento clásico, que proporciona funciones de retrollamada cuando el transporte subyacente está listo para ser leído o escrito, un buffer de eventos llama a sus funciones de retrollamada proporcionadas por el usuario cuando ha leído o escrito suficientes datos. - -
- -
- &reftitle.classsynopsis; - - - - - EventBufferEvent - - - - - final - EventBufferEvent - - - - &Constants; - - const - int - EventBufferEvent::READING - 1 - - - const - int - EventBufferEvent::WRITING - 2 - - - const - int - EventBufferEvent::EOF - 16 - - - const - int - EventBufferEvent::ERROR - 32 - - - const - int - EventBufferEvent::TIMEOUT - 64 - - - const - int - EventBufferEvent::CONNECTED - 128 - - - const - int - EventBufferEvent::OPT_CLOSE_ON_FREE - 1 - - - const - int - EventBufferEvent::OPT_THREADSAFE - 2 - - - const - int - EventBufferEvent::OPT_DEFER_CALLBACKS - 4 - - - const - int - EventBufferEvent::OPT_UNLOCK_CALLBACKS - 8 - - - const - int - EventBufferEvent::SSL_OPEN - 0 - - - const - int - EventBufferEvent::SSL_CONNECTING - 1 - - - const - int - EventBufferEvent::SSL_ACCEPTING - 2 - - &Properties; - - public - int - fd - - - public - int - priority - - - public - readonly - EventBuffer - input - - - public - readonly - EventBuffer - output - - &Methods; - - - -
- -
- &reftitle.properties; - - - - fd - - - - Descriptor de fichero numérico asociado con el buffer de eventos. Normalmente, representa un socket enlazado. Vale &null; si no hay ningún descriptor de fichero (socket) asociado con el buffer de eventos. - - - - - - priority - - - - La prioridad del evento, utilizada para implementar el buffer de eventos. - - - - - - input - - - - Objeto de buffer de entrada subyacente (EventBuffer) - - - - - - output - - - - Objeto de buffer de salida subyacente (EventBuffer) - - - - -
- - -
- &reftitle.constants; - - - - EventBufferEvent::READING - - - - Un evento ocurre durante la operación de lectura en el bufferevent. Ver otros flags para conocer el tipo de evento. - - - - - - EventBufferEvent::WRITING - - - - Un evento ocurre durante una operación de escritura en el bufferevent. Ver otros flags para conocer el tipo de evento. - - - - - - EventBufferEvent::EOF - - - - Se recibe una indicación de fin de fichero en el buffer de eventos. - - - - - - EventBufferEvent::ERROR - - - - Un error ocurre durante una operación bufferevent. Para más información sobre el error, llame al método EventUtil::getLastSocketErrno y/o EventUtil::getLastSocketError. - - - - - - EventBufferEvent::TIMEOUT - - - - - - - - EventBufferEvent::CONNECTED - - - - Termina una conexión solicitada en el bufferevent. - - - - - - EventBufferEvent::OPT_CLOSE_ON_FREE - - - - Cuando el buffer de eventos es liberado, cierra el transporte subyacente. Esto cerrará el socket subyacente, liberará el buffer de eventos subyacente, etc. - - - - - - EventBufferEvent::OPT_THREADSAFE - - - - Asigna automáticamente bloqueos para el bufferevent, para hacer segura la utilización de múltiples threads. - - - - - - EventBufferEvent::OPT_DEFER_CALLBACKS - - - - Cuando este flag está definido, el bufferevent pospone todas sus funciones de retrollamada. Ver la documentación sobre la programación de red rápida, portable, no bloqueante con Libevent, el posponer de las funciones de retrollamada. - - - - - - EventBufferEvent::OPT_UNLOCK_CALLBACKS - - - - Por omisión, cuando el bufferevent está definido para ser seguro al nivel de los threads, el bloqueo del buffer de eventos es mantenido, incluso si una función de retrollamada de usuario es llamada. La definición de esta opción permite a Libevent liberar el bloqueo del buffer de eventos cuando la función de retrollamada es llamada. - - - - - - EventBufferEvent::SSL_OPEN - - - - La negociación SSL se realiza. - - - - - - EventBufferEvent::SSL_CONNECTING - - - - SSL realiza actualmente la negociación como cliente. - - - - - - EventBufferEvent::SSL_ACCEPTING - - - - SSL realiza actualmente la negociación como servidor. - - - - -
- -
- - &reference.event.entities.eventbufferevent; - -
- diff --git a/reference/event/eventbufferevent/close.xml b/reference/event/eventbufferevent/close.xml deleted file mode 100644 index ca3e7e2a73..0000000000 --- a/reference/event/eventbufferevent/close.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - EventBufferEvent::close - Cierra el descriptor de fichero asociado con el buffer de eventos actual - - - &reftitle.description; - - public - void - EventBufferEvent::close - - - - Cierra el descriptor de fichero asociado con el buffer de eventos actual. - - - Este método puede ser utilizado en los casos donde la opción - EventBufferEvent::OPT_CLOSE_ON_FREE no es apropiada. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/eventbufferevent/connect.xml b/reference/event/eventbufferevent/connect.xml deleted file mode 100644 index 1e72992f2f..0000000000 --- a/reference/event/eventbufferevent/connect.xml +++ /dev/null @@ -1,272 +0,0 @@ - - - - - - - - EventBufferEvent::connect - Conecta el descriptor de fichero del búfer de eventos a la dirección proporcionada, - o al socket UNIX - - - &reftitle.description; - - public - bool - EventBufferEvent::connect - - string - addr - - - - Conecta el descriptor de fichero del búfer de eventos a la dirección proporcionada - (opcionalmente, proporcionando el puerto), o al socket UNIX. - - - Si el socket no está asignado al búfer de eventos, este método - asigna un nuevo socket y lo hace no bloqueante internamente. - - - Para resolver los nombres DNS (de forma asíncrona), utilice el método - EventBufferEvent::connectHost. - - - - &reftitle.parameters; - - - - addr - - - - Debe contener una dirección IP con, opcionalmente, el número del puerto, - o una ruta hacia el socket UNIX. Los formatos reconocidos son : - - - - Tenga en cuenta que el prefijo 'unix:' actualmente - no distingue entre mayúsculas y minúsculas. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - Ejemplo con <function>EventBufferEvent::connect</function> - -getInput(); - - while (($n = $input->remove($buf, 1024)) > 0) { - echo $buf; - } -} - -/* Función de retrollamada de evento */ -function eventcb($bev, $events, $base) { - if ($events & EventBufferEvent::CONNECTED) { - echo "Conectado.\n"; - } elseif ($events & (EventBufferEvent::ERROR | EventBufferEvent::EOF)) { - if ($events & EventBufferEvent::ERROR) { - echo "Error DNS: ", $bev->getDnsErrorString(), PHP_EOL; - } - - echo "Cierre\n"; - $base->exit(); - exit("Hecho !\n"); - } -} - -$base = new EventBase(); - -echo "paso 1\n"; -$bev = new EventBufferEvent($base, /* usar socket interno */ NULL, - EventBufferEvent::OPT_CLOSE_ON_FREE | EventBufferEvent::OPT_DEFER_CALLBACKS); -if (!$bev) { - exit("Fallo al crear el socket bufferevent\n"); -} - -echo "paso 2\n"; -$bev->setCallbacks("readcb", /* writecb */ NULL, "eventcb", $base); -$bev->enable(Event::READ | Event::WRITE); - -echo "paso 3\n"; -/* Envía la solicitud */ -$output = $bev->getOutput(); -if (!$output->add( - "GET /index.cphp HTTP/1.0\r\n". - "Connection: Close\r\n\r\n" -)) { - exit("Fallo al añadir la solicitud en el búfer de salida\n"); -} - -/* Conexión al host de forma asíncrona. - * Conocemos la IP, y por lo tanto, no necesitamos resolución DNS. */ -if (!$bev->connect("127.0.0.1:80")) { - exit("Imposible conectar al host\n"); -} - -/* Distribuye los eventos pendientes */ -$base->dispatch(); -]]> - - &example.outputs.similar; - - - - - - Conexión a un socket UNIX, lectura de la respuesta desde el - servidor, y visualización en una consola - -base = $base; - $this->bev = new EventBufferEvent($base, NULL, EventBufferEvent::OPT_CLOSE_ON_FREE, - array ($this, "read_cb"), NULL, array ($this, "event_cb")); - - if (!$this->bev->connect("unix:$sock_path")) { - trigger_error("Fallo al conectar al socket `$sock_path'", E_USER_ERROR); - } - - $this->bev->enable(Event::READ); - } - - function __destruct() { - if ($this->bev) { - $this->bev->free(); - $this->bev = NULL; - } - } - - function dispatch() { - $this->base->dispatch(); - } - - function read_cb($bev, $unused) { - $in = $bev->input; - - printf("Recepción de %ld bytes\n", $in->length); - printf("----- datos ----\n"); - printf("%ld:\t%s\n", (int) $in->length, $in->pullup(-1)); - - $this->bev->free(); - $this->bev = NULL; - $this->base->exit(NULL); - } - - function event_cb($bev, $events, $unused) { - if ($events & EventBufferEvent::ERROR) { - echo "Error desde bufferevent\n"; - } - - if ($events & (EventBufferEvent::EOF | EventBufferEvent::ERROR)) { - $bev->free(); - $bev = NULL; - } elseif ($events & EventBufferEvent::CONNECTED) { - $bev->output->add("test\n"); - } - } -} - -if ($argc <= 1) { - exit("La ruta hacia el socket no está proporcionada\n"); -} -$sock_path = $argv[1]; - -$base = new EventBase(); -$cl = new MyUnixSocketClient($base, $sock_path); -$cl->dispatch(); -?> - -]]> - - &example.outputs.similar; - - - - - - - &reftitle.seealso; - - - EventBufferEvent::connectHost - - - - - diff --git a/reference/event/eventbufferevent/connecthost.xml b/reference/event/eventbufferevent/connecthost.xml deleted file mode 100644 index 2b4de12e92..0000000000 --- a/reference/event/eventbufferevent/connecthost.xml +++ /dev/null @@ -1,256 +0,0 @@ - - - - - - - EventBufferEvent::connectHost - Conexión a un host con resolución de DNS asíncrona (opcional) - - - &reftitle.description; - - public - bool - EventBufferEvent::connectHost - - EventDnsBase - dns_base - - - string - hostname - - - int - port - - - int - family - EventUtil::AF_UNSPEC - - - - Resuelve el nombre de host DNS, buscando la dirección del tipo - family (constante EventUtil::AF_*). - Si la resolución del nombre falla, la función de retrollamada del evento - será llamada con un evento de error. Si la resolución tiene éxito, - se realizará un intento de conexión, de manera similar a como lo hace el método - EventBufferEvent::connect. - - - El parámetro dns_base es opcional. - Puede ser &null;, o bien un objeto creado con el método - EventDnsBase::__construct. - Para una resolución de nombre de host asíncrona, pase una fuente de evento de base DNS válida. De lo contrario, la resolución del nombre de host - será bloqueante. - - - - EventDnsBase solo está disponible si - Event está configurado con la opción - - (biblioteca event_extra, - el soporte de las funcionalidades específicas de libevent - incluyendo HTTP, DNS y RPC). - - - - - EventBufferEvent::connectHost - requiere libevent-2.0.3-alpha o posteriores. - - - - - &reftitle.parameters; - - - - dns_base - - - - Objeto EventDnsBase en el caso - donde el DNS debe ser resuelto de manera asíncrona. De lo contrario, &null;. - - - - - - hostname - - - - El nombre de host al cual se intenta realizar la conexión. - Los formatos reconocidos son: - - - - - - - - - port - - - - El número del puerto - - - - - - family - - - - Familia de la dirección. - EventUtil::AF_UNSPEC, - EventUtil::AF_INET o - EventUtil::AF_INET6. Ver las - constantes EventUtil. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - Ejemplo con <function>EventBufferEvent::connectHost</function> - -input; //$bev->getInput(); - - //$pos = $input->search("TTP"); - $pos = $bev->input->search("TTP"); - - while (($n = $bev->input->remove($buf, 1024)) > 0) { - echo $buf; - } -} - -/* Función de retrollamada del evento */ -function eventcb($bev, $events, $base) { - if ($events & EventBufferEvent::CONNECTED) { - echo "Conectado.\n"; - } elseif ($events & (EventBufferEvent::ERROR | EventBufferEvent::EOF)) { - if ($events & EventBufferEvent::ERROR) { - echo "Error DNS: ", $bev->getDnsErrorString(), PHP_EOL; - } - - echo "Cerrando\n"; - $base->exit(); - exit("Hecho !\n"); - } -} - -$base = new EventBase(); - -$dns_base = new EventDnsBase($base, TRUE); // Resolución DNS asíncrona -if (!$dns_base) { - exit("Fallo en la inicialización de la base DNS\n"); -} - -$bev = new EventBufferEvent($base, /* uso de un socket interno */ NULL, - EventBufferEvent::OPT_CLOSE_ON_FREE | EventBufferEvent::OPT_DEFER_CALLBACKS, - "readcb", /* writecb */ NULL, "eventcb", $base -); -if (!$bev) { - exit("Fallo al crear el socket bufferevent\n"); -} - -//$bev->setCallbacks("readcb", /* writecb */ NULL, "eventcb", $base); -$bev->enable(Event::READ | Event::WRITE); - -$output = $bev->output; //$bev->getOutput(); -if (!$output->add( - "GET {$argv[2]} HTTP/1.0\r\n". - "Host: {$argv[1]}\r\n". - "Connection: Close\r\n\r\n" -)) { - exit("Fallo al añadir la solicitud en el búfer de salida\n"); -} - -if (!$bev->connectHost($dns_base, $argv[1], 80, EventUtil::AF_UNSPEC)) { - exit("Imposible conectar al host {$argv[1]}\n"); -} - -$base->dispatch(); -?> -]]> - - &example.outputs.similar; - - -301 Moved -

301 Moved

-The document has moved -here. - -Cerrando -Hecho ! -]]> -
-
-
- - &reftitle.seealso; - - - EventBufferEvent::connect - - - -
- diff --git a/reference/event/eventbufferevent/construct.xml b/reference/event/eventbufferevent/construct.xml deleted file mode 100644 index 8fc46b0238..0000000000 --- a/reference/event/eventbufferevent/construct.xml +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - EventBufferEvent::__construct - Construye un objeto EventBufferEvent - - - &reftitle.description; - - public - EventBufferEvent::__construct - - EventBase - base - - - mixed - socket - &null; - - - int - options - 0 - - - callable - readcb - &null; - - - callable - writecb - &null; - - - callable - eventcb - &null; - - mixedarg&null; - - - Crea un buffer de eventos en un socket, un flujo o un descriptor de fichero. Pasar el valor &null; al parámetro - socket significa que el socket debe ser creado posteriormente, es decir, a través del método - EventBufferEvent::connect. - - - - &reftitle.parameters; - - - - base - - - - Evento base que debe ser asociado con el nuevo buffer de eventos. - - - - - - socket - - - - Debe ser creado como flujo (no necesariamente a través de la extensión - sockets) - - - - - - options - - - - Una constante entre las constantes - EventBufferEvent::OPT_*, - o 0. - - - - - - readcb - - - - Función de retrollamada para los eventos de lectura. Ver también las - funciones de retrollamada del buffer de eventos. - - - - - - writecb - - - - Función de retrollamada para los eventos de escritura. Ver también las - funciones de retrollamada del buffer de eventos. - - - - - - eventcb - - - - Función de retrollamada para los eventos de cambio de estado. Ver también las - funciones de retrollamada del buffer de eventos. - - - - - - arg - - - - Una variable que será pasada a todas las funciones de retrollamada. - - - - - - - &reftitle.seealso; - - - EventBufferEvent::sslFilter - - - EventBufferEvent::sslSocket - - - - - diff --git a/reference/event/eventbufferevent/createpair.xml b/reference/event/eventbufferevent/createpair.xml deleted file mode 100644 index b897087463..0000000000 --- a/reference/event/eventbufferevent/createpair.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - EventBufferEvent::createPair - Crea dos eventos de buffer conectados entre sí - - - &reftitle.description; - - public - static - array - EventBufferEvent::createPair - - EventBase - base - - - int - options - 0 - - - - Devuelve un array de dos objetos EventBufferEvent - conectados entre sí. Todas las opciones habituales son soportadas, - salvo EventBufferEvent::OPT_CLOSE_ON_FREE - que no tiene ningún efecto, y EventBufferEvent::OPT_DEFER_CALLBACKS - que siempre está activado. - - - - &reftitle.parameters; - - - - base - - - - Evento base asociado. - - - - - - options - - - - Constantes EventBufferEvent::OPT_* - combinadas con el operador OR. - - - - - - - &reftitle.returnvalues; - - Devuelve un array de dos objetos - EventBufferEvent - conectados entre sí. - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL event 1.9.0 - - El método es ahora estático. - - - - - - - - diff --git a/reference/event/eventbufferevent/disable.xml b/reference/event/eventbufferevent/disable.xml deleted file mode 100644 index 5af25b4511..0000000000 --- a/reference/event/eventbufferevent/disable.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - EventBufferEvent::disable - Desactiva los eventos de lectura, escritura o ambos en un evento de búfer - - - &reftitle.description; - - public - bool - EventBufferEvent::disable - - int - events - - - - Desactiva los eventos Event::READ, - Event::WRITE, o - Event::READ|Event::WRITE - en un evento de búfer. - - - - &reftitle.parameters; - - - - events - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBufferEvent::enable - - - - - diff --git a/reference/event/eventbufferevent/enable.xml b/reference/event/eventbufferevent/enable.xml deleted file mode 100644 index 8d67c01742..0000000000 --- a/reference/event/eventbufferevent/enable.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - EventBufferEvent::enable - Activa los eventos de lectura, escritura, o ambos, en un evento de buffer - - - &reftitle.description; - - public - bool - EventBufferEvent::enable - - int - events - - - - Activa los eventos Event::READ, - Event::WRITE, o - Event::READ|Event::WRITE - en un evento de buffer. - - - - &reftitle.parameters; - - - - events - - - - Event::READ, Event::WRITE, o - Event::READ|Event::WRITE - en un evento de buffer. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBufferEvent::disable - - - - - diff --git a/reference/event/eventbufferevent/free.xml b/reference/event/eventbufferevent/free.xml deleted file mode 100644 index 0e6a67abd0..0000000000 --- a/reference/event/eventbufferevent/free.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - EventBufferEvent::free - Libera un evento de búfer - - - &reftitle.description; - - public - void - EventBufferEvent::free - - - - Libera todos los recursos asignados por un evento - de búfer. - - - Generalmente, no es necesario llamar a este método, ya que normalmente, la liberación total de los recursos asociados se realiza - en los destructores internos del objeto. Sin embargo, puede ocurrir - que un script largo asigne muchas instancias, o bien que un script - utilice una gran cantidad de memoria; en estos casos, puede ser necesario - liberar los recursos lo más rápido posible. Asimismo, el uso del método - EventBufferEvent::free puede ser útil - para proteger la ejecución del script de alcanzar el valor de - memory_limit. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/eventbufferevent/getdnserrorstring.xml b/reference/event/eventbufferevent/getdnserrorstring.xml deleted file mode 100644 index 706cc5c4fc..0000000000 --- a/reference/event/eventbufferevent/getdnserrorstring.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - EventBufferEvent::getDnsErrorString - Devuelve un string que describe el último error DNS - - - &reftitle.description; - - public - string - EventBufferEvent::getDnsErrorString - - - - Devuelve un string que describe el último error DNS durante - la ejecución del método EventBufferEvent::connectHost - o un string vacío si no se detecta ningún error DNS. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve un string que describe el error DNS, o un string vacío si no hay - ningún error. - - - - &reftitle.seealso; - - - EventBufferEvent::connectHost - - - - - diff --git a/reference/event/eventbufferevent/getenabled.xml b/reference/event/eventbufferevent/getenabled.xml deleted file mode 100644 index e30ddaf421..0000000000 --- a/reference/event/eventbufferevent/getenabled.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - - EventBufferEvent::getEnabled - Devuelve una máscara de eventos actualmente activos en el búfer de eventos - - - &reftitle.description; - - public - int - EventBufferEvent::getEnabled - - - - Devuelve una máscara de eventos actualmente activos en el búfer de eventos. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve un entero que representa una máscara de eventos actualmente - activos en el búfer de eventos. - - - - &reftitle.seealso; - - - EventBufferEvent::enable - - - EventBufferEvent::disable - - - - - diff --git a/reference/event/eventbufferevent/getinput.xml b/reference/event/eventbufferevent/getinput.xml deleted file mode 100644 index 68c852c38a..0000000000 --- a/reference/event/eventbufferevent/getinput.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - - EventBufferEvent::getInput - Devuelve el búfer de entrada asociado con el búfer de eventos actual - - - &reftitle.description; - - public - EventBuffer - EventBufferEvent::getInput - - - - Devuelve el búfer de entrada asociado con el búfer de eventos actual. - Un búfer de entrada es un almacenamiento para los datos a leer. - - - Téngase en cuenta que también hay propiedades de - entrada - para la clase EventBufferEvent. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve una instancia del búfer de entrada - EventBuffer asociado con el búfer de eventos actual. - - - - &reftitle.examples; - - Función de retrollamada para un evento de lectura en el búfer - -input; //$bev->getInput(); - - while (($n = $input->remove($buf, 1024)) > 0) { - echo $buf; - } -} -?> -]]> - - - - - &reftitle.seealso; - - - EventBufferEvent::getOutput - - - - - diff --git a/reference/event/eventbufferevent/getoutput.xml b/reference/event/eventbufferevent/getoutput.xml deleted file mode 100644 index d34e9e89d5..0000000000 --- a/reference/event/eventbufferevent/getoutput.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - - EventBufferEvent::getOutput - Devuelve el búfer de salida asociado con el búfer de evento actual - - - &reftitle.description; - - public - EventBuffer - EventBufferEvent::getOutput - - - - Devuelve el búfer de salida asociado con el búfer de evento actual. Un búfer de salida es un almacenamiento para los datos a escribir. - - - Tenga en cuenta que también hay propiedades de - salida - para la clase EventBufferEvent. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve una instancia del búfer de salida - EventBuffer asociado con el búfer de eventos actual. - - - - &reftitle.examples; - - Ejemplo con <function>EventBufferEvent::getOutput</function> - -enable(Event::READ | Event::WRITE); - -$output = $bev->getOutput(); -if (!$output->add( - "GET {$argv[2]} HTTP/1.0\r\n". - "Host: {$argv[1]}\r\n". - "Connection: Close\r\n\r\n" -)) { - exit("Fallo al añadir la solicitud en el búfer de salida\n"); -} - -/* ... */ -?> -]]> - - - - - &reftitle.seealso; - - - EventBufferEvent::getInput - - - - - diff --git a/reference/event/eventbufferevent/read.xml b/reference/event/eventbufferevent/read.xml deleted file mode 100644 index 802d7089a7..0000000000 --- a/reference/event/eventbufferevent/read.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - EventBufferEvent::read - Lee los datos del búfer - - - &reftitle.description; - - public - string - EventBufferEvent::read - - int - size - - - - Elimina los size bytes del búfer - de entrada. Devuelve un string de datos leídos - desde el búfer de entrada. - - - - &reftitle.parameters; - - - - size - - - - Número máximo de bytes a leer - - - - - - - &reftitle.returnvalues; - - Devuelve el string de datos leídos desde el búfer de entrada. - - - - &reftitle.seealso; - - - EventBufferEvent::readBuffer - - - - - diff --git a/reference/event/eventbufferevent/readbuffer.xml b/reference/event/eventbufferevent/readbuffer.xml deleted file mode 100644 index 60b6800d9e..0000000000 --- a/reference/event/eventbufferevent/readbuffer.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - EventBufferEvent::readBuffer - Vacía el contenido entero del búfer de entrada y lo coloca en el búfer - - - &reftitle.description; - - public - bool - EventBufferEvent::readBuffer - - EventBuffer - buf - - - - Vacía el contenido entero del búfer de entrada y lo coloca en el búfer - buf. - - - - &reftitle.parameters; - - - - buf - - - - Búfer objetivo - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBufferEvent::read - - - - - diff --git a/reference/event/eventbufferevent/setcallbacks.xml b/reference/event/eventbufferevent/setcallbacks.xml deleted file mode 100644 index f3cf5e456b..0000000000 --- a/reference/event/eventbufferevent/setcallbacks.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - EventBufferEvent::setCallbacks - Asigna las funciones de retrollamada para la lectura, la escritura y los estados de eventos - - - &reftitle.description; - - public - void - EventBufferEvent::setCallbacks - - callable - readcb - - - callable - writecb - - - callable - eventcb - - - mixed - arg - - - - Asigna las funciones de retrollamada para la lectura, la escritura y los estados de eventos. - - - - &reftitle.parameters; - - - - readcb - - - - Función de retrollamada para un evento de lectura. - Véase las - funciones de - retrollamada para los tampones de eventos. - - - - - - writecb - - - - Función de retrollamada para un evento de escritura. - Véase las - funciones de - retrollamada para los tampones de eventos. - - - - - - eventcb - - - - Función de retrollamada para un evento de cambio de estado. - Véase las - funciones de - retrollamada para los tampones de eventos. - - - - - - arg - - - - Una variable que será pasada a todas las funciones de retrollamada. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventBufferEvent::__construct - - - - - diff --git a/reference/event/eventbufferevent/setpriority.xml b/reference/event/eventbufferevent/setpriority.xml deleted file mode 100644 index cae1686de8..0000000000 --- a/reference/event/eventbufferevent/setpriority.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - - EventBufferEvent::setPriority - Asigna una prioridad para un búfer de eventos - - - &reftitle.description; - - public - bool - EventBufferEvent::setPriority - - int - priority - - - - Asigna una prioridad para un búfer de eventos. - - - - Solo soportado para los sockets de búfer de eventos. - - - - - &reftitle.parameters; - - - - priority - - - - Valor de la prioridad. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/eventbufferevent/settimeouts.xml b/reference/event/eventbufferevent/settimeouts.xml deleted file mode 100644 index 4aebf1e904..0000000000 --- a/reference/event/eventbufferevent/settimeouts.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - EventBufferEvent::setTimeouts - Define el modo de lectura y escritura para el tiempo de espera máximo de un búfer de eventos - - - &reftitle.description; - - public - bool - EventBufferEvent::setTimeouts - - float - timeout_read - - - float - timeout_write - - - - Define el modo de lectura y escritura para el tiempo de espera máximo de un búfer de eventos. - - - - &reftitle.parameters; - - - - timeout_read - - - - La lectura del tiempo de espera máximo - - - - - - timeout_write - - - - La escritura del tiempo de espera máximo - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/eventbufferevent/setwatermark.xml b/reference/event/eventbufferevent/setwatermark.xml deleted file mode 100644 index 43d9360ef9..0000000000 --- a/reference/event/eventbufferevent/setwatermark.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - EventBufferEvent::setWatermark - Activa la lectura, y/o la escritura de las marcas de agua - - - &reftitle.description; - - public - void - EventBufferEvent::setWatermark - - int - events - - - int - lowmark - - - int - highmark - - - - Activa la lectura, la escritura o ambas para las marcas de agua - de un búfer de eventos. - - - Una marca de agua de búfer de eventos es una porción, un valor que especifica - el número de bytes a leer o escribir antes de llamar a la función de retrollamada. - Por omisión, cada evento de lectura/escritura lanza una función de retrollamada. - Vea también la siguiente página (en inglés): - Fast - portable non-blocking network programming with Libevent: Callbacks and watermarks - - - - &reftitle.parameters; - - - - events - - - - Máscara de constantes Event::READ, - Event::WRITE, o ambas. - - - - - - lowmark - - - - Valor mínimo de la marca de agua. - - - - - - highmark - - - - Valor máximo de la marca de agua. El valor 0 - significa "sin límite". - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/eventbufferevent/sslerror.xml b/reference/event/eventbufferevent/sslerror.xml deleted file mode 100644 index c277189ee1..0000000000 --- a/reference/event/eventbufferevent/sslerror.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - - EventBufferEvent::sslError - Devuelve el error OpenSSL más reciente reportado por el buffer de eventos - - - &reftitle.description; - - public - string - EventBufferEvent::sslError - - - - Devuelve el error OpenSSL más reciente reportado por el buffer de eventos. - - - - Este método solo está disponible si - Event ha sido compilado con soporte OpenSSL. - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve la cadena de error OpenSSL reportada por el buffer de eventos o - &false; si no hay más errores que devolver. - - - - &reftitle.examples; - - Ejemplo con <function>EventBufferEvent::sslError</function> - -sslError()) { - fprintf(STDERR, "Bufferevent error %s.\n", $err); - } - } - - if ($events & (EventBufferEvent::EOF | EventBufferEvent::ERROR)) { - $bev->free(); - } -} -?> -]]> - - - - - &reftitle.seealso; - - - EventBufferEvent::sslRenegotiate - - - - - diff --git a/reference/event/eventbufferevent/sslfilter.xml b/reference/event/eventbufferevent/sslfilter.xml deleted file mode 100644 index 56354f8d8f..0000000000 --- a/reference/event/eventbufferevent/sslfilter.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - EventBufferEvent::sslFilter - Crea un nuevo búfer de evento SSL, cuyos datos - serán enviados a través de otro búfer de evento - - - &reftitle.description; - - public - static - EventBufferEvent - EventBufferEvent::sslFilter - - EventBase - base - - - EventBufferEvent - underlying - - - EventSslContext - ctx - - - int - state - - - int - options - 0 - - - - Crea un nuevo búfer de evento SSL, cuyos datos - serán enviados a través de otro búfer de evento. - - - - Este método solo está disponible si - Event ha sido compilado con soporte OpenSSL. - - - - - &reftitle.parameters; - - - - base - - - - Evento base asociado. - - - - - - underlying - - - - Un socket de búfer de evento a utilizar para este SSL. - - - - - - ctx - - - - Objeto de la clase EventSslContext. - - - - - - state - - - - El estado actual de la conexión SSL: - EventBufferEvent::SSL_OPEN, - EventBufferEvent::SSL_ACCEPTING o - EventBufferEvent::SSL_CONNECTING. - - - - - - options - - - - Una o más opciones de búfer de evento. - - - - - - - &reftitle.returnvalues; - - Devuelve un nuevo objeto EventBufferEvent SSL. - - - - &reftitle.examples; - - - - - - &reftitle.seealso; - - - EventBufferEvent::sslSocket - - - - - diff --git a/reference/event/eventbufferevent/sslgetcipherinfo.xml b/reference/event/eventbufferevent/sslgetcipherinfo.xml deleted file mode 100644 index 3bdfec3fdb..0000000000 --- a/reference/event/eventbufferevent/sslgetcipherinfo.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - EventBufferEvent::sslGetCipherInfo - Devuelve una descripción textual de un cipher - - - &reftitle.description; - - public - string - EventBufferEvent::sslGetCipherInfo - - - - Recupera la descripción del cipher actual a través de la función - SSL_CIPHER_description de la API SSL (ver - la página man de SSL_CIPHER_get_name(3)). - - - - Esta función solo está disponible si - Event ha sido compilado con soporte - OpenSSL. - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve una descripción textual del cipher en caso de éxito, - o bien &false; si ocurre un error. - - - - diff --git a/reference/event/eventbufferevent/sslgetciphername.xml b/reference/event/eventbufferevent/sslgetciphername.xml deleted file mode 100644 index ad9cc2c3c7..0000000000 --- a/reference/event/eventbufferevent/sslgetciphername.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - EventBufferEvent::sslGetCipherName - Devuelve el nombre del cipher actual para la conexión SSL - - - &reftitle.description; - - public - string - EventBufferEvent::sslGetCipherName - - - - Recupera el nombre del cipher actual para la conexión SSL. - - - - Esta función solo está disponible si - Event ha sido compilado con soporte - OpenSSL. - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve el nombre del cipher actual para la conexión SSL o &false; - en caso de error. - - - - diff --git a/reference/event/eventbufferevent/sslgetcipherversion.xml b/reference/event/eventbufferevent/sslgetcipherversion.xml deleted file mode 100644 index 88084ab64d..0000000000 --- a/reference/event/eventbufferevent/sslgetcipherversion.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - EventBufferEvent::sslGetCipherVersion - Devuelve la versión del cipher utilizado para la conexión SSL actual - - - &reftitle.description; - - public - string - EventBufferEvent::sslGetCipherVersion - - - - Recupera la versión del cipher utilizado para la conexión SSL actual. - - - - Esta función solo está disponible si - Event ha sido compilado con soporte - OpenSSL. - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve la versión del cipher utilizado para la conexión SSL actual - o &false; en caso de error. - - - - diff --git a/reference/event/eventbufferevent/sslgetprotocol.xml b/reference/event/eventbufferevent/sslgetprotocol.xml deleted file mode 100644 index d106b35a46..0000000000 --- a/reference/event/eventbufferevent/sslgetprotocol.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - EventBufferEvent::sslGetProtocol - Devuelve el nombre del protocolo utilizado para la conexión SSL actual - - - &reftitle.description; - - public - string - EventBufferEvent::sslGetProtocol - - - - Devuelve el nombre del protocolo utilizado para la conexión SSL actual. - - - - Esta función solo está disponible si - Event ha sido compilado con soporte - OpenSSL. - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve el nombre del protocolo utilizado para la conexión SSL actual. - - - - - diff --git a/reference/event/eventbufferevent/sslrenegotiate.xml b/reference/event/eventbufferevent/sslrenegotiate.xml deleted file mode 100644 index e9742377a4..0000000000 --- a/reference/event/eventbufferevent/sslrenegotiate.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - EventBufferEvent::sslRenegotiate - Solicita al búfer de eventos iniciar una renegociación SSL - - - &reftitle.description; - - public - void - EventBufferEvent::sslRenegotiate - - - - Solicita al búfer de eventos iniciar una renegociación SSL. - - - - La llamada a este método solicita a SSL una renegociación, y al búfer de eventos llamar a la función de retrollamada apropiada. Es un método muy avanzado; solo debe ser llamado si se sabe perfectamente lo que se hace, especialmente desde algunas versiones SSL donde se han actualizado fallas de seguridad durante la renegociación. - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/eventbufferevent/sslsocket.xml b/reference/event/eventbufferevent/sslsocket.xml deleted file mode 100644 index 9eac185ff3..0000000000 --- a/reference/event/eventbufferevent/sslsocket.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - EventBufferEvent::sslSocket - Crea un nuevo buffer SSL cuyos datos serán enviados a través de un socket SSL - - - &reftitle.description; - - public - static - EventBufferEvent - EventBufferEvent::sslSocket - - EventBase - base - - - mixed - socket - - - EventSslContext - ctx - - - int - state - - - int - options - - - - Crea un nuevo buffer SSL cuyos datos serán - enviados a través de un socket SSL. - - - - &reftitle.parameters; - - - - base - - - - Evento base asociado. - - - - - - socket - - - - Socket a utilizar para este SSL. Puede ser un flujo, un recurso - de socket, un descriptor numérico de fichero, o &null;. Si el - argumento socket es &null;, se asume - que el descriptor de fichero para este socket será asignado posteriormente - a través del método EventBufferEvent::connectHost. - - - - - - ctx - - - - Objeto de la clase EventSslContext. - - - - - - state - - - - El estado actual de la conexión SSL: - EventBufferEvent::SSL_OPEN, - EventBufferEvent::SSL_ACCEPTING o - EventBufferEvent::SSL_CONNECTING. - - - - - - options - - - - Las opciones del buffer de evento. - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto EventBufferEvent. - - - - &reftitle.seealso; - - - EventBufferEvent::sslFilter - - - - - diff --git a/reference/event/eventbufferevent/write.xml b/reference/event/eventbufferevent/write.xml deleted file mode 100644 index 1abcfbe6bf..0000000000 --- a/reference/event/eventbufferevent/write.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - EventBufferEvent::write - Añade datos a un buffer de evento de salida - - - &reftitle.description; - - public - bool - EventBufferEvent::write - - string - data - - - - Añade datos a un buffer de evento de salida. - - - - &reftitle.parameters; - - - - data - - - - Datos a añadir al buffer. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBufferEvent::writeBuffer - - - - - diff --git a/reference/event/eventbufferevent/writebuffer.xml b/reference/event/eventbufferevent/writebuffer.xml deleted file mode 100644 index bd7c9474e1..0000000000 --- a/reference/event/eventbufferevent/writebuffer.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - EventBufferEvent::writeBuffer - Añade el contenido entero de un buffer en un buffer de evento de salida - - - &reftitle.description; - - public - bool - EventBufferEvent::writeBuffer - - EventBuffer - buf - - - - Añade el contenido entero de un buffer en un buffer de evento de salida. - - - - &reftitle.parameters; - - - - buf - - - - Objeto EventBuffer fuente. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBufferEvent::write - - - - - diff --git a/reference/event/eventconfig.xml b/reference/event/eventconfig.xml deleted file mode 100644 index 305918ac0e..0000000000 --- a/reference/event/eventconfig.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - La clase EventConfig - EventConfig - - -
- &reftitle.intro; - - Representa la estructura de configuración que puede ser utilizada - en la construcción de la clase EventBase. - -
- -
- &reftitle.classsynopsis; - - - - - EventConfig - - - - - final - EventConfig - - - - &Constants; - - const - int - EventConfig::FEATURE_ET - 1 - - - const - int - EventConfig::FEATURE_O1 - 2 - - - const - int - EventConfig::FEATURE_FDS - 4 - - &Methods; - - - -
- -
- &reftitle.constants; - - - - EventConfig::FEATURE_ET - - - - Requiere un método del backend que soporte las I/O edge-triggered. - - - - - - EventConfig::FEATURE_O1 - - - - Requiere un método del backend donde añadir o eliminar un solo evento, - o tener un solo evento que se vuelve activo. - - - - - - EventConfig::FEATURE_FDS - - - - Requiere un método del backend que puede soportar tipos de - descriptor de fichero arbitrario, y no solo sockets. - - - - -
- -
- - &reference.event.entities.eventconfig; - -
- diff --git a/reference/event/eventconfig/avoidmethod.xml b/reference/event/eventconfig/avoidmethod.xml deleted file mode 100644 index 6df0c9d78c..0000000000 --- a/reference/event/eventconfig/avoidmethod.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - EventConfig::avoidMethod - Solicita a libevent que ignore un método de evento específico - - - &reftitle.description; - - public - bool - EventConfig::avoidMethod - - string - method - - - - Solicita a libevent que ignore un método de evento específico. - Ver la - creación - de un evento de base. - - - - &reftitle.parameters; - - - - method - - - - El método a ignorar. Ver - las constantes EventConfig. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - Ejemplo con <function>EventConfig::avoidMethod</function> - -avoidMethod("select")) { - echo "Método 'select' ignorado\n"; -} -?> -]]> - - - - - &reftitle.seealso; - - - EventBase::__construct - - - - - diff --git a/reference/event/eventconfig/construct.xml b/reference/event/eventconfig/construct.xml deleted file mode 100644 index cfaed3c099..0000000000 --- a/reference/event/eventconfig/construct.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - EventConfig::__construct - Construye un objeto EventConfig - - - &reftitle.description; - - public - EventConfig::__construct - - - - Construye un objeto EventConfig que podrá ser pasado - al constructor EventBase::__construct. - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.examples; - - Ejemplo con <function>EventConfig::__construct</function> - -avoidMethod("select")) { - echo "Método 'select' ignorado\n"; -} - -// Crea un event_base asociado con la configuración -$base = new EventBase($cfg); - -/* Ahora, $base está configurado para ignorar el método select */ -?> -]]> - - - - - - &reftitle.seealso; - - - EventBase::__construct - - - - - diff --git a/reference/event/eventconfig/requirefeatures.xml b/reference/event/eventconfig/requirefeatures.xml deleted file mode 100644 index 60cbdd0c66..0000000000 --- a/reference/event/eventconfig/requirefeatures.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - - EventConfig::requireFeatures - Ingresa una funcionalidad de método de evento solicitada por la aplicación - - - &reftitle.description; - - public - bool - EventConfig::requireFeatures - - int - feature - - - - Ingresa una funcionalidad de método de evento solicitada - por la aplicación. - - - - &reftitle.parameters; - - - - feature - - - - Máscara de funcionalidades solicitadas. Ver las constantes - EventConfig::FEATURE_*. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - Ejemplo con <function>EventConfig::requireFeatures</function> - -requireFeatures(EventConfig::FEATURE_FDS)) { - echo "funcionalidad FDS solicitada\n"; - - $base = new EventBase($cfg); - ($base->getFeatures() & EventConfig::FEATURE_FDS) - and print "FDS - tipos arbitrarios de descriptor de fichero y no solo sockets\n"; -} -?> -]]> - - &example.outputs.similar; - - - - - - - &reftitle.seealso; - - - EventBase::getFeatures - - - - - diff --git a/reference/event/eventconfig/setflags.xml b/reference/event/eventconfig/setflags.xml deleted file mode 100644 index be147f1b62..0000000000 --- a/reference/event/eventconfig/setflags.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - EventConfig::setFlags - Define uno o varios flags para configurar la inicialización eventual de EventBase - - - &reftitle.description; - - public - bool - EventConfig::setFlags - - int - flags - - - - Define uno o varios flags para configurar las partes de la inicialización eventual de EventBase que serán inicializadas, y cómo funcionarán. - - - - &reftitle.parameters; - - - - flags - - - - Una de las constantes EventBase::LOOP_*. Ver constantes de EventBase. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventBase::getFeatures - - - - - diff --git a/reference/event/eventconfig/setmaxdispatchinterval.xml b/reference/event/eventconfig/setmaxdispatchinterval.xml deleted file mode 100644 index a96059e07a..0000000000 --- a/reference/event/eventconfig/setmaxdispatchinterval.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - EventConfig::setMaxDispatchInterval - Evita la inversión de prioridades - - - &reftitle.description; - - public - void - EventConfig::setMaxDispatchInterval - - int - max_interval - - - int - max_callbacks - - - int - min_priority - - - - Evita la inversión de prioridades limitando el número de funciones de retrollamada de eventos de baja prioridad que pueden ser invocadas antes de verificar la presencia de eventos de alta prioridad. - - - - Disponible a partir de libevent 2.1.0-alpha. - - - - - &reftitle.parameters; - - - - max_interval - - - - Un intervalo después del cual Libevent detendrá la ejecución de las funciones de retrollamada y verificará la presencia de otros eventos, o 0 si no debe haber tal intervalo. - - - - - - max_callbacks - - - - Un número de funciones de retrollamada después del cual Libevent debe detener la ejecución de las funciones de retrollamada y verificar la presencia de otros eventos, o -1 si no debe haber tal límite. - - - - - - min_priority - - - - Una prioridad por debajo de la cual max_interval y max_callbacks no deben ser tomados en cuenta. Si se define a 0, serán tomados en cuenta para los eventos de cualquier prioridad; si se define a 1, serán tomados en cuenta para los eventos de prioridad 1 y así sucesivamente. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/eventdnsbase.xml b/reference/event/eventdnsbase.xml deleted file mode 100644 index 42d224b02a..0000000000 --- a/reference/event/eventdnsbase.xml +++ /dev/null @@ -1,210 +0,0 @@ - - - - - - - La clase EventDnsBase - EventDnsBase - - -
- &reftitle.intro; - - Representa la estructura base DNS de Libevent. Utilizada para - resolver DNS de forma asíncrona, para analizar ficheros - de configuración como resolv.conf etc. - -
- -
- &reftitle.classsynopsis; - - - - - EventDnsBase - - - - - final - EventDnsBase - - - - &Constants; - - const - int - EventDnsBase::OPTION_SEARCH - 1 - - - const - int - EventDnsBase::OPTION_NAMESERVERS - 2 - - - const - int - EventDnsBase::OPTION_MISC - 4 - - - const - int - EventDnsBase::OPTION_HOSTSFILE - 8 - - - const - int - EventDnsBase::OPTIONS_ALL - 15 - - - const - int - EventDnsBase::DISABLE_WHEN_INACTIVE - 32768 - - - const - int - EventDnsBase::INITIALIZE_NAMESERVERS - 1 - - - const - int - EventDnsBase::NAMESERVERS_NO_DEFAULT - 65536 - - &Methods; - - - - -
- -
- &reftitle.constants; - - - - EventDnsBase::OPTION_SEARCH - - - - Solicita leer el dominio y buscar los campos desde el - fichero resolv.conf y la opción - ndots, y los utiliza para decidir qué dominio - (si lo hay) debe ser utilizado para buscar los nombres de hosts - que no están totalmente cualificados. - - - - - - EventDnsBase::OPTION_NAMESERVERS - - - - Solicita conocer los nombres de los servidores desde el fichero - resolv.conf. - - - - - - EventDnsBase::OPTION_MISC - - - - - - - - EventDnsBase::OPTION_HOSTSFILE - - - - Solicita leer una lista de hosts desde el fichero - /etc/hosts como parte de la - carga del fichero resolv.conf. - - - - - - EventDnsBase::OPTIONS_ALL - - - - Solicita conocer todo el contenido del fichero - resolv.conf. - - - - - - EventDnsBase::DISABLE_WHEN_INACTIVE - - - - No impide que el bucle de eventos de libevent termine cuando no se tienen peticiones DNS activas. - - - - - - EventDnsBase::INITIALIZE_NAMESERVERS - - - - Procesar el fichero resolv.conf. - - - - - - EventDnsBase::NAMESERVERS_NO_DEFAULT - - - - No añadir un servidor de nombres por omisión si no hay servidores de nombres en el fichero resolv.conf. - - - - -
- -
- - &reference.event.entities.eventdnsbase; - -
- diff --git a/reference/event/eventdnsbase/addnameserverip.xml b/reference/event/eventdnsbase/addnameserverip.xml deleted file mode 100644 index 7dd4b546e6..0000000000 --- a/reference/event/eventdnsbase/addnameserverip.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - EventDnsBase::addNameserverIp - Añade un servidor de nombres a la base DNS - - - &reftitle.description; - - public - bool - EventDnsBase::addNameserverIp - - string - ip - - - - Añade un servidor de nombres a evdns_base. - - - - &reftitle.parameters; - - - - ip - - - - El string que representa el servidor de nombres; puede ser una dirección - IPv4, una dirección IPv6, una dirección IPv4 con un puerto - (IPv4:Port), o una dirección IPv6 con un - puerto ([IPv6]:Port). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/eventdnsbase/addsearch.xml b/reference/event/eventdnsbase/addsearch.xml deleted file mode 100644 index 126f843ffb..0000000000 --- a/reference/event/eventdnsbase/addsearch.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - EventDnsBase::addSearch - Añade un dominio a la lista de dominios utilizados para la búsqueda - - - &reftitle.description; - - public - void - EventDnsBase::addSearch - - string - domain - - - - Añade un dominio a la lista de dominios utilizados para la búsqueda. - - - - &reftitle.parameters; - - - - domain - - - - El dominio a añadir para la búsqueda. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/eventdnsbase/clearsearch.xml b/reference/event/eventdnsbase/clearsearch.xml deleted file mode 100644 index 8bd9f2566e..0000000000 --- a/reference/event/eventdnsbase/clearsearch.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - EventDnsBase::clearSearch - Elimina todos los sufijos de búsqueda comunes - - - &reftitle.description; - - public - void - EventDnsBase::clearSearch - - - - Elimina todos los sufijos de búsqueda comunes desde - la base DNS; el método EventDnsBase::addSearch - añade un sufijo. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventDnsBase::addSearch - - - - - diff --git a/reference/event/eventdnsbase/construct.xml b/reference/event/eventdnsbase/construct.xml deleted file mode 100644 index eaba38a4a2..0000000000 --- a/reference/event/eventdnsbase/construct.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - - EventDnsBase::__construct - Construye un objeto EventDnsBase - - - &reftitle.description; - - public - EventDnsBase::__construct - - EventBase - base - - - intbool - initialize - - - - Construye un objeto EventDnsBase. - - - - &reftitle.parameters; - - - - base - - - - Evento de base. - - - - - - initialize - - - - Si initialize es &true;, intenta utilizar los parámetros por defecto del sistema operativo subyacente para configurar adecuadamente la base DNS. - Si es &false;, la base DNS se deja sin configurar, sin servidores de nombres ni opciones definidas. - En este último caso, la base DNS debe ser configurada manualmente, por ejemplo con el método EventDnsBase::parseResolvConf. - - - Si initialize es un entero, debe ser uno de los siguientes flags: - - - - - Flag - &Description; - - - - - EventDnsBase::DISABLE_WHEN_INACTIVE - - No impide que el bucle de eventos de libevent termine cuando no haya solicitudes DNS activas. - - - - EventDnsBase::INITIALIZE_NAMESERVERS - - Procesar el fichero resolv.conf. - - - - EventDnsBase::NAMESERVERS_NO_DEFAULT - - No añadir servidores de nombres por defecto si no hay servidores de nombres en el fichero resolv.conf. - - - - - - - - - - - - &reftitle.errors; - - Si initialize tiene un tipo distinto de - intbool, - se lanza una TypeError. - - - Si el valor de initialize es inválido, - se lanza una EventException. - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL event 3.1.3 - - Si initialize tiene un tipo distinto de - intbool, - se lanza una TypeError. - - - - PECL event 3.1.0RC1 - - El tipo del parámetro initialize ha sido cambiado de bool - a mixed. El valor puede ser bool (preservando el significado anterior) - o una de las siguientes constantes: - EventDnsBase::DISABLE_WHEN_INACTIVE, - EventDnsBase::INITIALIZE_NAMESERVERS, - o EventDnsBase::NAMESERVERS_NO_DEFAULT. - - - - - - - - diff --git a/reference/event/eventdnsbase/countnameservers.xml b/reference/event/eventdnsbase/countnameservers.xml deleted file mode 100644 index c3ac88919a..0000000000 --- a/reference/event/eventdnsbase/countnameservers.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - EventDnsBase::countNameservers - Recupera el número de servidores de nombres configurados - - - &reftitle.description; - - public - int - EventDnsBase::countNameservers - - - - Recupera el número de servidores de nombres configurados. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve el número de servidores de nombres configurados (no necesariamente - el número de servidores de nombres en funcionamiento). Esto es útil - para verificar si las llamadas a las diversas funciones de configuración - de los servidores de nombres han tenido éxito o no. - - - - diff --git a/reference/event/eventdnsbase/loadhosts.xml b/reference/event/eventdnsbase/loadhosts.xml deleted file mode 100644 index 1be1b44018..0000000000 --- a/reference/event/eventdnsbase/loadhosts.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - EventDnsBase::loadHosts - Carga un fichero hosts (en el mismo formato que /etc/hosts) - - - &reftitle.description; - - public - bool - EventDnsBase::loadHosts - - string - hosts - - - - Carga un fichero hosts (en el mismo formato que /etc/hosts). - - - - &reftitle.parameters; - - - - hosts - - - - Ruta de acceso al fichero hosts. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/eventdnsbase/parseresolvconf.xml b/reference/event/eventdnsbase/parseresolvconf.xml deleted file mode 100644 index 1aba477d0b..0000000000 --- a/reference/event/eventdnsbase/parseresolvconf.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - EventDnsBase::parseResolvConf - Analiza el fichero resolv.conf - - - &reftitle.description; - - public - bool - EventDnsBase::parseResolvConf - - int - flags - - - string - filename - - - - Analiza el fichero resolv.conf y lee todas las opciones presentes. - - - - &reftitle.parameters; - - - - flags - - - - Determina la información a analizar desde el fichero - resolv.conf. Ver la página del manual del sistema - del fichero resolv.conf para conocer - su formato. - - - Las siguientes directivas no son analizadas en el fichero: - sortlist, rotate, no-check-names, inet6, debug. - - - Si esta función encuentra un error, los valores devueltos posibles - son: - - - 1 = fallo al abrir el fichero - - 2 = fallo al recuperar la información del fichero - - 3 = fichero demasiado grande - - 4 = exceso de memoria - - 5 = lectura demasiado corta del fichero - - 6 = ningún servidor de nombres listado en el fichero - - - - - - - filename - - - - Ruta hacia el fichero resolv.conf. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/eventdnsbase/setoption.xml b/reference/event/eventdnsbase/setoption.xml deleted file mode 100644 index 9fa58b4cc9..0000000000 --- a/reference/event/eventdnsbase/setoption.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - EventDnsBase::setOption - Define el valor de una opción de configuración - - - &reftitle.description; - - public - bool - EventDnsBase::setOption - - string - option - - - string - value - - - - Define el valor de una opción de configuración. - - - - &reftitle.parameters; - - - - option - - - - Las opciones de configuración actualmente disponibles son: - "ndots", "timeout", - "max-timeouts", "max-inflight" - y "attempts". - - - - - - value - - - - El valor de la opción. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/eventdnsbase/setsearchndots.xml b/reference/event/eventdnsbase/setsearchndots.xml deleted file mode 100644 index fce081df85..0000000000 --- a/reference/event/eventdnsbase/setsearchndots.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - EventDnsBase::setSearchNdots - Define el parámetro 'ndots' para las búsquedas - - - &reftitle.description; - - public - bool - EventDnsBase::setSearchNdots - - int - ndots - - - - Define el parámetro 'ndots' para las búsquedas. - Define el número de puntos que, cuando se encuentran en un nombre, - hace que la primera solicitud se realice sin búsqueda de dominio. - - - - &reftitle.parameters; - - - - ndots - - - - El número de puntos. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/eventexception.xml b/reference/event/eventexception.xml deleted file mode 100644 index b0228a4534..0000000000 --- a/reference/event/eventexception.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - La clase EventException - EventException - - -
- &reftitle.intro; - - Una EventException es lanzada cuando los métodos de extensión de Event - encuentran una entrada de usuario inválida o identifican un error irrecuperable. Esta excepción - sirve como señal para los desarrolladores para manejar situaciones excepcionales de manera elegante. - -
- -
- &reftitle.classsynopsis; - - - - - EventException - - - - extends - RuntimeException - - - &InheritedProperties; - - - - - &InheritedMethods; - - - - - - - - -
-
- -
- diff --git a/reference/event/eventhttp.xml b/reference/event/eventhttp.xml deleted file mode 100644 index 8723d71c60..0000000000 --- a/reference/event/eventhttp.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - La clase EventHttp - EventHttp - - -
- &reftitle.intro; - - Representa el servidor HTTP. - -
- -
- &reftitle.classsynopsis; - - - - - EventHttp - - - - - final - EventHttp - - - - &Methods; - - - -
-
- - &reference.event.entities.eventhttp; - -
- diff --git a/reference/event/eventhttp/accept.xml b/reference/event/eventhttp/accept.xml deleted file mode 100644 index 9ce4145ca8..0000000000 --- a/reference/event/eventhttp/accept.xml +++ /dev/null @@ -1,177 +0,0 @@ - - - - - - - EventHttp::accept - Permite a un servidor HTTP aceptar las conexiones en el - socket o recurso especificado - - - &reftitle.description; - - public - bool - EventHttp::accept - - mixed - socket - - - - Permite a un servidor HTTP aceptar las conexiones en el - socket o recurso especificado. El socket debe estar listo para - aceptar las conexiones. - - - Puede ser llamado varias veces para aceptar las conexiones en - diferentes sockets. - - - - Para enlazar un socket, una conexión listen y una conexión - accept - en el socket en una sola llamada, utilice el método - EventHttp::bind. - EventHttp::accept solo es necesario si un socket - está listo para aceptar las conexiones. - - - - - &reftitle.parameters; - - - - socket - - - - Socket, flujo, o descriptor numérico de fichero representando un socket - listo para aceptar las conexiones. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - Ejemplo con <function>EventHttp::accept</function> - - "127.0.0.1", - 8092 => "127.0.0.2", -]; -$i = 0; - -$socket = array(); - -foreach ($addresses as $port => $ip) { - echo $ip, " ", $port, PHP_EOL; - $socket[$i] = socket_create(AF_INET, SOCK_STREAM, SOL_TCP); - if (!socket_bind($socket[$i], $ip, $port)) { - exit("fallo de socket_bind\n"); - } - socket_listen($socket[$i], 0); - socket_set_nonblock($socket[$i]); - - if (!$http->accept($socket[$i])) { - echo "La aceptación ha fallado\n"; - exit(1); - } - - ++$i; -} - -$http->setCallback("/some-page", function() { - echo "(some-page)\n"; - echo "URI : ", $req->getUri(), PHP_EOL; - $req->sendReply(200, "OK"); - echo "OK\n"; -}); - -$http->setDefaultCallback(function($req) { - echo "URI : ", $req->getUri(), PHP_EOL; - $req->sendReply(200, "OK"); - echo "OK\n"; -}); - -$signal = Event::signal($base, SIGINT, function () use ($base) { - echo "SIGINT recibido. Deteniendo...\n"; - $base->stop(); -}); -$signal->add(); - -$base->dispatch(); -echo "END\n"; - -// No cerramos los sockets, sabiendo que Libevent ya establece -// los flags CLOSE_ON_FREE y CLOSE_ON_EXEC en el descriptor -// de fichero con los sockets. -?> -]]> - - &example.outputs.similar; - - - - - - - &reftitle.seealso; - - - EventHttp::bind - - - - - diff --git a/reference/event/eventhttp/addserveralias.xml b/reference/event/eventhttp/addserveralias.xml deleted file mode 100644 index ffe401c8b1..0000000000 --- a/reference/event/eventhttp/addserveralias.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - - EventHttp::addServerAlias - Añade un alias del servidor para el objeto servidor HTTP - - - &reftitle.description; - - public - bool - EventHttp::addServerAlias - - string - alias - - - - Añade un alias del servidor para el objeto servidor HTTP. - - - - &reftitle.parameters; - - - - alias - - - - El alias a añadir. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - - Ejemplo con <function>EventHttp::addServerAlias</function> - -bind("127.0.0.1", 8088)) { - exit("bind(1) ha fallado\n"); -}; - -if (!$http->addServerAlias("local.net")) { - exit("Imposible añadir el alias del servidor\n"); -} - -$http->setCallback("/about", function($req) { - echo "URI : ", $req->getUri(), PHP_EOL; - $req->sendReply(200, "OK"); -}); -$base->dispatch(); -?> -]]> - - - - - &reftitle.seealso; - - - EventHttp::removeServerAlias - - - - - diff --git a/reference/event/eventhttp/bind.xml b/reference/event/eventhttp/bind.xml deleted file mode 100644 index 793bb1dddd..0000000000 --- a/reference/event/eventhttp/bind.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - - - EventHttp::bind - Liga un servidor HTTP a una dirección y un puerto especificados - - - &reftitle.description; - - public - void - EventHttp::bind - - string - address - - - int - port - - - - Liga un servidor HTTP a una dirección y un puerto especificados. - - - Puede ser llamada varias veces para ligar el mismo servidor HTTP a varios puertos. - - - - &reftitle.parameters; - - - - address - - - - Un string que contiene la dirección IP a escuchar. - - - - - - port - - - - El número de puerto en el que se realizará la escucha. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - Ejemplo con <function>EventHttp::bind</function> - -bind("127.0.0.1", 8088)) { - exit("bind(1) ha fallado\n"); -}; -if (!$http->bind("127.0.0.1", 8089)) { - exit("bind(2) ha fallado\n"); - -}; - -$http->setCallback("/about", function($req) { - echo "URI : ", $req->getUri(), PHP_EOL; - $req->sendReply(200, "OK"); - echo "OK\n"; -}); - -$base->dispatch(); -?> -]]> - - &example.outputs.similar; - -404 Not Found

Not Found

The requested URL /unknown was not found on this server.

- -Servidor: -URI: /about -OK -]]> -
-
-
- - &reftitle.seealso; - - - EventHttp::accept - - - -
- diff --git a/reference/event/eventhttp/construct.xml b/reference/event/eventhttp/construct.xml deleted file mode 100644 index 592e313d2e..0000000000 --- a/reference/event/eventhttp/construct.xml +++ /dev/null @@ -1,250 +0,0 @@ - - - - - - - EventHttp::__construct - Construye un objeto EventHttp (el servidor HTTP) - - - &reftitle.description; - - public - EventHttp::__construct - - EventBase - base - - - EventSslContext - ctx - &null; - - - - Construye el objeto del servidor HTTP. - - - - - &reftitle.parameters; - - - - base - - - - Evento base asociado. - - - - - - ctx - - - - El objeto de la clase EventSslContext. - Transforma un servidor HTTP en un servidor HTTPS. Esto significa que si - el argumento ctx está configurado correctamente, - entonces el buffer de eventos subyacente se basará en sockets OpenSSL. - Asimismo, todo el tráfico pasará a través de SSL o TLS. - - - - Este argumento solo está disponible si Event - ha sido compilado con soporte para OpenSSL, y solo a partir de la - versión Libevent 2.1.0-alpha o superiores. - - - - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL event 1.9.0 - - Añadido soporte para OpenSSL (ctx). - - - - - - - - - &reftitle.examples; - - Servidor HTTP simple - -= $max_requests) { - echo "Counter reached max requests $max_requests. Exiting\n"; - exit(); - } - - echo __METHOD__, " called\n"; - echo "request:"; var_dump($req); - echo "data:"; var_dump($data); - - echo "\n===== DUMP =====\n"; - echo "Command:", $req->getCommand(), PHP_EOL; - echo "URI:", $req->getUri(), PHP_EOL; - echo "Input headers:"; var_dump($req->getInputHeaders()); - echo "Output headers:"; var_dump($req->getOutputHeaders()); - - echo "\n >> Sending reply ..."; - $req->sendReply(200, "OK"); - echo "OK\n"; - - echo "\n >> Reading input buffer ...\n"; - $buf = $req->getInputBuffer(); - while ($s = $buf->readLine(EventBuffer::EOL_ANY)) { - echo $s, PHP_EOL; - } - echo "No more data in the buffer\n"; -} - -function _http_about($req) { - echo __METHOD__, PHP_EOL; - echo "URI: ", $req->getUri(), PHP_EOL; - echo "\n >> Sending reply ..."; - $req->sendReply(200, "OK"); - echo "OK\n"; -} - -function _http_default($req, $data) { - echo __METHOD__, PHP_EOL; - echo "URI: ", $req->getUri(), PHP_EOL; - echo "\n >> Sending reply ..."; - $req->sendReply(200, "OK"); - echo "OK\n"; -} - -$port = 8010; -if ($argc > 1) { - $port = (int) $argv[1]; -} -if ($port <= 0 || $port > 65535) { - exit("Invalid port"); -} - -$base = new EventBase(); -$http = new EventHttp($base); -$http->setAllowedMethods(EventHttpRequest::CMD_GET | EventHttpRequest::CMD_POST); - -$http->setCallback("/dump", "_http_dump", array(4, 8)); -$http->setCallback("/about", "_http_about"); -$http->setDefaultCallback("_http_default", "custom data value"); - -$http->bind("0.0.0.0", 8010); -$base->loop(); -?> -]]> - - &example.outputs.similar; - - - - - - - diff --git a/reference/event/eventhttp/removeserveralias.xml b/reference/event/eventhttp/removeserveralias.xml deleted file mode 100644 index 4cb237bd6a..0000000000 --- a/reference/event/eventhttp/removeserveralias.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - EventHttp::removeServerAlias - Elimina un alias en el servidor - - - &reftitle.description; - - public - bool - EventHttp::removeServerAlias - - string - alias - - - - Elimina un alias en el servidor, previamente añadido con el - método EventHttp::addServerAlias - - - - &reftitle.parameters; - - - - alias - - - - El alias a eliminar. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventHttp::addServerAlias - - - - - diff --git a/reference/event/eventhttp/setallowedmethods.xml b/reference/event/eventhttp/setallowedmethods.xml deleted file mode 100644 index d2901e5f2d..0000000000 --- a/reference/event/eventhttp/setallowedmethods.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - EventHttp::setAllowedMethods - Define los métodos HTTP soportados y aceptados en las peticiones - en este servidor, y pasados a las funciones de retrollamada de los usuarios - - - - &reftitle.description; - - public - void - EventHttp::setAllowedMethods - - int - methods - - - - Define los métodos HTTP soportados y aceptados en las peticiones - en este servidor, y pasados a las funciones de retrollamada de los usuarios. - - - Si no son soportados, generarán una respuesta - "405 Method not allowed". - - - Por omisión, los siguientes métodos están incluidos: - GET, POST, HEAD, - PUT, y DELETE. Ver las constantes - EventHttpRequest::CMD_*. - - - - - &reftitle.parameters; - - - - methods - - - - Una máscara de constantes - EventHttpRequest::CMD_*. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/event/eventhttp/setcallback.xml b/reference/event/eventhttp/setcallback.xml deleted file mode 100644 index 4bbf865a7c..0000000000 --- a/reference/event/eventhttp/setcallback.xml +++ /dev/null @@ -1,249 +0,0 @@ - - - - - - EventHttp::setCallback - Define una retrollamada para una URI específica - - - &reftitle.description; - - public - void - EventHttp::setCallback - - string - path - - - string - cb - - - string - arg - - - - Define una retrollamada para una URI específica. - - - - &reftitle.parameters; - - - - path - - - - La URI para la cual la retrollamada debe ser invocada. - - - - - - cb - - - - La retrollamada callable - que será invocada durante una petición en la URI - path. Debe corresponder al siguiente prototipo: - - - void - callback - - EventHttpRequest - req - NULL - - - mixed - arg - NULL - - - - - - req - - - - Un objeto EventHttpRequest. - - - - - - arg - - - - Datos personalizados. - - - - - - - - - arg - - - - Datos personalizados. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - Ejemplo con <function>EventHttp::setCallback</function> - -= $max_requests) { - echo "Counter reached max requests $max_requests. Exiting\n"; - exit(); - } - - echo __METHOD__, " called\n"; - echo "request:"; var_dump($req); - echo "data:"; var_dump($data); - - echo "\n===== DUMP =====\n"; - echo "Command:", $req->getCommand(), PHP_EOL; - echo "URI:", $req->getUri(), PHP_EOL; - echo "Input headers:"; var_dump($req->getInputHeaders()); - echo "Output headers:"; var_dump($req->getOutputHeaders()); - - echo "\n >> Sending reply ..."; - $req->sendReply(200, "OK"); - echo "OK\n"; - - echo "\n >> Reading input buffer ...\n"; - $buf = $req->getInputBuffer(); - while ($s = $buf->readLine(EventBuffer::EOL_ANY)) { - echo $s, PHP_EOL; - } - echo "No more data in the buffer\n"; -} - -function _http_about($req) { - echo __METHOD__, PHP_EOL; - echo "URI: ", $req->getUri(), PHP_EOL; - echo "\n >> Sending reply ..."; - $req->sendReply(200, "OK"); - echo "OK\n"; -} - -function _http_default($req, $data) { - echo __METHOD__, PHP_EOL; - echo "URI: ", $req->getUri(), PHP_EOL; - echo "\n >> Sending reply ..."; - $req->sendReply(200, "OK"); - echo "OK\n"; -} - -$port = 8010; -if ($argc > 1) { - $port = (int) $argv[1]; -} -if ($port <= 0 || $port > 65535) { - exit("Invalid port"); -} - -$base = new EventBase(); -$http = new EventHttp($base); -$http->setAllowedMethods(EventHttpRequest::CMD_GET | EventHttpRequest::CMD_POST); - -$http->setCallback("/dump", "_http_dump", array(4, 8)); -$http->setCallback("/about", "_http_about"); -$http->setDefaultCallback("_http_default", "custom data value"); - -$http->bind("0.0.0.0", 8010); -$base->loop(); -?> -]]> - - &example.outputs.similar; - - - - - - - &reftitle.seealso; - - - EventHttp::setDefaultCallback - - - - - diff --git a/reference/event/eventhttp/setdefaultcallback.xml b/reference/event/eventhttp/setdefaultcallback.xml deleted file mode 100644 index dccde32202..0000000000 --- a/reference/event/eventhttp/setdefaultcallback.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - EventHttp::setDefaultCallback - Define la función de retrollamada por defecto para manejar las peticiones que no son capturadas por - funciones de retrollamada específicas - - - &reftitle.description; - - public - void - EventHttp::setDefaultCallback - - string - cb - - - string - arg - - - - Define la función de retrollamada por defecto para manejar las peticiones que no son capturadas por - funciones de retrollamada específicas. - - - - &reftitle.parameters; - - - - cb - - - - La función de retrollamada de tipo callable. - Debe corresponder al siguiente prototipo: - - - void - callback - - EventHttpRequest - req - NULL - - - mixed - arg - NULL - - - - - - req - - - - EventHttpRequest - Objeto. - - - - - - arg - - - - Datos personalizados. - - - - - - - - - arg - - - - Datos personalizados proporcionados por el usuario a la función de retrollamada. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - Ejemplo con <function>EventHttp::setDefaultCallback</function> - -bind("127.0.0.1", 8088)) { - exit("Fallo en bind(1)\n"); -}; - -$http->setDefaultCallback(function($req) { - echo "URI : ", $req->getUri(), PHP_EOL; - $req->sendReply(200, "OK"); -}); - -$base->dispatch(); -?> -]]> - - - - - &reftitle.seealso; - - - EventHttp::setCallback - - - - - diff --git a/reference/event/eventhttp/setmaxbodysize.xml b/reference/event/eventhttp/setmaxbodysize.xml deleted file mode 100644 index f06dae2266..0000000000 --- a/reference/event/eventhttp/setmaxbodysize.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - EventHttp::setMaxBodySize - Define la talla máxima del cuerpo de la petición - - - &reftitle.description; - - public - void - EventHttp::setMaxBodySize - - int - value - - - - Define la talla máxima del cuerpo de la petición. - - - - &reftitle.parameters; - - - - value - - - - La talla del cuerpo, en bytes. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventHttp::setMaxHeadersSize - - - - - diff --git a/reference/event/eventhttp/setmaxheaderssize.xml b/reference/event/eventhttp/setmaxheaderssize.xml deleted file mode 100644 index 7b8d30507b..0000000000 --- a/reference/event/eventhttp/setmaxheaderssize.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - EventHttp::setMaxHeadersSize - Define el tamaño máximo de las cabeceras HTTP - - - &reftitle.description; - - public - void - EventHttp::setMaxHeadersSize - - int - value - - - - Define el tamaño máximo de las cabeceras HTTP. - - - - &reftitle.parameters; - - - - value - - - - El tamaño máximo de las cabeceras, en bytes. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventHttp::setMaxHeadersSize - - - - - diff --git a/reference/event/eventhttp/settimeout.xml b/reference/event/eventhttp/settimeout.xml deleted file mode 100644 index ffc4d6f9d7..0000000000 --- a/reference/event/eventhttp/settimeout.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - EventHttp::setTimeout - Define el tiempo máximo de espera para una petición HTTP - - - &reftitle.description; - - public - void - EventHttp::setTimeout - - int - value - - - - Define el tiempo máximo de espera para una petición HTTP. - - - - &reftitle.parameters; - - - - value - - - - El tiempo máximo de espera, en segundos. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/eventhttpconnection.xml b/reference/event/eventhttpconnection.xml deleted file mode 100644 index 9ae6cfb6c4..0000000000 --- a/reference/event/eventhttpconnection.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - La clase EventHttpConnection - EventHttpConnection - - -
- &reftitle.intro; - - Representa una conexión HTTP. - -
- -
- &reftitle.classsynopsis; - - - - - EventHttpConnection - - - - - EventHttpConnection - - - - &Methods; - - - -
-
- - &reference.event.entities.eventhttpconnection; - -
- diff --git a/reference/event/eventhttpconnection/construct.xml b/reference/event/eventhttpconnection/construct.xml deleted file mode 100644 index 9103b0cd74..0000000000 --- a/reference/event/eventhttpconnection/construct.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - - EventHttpConnection::__construct - Construye un objeto EventHttpConnection - - - &reftitle.description; - - public - EventHttpConnection::__construct - - EventBase - base - - - EventDnsBase - dns_base - - - string - address - - - int - port - - - EventSslContext - ctx - &null; - - - - Construye un objeto EventHttpConnection. - - - - &reftitle.parameters; - - - - base - - - - Base de evento asociada. - - - - - - dns_base - - - - Si vale &null;, la resolución del nombre de host será bloqueante. - - - - - - address - - - - La dirección de conexión. - - - - - - port - - - - El puerto de conexión. - - - - - - ctx - - - - El objeto de la clase EventSslContext. - Activa OpenSSL. - - - - Este parámetro solo está disponible si Event - ha sido compilado con soporte OpenSSL, y únicamente con la - versión Libevent 2.1.0-alpha y superiores. - - - - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL event 1.9.0 - - Añadido soporte de OpenSSL (ctx). - - - - - - - - - diff --git a/reference/event/eventhttpconnection/getbase.xml b/reference/event/eventhttpconnection/getbase.xml deleted file mode 100644 index 1cf601885e..0000000000 --- a/reference/event/eventhttpconnection/getbase.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - - EventHttpConnection::getBase - Devuelve la base de eventos asociada con la conexión - - - &reftitle.description; - - public - EventBase - EventHttpConnection::getBase - - - - Devuelve la base de eventos asociada con la conexión. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve el objeto EventBase asociado con - la conexión en caso de éxito, &false; de lo contrario. - - - - diff --git a/reference/event/eventhttpconnection/getpeer.xml b/reference/event/eventhttpconnection/getpeer.xml deleted file mode 100644 index 629e512c3f..0000000000 --- a/reference/event/eventhttpconnection/getpeer.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - EventHttpConnection::getPeer - Recupera la dirección y el puerto remoto asociados con la conexión - - - &reftitle.description; - - public - void - EventHttpConnection::getPeer - - string - address - - - int - port - - - - Recupera la dirección y el puerto remoto asociados con la conexión. - - - - &reftitle.parameters; - - - - address - - - - Dirección del par. - - - - - - port - - - - Puerto del par. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/eventhttpconnection/makerequest.xml b/reference/event/eventhttpconnection/makerequest.xml deleted file mode 100644 index e60271ba56..0000000000 --- a/reference/event/eventhttpconnection/makerequest.xml +++ /dev/null @@ -1,166 +0,0 @@ - - - - - - - EventHttpConnection::makeRequest - Realiza una petición HTTP en la conexión especificada - - - &reftitle.description; - - public - bool - EventHttpConnection::makeRequest - - EventHttpRequest - req - - - int - type - - - string - uri - - - - Realiza una petición HTTP en la conexión especificada. - El parámetro type será una constante - EventHttpRequest::CMD_*. - - - - &reftitle.parameters; - - - - req - - - - El objeto que representa la conexión en la que se enviará la petición. - - - - - - type - - - - Una constante - EventHttpRequest::CMD_*. - - - - - - uri - - - - El URI asociado a la petición. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - - Ejemplo con <function>EventHttpConnection::makeRequest</function> - -getResponseCode(); - - if ($response_code == 0) { - echo "Conexión rechazada\n"; - } elseif ($response_code != 200) { - echo "Respuesta inesperada: $response_code\n"; - } else { - echo "Éxito: $response_code\n"; - $buf = $req->getInputBuffer(); - echo "Cuerpo:\n"; - while ($s = $buf->readLine(EventBuffer::EOL_ANY)) { - echo $s, PHP_EOL; - } - } - } - - $base->exit(NULL); -} - -$address = "127.0.0.1"; -$port = 80; - -$base = new EventBase(); -$conn = new EventHttpConnection($base, NULL, $address, $port); -$conn->setTimeout(5); -$req = new EventHttpRequest("_request_handler", $base); - -$req->addHeader("Host", $address, EventHttpRequest::OUTPUT_HEADER); -$req->addHeader("Content-Length", "0", EventHttpRequest::OUTPUT_HEADER); -$conn->makeRequest($req, EventHttpRequest::CMD_GET, "/index.cphp"); - -$base->loop(); -?> -]]> - - &example.outputs.similar; - - - - - - - &reftitle.seealso; - - - EventHttpRequest::addHeader - - - - - diff --git a/reference/event/eventhttpconnection/setclosecallback.xml b/reference/event/eventhttpconnection/setclosecallback.xml deleted file mode 100644 index 1caf451442..0000000000 --- a/reference/event/eventhttpconnection/setclosecallback.xml +++ /dev/null @@ -1,194 +0,0 @@ - - - - - - - EventHttpConnection::setCloseCallback - Define una función de retrollamada al cerrar la conexión - - - &reftitle.description; - - public - void - EventHttpConnection::setCloseCallback - - callable - callback - - - mixed - data - - - - Define una función de retrollamada al cerrar la conexión. - - - - &reftitle.parameters; - - - - callback - - - - Función de retrollamada a llamar al cerrar la conexión. - Debe corresponder al siguiente prototipo: - - - void - callback - - EventHttpConnection - conn - &null; - - - mixed - arg - &null; - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.examples; - - Ejemplo con <methodname>EventHttpConnection::setCloseCallback</methodname> - - - * - * 3) Terminar la conexión del cliente abruptamente, - * es decir, matar el proceso o simplemente presionar Ctrl-C. - * - * 4) Verificar si el servidor llamó a _close_callback. - * El script debe mostrar la cadena "_close_callback" en la salida estándar. - * - * 5) Verificar si el proceso del servidor no tiene conexiones huérfanas, - * por ejemplo, con la utilidad `lsof`. - */ - -function _close_callback($conn) -{ - echo __FUNCTION__, PHP_EOL; -} - -function _http_default($req, $dummy) -{ - $conn = $req->getConnection(); - $conn->setCloseCallback('_close_callback', NULL); - - /* - Al habilitar Event::READ se protege al servidor contra conexiones no cerradas. - Esta es una peculiaridad de Libevent. La biblioteca deshabilita los eventos Event::READ - en esta conexión, y el servidor no es notificado sobre las conexiones terminadas. - - Por lo tanto, cada vez que el cliente termina la conexión abruptamente, obtenemos una conexión huérfana. Por ejemplo, lo siguiente es parte del comando `lsof -p $PID | grep TCP` - después de que el cliente ha terminado la conexión: - - 57-php 15057 ruslan 6u unix 0xffff8802fb59c780 0t0 125187 socket - 58:php 15057 ruslan 7u IPv4 125189 0t0 TCP *:4242 (LISTEN) - 59:php 15057 ruslan 8u IPv4 124342 0t0 TCP localhost:4242->localhost:37375 (CLOSE_WAIT) - - donde $PID es el ID del proceso. - - El siguiente bloque de código corrige este tipo de conexiones huérfanas. - */ - $bev = $req->getBufferEvent(); - $bev->enable(Event::READ); - - // Debemos liberarlo explícitamente. Ver EventHttpRequest::getConnection - - $bev->free(); // Debemos liberarlo explícitamente - - $req->addHeader( - 'Content-Type', - 'multipart/x-mixed-replace;boundary=boundarydonotcross', - EventHttpRequest::OUTPUT_HEADER - ); - - $buf = new EventBuffer(); - $buf->add(''); - - $req->sendReply(200, "OK"); - $req->sendReplyChunk($buf); -} - -$port = 4242; -if ($argc > 1) { - $port = (int) $argv[1]; -} -if ($port <= 0 || $port > 65535) { - exit("Puerto no válido"); -} - -$base = new EventBase(); -$http = new EventHttp($base); - -$http->setDefaultCallback("_http_default", NULL); -$http->bind("0.0.0.0", $port); -$base->loop(); - -?> -]]> - - - - - diff --git a/reference/event/eventhttpconnection/setlocaladdress.xml b/reference/event/eventhttpconnection/setlocaladdress.xml deleted file mode 100644 index 8b13d473de..0000000000 --- a/reference/event/eventhttpconnection/setlocaladdress.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - EventHttpConnection::setLocalAddress - Define la dirección IP desde la cual se realizan las conexiones HTTP - - - &reftitle.description; - - public - void - EventHttpConnection::setLocalAddress - - string - address - - - - Define la dirección IP desde la cual se realizan las conexiones HTTP. - - - - &reftitle.parameters; - - - - address - - - - La dirección IP desde la cual se realizan las conexiones HTTP. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventHttpConnection::setLocalPort - - - - - diff --git a/reference/event/eventhttpconnection/setlocalport.xml b/reference/event/eventhttpconnection/setlocalport.xml deleted file mode 100644 index ffc7cd01b4..0000000000 --- a/reference/event/eventhttpconnection/setlocalport.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - EventHttpConnection::setLocalPort - Define el puerto local desde el cual se realizan las conexiones - - - &reftitle.description; - - public - void - EventHttpConnection::setLocalPort - - int - port - - - - Define el puerto local desde el cual se realizan las conexiones. - - - - &reftitle.parameters; - - - - port - - - - El número del puerto. - - - - - - - &reftitle.returnvalues; - - - - &reftitle.seealso; - - - EventHttpConnection::setLocalAddress - - - - - diff --git a/reference/event/eventhttpconnection/setmaxbodysize.xml b/reference/event/eventhttpconnection/setmaxbodysize.xml deleted file mode 100644 index b677eb7316..0000000000 --- a/reference/event/eventhttpconnection/setmaxbodysize.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - EventHttpConnection::setMaxBodySize - Define el tamaño máximo del cuerpo para la conexión - - - &reftitle.description; - - public - void - EventHttpConnection::setMaxBodySize - - string - max_size - - - - Define el tamaño máximo del cuerpo para la conexión. - - - - &reftitle.parameters; - - - - max_size - - - - El tamaño máximo del cuerpo, en bytes. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventHttpConnection::setMaxHeadersSize - - - - - diff --git a/reference/event/eventhttpconnection/setmaxheaderssize.xml b/reference/event/eventhttpconnection/setmaxheaderssize.xml deleted file mode 100644 index 413dd2d998..0000000000 --- a/reference/event/eventhttpconnection/setmaxheaderssize.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - EventHttpConnection::setMaxHeadersSize - Define el tamaño máximo de las cabeceras - - - &reftitle.description; - - public - void - EventHttpConnection::setMaxHeadersSize - - string - max_size - - - - Define el tamaño máximo de las cabeceras para la conexión. - - - - &reftitle.parameters; - - - - max_size - - - - El tamaño máximo de las cabeceras, en bytes. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventHttpConnection::setMaxBodySize - - - - - diff --git a/reference/event/eventhttpconnection/setretries.xml b/reference/event/eventhttpconnection/setretries.xml deleted file mode 100644 index 566cdaef3f..0000000000 --- a/reference/event/eventhttpconnection/setretries.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - EventHttpConnection::setRetries - Define el número de intentos para la conexión - - - &reftitle.description; - - public - void - EventHttpConnection::setRetries - - int - retries - - - - Define el número de intentos para la conexión. - - - - &reftitle.parameters; - - - - retries - - - - El número límite de intentos. - -1 significa indefinidamente. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/eventhttpconnection/settimeout.xml b/reference/event/eventhttpconnection/settimeout.xml deleted file mode 100644 index e7f4b39770..0000000000 --- a/reference/event/eventhttpconnection/settimeout.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - EventHttpConnection::setTimeout - Define el tiempo límite máximo para la conexión - - - &reftitle.description; - - public - void - EventHttpConnection::setTimeout - - int - timeout - - - - Define el tiempo límite máximo para la conexión. - - - - &reftitle.parameters; - - - - timeout - - - - El tiempo límite máximo, en segundos. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/eventhttprequest.xml b/reference/event/eventhttprequest.xml deleted file mode 100644 index ff631e14d9..0000000000 --- a/reference/event/eventhttprequest.xml +++ /dev/null @@ -1,246 +0,0 @@ - - - - - - - La clase EventHttpRequest - EventHttpRequest - - -
- &reftitle.intro; - - Representa una petición HTTP. - -
- -
- &reftitle.classsynopsis; - - - - - EventHttpRequest - - - - - EventHttpRequest - - - - &Constants; - - const - int - EventHttpRequest::CMD_GET - 1 - - - const - int - EventHttpRequest::CMD_POST - 2 - - - const - int - EventHttpRequest::CMD_HEAD - 4 - - - const - int - EventHttpRequest::CMD_PUT - 8 - - - const - int - EventHttpRequest::CMD_DELETE - 16 - - - const - int - EventHttpRequest::CMD_OPTIONS - 32 - - - const - int - EventHttpRequest::CMD_TRACE - 64 - - - const - int - EventHttpRequest::CMD_CONNECT - 128 - - - const - int - EventHttpRequest::CMD_PATCH - 256 - - - const - int - EventHttpRequest::INPUT_HEADER - 1 - - - const - int - EventHttpRequest::OUTPUT_HEADER - 2 - - &Methods; - - - -
- -
- &reftitle.constants; - - - - EventHttpRequest::CMD_GET - - - - método GET (comando) - - - - - - EventHttpRequest::CMD_POST - - - - método POST (comando) - - - - - - EventHttpRequest::CMD_HEAD - - - - método HEAD (comando) - - - - - - EventHttpRequest::CMD_PUT - - - - método PUT (comando) - - - - - - EventHttpRequest::CMD_DELETE - - - - comando DELETE (método) - - - - - - EventHttpRequest::CMD_OPTIONS - - - - método OPTIONS (comando) - - - - - - EventHttpRequest::CMD_TRACE - - - - método TRACE (comando) - - - - - - EventHttpRequest::CMD_CONNECT - - - - método CONNECT (comando) - - - - - - EventHttpRequest::CMD_PATCH - - - - método PATCH (comando) - - - - - - EventHttpRequest::INPUT_HEADER - - - - Solicita el tipo de encabezado de entrada. - - - - - - EventHttpRequest::OUTPUT_HEADER - - - - Solicita el tipo de encabezado de salida. - - - - -
- -
- - &reference.event.entities.eventhttprequest; - -
- diff --git a/reference/event/eventhttprequest/addheader.xml b/reference/event/eventhttprequest/addheader.xml deleted file mode 100644 index 6ae5f76554..0000000000 --- a/reference/event/eventhttprequest/addheader.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - EventHttpRequest::addHeader - Añade un encabezado HTTP a los encabezados de la petición - - - &reftitle.description; - - public - bool - EventHttpRequest::addHeader - - string - key - - - string - value - - - int - type - - - - Añade un encabezado HTTP a los encabezados de la petición. - - - - &reftitle.parameters; - - - - key - - - - Nombre del encabezado. - - - - - - value - - - - Valor del encabezado. - - - - - - type - - - - Una de las constantes - - EventHttpRequest::*_HEADER. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventHttpRequest::removeHeader - - - - - - diff --git a/reference/event/eventhttprequest/cancel.xml b/reference/event/eventhttprequest/cancel.xml deleted file mode 100644 index 893a455809..0000000000 --- a/reference/event/eventhttprequest/cancel.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - EventHttpRequest::cancel - Cancela una petición HTTP pendiente - - - &reftitle.description; - - public - void - EventHttpRequest::cancel - - - - Cancela una petición HTTP pendiente. - - - Cancela una petición HTTP entrante. La retrollamada asociada con - esta petición no será ejecutada, y el objeto de la petición, liberado. - Si la petición está en curso de procesamiento, el objeto EventHttpConnection - correspondiente será re-inicializado. - - - Una petición no puede ser cancelada si su retrollamada ya ha sido ejecutada. - Una petición puede ser cancelada desde su retrollamada. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/eventhttprequest/clearheaders.xml b/reference/event/eventhttprequest/clearheaders.xml deleted file mode 100644 index 4a0f183ce1..0000000000 --- a/reference/event/eventhttprequest/clearheaders.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - - EventHttpRequest::clearHeaders - Elimina todos los encabezados de la lista de encabezados de la petición - - - &reftitle.description; - - public - void - EventHttpRequest::clearHeaders - - - - Elimina todos los encabezados de la lista de encabezados de la petición. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventHttpRequest::addHeader - - - - - - diff --git a/reference/event/eventhttprequest/closeconnection.xml b/reference/event/eventhttprequest/closeconnection.xml deleted file mode 100644 index 73b541a000..0000000000 --- a/reference/event/eventhttprequest/closeconnection.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - EventHttpRequest::closeConnection - Cierra las conexiones HTTP asociadas - - - &reftitle.description; - - public - void - EventHttpRequest::closeConnection - - - - Cierra las conexiones HTTP asociadas con la petición. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/event/eventhttprequest/construct.xml b/reference/event/eventhttprequest/construct.xml deleted file mode 100644 index 987d750911..0000000000 --- a/reference/event/eventhttprequest/construct.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - - - EventHttpRequest::__construct - Construye un objeto EventHttpRequest - - - &reftitle.description; - - public - EventHttpRequest::__construct - - callable - callback - - - mixed - data - &null; - - - - Construye un objeto EventHttpRequest. - - - - - &reftitle.parameters; - - - - callback - - - - Función de retrollamada llamada con la ruta solicitada. - Debe corresponder al siguiente prototipo: - - - void - callback - - EventHttpRequest - req - &null; - - - mixed - arg - &null; - - - - - - - data - - - - Datos personalizados del usuario para pasar a - la función de retrollamada. - - - - - - - &reftitle.examples; - - - Ejemplo con <function>EventHttpRequest::__construct</function> - -getResponseCode(); - - if ($response_code == 0) { - echo "Conexión rechazada\n"; - } elseif ($response_code != 200) { - echo "Respuesta inesperada: $response_code\n"; - } else { - echo "Éxito: $response_code\n"; - $buf = $req->getInputBuffer(); - echo "Body:\n"; - while ($s = $buf->readLine(EventBuffer::EOL_ANY)) { - echo $s, PHP_EOL; - } - } - } - - $base->exit(NULL); -} - -$address = "127.0.0.1"; -$port = 80; - -$base = new EventBase(); -$conn = new EventHttpConnection($base, NULL, $address, $port); -$conn->setTimeout(5); -$req = new EventHttpRequest("_request_handler", $base); - -$req->addHeader("Host", $address, EventHttpRequest::OUTPUT_HEADER); -$req->addHeader("Content-Length", "0", EventHttpRequest::OUTPUT_HEADER); -$conn->makeRequest($req, EventHttpRequest::CMD_GET, "/index.cphp"); - -$base->loop(); -?> -]]> - - - - - &reftitle.seealso; - - - EventHttpRequest::cancel - - - EventHttpRequest::addHeader - - - - - diff --git a/reference/event/eventhttprequest/findheader.xml b/reference/event/eventhttprequest/findheader.xml deleted file mode 100644 index a94fcf27c3..0000000000 --- a/reference/event/eventhttprequest/findheader.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - EventHttpRequest::findHeader - Busca el valor de un encabezado - - - &reftitle.description; - - public - void - EventHttpRequest::findHeader - - string - key - - - string - type - - - - Busca el valor de un encabezado. - - - - &reftitle.parameters; - - - - key - - - - El nombre del encabezado. - - - - - - type - - - - Una de las constantes - - EventHttpRequest::*_HEADER. - - - - - - - &reftitle.returnvalues; - - Devuelve &null; si el encabezado no ha sido encontrado. - - - - &reftitle.seealso; - - - EventHttpRequest::addHeader - - - - - - diff --git a/reference/event/eventhttprequest/free.xml b/reference/event/eventhttprequest/free.xml deleted file mode 100644 index 77651e1a4d..0000000000 --- a/reference/event/eventhttprequest/free.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - - EventHttpRequest::free - Libera el objeto y elimina los eventos asociados - - - &reftitle.description; - - public - void - EventHttpRequest::free - - - - Libera el objeto y elimina los eventos asociados. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/event/eventhttprequest/getbufferevent.xml b/reference/event/eventhttprequest/getbufferevent.xml deleted file mode 100644 index 0e5e5c5d33..0000000000 --- a/reference/event/eventhttprequest/getbufferevent.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - EventHttpRequest::getBufferEvent - Devuelve el objeto EventBufferEvent - - - &reftitle.description; - - public - EventBufferEvent - EventHttpRequest::getBufferEvent - - - - Devuelve el objeto EventBufferEvent - que representa el evento de buffer que la conexión utiliza. - - - - El contador de referencia del objeto devuelto será incrementado en uno para - proteger las estructuras internas contra destrucciones prematuras cuando - el método es llamado desde una función de retrollamada. El objeto - EventBufferEvent debe ser liberado explícitamente - a través del método EventBufferEvent::free. - De lo contrario, habrá una fuga de memoria. - - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve un objeto EventBufferEvent. - - - - &reftitle.seealso; - - - EventHttpRequest::getConnection - - - - - diff --git a/reference/event/eventhttprequest/getcommand.xml b/reference/event/eventhttprequest/getcommand.xml deleted file mode 100644 index 26c293b07f..0000000000 --- a/reference/event/eventhttprequest/getcommand.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - - EventHttpRequest::getCommand - Devuelve el comando de la petición (método) - - - &reftitle.description; - - public - void - EventHttpRequest::getCommand - - - - Devuelve el comando de la petición; una de las constantes - - EventHttpRequest::CMD_* - . - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve el comando de la petición; una de las constantes - - EventHttpRequest::CMD_* - . - - - - - diff --git a/reference/event/eventhttprequest/getconnection.xml b/reference/event/eventhttprequest/getconnection.xml deleted file mode 100644 index 07b0dc5a45..0000000000 --- a/reference/event/eventhttprequest/getconnection.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - EventHttpRequest::getConnection - Devuelve un objeto EventHttpConnection - - - &reftitle.description; - - public - EventHttpConnection - EventHttpRequest::closeConnection - - - - Devuelve un objeto EventHttpConnection - que representa una conexión HTTP asociada a la petición. - - - - La API Libevent permite que los objetos de petición HTTP no estén - ligados a una conexión HTTP. Sin embargo, no se puede disociar - EventHttpRequest de - EventHttpConnection. Por lo tanto, se construye - el objeto EventHttpConnection sobre la marcha. - Dado que no se dispone de información sobre el evento de base, - la base DNS, ni sobre la función de retrollamada asociada al cierre - de la conexión, se establecen estos campos como indefinidos. - - - - El método EventHttpRequest::getConnection - es habitualmente útil cuando se debe definir una función de retrollamada - para asociarla al cierre de la conexión. Ver el método - EventHttpConnection::setCloseCallback. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve un objeto EventHttpConnection. - - - - &reftitle.seealso; - - EventHttpConnection::setCloseCallback - EventHttpRequest::getBufferEvent - - - - - diff --git a/reference/event/eventhttprequest/gethost.xml b/reference/event/eventhttprequest/gethost.xml deleted file mode 100644 index a75c5a69b6..0000000000 --- a/reference/event/eventhttprequest/gethost.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - - EventHttpRequest::getHost - Devuelve el host solicitado - - - &reftitle.description; - - public - string - EventHttpRequest::getHost - - - - Devuelve el host solicitado. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve el host solicitado. - - - - &reftitle.seealso; - - - EventHttpRequest::getUri - - - EventHttpRequest::getCommand - - - - - - diff --git a/reference/event/eventhttprequest/getinputbuffer.xml b/reference/event/eventhttprequest/getinputbuffer.xml deleted file mode 100644 index 6578a9259f..0000000000 --- a/reference/event/eventhttprequest/getinputbuffer.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - EventHttpRequest::getInputBuffer - Devuelve el buffer de entrada - - - &reftitle.description; - - public - EventBuffer - EventHttpRequest::getInputBuffer - - - - Devuelve el buffer de entrada. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve el buffer de entrada. - - - - &reftitle.seealso; - - - EventHttpRequest::getOutputBuffer - - - - - diff --git a/reference/event/eventhttprequest/getinputheaders.xml b/reference/event/eventhttprequest/getinputheaders.xml deleted file mode 100644 index 45b6dcf2ab..0000000000 --- a/reference/event/eventhttprequest/getinputheaders.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - EventHttpRequest::getInputHeaders - Devuelve el array asociativo que contiene los encabezados de entrada - - - &reftitle.description; - - public - array - EventHttpRequest::getInputHeaders - - - - Devuelve el array asociativo que contiene los encabezados de entrada. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve el array asociativo que contiene los encabezados de entrada. - - - - &reftitle.seealso; - - - EventHttpRequest::getOutputHeaders - - - - - diff --git a/reference/event/eventhttprequest/getoutputbuffer.xml b/reference/event/eventhttprequest/getoutputbuffer.xml deleted file mode 100644 index a3afcfa43e..0000000000 --- a/reference/event/eventhttprequest/getoutputbuffer.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - EventHttpRequest::getOutputBuffer - Devuelve el buffer de salida de la petición - - - &reftitle.description; - - public - EventBuffer - EventHttpRequest::getOutputBuffer - - - - Devuelve el buffer de salida de la petición. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve el buffer de salida de la petición. - - - - &reftitle.seealso; - - - EventHttpRequest::getInputBuffer - - - - - diff --git a/reference/event/eventhttprequest/getoutputheaders.xml b/reference/event/eventhttprequest/getoutputheaders.xml deleted file mode 100644 index ffed6d4c32..0000000000 --- a/reference/event/eventhttprequest/getoutputheaders.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - EventHttpRequest::getOutputHeaders - Devuelve un array asociativo que contiene los encabezados de salida - - - &reftitle.description; - - public - void - EventHttpRequest::getOutputHeaders - - - - Devuelve un array asociativo que contiene los encabezados de salida. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - - - &reftitle.seealso; - - - EventHttpRequest::getInputHeaders - - - - - diff --git a/reference/event/eventhttprequest/getresponsecode.xml b/reference/event/eventhttprequest/getresponsecode.xml deleted file mode 100644 index 61042c4c91..0000000000 --- a/reference/event/eventhttprequest/getresponsecode.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - EventHttpRequest::getResponseCode - Devuelve el código de la respuesta - - - &reftitle.description; - - public - int - EventHttpRequest::getResponseCode - - - - Devuelve el código de la respuesta. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve el código de la respuesta. - - - - &reftitle.seealso; - - - EventHttpRequest::getCommand - - - EventHttpRequest::getHost - - - EventHttpRequest::getUri - - - - - diff --git a/reference/event/eventhttprequest/geturi.xml b/reference/event/eventhttprequest/geturi.xml deleted file mode 100644 index b84d954777..0000000000 --- a/reference/event/eventhttprequest/geturi.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - EventHttpRequest::getUri - Devuelve el URI de la petición - - - &reftitle.description; - - public - string - EventHttpRequest::getUri - - - - Devuelve el URI de la petición. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve el URI de la petición. - - - - &reftitle.seealso; - - - EventHttpRequest::getCommand - - - EventHttpRequest::getHost - - - EventHttpRequest::getResponseCode - - - - - diff --git a/reference/event/eventhttprequest/removeheader.xml b/reference/event/eventhttprequest/removeheader.xml deleted file mode 100644 index 5f0f608507..0000000000 --- a/reference/event/eventhttprequest/removeheader.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - - EventHttpRequest::removeHeader - Elimina un encabezado HTTP de los encabezados de la petición - - - &reftitle.description; - - public - void - EventHttpRequest::removeHeader - - string - key - - - string - type - - - - Elimina un encabezado HTTP de los encabezados de la petición. - - - - &reftitle.parameters; - - - - key - - - - El nombre del encabezado. - - - - - - type - - - - Una constante EventHttpRequest::*_HEADER. - - - - - - - &reftitle.returnvalues; - - Elimina un encabezado HTTP de los encabezados de la petición. - - - - &reftitle.seealso; - - - EventHttpRequest::addHeader - - - - - diff --git a/reference/event/eventhttprequest/senderror.xml b/reference/event/eventhttprequest/senderror.xml deleted file mode 100644 index 22c13eea20..0000000000 --- a/reference/event/eventhttprequest/senderror.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - - - EventHttpRequest::sendError - Envía un mensaje de error HTML al cliente - - - &reftitle.description; - - public - void - EventHttpRequest::sendError - - int - error - - - string - reason - &null; - - - - Envía un mensaje de error HTML al cliente. - - - - &reftitle.parameters; - - - - error - - - - El código de error HTTP. - - - - - - reason - - - - Una breve explicación del error. Si es &null;, se utilizará el significado estándar del código de error. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.examples; - - Ejemplo con <function>EventHttpRequest::sendError</function> - -sendError(400); -} - -$base = new EventBase(); -$http = new EventHttp($base); - -$http->setCallback("/err400", "_http_400"); - -$http->bind("0.0.0.0", 8010); -$base->loop(); -?> -]]> - - - - - &reftitle.seealso; - - - EventHttpRequest::sendReply - - - - - - diff --git a/reference/event/eventhttprequest/sendreply.xml b/reference/event/eventhttprequest/sendreply.xml deleted file mode 100644 index dd01ed6663..0000000000 --- a/reference/event/eventhttprequest/sendreply.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - - EventHttpRequest::sendReply - Envía una respuesta HTML al cliente - - - &reftitle.description; - - public - void - EventHttpRequest::sendReply - - int - code - - - string - reason - - - EventBuffer - buf - - - - Envía una respuesta HTML al cliente. El cuerpo de la respuesta contiene - los datos del parámetro opcional buf. - - - - &reftitle.parameters; - - - - code - - - - El código de respuesta HTTP a enviar. - - - - - - reason - - - - Un breve mensaje a enviar con el código de respuesta. - - - - - - buf - - - - El cuerpo de la respuesta. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventHttpRequest::sendError - - - EventHttpRequest::sendReplyChunk - - - - - diff --git a/reference/event/eventhttprequest/sendreplychunk.xml b/reference/event/eventhttprequest/sendreplychunk.xml deleted file mode 100644 index 30e2494476..0000000000 --- a/reference/event/eventhttprequest/sendreplychunk.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - EventHttpRequest::sendReplyChunk - Envía otro bloque de datos como parte de un bloque de respuesta entrante - - - &reftitle.description; - - public - void - EventHttpRequest::sendReplyChunk - - EventBuffer - buf - - - - Envía otro bloque de datos como parte de un bloque de respuesta entrante. - Después de la llamada a este método, el parámetro buf - estará vacío. - - - - &reftitle.parameters; - - - - buf - - - - El bloque de datos a enviar como parte de la respuesta. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventHttpRequest::sendReplyStart - - - EventHttpRequest::sendReplyEnd - - - - - diff --git a/reference/event/eventhttprequest/sendreplyend.xml b/reference/event/eventhttprequest/sendreplyend.xml deleted file mode 100644 index 44fcdfb90a..0000000000 --- a/reference/event/eventhttprequest/sendreplyend.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - EventHttpRequest::sendReplyEnd - Completa un bloque de respuesta, liberando la petición - - - &reftitle.description; - - public - void - EventHttpRequest::sendReplyEnd - - - - Completa un bloque de respuesta, liberando la petición. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventHttpRequest::sendReplyStart - - - EventHttpRequest::sendReplyChunk - - - - - diff --git a/reference/event/eventhttprequest/sendreplystart.xml b/reference/event/eventhttprequest/sendreplystart.xml deleted file mode 100644 index 13099c1de8..0000000000 --- a/reference/event/eventhttprequest/sendreplystart.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - EventHttpRequest::sendReplyStart - Inicializa un bloque de respuesta - - - &reftitle.description; - - public - void - EventHttpRequest::sendReplyStart - - int - code - - - string - reason - - - - Inicializa una respuesta que utiliza las cabeceras - Transfer-Encoding - chunked. - - - Esto permite al llamante difundir la respuesta al cliente, y es útil - cuando no todos los datos de la respuesta están inmediatamente - disponibles, o bien al enviar respuestas demasiado voluminosas. - - - El llamante debe proporcionar los bloques de datos con el método - EventHttpRequest::sendReplyChunk y completar - la respuesta llamando al método - EventHttpRequest::sendReplyEnd. - - - - &reftitle.parameters; - - - - code - - - - El código de respuesta HTTP a enviar. - - - - - - reason - - - - Un breve mensaje a enviar con el código de respuesta. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - EventHttpRequest::sendReplyChunk - - - EventHttpRequest::sendReplyEnd - - - - - diff --git a/reference/event/eventlistener.xml b/reference/event/eventlistener.xml deleted file mode 100644 index 7260a528ae..0000000000 --- a/reference/event/eventlistener.xml +++ /dev/null @@ -1,185 +0,0 @@ - - - - - - - La clase EventListener - EventListener - - -
- &reftitle.intro; - - Representa una escucha de conexión. - -
- -
- &reftitle.classsynopsis; - - - - - EventListener - - - - - final - EventListener - - - - &Constants; - - const - int - EventListener::OPT_LEAVE_SOCKETS_BLOCKING - 1 - - - const - int - EventListener::OPT_CLOSE_ON_FREE - 2 - - - const - int - EventListener::OPT_CLOSE_ON_EXEC - 4 - - - const - int - EventListener::OPT_REUSEABLE - 8 - - - const - int - EventListener::OPT_THREADSAFE - 16 - - &Properties; - - public - readonly - int - fd - - &Methods; - - - -
-
- &reftitle.properties; - - - - fd - - - - Descriptor de fichero numérico del socket subyacente - (Añadido en event-1.6.0). - - - - -
- -
- &reftitle.constants; - - - - EventListener::OPT_LEAVE_SOCKETS_BLOCKING - - - - Por omisión, Libevent pone en modo no bloqueante los descriptores - de ficheros o sockets subyacentes. Este flag indica a Libevent que los deje en modo bloqueante. - - - - - - EventListener::OPT_CLOSE_ON_FREE - - - - Si esta opción está definida, la escucha de la conexión cierra su - socket subyacente cuando el objeto EventListener - es liberado. - - - - - - EventListener::OPT_CLOSE_ON_EXEC - - - - Si esta opción está definida, la escucha de la conexión define - el flag de cierre a la ejecución en el socket de escucha subyacente. Ver la documentación de la plataforma - para más información sobre fcntl y - FD_CLOEXEC. - - - - - - EventListener::OPT_REUSEABLE - - - - Por omisión en algunas plataformas, una vez que un socket de escucha - es cerrado, ningún otro socket puede ser ligado al mismo puerto - hasta que cierto tiempo no haya pasado. El hecho de definir - esta opción hace que Libevent marque este socket como reutilizable, - así, una vez cerrado, otro socket puede ser abierto para escuchar - el mismo puerto. - - - - - - EventListener::OPT_THREADSAFE - - - - Bloqueo de la asignación para el escuchador; así, es seguro utilizarlo desde múltiples threads. - - - - -
- -
- - &reference.event.entities.eventlistener; - -
- diff --git a/reference/event/eventlistener/construct.xml b/reference/event/eventlistener/construct.xml deleted file mode 100644 index f3f85ca949..0000000000 --- a/reference/event/eventlistener/construct.xml +++ /dev/null @@ -1,314 +0,0 @@ - - - - - - EventListener::__construct - Crea un nuevo oyente de conexión asociado con la base de eventos - - - &reftitle.description; - - public - EventListener::__construct - - EventBase - base - - - callable - cb - - - mixed - data - - - int - flags - - - int - backlog - - - mixed - target - - - - Crea un nuevo oyente de conexión asociado con la base de eventos. - - - - &reftitle.parameters; - - - - base - - - - Base de eventos asociada. - - - - - - cb - - - - Un callable que será invocado cuando una - nueva conexión sea recibida. - - - - - - data - - - - Datos de usuario personalizados adjuntos al parámetro - cb. - - - - - - flags - - - - Una máscara de constantes - EventListener::OPT_*. Ver las - constantes EventListener. - - - - - - backlog - - - - Controla el número máximo de conexiones en espera que la pila de red - permite esperar en un estado "aún no aceptado"; ver la documentación - de la función listen de su sistema para más - detalles. Si el parámetro backlog es negativo, - Libevent intenta obtener un buen valor para este parámetro; - si es cero, Event asume que la función del sistema listen - ya ha sido llamada en el socket (target). - - - - - - target - - - - Puede ser un string, un recurso de socket, o un flujo asociado con un socket. En el caso de que este parámetro sea un string, será analizado como dirección IP. - Será analizado como socket de dominio UNIX si está prefijado - por 'unix:', por ejemplo, 'unix:/tmp/my.sock'. - - - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL event 1.5.0 - - Se añadió el soporte para sockets de dominio UNIX. - - - - - - - - &reftitle.examples; - - - Ejemplo con <function>EventListener::__construct</function> - -bev->free(); - } - - public function __construct($base, $fd) { - $this->base = $base; - - $this->bev = new EventBufferEvent($base, $fd, EventBufferEvent::OPT_CLOSE_ON_FREE); - - $this->bev->setCallbacks(array($this, "echoReadCallback"), NULL, - array($this, "echoEventCallback"), NULL); - - if (!$this->bev->enable(Event::READ)) { - echo "Imposible habilitar READ\n"; - return; - } - } - - public function echoReadCallback($bev, $ctx) { - // Copia todos los datos desde el buffer de entrada hacia el buffer de salida - - // Variante #1 - $bev->output->addBuffer($bev->input); - - /* Variante #2 */ - /* - $input = $bev->getInput(); - $output = $bev->getOutput(); - $output->addBuffer($input); - */ - } - - public function echoEventCallback($bev, $events, $ctx) { - if ($events & EventBufferEvent::ERROR) { - echo "Error desde bufferevent\n"; - } - - if ($events & (EventBufferEvent::EOF | EventBufferEvent::ERROR)) { - //$bev->free(); - $this->__destruct(); - } - } -} - -class MyListener { - public $base, - $listener, - $socket; - private $conn = array(); - - public function __destruct() { - foreach ($this->conn as &$c) $c = NULL; - } - - public function __construct($port) { - $this->base = new EventBase(); - if (!$this->base) { - echo "Imposible abrir la base del evento"; - exit(1); - } - - // Variante #1 - /* - $this->socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP); - if (!socket_bind($this->socket, '0.0.0.0', $port)) { - echo "Imposible enlazar el socket\n"; - exit(1); - } - $this->listener = new EventListener($this->base, - array($this, "acceptConnCallback"), $this->base, - EventListener::OPT_CLOSE_ON_FREE | EventListener::OPT_REUSEABLE, - -1, $this->socket); - */ - - // Variante #2 - $this->listener = new EventListener($this->base, - array($this, "acceptConnCallback"), $this->base, - EventListener::OPT_CLOSE_ON_FREE | EventListener::OPT_REUSEABLE, -1, - "0.0.0.0:$port"); - - if (!$this->listener) { - echo "No se pudo crear el oyente"; - exit(1); - } - - $this->listener->setErrorCallback(array($this, "accept_error_cb")); - } - - public function dispatch() { - $this->base->dispatch(); - } - - // Esta función de retrollamada es llamada cuando hay datos para leer desde $bev - public function acceptConnCallback($listener, $fd, $address, $ctx) { - // ¡Tenemos una nueva conexión! Se le define un bufferevent. */ - $base = $this->base; - $this->conn[] = new MyListenerConnection($base, $fd); - } - - public function accept_error_cb($listener, $ctx) { - $base = $this->base; - - fprintf(STDERR, "Error recibido %d (%s) en el oyente. " - ."Cerrando.\n", - EventUtil::getLastSocketErrno(), - EventUtil::getLastSocketError()); - - $base->exit(NULL); - } -} - -$port = 9808; - -if ($argc > 1) { - $port = (int) $argv[1]; -} -if ($port <= 0 || $port > 65535) { - exit("Puerto inválido"); -} - -$l = new MyListener($port); -$l->dispatch(); -?> -]]> - - - - - diff --git a/reference/event/eventlistener/disable.xml b/reference/event/eventlistener/disable.xml deleted file mode 100644 index 89053b519f..0000000000 --- a/reference/event/eventlistener/disable.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - EventListener::disable - Desactiva un objeto de escucha de eventos de conexión - - - &reftitle.description; - - public - bool - EventListener::disable - - - - Desactiva un objeto de escucha de eventos de conexión. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventListener::enable - - - - - diff --git a/reference/event/eventlistener/enable.xml b/reference/event/eventlistener/enable.xml deleted file mode 100644 index 49c7633d34..0000000000 --- a/reference/event/eventlistener/enable.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - EventListener::enable - Activa un objeto de escucha de eventos de conexión - - - &reftitle.description; - - public - bool - EventListener::enable - - - - Activa un objeto de escucha de eventos de conexión. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - EventListener::disable - - - - - diff --git a/reference/event/eventlistener/getbase.xml b/reference/event/eventlistener/getbase.xml deleted file mode 100644 index 7d90e9c9b2..0000000000 --- a/reference/event/eventlistener/getbase.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - - EventListener::getBase - Devuelve la base de evento asociada con el escuchador de eventos - - - &reftitle.description; - - public - void - EventListener::getBase - - - - Devuelve la base de evento asociada con el escuchador de eventos. - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - Devuelve la base de evento asociada con el escuchador de eventos. - - - - diff --git a/reference/event/eventlistener/getsocketname.xml b/reference/event/eventlistener/getsocketname.xml deleted file mode 100644 index 101defb2d9..0000000000 --- a/reference/event/eventlistener/getsocketname.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - EventListener::getSocketName - Recupera la dirección actual a la que está ligado el socket de escucha - - - &reftitle.description; - - public - static - bool - EventListener::getSocketName - - string - address - - - mixed - port - - - - Recupera la dirección actual a la que está ligado el socket de escucha. - - - - &reftitle.parameters; - - - - address - - - - Parámetro de salida. La dirección IP según la familia de direcciones del socket. - - - - - - port - - - - Parámetro de salida. El puerto al que está ligado el socket. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/eventlistener/setcallback.xml b/reference/event/eventlistener/setcallback.xml deleted file mode 100644 index 99f782d11d..0000000000 --- a/reference/event/eventlistener/setcallback.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - - EventListener::setCallback - El propósito de setCallback - - - &reftitle.description; - - public - void - EventListener::setCallback - - callable - cb - - - mixed - arg - &null; - - - - Coloca una retrollamada para el evento de conexión, y, opcionalmente, - argumentos para esta retrollamada. - - - - &reftitle.parameters; - - - - cb - - - - La nueva retrollamada para las nuevas conexiones. - Ignorada si vale &null;. - - - Debe corresponder al siguiente prototipo: - - - void - callback - - EventListener - listener - &null; - - - mixed - fd - &null; - - - array - address - &null; - - - mixed - arg - &null; - - - - - - listener - - - - El objeto EventListener. - - - - - - fd - - - - El descriptor de fichero o un recurso asociado a la escucha. - - - - - - address - - - - Array de dos elementos: la dirección IP y el puerto - del servidor. - - - - - - arg - - - - Datos de usuario personalizados adjuntos a la retrollamada. - - - - - - - - - arg - - - - Datos de usuario personalizados adjuntos a la retrollamada. Ignorados si valen &null;. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/event/eventlistener/seterrorcallback.xml b/reference/event/eventlistener/seterrorcallback.xml deleted file mode 100644 index 08523fb631..0000000000 --- a/reference/event/eventlistener/seterrorcallback.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - EventListener::setErrorCallback - Define la función de retrollamada en el evento de error - - - &reftitle.description; - - public - void - EventListener::setErrorCallback - - string - cb - - - - Define la función de retrollamada en el evento de error. - - - - &reftitle.parameters; - - - - cb - - - - La función de retrollamada para el error. Debe corresponder al siguiente prototipo: - - - void - callback - - EventListener - listener - &null; - - - mixed - data - &null; - - - - - - listener - - - - El objeto EventListener. - - - - - - data - - - - Datos personalizados del usuario para asociar a la función de retrollamada. - - - - - - - - - - &reftitle.returnvalues; - - - - &reftitle.seealso; - - - EventListener::setCallback - - - - - diff --git a/reference/event/eventsslcontext.xml b/reference/event/eventsslcontext.xml deleted file mode 100644 index acc5305633..0000000000 --- a/reference/event/eventsslcontext.xml +++ /dev/null @@ -1,412 +0,0 @@ - - - - - - La clase EventSslContext - EventSslContext - - -
- &reftitle.intro; - - Representa la estructura SSL_CTX. - Proporciona métodos y propiedades para configurar el contexto SSL. - -
- -
- &reftitle.classsynopsis; - - - - - EventSslContext - - - - - final - EventSslContext - - - - &Constants; - - const - int - EventSslContext::SSLv2_CLIENT_METHOD - 1 - - - const - int - EventSslContext::SSLv3_CLIENT_METHOD - 2 - - - const - int - EventSslContext::SSLv23_CLIENT_METHOD - 3 - - - const - int - EventSslContext::TLS_CLIENT_METHOD - 4 - - - const - int - EventSslContext::SSLv2_SERVER_METHOD - 5 - - - const - int - EventSslContext::SSLv3_SERVER_METHOD - 6 - - - const - int - EventSslContext::SSLv23_SERVER_METHOD - 7 - - - const - int - EventSslContext::TLS_SERVER_METHOD - 8 - - - const - int - EventSslContext::OPT_LOCAL_CERT - 1 - - - const - int - EventSslContext::OPT_LOCAL_PK - 2 - - - const - int - EventSslContext::OPT_PASSPHRASE - 3 - - - const - int - EventSslContext::OPT_CA_FILE - 4 - - - const - int - EventSslContext::OPT_CA_PATH - 5 - - - const - int - EventSslContext::OPT_ALLOW_SELF_SIGNED - 6 - - - const - int - EventSslContext::OPT_VERIFY_PEER - 7 - - - const - int - EventSslContext::OPT_VERIFY_DEPTH - 8 - - - const - int - EventSslContext::OPT_CIPHERS - 9 - - &Properties; - - public - string - local_cert - - - public - string - local_pk - - &Methods; - - - -
- -
- &reftitle.properties; - - - - local_cert - - - - Ruta hacia el fichero que contiene el certificado en el sistema de ficheros. - Debe ser un fichero codificado PEM que contiene los certificados. - Puede, opcionalmente, contener la cadena del certificado - del emisor. - - - - - - local_pk - - - - Ruta hacia el fichero que contiene la clave privada local. - - - - -
- - -
- &reftitle.constants; - - - - EventSslContext::SSLv2_CLIENT_METHOD - - - - Método cliente SSLv2. Ver la página del manual sobre - SSL_CTX_new(3). - - - - - - EventSslContext::SSLv3_CLIENT_METHOD - - - - Método cliente SSLv3. Ver la página del manual sobre - SSL_CTX_new(3). - - - - - - EventSslContext::SSLv23_CLIENT_METHOD - - - - Método cliente SSLv23. Ver la página del manual sobre - SSL_CTX_new(3). - - - - - - EventSslContext::TLS_CLIENT_METHOD - - - - Método cliente TLS. Ver la página del manual sobre - SSL_CTX_new(3). - - - - - - EventSslContext::SSLv2_SERVER_METHOD - - - - Método servidor SSLv2. Ver la página del manual sobre - SSL_CTX_new(3). - - - - - - EventSslContext::SSLv3_SERVER_METHOD - - - - Método servidor SSLv3. Ver la página del manual sobre - SSL_CTX_new(3). - - - - - - EventSslContext::SSLv23_SERVER_METHOD - - - - Método servidor SSLv23. Ver la página del manual sobre - SSL_CTX_new(3). - - - - - - EventSslContext::TLS_SERVER_METHOD - - - - Método servidor TLS. Ver la página del manual sobre - SSL_CTX_new(3). - - - - - - EventSslContext::OPT_LOCAL_CERT - - - - Clave para un elemento del array que contiene las opciones, utilizado - en el método EventSslContext::__construct. - Las opciones apuntan a la ruta del certificado local. - - - - - - EventSslContext::OPT_LOCAL_PK - - - - Clave para un elemento del array que contiene las opciones, utilizado - en el método EventSslContext::__construct. - Las opciones apuntan a la ruta de la clave privada. - - - - - - EventSslContext::OPT_PASSPHRASE - - - - Clave para un elemento del array que contiene las opciones, utilizado - en el método EventSslContext::__construct. - Representa la contraseña del certificado. - - - - - - EventSslContext::OPT_CA_FILE - - - - Clave para un elemento del array que contiene las opciones, utilizado - en el método EventSslContext::__construct. - Representa la ruta hacia el fichero de la autoridad del certificado. - - - - - - EventSslContext::OPT_CA_PATH - - - - Clave para un elemento del array que contiene las opciones, utilizado - en el método EventSslContext::__construct. - Representa la ruta en la que se debe buscar el fichero - de la autoridad del certificado. - - - - - - EventSslContext::OPT_ALLOW_SELF_SIGNED - - - - Clave para un elemento del array que contiene las opciones, utilizado - en el método EventSslContext::__construct. - Representa una opción que permite los certificados autofirmados. - - - - - - EventSslContext::OPT_VERIFY_PEER - - - - Clave para un elemento del array que contiene las opciones, utilizado - en el método EventSslContext::__construct. - Representa una opción que indica a Event que verifique los pares. - - - - - - EventSslContext::OPT_VERIFY_DEPTH - - - - Clave para un elemento del array que contiene las opciones, utilizado - en el método EventSslContext::__construct. - Representa la profundidad máxima de la verificación de la cadena - del certificado que debe ser permitida para el contexto SSL. - - - - - - EventSslContext::OPT_CIPHERS - - - - Clave para un elemento del array que contiene las opciones, utilizado - en el método EventSslContext::__construct. - Representa la lista de cifrados para el contexto SSL. - - - - -
- -
- - &reference.event.entities.eventsslcontext; - -
- diff --git a/reference/event/eventsslcontext/construct.xml b/reference/event/eventsslcontext/construct.xml deleted file mode 100644 index 42683fef2f..0000000000 --- a/reference/event/eventsslcontext/construct.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - EventSslContext::__construct - Construye un contexto OpenSSL para usar con las clases Event - - - &reftitle.description; - - public - EventSslContext::__construct - - string - method - - - string - options - - - - Crea un contexto SSL que contiene el puntero hacia SSL_CTX - (ver el manual del sistema). - - - - &reftitle.parameters; - - - - method - - - - Una de las constantes - EventSslContext::*_METHOD. - - - - - - options - - - - Un array asociativo de opciones de contexto SSL. - Una de las constantes - EventSslContext::OPT_*. - - - - - - - &reftitle.examples; - - - Ejemplo con <function>EventSslContext::__construct</function> - - $local_cert, - EventSslContext::OPT_LOCAL_PK => $local_pk, - EventSslContext::OPT_PASSPHRASE => "echo server", - EventSslContext::OPT_VERIFY_PEER => true, - EventSslContext::OPT_ALLOW_SELF_SIGNED => false, -)); -?> -]]> - - - - - - diff --git a/reference/event/eventutil.xml b/reference/event/eventutil.xml deleted file mode 100644 index d4ba17cb97..0000000000 --- a/reference/event/eventutil.xml +++ /dev/null @@ -1,485 +0,0 @@ - - - - - - La clase EventUtil - EventUtil - - -
- &reftitle.intro; - - La clase EventUtil es un esqueleto con métodos y constantes adicionales. - -
- -
- &reftitle.classsynopsis; - - - - - EventUtil - - - - - final - EventUtil - - - - &Constants; - - const - int - EventUtil::AF_INET - 2 - - - const - int - EventUtil::AF_INET6 - 10 - - - const - int - EventUtil::AF_UNSPEC - 0 - - - const - int - EventUtil::LIBEVENT_VERSION_NUMBER - 33559808 - - - const - int - EventUtil::SO_DEBUG - 1 - - - const - int - EventUtil::SO_REUSEADDR - 2 - - - const - int - EventUtil::SO_KEEPALIVE - 9 - - - const - int - EventUtil::SO_DONTROUTE - 5 - - - const - int - EventUtil::SO_LINGER - 13 - - - const - int - EventUtil::SO_BROADCAST - 6 - - - const - int - EventUtil::SO_OOBINLINE - 10 - - - const - int - EventUtil::SO_SNDBUF - 7 - - - const - int - EventUtil::SO_RCVBUF - 8 - - - const - int - EventUtil::SO_SNDLOWAT - 19 - - - const - int - EventUtil::SO_RCVLOWAT - 18 - - - const - int - EventUtil::SO_SNDTIMEO - 21 - - - const - int - EventUtil::SO_RCVTIMEO - 20 - - - const - int - EventUtil::SO_TYPE - 3 - - - const - int - EventUtil::SO_ERROR - 4 - - - const - int - EventUtil::SOL_SOCKET - 1 - - - const - int - EventUtil::SOL_TCP - 6 - - - const - int - EventUtil::SOL_UDP - 17 - - - const - int - EventUtil::IPPROTO_IP - 0 - - - const - int - EventUtil::IPPROTO_IPV6 - 41 - - &Methods; - - - -
- -
- &reftitle.constants; - - - - EventUtil::AF_INET - - - - Familia de direcciones IPv4 - - - - - - EventUtil::AF_INET6 - - - - Familia de direcciones IPv6 - - - - - - EventUtil::AF_UNSPEC - - - - Familia de direcciones IP no especificada - - - - - - EventUtil::SO_DEBUG - - - - Opción del socket. Activa la depuración del socket. Solo permitido para - los procesos con la capacidad CAP_NET_ADMIN - o un ID de usuario efectivo de 0. - (Añadido en event-1.6.0.) - - - - - - EventUtil::SO_REUSEADDR - - - - Opción del socket. Indica que las reglas utilizadas en la - validación de direcciones proporcionadas en una llamada a - bind(2) deben permitir la reutilización - de direcciones locales. Ver la página del manual sobre - socket(7). (Añadido en event-1.6.0.) - - - - - - EventUtil::SO_KEEPALIVE - - - - Opción del socket. Activa el envío de mensajes keep-alive en los - sockets de conexión. Espera un entero. Ver la página del manual sobre - socket(7). (Añadido en event-1.6.0.) - - - - - - EventUtil::SO_DONTROUTE - - - - Opción del socket. Ver la página del manual sobre - socket(7). (Añadido en event-1.6.0.) - - - - - - EventUtil::SO_LINGER - - - - Opción del socket. Cuando está activo, una llamada a - close(2) o a shutdown(2) - no devolverá hasta que todos los mensajes de la cola del socket hayan sido enviados, o hasta que se alcance el tiempo máximo de espera del linger. De lo contrario, las llamadas devolverán inmediatamente - y el cierre se realizará en segundo plano. Ver la página del manual sobre - socket(7). (Añadido en event-1.6.0.) - - - - - - EventUtil::SO_BROADCAST - - - - Opción del socket. Indica si la transmisión de mensajes - de broadcast está soportada. Ver la página del manual sobre - socket(7). (Añadido en event-1.6.0.) - - - - - - EventUtil::SO_OOBINLINE - - - - Opción del socket. Ver la página del manual sobre - socket(7). (Añadido en event-1.6.0.) - - - - - - EventUtil::SO_SNDBUF - - - - Opción del socket. Ver la página del manual sobre - socket(7). (Añadido en event-1.6.0.) - - - - - - EventUtil::SO_RCVBUF - - - - Opción del socket. Ver la página del manual sobre - socket(7). (Añadido en event-1.6.0.) - - - - - - EventUtil::SO_SNDLOWAT - - - - Opción del socket. Ver la página del manual sobre - socket(7). (Añadido en event-1.6.0.) - - - - - - EventUtil::SO_RCVLOWAT - - - - Opción del socket. Ver la página del manual sobre - socket(7). (Añadido en event-1.6.0.) - - - - - - EventUtil::SO_SNDTIMEO - - - - Opción del socket. Ver la página del manual sobre - socket(7). (Añadido en event-1.6.0.) - - - - - - EventUtil::SO_RCVTIMEO - - - - Opción del socket. Ver la página del manual sobre - socket(7). (Añadido en event-1.6.0.) - - - - - - EventUtil::SO_TYPE - - - - Opción del socket. Ver la página del manual sobre - socket(7). (Añadido en event-1.6.0.) - - - - - - EventUtil::SO_ERROR - - - - Opción del socket. Ver la página del manual sobre - socket(7). (Añadido en event-1.6.0.) - - - - - - EventUtil::SOL_SOCKET - - - - Opción del socket. Ver la página del manual sobre - socket(7). (Añadido en event-1.6.0.) - - - - - - EventUtil::SOL_TCP - - - - Opción del socket. Ver la página del manual sobre - socket(7). (Añadido en event-1.6.0.) - - - - - - EventUtil::SOL_UDP - - - - Opción del socket. Ver la página del manual sobre - socket(7). (Añadido en event-1.6.0.) - - - - - - EventUtil::IPPROTO_IP - - - - Ver la página del manual sobre socket(7). - (Añadido en event-1.6.0.) - - - - - - EventUtil::IPPROTO_IPV6 - - - - Ver la página del manual sobre socket(7). - (Añadido en event-1.6.0.) - - - - - - EventUtil::LIBEVENT_VERSION_NUMBER - - - - Número de versión de Libevent en el momento en que la extensión Event - fue compilada con la biblioteca. - - - - -
- -
- - &reference.event.entities.eventutil; - -
- diff --git a/reference/event/eventutil/construct.xml b/reference/event/eventutil/construct.xml deleted file mode 100644 index 241d901e9d..0000000000 --- a/reference/event/eventutil/construct.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - - - EventUtil::__construct - El constructor - - - &reftitle.description; - - abstract - public - EventUtil::__construct - - - - EventUtil es un esqueleto. - Asimismo, el constructor es abstracto, y por lo tanto es imposible - crear objetos basados en esta clase. - - - - &reftitle.parameters; - &no.function.parameters; - - - - diff --git a/reference/event/eventutil/getlastsocketerrno.xml b/reference/event/eventutil/getlastsocketerrno.xml deleted file mode 100644 index 579aa14dfd..0000000000 --- a/reference/event/eventutil/getlastsocketerrno.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - EventUtil::getLastSocketErrno - Devuelve el número de error más reciente ocurrido en el socket - - - &reftitle.description; - - public - static - int - EventUtil::getLastSocketErrno - - mixed - socket - &null; - - - - Devuelve el número de error más reciente ocurrido en el socket - (errno). - - - - &reftitle.parameters; - - - - socket - - - - Recurso de socket, flujo o descriptor de fichero de socket. - - - - - - - &reftitle.returnvalues; - - Devuelve el número de error más reciente ocurrido en el socket - (errno). - - - - &reftitle.seealso; - - - EventUtil::getLastSocketError - - - - - diff --git a/reference/event/eventutil/getlastsocketerror.xml b/reference/event/eventutil/getlastsocketerror.xml deleted file mode 100644 index 5d612fbc32..0000000000 --- a/reference/event/eventutil/getlastsocketerror.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - EventUtil::getLastSocketError - Devuelve el error más reciente ocurrido en el socket - - - &reftitle.description; - - public - static - string - EventUtil::getLastSocketError - - mixed - socket - - - - Devuelve el error más reciente ocurrido en el socket. - - - - &reftitle.parameters; - - - - socket - - - - Recurso de socket, flujo, o descriptor de fichero de socket. - - - - - - - &reftitle.returnvalues; - - Devuelve el error más reciente ocurrido en el socket. - - - - &reftitle.seealso; - - - EventUtil::getLastSocketErrno - - - - - diff --git a/reference/event/eventutil/getsocketfd.xml b/reference/event/eventutil/getsocketfd.xml deleted file mode 100644 index 01025e1aaa..0000000000 --- a/reference/event/eventutil/getsocketfd.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - EventUtil::getSocketFd - Devuelve el descriptor de fichero de un socket o de un flujo - - - &reftitle.description; - - public - static - int - EventUtil::getSocketFd - - mixed - socket - - - - Devuelve el descriptor numérico de fichero de un socket - o de un flujo especificado por el parámetro socket, - como lo hace la extensión Event internamente - para todos los métodos que aceptan un socket o un flujo. - - - - &reftitle.parameters; - - - - socket - - - - Socket o flujo. - - - - - - - &reftitle.returnvalues; - - Devuelve el descriptor de fichero numérico en caso de éxito, &false; en caso contrario. - EventUtil::getSocketFd devuelve &false; - en el caso de que el tipo de fichero no haya podido ser reconocido, o bien cuando - el descriptor de fichero asociado con el parámetro socket - no es válido. - - - - - diff --git a/reference/event/eventutil/getsocketname.xml b/reference/event/eventutil/getsocketname.xml deleted file mode 100644 index 2852917ecc..0000000000 --- a/reference/event/eventutil/getsocketname.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - - EventUtil::getSocketName - Recupera la dirección actual ligada al socket - - - &reftitle.description; - - public - static - bool - EventUtil::getSocketName - - mixed - socket - - - string - address - - - mixed - port - - - - Recupera la dirección actual ligada al socket. - - - - &reftitle.parameters; - - - - socket - - - - Recurso de socket, flujo, o descriptor de fichero de socket. - - - - - - address - - - - Parámetro de salida. Dirección IP o la ruta del dominio UNIX del socket, - según la familia de dirección del socket. - - - - - - port - - - - Parámetro de salida. El puerto ligado al socket. No tiene sentido para - los sockets de dominio UNIX. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/event/eventutil/setsocketoption.xml b/reference/event/eventutil/setsocketoption.xml deleted file mode 100644 index d47270fa7b..0000000000 --- a/reference/event/eventutil/setsocketoption.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - EventUtil::setSocketOption - Define las opciones del socket - - - &reftitle.description; - - public - static - bool - EventUtil::setSocketOption - - mixed - socket - - - int - level - - - int - optname - - - mixed - optval - - - - Define las opciones del socket. - - - - &reftitle.parameters; - - - - socket - - - - Recurso de socket, flujo, o descriptor de fichero numérico asociado con el socket. - - - - - - level - - - - Una constante EventUtil::SOL_*. Especifica el nivel del protocolo en el cual residen las opciones. Por ejemplo, para recuperar las opciones a nivel de socket, el parámetro level debe ser establecido al valor EventUtil::SOL_SOCKET. Otros niveles, como TCP, pueden ser utilizados especificando el número del protocolo de ese nivel. Los números de los protocolos pueden ser encontrados utilizando la función getprotobyname. Ver también las constantes EventUtil. - - - - - - optname - - - - Nombre de la opción (tipo). Tiene el mismo significado que el parámetro correspondiente de la función socket_get_option. Ver también las constantes EventUtil. - - - - - - optval - - - - Acepta los mismos valores que el parámetro optval de la función socket_get_option. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - socket_get_option - - - socket_set_option - - - - - diff --git a/reference/event/eventutil/sslrandpoll.xml b/reference/event/eventutil/sslrandpoll.xml deleted file mode 100644 index c5e133d9a5..0000000000 --- a/reference/event/eventutil/sslrandpoll.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - EventUtil::sslRandPoll - Genera la entropía a través de OpenSSL RAND_poll() - - - &reftitle.description; - - public - static - void - EventUtil::sslRandPoll - - - - Genera la entropía a través de OpenSSL RAND_poll() - (ver el manual del sistema). - - - - &reftitle.parameters; - &no.function.parameters; - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/event/examples.xml b/reference/event/examples.xml deleted file mode 100644 index d50b4e544f..0000000000 --- a/reference/event/examples.xml +++ /dev/null @@ -1,1317 +0,0 @@ - - - - - - - &reftitle.examples; - - Cliente HTTP simple - -input; //$bev->getInput(); - - //$pos = $input->search("TTP"); - $pos = $bev->input->search("TTP"); - - while (($n = $bev->input->remove($buf, 1024)) > 0) { - echo $buf; - } -} - -// Función de retrollamada del evento -function eventcb($bev, $events, $base) { - if ($events & EventBufferEvent::CONNECTED) { - echo "Conectado.\n"; - } elseif ($events & (EventBufferEvent::ERROR | EventBufferEvent::EOF)) { - if ($events & EventBufferEvent::ERROR) { - echo "error DNS : ", $bev->getDnsErrorString(), PHP_EOL; - } - - echo "Cierre\n"; - $base->exit(); - exit("¡Hecho!\n"); - } -} - -if ($argc != 3) { - echo <<setCallbacks("readcb", /* writecb */ NULL, "eventcb", $base); -$bev->enable(Event::READ | Event::WRITE); - -$output = $bev->output; //$bev->getOutput(); -if (!$output->add( - "GET {$argv[2]} HTTP/1.0\r\n". - "Host: {$argv[1]}\r\n". - "Connection: Close\r\n\r\n" -)) { - exit("Fallo en la adición de la petición en el buffer de salida\n"); -} - -if (!$bev->connectHost($dns_base, $argv[1], 80, EventUtil::AF_UNSPEC)) { - exit("Conexión imposible al host {$argv[1]}\n"); -} - -$base->dispatch(); -?> -]]> - - &example.outputs.similar; - - -301 Moved -

301 Moved

-The document has moved -here. - -Closing -Done -]]> -
-
- - Cliente HTTP utilizando una resolución DNS asíncrona - -getInput(); - - while (($n = $input->remove($buf, 1024)) > 0) { - echo $buf; - } -} - -// Función de retrollamada del evento -function eventcb($bev, $events, $base) { - if ($events & EventBufferEvent::CONNECTED) { - echo "Conectado.\n"; - } elseif ($events & (EventBufferEvent::ERROR | EventBufferEvent::EOF)) { - if ($events & EventBufferEvent::ERROR) { - echo "Error DNS : ", $bev->getDnsErrorString(), PHP_EOL; - } - - echo "Cierre\n"; - $base->exit(); - exit("¡Hecho!\n"); - } -} - -$base = new EventBase(); - -echo "paso n°1\n"; -$bev = new EventBufferEvent($base, /* use internal socket */ NULL, - EventBufferEvent::OPT_CLOSE_ON_FREE | EventBufferEvent::OPT_DEFER_CALLBACKS); -if (!$bev) { - exit("Fallo en la creación del socket bufferevent\n"); -} - -echo "paso n°2\n"; -$bev->setCallbacks("readcb", /* writecb */ NULL, "eventcb", $base); -$bev->enable(Event::READ | Event::WRITE); - -echo "paso n°3\n"; -// Envío de la petición -$output = $bev->getOutput(); -if (!$output->add( - "GET /index.cphp HTTP/1.0\r\n". - "Connection: Close\r\n\r\n" -)) { - exit("Fallo en la adición de la petición en el buffer de salida\n"); -} - -/* Conexión al host de forma síncrona. -Conocemos la IP, por lo que no se necesita resolución DNS. */ -if (!$bev->connect("127.0.0.1:80")) { - exit("Imposible conectar al host\n"); -} - -// Difunde los eventos pendientes -$base->dispatch(); -?> -]]> - - - - - Servidor de visualización - -bev->free(); - } - - public function __construct($base, $fd) { - $this->base = $base; - - $this->bev = new EventBufferEvent($base, $fd, EventBufferEvent::OPT_CLOSE_ON_FREE); - - $this->bev->setCallbacks(array($this, "echoReadCallback"), NULL, - array($this, "echoEventCallback"), NULL); - - if (!$this->bev->enable(Event::READ)) { - echo "Fallo en la activación de READ\n"; - return; - } - } - - public function echoReadCallback($bev, $ctx) { - // Copia todos los datos desde el buffer de entrada hacia el buffer de salida - - // Variante #1 - $bev->output->addBuffer($bev->input); - - /* Variante #2 */ - /* - $input = $bev->getInput(); - $output = $bev->getOutput(); - $output->addBuffer($input); - */ - } - - public function echoEventCallback($bev, $events, $ctx) { - if ($events & EventBufferEvent::ERROR) { - echo "Error desde bufferevent\n"; - } - - if ($events & (EventBufferEvent::EOF | EventBufferEvent::ERROR)) { - //$bev->free(); - $this->__destruct(); - } - } -} - -class MyListener { - public $base, - $listener, - $socket; - private $conn = array(); - - public function __destruct() { - foreach ($this->conn as &$c) $c = NULL; - } - - public function __construct($port) { - $this->base = new EventBase(); - if (!$this->base) { - echo "Imposible abrir la base del evento"; - exit(1); - } - - // Variante #1 - /* - $this->socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP); - if (!socket_bind($this->socket, '0.0.0.0', $port)) { - echo "Imposible enlazar el socket\n"; - exit(1); - } - $this->listener = new EventListener($this->base, - array($this, "acceptConnCallback"), $this->base, - EventListener::OPT_CLOSE_ON_FREE | EventListener::OPT_REUSEABLE, - -1, $this->socket); - */ - - // Variante #2 - $this->listener = new EventListener($this->base, - array($this, "acceptConnCallback"), $this->base, - EventListener::OPT_CLOSE_ON_FREE | EventListener::OPT_REUSEABLE, -1, - "0.0.0.0:$port"); - - if (!$this->listener) { - echo "Imposible crear el oyente"; - exit(1); - } - - $this->listener->setErrorCallback(array($this, "accept_error_cb")); - } - - public function dispatch() { - $this->base->dispatch(); - } - - // Esta función de retrollamada es llamada cuando hay datos para leer en $bev - public function acceptConnCallback($listener, $fd, $address, $ctx) { - // ¡Tenemos una nueva conexión! Se define un bufferevent para ella. */ - $base = $this->base; - $this->conn[] = new MyListenerConnection($base, $fd); - } - - public function accept_error_cb($listener, $ctx) { - $base = $this->base; - - fprintf(STDERR, "Se recibe un error %d (%s) en el oyente. " - ."Cerrando.\n", - EventUtil::getLastSocketErrno(), - EventUtil::getLastSocketError()); - - $base->exit(NULL); - } -} - -$port = 9808; - -if ($argc > 1) { - $port = (int) $argv[1]; -} -if ($port <= 0 || $port > 65535) { - exit("Puerto inválido"); -} - -$l = new MyListener($port); -$l->dispatch(); -?> -]]> - - - - Servidor de visualización SSL - -port = $port; - $this->ctx = $this->init_ssl(); - if (!$this->ctx) { - exit("Fallo en la creación del contexto SSL\n"); - } - - $this->base = new EventBase(); - if (!$this->base) { - exit("Imposible abrir la base del evento\n"); - } - - $this->listener = new EventListener($this->base, - array($this, "ssl_accept_cb"), $this->ctx, - EventListener::OPT_CLOSE_ON_FREE | EventListener::OPT_REUSEABLE, - -1, "$host:$port"); - if (!$this->listener) { - exit("Imposible crear el oyente\n"); - } - - $this->listener->setErrorCallback(array($this, "accept_error_cb")); - } - function dispatch() { - $this->base->dispatch(); - } - - // Esta función de retrollamada es llamada cuando hay datos para leer en $bev. - function ssl_read_cb($bev, $ctx) { - $in = $bev->input; //$bev->getInput(); - - printf("Recepción de %zu bytes\n", $in->length); - printf("----- datos ----\n"); - printf("%ld:\t%s\n", (int) $in->length, $in->pullup(-1)); - - $bev->writeBuffer($in); - } - - // Esta función de retrollamada es llamada cuando ocurren errores en el oyente de eventos, - // i.e. la conexión se cierra, o ocurre un error - function ssl_event_cb($bev, $events, $ctx) { - if ($events & EventBufferEvent::ERROR) { - // Recupera los errores desde la pila de errores SSL - while ($err = $bev->sslError()) { - fprintf(STDERR, "Error Bufferevent %s.\n", $err); - } - } - - if ($events & (EventBufferEvent::EOF | EventBufferEvent::ERROR)) { - $bev->free(); - } - } - - // Esta función de retrollamada es llamada cuando un cliente acepta una nueva conexión - function ssl_accept_cb($listener, $fd, $address, $ctx) { - // ¡Tenemos una nueva conexión! Se define un bufferevent para ella. - $this->bev = EventBufferEvent::sslSocket($this->base, $fd, $this->ctx, - EventBufferEvent::SSL_ACCEPTING, EventBufferEvent::OPT_CLOSE_ON_FREE); - - if (!$this->bev) { - echo "Fallo en la creación del buffer SSL\n"; - $this->base->exit(NULL); - exit(1); - } - - $this->bev->enable(Event::READ); - $this->bev->setCallbacks(array($this, "ssl_read_cb"), NULL, - array($this, "ssl_event_cb"), NULL); - } - - // Esta función de retrollamada es llamada cuando se falla en definir una nueva conexión para un cliente - function accept_error_cb($listener, $ctx) { - fprintf(STDERR, "Se recibe un error %d (%s) en el oyente. " - ."Cerrando.\n", - EventUtil::getLastSocketErrno(), - EventUtil::getLastSocketError()); - - $this->base->exit(NULL); - } - - // Inicializa las estructuras SSL; crea un EventSslContext - // Opcionalmente, crea certificados autofirmados - function init_ssl() { - // Necesitamos la entropía. De lo contrario, no tiene sentido cifrar. - if (!EventUtil::sslRandPoll()) { - exit("Fallo de EventUtil::sslRandPoll\n"); - } - - $local_cert = __DIR__."/cert.pem"; - $local_pk = __DIR__."/privkey.pem"; - - if (!file_exists($local_cert) || !file_exists($local_pk)) { - echo "Imposible leer $local_cert ni $local_pk archivo. Para generar una clave\n", - "y un certificado autofirmado, ejecute :\n", - " openssl genrsa -out $local_pk 2048\n", - " openssl req -new -key $local_pk -out cert.req\n", - " openssl x509 -req -days 365 -in cert.req -signkey $local_pk -out $local_cert\n"; - - return FALSE; - } - - $ctx = new EventSslContext(EventSslContext::SSLv3_SERVER_METHOD, array ( - EventSslContext::OPT_LOCAL_CERT => $local_cert, - EventSslContext::OPT_LOCAL_PK => $local_pk, - //EventSslContext::OPT_PASSPHRASE => "echo server", - EventSslContext::OPT_VERIFY_PEER => true, - EventSslContext::OPT_ALLOW_SELF_SIGNED => false, - )); - - return $ctx; - } -} - -// Permite el sobrescrito del puerto -$port = 9999; -if ($argc > 1) { - $port = (int) $argv[1]; -} -if ($port <= 0 || $port > 65535) { - exit("Puerto inválido\n"); -} - -$l = new MySslEchoServer($port); -$l->dispatch(); -?> -]]> - - - - Manejador de señal - -base = $base; - } - - function eventSighandler($no, $c) { - echo "Se captura la señal $no\n"; - event_base_loopexit($c->base); - } -} - -$base = event_base_new(); -$c = new MyEventSignal($base); -$no = SIGTERM; -$ev = evsignal_new($base, $no, array($c,'eventSighandler'), $c); - -evsignal_add($ev); - -event_base_loop($base); -?> -]]> - - - - Uso de un bucle libevent para realizar las peticiones de la extensión `eio' - -stop(); -}, $base); - -echo "paso 3\n"; - -$event->add(); - -echo "paso 4\n"; - -$base->dispatch(); - -echo "¡Hecho!\n"; -?> -]]> - - - - Diversos - -avoidMethod("select")) { - echo "El método 'select' ha sido desactivado\n"; -} - -// Crea un event_base asociado a la configuración -$base = new EventBase($cfg); -echo "Método de evento utilizado : ", $base->getMethod(), PHP_EOL; - -echo "Características :\n"; -$features = $base->getFeatures(); -($features & EventConfig::FEATURE_ET) and print "ET - edge-triggered IO\n"; -($features & EventConfig::FEATURE_O1) and print "O1 - O(1) operation for adding/deleting events\n"; -($features & EventConfig::FEATURE_FDS) and print "FDS - arbitrary file descriptor types, and not just sockets\n"; - -// Requiere la característica FDS -if ($cfg->requireFeatures(EventConfig::FEATURE_FDS)) { - echo "La característica FDS es ahora requerida\n"; - - $base = new EventBase($cfg); - ($base->getFeatures() & EventConfig::FEATURE_FDS) - and print "FDS - tipo de descriptor de archivo arbitrario, y no solo los sockets\n"; -} -/* }}} */ - -/* {{{ Base */ -$base = new EventBase(); -$event = new Event($base, STDIN, Event::READ | Event::PERSIST, function ($fd, $events, $arg) { - static $max_iterations = 0; - - if (++$max_iterations >= 5) { - /* se sale después de 5 iteraciones con un tiempo máximo de espera de 2.33 segundos */ - echo "Detención...\n"; - $arg[0]->exit(2.33); - } - - echo fgets($fd); -}, array (&$base)); - -$event->add(); -$base->loop(); -/* Base }}} */ -?> -]]> - - - - Servidor HTTP simple - -= $max_requests) { - echo "El contador ha alcanzado el número máximo de peticiones ($max_requests). ¡Salida!\n"; - exit(); - } - - echo __METHOD__, " llamada\n"; - echo "Petición :"; var_dump($req); - echo "Datos :"; var_dump($data); - - echo "\n===== DUMP =====\n"; - echo "Comando :", $req->getCommand(), PHP_EOL; - echo "URI :", $req->getUri(), PHP_EOL; - echo "Encabezados de entrada :"; var_dump($req->getInputHeaders()); - echo "Encabezados de salida :"; var_dump($req->getOutputHeaders()); - - echo "\n >> Enviando la respuesta ..."; - $req->sendReply(200, "OK"); - echo "OK\n"; - - echo "\n >> Lectura del buffer de entrada ...\n"; - $buf = $req->getInputBuffer(); - while ($s = $buf->readLine(EventBuffer::EOL_ANY)) { - echo $s, PHP_EOL; - } - echo "No hay más datos en el buffer\n"; -} - -function _http_about($req) { - echo __METHOD__, PHP_EOL; - echo "URI : ", $req->getUri(), PHP_EOL; - echo "\n >> Enviando la respuesta ..."; - $req->sendReply(200, "OK"); - echo "OK\n"; -} - -function _http_default($req, $data) { - echo __METHOD__, PHP_EOL; - echo "URI: ", $req->getUri(), PHP_EOL; - echo "\n >> Enviando la respuesta ..."; - $req->sendReply(200, "OK"); - echo "OK\n"; -} - -$port = 8010; -if ($argc > 1) { - $port = (int) $argv[1]; -} -if ($port <= 0 || $port > 65535) { - exit("Puerto inválido"); -} - -$base = new EventBase(); -$http = new EventHttp($base); -$http->setAllowedMethods(EventHttpRequest::CMD_GET | EventHttpRequest::CMD_POST); - -$http->setCallback("/dump", "_http_dump", array(4, 8)); -$http->setCallback("/about", "_http_about"); -$http->setDefaultCallback("_http_default", "valor de datos personalizados"); - -$http->bind("0.0.0.0", 8010); -$base->loop(); -?> -]]> - - &example.outputs.similar; - - - - - - Servidor HTTPS simple - -= $max_requests) { - echo "El contador ha alcanzado el número máximo de peticiones ($max_requests). Salida\n"; - exit(); - } - - echo __METHOD__, " llamada\n"; - echo "Petición :"; var_dump($req); - echo "Datos :"; var_dump($data); - - echo "\n===== DUMP =====\n"; - echo "Comando :", $req->getCommand(), PHP_EOL; - echo "URI :", $req->getUri(), PHP_EOL; - echo "Encabezados de entrada :"; var_dump($req->getInputHeaders()); - echo "Encabezados de salida :"; var_dump($req->getOutputHeaders()); - - echo "\n >> Enviando la respuesta ..."; - $req->sendReply(200, "OK"); - echo "OK\n"; - - $buf = $req->getInputBuffer(); - echo "\n >> Lectura del buffer de entrada (", $buf->length, ") ...\n"; - while ($s = $buf->read(1024)) { - echo $s; - } - echo "\nNo hay más datos en el buffer\n"; -} - -function _http_about($req) { - echo __METHOD__, PHP_EOL; - echo "URI : ", $req->getUri(), PHP_EOL; - echo "\n >> Enviando la respuesta ..."; - $req->sendReply(200, "OK"); - echo "OK\n"; -} - -function _http_default($req, $data) { - echo __METHOD__, PHP_EOL; - echo "URI: ", $req->getUri(), PHP_EOL; - echo "\n >> Enviando la respuesta ..."; - $req->sendReply(200, "OK"); - echo "OK\n"; -} - -function _http_400($req) { - $req->sendError(400); -} - -function _init_ssl() { - $local_cert = __DIR__."/ssl-echo-server/cert.pem"; - $local_pk = __DIR__."/ssl-echo-server/privkey.pem"; - - $ctx = new EventSslContext(EventSslContext::SSLv3_SERVER_METHOD, array ( - EventSslContext::OPT_LOCAL_CERT => $local_cert, - EventSslContext::OPT_LOCAL_PK => $local_pk, - //EventSslContext::OPT_PASSPHRASE => "test", - EventSslContext::OPT_ALLOW_SELF_SIGNED => true, - )); - - return $ctx; -} - -$port = 9999; -if ($argc > 1) { - $port = (int) $argv[1]; -} -if ($port <= 0 || $port > 65535) { - exit("Puerto inválido"); -} -$ip = '0.0.0.0'; - -$base = new EventBase(); -$ctx = _init_ssl(); -$http = new EventHttp($base, $ctx); -$http->setAllowedMethods(EventHttpRequest::CMD_GET | EventHttpRequest::CMD_POST); - -$http->setCallback("/dump", "_http_dump", array(4, 8)); -$http->setCallback("/about", "_http_about"); -$http->setCallback("/err400", "_http_400"); -$http->setDefaultCallback("_http_default", "Valor de los datos personalizados"); - -$http->bind($ip, $port); -$base->dispatch(); -]]> - - - - Conexión OpenSSL - -getResponseCode(); - - if ($response_code == 0) { - echo "Conexión rechazada\n"; - } elseif ($response_code != 200) { - echo "Respuesta inesperada : $response_code\n"; - } else { - echo "Éxito : $response_code\n"; - $buf = $req->getInputBuffer(); - echo "Cuerpo :\n"; - while ($s = $buf->readLine(EventBuffer::EOL_ANY)) { - echo $s, PHP_EOL; - } - } - } - - $base->exit(NULL); -} - -function _init_ssl() { - $ctx = new EventSslContext(EventSslContext::SSLv3_CLIENT_METHOD, array ()); - - return $ctx; -} - -// Permite el sobrescrito del puerto -$port = 9999; -if ($argc > 1) { - $port = (int) $argv[1]; -} -if ($port <= 0 || $port > 65535) { - exit("Puerto inválido\n"); -} -$host = '127.0.0.1'; - -$ctx = _init_ssl(); -if (!$ctx) { - trigger_error("Fallo en la creación del contexto SSL", E_USER_ERROR); -} - -$base = new EventBase(); -if (!$base) { - trigger_error("Fallo en la inicialización de la base de evento", E_USER_ERROR); -} - -$conn = new EventHttpConnection($base, NULL, $host, $port, $ctx); -$conn->setTimeout(50); - -$req = new EventHttpRequest("_request_handler", $base); -$req->addHeader("Host", $host, EventHttpRequest::OUTPUT_HEADER); -$buf = $req->getOutputBuffer(); -$buf->add("HTML TEST"); -//$req->addHeader("Content-Length", $buf->length, EventHttpRequest::OUTPUT_HEADER); -//$req->addHeader("Connection", "close", EventHttpRequest::OUTPUT_HEADER); -$conn->makeRequest($req, EventHttpRequest::CMD_POST, "/dump"); - -$base->dispatch(); -echo "FIN\n"; -?> -]]> - - - - - Ejemplo con <function>EventHttpConnection::makeRequest</function> - -getResponseCode(); - - if ($response_code == 0) { - echo "Conexión rechazada\n"; - } elseif ($response_code != 200) { - echo "Respuesta inesperada : $response_code\n"; - } else { - echo "Éxito : $response_code\n"; - $buf = $req->getInputBuffer(); - echo "Cuerpo :\n"; - while ($s = $buf->readLine(EventBuffer::EOL_ANY)) { - echo $s, PHP_EOL; - } - } - } - - $base->exit(NULL); -} - -$address = "127.0.0.1"; -$port = 80; - -$base = new EventBase(); -$conn = new EventHttpConnection($base, NULL, $address, $port); -$conn->setTimeout(5); -$req = new EventHttpRequest("_request_handler", $base); - -$req->addHeader("Host", $address, EventHttpRequest::OUTPUT_HEADER); -$req->addHeader("Content-Length", "0", EventHttpRequest::OUTPUT_HEADER); -$conn->makeRequest($req, EventHttpRequest::CMD_GET, "/index.cphp"); - -$base->loop(); -?> -]]> - - &example.outputs.similar; - - - - - - Escucha de una conexión basada en un socket de dominio Unix - -bev) { - $this->bev->free(); - } - } - - public function __construct($base, $fd) { - $this->base = $base; - - $this->bev = new EventBufferEvent($base, $fd, EventBufferEvent::OPT_CLOSE_ON_FREE); - - $this->bev->setCallbacks(array($this, "echoReadCallback"), NULL, - array($this, "echoEventCallback"), NULL); - - if (!$this->bev->enable(Event::READ)) { - echo "Fallo en la activación de READ\n"; - return; - } - } - - public function echoReadCallback($bev, $ctx) { - // Copia todos los datos desde el buffer de entrada hacia el buffer de salida - $bev->output->addBuffer($bev->input); - } - - public function echoEventCallback($bev, $events, $ctx) { - if ($events & EventBufferEvent::ERROR) { - echo "Error desde bufferevent\n"; - } - - if ($events & (EventBufferEvent::EOF | EventBufferEvent::ERROR)) { - $bev->free(); - $bev = NULL; - } - } -} - -class MyListener { - public $base, - $listener, - $socket; - private $conn = array(); - - public function __destruct() { - foreach ($this->conn as &$c) $c = NULL; - } - - public function __construct($sock_path) { - $this->base = new EventBase(); - if (!$this->base) { - echo "No se pudo abrir la base de eventos"; - exit(1); - } - - if (file_exists($sock_path)) { - unlink($sock_path); - } - - $this->listener = new EventListener($this->base, - array($this, "acceptConnCallback"), $this->base, - EventListener::OPT_CLOSE_ON_FREE | EventListener::OPT_REUSEABLE, -1, - "unix:$sock_path"); - - if (!$this->listener) { - trigger_error("Imposible crear el oyente", E_USER_ERROR); - } - - $this->listener->setErrorCallback(array($this, "accept_error_cb")); - } - - public function dispatch() { - $this->base->dispatch(); - } - - // Esta función de retrollamada será llamada cuando haya datos para leer en $bev - public function acceptConnCallback($listener, $fd, $address, $ctx) { - // ¡Tenemos una nueva conexión! Se define un bufferevent para ella. */ - $base = $this->base; - $this->conn[] = new MyListenerConnection($base, $fd); - } - - public function accept_error_cb($listener, $ctx) { - $base = $this->base; - - fprintf(STDERR, "Se recibe un error %d (%s) en el oyente. " - ."Cerrando.\n", - EventUtil::getLastSocketErrno(), - EventUtil::getLastSocketError()); - - $base->exit(NULL); - } -} - -if ($argc <= 1) { - exit("La ruta hacia el socket no está proporcionada\n"); -} -$sock_path = $argv[1]; - -$l = new MyListener($sock_path); -$l->dispatch(); -?> -]]> - - - - Ejemplo de servidor SMTP - - - * - * Uso: - * 1) Prepare el certificado cert.pem y la clave privada privkey.pem. - * 2) Inicie el script del servidor - * 3) Abra la conexión TLS, i.e. : - * $ openssl s_client -connect localhost:25 -starttls smtp -crlf - * 4) Comience a probar los comandos listados en el método `cmd` a continuación. - */ - -class Handler { - public $domainName = FALSE; - public $connections = []; - public $buffers = []; - public $maxRead = 256000; - - public function __construct() { - $this->ctx = new EventSslContext(EventSslContext::SSLv3_SERVER_METHOD, [ - EventSslContext::OPT_LOCAL_CERT => 'cert.pem', - EventSslContext::OPT_LOCAL_PK => 'privkey.pem', - //EventSslContext::OPT_PASSPHRASE => '', - EventSslContext::OPT_VERIFY_PEER => false, // cambiar a TRUE con certificados auténticos - EventSslContext::OPT_ALLOW_SELF_SIGNED => true // cambiar a FALSE con certificados auténticos - ]); - - $this->base = new EventBase(); - if (!$this->base) { - exit("Imposible abrir la base del evento\n"); - } - - if (!$this->listener = new EventListener($this->base, - [$this, 'ev_accept'], - $this->ctx, - EventListener::OPT_CLOSE_ON_FREE | EventListener::OPT_REUSEABLE, - -1, - '0.0.0.0:25')) - { - exit("Imposible crear el oyente\n"); - } - - $this->listener->setErrorCallback([$this, 'ev_error']); - $this->base->dispatch(); - } - - public function ev_accept($listener, $fd, $address, $ctx) { - static $id = 0; - $id += 1; - - $this->connections[$id]['clientData'] = ''; - $this->connections[$id]['cnx'] = new EventBufferEvent($this->base, $fd, - EventBufferEvent::OPT_CLOSE_ON_FREE); - - if (!$this->connections[$id]['cnx']) { - echo "Fallo en la creación del buffer\n"; - $this->base->exit(NULL); - exit(1); - } - - $this->connections[$id]['cnx']->setCallbacks([$this, "ev_read"], NULL, - [$this, 'ev_error'], $id); - $this->connections[$id]['cnx']->enable(Event::READ | Event::WRITE); - - $this->ev_write($id, '220 '.$this->domainName." wazzzap?\r\n"); - } - - function ev_error($listener, $ctx) { - $errno = EventUtil::getLastSocketErrno(); - - fprintf(STDERR, "Se recibe el error %d (%s) en el oyente. Detención.\n", - $errno, EventUtil::getLastSocketError()); - - if ($errno != 0) { - $this->base->exit(NULL); - exit(); - } - } - - public function ev_close($id) { - $this->connections[$id]['cnx']->disable(Event::READ | Event::WRITE); - unset($this->connections[$id]); - } - - protected function ev_write($id, $string) { - echo 'S('.$id.'): '.$string; - $this->connections[$id]['cnx']->write($string); - } - - public function ev_read($buffer, $id) { - while($buffer->input->length > 0) { - $this->connections[$id]['clientData'] .= $buffer->input->read($this->maxRead); - $clientDataLen = strlen($this->connections[$id]['clientData']); - - if($this->connections[$id]['clientData'][$clientDataLen-1] == "\n" - && $this->connections[$id]['clientData'][$clientDataLen-2] == "\r") - { - // Elimina los caracteres \r\n al final - $line = substr($this->connections[$id]['clientData'], 0, - strlen($this->connections[$id]['clientData']) - 2); - - $this->connections[$id]['clientData'] = ''; - $this->cmd($buffer, $id, $line); - } - } - } - - protected function cmd($buffer, $id, $line) { - switch ($line) { - case strncmp('EHLO ', $line, 4): - $this->ev_write($id, "250-STARTTLS\r\n"); - $this->ev_write($id, "250 OK ehlo\r\n"); - break; - - case strncmp('HELO ', $line, 4): - $this->ev_write($id, "250-STARTTLS\r\n"); - $this->ev_write($id, "250 OK helo\r\n"); - break; - - case strncmp('QUIT', $line, 3): - $this->ev_write($id, "250 OK quit\r\n"); - $this->ev_close($id); - break; - - case strncmp('STARTTLS', $line, 3): - $this->ev_write($id, "220 Ready to start TLS\r\n"); - $this->connections[$id]['cnx'] = EventBufferEvent::sslFilter($this->base, - $this->connections[$id]['cnx'], $this->ctx, - EventBufferEvent::SSL_ACCEPTING, - EventBufferEvent::OPT_CLOSE_ON_FREE); - $this->connections[$id]['cnx']->setCallbacks([$this, "ev_read"], NULL, [$this, 'ev_error'], $id); - $this->connections[$id]['cnx']->enable(Event::READ | Event::WRITE); - break; - - default: - echo 'Comando desconocido : '.$line."\n"; - break; - } - } -} - -new Handler(); -]]> - - -
- diff --git a/reference/event/setup.xml b/reference/event/setup.xml deleted file mode 100644 index d66249f7cd..0000000000 --- a/reference/event/setup.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - &reftitle.setup; - -
- &reftitle.required; - - Esta extensión requiere la biblioteca - libevent. - La mayoría de las distribuciones modernas proporcionan paquetes - para libevent. - - - Las funcionalidades OpenSSL requieren la biblioteca - OpenSSL. - -
-
- &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;event. - -
-
- diff --git a/reference/expect/book.xml b/reference/expect/book.xml deleted file mode 100644 index 8b52510a9a..0000000000 --- a/reference/expect/book.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - - Expect - - - - &reftitle.intro; - - Esta extensión permite interactuar con procesos mediante PTY. Se recomienda - tener en cuenta la envoltura expect:// - junto con las funciones del sistema - de ficheros, lo cual ofrece una interfaz más sencilla e intuitiva. - - - - - &reference.expect.setup; - &reference.expect.constants; - &reference.expect.examples; - &reference.expect.reference; - - - diff --git a/reference/expect/configure.xml b/reference/expect/configure.xml deleted file mode 100644 index 1d17d45de7..0000000000 --- a/reference/expect/configure.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - -
- &reftitle.install; - - &pecl.moved; - &pecl.info; - &url.pecl.package;expect. - - - Para poder utilizar estas funciones, se debe compilar PHP con soporte para expect - utilizando la opción de configuración - . - - - Los usuarios de Windows deben habilitar php_expect.dll dentro - del fichero &php.ini; para poder utilizar estas funciones. - &pecl.windows.download; - -
- diff --git a/reference/expect/constants.xml b/reference/expect/constants.xml deleted file mode 100644 index 156fc434ed..0000000000 --- a/reference/expect/constants.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - EXP_GLOB - (int) - - - - Indica que el patrón es del tipo glob (tipo Unix). - - - - - - EXP_EXACT - (int) - - - - Indica que el patrón es una cadena exacta. - - - - - - EXP_REGEXP - (int) - - - - Indica que el patrón es un texto de tipo expresión regular. - - - - - - EXP_EOF - (int) - - - - Valor, devuelto por expect_expectl, cada vez que - se alcanza EOF (fin del fichero). - - - - - - EXP_TIMEOUT - (int) - - - - Valor, devuelto por expect_expectl pasados unos determinados - segundos, con el valor especificado en expect.timeout - - - - - - EXP_FULLBUFFER - (int) - - - - Valor, devuelto por expect_expectl si no coincidiera - ningún patrón. - - - - - - - diff --git a/reference/expect/examples.xml b/reference/expect/examples.xml deleted file mode 100644 index aa3741d915..0000000000 --- a/reference/expect/examples.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - &reftitle.examples; -
- Ejemplos de uso de Expect - - Ejemplo de uso de Expect - - Este ejemplo conecta a un host remoto mediante SSH, y muestra el tiempo - que lleva en funcionamiento dicho host con uptime. - - - "password:", 1 => PASSWORD) -); - -switch (expect_expectl ($stream, $cases)) { - case PASSWORD: - fwrite ($stream, "password\n"); - break; - - default: - die ("Error al tratar de conectar con el host remoto\n"); -} - -while ($line = fgets($stream)) { - print $line; -} -fclose ($stream); -?> -]]> - - - - - El siguiente ejemplo conecta con un host remoto, determina si el SO instalado - es de 32 o de 64 bits, y finalmente actualiza el paquete que corresponda. - - - Otro ejemplo de uso de Expect - - -]]> - - -
-
- diff --git a/reference/expect/functions/expect-expectl.xml b/reference/expect/functions/expect-expectl.xml deleted file mode 100644 index a8429a6d24..0000000000 --- a/reference/expect/functions/expect-expectl.xml +++ /dev/null @@ -1,198 +0,0 @@ - - - - - - expect_expectl - Espera a que la salida de un proceso coincida con un patrón, - se supere un determinado periodo de tiempo, o se alcance un EOF - - - - &reftitle.description; - - intexpect_expectl - resourceexpect - arraycases - arraymatch - - - Espera a que la salida de un proceso coincida con un patrón, se supere un determinado - periodo de tiempo, o se alcance un EOF. - - - Si se proporciona el parámetro match, se le asignará el resultado de la - búsqueda. La cadena que coincide se encuentra en match[0]. - Las subcadenas que coincidan (de acuerdo a los paréntesis) con el patrón original se encuentran - en match[1], match[2], y así - hasta match[9] (límite establecido por libexpect). - - - - &reftitle.parameters; - - - expect - - - Flujo de Expect, abierto anteriormente con - expect_popen. - - - - - cases - - - Matriz con casos de expect. Cada caso será un array indexado, tal - como se describe en la siguiente tabla: - - Array de Caso de Expect - - - - Clave de índice - Tipo de valor - Descripción - Es Obligatorio - Valor por omisión - - - - - 0 - string - patrón, que buscará coincidencias en la salida del flujo - sí - - - - 1 - mixto - valor, que devolverá esta función, si coincidiera el patrón - sí - - - - 2 - integer - - tipo de patrón, de entre: - EXP_GLOB, - EXP_EXACT - o - EXP_REGEXP - - no - EXP_GLOB - - - -
-
-
-
-
-
- - &reftitle.returnvalues; - - Devuelve valores asociados con el patrón que coincida. - - - En caso de error esta función devuelve: - EXP_EOF, - EXP_TIMEOUT - o - EXP_FULLBUFFER - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL expect 0.2.1 - - Antes de la versión 0.2.1, en el parámetro match se devolvía el string que - coincidiera, no un array de substrings coincidentes. - - - - - - - - &reftitle.examples; - - Ejemplo de <function>expect_expectl</function> - - -]]> - - - - - &reftitle.seealso; - - expect_popen - - -
- diff --git a/reference/expect/functions/expect-popen.xml b/reference/expect/functions/expect-popen.xml deleted file mode 100644 index 89917f0620..0000000000 --- a/reference/expect/functions/expect-popen.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - expect_popen - Ejecuta comandos por la shell Bourne, y abre el flujo PTY - al proceso - - - &reftitle.description; - - resourceexpect_popen - stringcommand - - - Ejecuta comandos por la shell Bourne, y abre el flujo PTY al proceso. - - - - &reftitle.parameters; - - - command - - - Comando a ejecutar. - - - - - - - &reftitle.returnvalues; - - Devuelve un flujo PTY abierto al stdio, - stdout, y stderr del prceso. - - - En caso de error, devuelve &false;. - - - - &reftitle.examples; - - Ejemplo de <function>expect_popen</function> - - -]]> - - - - - &reftitle.seealso; - - popen - - - - diff --git a/reference/expect/ini.xml b/reference/expect/ini.xml deleted file mode 100644 index bdde270197..0000000000 --- a/reference/expect/ini.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - -
- &reftitle.runtime; - &extension.runtime; - - La extensión Expect se configura mediante opciones del - fichero de configuración &php.ini;. - - &ConfigureOptions; de Expect - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - expect.timeout - "10" - INI_ALL - - - - expect.loguser - "1" - INI_ALL - - - - expect.logfile - "" - INI_ALL - - - - expect.match_max - "" - INI_ALL - - - - -
- &ini.php.constants; -
- - &ini.descriptions.title; - - - - - expect.timeout - int - - - - Tiempo de espera de datos, al usar la función - expect_expectl. - - - El valor en "-1" deshabilita el tiempo de espera. - - - - El valor en "0" provoca que expect_expectl - devuelva el control inmediatamente. - - - - - - - - expect.loguser - bool - - - - Indica si Expect debe enviar alguna salida del proceso creado a la salida estándar. - Dado que normalmente los programas interactivos imprimen en pantalla los datos de entrada, - esto sería suficiente para poder mostrar los dos lados de la conversación. - - - - - - - expect.logfile - string - - - - Nombre del fichero en el que se escribirá la salida del proceso creado. - Si no existiera, se crearía. - - - - Si se establece un valor, se escribe la salida independientemente del - valor de expect.loguser. - - - - - - - - expect.match_max - int - - - - Cambia el tamaño predeterminado (2000 bytes) del buffer utilizado para que coincida - con los asteriscos en el patrón. - - - - - -
- diff --git a/reference/expect/reference.xml b/reference/expect/reference.xml deleted file mode 100644 index 0cbb793cf3..0000000000 --- a/reference/expect/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - &Functions; de Expect -&reference.expect.entities.functions; - - - - - diff --git a/reference/expect/setup.xml b/reference/expect/setup.xml deleted file mode 100644 index fd2f990746..0000000000 --- a/reference/expect/setup.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - &reftitle.setup; - - -
- &reftitle.required; - - Este módulo utiliza las funciones de la biblioteca expect. - Se necesita la versión de libexpect >= 5.43.0. - -
- - - - &reference.expect.configure; - - - - &reference.expect.ini; - - - -
- &reftitle.resources; - - expect_popen devuelve el flujo del PTY usado por - expect_expectl. - -
- - -
- diff --git a/reference/fann/book.xml b/reference/fann/book.xml deleted file mode 100644 index 5aa3a1f44e..0000000000 --- a/reference/fann/book.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - FANN (Fast Artificial Neural Network - Red Neuronal Artificial Rápida) - FANN - - - &reftitle.intro; - - Enlace de PHP para la biblioteca FANN (Fast Artificial Neural Network - Red Neuronal Artificial Rápida), la cual implementa - redes neuronales artificiales multicapa con soporte para redes completa y escasamente conectadas. - Incluye un marco de trabajo para el manejo sencillo de conjuntos de datos de entrenamiento. - Es sencilla de utilizar, es versátil, está bien documentada, y es rápida. - - - - &reference.fann.setup; - &reference.fann.constants; - &reference.fann.examples; - &reference.fann.reference; - &reference.fann.fannconnection; - - - - diff --git a/reference/fann/configure.xml b/reference/fann/configure.xml deleted file mode 100644 index 2a869a3472..0000000000 --- a/reference/fann/configure.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - - -
- &reftitle.install; - - - &pecl.info; - &url.pecl.package;fann - - - -
- - - diff --git a/reference/fann/constants.xml b/reference/fann/constants.xml deleted file mode 100644 index 740d8bb518..0000000000 --- a/reference/fann/constants.xml +++ /dev/null @@ -1,619 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - - Algoritmos de entrenamiento - - - FANN_TRAIN_INCREMENTAL - (int) - - - - Algoritmo de retropropagación estándar, donde los pesos se actualizan después de cada patrón de entrenamiento. - Esto significa que los pesos se actualizan muchas veces durante una única época. Por este motivo, algunos problemas - entrenarán muy rápido con este algoritmo, mientras que problemas más avanzados no entrenarán muy bien. - - - - - - FANN_TRAIN_BATCH - (int) - - - - Algoritmo de retropropagación estándar, donde los pesos se actualizan después de calcular el error cuadrático medio - para el conjunto de entrenamiento completo. Esto significa que los pesos solamente se actualizan una vez durante una época. - Por este motivo, algunos problemas entrenarán más lento con este algoritmo. Aunque debido a que el error - cuadrático medio se calcula más correctamente que en el entrenamiento incremental, algunos probleamas alcanzarán - soluciones mejores con este algoritmo. - - - - - - FANN_TRAIN_RPROP - (int) - - - - Un algoritmo de entrenamiento por lotes más avanzado que alcanza buenos resultados para muchos problemas. El - algoritmo de entrenamiento RPROP es adaptativo, por lo que no emplea learning_rate. Sin embargo, se pueden - establecer otros parámetros para cambiar la manera en que funciona el algoritmo RPROP, aunque solamente se recomienda - para usuarios que sepan cómo funciona el algoritmo de entrenamiento RPROP. El algoritmo de entrenamiento RPROP - está descrito por [Riedmiller y Braun, 1993], aunque el algoritmo real de aprendizaje utilizado aquí es - el algoritmo de entrenamiento iRPROP-, el cual está descrito por [Igel y Husken, 2000], y es una variedad - del algoritmo de entrenamiento RPROP estándar. - - - - - - FANN_TRAIN_QUICKPROP - (int) - - - - Un algoritmo de entrenamiento por lotes más avanzado que alcanza buenos resultados para muchos problemas. - El algoritmo de entrenamiento quickprop emplea el parámetro learning_rate junto con otros parámetros más avanzados, - aunque solamente se recomienda cambiar estos parámetros avanzados a usuarios que sepan cómo funciona - el algoritmo de entrenamiento quickprop. El algoritmo de entrenamiento quickprop está descrito por [Fahlman, 1988]. - - - - - - FANN_TRAIN_SARPROP - (int) - - - - Algoritmo de entrenamiento más avanzado aún. Solamente para la versión 2.2 - - - - - - Funciones de activación - - - FANN_LINEAR - (int) - - - - Función de activación lineal. - - - - - - FANN_THRESHOLD - (int) - - - - Función de activación de umbral. - - - - - - FANN_THRESHOLD_SYMMETRIC - (int) - - - - Función de activación de umbral. - - - - - - FANN_SIGMOID - (int) - - - - Función de activación sigmoide. - - - - - - FANN_SIGMOID_STEPWISE - (int) - - - - Aproximación lineal escalonada a la sigmoide. - - - - - - FANN_SIGMOID_SYMMETRIC - (int) - - - - Función de activación sigmoide simétrica, también conocida como tanh. - - - - - - FANN_SIGMOID_SYMMETRIC_STEPWISE - (int) - - - - Aproximación lineal escalonada a la sigmoide simétrica. - - - - - - FANN_GAUSSIAN - (int) - - - - Función de activación gaussiana. - - - - - - FANN_GAUSSIAN_SYMMETRIC - (int) - - - - Función de activación gaussiana simétrica. - - - - - - FANN_GAUSSIAN_STEPWISE - (int) - - - - Función de activación gaussiana escalonada. - - - - - - FANN_ELLIOT - (int) - - - - Función de activación rápida (igual que la sigmoide) definida por David Elliott. - - - - - - FANN_ELLIOT_SYMMETRIC - (int) - - - - Función de activación rápida (igual que la sigmoide simétrica) definida por David Elliott. - - - - - - FANN_LINEAR_PIECE - (int) - - - - Función de activación lineal acotada. - - - - - - FANN_LINEAR_PIECE_SYMMETRIC - (int) - - - - Función de activación lineal acotada. - - - - - - FANN_SIN_SYMMETRIC - (int) - - - - Función de activación sinusal periódica. - - - - - - FANN_COS_SYMMETRIC - (int) - - - - Función de activación cosinusal periódica. - - - - - - FANN_SIN - (int) - - - - Función de activación sinusal periódica. - - - - - - FANN_COS - (int) - - - - Función de activación cosinusal periódica. - - - - - - Funciones de error utilizadas durante el entrenamiento - - - FANN_ERRORFUNC_LINEAR - (int) - - - - Función de error lineal estándar. - - - - - - FANN_ERRORFUNC_TANH - (int) - - - - Función de erorr tanh, normalmente mejor, aunque puede requerir un índice de aprendizaje menor. Esta función de error - dirige de forma agresiva las salidas que difieren mucho de las deseadas, mientras que no dirige las salidas que únicamente difieren más bien poco. - No se recomienda para el entrenamiento en cascada o incremental. - - - - - - Criterios de parada utilizados durante el entrenamiento - - - FANN_STOPFUNC_MSE - (int) - - - - El criterio de parada el es valor del Error Cuadrático Medio (ECM - MSE por sus siglas en inglés). - - - - - - FANN_STOPFUNC_BIT - (int) - - - - El criterio de parada es el número de bit que fallan. El número de bit significa el número de neuronas de salida - que difieren más del límite de fallo de bit (véanse fann_get_bit_fail_limit y fann_set_bit_fail_limit). Los bit se cuentan - en todos los datos de entrenamiento, por lo que este número puede ser mayor que el número de datos de entrenamiento. - - - - - - Definición de los tipos de redes empleados por <function>fann_get_network_type</function> - - - FANN_NETTYPE_LAYER - (int) - - - - Cada capa únicamente posee conexiones a la siguiente capa. - - - - - - FANN_NETTYPE_SHORTCUT - (int) - - - - Cada capa posee conexiones a todas las capas siguientes. - - - - - - Errores - - - FANN_E_NO_ERROR - (int) - - - - Sin errores. - - - - - - FANN_E_CANT_OPEN_CONFIG_R - (int) - - - - No se puede abrir el fichero de configuración para lectura. - - - - - - FANN_E_CANT_OPEN_CONFIG_W - (int) - - - - No se puede abrir el fichero de configuración para escritura. - - - - - - FANN_E_WRONG_CONFIG_VERSION - (int) - - - - Versión errónea del fichero de configuración. - - - - - - FANN_E_CANT_READ_CONFIG - (int) - - - - Error al leer información del fichero de configuración. - - - - - - FANN_E_CANT_READ_NEURON - (int) - - - - Error al leer información de neuronas desde el fichero de configuración. - - - - - - FANN_E_CANT_READ_CONNECTIONS - (int) - - - - Error al leer conexiones desde el fichero de configuración. - - - - - - FANN_E_WRONG_NUM_CONNECTIONS - (int) - - - - Número de conexiones diferente del esperado. - - - - - - FANN_E_CANT_OPEN_TD_W - (int) - - - - No se puede abrir el fichero de datos de entrenamiento para escritura. - - - - - - FANN_E_CANT_OPEN_TD_R - (int) - - - - No se puede abrir el fichero de datos de entrenamiento para lectura. - - - - - - FANN_E_CANT_READ_TD - (int) - - - - Error al leer datos de entrenamiento desde el fichero. - - - - - - FANN_E_CANT_ALLOCATE_MEM - (int) - - - - No se puede asignar memoria. - - - - - - FANN_E_CANT_TRAIN_ACTIVATION - (int) - - - - No se puede entrenar con la función de activación seleccionada. - - - - - - FANN_E_CANT_USE_ACTIVATION - (int) - - - - No se puede utilizar la función de activación seleccionada. - - - - - - FANN_E_TRAIN_DATA_MISMATCH - (int) - - - - Diferencias irreconciliables entre dos estructuras fann_train_data. - - - - - - FANN_E_CANT_USE_TRAIN_ALG - (int) - - - - No se puede utilizar el algoritmo de entrenamiento seleccionado. - - - - - - FANN_E_TRAIN_DATA_SUBSET - (int) - - - - Intento de tomar un subconjunto que no está dentro del conjunto de entrenamiento. - - - - - - FANN_E_INDEX_OUT_OF_BOUND - (int) - - - - Índice fuera de los límites. - - - - - - FANN_E_SCALE_NOT_PRESENT - (int) - - - - No están presentes los parámetro de escala. - - - - - - FANN_E_INPUT_NO_MATCH - (int) - - - - El número de neuronas de entrada en los datos de la Red Neuronal Artificial (RNA - ANN por sus siglas en inglés) no coinciden. - - - - - - FANN_E_OUTPUT_NO_MATCH - (int) - - - - El número de neuronas de salida en los datos de la Red Neuronal Artificial (RNA - ANN por sus siglas en inglés) no coinciden. - - - - - - - - diff --git a/reference/fann/examples.xml b/reference/fann/examples.xml deleted file mode 100644 index ca0ca465cb..0000000000 --- a/reference/fann/examples.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - &reftitle.examples; -
- Entrenamiento XOR - - Este ejemplo muestra cómo entrenar datos para una función XOR - - Fichero xor.data - - - - - - Entrenamiento sencillo - - -]]> - - - - - Este ejemplo muestra cómo leer y ejecutar datos para una función XOR - - Prueba sencilla - - %f\n", $entrada[0], $entrada[1], $calc_out[0]); -fann_destroy($rna); -?> -]]> - - - -
-
- - diff --git a/reference/fann/fannconnection.xml b/reference/fann/fannconnection.xml deleted file mode 100644 index 942a81aebb..0000000000 --- a/reference/fann/fannconnection.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - - La clase FANNConnection - FANNConnection - - - - -
- &reftitle.intro; - - FANNConnection se emplea para la conexión de redes neuronales. - Los objetos de esta clase se emplean en fann_get_connection_array y fann_set_weight_array. - -
- - -
- &reftitle.classsynopsis; - - - - FANNConnection - - - - - FANNConnection - - - - &Properties; - - public - from_neuron - - - public - to_neuron - - - public - weight - - - - &Methods; - - - - - - - - - -
- - - -
- &reftitle.properties; - - - from_neuron - - La neurona donde empieza la conexión. - - - - to_neuron - - La neurona donde finaliza la conexión. - - - - weight - - El peso de la conexión. - - - -
- - - -
- - &reference.fann.entities.fannconnection; - -
- - diff --git a/reference/fann/fannconnection/construct.xml b/reference/fann/fannconnection/construct.xml deleted file mode 100644 index 607ca1764e..0000000000 --- a/reference/fann/fannconnection/construct.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - FANNConnection::__construct - El constructor de la conexión - - - - &reftitle.description; - - public FANNConnection::__construct - intfrom_neuron - intto_neuron - floatweight - - - Crea una nueva conexión e inicializa sus parámetros. Después de crear la conexión, solamente se puede cambiar el peso. - - - - - &reftitle.parameters; - - - from_neuron - - - El número de posición de la neurona inicial. - - - - - to_neuron - - - El número de posición de la neurona terminal. - - - - - weight - - - El valor del peso de la conexión. - - - - - - - - - diff --git a/reference/fann/fannconnection/getfromneuron.xml b/reference/fann/fannconnection/getfromneuron.xml deleted file mode 100644 index bbf16c6722..0000000000 --- a/reference/fann/fannconnection/getfromneuron.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - FANNConnection::getFromNeuron - Devuelve las posiciones de la neurona inicial - - - - &reftitle.description; - - public intFANNConnection::getFromNeuron - - - - Devuelve las posiciones de la neurona inicial. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Las posiciones de la neurona inicial. - - - - - - - diff --git a/reference/fann/fannconnection/gettoneuron.xml b/reference/fann/fannconnection/gettoneuron.xml deleted file mode 100644 index f6d47f90be..0000000000 --- a/reference/fann/fannconnection/gettoneuron.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - FANNConnection::getToNeuron - Devuelve las posiciones de la neurona terminal - - - - &reftitle.description; - - public intFANNConnection::getToNeuron - - - - Devuelve las posiciones de la neurona terminal. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Las posiciones de la neurona terminal. - - - - - - - diff --git a/reference/fann/fannconnection/getweight.xml b/reference/fann/fannconnection/getweight.xml deleted file mode 100644 index 94fdc41e28..0000000000 --- a/reference/fann/fannconnection/getweight.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - FANNConnection::getWeight - Devuelve el peso de la conexión - - - - &reftitle.description; - - public voidFANNConnection::getWeight - - - - Devuelve el peso de la conexión. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El peso de la conexión. - - - - - - - diff --git a/reference/fann/fannconnection/setweight.xml b/reference/fann/fannconnection/setweight.xml deleted file mode 100644 index 73692a7f88..0000000000 --- a/reference/fann/fannconnection/setweight.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - FANNConnection::setWeight - Establece el peso de la conexión - - - - &reftitle.description; - - public voidFANNConnection::setWeight - floatweight - - - Establece el peso de la conexión. - - - Este método es diferente de fann_set_weight. No - actualiza el valor del peso de la red. El valor de la red se actualiza solamente - después de llamar a fann_set_weight_array. - - - - - &reftitle.parameters; - - - - weight - - - El peso de la conexión. - - - - - - - - - &reftitle.returnvalues; - &fann.return.void; - - - - - - diff --git a/reference/fann/functions/fann-cascadetrain-on-data.xml b/reference/fann/functions/fann-cascadetrain-on-data.xml deleted file mode 100644 index 4ab218691e..0000000000 --- a/reference/fann/functions/fann-cascadetrain-on-data.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - - fann_cascadetrain_on_data - Entrena un conjunto de datos completo, por un período de tiempo utilizando el algoritmo de entrenamiento Cascade2 - - - - &reftitle.description; - - boolfann_cascadetrain_on_data - resourceann - resourcedata - intmax_neurons - intneurons_between_reports - floatdesired_error - - - La fracción de cambio de salida en cascada es un número entre 0 y 1 que determina lo grande que debería - ser el cambio del valor de una fracción de fann_get_MSE en fann_get_cascade_output_stagnation_epochs - durante el entrenamiento de las conexiones de salida, para que el entrenamiento no se estanque. Si el entrenamiento se estanca, - el entrenamiento de las conexiones de salida finalizará y se prepararán nuevas candidatas. - - - Este entrenamiento emplea los parámetros establecidos en las funciones fann_set_cascade_..., aunque también emplea otro algoritmo de entrenamiento - debido a su algoritmo de entrenamiento interno. Este algoritmo se puede establecer a FANN_TRAIN_RPROP o - FANN_TRAIN_QUICKPROP mediante fann_set_training_algorithm, y los parámetros - establecidos para estos algoritmos de entrenamiento también afectarán al entrenamiento en cascada. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - data - - &fann.train.description; - - - - max_neurons - - - El número máximo de neuronas a añadir a la red neuronal. - - - - - neurons_between_reports - - - El número de neuronas entre impresiones de informes de estado. Un valor de cero significa que no deberían imprimirse informes. - - - - - desired_error - - - El fann_get_MSE o fann_get_bit_fail deseados, - dependiendo de la función de parada elegida mediante fann_set_train_stop_function. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_train_on_data - fann_cascadetrain_on_file - - - - - - - - diff --git a/reference/fann/functions/fann-cascadetrain-on-file.xml b/reference/fann/functions/fann-cascadetrain-on-file.xml deleted file mode 100644 index 52c569a2d9..0000000000 --- a/reference/fann/functions/fann-cascadetrain-on-file.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - fann_cascadetrain_on_file - Entrena una red neuronal sobre un conjunto completo de datos durante un período de tiempo utilizando el algoritmo de entrenamiento Cascade2 - - - - &reftitle.description; - - boolfann_cascadetrain_on_file - resourceann - stringfilename - intmax_neurons - intneurons_between_reports - floatdesired_error - - - Realiza la misma operación que fann_cascadetrain_on_data, pero lee los datos de entrenamiento directamente desde un fichero. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - filename - - - Un fichero que contiene los datos para el entrenamiento. - - - - - max_neurons - - - El número máximo de neuronas a añadir a la red neuronal. - - - - - neurons_between_reports - - - El número de neuronas entre la impresión de un informe de estado. Un valor de cero indica que no debe mostrarse ningún informe. - - - - - desired_error - - - La fann_get_MSE o fann_get_bit_fail deseada, - según la función de parada seleccionada por fann_set_train_stop_function. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_train_on_data - fann_cascadetrain_on_data - - - - - - - diff --git a/reference/fann/functions/fann-clear-scaling-params.xml b/reference/fann/functions/fann-clear-scaling-params.xml deleted file mode 100644 index 6fba78e3bb..0000000000 --- a/reference/fann/functions/fann-clear-scaling-params.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - fann_clear_scaling_params - Limpia los parámetros de escala - - - - &reftitle.description; - - boolfann_clear_scaling_params - resourceann - - - Limpia los parámetros de escala. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - - diff --git a/reference/fann/functions/fann-copy.xml b/reference/fann/functions/fann-copy.xml deleted file mode 100644 index 3054f8820a..0000000000 --- a/reference/fann/functions/fann-copy.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - fann_copy - Crea una copia de una estructura fann - - - - &reftitle.description; - - resourcefann_copy - resourceann - - - Crea una copia de una estructura fann. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Devuelve una copia de un recurso de red neuronal en caso de éxito, o &false; en caso de error. - - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_test - - - - - - - diff --git a/reference/fann/functions/fann-create-from-file.xml b/reference/fann/functions/fann-create-from-file.xml deleted file mode 100644 index 504ca17e4c..0000000000 --- a/reference/fann/functions/fann-create-from-file.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - fann_create_from_file - Construye una red neuronal de retropropagación desde un fichero de configuración - - - - &reftitle.description; - - resourcefann_create_from_file - stringconfiguration_file - - - Construye una red neuronal de retropropagación desde un fichero de configuración, el cual ha sido guardado mediante fann_save. - - - - - &reftitle.parameters; - - - configuration_file - - - La ruta al fichero de configuración. - - - - - - - - &reftitle.returnvalues; - &fann.return.ann; - - - - &reftitle.seealso; - - - fann_save - - - - - - - - diff --git a/reference/fann/functions/fann-create-shortcut-array.xml b/reference/fann/functions/fann-create-shortcut-array.xml deleted file mode 100644 index c738be6a30..0000000000 --- a/reference/fann/functions/fann-create-shortcut-array.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - fann_create_shortcut_array - Crea una red neuronal de retropropagación estándar que no está completamente conectada y que posee conexiones de atajo - - - - &reftitle.description; - - resourcefann_create_shortcut_array - intnum_layers - arraylayers - - - Crea una red neuronal de retropropagación estándar que no está completamente conectada y que tiene conexiones de atajo, empleando un array con tamaños de capas. - - - - - &reftitle.parameters; - - - num_layers - - - El número total de capas incluyendo la capa de entrada y de salida. - - - - - layers - - - Un array con los tamaños de las capas. - - - - - - - - &reftitle.returnvalues; - - Devuelve un recurso de red neuronal en caso de éxito, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_create_shortcut - fann_create_sparse - fann_create_standard - - - - - - - diff --git a/reference/fann/functions/fann-create-shortcut.xml b/reference/fann/functions/fann-create-shortcut.xml deleted file mode 100644 index def15ec72b..0000000000 --- a/reference/fann/functions/fann-create-shortcut.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - fann_create_shortcut - Crea una red neuronal de retropropagación estándar que no está completamente conectada y que posee conexiones de atajo - - - - &reftitle.description; - - resourcefann_create_shortcut - intnum_layers - intnum_neurons1 - intnum_neurons2 - intnum_neuronsN - - - Crea una red neuronal de retropropagación estándar que no está completamente conectada y que también posee conexiones de atajo. - - - Las conexiones de atajo son conexiones que saltan capas. Una red completamente conectada con conexiones de atajo es una red - donde todas las neuronas están conectadas a todas las neuronas de capas posteriores, incluyendo conexiones directas entre la capa de entrada y la de salida. - - - - - &reftitle.parameters; - - - num_layers - - - El número total de capas incluyendo la capa de entrada y de salida. - - - - - num_neurons1 - - - El número de neuronas de la primera capa. - - - - - num_neurons2 - - - El número de neuronas de la segunda capa. - - - - - num_neuronsN - - - El número de neuronas de la otras capas. - - - - - - - - &reftitle.returnvalues; - - Devuelve un recurso de red neuronal en caso de éxito, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_create_shortcut_array - fann_create_sparse - fann_create_standard - - - - - - - diff --git a/reference/fann/functions/fann-create-sparse-array.xml b/reference/fann/functions/fann-create-sparse-array.xml deleted file mode 100644 index e1e98f4401..0000000000 --- a/reference/fann/functions/fann-create-sparse-array.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - fann_create_sparse_array - Crea una red neuronal de retropropagación estándar que no está completamente conectada empleando un array con tamaños de capas - - - - &reftitle.description; - - resourcefann_create_sparse_array - floatconnection_rate - intnum_layers - arraylayers - - - Crea una red neuronal de retropropagación estándar que no está completamente conectada empleando un array con tamaños de capas - - - - - &reftitle.parameters; - - - connection_rate - - - El índice de conexión controla cuántas conexiones habrá en la red. Si el índice de conexión - está establecido a 1, la red estará completamente conectada, aunque si está establecida a 0.5, solamente se establecerán - la mitad de las conexiones. Un índice de conexión de 1 generará el mismo resultado que fann_create_standard. - - - - - num_layers - - - El número total de capas incluyendo la capa de entrada y de salida. - - - - - layers - - - Un array con los tamaños de las capas. - - - - - - - - &reftitle.returnvalues; - - Devuelve un recurso de red neuronal en caso de éxito, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_create_sparse - fann_create_standard - fann_create_shortcut - - - - - - - diff --git a/reference/fann/functions/fann-create-sparse.xml b/reference/fann/functions/fann-create-sparse.xml deleted file mode 100644 index 246f344aab..0000000000 --- a/reference/fann/functions/fann-create-sparse.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - fann_create_sparse - Crea una red neuronal de retropropagación estándar que no está conectada completamente - - - - &reftitle.description; - - resourcefann_create_sparse - floatconnection_rate - intnum_layers - intnum_neurons1 - intnum_neurons2 - intnum_neuronsN - - - Crea una red neuronal de retropropagación estándar que no está conectada completamente. - - - - - &reftitle.parameters; - - - connection_rate - - - El índice de conexión controla cuántas conexiones habrá en la red. Si el índice de conexión - está establecido a 1, la red estará completamente conectada, aunque si está establecida a 0.5, solamente se establecerán - la mitad de las conexiones. Un índice de conexión de 1 generará el mismo resultado que fann_create_standard. - - - - - num_layers - - - El número total de capas incluyendo la capa de entrada y de salida. - - - - - num_neurons1 - - - El número de neuronas de la primera capa. - - - - - num_neurons2 - - - El número de neuronas de la segunda capa. - - - - - num_neuronsN - - - El número de neuronas de la otras capas. - - - - - - - - &reftitle.returnvalues; - - Devuelve un recurso de red neuronal en caso de éxito, o &false; en caso de error. - - - - - - &reftitle.seealso; - - - fann_create_sparse_array - fann_create_standard - fann_create_shortcut - - - - - - - diff --git a/reference/fann/functions/fann-create-standard-array.xml b/reference/fann/functions/fann-create-standard-array.xml deleted file mode 100644 index 7113c5d02a..0000000000 --- a/reference/fann/functions/fann-create-standard-array.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - - fann_create_standard_array - Crea una red neuronal de retropropagación estándar completamente conectada empleando un array con tamaños de capas - - - - &reftitle.description; - - resourcefann_create_standard_array - intnum_layers - arraylayers - - - Crea una red neuronal de retropropagación estándar completamente conectada. - - - Habrá una neurona de tendencia en cada capa (excepto en la de salida), - y dicha neurona estará conectada a todas las neuronas de la siguiente capa. - Al ejecutar la red, los nodos de tendencia siempre emiten 1. - - - Para destruir una red neuronal, utilice la función fann_destroy. - - - - - &reftitle.parameters; - - - num_layers - - - El número total de capas incluyendo la capa de entrada y de salida. - - - - - layers - - - Un array con los tamaños de las capas. - - - - - - - - &reftitle.returnvalues; - - Devuelve un recurso de red neuronal en caso de éxito, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_create_standard - fann_create_sparse - fann_create_shortcut - - - - - - - diff --git a/reference/fann/functions/fann-create-standard.xml b/reference/fann/functions/fann-create-standard.xml deleted file mode 100644 index 2e1893d48d..0000000000 --- a/reference/fann/functions/fann-create-standard.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - - fann_create_standard - Crea una red neuronal de retropropagación estándar completamente conectada - - - - &reftitle.description; - - resourcefann_create_standard - intnum_layers - intnum_neurons1 - intnum_neurons2 - intnum_neuronsN - - - Crea una red neuronal de retropropagación estándar completamente conectada. - - - Habrá una neurona de tendencia en cada capa (excepto en la de salida), - y dicha neurona estará conectada a todas las neuronas de la siguiente capa. - Al ejecutar la red, los nodos de tendencia siempre emiten 1. - - - Para destruir una red neuronal, utilice la función fann_destroy. - - - - - &reftitle.parameters; - - - num_layers - - - El número total de capas incluyendo la capa de entrada y de salida. - - - - - num_neurons1 - - - El número de neuronas de la primera capa. - - - - - num_neurons2 - - - El número de neuronas de la segunda capa. - - - - - num_neuronsN - - - El número de neuronas de la otras capas. - - - - - - - - &reftitle.returnvalues; - - Devuelve un recurso de red neuronal en caso de éxito, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_create_standard_array - fann_create_sparse - fann_create_shortcut - - - - - - - diff --git a/reference/fann/functions/fann-create-train-from-callback.xml b/reference/fann/functions/fann-create-train-from-callback.xml deleted file mode 100644 index e5c7fd18d7..0000000000 --- a/reference/fann/functions/fann-create-train-from-callback.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - - fann_create_train_from_callback - Crea una estructura de datos de entrenamiento desde una función proporcionada por el usuario - - - - &reftitle.description; - - resourcefann_create_train_from_callback - intnum_data - intnum_input - intnum_output - callableuser_function - - - Crea una estructura de datos de entrenamiento desde una función proporcionada por el usuario. Debido a que los datos de entrenamiento se numeran (datos 1, datos 2...), - el usuario debe escribir una función que reciba el número del conjunto de datos de entrenamiento (entrada, salida) y que devuelva el conjunto. - - - - - &reftitle.parameters; - - - num_data - - - El número de datos de entrenamiento - - - - - num_input - - - El número de entradas por datos de entrenamiento - - - - - num_output - - - El número de salidas por datos de entrenamiento - - - - - user_function - - - La función proporcionada por elusuario con los siguientes parámetros: - - num - El número del conjunto de datos de entrenamiento - num_input - El número de entradas por datos de entrenamiento - num_output - El número de salidas por datos de entrenamiento - - - - La función debería devolver un array asociativo con las claves input y output y - con dos valores para la entrada y la salida. - - - - - - - - &reftitle.returnvalues; - &fann.return.train; - - - - &reftitle.examples; - - - Ejemplo de <methodname>fann_create_train_from_callback</methodname> - - array_fill(0, $num_input, 1), - "output" => array_fill(0, $num_output, 1), - ); -} - -$num_data = 3; -$num_input = 2; -$num_output = 1; -$train_data = fann_create_train_from_callback($num_data, $num_input, $num_output, "create_train_callback"); -if ($train_data) { - // Hacer algo con $train_data -} -?> -]]> - - - - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_read_train_from_file - fann_train_on_data - fann_destroy_train - fann_save_train - - - - - - - - diff --git a/reference/fann/functions/fann-create-train.xml b/reference/fann/functions/fann-create-train.xml deleted file mode 100644 index 39de47bf6a..0000000000 --- a/reference/fann/functions/fann-create-train.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - fann_create_train - Crea una estructura de datos de entrenamiento vacía - - - - &reftitle.description; - - resourcefann_create_train - intnum_data - intnum_input - intnum_output - - - Crea una estructura de datos de entrenamiento vacía. - - - - - &reftitle.parameters; - - - num_data - - - El número de datos de entrenamiento - - - - - num_input - - - El número de entradas por datos de entrenamiento - - - - - num_output - - - El número de salidas por datos de entrenamiento - - - - - - - - &reftitle.returnvalues; - &fann.return.train; - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_read_train_from_file - fann_train_on_data - fann_destroy_train - fann_save_train - - - - - - - - diff --git a/reference/fann/functions/fann-descale-input.xml b/reference/fann/functions/fann-descale-input.xml deleted file mode 100644 index 71b8776446..0000000000 --- a/reference/fann/functions/fann-descale-input.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - fann_descale_input - Escalar datos en un vector de entrada después de obtenerlo de una RNA basada en parámetros previamente calculados - - - - &reftitle.description; - - boolfann_descale_input - resourceann - arrayinput_vector - - - Escalar datos en un vector de entrada después de obtenerlo de una RNA basada en parámetros previamente calculados. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - input_vector - - - El vector de entrada a desescalar - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_scale_input - fann_descale_output - - - - - - - - diff --git a/reference/fann/functions/fann-descale-output.xml b/reference/fann/functions/fann-descale-output.xml deleted file mode 100644 index 5890420037..0000000000 --- a/reference/fann/functions/fann-descale-output.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - fann_descale_output - Escalar datos en un vector de entrada después de obtenerlo de una RNA basada en parámetros previamente calculados - - - - &reftitle.description; - - boolfann_descale_output - resourceann - arrayoutput_vector - - - Escalar datos en un vector de entrada después de obtenerlo de una RNA basada en parámetros previamente calculados. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - output_vector - - - El vector de salida a desescalar - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_scale_output - fann_descale_input - - - - - - - - diff --git a/reference/fann/functions/fann-descale-train.xml b/reference/fann/functions/fann-descale-train.xml deleted file mode 100644 index 84416afccf..0000000000 --- a/reference/fann/functions/fann-descale-train.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - fann_descale_train - Descalar datos de entrada y salida basados en parámetros previamente calculados - - - - &reftitle.description; - - boolfann_descale_train - resourceann - resourcetrain_data - - - Descalar datos de entrada y salida basados en parámetros previamente calculados. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - train_data - - &fann.train.description; - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_scale_train - fann_set_scaling_params - - - - - - - - diff --git a/reference/fann/functions/fann-destroy-train.xml b/reference/fann/functions/fann-destroy-train.xml deleted file mode 100644 index aa147c3738..0000000000 --- a/reference/fann/functions/fann-destroy-train.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - fann_destroy_train - Destruye los datos de entrenamiento - - - - &reftitle.description; - - boolfann_destroy_train - resourcetrain_data - - - Destruye los datos de entrenamiento. - - - - - &reftitle.parameters; - - - train_data - - &fann.train.description; - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - - diff --git a/reference/fann/functions/fann-destroy.xml b/reference/fann/functions/fann-destroy.xml deleted file mode 100644 index a939615d74..0000000000 --- a/reference/fann/functions/fann-destroy.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - - fann_destroy - Destruye la red por completo y libera adecuadamente toda la memoria asociada - - - - &reftitle.description; - - boolfann_destroy - resourceann - - - Destruye la red por completo y libera adecuadamente toda la memoria asociada. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - - - diff --git a/reference/fann/functions/fann-duplicate-train-data.xml b/reference/fann/functions/fann-duplicate-train-data.xml deleted file mode 100644 index d04ca966af..0000000000 --- a/reference/fann/functions/fann-duplicate-train-data.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - fann_duplicate_train_data - Devuelve una copia exacta de uno datos de entrenamiento de fann - - - - &reftitle.description; - - resourcefann_duplicate_train_data - resourcedata - - - Devuelve una copia exacta de un resource de datos de entrenamiento de fann. - - - - - &reftitle.parameters; - - - data - - &fann.train.description; - - - - - - - &reftitle.returnvalues; - &fann.return.train; - - - - - diff --git a/reference/fann/functions/fann-get-activation-function.xml b/reference/fann/functions/fann-get-activation-function.xml deleted file mode 100644 index b9b59cf942..0000000000 --- a/reference/fann/functions/fann-get-activation-function.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - fann_get_activation_function - Devuelve la función de activación - - - - &reftitle.description; - - intfann_get_activation_function - resourceann - intlayer - intneuron - - - Obtiene la función de activación para la neurona número the neuron en la capa número - layer, contando la capa de entrada como capa 0. - - - No es posible obtener funciones de activación para neuronas de la capa de entrada. - - - El valor devuelto es una de las constantes de funciones de activación. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - layer - - - El número de capa. - - - - - neuron - - - El número de neurona. - - - - - - - - &reftitle.returnvalues; - - Una constante de funciones de activación o -1 - si la neurona no está definida en la red neuronal, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_set_activation_function_layer - fann_set_activation_function_hidden - fann_set_activation_function_output - fann_set_activation_steepness - fann_set_activation_function - - - - - - - - diff --git a/reference/fann/functions/fann-get-activation-steepness.xml b/reference/fann/functions/fann-get-activation-steepness.xml deleted file mode 100644 index 0052f76c13..0000000000 --- a/reference/fann/functions/fann-get-activation-steepness.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - fann_get_activation_steepness - Devuelve la pendiente de activación para el número de neurona y de capa proporcionados - - - - &reftitle.description; - - floatfann_get_activation_steepness - resourceann - intlayer - intneuron - - - Obtiene la pendiente de activación para la neurona número neuron en la capa número - layer, contando la capa de entrada como capa 0. - - - No es posible obtener la pendiente de activación para neuronas de la capa de entrada. - - - La pendiente de una función de activación dice algo sobre cómo de rápido va la función de activación - del mínimo al máximo. Un valor alto para la función de activación proporcionará un entrenamiento más agresivo. - - - Cuando se entrenan redes neuronales donde los valores de salida deberían estar en los extremos - (normalmente 0 y 1, dependiendo de la función de activación), se puede emplear una función de activación (p.ej. 1.0). - - - La pendiente de activación predeterminada es 0.5. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - layer - - - El número de capa - - - - - neuron - - - El número de neurona - - - - - - - - &reftitle.returnvalues; - - La pendiente de activación para la neurona o -1 si la neurona no está definida en la red neuronal, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_set_activation_function - fann_set_activation_steepness_layer - fann_set_activation_steepness_hidden - fann_set_activation_steepness_output - fann_set_activation_steepness - - - - - - - - diff --git a/reference/fann/functions/fann-get-bias-array.xml b/reference/fann/functions/fann-get-bias-array.xml deleted file mode 100644 index 54166b82d4..0000000000 --- a/reference/fann/functions/fann-get-bias-array.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - fann_get_bias_array - Obtener el número de tendencias de cada capa de una red - - - - &reftitle.description; - - arrayfann_get_bias_array - resourceann - - - Obtener el número de tendencias de cada capa de una red. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Un array con de números de tendencias en cada capa. - - - - - - - diff --git a/reference/fann/functions/fann-get-bit-fail-limit.xml b/reference/fann/functions/fann-get-bit-fail-limit.xml deleted file mode 100644 index d99f9991d0..0000000000 --- a/reference/fann/functions/fann-get-bit-fail-limit.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - - fann_get_bit_fail_limit - Devuelve el límite de fallo de bit empleado durante un entrenamiento - - - - &reftitle.description; - - floatfann_get_bit_fail_limit - resourceann - - - Devuelve el límite de fallo de bit empleado durante un entrenamiento. - - - El límite de fallo de bit se emplea durante un entrenamiento donde la función de parada - esté establecida a FANN_STOPFUNC_BIT. - - - El límite es la diferencia máxima aceptada entre la salida provista y la salida real durante un entrenamiento. - Cada salida que diverja más que este límite se cuenta como un bit de error. Esta diferencia se dividide entre dos - al tratar con funciones de activación simétrica, por lo que las funciones de activación simétrica y no simétrica - pueden utilizar el mismo límite. - - - El límite de fallo de bit es 0.35. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - El límite de fallo de bit, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_set_bit_fail_limit - - - - - - - - diff --git a/reference/fann/functions/fann-get-bit-fail.xml b/reference/fann/functions/fann-get-bit-fail.xml deleted file mode 100644 index a149676184..0000000000 --- a/reference/fann/functions/fann-get-bit-fail.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - fann_get_bit_fail - El número de bit fallidos - - - - &reftitle.description; - - intfann_get_bit_fail - resourceann - - - El número de bit fallidos; es el número de neuronas de salida que difieren más del límte de fallo de bit - (véanse fann_get_bit_fail_limit y fann_set_bit_fail_limit). - Los bit se cuentan en todos los datos de entrenamiento, por lo que este número puede ser mayor que el número de datos de entrenamiento. - - - Este valor es reiniciado por fann_reset_MSE y actualizado por las mismas funciones - que también actualizan el valor del ECM (p.ej., fann_test_data y fann_train_epoch) - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - El número de bit fallidos, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_get_MSE - fann_reset_MSE - fann_test_data - fann_train_epoch - fann_get_bit_fail_limit - fann_set_bit_fail_limit - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-activation-functions-count.xml b/reference/fann/functions/fann-get-cascade-activation-functions-count.xml deleted file mode 100644 index 61011e1d0e..0000000000 --- a/reference/fann/functions/fann-get-cascade-activation-functions-count.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - fann_get_cascade_activation_functions_count - Devuelve el número de funciones de activación en cascada - - - - &reftitle.description; - - intfann_get_cascade_activation_functions_count - resourceann - - - El número de funciones de activación del array fann_get_cascade_activation_functions. - - - El número predeterminado de funciones de activación es 6. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - El número de funciones de activación en cascada, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_get_cascade_activation_functions - fann_set_cascade_activation_functions - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-activation-functions.xml b/reference/fann/functions/fann-get-cascade-activation-functions.xml deleted file mode 100644 index 953dd0141f..0000000000 --- a/reference/fann/functions/fann-get-cascade-activation-functions.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - fann_get_cascade_activation_functions - Devuelve las funciones de activación en cascada - - - - &reftitle.description; - - arrayfann_get_cascade_activation_functions - resourceann - - - El array de funciones de activación en cascada es un array con las diferentes funciones de activación empleadas por las cadidatas. - - - Véase fann_get_cascade_num_candidates para una descripción de las neuronas candidatas generadas por este array. - - - Las funciones de activación predeterminadas son FANN_SIGMOID, FANN_SIGMOID_SYMMETRIC, - FANN_GAUSSIAN, FANN_GAUSSIAN_SYMMETRIC, FANN_ELLIOT y - FANN_ELLIOT_SYMMETRIC. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Las funciones de activación en cascada, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_get_cascade_activation_functions_count - fann_set_cascade_activation_functions - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-activation-steepnesses-count.xml b/reference/fann/functions/fann-get-cascade-activation-steepnesses-count.xml deleted file mode 100644 index 880791fc0d..0000000000 --- a/reference/fann/functions/fann-get-cascade-activation-steepnesses-count.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - fann_get_cascade_activation_steepnesses_count - El número de pendientes de activación - - - - &reftitle.description; - - intfann_get_cascade_activation_steepnesses_count - resourceann - - - El número de pendientes de activación del array fann_get_cascade_activation_functions. - - - El número de pendientes de activación predeterminado es 4. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - El número de pendientes de activación, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_get_cascade_activation_steepnesses - fann_set_cascade_activation_functions - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-activation-steepnesses.xml b/reference/fann/functions/fann-get-cascade-activation-steepnesses.xml deleted file mode 100644 index cde4aaa38b..0000000000 --- a/reference/fann/functions/fann-get-cascade-activation-steepnesses.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - fann_get_cascade_activation_steepnesses - Devuelve las pendientes de activación en cascada - - - - &reftitle.description; - - arrayfann_get_cascade_activation_steepnesses - resourceann - - - El array de pendientes de activación en cascada es un array con las diferentes funciones de activación empleadas por las candidatas. - - - Véase fann_get_cascade_num_candidates para una descripción de las neuronas candidatas generadas por este array. - - - Las pendientes de activación predeterminadas son {0.25, 0.50, 0.75, 1.00}. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Las pendientes de activación en cascada, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_get_cascade_activation_steepnesses_count - fann_set_cascade_activation_steepnesses - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-candidate-change-fraction.xml b/reference/fann/functions/fann-get-cascade-candidate-change-fraction.xml deleted file mode 100644 index d101503dc6..0000000000 --- a/reference/fann/functions/fann-get-cascade-candidate-change-fraction.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - - fann_get_cascade_candidate_change_fraction - Devuelve la fracción de cambio de candidatas en cascada - - - - &reftitle.description; - - floatfann_get_cascade_candidate_change_fraction - resourceann - - - La fracción de cambio de candidatas en cascada es un número entre 0 y 1 que determina lo grande que debería ser el cambio del valor de una fracción de - fann_get_MSE en fann_get_cascade_candidate_stagnation_epochs durante el entrenamiento de las neuronas candidatas, - para que el entrenamiento no se estanque. Si el entrenamiento se estanca, el entrenamiento de las neuronas candidatas finalizará - y se seleccionarán nuevas candidatas. - - - Esto significa que si el ECM no cambia por una fracción de fann_get_cascade_candidate_change_fraction durante - un período de fann_get_cascade_candidate_stagnation_epochs, el entrenamiento de las neuronas candidatas se para - delbido a que el entrenamiento ha estancado. - - - Si la fracción de cambio de candidatas en cascada es baja, las neuronas candidatas serán entrenadas más, y si la fracción es alta, serán entrenadas menos. - - - La fracción de cambio de candidatas en cascada predeterminada es 0.01, que es equivalente a un cambio del 1% en el ECM. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The cascade candidate change fraction, or &false; on error. - - - - - &reftitle.seealso; - - - fann_set_cascade_candidate_change_fraction - fann_get_MSE - fann_get_cascade_candidate_stagnation_epochs - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-candidate-limit.xml b/reference/fann/functions/fann-get-cascade-candidate-limit.xml deleted file mode 100644 index 77ad52d6b9..0000000000 --- a/reference/fann/functions/fann-get-cascade-candidate-limit.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - fann_get_cascade_candidate_limit - Devuelve el límite de candidatas - - - - &reftitle.description; - - floatfann_get_cascade_candidate_limit - resourceann - - - El límite de candidatas es un límite de cuánto podrían ser entrenadas las neuronas candidatas. El límite es un límite - de la proporción entre el ECM y la puntuación de la candidata. - - - Establecezca este valor a uno más bajo para evitar el sobreajuste, y a uno más alto si el sobreajuste no es un problema. - - - El límite de candidatas predetermiado es 1000.0. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - El límite de candidatas, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_set_cascade_candidate_limit - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-candidate-stagnation-epochs.xml b/reference/fann/functions/fann-get-cascade-candidate-stagnation-epochs.xml deleted file mode 100644 index ef05e37d4c..0000000000 --- a/reference/fann/functions/fann-get-cascade-candidate-stagnation-epochs.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - fann_get_cascade_candidate_stagnation_epochs - Devuelve el número de épocas de estancamiento de candidatas en cascada - - - - &reftitle.description; - - intfann_get_cascade_candidate_stagnation_epochs - resourceann - - - El número de épocas de estancamiento de candidatas en cascada determina el número de entrenamiento de épocas permitido para continuar - sin cambiar el ECM por una fracción de fann_get_cascade_candidate_change_fraction. - - - Véase más información sobre este parámetro en fann_get_cascade_candidate_change_fraction. - - - El número de épocas de estancamiento de candidatas en cascada predeterminado es 12. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - El número de épocas de estancamiento de candidatas en cascada, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_set_cascade_candidate_stagnation_epochs - fann_get_cascade_candidate_change_fraction - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-max-cand-epochs.xml b/reference/fann/functions/fann-get-cascade-max-cand-epochs.xml deleted file mode 100644 index 60033b918e..0000000000 --- a/reference/fann/functions/fann-get-cascade-max-cand-epochs.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - fann_get_cascade_max_cand_epochs - Devuelve el máximo de épocas de candidatas - - - - &reftitle.description; - - intfann_get_cascade_max_cand_epochs - resourceann - - - El máximo de épocas de cadidatas determina el número máximo de épocas que podrían ser entrenadas - las conexiones de entrada a las candidatas antes de añadir una nueva neurona candidata. - - - El máximo de épocas de candidatas predterminado es 150. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - El máximo de épocas de candidtas, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_set_cascade_max_cand_epochs - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-max-out-epochs.xml b/reference/fann/functions/fann-get-cascade-max-out-epochs.xml deleted file mode 100644 index 405327d840..0000000000 --- a/reference/fann/functions/fann-get-cascade-max-out-epochs.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - fann_get_cascade_max_out_epochs - Devuelve el máximo de épocas de salida - - - - &reftitle.description; - - intfann_get_cascade_max_out_epochs - resourceann - - - El máximo de épocas de salida determina el número máximo de épocas que podrían ser entrenadas - las conexiones de salida después de añadir una nueva neurona candidata. - - - El máximo de épocas de salida predterminado es 150. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - El máximo de épocas de salida, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_set_cascade_max_out_epochs - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-min-cand-epochs.xml b/reference/fann/functions/fann-get-cascade-min-cand-epochs.xml deleted file mode 100644 index ea7fbc3ed3..0000000000 --- a/reference/fann/functions/fann-get-cascade-min-cand-epochs.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - fann_get_cascade_min_cand_epochs - Devuelve el mínimo de épocas de candidatas - - - - &reftitle.description; - - intfann_get_cascade_min_cand_epochs - resourceann - - - El mínimo de épocas de cadidatas determina el número máximo de épocas que podrían ser entrenadas - las conexiones de entrada a las candidatas antes de añadir una nueva neurona candidata. - - - El mínimo de épocas de candidatas predterminado es 150. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - El mínimo de épocas de candidtas, o &false; en caso de error. - - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_set_cascade_min_cand_epochs - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-min-out-epochs.xml b/reference/fann/functions/fann-get-cascade-min-out-epochs.xml deleted file mode 100644 index 75bf6b6c07..0000000000 --- a/reference/fann/functions/fann-get-cascade-min-out-epochs.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - fann_get_cascade_min_out_epochs - Devuelve el mínimo de épocas de salida - - - - &reftitle.description; - - intfann_get_cascade_min_out_epochs - resourceann - - - El mínimo de épocas de salida determina el número mínimo de épocas que deben ser entrenadas - las conexiones de salida después de añadir una nueva neurona candidata. - - - El mínimo de épocas de salida predterminado es 150. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - El mínimo de épocas de salida, o &false; en caso de error. - - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_set_cascade_min_out_epochs - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-num-candidate-groups.xml b/reference/fann/functions/fann-get-cascade-num-candidate-groups.xml deleted file mode 100644 index 75c83825dc..0000000000 --- a/reference/fann/functions/fann-get-cascade-num-candidate-groups.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - fann_get_cascade_num_candidate_groups - Devuelve el número de grupos de candidatas - - - - &reftitle.description; - - intfann_get_cascade_num_candidate_groups - resourceann - - - El número de grupos de candidatas es el número de grupos de candidatas idénticos que se emplearán durante un entrenamiento. - - - Este número se puede usar para tener más candidatas sin tener que definir nuevos parámetros para las candidatas. - - - Véase fann_get_cascade_num_candidates para una descripción de - las neuronas candidatas generadas por este parámetro. - - - El número de grupos de candidatas predeterminado es 2. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - El número de grupos de candidatas, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_set_cascade_num_candidate_groups - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-num-candidates.xml b/reference/fann/functions/fann-get-cascade-num-candidates.xml deleted file mode 100644 index 6438ccb536..0000000000 --- a/reference/fann/functions/fann-get-cascade-num-candidates.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - - fann_get_cascade_num_candidates - Devuelve el número de candidatas empleadas durante un entrenamiento - - - - &reftitle.description; - - intfann_get_cascade_num_candidates - resourceann - - - El número de candidatas empleadas durante el entrenamiento (calculado multiplicando - fann_get_cascade_activation_functions_count, - fann_get_cascade_activation_steepnesses_count y - fann_get_cascade_num_candidate_groups). - - - Las candidatas reales están definidos por los array fann_get_cascade_activation_functions y - fann_get_cascade_activation_steepnesses. Estos array definen las funciones de activación y - las pendientes de activación empleadas por las neuronas candidatas. Si hay 2 funciones de activación en el array de funciones de activación y - 3 pendientes en el array de pendientes, habrá 2x3=6 candidatas diferentes que serán entrenados. Estas 6 candidatas - diferentes se puedn copiar a varios grupos de candidatas, donde la única diferencia entre estos grupos es el peso inicial. - Si el número de grupos se establece a 2, el número de neuronas candidatas será 2x3x2=12. - El número de grupos de candidatas está definido por fann_set_cascade_num_candidate_groups. - - - El número de candidatas predeterminado es 6x4x2 = 48 - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - El número de candidatas emleadas durante un entrenamiento, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_get_cascade_activation_functions - fann_get_cascade_activation_functions_count - fann_get_cascade_activation_steepnesses - fann_get_cascade_activation_steepnesses_count - fann_get_cascade_num_candidate_groups - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-output-change-fraction.xml b/reference/fann/functions/fann-get-cascade-output-change-fraction.xml deleted file mode 100644 index 182d5282b9..0000000000 --- a/reference/fann/functions/fann-get-cascade-output-change-fraction.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - - - fann_get_cascade_output_change_fraction - Devuelve la fracción de cambio de salida en cascada - - - - &reftitle.description; - - floatfann_get_cascade_output_change_fraction - resourceann - - - La fracción de cambio de salida en cascada es un número entre 0 y 1 que determina lo grande que debería ser el cambio del valor de una fracción de - fann_get_MSE en fann_get_cascade_output_stagnation_epochs durante el entrenamiento de las conexiones de salida, - para que el entrenamiento no se estanque. Si el entrenamiento se estanca, el entrenamiento de las conexiones de salida - finalizará y se prepararán nuevas candidatas. - - - Esto significa que si el ECM no cambia por una fracción de fann_get_cascade_output_change_fraction durante - un período de fann_get_cascade_output_stagnation_epochs, el entrenamiento de las conexiones de salida se - para delbido a que el entrenamiento ha estancado. - - - Si la fracción de cambio de salida en cascada es baja, las conexiones de salida serán entrenadas más, y si la fracción es alta, - serán entrenadas menos. - - - La fracción de cambio de salida en cascada predeterminada es 0.01, que es equivalente a un cambio del 1% en el ECM. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - La fracción de cambio de salida en cascada, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_set_cascade_output_change_fraction - fann_get_MSE - fann_get_cascade_output_stagnation_epochs - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-output-stagnation-epochs.xml b/reference/fann/functions/fann-get-cascade-output-stagnation-epochs.xml deleted file mode 100644 index d8a69a1f0e..0000000000 --- a/reference/fann/functions/fann-get-cascade-output-stagnation-epochs.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - fann_get_cascade_output_stagnation_epochs - Devuelve el número de épocas de estancamiento de salida en cascada - - - - &reftitle.description; - - intfann_get_cascade_output_stagnation_epochs - resourceann - - - El número de épocas de estacamiento de salida en cascada determina el número de épocas que se le permite al entrenamiento - continuar sin cambiar el ECM por una fracción de fann_get_cascade_output_change_fraction. - - - Véase más información sobre este parámetro en fann_get_cascade_output_change_fraction. - - - El número predeterminado de épocas de estancamiento de salida en cascada es 12. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - El número de épocas de estancamiento de salida en cascada, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_set_cascade_output_stagnation_epochs - fann_get_cascade_output_change_fraction - - - - - - - - diff --git a/reference/fann/functions/fann-get-cascade-weight-multiplier.xml b/reference/fann/functions/fann-get-cascade-weight-multiplier.xml deleted file mode 100644 index a26a4aebe5..0000000000 --- a/reference/fann/functions/fann-get-cascade-weight-multiplier.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - fann_get_cascade_weight_multiplier - Devuelve el multiplicador de peso - - - - &reftitle.description; - - floatfann_get_cascade_weight_multiplier - resourceann - - - El multiplicador de peso es un parámetro que se emplea para multiplicar los pesos de la neurona candidata antes de añadir - la neurona a la red neuronal. Este parámetro está normalmente entre 0 y 1, y se emplea para hacer el entrenamiento un poco menos agresivo. - - - El multiplicador de peso predeterminado es 0.4. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - El multiplicador de peso, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_set_cascade_weight_multiplier - - - - - - - - diff --git a/reference/fann/functions/fann-get-connection-array.xml b/reference/fann/functions/fann-get-connection-array.xml deleted file mode 100644 index 66c7f6b66d..0000000000 --- a/reference/fann/functions/fann-get-connection-array.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - fann_get_connection_array - Obtener las conexiones de la red - - - - &reftitle.description; - - arrayfann_get_connection_array - resourceann - - - Obtener las conexiones de la red. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Un array con las conexiones de la red. - - - - - - - diff --git a/reference/fann/functions/fann-get-connection-rate.xml b/reference/fann/functions/fann-get-connection-rate.xml deleted file mode 100644 index f29eafa62c..0000000000 --- a/reference/fann/functions/fann-get-connection-rate.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - fann_get_connection_rate - Obtener el índice de conexión empleado al crear la red - - - - &reftitle.description; - - floatfann_get_connection_rate - resourceann - - - Obtener el índice de conexión empleado al crear la red. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - El índice de conexión empleado al crear la red, o &false; en caso de error. - - - - - - - diff --git a/reference/fann/functions/fann-get-errno.xml b/reference/fann/functions/fann-get-errno.xml deleted file mode 100644 index 63db878d4a..0000000000 --- a/reference/fann/functions/fann-get-errno.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - fann_get_errno - Devuelve el número del último error - - - - &reftitle.description; - - intfann_get_errno - resourceerrdat - - - Devuelve el número del último error. - - - - - &reftitle.parameters; - - - errdat - - &fann.errdat.description; - - - - - - - &reftitle.returnvalues; - - El número de error, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_reset_errno - fann_get_errstr - - - - - - - - diff --git a/reference/fann/functions/fann-get-errstr.xml b/reference/fann/functions/fann-get-errstr.xml deleted file mode 100644 index fa3e98444d..0000000000 --- a/reference/fann/functions/fann-get-errstr.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - fann_get_errstr - Devuelve el string de último error - - - - &reftitle.description; - - stringfann_get_errstr - resourceerrdat - - - Devuelve el string de último error. - - - - - &reftitle.parameters; - - - errdat - - &fann.errdat.description; - - - - - - - &reftitle.returnvalues; - - El string del último error, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_reset_errstr - fann_get_errno - - - - - - - - diff --git a/reference/fann/functions/fann-get-layer-array.xml b/reference/fann/functions/fann-get-layer-array.xml deleted file mode 100644 index b143f5c1c6..0000000000 --- a/reference/fann/functions/fann-get-layer-array.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - - fann_get_layer_array - Obtener el número de neuronas de cada capa de la red - - - - &reftitle.description; - - arrayfann_get_layer_array - resourceann - - - Obtener el número de neuronas de cada capa de la red neuronal. - - - Las tendencias no se incluyen, coincidiendo así las capas con las funciones fann_create. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Un array de números de neuronas en cada capa. - - - - - - diff --git a/reference/fann/functions/fann-get-learning-momentum.xml b/reference/fann/functions/fann-get-learning-momentum.xml deleted file mode 100644 index 043c26c945..0000000000 --- a/reference/fann/functions/fann-get-learning-momentum.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - fann_get_learning_momentum - Devuelve el momento del aprendizaje - - - - &reftitle.description; - - floatfann_get_learning_momentum - resourceann - - - El momento del aprendizaje se puede emplear para acelerar un entrenamiento FANN_TRAIN_INCREMENTAL. - Sin embargo, un momento muy alto no beneficiará al entrenamiento. Establecer el momento a 0 es lo mismo que - no emplear el parmámetro del momento. El valor recomendado para el valor de este parámetro está entre 0.0 y 1.0. - - - El momento predeterminado es 0. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - El moemento del aprendizaje, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_set_learning_momentum - fann_set_training_algorithm - - - - - - - - diff --git a/reference/fann/functions/fann-get-learning-rate.xml b/reference/fann/functions/fann-get-learning-rate.xml deleted file mode 100644 index 1b8bd34db7..0000000000 --- a/reference/fann/functions/fann-get-learning-rate.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - fann_get_learning_rate - Devuelve el índice de aprendizaje - - - - &reftitle.description; - - floatfann_get_learning_rate - resourceann - - - El índice de aprendizaje se emplea para determinar la agresividad de un entrenamiento para algunos de los algoritmo de entrenamiento - (FANN_TRAIN_INCREMENTAL, FANN_TRAIN_BATCH y FANN_TRAIN_QUICKPROP). - Observe, sin embargo, que no se emplea en FANN_TRAIN_RPROP. - - - El índice de aprendizaje predeterminado es 0.7. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - El índice de aprendizaje, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_set_learning_rate - fann_set_training_algorithm - - - - - - - - diff --git a/reference/fann/functions/fann-get-mse.xml b/reference/fann/functions/fann-get-mse.xml deleted file mode 100644 index 9fe916c4f6..0000000000 --- a/reference/fann/functions/fann-get-mse.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - fann_get_MSE - Lee el error cuadrático medio de la red - - - - &reftitle.description; - - floatfann_get_MSE - resourceann - - - Lee el error cuadrático medio de la red. - - - Este valor se calcula durante un entrenamiento o una prueba, por lo que a veces puede - estar un poco alejados si los pesos han cambiado desde el último cálculo de este valor. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - El error cuadrático medio, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_test_data - - - - - - - diff --git a/reference/fann/functions/fann-get-network-type.xml b/reference/fann/functions/fann-get-network-type.xml deleted file mode 100644 index dda1057c9d..0000000000 --- a/reference/fann/functions/fann-get-network-type.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - fann_get_network_type - Obtener el tipo de una red neuronal - - - - &reftitle.description; - - intfann_get_network_type - resourceann - - - Obtener el tipo de una red neuronal. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Una constante de tipo de red, o &false; en caso de error. - - - - - - - diff --git a/reference/fann/functions/fann-get-num-input.xml b/reference/fann/functions/fann-get-num-input.xml deleted file mode 100644 index 61b2b8ec8d..0000000000 --- a/reference/fann/functions/fann-get-num-input.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - fann_get_num_input - Obtener el número de neuronas de entrada - - - - &reftitle.description; - - intfann_get_num_input - resourceann - - - Obtener el número de neuronas de entrada. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - El número de neuronas de entrada, o &false; en caso de error. - - - - - - - diff --git a/reference/fann/functions/fann-get-num-layers.xml b/reference/fann/functions/fann-get-num-layers.xml deleted file mode 100644 index d4e6e8fccc..0000000000 --- a/reference/fann/functions/fann-get-num-layers.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - fann_get_num_layers - Obtener el número de capas de la red neuronal - - - - &reftitle.description; - - intfann_get_num_layers - resourceann - - - Obtener el número de capas de la red neuronal. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - El número de capas de la red neuronal, o &false; en caso de error. - - - - - - - diff --git a/reference/fann/functions/fann-get-num-output.xml b/reference/fann/functions/fann-get-num-output.xml deleted file mode 100644 index e4396e75b7..0000000000 --- a/reference/fann/functions/fann-get-num-output.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - fann_get_num_output - Obtener el número de neuronas de salida - - - - &reftitle.description; - - intfann_get_num_output - resourceann - - - Obtener el número de neuronas de salida. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - El número de neuronas de salida, o &false; en caso de error. - - - - - - - diff --git a/reference/fann/functions/fann-get-quickprop-decay.xml b/reference/fann/functions/fann-get-quickprop-decay.xml deleted file mode 100644 index 96c68b334f..0000000000 --- a/reference/fann/functions/fann-get-quickprop-decay.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - fann_get_quickprop_decay - Devuelve la decadencia, que es un factor por el que los pesos deberían decrementar en cada iteración durante un entrenamiento quickprop - - - - &reftitle.description; - - floatfann_get_quickprop_decay - resourceann - - - La decadencia es un número pequeño negativo que es un factor por el que los pesos deberían decrementar en cada iteración - durante un entrenamiento quickprop. Se emplea para asegurarse de que los pesos no sean demasiado altos durante el entrenamiento. - - - La decadencia predeterminada es -0.0001. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - The decay, or &false; on error. - - - - - &reftitle.seealso; - - - fann_set_quickprop_decay - - - - - - - - diff --git a/reference/fann/functions/fann-get-quickprop-mu.xml b/reference/fann/functions/fann-get-quickprop-mu.xml deleted file mode 100644 index ac1eb7a8a1..0000000000 --- a/reference/fann/functions/fann-get-quickprop-mu.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - fann_get_quickprop_mu - Devuelve el factor mu - - - - &reftitle.description; - - floatfann_get_quickprop_mu - resourceann - - - El factor mu se emplea para aumentar y disminuir el tamaño del paso durante un entrenamiento quickprop. El factor mu debería - estar siempre por encima de 1, ya que, de lo contrario, lo disminuiría cuando se suponía que debía de aumentarlo. - - - El factor mu predeterminado es 1.75. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - Ek factor mu, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_set_quickprop_mu - - - - - - - - diff --git a/reference/fann/functions/fann-get-rprop-decrease-factor.xml b/reference/fann/functions/fann-get-rprop-decrease-factor.xml deleted file mode 100644 index 10bbefc15b..0000000000 --- a/reference/fann/functions/fann-get-rprop-decrease-factor.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - fann_get_rprop_decrease_factor - Devuelve el factor de disminución empleado durante un entrenamiento RPROP - - - - &reftitle.description; - - floatfann_get_rprop_decrease_factor - resourceann - - - El factor de disminución es un valor menor que 1, el cual se emplea para disminuir el tamaño del paso durante un entrenamiento RPROP. - - - El factor de disminución predeterminado es 0.5. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - El factor de disminución, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_set_rprop_decrease_factor - - - - - - - - diff --git a/reference/fann/functions/fann-get-rprop-delta-max.xml b/reference/fann/functions/fann-get-rprop-delta-max.xml deleted file mode 100644 index 729f6459ac..0000000000 --- a/reference/fann/functions/fann-get-rprop-delta-max.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - fann_get_rprop_delta_max - Devuelve el tamaño de paso máximo - - - - &reftitle.description; - - floatfann_get_rprop_delta_max - resourceann - - - El tamaño de paso máximo es un número positivo que determina lo grande que podría ser el tamaño de paso máximo. - - - El valor predeterminado de delta máximo es 50.0. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - El tamaño de paso máximo, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_set_rprop_delta_max - fann_get_rprop_delta_min - - - - - - - - diff --git a/reference/fann/functions/fann-get-rprop-delta-min.xml b/reference/fann/functions/fann-get-rprop-delta-min.xml deleted file mode 100644 index 254472fb02..0000000000 --- a/reference/fann/functions/fann-get-rprop-delta-min.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - fann_get_rprop_delta_min - Devuelve el tamaño de paso mínimo - - - - &reftitle.description; - - floatfann_get_rprop_delta_min - resourceann - - - El tamaño de paso mínimo es un número positivo pequeño que determina lo pequeño que podría ser el tamaño de paso mínimo. - - - El valor predeterminado de delta mínimo es 0.0. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - El tamaño de paso mínimo, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_set_rprop_delta_min - - - - - - - - diff --git a/reference/fann/functions/fann-get-rprop-delta-zero.xml b/reference/fann/functions/fann-get-rprop-delta-zero.xml deleted file mode 100644 index 4a37c8d734..0000000000 --- a/reference/fann/functions/fann-get-rprop-delta-zero.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - fann_get_rprop_delta_zero - Devuelve el tamaño de paso inicial - - - - &reftitle.description; - - intfann_get_rprop_delta_zero - resourceann - - - El tamaño de paso inicial es un número positivo que determina el tamaño de paso inicial. - - - El valor predeterminado de delta cero es 0.1. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - El tamaño de paso inicial, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_set_rprop_delta_zero - fann_get_rprop_delta_min - fann_get_rprop_delta_max - - - - - - - - diff --git a/reference/fann/functions/fann-get-rprop-increase-factor.xml b/reference/fann/functions/fann-get-rprop-increase-factor.xml deleted file mode 100644 index 1f2083b19a..0000000000 --- a/reference/fann/functions/fann-get-rprop-increase-factor.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - fann_get_rprop_increase_factor - Devuelve el factor de aumento empleado durante un entrenamiento RPROP - - - - &reftitle.description; - - floatfann_get_rprop_increase_factor - resourceann - - - El factor de aumento es un valor mayor que 1, el cual se emplea para aumentar el tamaño del paso durante un entrenamiento RPROP. - - - El factor de aumento predeterminado es 1.2. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - El factor de aumento, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_set_rprop_increase_factor - - - - - - - - diff --git a/reference/fann/functions/fann-get-sarprop-step-error-shift.xml b/reference/fann/functions/fann-get-sarprop-step-error-shift.xml deleted file mode 100644 index ca34cb4fe2..0000000000 --- a/reference/fann/functions/fann-get-sarprop-step-error-shift.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - fann_get_sarprop_step_error_shift - Devuelve el desplazamiento del error de paso de sarprop - - - - &reftitle.description; - - floatfann_get_sarprop_step_error_shift - resourceann - - - Devuelve el desplazamiento del error de paso de sarprop. - - - El desplazamiento del error de paso predeterminado es 1.385. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - El desplazamiento del error de paso de sarprop , o &false; en caso de error. - - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_set_sarprop_step_error_shift - - - - - - - - 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 deleted file mode 100644 index da51e43354..0000000000 --- a/reference/fann/functions/fann-get-sarprop-step-error-threshold-factor.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - fann_get_sarprop_step_error_threshold_factor - Devuelve el factor de umbral del error de paso de sarprop - - - - &reftitle.description; - - floatfann_get_sarprop_step_error_threshold_factor - resourceann - - - Devuelve el factor de umbral del error de paso de sarprop. - - - El factor predeterminado es 0.1. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - El factor de umbral del error de paso de sarprop, o &false; en caso de error. - - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_set_sarprop_step_error_threshold_factor - - - - - - - - diff --git a/reference/fann/functions/fann-get-sarprop-temperature.xml b/reference/fann/functions/fann-get-sarprop-temperature.xml deleted file mode 100644 index 59ca9f636a..0000000000 --- a/reference/fann/functions/fann-get-sarprop-temperature.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - fann_get_sarprop_temperature - Devuelve la temperatura de sarprop - - - - &reftitle.description; - - floatfann_get_sarprop_temperature - resourceann - - - Devuelve la temperatura de sarprop. - - - La temperatura predeterminada es 0.015. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - La temperatura de sarprop, o &false; en caso de error. - - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_set_sarprop_temperature - - - - - - - - diff --git a/reference/fann/functions/fann-get-sarprop-weight-decay-shift.xml b/reference/fann/functions/fann-get-sarprop-weight-decay-shift.xml deleted file mode 100644 index 7fa0e37304..0000000000 --- a/reference/fann/functions/fann-get-sarprop-weight-decay-shift.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - fann_get_sarprop_weight_decay_shift - Devuelve el desplazamiento de decadencia del peso de sarprop - - - - &reftitle.description; - - floatfann_get_sarprop_weight_decay_shift - resourceann - - - Devuelve el desplazamiento de decadencia del peso de sarprop. - - - El valor de delta máximo es -6.644. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - El desplazamiento de decadencia del peso de sarprop, o &false; en caso de error. - - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_set_sarprop_weight_decay_shift - - - - - - - - diff --git a/reference/fann/functions/fann-get-total-connections.xml b/reference/fann/functions/fann-get-total-connections.xml deleted file mode 100644 index 3a0cc05b5b..0000000000 --- a/reference/fann/functions/fann-get-total-connections.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - fann_get_total_connections - Obtener el número total de conexiones de la red completa - - - - &reftitle.description; - - intfann_get_total_connections - resourceann - - - Obtener el número total de conexiones de la red completa. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - El número total de conexiones de la red completa, o &false; en caso de error. - - - - - - - diff --git a/reference/fann/functions/fann-get-total-neurons.xml b/reference/fann/functions/fann-get-total-neurons.xml deleted file mode 100644 index 61d933aa90..0000000000 --- a/reference/fann/functions/fann-get-total-neurons.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - fann_get_total_neurons - Obtener el número total de neuronas de la red completa - - - - &reftitle.description; - - intfann_get_total_neurons - resourceann - - - Obtener el número total de neuronas de la red completa. Este número también incluye las neuronas de tendencia, - por lo que una red 2-4-2 posee 2+4+2 +2(tendencias) = 10 neuronas. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - El número total de neuronas de la red completa, o &false; en caso de error. - - - - - - diff --git a/reference/fann/functions/fann-get-train-error-function.xml b/reference/fann/functions/fann-get-train-error-function.xml deleted file mode 100644 index c4d2e48ab4..0000000000 --- a/reference/fann/functions/fann-get-train-error-function.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - fann_get_train_error_function - Devuelve la función de error empleada durante un entrenamiento - - - - &reftitle.description; - - intfann_get_train_error_function - resourceann - - - Devuelve la función de error empleada durante un entrenamiento. - - - Las funciones de error están descritas en las constantes de funciones de error. - - - La función de error predeteminada es FANN_ERRORFUNC_TANH. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - La constante de función de error, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_set_train_error_function - - - - - - - - diff --git a/reference/fann/functions/fann-get-train-stop-function.xml b/reference/fann/functions/fann-get-train-stop-function.xml deleted file mode 100644 index 1a5260eb03..0000000000 --- a/reference/fann/functions/fann-get-train-stop-function.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - fann_get_train_stop_function - Devuelve la función de parada empleada durante el entrenamiento - - - - &reftitle.description; - - intfann_get_train_stop_function - resourceann - - - Devuelve la función de parada empleada durante el entrenamiento. - - - Las funciones de parada están descritas en las constantes de funciones de parada. - - - La función de parada predeterminada es FANN_STOPFUNC_MSE. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - La constante de función de parada, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_set_train_stop_function - - - - - - - - diff --git a/reference/fann/functions/fann-get-training-algorithm.xml b/reference/fann/functions/fann-get-training-algorithm.xml deleted file mode 100644 index 7964b6c13d..0000000000 --- a/reference/fann/functions/fann-get-training-algorithm.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - fann_get_training_algorithm - Devuelve el algoritmo de entrenamiento - - - - &reftitle.description; - - intfann_get_training_algorithm - resourceann - - - Devuelve el algoritmo de entrenamiento. Este algoritmo lo utilizan fann_train_on_data y funciones asociadas. - - - - Observe que este algoritmo también se emplea durante fann_cascadetrain_on_data, aunque solamente - están permitidos FANN_TRAIN_RPROP y FANN_TRAIN_QUICKPROP durante un entrenamiento en cascada. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - - La constante de Algoritmo de entrenamiento, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_set_training_algorithm - - - - - - - - diff --git a/reference/fann/functions/fann-init-weights.xml b/reference/fann/functions/fann-init-weights.xml deleted file mode 100644 index 4a1c9ebb85..0000000000 --- a/reference/fann/functions/fann-init-weights.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - - fann_init_weights - Inicializar los pesos empleando el algoritmo de Widrow + Nguyen - - - - &reftitle.description; - - boolfann_init_weights - resourceann - resourcetrain_data - - - Inicializar los pesos empleando el algoritmo de Widrow + Nguyen. - - - Esta función tiene un comportamiento similar a fann_randomize_weights. Empleará el algoritmo desarrollado por - Derrick Nguyen y Bernard Widrow para establecer los pesos de tal forma que aceleren el entrenamiento. Esta técnica no siempre - funciona, por lo que en algunos casos puede ser menoes eficiente que una simple inicialización aleatoria. - - - El algoritmo requiere el acceso al rango de datos de entrada (por ejemplo, entradas mayores y menores), por lo que - acepta un segundo parámetro, data, que son los datos de entrenamiento que se emplearán para entrenar la red. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - train_data - - &fann.train.description; - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_randomize_weights - fann_read_train_from_file - - - - - - - - diff --git a/reference/fann/functions/fann-length-train-data.xml b/reference/fann/functions/fann-length-train-data.xml deleted file mode 100644 index 0039d3e784..0000000000 --- a/reference/fann/functions/fann-length-train-data.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - fann_length_train_data - Devuelve el número de patrones de entrenamiento de los datos de entrenamiento - - - - &reftitle.description; - - intfann_length_train_data - resourcedata - - - Devuelve el número de patrones de entrenamiento del resource de datos de entrenamiento. - - - - - &reftitle.parameters; - - - data - - &fann.train.description; - - - - - - - &reftitle.returnvalues; - - El número de elementos del resource de datos de entrenamiento, o &false; en caso de error. - - - - - - diff --git a/reference/fann/functions/fann-merge-train-data.xml b/reference/fann/functions/fann-merge-train-data.xml deleted file mode 100644 index e87132a913..0000000000 --- a/reference/fann/functions/fann-merge-train-data.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - fann_merge_train_data - Funde los datos de entrenamiento - - - - &reftitle.description; - - resourcefann_merge_train_data - resourcedata1 - resourcedata2 - - - Funde los datos de data1 y data2 en un nuevo resource de datos de entrenamiento. - - - - - &reftitle.parameters; - - - data1 - - &fann.train.description; - - - - data2 - - &fann.train.description; - - - - - - - &reftitle.returnvalues; - - El nuevo resource de datos de entrenamiento fundido, o &false; en caso de error. - - - - - - diff --git a/reference/fann/functions/fann-num-input-train-data.xml b/reference/fann/functions/fann-num-input-train-data.xml deleted file mode 100644 index a02f84d0cc..0000000000 --- a/reference/fann/functions/fann-num-input-train-data.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - fann_num_input_train_data - Devuelve el número de entradas de cada patrón de entrenamiento de los datos de entrenamiento - - - - &reftitle.description; - - intfann_num_input_train_data - resourcedata - - - Devuelve el número de entradas de cada patrón de entrenamiento del resource de datos de entrenamiento. - - - - - &reftitle.parameters; - - - data - - &fann.train.description; - - - - - - - &reftitle.returnvalues; - - El número de entradas, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_length_train_data - fann_num_output_train_data - - - - - - - - diff --git a/reference/fann/functions/fann-num-output-train-data.xml b/reference/fann/functions/fann-num-output-train-data.xml deleted file mode 100644 index 6caae92022..0000000000 --- a/reference/fann/functions/fann-num-output-train-data.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - fann_num_output_train_data - Devuelve el número de salidas de cada patrón de entrenamiento de los datos de entrenamiento - - - - &reftitle.description; - - intfann_num_output_train_data - resourcedata - - - Devuelve el número de salidas de cada patrón de entrenamiento del resource de datos de entrenamiento. - - - - - &reftitle.parameters; - - - data - - &fann.train.description; - - - - - - - &reftitle.returnvalues; - - El número de salidas, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_length_train_data - fann_num_input_train_data - - - - - - - - diff --git a/reference/fann/functions/fann-print-error.xml b/reference/fann/functions/fann-print-error.xml deleted file mode 100644 index 9058a38049..0000000000 --- a/reference/fann/functions/fann-print-error.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - fann_print_error - Imprime el string de error - - - - &reftitle.description; - - voidfann_print_error - resourceerrdat - - - Imprime el string de error. - - - - - &reftitle.parameters; - - - errdat - - &fann.errdat.description; - - - - - - - &reftitle.returnvalues; - &fann.return.void; - - - - &reftitle.seealso; - - - fann_get_errstr - - - - - - - - diff --git a/reference/fann/functions/fann-randomize-weights.xml b/reference/fann/functions/fann-randomize-weights.xml deleted file mode 100644 index 989bf5e0ea..0000000000 --- a/reference/fann/functions/fann-randomize-weights.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - - fann_randomize_weights - Dar a cada conexión un peso aleatorio entre min_weight y max_weight - - - - &reftitle.description; - - boolfann_randomize_weights - resourceann - floatmin_weight - floatmax_weight - - - Dar a cada conexión un peso aleatorio entre min_weight y max_weight. - - - Desde el comienzo, los pesos son aleatorios, entre -0.1 y 0.1. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - min_weight - - - El valor del peso máximo. - - - - - max_weight - - - El valor del peso mínimo. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_init_weights - - - - - - - - diff --git a/reference/fann/functions/fann-read-train-from-file.xml b/reference/fann/functions/fann-read-train-from-file.xml deleted file mode 100644 index 817144fd94..0000000000 --- a/reference/fann/functions/fann-read-train-from-file.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - - - fann_read_train_from_file - Lee un fichero que almacena datos de entrenamiento - - - - &reftitle.description; - - resourcefann_read_train_from_file - stringfilename - - - Lee un fichero que almacena datos de entrenamiento. - - - - - &reftitle.parameters; - - - filename - - - El fichero de entrada con el siguiente formato: - - - - - - - - - - - &reftitle.returnvalues; - &fann.return.train; - - - - &reftitle.examples; - - - Ejemplo de <methodname>fann_read_train_from_file</methodname> - - -]]> - - Contenido de xor.data - - - - - - - - - &reftitle.seealso; - - - fann_train_on_data - fann_destroy_train - fann_save_train - - - - - - - diff --git a/reference/fann/functions/fann-reset-errno.xml b/reference/fann/functions/fann-reset-errno.xml deleted file mode 100644 index 995b35179c..0000000000 --- a/reference/fann/functions/fann-reset-errno.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - - fann_reset_errno - Reinicia el número del último error - - - - &reftitle.description; - - voidfann_reset_errno - resourceerrdat - - - Reinicia el número del último error. - - - - - &reftitle.parameters; - - - errdat - - &fann.errdat.description; - - - - - - - &reftitle.returnvalues; - &fann.return.void; - - - - &reftitle.seealso; - - - fann_get_errno - fann_reset_errstr - - - - - - - - diff --git a/reference/fann/functions/fann-reset-errstr.xml b/reference/fann/functions/fann-reset-errstr.xml deleted file mode 100644 index 223c98b473..0000000000 --- a/reference/fann/functions/fann-reset-errstr.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - - fann_reset_errstr - Reinicia el string del último error - - - - &reftitle.description; - - voidfann_reset_errstr - resourceerrdat - - - Reinicia el string del último error. - - - - - &reftitle.parameters; - - - errdat - - &fann.errdat.description; - - - - - - - &reftitle.returnvalues; - &fann.return.void; - - - - &reftitle.seealso; - - - fann_get_errstr - fann_reset_errno - - - - - - - - diff --git a/reference/fann/functions/fann-reset-mse.xml b/reference/fann/functions/fann-reset-mse.xml deleted file mode 100644 index b027788d77..0000000000 --- a/reference/fann/functions/fann-reset-mse.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - fann_reset_MSE - Reinicia el error cuadrático medio de la red - - - - &reftitle.description; - - boolfann_reset_MSE - stringann - - - Reinicia el error cuadrático medio de la red. - - - Esta función también reinicia el número de bit que fallan. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_MSE - fann_get_bit_fail - fann_get_bit_fail_limit - - - - - - - diff --git a/reference/fann/functions/fann-run.xml b/reference/fann/functions/fann-run.xml deleted file mode 100644 index 1cd766e6fc..0000000000 --- a/reference/fann/functions/fann-run.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - fann_run - Ejecutará la entrada a través de la red neuronal - - - - &reftitle.description; - - arrayfann_run - resourceann - arrayinput - - - Ejecutará la entrada a través de la red neuronal, devolviendo un array de salidas, el número de las que son - iguales al número de neuronas de la capa de salida. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - input - - - Un array de valores de entrada. - - - - - - - - &reftitle.returnvalues; - - Un array de valores de salida, o &false; en caso de error. - - - - - - diff --git a/reference/fann/functions/fann-save-train.xml b/reference/fann/functions/fann-save-train.xml deleted file mode 100644 index 8d962f429c..0000000000 --- a/reference/fann/functions/fann-save-train.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - fann_save_train - Guarda la estructura de entrenamiento en un fichero - - - - &reftitle.description; - - boolfann_save_train - resourcedata - stringfile_name - - - Guarda la estructura de entrenamiento en un fichero, con el formato especificado en fann_read_train_from_file. - - - - - &reftitle.parameters; - - - data - - &fann.train.description; - - - - file_name - - - El nombre delfichero donde guardar los datos de entrenamiento. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_read_train_from_file - - - - - - - - diff --git a/reference/fann/functions/fann-save.xml b/reference/fann/functions/fann-save.xml deleted file mode 100644 index e23b94a246..0000000000 --- a/reference/fann/functions/fann-save.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - fann_save - Guarda la red completa a un fichero de configuración - - - - &reftitle.description; - - boolfann_save - resourceann - stringconfiguration_file - - - Guarda la red completa a un fichero de configuración. - - - El fichero de configuración contiene toda la información sobre la red neuronal y habilita a - fann_create_from_file para crear una copia exacta de la red neuronal - y de todos los parámetros asociados a dicha red. - - - Estos tres parámetros (fann_set_callback, fann_set_error_log, - fann_set_user_data) NO se guardan en el fichero porque no se pueden llevar a una ubicación - diferente de forma segura. Tampoco se guardan los parámetros temporales generados durante el entrenamiento, - como fann_get_MSE. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - configuration_file - - - La ruta al fichero de configuración. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_create_from_file - - - - - - - - diff --git a/reference/fann/functions/fann-scale-input-train-data.xml b/reference/fann/functions/fann-scale-input-train-data.xml deleted file mode 100644 index 17c8035e3e..0000000000 --- a/reference/fann/functions/fann-scale-input-train-data.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - - - fann_scale_input_train_data - Escala las entradas de los datos de entrenamiento al rango especificado - - - - &reftitle.description; - - boolfann_scale_input_train_data - resourcetrain_data - floatnew_min - floatnew_max - - - Escala las entradas de los datos de entrenamiento al rango especificado. - - - - - &reftitle.parameters; - - - train_data - - &fann.train.description; - - - - new_min - - - El nuevo mínimo después de escalar las entradas de los datos de entrenamiento. - - - - - new_max - - - El nuevo máximo después de escalar las entradas de los datos de entrenamiento. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_scale_output_train_data - fann_scale_train_data - - - - - - - - diff --git a/reference/fann/functions/fann-scale-input.xml b/reference/fann/functions/fann-scale-input.xml deleted file mode 100644 index cf29f3a07b..0000000000 --- a/reference/fann/functions/fann-scale-input.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - fann_scale_input - Escalar datos en un vector de entrada antes de alimentarlo a una RNA basada en parámetros previamente calculados - - - - &reftitle.description; - - boolfann_scale_input - resourceann - arrayinput_vector - - - Escalar datos en un vector de entrada antes de alimentarlo a una RNA basada en parámetros previamente calculados. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - input_vector - - - El vector de entrada a escalar - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_descale_input - fann_scale_output - - - - - - - - diff --git a/reference/fann/functions/fann-scale-output-train-data.xml b/reference/fann/functions/fann-scale-output-train-data.xml deleted file mode 100644 index d18d364bd2..0000000000 --- a/reference/fann/functions/fann-scale-output-train-data.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - - - fann_scale_output_train_data - Escala las salidas de los datos de entrenamiento al rango especificado - - - - &reftitle.description; - - boolfann_scale_output_train_data - resourcetrain_data - floatnew_min - floatnew_max - - - Escala las salidas de los datos de entrenamiento al rango especificado. - - - - - &reftitle.parameters; - - - train_data - - &fann.train.description; - - - - new_min - - - El nuevo mínimo después de escalar las salidas de los datos de entrenamiento. - - - - - new_max - - - El nuevo máximo después de escalar las salidas de los datos de entrenamiento. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_scale_input_train_data - fann_scale_train_data - - - - - - - - diff --git a/reference/fann/functions/fann-scale-output.xml b/reference/fann/functions/fann-scale-output.xml deleted file mode 100644 index 68b531203f..0000000000 --- a/reference/fann/functions/fann-scale-output.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - fann_scale_output - Escalar datos en un vector de entrada antes de alimentarlo a una RNA basada en parámetros previamente calculados - - - - &reftitle.description; - - boolfann_scale_output - resourceann - arrayoutput_vector - - - Escalar datos en un vector de entrada antes de alimentarlo a una RNA basada en parámetros previamente calculados. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - output_vector - - - El vector de salida a escalar - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_descale_output - fann_scale_input - - - - - - - - diff --git a/reference/fann/functions/fann-scale-train-data.xml b/reference/fann/functions/fann-scale-train-data.xml deleted file mode 100644 index dab3f1c90d..0000000000 --- a/reference/fann/functions/fann-scale-train-data.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - - - fann_scale_train_data - Escala la entradas y salidas de los datos de entrenamiento al rango especificado - - - - &reftitle.description; - - boolfann_scale_train_data - resourcetrain_data - floatnew_min - floatnew_max - - - Escala la entradas y salidas de los datos de entrenamiento al rango especificado. - - - - - &reftitle.parameters; - - - train_data - - &fann.train.description; - - - - new_min - - - El nuevo mínimo después de escalar las entradas y salidas de los datos de entrenamiento. - - - - - new_max - - - El nuevo máximo después de escalar las entradas y salidas de los datos de entrenamiento. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_scale_output_train_data - fann_scale_input_train_data - - - - - - - - diff --git a/reference/fann/functions/fann-scale-train.xml b/reference/fann/functions/fann-scale-train.xml deleted file mode 100644 index 9d862f1ac3..0000000000 --- a/reference/fann/functions/fann-scale-train.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - fann_scale_train - Escalar datos de entrada y salida basados en parámetros previamente calculados - - - - &reftitle.description; - - boolfann_scale_train - resourceann - resourcetrain_data - - - Escalar datos de entrada y salida basados en parámetros previamente calculados. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - train_data - - &fann.train.description; - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_descale_train - fann_set_scaling_params - - - - - - - - diff --git a/reference/fann/functions/fann-set-activation-function-hidden.xml b/reference/fann/functions/fann-set-activation-function-hidden.xml deleted file mode 100644 index 67d5d9ddd0..0000000000 --- a/reference/fann/functions/fann-set-activation-function-hidden.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - fann_set_activation_function_hidden - Establece la función de activación para todas las capas ocultas - - - - &reftitle.description; - - boolfann_set_activation_function_hidden - resourceann - intactivation_function - - - Establece la función de activación para todas las capas ocultas. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - activation_function - - - La constante de funciones de activación. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_set_activation_function - fann_set_activation_function_layer - fann_set_activation_function_output - fann_set_activation_steepness - - - - - - - - diff --git a/reference/fann/functions/fann-set-activation-function-layer.xml b/reference/fann/functions/fann-set-activation-function-layer.xml deleted file mode 100644 index 5e37fb694a..0000000000 --- a/reference/fann/functions/fann-set-activation-function-layer.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - fann_set_activation_function_layer - Establece la función de activación para todas las neuronas de la capa proporcionada - - - - &reftitle.description; - - boolfann_set_activation_function_layer - resourceann - intactivation_function - intlayer - - - Establece la función de activación para todas las neuronas de la capa número layer, contanldo la capa de entrada como capa 0. - - - No es posible establecer funciones de activación para las neuronas de la capa de entrada. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - activation_function - - - La constante de funciones de activación. - - - - - layer - - - El número de capa. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_set_activation_function - fann_set_activation_function_hidden - fann_set_activation_function_output - fann_set_activation_steepness - - - - - - - - diff --git a/reference/fann/functions/fann-set-activation-function-output.xml b/reference/fann/functions/fann-set-activation-function-output.xml deleted file mode 100644 index 69d99b3cf6..0000000000 --- a/reference/fann/functions/fann-set-activation-function-output.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - fann_set_activation_function_output - Establece la función de activación para la capa de salida - - - - &reftitle.description; - - boolfann_set_activation_function_output - resourceann - intactivation_function - - - Establece la función de activación para la capa de salida. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - activation_function - - - La constante de funciones de activación. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_set_activation_function - fann_set_activation_function_layer - fann_set_activation_function_hidden - fann_set_activation_steepness - - - - - - - - diff --git a/reference/fann/functions/fann-set-activation-function.xml b/reference/fann/functions/fann-set-activation-function.xml deleted file mode 100644 index c2d59c70d6..0000000000 --- a/reference/fann/functions/fann-set-activation-function.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - - fann_set_activation_function - Establece la función de activación para la neurona y capa proporcionadas - - - - &reftitle.description; - - boolfann_set_activation_function - resourceann - intactivation_function - intlayer - intneuron - - - Establece la función de activación para la neurona número neuron en la capa número - layer, contando al capa de entrada como capa 0. - - - No es posible establecer funciones de activación para las neuronas de la capa de entrada. - - - Al elegir una función de activación, es importante observar que las funciones de activación tienen un rango diferente. - FANN_SIGMOID está, p.ej., en el rango 0 - 1, mientras que FANN_SIGMOID_SYMMETRIC está - en el rango -1 - 1, y FANN_LINEAR no tiene límites. - - - The supplied activation_function value must be - one of the activation functions constants. - - - El valor devuelto es una de las constantes de funciones de activación. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - activation_function - - - La constante de funciones de activación. - - - - - layer - - - El número de capa. - - - - - neuron - - - El número de neurona. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_set_activation_function_layer - fann_set_activation_function_hidden - fann_set_activation_function_output - fann_set_activation_steepness - fann_get_activation_function - - - - - - - - diff --git a/reference/fann/functions/fann-set-activation-steepness-hidden.xml b/reference/fann/functions/fann-set-activation-steepness-hidden.xml deleted file mode 100644 index 870e1f3e16..0000000000 --- a/reference/fann/functions/fann-set-activation-steepness-hidden.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - - fann_set_activation_steepness_hidden - Establece la pendiente de la activación para todas las neuronas de todas las capas ocultas - - - - &reftitle.description; - - boolfann_set_activation_steepness_hidden - resourceann - floatactivation_steepness - - - Establece la pendiente de la activación para todas las neuronas de todas las capas ocultas. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - activation_steepness - - - La pendiente de activación. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_set_activation_steepness - fann_set_activation_steepness_layer - fann_set_activation_steepness_output - fann_get_activation_steepness - fann_set_activation_function - - - - - - - - diff --git a/reference/fann/functions/fann-set-activation-steepness-layer.xml b/reference/fann/functions/fann-set-activation-steepness-layer.xml deleted file mode 100644 index 3767a7eecc..0000000000 --- a/reference/fann/functions/fann-set-activation-steepness-layer.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - - fann_set_activation_steepness_layer - Establece la pendiente de activación para todas las neuronas del número de capa proporcionada - - - - &reftitle.description; - - boolfann_set_activation_steepness_layer - resourceann - floatactivation_steepness - intlayer - - - Establece la pendiente de activación para todas las neuronas de la capa número layer, - contando la capa de entrada como capa 0. - - - No es posible establecer una pendiente de activación en la capa de entrada. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - activation_steepness - - - La pendiente de activación. - - - - - layer - - - El número de capa. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_set_activation_steepness - fann_set_activation_steepness_hidden - fann_set_activation_steepness_output - fann_get_activation_steepness - fann_set_activation_function - - - - - - - - diff --git a/reference/fann/functions/fann-set-activation-steepness-output.xml b/reference/fann/functions/fann-set-activation-steepness-output.xml deleted file mode 100644 index 0e43e83c4e..0000000000 --- a/reference/fann/functions/fann-set-activation-steepness-output.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - - fann_set_activation_steepness_output - Establece la pendiente de activación de la capa de salida - - - - &reftitle.description; - - boolfann_set_activation_steepness_output - resourceann - floatactivation_steepness - - - Establece la pendiente de activación de la capa de salida. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - activation_steepness - - - La pendiente de activación. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_set_activation_steepness - fann_set_activation_steepness_layer - fann_set_activation_steepness_hidden - fann_get_activation_steepness - fann_set_activation_function - - - - - - - - diff --git a/reference/fann/functions/fann-set-activation-steepness.xml b/reference/fann/functions/fann-set-activation-steepness.xml deleted file mode 100644 index cf338e75e1..0000000000 --- a/reference/fann/functions/fann-set-activation-steepness.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - - fann_set_activation_steepness - Establece la pendiente de activación el número de neurona y capa proporcionados - - - - &reftitle.description; - - boolfann_set_activation_steepness - resourceann - floatactivation_steepness - intlayer - intneuron - - - Establece la pendiente de activación en la neurona número neuron de la capa número layer, - contando la capa de entrada como capa 0. - - - No es posible establecer una pendiente de activación en la capa de entrada. - - - La pendiente de una función de activación dice algo sobre cómo de rápido va la función de activación - del mínimo al máximo. Un valor alto para la función de activación proporcionará un entrenamiento más agresivo. - - - Cuando se entrenan redes neuronales donde los valores de salida deberían estar en los extremos - (normalmente 0 y 1, dependiendo de la función de activación), se puede emplear una función de activación (p.ej. 1.0). - - - La pendiente de activación predeterminada es 0.5. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - activation_steepness - - - La pendiente de activación. - - - - - layer - - - El número de capa. - - - - - neuron - - - El número de neurona. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_set_activation_steepness_layer - fann_set_activation_steepness_hidden - fann_set_activation_steepness_output - fann_get_activation_steepness - fann_set_activation_function - - - - - - - - diff --git a/reference/fann/functions/fann-set-bit-fail-limit.xml b/reference/fann/functions/fann-set-bit-fail-limit.xml deleted file mode 100644 index be4b08a2d6..0000000000 --- a/reference/fann/functions/fann-set-bit-fail-limit.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - fann_set_bit_fail_limit - Establece el límite de fallo de bit empleado durante un entrenamiento - - - - &reftitle.description; - - boolfann_set_bit_fail_limit - resourceann - floatbit_fail_limit - - - Establece el límite de fallo de bit empleado durante un entrenamiento. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - bit_fail_limit - - - El límite de fallo de bit. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_bit_fail_limit - - - - - - - diff --git a/reference/fann/functions/fann-set-callback.xml b/reference/fann/functions/fann-set-callback.xml deleted file mode 100644 index 8ceb1e1bcf..0000000000 --- a/reference/fann/functions/fann-set-callback.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - fann_set_callback - Establece la función de retrollamada a emplear durante el entrenamiento - - - - &reftitle.description; - - boolfann_set_callback - resourceann - callablecallback - - - Establece la función de retrollamada a emplear durante el entrenamiento. Esto significa que es llamada desde - fann_train_on_data o fann_train_on_file. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - callback - - - La función de retrollamada proporcionada toma los siguientes parámetros: - - ann - El resource de red neuronal - train - El resource de datos de entrenamiento - o &null; si se llamada desde fann_train_on_file - max_epochs - El número máximo de épocas que debería continuar el entrenamiento - epochs_between_reports - El número de épocas entre llamadas a esta función - desired_error - El fann_get_MSE deseado o - fann_get_bit_fail, dependiendo de la función de parada elegida mediante - fann_set_train_stop_function - epochs - La época actual - - - - La retrollamada debería devolver &true;. Si devuelve &false;, el entrenamiento finalizará. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_train_on_data - fann_train_on_file - - - - - - - - diff --git a/reference/fann/functions/fann-set-cascade-activation-functions.xml b/reference/fann/functions/fann-set-cascade-activation-functions.xml deleted file mode 100644 index 2ff3089231..0000000000 --- a/reference/fann/functions/fann-set-cascade-activation-functions.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - - fann_set_cascade_activation_functions - Establece el array de funciones de activación de candidatas en cascada - - - - &reftitle.description; - - boolfann_set_cascade_activation_functions - resourceann - arraycascade_activation_functions - - - Establece el array de funciones de activación de candidatas en cascada. - - - Véase fann_get_cascade_num_candidates para una descripción de las neuronas candidatas generadas por este array. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_activation_functions - - - El array de funciones de activación de candidatas en cascada. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_cascade_activation_functions_count - fann_set_cascade_activation_functions - - - - - - - - diff --git a/reference/fann/functions/fann-set-cascade-activation-steepnesses.xml b/reference/fann/functions/fann-set-cascade-activation-steepnesses.xml deleted file mode 100644 index 2bb962a179..0000000000 --- a/reference/fann/functions/fann-set-cascade-activation-steepnesses.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - - fann_set_cascade_activation_steepnesses - Establece el array de pendientes de activación de candidatas en cascada - - - - &reftitle.description; - - boolfann_set_cascade_activation_steepnesses - resourceann - arraycascade_activation_steepnesses_count - - - Establece el array de pendientes de activación de candidatas en cascada. - - - Véase fann_get_cascade_num_candidates para una descripción de las neuronas candidatas generadas por este array. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_activation_steepnesses_count - - - El array de pendientes de activación de candidatas en cascada. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_cascade_activation_steepnesses - fann_get_cascade_activation_steepnesses_count - - - - - - - - diff --git a/reference/fann/functions/fann-set-cascade-candidate-change-fraction.xml b/reference/fann/functions/fann-set-cascade-candidate-change-fraction.xml deleted file mode 100644 index ca9f1115ad..0000000000 --- a/reference/fann/functions/fann-set-cascade-candidate-change-fraction.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - fann_set_cascade_candidate_change_fraction - Establece la fracción de cambio de candidatas en cascada - - - - &reftitle.description; - - boolfann_set_cascade_candidate_change_fraction - resourceann - floatcascade_candidate_change_fraction - - - Establece la fracción de cambio de candidatas en cascada. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_candidate_change_fraction - - - La fracción de cambio de candidatas en cascada. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_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 deleted file mode 100644 index d524c96fec..0000000000 --- a/reference/fann/functions/fann-set-cascade-candidate-limit.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - fann_set_cascade_candidate_limit - Establece el límite de candidatas - - - - &reftitle.description; - - boolfann_set_cascade_candidate_limit - resourceann - floatcascade_candidate_limit - - - Establece el límite de candidatas. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_candidate_limit - - - El límite de candidatas. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_cascade_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 deleted file mode 100644 index ffc0fab067..0000000000 --- a/reference/fann/functions/fann-set-cascade-candidate-stagnation-epochs.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - fann_set_cascade_candidate_stagnation_epochs - Establece el número de épocas de estancamiento de candidatas en cascada - - - - &reftitle.description; - - boolfann_set_cascade_candidate_stagnation_epochs - resourceann - intcascade_candidate_stagnation_epochs - - - Establece el número de épocas de estancamiento de candidatas en cascada. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_candidate_stagnation_epochs - - - El número de épocas de estancamiento de candidatas en cascada. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_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 deleted file mode 100644 index b825a07f96..0000000000 --- a/reference/fann/functions/fann-set-cascade-max-cand-epochs.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - fann_set_cascade_max_cand_epochs - Establece el máximo de épocas de candidatas - - - - &reftitle.description; - - boolfann_set_cascade_max_cand_epochs - resourceann - intcascade_max_cand_epochs - - - Establece el máximo de épocas de candidatas. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_max_cand_epochs - - - El máximo de épocas de candidatas. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_cascade_max_cand_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 deleted file mode 100644 index 565f55e731..0000000000 --- a/reference/fann/functions/fann-set-cascade-max-out-epochs.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - fann_set_cascade_max_out_epochs - Establece el máximo de épocas de salida - - - - &reftitle.description; - - boolfann_set_cascade_max_out_epochs - resourceann - intcascade_max_out_epochs - - - Establece el máximo de épocas de salida. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_max_out_epochs - - - El máximo de épocas de salida. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_cascade_max_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 deleted file mode 100644 index e86a219ed9..0000000000 --- a/reference/fann/functions/fann-set-cascade-min-cand-epochs.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - fann_set_cascade_min_cand_epochs - Establece el mínimo de épocas de candidatas - - - - &reftitle.description; - - boolfann_set_cascade_min_cand_epochs - resourceann - intcascade_min_cand_epochs - - - Establece el mínimo de épocas de candidatas. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_min_cand_epochs - - - El máximo de mínimo de candidatas. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_get_cascade_min_cand_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 deleted file mode 100644 index 428453b2fb..0000000000 --- a/reference/fann/functions/fann-set-cascade-min-out-epochs.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - fann_set_cascade_min_out_epochs - Establece el mínimo de épocas de salida - - - - &reftitle.description; - - boolfann_set_cascade_min_out_epochs - resourceann - intcascade_min_out_epochs - - - Establece el mínimo de épocas de salida. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_min_out_epochs - - - El mínimo de épocas de salida. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_get_cascade_min_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 deleted file mode 100644 index 145fd613c4..0000000000 --- a/reference/fann/functions/fann-set-cascade-num-candidate-groups.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - fann_set_cascade_num_candidate_groups - Establece el número de grupos de candidatas - - - - &reftitle.description; - - boolfann_set_cascade_num_candidate_groups - resourceann - intcascade_num_candidate_groups - - - Establece el número de grupos de candidatas. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_num_candidate_groups - - - El número de grupos de candidatas. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_cascade_num_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 deleted file mode 100644 index 7bbc6f242b..0000000000 --- a/reference/fann/functions/fann-set-cascade-output-change-fraction.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - fann_set_cascade_output_change_fraction - Establece la fracción de cambio de salida en cascada - - - - &reftitle.description; - - boolfann_set_cascade_output_change_fraction - resourceann - floatcascade_output_change_fraction - - - Establece la fracción de cambio de salida en cascada. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_output_change_fraction - - - La fracción de cambio de salida en cascada. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_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 deleted file mode 100644 index 3b615bccc0..0000000000 --- a/reference/fann/functions/fann-set-cascade-output-stagnation-epochs.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - fann_set_cascade_output_stagnation_epochs - Establece el número de épocas de estancamiento de salida en cascada - - - - &reftitle.description; - - boolfann_set_cascade_output_stagnation_epochs - resourceann - intcascade_output_stagnation_epochs - - - Establece el número de épocas de estancamiento de salida en cascada. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_output_stagnation_epochs - - - El número de épocas de estancamiento de salida en cascada. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_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 deleted file mode 100644 index 08866809aa..0000000000 --- a/reference/fann/functions/fann-set-cascade-weight-multiplier.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - fann_set_cascade_weight_multiplier - Establece el multiplicador de peso - - - - &reftitle.description; - - boolfann_set_cascade_weight_multiplier - resourceann - floatcascade_weight_multiplier - - - Establece el multiplicador de peso. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - cascade_weight_multiplier - - - El multiplicador de peso. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_cascade_weight_multiplier - - - - - - - - diff --git a/reference/fann/functions/fann-set-error-log.xml b/reference/fann/functions/fann-set-error-log.xml deleted file mode 100644 index ec180b2ae9..0000000000 --- a/reference/fann/functions/fann-set-error-log.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - fann_set_error_log - Establece dónde registrar los errores - - - - &reftitle.description; - - voidfann_set_error_log - resourceerrdat - stringlog_file - - - Establece dónde registrar los errores. - - - - - &reftitle.parameters; - - - errdat - - &fann.errdat.description; - - - - log_file - - - La ruta al fichero de registro. - - - - - - - - &reftitle.returnvalues; - &fann.return.void; - - - - - diff --git a/reference/fann/functions/fann-set-input-scaling-params.xml b/reference/fann/functions/fann-set-input-scaling-params.xml deleted file mode 100644 index 481869e1a4..0000000000 --- a/reference/fann/functions/fann-set-input-scaling-params.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - - fann_set_input_scaling_params - Calcular los parámetros de escala de entrada para un uso futuro basados en datos de entrenamiento - - - - &reftitle.description; - - boolfann_set_input_scaling_params - resourceann - resourcetrain_data - floatnew_input_min - floatnew_input_max - - - Calcular los parámetros de escala de entrada para un uso futuro basados en datos de entrenamiento. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - train_data - - &fann.train.description; - - - - new_input_min - - - El límite inferior deseado de los datos de entrada después de escalar (no seguido estrictamente) - - - - - new_input_max - - - El límite superior deseado de los datos de entrada después de escalar (no seguido estrictamente) - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_set_output_scaling_params - - - - - - - - diff --git a/reference/fann/functions/fann-set-learning-momentum.xml b/reference/fann/functions/fann-set-learning-momentum.xml deleted file mode 100644 index e951f0ba6a..0000000000 --- a/reference/fann/functions/fann-set-learning-momentum.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - - fann_set_learning_momentum - Establece el momento del aprendizaje - - - - &reftitle.description; - - boolfann_set_learning_momentum - resourceann - floatlearning_momentum - - - Establece el momento del aprendizaje. - - - Hay más información disponible en fann_get_learning_momentum. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - learning_momentum - - - El momento del aprendizaje - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_learning_momentum - fann_set_training_algorithm - - - - - - - - diff --git a/reference/fann/functions/fann-set-learning-rate.xml b/reference/fann/functions/fann-set-learning-rate.xml deleted file mode 100644 index 61a8527047..0000000000 --- a/reference/fann/functions/fann-set-learning-rate.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - - fann_set_learning_rate - Establece el índice de aprendizaje - - - - &reftitle.description; - - boolfann_set_learning_rate - resourceann - floatlearning_rate - - - Establece el índice de aprendizaje. - - - Hay más información en fann_get_learning_rate. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - learning_rate - - - El índice de aprendizaje. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_learning_rate - fann_set_training_algorithm - - - - - - - - diff --git a/reference/fann/functions/fann-set-output-scaling-params.xml b/reference/fann/functions/fann-set-output-scaling-params.xml deleted file mode 100644 index fc3ec7280a..0000000000 --- a/reference/fann/functions/fann-set-output-scaling-params.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - - fann_set_output_scaling_params - Calcular los parámetros de escala de salida para un uso futuro basados en datos de entrenamiento - - - - &reftitle.description; - - boolfann_set_output_scaling_params - resourceann - resourcetrain_data - floatnew_output_min - floatnew_output_max - - - Calcular los parámetros de escala de salida para un uso futuro basados en datos de entrenamiento. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - train_data - - &fann.train.description; - - - - new_output_min - - - El límite inferior deseado de los datos de salida después de escalar (no seguido estrictamente) - - - - - new_output_max - - - El límite superior deseado de los datos de salida después de escalar (no seguido estrictamente) - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_set_input_scaling_params - - - - - - - - diff --git a/reference/fann/functions/fann-set-quickprop-decay.xml b/reference/fann/functions/fann-set-quickprop-decay.xml deleted file mode 100644 index 6020e366aa..0000000000 --- a/reference/fann/functions/fann-set-quickprop-decay.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - fann_set_quickprop_decay - Establece el factor de decadencia de quickprop - - - - &reftitle.description; - - boolfann_set_quickprop_decay - resourceann - floatquickprop_decay - - - Establece el factor de decadencia de quickprop. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - quickprop_decay - - - El factor de decadencia de quickprop. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_quickprop_decay - - - - - - - - diff --git a/reference/fann/functions/fann-set-quickprop-mu.xml b/reference/fann/functions/fann-set-quickprop-mu.xml deleted file mode 100644 index dae7b5aea7..0000000000 --- a/reference/fann/functions/fann-set-quickprop-mu.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - fann_set_quickprop_mu - Establece el factor mu de quickprop - - - - &reftitle.description; - - boolfann_set_quickprop_mu - resourceann - floatquickprop_mu - - - Establece el factor mu de quickprop. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - quickprop_mu - - - El factor mu. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_quickprop_mu - - - - - - - - diff --git a/reference/fann/functions/fann-set-rprop-decrease-factor.xml b/reference/fann/functions/fann-set-rprop-decrease-factor.xml deleted file mode 100644 index 2b6856cc00..0000000000 --- a/reference/fann/functions/fann-set-rprop-decrease-factor.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - fann_set_rprop_decrease_factor - Establece el factor de disminución empleado durante un entrenamiento RPROP - - - - &reftitle.description; - - boolfann_set_rprop_decrease_factor - resourceann - floatrprop_decrease_factor - - - Establece el factor de disminución empleado durante un entrenamiento RPROP. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - rprop_decrease_factor - - - El factor de disminución. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_rprop_decrease_factor - - - - - - - - diff --git a/reference/fann/functions/fann-set-rprop-delta-max.xml b/reference/fann/functions/fann-set-rprop-delta-max.xml deleted file mode 100644 index 43e0664eaf..0000000000 --- a/reference/fann/functions/fann-set-rprop-delta-max.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - fann_set_rprop_delta_max - Establece el tamaño de paso máximo - - - - &reftitle.description; - - boolfann_set_rprop_delta_max - resourceann - floatrprop_delta_max - - - El tamaño de paso máximo es un número positivo que determina lo grande que podría ser el tamaño de paso máximo. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - rprop_delta_max - - - El tamaño de paso máximo. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_rprop_delta_max - fann_get_rprop_delta_min - - - - - - - - diff --git a/reference/fann/functions/fann-set-rprop-delta-min.xml b/reference/fann/functions/fann-set-rprop-delta-min.xml deleted file mode 100644 index 0587898279..0000000000 --- a/reference/fann/functions/fann-set-rprop-delta-min.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - fann_set_rprop_delta_min - Establece el tamaño de paso mínimo - - - - &reftitle.description; - - boolfann_set_rprop_delta_min - resourceann - floatrprop_delta_min - - - El tamaño de paso mínimo es un número positivo pequeño que determina lo pequeño que podría ser el tamaño de paso mínimo. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - rprop_delta_min - - - El tamaño de paso mínimo. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_rprop_delta_min - - - - - - - - diff --git a/reference/fann/functions/fann-set-rprop-delta-zero.xml b/reference/fann/functions/fann-set-rprop-delta-zero.xml deleted file mode 100644 index 22b6372a3c..0000000000 --- a/reference/fann/functions/fann-set-rprop-delta-zero.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - fann_set_rprop_delta_zero - Establece el tamaño de paso inicial - - - - &reftitle.description; - - boolfann_set_rprop_delta_zero - resourceann - floatrprop_delta_zero - - - El tamaño de paso inicial es un número positivo que determina el tamaño de paso inicial. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - rprop_delta_zero - - - El tamaño de paso inicial. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_rprop_delta_zero - fann_get_rprop_delta_min - fann_get_rprop_delta_max - - - - - - - - diff --git a/reference/fann/functions/fann-set-rprop-increase-factor.xml b/reference/fann/functions/fann-set-rprop-increase-factor.xml deleted file mode 100644 index 2f990589a7..0000000000 --- a/reference/fann/functions/fann-set-rprop-increase-factor.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - fann_set_rprop_increase_factor - Establece el factor de aumento empleado durante un entrenamiento RPROP - - - - &reftitle.description; - - boolfann_set_rprop_increase_factor - resourceann - floatrprop_increase_factor - - - Establece el factor de aumento empleado durante un entrenamiento RPROP. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - rprop_increase_factor - - - El aumento de disminución. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_rprop_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 deleted file mode 100644 index 6db185f649..0000000000 --- a/reference/fann/functions/fann-set-sarprop-step-error-shift.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - fann_set_sarprop_step_error_shift - Establece el desplazamiento del error de paso de sarprop - - - - &reftitle.description; - - boolfann_set_sarprop_step_error_shift - resourceann - floatsarprop_step_error_shift - - - Establece el desplazamiento del error de paso de sarprop. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - sarprop_step_error_shift - - - El desplazamiento del error de paso de sarprop. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_get_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 deleted file mode 100644 index d434369994..0000000000 --- a/reference/fann/functions/fann-set-sarprop-step-error-threshold-factor.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - fann_set_sarprop_step_error_threshold_factor - Establece el factor de umbral del error de paso de sarprop - - - - &reftitle.description; - - boolfann_set_sarprop_step_error_threshold_factor - resourceann - floatsarprop_step_error_threshold_factor - - - Establece el factor de umbral del error de paso de sarprop. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - sarprop_step_error_threshold_factor - - - El factor de umbral del error de paso de sarprop. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_get_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 deleted file mode 100644 index 0e8c159c1d..0000000000 --- a/reference/fann/functions/fann-set-sarprop-temperature.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - fann_set_sarprop_temperature - Establece la temperatura de sarprop - - - - &reftitle.description; - - boolfann_set_sarprop_temperature - resourceann - floatsarprop_temperature - - - Establece la temperatura de sarprop. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - sarprop_temperature - - - La temperatura de sarprop. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_get_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 deleted file mode 100644 index 1d7a1e55c7..0000000000 --- a/reference/fann/functions/fann-set-sarprop-weight-decay-shift.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - fann_set_sarprop_weight_decay_shift - Establece el desplazamiento de decadencia del peso de sarprop - - - - &reftitle.description; - - boolfann_set_sarprop_weight_decay_shift - resourceann - floatsarprop_weight_decay_shift - - - Establece el desplazamiento de decadencia del peso de sarprop. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - sarprop_weight_decay_shift - - - El desplazamiento de decadencia del peso de sarprop. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.notes; - &fann.note.function.fann-2.2; - - - - &reftitle.seealso; - - - fann_get_sarprop_weight_decay_shift - - - - - - - - diff --git a/reference/fann/functions/fann-set-scaling-params.xml b/reference/fann/functions/fann-set-scaling-params.xml deleted file mode 100644 index b21e22bc8a..0000000000 --- a/reference/fann/functions/fann-set-scaling-params.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - - - fann_set_scaling_params - Calcular los parámetros de escala de entrada y salida para un uso futuro basados en datos de entrenamiento - - - - &reftitle.description; - - boolfann_set_scaling_params - resourceann - resourcetrain_data - floatnew_input_min - floatnew_input_max - floatnew_output_min - floatnew_output_max - - - Calcular los parámetros de escala de entradas y salidas para un uso futuro basados en datos de entrenamiento. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - train_data - - &fann.train.description; - - - - new_input_min - - - El límite inferior deseado de los datos de entrada después de escalar (no seguido estrictamente) - - - - - new_input_max - - - El límite superior deseado de los datos de entrada después de escalar (no seguido estrictamente) - - - - - new_output_min - - - El límite inferior deseado de los datos de salida después de escalar (no seguido estrictamente) - - - - - new_output_max - - - El límite superior deseado de los datos de salida después de escalar (no seguido estrictamente) - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_set_input_scaling_params - fann_set_output_scaling_params - - - - - - - - diff --git a/reference/fann/functions/fann-set-train-error-function.xml b/reference/fann/functions/fann-set-train-error-function.xml deleted file mode 100644 index 09cec202a3..0000000000 --- a/reference/fann/functions/fann-set-train-error-function.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - fann_set_train_error_function - Establecer la función de error empleada durante un entrenamiento - - - - &reftitle.description; - - boolfann_set_train_error_function - resourceann - interror_function - - - Establecer la función de error empleada durante un entrenamiento. - - - Las funciones de error están descritas en las constantes de funciones de error. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - error_function - - - La constante de función de error . - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_train_error_function - - - - - - - - diff --git a/reference/fann/functions/fann-set-train-stop-function.xml b/reference/fann/functions/fann-set-train-stop-function.xml deleted file mode 100644 index 4c3fb0daf2..0000000000 --- a/reference/fann/functions/fann-set-train-stop-function.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - fann_set_train_stop_function - Establece la función de parada empleada durante el entrenamiento - - - - &reftitle.description; - - boolfann_set_train_stop_function - resourceann - intstop_function - - - Establece la función de parada empleada durante el entrenamiento. - - - Las funciones de parada están descritas en las constantes de funciones de parada. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - stop_function - - - La constante de función de parada. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_train_stop_function - - - - - - - - diff --git a/reference/fann/functions/fann-set-training-algorithm.xml b/reference/fann/functions/fann-set-training-algorithm.xml deleted file mode 100644 index 2d3940843a..0000000000 --- a/reference/fann/functions/fann-set-training-algorithm.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - fann_set_training_algorithm - Establece el algoritmo de entrenamiento - - - - &reftitle.description; - - boolfann_set_training_algorithm - resourceann - inttraining_algorithm - - - Establece el algoritmo de entrenamiento. - - - Hay más información disponible en fann_get_training_algorithm. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - training_algorithm - - - La constante de Algoritno de entrenamiento. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_get_training_algorithm - - - - - - - - diff --git a/reference/fann/functions/fann-set-weight-array.xml b/reference/fann/functions/fann-set-weight-array.xml deleted file mode 100644 index 1e8daaf2d8..0000000000 --- a/reference/fann/functions/fann-set-weight-array.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - fann_set_weight_array - Establecer las conexiones de la red - - - - &reftitle.description; - - boolfann_set_weight_array - resourceann - arrayconnections - - - Establecer las conexiones de la red. - - - Solamente se pueden cambiar los pesos. Las conexiones y los pesos se ignoran si no existen en la red. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - connections - - - Un array de objetos FANNConnection - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - - - diff --git a/reference/fann/functions/fann-set-weight.xml b/reference/fann/functions/fann-set-weight.xml deleted file mode 100644 index 44dbb741ef..0000000000 --- a/reference/fann/functions/fann-set-weight.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - - fann_set_weight - Establecer una conexión de la red - - - - &reftitle.description; - - boolfann_set_weight - resourceann - intfrom_neuron - intto_neuron - floatweight - - - Establecer una conexión de la red. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - from_neuron - - - La neurona donde empiza la conexión. - - - - - to_neuron - - - La neurona donde finaliza la conexión. - - - - - weight - - - El peso de la conexión. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - - - diff --git a/reference/fann/functions/fann-shuffle-train-data.xml b/reference/fann/functions/fann-shuffle-train-data.xml deleted file mode 100644 index dd5c926c53..0000000000 --- a/reference/fann/functions/fann-shuffle-train-data.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - - fann_shuffle_train_data - Mezcla los datos de entrenamiento, aleatorizando el orden - - - - &reftitle.description; - - boolfann_shuffle_train_data - resourcetrain_data - - - Mezcla los datos de entrenamiento, aleatorizando el orden. Es lo recomendado para entrenamientos incrementales, - mientras que no tiene influencia durante entrenamientos por lotes. - - - - - &reftitle.parameters; - - - train_data - - &fann.train.description; - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - - diff --git a/reference/fann/functions/fann-subset-train-data.xml b/reference/fann/functions/fann-subset-train-data.xml deleted file mode 100644 index 7cb7f5979e..0000000000 --- a/reference/fann/functions/fann-subset-train-data.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - fann_subset_train_data - Devuelve una copia de un subconjunto de los datos de entrenamiento - - - - &reftitle.description; - - resourcefann_subset_train_data - resourcedata - intpos - intlength - - - Devuelve una copia de un subconjunto del resource de datos de entrenamiento, empezando en la posición - pos y con length elementos hacia adelante. - - - fann_subset_train_data(train_data, 0, fann_length_train_data(train_data)) hace lo mismo que - fann_duplicate_train_data - - - - - &reftitle.parameters; - - - data - - &fann.train.description; - - - - pos - - - La posición de inicio. - - - - - length - - - El número de elementos a copiar. - - - - - - - - &reftitle.returnvalues; - &fann.return.train; - - - - &reftitle.seealso; - - - fann_duplicate_train_data - - - - - - - - diff --git a/reference/fann/functions/fann-test-data.xml b/reference/fann/functions/fann-test-data.xml deleted file mode 100644 index 5c83485ebb..0000000000 --- a/reference/fann/functions/fann-test-data.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - - fann_test_data - Prueba un conjunto de datos de entrenamiento y calcula el ECM de dichos datos - - - - &reftitle.description; - - floatfann_test_data - resourceann - resourcedata - - - Prueba un conjunto de datos de entrenamiento y calcula el ECM de dichos datos. - - - Esta función actualiza el ECM y los valores de fallo de bit. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - data - - &fann.train.description; - - - - - - - &reftitle.returnvalues; - - El ECM actualizado, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_train_on_data - fann_train_epoch - fann_get_bit_fail - fann_get_MSE - fann_set_training_algorithm - - - - - - - - diff --git a/reference/fann/functions/fann-test.xml b/reference/fann/functions/fann-test.xml deleted file mode 100644 index 1039c7eaad..0000000000 --- a/reference/fann/functions/fann-test.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - - fann_test - Realiza una prueba con un conjunto de entradas y un conjunto de salidas deseadas - - - - &reftitle.description; - - arrayfann_test - resourceann - arrayinput - arraydesired_output - - - Realiza una prueba con un conjunto de entradas y un conjunto de salidas deseadas. - Esta operación actualiza el error cuadrático medio, pero - no modifica de ninguna manera la red. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - input - - - Un array de entradas. Este array debe tener una longitud exacta - de fann_get_num_input. - - - - - desired_output - - - Un array de salidas deseadas. Este array debe tener una longitud exacta - de fann_get_num_output. - - - - - - - - &reftitle.returnvalues; - Devuelve las salidas de prueba en caso de éxito, o &false; en caso de error. - - - - &reftitle.seealso; - - - fann_test_data - fann_train - fann_get_num_input - fann_get_num_output - - - - - - - diff --git a/reference/fann/functions/fann-train-epoch.xml b/reference/fann/functions/fann-train-epoch.xml deleted file mode 100644 index 89dbe90919..0000000000 --- a/reference/fann/functions/fann-train-epoch.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - fann_train_epoch - Entrenar una época con un conjunto de datos de entrenamiento - - - - &reftitle.description; - - floatfann_train_epoch - resourceann - resourcedata - - - Entrena una época con los datos de entrenamiento almacenados en data. Una época es - donde todos los datos de entrenamiento son considerados exactamente una vez. - - - Esta función devuelve el ECM tal como es calculado antes o durante el entrenamiento real. - No es el ECM real después de la época de entrenamiento, pero como calcularlo requeriría atravesar - el conjunto de entrenamiento completo una vez más, el empleo de este valor durante el entrenamiento es más que adecuado. - - - El algoritmo de entrenaiento empleado por esta función se elige mediante la función - fann_set_training_algorithm. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - data - - &fann.train.description; - - - - - - - &reftitle.returnvalues; - - El ECM, o &false; en caso de error. - - - - - &reftitle.seealso; - - - fann_train_on_data - fann_test_data - fann_get_MSE - fann_set_training_algorithm - - - - - - - - diff --git a/reference/fann/functions/fann-train-on-data.xml b/reference/fann/functions/fann-train-on-data.xml deleted file mode 100644 index dfc613cd6f..0000000000 --- a/reference/fann/functions/fann-train-on-data.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - - fann_train_on_data - Entrena un conjunto de datos completo por un período de tiempo - - - - &reftitle.description; - - boolfann_train_on_data - resourceann - resourcedata - intmax_epochs - intepochs_between_reports - floatdesired_error - - - Entrena un conjunto de datos completo por un período de tiempo. - - - Este entrenamiento emplea el algoritmo de entrenamiento elegido mediante fann_set_training_algorithm y - los parámetros establecidos para estos algoritmos de entrenamiento. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - data - - &fann.train.description; - - - - max_epochs - - - El número máximo de épocas que debería continuar el entrenamiento. - - - - - epochs_between_reports - - - El número de épocas entre llamadas a funciones de retrollamada. Un valor de cero significa que no se llamará a la función del usuario. - - - - - desired_error - - - El fann_get_MSE o fann_get_bit_fail deseados, dependiendo de la función de parada - elegida mediante fann_set_train_stop_function. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_train_on_file - fann_train_epoch - fann_get_bit_fail - fann_get_MSE - fann_set_train_stop_function - fann_set_training_algorithm - fann_set_callback - - - - - - - - diff --git a/reference/fann/functions/fann-train-on-file.xml b/reference/fann/functions/fann-train-on-file.xml deleted file mode 100644 index ca395039aa..0000000000 --- a/reference/fann/functions/fann-train-on-file.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - - - fann_train_on_file - Entrena un conjunto de datos completo leído desde un fichero, por un período de tiempo - - - - &reftitle.description; - - boolfann_train_on_file - resourceann - stringfilename - intmax_epochs - intepochs_between_reports - floatdesired_error - - - Entrena un conjunto de datos completo leído desde un fichero, por un período de tiempo. - - - Este entrenamiento emplea el algoritmo de entrenamiento elegido mediante fann_set_training_algorithm y - los parámetros establecidos para estos algoritmos de entrenamiento. - - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - filename - - - El fichero que contiene los datos de entrenamiento. - - - - - max_epochs - - - El número máximo de épocas que debería continuar el entrenamiento. - - - - - epochs_between_reports - - - El número de épocas entre llamadas a funciones de retrollamada. Un valor de cero significa que no se llamará a la función del usuario. - - - - - desired_error - - - El fann_get_MSE o fann_get_bit_fail deseados, dependiendo de la función de parada - elegida mediante fann_set_train_stop_function. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_train_on_data - fann_train_epoch - fann_get_bit_fail - fann_get_MSE - fann_set_train_stop_function - fann_set_training_algorithm - fann_set_callback - - - - - - - - diff --git a/reference/fann/functions/fann-train.xml b/reference/fann/functions/fann-train.xml deleted file mode 100644 index 46c9f3ad24..0000000000 --- a/reference/fann/functions/fann-train.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - - fann_train - Entrenar una iteración con un conjunto de entradas y un conjunto de salidas deseadas - - - - &reftitle.description; - - boolfann_train - resourceann - arrayinput - arraydesired_output - - - Entrenar una iteración con un conjunto de entradas y un conjunto de salidas deseadas. Este entrenamiento siempre es incremental, - ya que solamente está presente un patrón. - - - - - &reftitle.parameters; - - - ann - - &fann.ann.description; - - - - input - - - Un array de entradas. Este array debe ser exactamente de fann_get_num_input de longitud. - - - - - desired_output - - - Un array de salidas deseadas. Este array debe ser exactamente de fann_get_num_output de longitud. - - - - - - - - &reftitle.returnvalues; - &fann.return.bool; - - - - &reftitle.seealso; - - - fann_train_on_data - fann_train_epoch - fann_get_num_input - fann_get_num_output - - - - - - - - diff --git a/reference/fann/reference.xml b/reference/fann/reference.xml deleted file mode 100644 index c6cb3f0a55..0000000000 --- a/reference/fann/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - &Functions; de Fann - - &reference.fann.entities.functions; - - - - diff --git a/reference/fann/setup.xml b/reference/fann/setup.xml deleted file mode 100644 index 0cd645e1e0..0000000000 --- a/reference/fann/setup.xml +++ /dev/null @@ -1,187 +0,0 @@ - - - - - &reftitle.setup; - -
- &reftitle.required; - - PHP >= 5.2.0 y libfann >= 2.1.0 - -
- -
- &reftitle.install; - - La extensión FANN PHP debería funcionar en todos los sistemas Linux. - - - - - - - - - - - - - - -
- - Instalación de la biblioteca FANN - - - Antes de comenzar la instalación, asegúrese de que libfann esté instalado - en su sistema. Forma parte del repositorio principal en la mayoría de las distribuciones Linux - (busque fann). Se necesita una versión de desarrollo. - - - Si no está instalado, debe instalarse primero. Descárguelo desde el - sitio oficial o obténgalo desde el repositorio de su - distribución. Por ejemplo en Fedora: - - - - o en Ubuntu: - - - - - - Si la biblioteca se reinstala manualmente, entonces todos los archivos antiguos de la biblioteca - deben eliminarse antes de reinstalar, de lo contrario podría vincularse la versión antigua de la biblioteca. - -
- -
- - Instalación PECL - - - Esta extensión está disponible en PECL. La instalación es muy sencilla. Ejecute simplemente: - - - - -
- -
- - Manual de instalación - - - Para los desarrolladores y las personas interesadas en los últimos cambios, se - puede compilar el controlador a partir del código fuente más reciente en - Github. - Vaya a Github y haga clic en el botón "Download ZIP". Luego ejecute: - - - - - - - - Aplique los siguientes cambios a php.ini: - - - - - Asegúrese de que la variable extension_dir apunte hacia - el directorio que contiene fann.so. La construcción mostrará dónde - instala el controlador PHP con una salida que se parece a: - - - - - Asegúrese de que sea el mismo que el directorio de extensión PHP ejecutando: - - - /usr/lib/php/extensions/no-debug-non-zts-20060613 => - /usr/lib/php/extensions/no-debug-non-zts-20060613 - -]]> - - - Si no es así, cambie la variable extension_dir en php.ini o - mueva fann.so. - - - - - Para cargar la extensión al iniciar PHP, añada una línea: - - - - - - - - - -
-
- -
- &reftitle.resources; - - - -
- -
- - diff --git a/reference/fdf/book.xml b/reference/fdf/book.xml deleted file mode 100644 index 72b9c45f5b..0000000000 --- a/reference/fdf/book.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - Formato de formulario - FDF - - - - &reftitle.intro; - - Forms Data Format (FDF) es un formato de formulario para documentos - PDF. La documentación (en inglés) puede ser leída en - &spec.pdf.fdf; - para más detalles sobre los pormenores. - - - El espíritu de FDF es similar al de los formularios HTML. Las - diferencias radican en los medios de transmisión de los - datos al servidor, cuando el botón "submit" (enviar) es - presionado (lo cual es del ámbito de Form Data Format) y el formato de - formulario en sí mismo (que es más bien del ámbito de Portable Document - Format, PDF). Gestionar datos FDF es uno de los objetivos de las - funciones FDF. Pero hay otros. También es posible tomar un - formulario PDF y prellenar los campos sin modificar el - formulario en sí. En este caso, se creará un documento FDF - (fdf_create), se llenarán los campos - (fdf_set_value) y se asociará a un fichero PDF - (fdf_set_file). Finalmente, todo será enviado - al cliente, con el tipo MIME application/vnd.fdf. El módulo "Acrobat reader" - del navegador reconocerá este tipo MIME y leerá el fichero - PDF, luego lo llenará con FDF. - - - - Si se edita un fichero FDF con un editor de texto, se encontrará - un catálogo de objetos con el nombre de FDF. Este objeto - puede contener entradas tales como Fields, - F, Status etc. - Las entradas más comúnmente utilizadas son - Fields, que indica una lista de campos de control, - y F que contiene el nombre del fichero PDF al que - pertenecen estos datos. Estas entradas son designadas en la documentación - PDF bajo el nombre de /F-Key o /Status-Key. - La modificación de estas entradas es posible con las funciones - fdf_set_file y fdf_set_status. - Los campos son modificables con las funciones - fdf_set_value, fdf_set_opt etc. - - - - - &reference.fdf.setup; - &reference.fdf.constants; - &reference.fdf.examples; - &reference.fdf.reference; - - - - diff --git a/reference/fdf/configure.xml b/reference/fdf/configure.xml deleted file mode 100644 index c7a28e9ccd..0000000000 --- a/reference/fdf/configure.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - -
- &reftitle.install; - - &pecl.info.dead; - &url.pecl.vcs;fdf. - - - Esta extensión ya no se proporciona con PHP. - - - - Si se encuentran problemas durante la configuración de FDF con soporte fdftk, verifique que el fichero de encabezado - fdftk.h y la biblioteca - libfdftk.so estén en su lugar. El script - configure soporta la jerarquía de directorios de la distribución - FDF SDK y la organización clásica DIR/include y - DIR/lib: por lo tanto, se puede utilizar uno u otro - directamente con la distribución descomprimida, o bien incluyendo el - fichero de encabezado y la biblioteca apropiada en su sistema, es decir, - en /usr/local/include y - /usr/local/lib. Solo queda configurar - con . - - - - Nota para usuarios Win32 - - &ext.windows.path.dll; - fdftk.dll - - -
- diff --git a/reference/fdf/constants.xml b/reference/fdf/constants.xml deleted file mode 100644 index 8f25b5bc08..0000000000 --- a/reference/fdf/constants.xml +++ /dev/null @@ -1,329 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - - - FDFValue - (int) - - - - - - - - - - FDFStatus - (int) - - - - - - - - - - FDFFile - (int) - - - - - - - - - - FDFID - (int) - - - - - - - - - - FDFFf - (int) - - - - - - - - - - FDFSetFf - (int) - - - - - - - - - - FDFClearFf - (int) - - - - - - - - - - FDFFlags - (int) - - - - - - - - - - FDFSetF - (int) - - - - - - - - - - FDFClrF - (int) - - - - - - - - - - FDFAP - (int) - - - - - - - - - - FDFAS - (int) - - - - - - - - - - FDFAction - (int) - - - - - - - - - - FDFAA - (int) - - - - - - - - - - FDFAPRef - (int) - - - - - - - - - - FDFIF - (int) - - - - - - - - - - FDFEnter - (int) - - - - - - - - - - FDFExit - (int) - - - - - - - - - - FDFDown - (int) - - - - - - - - - - FDFUp - (int) - - - - - - - - - - FDFFormat - (int) - - - - - - - - - - FDFValidate - (int) - - - - - - - - - - FDFKeystroke - (int) - - - - - - - - - - FDFCalculate - (int) - - - - - - - - - - FDFNormalAP - (int) - - - - - - - - - - FDFRolloverAP - (int) - - - - - - - - - - FDFDownAP - (int) - - - - - - - - - - - diff --git a/reference/fdf/examples.xml b/reference/fdf/examples.xml deleted file mode 100644 index 7b260eb2df..0000000000 --- a/reference/fdf/examples.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - &reftitle.examples; - - Los siguientes ejemplos muestran cómo evaluar los datos - del formulario. - - Evaluar un documento FDF - -' . $volume . '"
'; - -$date = fdf_get_value($fdf, "date"); -echo 'El valor del campo date era "' . $date . '"
'; - -$comment = fdf_get_value($fdf, "comment"); -echo 'El valor del campo comment era "' . $comment . '"
'; - -if (fdf_get_value($fdf, "show_publisher") == "On") { - $publisher = fdf_get_value($fdf, "publisher"); - echo "El valor del campo Publisher era: '" . $publisher . "
"; -} else - echo 'El valor del campo Publisher no debe ser mostrado.
'; - -if (fdf_get_value($fdf, "show_preparer") == "On") { - $preparer = fdf_get_value($fdf, "preparer"); - echo 'El valor del campo Preparer era "' . $preparer . '"
'; -} else - echo 'El valor del campo Preparer no debe ser mostrado.
'; -fdf_close($fdf); -?> -]]> -
-
-
-
- - diff --git a/reference/fdf/functions/fdf-add-doc-javascript.xml b/reference/fdf/functions/fdf-add-doc-javascript.xml deleted file mode 100644 index d419d6449a..0000000000 --- a/reference/fdf/functions/fdf-add-doc-javascript.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - - fdf_add_doc_javascript - Añade código javascript a un documento FDF - - - - &reftitle.description; - - boolfdf_add_doc_javascript - resourcefdf_document - stringscript_name - stringscript_code - - - Añade el código javascript script_code - al documento fdfdoc, que Acrobat añadirá a los scripts de - nivel de documento, una vez importado el FDF. - - - - - &reftitle.parameters; - - - fdf_document - - - El gestor de documento FDF, devuelto por la función - fdf_create, la función - fdf_open o la función - fdf_open_string. - - - - - script_name - - - El nombre del script. - - - - - script_code - - - El código del script. Se recomienda encarecidamente utilizar '\r' como - separador de líneas en el código script_code. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Adición de código JavaScript a un documento FDF - - -]]> - - - Este ejemplo creará un documento FDF como el siguiente: - - -> >> ->> -endobj -trailer -<< -/Root 1 0 R - ->> -%%EOF -]]> - - - - - - diff --git a/reference/fdf/functions/fdf-add-template.xml b/reference/fdf/functions/fdf-add-template.xml deleted file mode 100644 index 7bbadbc04d..0000000000 --- a/reference/fdf/functions/fdf-add-template.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - - - fdf_add_template - Añade una plantilla en el documento FDF - - - - &reftitle.description; - - boolfdf_add_template - resourcefdf_document - intnewpage - stringfilename - stringtemplate - intrename - - &warn.undocumented.func; - - - - - diff --git a/reference/fdf/functions/fdf-close.xml b/reference/fdf/functions/fdf-close.xml deleted file mode 100644 index c09c9937e2..0000000000 --- a/reference/fdf/functions/fdf-close.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - fdf_close - Cierra un documento FDF - - - - &reftitle.description; - - voidfdf_close - resourcefdf_document - - - Cierra el documento FDF. - - - - - &reftitle.parameters; - - - fdf_document - - - El gestor de documento FDF, devuelto por la función - fdf_create, la función - fdf_open o la función - fdf_open_string. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - fdf_open - - - - diff --git a/reference/fdf/functions/fdf-create.xml b/reference/fdf/functions/fdf-create.xml deleted file mode 100644 index fc59e2a72a..0000000000 --- a/reference/fdf/functions/fdf-create.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - fdf_create - Crea un nuevo documento FDF - - - - &reftitle.description; - - resourcefdf_create - - - - Crea un nuevo documento FDF. - - - Esta función es necesaria para aquellos que desean prellenar - los campos de un formulario en un fichero PDF. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un gestor de documento FDF, o &false; - si ocurre un error. - - - - - &reftitle.examples; - - Prellemar un formulario PDF - - -]]> - - - - - - &reftitle.seealso; - - fdf_close - fdf_save - fdf_open - - - - - diff --git a/reference/fdf/functions/fdf-enum-values.xml b/reference/fdf/functions/fdf-enum-values.xml deleted file mode 100644 index 4085f9adf7..0000000000 --- a/reference/fdf/functions/fdf-enum-values.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - - fdf_enum_values - Llama a una función de usuario para cada valor FDF - - - - &reftitle.description; - - boolfdf_enum_values - resourcefdf_document - callablefunction - mixeduserdata - - &warn.undocumented.func; - - - - - diff --git a/reference/fdf/functions/fdf-errno.xml b/reference/fdf/functions/fdf-errno.xml deleted file mode 100644 index e004c5d233..0000000000 --- a/reference/fdf/functions/fdf-errno.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - fdf_errno - Devuelve el código de error de la última operación FDF - - - - &reftitle.description; - - intfdf_errno - - - - Recupera el código de error de la última operación FDF. - - - Un mensaje de error es accesible a través de la función - fdf_error. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el código de error en forma de &integer; o 0 si no ha ocurrido - ningún error. - - - - - &reftitle.seealso; - - fdf_error - - - - diff --git a/reference/fdf/functions/fdf-error.xml b/reference/fdf/functions/fdf-error.xml deleted file mode 100644 index 72a1717b36..0000000000 --- a/reference/fdf/functions/fdf-error.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - fdf_error - Devuelve el mensaje de error FDF - - - - &reftitle.description; - - stringfdf_error - interror_code-1 - - - Devuelve el mensaje de error FDF. - - - - - &reftitle.parameters; - - - error_code - - - Un código de error obtenido con la función - fdf_errno. Si no se proporciona, esta función - utiliza el código de error interno definido por la última operación. - - - - - - - - &reftitle.returnvalues; - - Devuelve el mensaje de error en forma de un &string; o - la cadena no error si no hay ninguno. - - - - - &reftitle.seealso; - - fdf_errno - - - - - diff --git a/reference/fdf/functions/fdf-get-ap.xml b/reference/fdf/functions/fdf-get-ap.xml deleted file mode 100644 index 71c08078aa..0000000000 --- a/reference/fdf/functions/fdf-get-ap.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - fdf_get_ap - Lee la apariencia de un campo - - - - &reftitle.description; - - boolfdf_get_ap - resourcefdf_document - stringfield - intface - stringfilename - - - Lee la apariencia del campo field (es decir, el valor - de la clave /AP) y la almacena en el fichero filename. - - - - - &reftitle.parameters; - - - fdf_document - - - El gestor de documento FDF, devuelto por la función - fdf_create, la función - fdf_open o la función - fdf_open_string. - - - - - field - - - - - - - face - - - Los valores posibles son FDFNormalAP, - FDFRolloverAP y FDFDownAP. - - - - - filename - - - La apariencia será almacenada en este parámetro. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/fdf/functions/fdf-get-attachment.xml b/reference/fdf/functions/fdf-get-attachment.xml deleted file mode 100644 index f86bf40a8a..0000000000 --- a/reference/fdf/functions/fdf-get-attachment.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - fdf_get_attachment - Extrae un fichero integrado en un documento FDF - - - - &reftitle.description; - - arrayfdf_get_attachment - resourcefdf_document - stringfieldname - stringsavepath - - - Extrae el fichero fieldname - subido a través del campo "file selection", - luego lo almacena en el fichero savepath. - - - - - &reftitle.parameters; - - - fdf_document - - - El gestor de documento FDF, devuelto por la función - fdf_create, la función - fdf_open o la función - fdf_open_string. - - - - - fieldname - - - - - - - savepath - - - Puede ser el nombre de un fichero o bien un directorio en el cual el - fichero subido será creado bajo su nombre original. Cualquier fichero - ya existente con el mismo nombre será sobrescrito. - - - - Parece que no hay otra manera de conocer el nombre del fichero subido - que almacenarlo en un directorio con savepath y - luego leer su nombre en el directorio. - - - - - - - - - &reftitle.returnvalues; - - El array devuelto contiene los siguientes campos: - - - path - ruta de almacenamiento del directorio - - - size - tamaño del fichero almacenado en bytes - - - type - Tipo MIME del fichero, si fue proporcionado en el documento FDF - - - - - - - &reftitle.examples; - - Almacenamiento de un fichero subido - - -]]> - - - - - - diff --git a/reference/fdf/functions/fdf-get-encoding.xml b/reference/fdf/functions/fdf-get-encoding.xml deleted file mode 100644 index 182b058ee2..0000000000 --- a/reference/fdf/functions/fdf-get-encoding.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - fdf_get_encoding - Lee el valor de la clave /Encoding - - - - &reftitle.description; - - stringfdf_get_encoding - resourcefdf_document - - - Recupera el valor de la clave /Encoding. - - - - - &reftitle.parameters; - - - fdf_document - - - El gestor de documento FDF, devuelto por la función - fdf_create, la función - fdf_open o la función - fdf_open_string. - - - - - - - - &reftitle.returnvalues; - - Devuelve la codificación, en forma de un &string;. Una cadena vacía - es devuelta si el esquema PDFDocEncoding/Unicode - es utilizado. - - - - - &reftitle.seealso; - - fdf_set_encoding - - - - - diff --git a/reference/fdf/functions/fdf-get-file.xml b/reference/fdf/functions/fdf-get-file.xml deleted file mode 100644 index 119a6b80e3..0000000000 --- a/reference/fdf/functions/fdf-get-file.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - fdf_get_file - Lee el valor de la clave /F - - - - &reftitle.description; - - stringfdf_get_file - resourcefdf_document - - - Lee el valor de la clave /F. - - - - - &reftitle.parameters; - - - fdf_document - - - El gestor de documento FDF, devuelto por la función - fdf_create, la función - fdf_open o la función - fdf_open_string. - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor de la clave, en forma de &string;. - - - - - &reftitle.seealso; - - fdf_set_file - - - - - diff --git a/reference/fdf/functions/fdf-get-flags.xml b/reference/fdf/functions/fdf-get-flags.xml deleted file mode 100644 index 642a95c652..0000000000 --- a/reference/fdf/functions/fdf-get-flags.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - - fdf_get_flags - Lee los atributos de un campo FDF - - - - &reftitle.description; - - intfdf_get_flags - resourcefdf_document - stringfieldname - intwhichflags - - &warn.undocumented.func; - - - - - diff --git a/reference/fdf/functions/fdf-get-opt.xml b/reference/fdf/functions/fdf-get-opt.xml deleted file mode 100644 index a73079d4ef..0000000000 --- a/reference/fdf/functions/fdf-get-opt.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - - fdf_get_opt - Lee un valor en un array de valores de un campo FDF - - - - &reftitle.description; - - mixedfdf_get_opt - resourcefdf_document - stringfieldname - intelement-1 - - &warn.undocumented.func; - - - - - diff --git a/reference/fdf/functions/fdf-get-status.xml b/reference/fdf/functions/fdf-get-status.xml deleted file mode 100644 index 1ec08d0140..0000000000 --- a/reference/fdf/functions/fdf-get-status.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - fdf_get_status - Lee el valor de la clave /STATUS - - - - &reftitle.description; - - stringfdf_get_status - resourcefdf_document - - - Lee el valor de la clave /STATUS. - - - - - &reftitle.parameters; - - - fdf_document - - - El gestor de documento FDF, devuelto por la función - fdf_create, la función - fdf_open o la función - fdf_open_string. - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor de la clave, en forma de &string;. - - - - - &reftitle.seealso; - - fdf_set_status - - - - - diff --git a/reference/fdf/functions/fdf-get-value.xml b/reference/fdf/functions/fdf-get-value.xml deleted file mode 100644 index 6d1a40ba35..0000000000 --- a/reference/fdf/functions/fdf-get-value.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - fdf_get_value - Devuelve el valor de un campo FDF - - - - &reftitle.description; - - mixedfdf_get_value - resourcefdf_document - stringfieldname - intwhich-1 - - - Devuelve el valor de un campo FDF. - - - - - &reftitle.parameters; - - - fdf_document - - - El gestor de documento FDF, devuelto por la función - fdf_create, la función - fdf_open o la función - fdf_open_string. - - - - - fieldname - - - Nombre del campo FDF, en forma de &string;. - - - - - which - - - Los elementos de un campo array pueden ser leídos proporcionando este - argumento opcional, en forma de un entero cuyo valor mínimo será 0. Para los campos que no son arrays, este argumento - opcional será ignorado. - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor del campo. - - - - - &reftitle.seealso; - - fdf_set_value - - - - - diff --git a/reference/fdf/functions/fdf-get-version.xml b/reference/fdf/functions/fdf-get-version.xml deleted file mode 100644 index fe14111208..0000000000 --- a/reference/fdf/functions/fdf-get-version.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - fdf_get_version - Lee el número de versión de la API FDF - - - - &reftitle.description; - - stringfdf_get_version - resourcefdf_document - - - Devuelve el número de versión FDF para el documento - fdf_document, para la API - si no se proporciona ningún argumento. - - - - - &reftitle.parameters; - - - fdf_document - - - El gestor de documento, devuelto por la función - fdf_create, la función - fdf_open o la función - fdf_open_string. - - - - - - - - &reftitle.returnvalues; - - Devuelve la versión, en forma de &string;. - Para la versión actual del FDF toolkit 5.0, el número de versión es - 5.0 y el número de versión del documento es - 1.2, 1.3 o 1.4. - - - - - &reftitle.seealso; - - fdf_set_version - - - - - diff --git a/reference/fdf/functions/fdf-header.xml b/reference/fdf/functions/fdf-header.xml deleted file mode 100644 index b75210e3be..0000000000 --- a/reference/fdf/functions/fdf-header.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - fdf_header - Emite las cabeceras HTTP específicas de FDF - - - - &reftitle.description; - - voidfdf_header - - - - fdf_header es una función de conveniencia, - para emitir las cabeceras HTTP específicas de FDF. Permite - enviar el tipo Content-type: - con el valor application/vnd.fdf. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/fdf/functions/fdf-next-field-name.xml b/reference/fdf/functions/fdf-next-field-name.xml deleted file mode 100644 index b791971326..0000000000 --- a/reference/fdf/functions/fdf-next-field-name.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - fdf_next_field_name - Lee el nombre del siguiente campo FDF - - - - &reftitle.description; - - stringfdf_next_field_name - resourcefdf_document - stringfieldname - - - Lee el nombre del siguiente campo FDF. Este nombre podrá ser utilizado en varias funciones. - - - - - &reftitle.parameters; - - - fdf_document - - - El gestor de documento FDF, devuelto por la función - fdf_create, la función - fdf_open o la función - fdf_open_string. - - - - - fieldname - - - Nombre del campo FDF, en forma de &string;. Si no se proporciona, - se devolverá el primer campo. - - - - - - - - &reftitle.returnvalues; - - Devuelve el nombre del campo, en forma de &string;. - - - - - &reftitle.examples; - - Detectar todos los nombres de un formulario FDF - - -]]> - - - - - - &reftitle.seealso; - - fdf_get_value - - - - - diff --git a/reference/fdf/functions/fdf-open-string.xml b/reference/fdf/functions/fdf-open-string.xml deleted file mode 100644 index a9fb867b13..0000000000 --- a/reference/fdf/functions/fdf-open-string.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - fdf_open_string - Lee un documento FDF a partir de un &string; - - - - &reftitle.description; - - resourcefdf_open_string - stringfdf_data - - - Lee un documento FDF a partir de un &string;. - - - Se puede utilizar fdf_open_string con la variable - $HTTP_FDF_DATA para procesar datos - de formularios provenientes de clientes remotos. - - - - - &reftitle.parameters; - - - fdf_data - - - Los datos, como devueltos desde un formulario PDF - o creados utilizando las funciones - fdf_create y - fdf_save_string. - - - - - - - - &reftitle.returnvalues; - - Devuelve un gestor de documento FDF, o &false; - si ocurre un error. - - - - - &reftitle.examples; - - Acceso a los datos de formulario FDF - - -]]> - - - - - - &reftitle.seealso; - - fdf_open - fdf_close - fdf_create - fdf_save_string - - - - - diff --git a/reference/fdf/functions/fdf-open.xml b/reference/fdf/functions/fdf-open.xml deleted file mode 100644 index 913079b124..0000000000 --- a/reference/fdf/functions/fdf-open.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - fdf_open - Abre un documento FDF - - - - &reftitle.description; - - resourcefdf_open - stringfilename - - - Abre un documento FDF. - - - Asimismo, se puede utilizar la función - fdf_open_string para procesar el resultado - de un formulario PDF enviado mediante un método POST. - - - - - &reftitle.parameters; - - - filename - - - Ruta hacia el fichero FDF. Este fichero debe contener los datos - tal como son devueltos por un formulario PDF o creados utilizando las funciones - fdf_create y fdf_save. - - - - - - - - &reftitle.returnvalues; - - Devuelve un gestor de documento FDF, o &false; - en caso de error. - - - - - &reftitle.examples; - - Acceder a los datos del formulario - - -]]> - - - - - - &reftitle.seealso; - - fdf_open_string - fdf_close - fdf_create - fdf_save - - - - - diff --git a/reference/fdf/functions/fdf-remove-item.xml b/reference/fdf/functions/fdf-remove-item.xml deleted file mode 100644 index 5c512837f8..0000000000 --- a/reference/fdf/functions/fdf-remove-item.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - - fdf_remove_item - Configura el marco FDF de destino para el formulario - - - - &reftitle.description; - - boolfdf_remove_item - resourcefdf_document - stringfieldname - intitem - - &warn.undocumented.func; - - - - - diff --git a/reference/fdf/functions/fdf-save-string.xml b/reference/fdf/functions/fdf-save-string.xml deleted file mode 100644 index f43939e3ec..0000000000 --- a/reference/fdf/functions/fdf-save-string.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - fdf_save_string - Devuelve un documento FDF en forma de &string; - - - - &reftitle.description; - - stringfdf_save_string - resourcefdf_document - - - Devuelve un documento FDF en forma de &string;. - - - - - &reftitle.parameters; - - - fdf_document - - - El gestor de documento FDF, devuelto por la función - fdf_create, la función - fdf_open o la función - fdf_open_string. - - - - - - - - &reftitle.returnvalues; - - Devuelve el documento, en forma de &string;, o - &false; en caso de error. - - - - - &reftitle.examples; - - Leer un documento FDF en forma de &string; - - -]]> - - &example.outputs; - -> ->> -endobj -2 0 obj -[ -<< /T (foo)/V (bar)>> -] -endobj -trailer -<< -/Root 1 0 R - ->> -%%EOF -]]> - - - - - - &reftitle.seealso; - - fdf_open_string - fdf_close - fdf_create - fdf_save - - - - - diff --git a/reference/fdf/functions/fdf-save.xml b/reference/fdf/functions/fdf-save.xml deleted file mode 100644 index 8ab4f3adac..0000000000 --- a/reference/fdf/functions/fdf-save.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - fdf_save - Guarda un documento FDF - - - - &reftitle.description; - - boolfdf_save - resourcefdf_document - stringfilename - - - Guarda un documento FDF. - - - - - &reftitle.parameters; - - - fdf_document - - - El gestor de documento FDF, devuelto por la función - fdf_create, la función - fdf_open o la función - fdf_open_string. - - - - - filename - - - Si se proporciona, el FDF resultante será escrito en este parámetro. - De lo contrario, esta función escribirá el FDF en la salida estándar de PHP. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - fdf_close - fdf_create - fdf_save_string - - - - - diff --git a/reference/fdf/functions/fdf-set-ap.xml b/reference/fdf/functions/fdf-set-ap.xml deleted file mode 100644 index c9f836ed2c..0000000000 --- a/reference/fdf/functions/fdf-set-ap.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - fdf_set_ap - Fija la apariencia de un campo FDF - - - - &reftitle.description; - - boolfdf_set_ap - resourcefdf_document - stringfield_name - intface - stringfilename - intpage_number - - - Fija la apariencia de un campo FDF (es decir, el valor de la clave - /AP). - - - - - &reftitle.parameters; - - - fdf_document - - - El gestor de documento FDF, devuelto por la función - fdf_create, la función - fdf_open o la función - fdf_open_string. - - - - - field_name - - - - - - - face - - - Los valores posibles son: FDFNormalAP, - FDFRolloverAP y - FDFDownAP. - - - - - filename - - - - - - - page_number - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/fdf/functions/fdf-set-encoding.xml b/reference/fdf/functions/fdf-set-encoding.xml deleted file mode 100644 index 69a4a3f4db..0000000000 --- a/reference/fdf/functions/fdf-set-encoding.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - fdf_set_encoding - Modifica la codificación de caracteres - - - - &reftitle.description; - - boolfdf_set_encoding - resourcefdf_document - stringencoding - - - Modifica la codificación de caracteres del documento FDF. - - - - - &reftitle.parameters; - - - fdf_document - - - El gestor de documento FDF, devuelto por la función - fdf_create, la función - fdf_open o la función - fdf_open_string. - - - - - encoding - - - El nombre de la codificación. Los siguientes valores son soportados: - "Shift-JIS", "UHC", - "GBK" y "BigFive". - - - Un &string; vacío reemplaza el valor por omisión de la codificación al - esquema PDFDocEncoding/Unicode. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/fdf/functions/fdf-set-file.xml b/reference/fdf/functions/fdf-set-file.xml deleted file mode 100644 index 507ab16203..0000000000 --- a/reference/fdf/functions/fdf-set-file.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - fdf_set_file - Crea un documento PDF para mostrar datos FDF - - - - &reftitle.description; - - boolfdf_set_file - resourcefdf_document - stringurl - stringtarget_frame - - - Crea un documento PDF para mostrar datos FDF. - - - - - &reftitle.parameters; - - - fdf_document - - - El gestor de documento FDF, devuelto por la función - fdf_create, la función - fdf_open o la función - fdf_open_string. - - - - - url - - - Debe ser proporcionado en forma de URL absoluta. - - - - - target_frame - - - Utilice este parámetro para especificar la frame en la que se mostrará el documento. También es posible definir el valor por omisión de este parámetro utilizando la función fdf_set_target_frame. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Pasar datos FDF a un segundo formulario - - -]]> - - - - - - &reftitle.seealso; - - fdf_get_file - fdf_set_target_frame - - - - - diff --git a/reference/fdf/functions/fdf-set-flags.xml b/reference/fdf/functions/fdf-set-flags.xml deleted file mode 100644 index 332e36a018..0000000000 --- a/reference/fdf/functions/fdf-set-flags.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - fdf_set_flags - Modifica una opción de un campo - - - - &reftitle.description; - - boolfdf_set_flags - resourcefdf_document - stringfieldname - intwhichFlags - intnewFlags - - - Modifica una opción de un campo. - - - - - &reftitle.parameters; - - - fdf_document - - - El gestor de documento FDF, devuelto por la función - fdf_create, la función - fdf_open o la función - fdf_open_string. - - - - - fieldname - - - Nombre del campo FDF, en forma de &string;. - - - - - whichFlags - - - - - - - newFlags - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - fdf_set_opt - - - - - diff --git a/reference/fdf/functions/fdf-set-javascript-action.xml b/reference/fdf/functions/fdf-set-javascript-action.xml deleted file mode 100644 index f8a56efd7c..0000000000 --- a/reference/fdf/functions/fdf-set-javascript-action.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - fdf_set_javascript_action - Modifica la acción javascript de un campo - - - - &reftitle.description; - - boolfdf_set_javascript_action - resourcefdf_document - stringfieldname - inttrigger - stringscript - - - Modifica la acción javascript de un campo dado. - - - - - &reftitle.parameters; - - - fdf_document - - - El gestor de documento FDF, devuelto por la función - fdf_create, la función - fdf_open o la función fdf_open_string. - - - - - fieldname - - - Nombre del campo FDF, en forma de &string;. - - - - - trigger - - - - - - - script - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - fdf_set_submit_form_action - - - - - diff --git a/reference/fdf/functions/fdf-set-on-import-javascript.xml b/reference/fdf/functions/fdf-set-on-import-javascript.xml deleted file mode 100644 index 98a0cbe1c7..0000000000 --- a/reference/fdf/functions/fdf-set-on-import-javascript.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - - fdf_set_on_import_javascript - Añade código Javascript para ser ejecutado cuando Acrobat abre un FDF - - - - &reftitle.description; - - boolfdf_set_on_import_javascript - resourcefdf_document - stringscript - boolbefore_data_import - - &warn.undocumented.func; - - - - &reftitle.seealso; - - fdf_add_doc_javascript - fdf_set_javascript_action - - - - - diff --git a/reference/fdf/functions/fdf-set-opt.xml b/reference/fdf/functions/fdf-set-opt.xml deleted file mode 100644 index ede39440d8..0000000000 --- a/reference/fdf/functions/fdf-set-opt.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - fdf_set_opt - Modifica una opción de un campo - - - - &reftitle.description; - - boolfdf_set_opt - resourcefdf_document - stringfieldname - intelement - stringstr1 - stringstr2 - - - Modifica una opción de un campo dado. - - - - - &reftitle.parameters; - - - fdf_document - - - El gestor de documento FDF, devuelto por la función - fdf_create, la función - fdf_open o la función fdf_open_string. - - - - - fieldname - - - Nombre del campo FDF, en forma de &string;. - - - - - element - - - - - - - str1 - - - - - - - str2 - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - fdf_set_flags - - - - - diff --git a/reference/fdf/functions/fdf-set-status.xml b/reference/fdf/functions/fdf-set-status.xml deleted file mode 100644 index 7950e09f63..0000000000 --- a/reference/fdf/functions/fdf-set-status.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - fdf_set_status - Establece el valor de la clave /STATUS - - - - &reftitle.description; - - boolfdf_set_status - resourcefdf_document - stringstatus - - - Establece el valor de la clave /STATUS. Cuando un cliente - recibe un FDF con un estado establecido, su valor se presentará en una caja de alerta. - - - - - &reftitle.parameters; - - - fdf_document - - - El gestor de documento FDF, devuelto por la función - fdf_create, la función - fdf_open o la función - fdf_open_string. - - - - - status - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - fdf_get_status - - - - - diff --git a/reference/fdf/functions/fdf-set-submit-form-action.xml b/reference/fdf/functions/fdf-set-submit-form-action.xml deleted file mode 100644 index 6b2ae2cfaf..0000000000 --- a/reference/fdf/functions/fdf-set-submit-form-action.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - fdf_set_submit_form_action - Modifica la acción de un formulario - - - - &reftitle.description; - - boolfdf_set_submit_form_action - resourcefdf_document - stringfieldname - inttrigger - stringscript - intflags - - - Modifica la acción de un formulario. - - - - - &reftitle.parameters; - - - fdf_document - - - El gestor de documento, devuelto por la función - fdf_create, la función - fdf_open o la función - fdf_open_string. - - - - - fieldname - - - Nombre del campo FDF, en forma de &string;. - - - - - trigger - - - - - - - script - - - - - - - flags - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - fdf_set_javascript_action - - - - - diff --git a/reference/fdf/functions/fdf-set-target-frame.xml b/reference/fdf/functions/fdf-set-target-frame.xml deleted file mode 100644 index 8674da084f..0000000000 --- a/reference/fdf/functions/fdf-set-target-frame.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - fdf_set_target_frame - Configura el marco de destino para la visualización del formulario - - - - &reftitle.description; - - boolfdf_set_target_frame - resourcefdf_document - stringframe_name - - - Configura el marco de destino para la visualización del resultado - PDF definido por fdf_save_file. - - - - - &reftitle.parameters; - - - fdf_document - - - El gestor de documento FDF, devuelto por la función - fdf_create, la función - fdf_open o la función - fdf_open_string. - - - - - frame_name - - - El nombre del marco, en forma de &string;. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - fdf_save_file - - - - - diff --git a/reference/fdf/functions/fdf-set-value.xml b/reference/fdf/functions/fdf-set-value.xml deleted file mode 100644 index 7ab5bc5c0b..0000000000 --- a/reference/fdf/functions/fdf-set-value.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - fdf_set_value - Modifica el valor de un campo FDF - - - - &reftitle.description; - - boolfdf_set_value - resourcefdf_document - stringfieldname - mixedvalue - intisName - - - Modifica el valor de un campo FDF. - - - - - &reftitle.parameters; - - - fdf_document - - - El gestor de documento FDF, devuelto por la función - fdf_create, la función - fdf_open o la función - fdf_open_string. - - - - - fieldname - - - Nombre del campo FDF, en forma de &string;. - - - - - value - - - Este parámetro debe ser almacenado como un string incluso si es un array. En este caso, todos los elementos del array serán almacenados como un array de valores. - - - - - isName - - - - En versiones anteriores de la suite FDF, el último parámetro determinaba si el valor del campo debía ser convertido en un nombre PDF (isname = 1) o posicionado como un string (isname = 0). - - - El valor ya no está en la suite actual, versión 5.0. Por razones de compatibilidad, esto sigue siendo soportado como un parámetro opcional, pero ignorado internamente. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - fdf_get_value - fdf_remove_item - - - - - diff --git a/reference/fdf/functions/fdf-set-version.xml b/reference/fdf/functions/fdf-set-version.xml deleted file mode 100644 index 2581c25fe4..0000000000 --- a/reference/fdf/functions/fdf-set-version.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - fdf_set_version - Modifica el número de versión del fichero FDF - - - - &reftitle.description; - - boolfdf_set_version - resourcefdf_document - stringversion - - - Modifica el número de versión del documento FDF actual. - - - Algunas funcionalidades soportadas por esta extensión solo están disponibles para las nuevas versiones de FDF. - - - - - &reftitle.parameters; - - - fdf_document - - - El gestor de documento FDF, devuelto por la función - fdf_create, la función - fdf_open o la función - fdf_open_string. - - - - - version - - - El número de versión. Para el toolkit FDF actual, puede ser - 1.2, 1.3 o - 1.4. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - fdf_get_version - - - - - diff --git a/reference/fdf/reference.xml b/reference/fdf/reference.xml deleted file mode 100644 index e754d10f61..0000000000 --- a/reference/fdf/reference.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - &Functions; FDF - - &reference.fdf.entities.functions; - - - - diff --git a/reference/fdf/setup.xml b/reference/fdf/setup.xml deleted file mode 100644 index 403b226986..0000000000 --- a/reference/fdf/setup.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - &reftitle.setup; - - -
- &reftitle.required; - - Se necesitará el SDK de FDF toolkit, disponible en el sitio - &spec.pdf.fdf;. - Desde PHP 4.3.0, se necesitará la versión 5.0 del SDK. - La biblioteca FDF toolkit está disponible como una biblioteca compilada, editada por Adobe, en los sistemas operativos Win32, - Linux, Solaris y AIX. - -
- - - - &reference.fdf.configure; - - - -
- &reftitle.resources; - - La mayoría de las funciones FDF requieren un recurso de tipo - fdf como primer argumento. Un recurso - fdf es una estructura que representa un - fichero FDF abierto. Se pueden crear recursos fdf - con las funciones fdf_create, - fdf_open y fdf_open_string. - -
- - -
- diff --git a/reference/gearman/book.xml b/reference/gearman/book.xml deleted file mode 100644 index 2d7b7470b0..0000000000 --- a/reference/gearman/book.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - Gearman - Gearman - - - &reftitle.intro; - - Gearman es un marco de referencia base genérico para distribuir - tareas a múltiples máquinas o múltiples procesos. Permite a una aplicación ejecutar tareas - en paralelo, distribuir la carga de cálculo y realizar llamadas de funciones entre varios lenguajes. - Este marco de referencia base puede ser utilizado en numerosas aplicaciones, desde sitios web de alta disponibilidad hasta el transporte de eventos de replicación de bases de datos. - - - Esta extensión proporciona clases para escribir clientes o agentes Gearman. - - - - &reference.gearman.setup; - &reference.gearman.constants; - &reference.gearman.examples; - &reference.gearman.gearmanclient; - &reference.gearman.gearmanjob; - &reference.gearman.gearmantask; - &reference.gearman.gearmanworker; - &reference.gearman.gearmanexception; - - - diff --git a/reference/gearman/configure.xml b/reference/gearman/configure.xml deleted file mode 100644 index 0a6eb5abe1..0000000000 --- a/reference/gearman/configure.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - -
- &reftitle.install; - - - &pecl.info; - &url.pecl.package;gearman - - -
- diff --git a/reference/gearman/constants.xml b/reference/gearman/constants.xml deleted file mode 100644 index 2b5f43d2e6..0000000000 --- a/reference/gearman/constants.xml +++ /dev/null @@ -1,583 +0,0 @@ - - - - - - &reftitle.constants; - &extension.constants; - - Valores de retorno. Siempre se debe buscar una cadena de caracteres de error en - GearmanClient::error o GearmanWorker ya que - pueden estar disponibles más detalles: - - - - - GEARMAN_SUCCESS - (int) - - - - Cualquier acción realizada ha sido exitosa. - - - - - - GEARMAN_IO_WAIT - (int) - - - - En modo no bloqueante, se ha alcanzado un evento que habría sido bloqueante. - - - - - - GEARMAN_ERRNO - (int) - - - - Un error del sistema. Se debe buscar en GearmanClient::errno o - GearmanWorker::errno el código de error del sistema que se ha - devuelto. - - - - - - GEARMAN_NO_ACTIVE_FDS - (int) - - - - GearmanClient::wait o GearmanWorker ha - sido llamado sin conexión. - - - - - - GEARMAN_UNEXPECTED_PACKET - (int) - - - - Indica que algo grave ha ocurrido en gearmand. Solo se aplica a - GearmanWorker. - - - - - - GEARMAN_GETADDRINFO - (int) - - - - La resolución DNS ha fallado (host o puerto inválido, etc). - - - - - - GEARMAN_NO_SERVERS - (int) - - - - No se ha realizado ninguna llamada a GearmanClient::addServer antes de enviar una - tarea. - - - - - - GEARMAN_LOST_CONNECTION - (int) - - - - Se ha perdido la conexión durante una solicitud. - - - - - - GEARMAN_MEMORY_ALLOCATION_FAILURE - (int) - - - - La asignación de memoria ha fallado (no hay memoria disponible). - - - - - - GEARMAN_SERVER_ERROR - (int) - - - - Algo ha salido mal con el servidor Gearman que no ha podido procesar - la solicitud como debería. - - - - - - GEARMAN_WORK_DATA - (int) - - - - Un código de error de notificación obtenido con GearmanClient::returnCode - al utilizar GearmanClient::do. Se envía para actualizar al - cliente con los datos de la tarea actual. Un agente lo utiliza cuando necesita enviar actualizaciones, - enviar resultados parciales o vaciar datos durante tareas largas. - - - - - - GEARMAN_WORK_WARNING - (int) - - - - Un código de error de notificación obtenido con GearmanClient::returnCode - al utilizar GearmanClient::do. Actualiza al cliente con - un aviso. El comportamiento es el mismo que con GEARMAN_WORK_DATA, excepto - que debería ser tratado como un aviso en lugar de los datos de una respuesta normal. - - - - - - GEARMAN_WORK_STATUS - (int) - - - - Un código de error de notificación obtenido con GearmanClient::returnCode - al utilizar GearmanClient::do. Se envía para actualizar el estado - de una tarea larga. Utilice GearmanClient::doStatus para obtener el porcentaje - de completación de la tarea. - - - - - - GEARMAN_WORK_EXCEPTION - (int) - - - - Un código de error de notificación obtenido con GearmanClient::returnCode - al utilizar GearmanClient::do. Indica que una tarea ha fallado - al lanzar una excepción dada. - - - - - - GEARMAN_WORK_FAIL - (int) - - - - Un código de error de notificación obtenido con GearmanClient::returnCode - al utilizar GearmanClient::do. Indica que una tarea ha fallado. - - - - - - GEARMAN_COULD_NOT_CONNECT - (int) - - - - Fallo al conectar con los servidores. - - - - - - GEARMAN_INVALID_FUNCTION_NAME - (int) - - - - Intento de referencia a una función con un nombre NULL o uso de la interfaz de devolución de llamada - sin especificar las devoluciones de llamada. - - - - - - GEARMAN_INVALID_WORKER_FUNCTION - (int) - - - - Intento de referencia a una función con una función de devolución de llamada NULL. - - - - - - GEARMAN_NO_REGISTERED_FUNCTIONS - (int) - - - - Cuando un agente recibe una tarea para una función que no ha referenciado. - - - - - - GEARMAN_NO_JOBS - (int) - - - - Para un agente no bloqueante, cuando GearmanWorker::work no tiene ninguna tarea - activa. - - - - - - GEARMAN_ECHO_DATA_CORRUPTION - (int) - - - - Después de GearmanClient::echo o GearmanWorker::echo, - los datos devueltos no coinciden con los datos enviados. - - - - - - GEARMAN_NEED_WORKLOAD_FN - (int) - - - - Cuando el cliente ha optado por distribuir la carga de trabajo en una tarea, pero no ha - especificado una función de retorno de la carga de trabajo. - - - - - - GEARMAN_PAUSE - (int) - - - - Para la interfaz de tarea cliente no bloqueante, puede ser devuelto desde el retorno de la tarea - para "pausar" la llamada y el retorno de GearmanClient::runTasks. - Llame de nuevo a GearmanClient::runTasks para continuar. - - - - - - GEARMAN_UNKNOWN_STATE - (int) - - - - Error de estado interno del cliente/agente. - - - - - - GEARMAN_SEND_BUFFER_TOO_SMALL - (int) - - - - Error interno: intentó vaciar más datos de los posibles en un paquete atómico, - debido a tamaños de búfer codificados en el código. - - - - - - GEARMAN_TIMEOUT - (int) - - - - Se ha alcanzado el límite de tiempo del agente/cliente. - - - - - - - Las opciones GearmanClient: - - - - - GEARMAN_CLIENT_GENERATE_UNIQUE - (int) - - - - Genera un identificador único (UUID) para cada tarea. - - - - - - - GEARMAN_CLIENT_NON_BLOCKING - (int) - - - - Inicia el cliente en modo no bloqueante. - - - - - - GEARMAN_CLIENT_UNBUFFERED_RESULT - (int) - - - - Permite al cliente leer los datos por paquetes en lugar de que la biblioteca los almacene - en búfer y los transmita. - - - - - - GEARMAN_CLIENT_FREE_TASKS - (int) - - - - Libera automáticamente los objetos de las tareas una vez que estas se han completado. Es la configuración por - defecto de esta extensión para evitar fugas de memoria. - - - - - - - Las opciones GearmanWorker: - - - - - GEARMAN_WORKER_NON_BLOCKING - (int) - - - - Inicia el agente en modo no bloqueante. - - - - - - GEARMAN_WORKER_GRAB_UNIQ - (int) - - - - Devuelve el identificador único asignado al cliente además del descriptor de tarea. - - - - - - - Configuración base de Gearman: - - - - - GEARMAN_DEFAULT_TCP_HOST - (string) - - - - - - - - - GEARMAN_DEFAULT_TCP_PORT - (int) - - - - - - - - - GEARMAN_DEFAULT_SOCKET_TIMEOUT - (int) - - - - - - - - - GEARMAN_DEFAULT_SOCKET_SEND_SIZE - (int) - - - - - - - - - GEARMAN_DEFAULT_SOCKET_RECV_SIZE - (int) - - - - - - - - - GEARMAN_MAX_ERROR_SIZE - (int) - - - - - - - - - GEARMAN_PACKET_HEADER_SIZE - (int) - - - - - - - - - GEARMAN_JOB_HANDLE_SIZE - (int) - - - - - - - - - GEARMAN_OPTION_SIZE - (int) - - - - - - - - - GEARMAN_UNIQUE_SIZE - (int) - - - - - - - - - GEARMAN_MAX_COMMAND_ARGS - (int) - - - - - - - - - GEARMAN_ARGS_BUFFER_SIZE - (int) - - - - - - - - - GEARMAN_SEND_BUFFER_SIZE - (int) - - - - - - - - - GEARMAN_RECV_BUFFER_SIZE - (int) - - - - - - - - - GEARMAN_WORKER_WAIT_TIMEOUT - (int) - - - - - - - - - diff --git a/reference/gearman/examples.xml b/reference/gearman/examples.xml deleted file mode 100644 index db6dfa8812..0000000000 --- a/reference/gearman/examples.xml +++ /dev/null @@ -1,475 +0,0 @@ - - - - - - &reftitle.examples; -
- Uso básico - - Cliente y trabajador básicos en Gearman - - Este ejemplo muestra un cliente y un trabajador muy sencillo. El cliente - envía un string al servidor de trabajos, y el trabajador da la vuelta al - string y lo envía de vuelta. El trabajo se realiza de forma síncrona. - - -addServer(); - -echo "Sending job\n"; - -# Enviamos trabajo "reverse" -do -{ - $result = $gmclient->do("reverse", "Hello!"); - - # Comprobación de varios paquetes de retorno y errores - switch($gmclient->returnCode()) - { - case GEARMAN_WORK_DATA: - echo "Data: $result\n"; - break; - case GEARMAN_WORK_STATUS: - list($numerator, $denominator)= $gmclient->doStatus(); - echo "Status: $numerator/$denominator complete\n"; - break; - case GEARMAN_WORK_FAIL: - echo "Failed\n"; - exit; - case GEARMAN_SUCCESS: - break; - default: - echo "RET: " . $gmclient->returnCode() . "\n"; - exit; - } -} -while($gmclient->returnCode() != GEARMAN_SUCCESS); - -?> -]]> - - -addServer(); - -# Registro de la función "reverse" en el servidor. Cambiar la función del -# trabajador a "reverse_fn_fast" para un trabajo más rápido sin mensajes de -# estado. -$gmworker->addFunction("reverse", "reverse_fn"); - -print "Waiting for job...\n"; -while($gmworker->work()) -{ - if ($gmworker->returnCode() != GEARMAN_SUCCESS) - { - echo "return_code: " . $gmworker->returnCode() . "\n"; - break; - } -} - -function reverse_fn($job) -{ - echo "Received job: " . $job->handle() . "\n"; - - $workload = $job->workload(); - $workload_size = $job->workloadSize(); - - echo "Workload: $workload ($workload_size)\n"; - - # Este bucle de estado no es necesario, sólo es para mostrar cómo funciona - for ($x= 0; $x < $workload_size; $x++) - { - echo "Sending status: " . ($x + 1) . "/$workload_size complete\n"; - $job->sendStatus($x, $workload_size); - sleep(1); - } - - $result= strrev($workload); - echo "Result: $result\n"; - - # Retornamos lo que hay que enviar de vuelta al cliente - return $result; -} - -# Una forma mucho más sencilla y que da menos información sería: -function reverse_fn_fast($job) -{ - return strrev($job->workload()); -} - -?> -]]> - - &example.outputs.similar; - - - - - - - -
-
- Cliente y trabajador básicos en Gearman, trabajo en segundo plano - - Cliente y trabajador básicos en Gearman, trabajo en segundo plano - - Este ejemplo muestra un trabajador y un cliente muy sencillos. El cliente - envía un string al servidor de trabajos como trabajo en segundo plano, y - el trabajador da la vuelta al string. Notar que como el trabajo se - realiza de forma asíncrona, el cliente no espera a que se complete el - trabajo y termina (y, por tanto, el cliente nunca recibe los resultados). - - -addServer(); - -# Ejecutar el cliente "reverse" en segundo plano -$job_handle = $gmclient->doBackground("reverse", "this is a test"); - -if ($gmclient->returnCode() != GEARMAN_SUCCESS) -{ - echo "bad return code\n"; - exit; -} - -echo "done!\n"; - -?> -]]> - - -addServer(); - -# Registro de la función "reverse" en el servidor. Cambiar la funcion del -# trabajador a "reverse_fn_fast" para usar un trabajador más rápido sin -# mostrar mensajes de estado -$gmworker->addFunction("reverse", "reverse_fn"); - -print "Waiting for job...\n"; -while($gmworker->work()) -{ - if ($gmworker->returnCode() != GEARMAN_SUCCESS) - { - echo "return_code: " . $gmworker->returnCode() . "\n"; - break; - } -} - -function reverse_fn($job) -{ - echo "Received job: " . $job->handle() . "\n"; - - $workload = $job->workload(); - $workload_size = $job->workloadSize(); - - echo "Workload: $workload ($workload_size)\n"; - - # Este bucle de estado no es necesario, únicamente muestra cómo funciona - for ($x= 0; $x < $workload_size; $x++) - { - echo "Sending status: " . ($x + 1) . "/$workload_size complete\n"; - $job->sendStatus($x, $workload_size); - sleep(1); - } - - $result= strrev($workload); - echo "Result: $result\n"; - - # Retorna lo que se quiere enviar de vuelta al cliente - return $result; -} - -# Una versión mucho más sencilla y que muestra menos información del proceso sería: -function reverse_fn_fast($job) -{ - return strrev($job->workload()); -} - -?> -]]> - - &example.outputs.similar; - - - - - - - -
-
- Cliente y trabajador básicos, enviando tareas - - Cliente y trabajador básicos, enviando tareas - - En este ejemplo, se extiende el cliente básico que da la vuelta al texto - para ejecutar dos tareas en paralelo. El trabajador "reverse" es idéntico - excepto la parte del envío del datos durante el proceso. - - -addServer(); - -# Registra alguna llamadas de retorno -$gmc->setCreatedCallback("reverse_created"); -$gmc->setDataCallback("reverse_data"); -$gmc->setStatusCallback("reverse_status"); -$gmc->setCompleteCallback("reverse_complete"); -$gmc->setFailCallback("reverse_fail"); - -# Asignación de datos arbitrarios para la aplicación -$data['foo'] = 'bar'; - -# Añade dos tareas -$task= $gmc->addTask("reverse", "foo", $data); -$task2= $gmc->addTaskLow("reverse", "bar", NULL); - -# Ejecuta las tareas en paralelo (se asumen múltiples trabajadores) -if (! $gmc->runTasks()) -{ - echo "ERROR " . $gmc->error() . "\n"; - exit; -} - -echo "DONE\n"; - -function reverse_created($task) -{ - echo "CREATED: " . $task->jobHandle() . "\n"; -} - -function reverse_status($task) -{ - echo "STATUS: " . $task->jobHandle() . " - " . $task->taskNumerator() . - "/" . $task->taskDenominator() . "\n"; -} - -function reverse_complete($task) -{ - echo "COMPLETE: " . $task->jobHandle() . ", " . $task->data() . "\n"; -} - -function reverse_fail($task) -{ - echo "FAILED: " . $task->jobHandle() . "\n"; -} - -function reverse_data($task) -{ - echo "DATA: " . $task->data() . "\n"; -} - -?> -]]> - - -addServer(); - -# Registra la función "reverse" en el servidor. Cambiar la función a -# "reverse_fn_fast" para obtener un worker más rápido que no genera -# informacion del proceso -$gmworker->addFunction("reverse", "reverse_fn"); - -print "Waiting for job...\n"; -while($gmworker->work()) -{ - if ($gmworker->returnCode() != GEARMAN_SUCCESS) - { - echo "return_code: " . $gmworker->returnCode() . "\n"; - break; - } -} - -function reverse_fn($job) -{ - echo "Received job: " . $job->handle() . "\n"; - - $workload = $job->workload(); - $workload_size = $job->workloadSize(); - - echo "Workload: $workload ($workload_size)\n"; - - # Este bucle de estado no es necesario, sólo es para mostrar cómo funciona - for ($x= 0; $x < $workload_size; $x++) - { - echo "Sending status: " . ($x + 1) . "/$workload_size complete\n"; - $job->sendStatus($x+1, $workload_size); - $job->sendData(substr($workload, $x, 1)); - sleep(1); - } - - $result= strrev($workload); - echo "Result: $result\n"; - - # Retornamos lo que queremos enviar de vuelta al cliente - return $result; -} - -# Una versión mucho más sencilla y que muestra menos información del proceso sería: -function reverse_fn_fast($job) -{ - return strrev($job->workload()); -} - -?> -]]> - - &example.outputs.similar; - - - - - - - -
-
- diff --git a/reference/gearman/gearmanclient.xml b/reference/gearman/gearmanclient.xml deleted file mode 100644 index f11d1f4ad4..0000000000 --- a/reference/gearman/gearmanclient.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - La clase GearmanClient - GearmanClient - - - - -
- &reftitle.intro; - - Representa una clase para conectarse a un servidor de tareas Gearman y someterle peticiones - para aplicar funciones sobre los datos proporcionados. La función aplicada debe formar parte de - las referenciadas por un agente Gearman y los datos procesados permanecen opacos desde el punto - de vista del servidor de tareas. - -
- - -
- &reftitle.classsynopsis; - - - - - GearmanClient - - - &Methods; - - - - - - - - - -
- -
- - &reference.gearman.entities.gearmanclient; - -
- diff --git a/reference/gearman/gearmanclient/addoptions.xml b/reference/gearman/gearmanclient/addoptions.xml deleted file mode 100644 index f37ba8f350..0000000000 --- a/reference/gearman/gearmanclient/addoptions.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - GearmanClient::addOptions - Añade opciones al cliente - - - - &reftitle.description; - - public boolGearmanClient::addOptions - intoption - - - Añade una o varias opciones a las ya existentes. - - - - - &reftitle.parameters; - - - option - - - Las opciones a añadir. - Una de las constantes siguientes o la combinación de constantes utilizando - el operador de manipulación de bits (|): - GEARMAN_CLIENT_GENERATE_UNIQUE, - GEARMAN_CLIENT_NON_BLOCKING, - GEARMAN_CLIENT_UNBUFFERED_RESULT o - GEARMAN_CLIENT_FREE_TASKS. - - - - - - - - &reftitle.returnvalues; - - Devuelve siempre &true;. - - - - - diff --git a/reference/gearman/gearmanclient/addserver.xml b/reference/gearman/gearmanclient/addserver.xml deleted file mode 100644 index f4ea7e723f..0000000000 --- a/reference/gearman/gearmanclient/addserver.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - GearmanClient::addServer - Añade un servidor de tareas al cliente - - - - &reftitle.description; - - public boolGearmanClient::addServer - stringhost&null; - intport0 - boolsetupExceptionHandler&true; - - - Añade un servidor de tareas a una lista de servidores que pueden ser utilizados para realizar una tarea. - No se realiza ninguna entrada/salida en un socket aquí; el servidor es simplemente añadido a la lista. - - - - - - &reftitle.parameters; - - - host - - - &gearman.parameter.host; - - - - - port - - - &gearman.parameter.port; - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Añadir dos servidores - -addServer("10.0.0.1"); -$gmclient->addServer("10.0.0.2", 7003); - -?> -]]> - - - - - - &reftitle.seealso; - - GearmanClient::addServers - - - - - diff --git a/reference/gearman/gearmanclient/addservers.xml b/reference/gearman/gearmanclient/addservers.xml deleted file mode 100644 index e3e36d47f1..0000000000 --- a/reference/gearman/gearmanclient/addservers.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - GearmanClient::addServers - Añade una lista de servidores de tareas al cliente - - - - &reftitle.description; - - public boolGearmanClient::addServers - stringservers&null; - boolsetupExceptionHandler&true; - - - Añade una lista de servidores de tareas que pueden ser utilizados para realizar una tarea. - No se realiza ninguna entrada/salida en un socket aquí; los servidores son simplemente añadidos a la lista completa de servidores. - - - - - - &reftitle.parameters; - - - servers - - - Una lista de servidores, separados por comas, cada uno especificado según el formato 'host:port'. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Añadir dos servidores - -addServers("10.0.0.1,10.0.0.2:7003"); - -?> -]]> - - - - - - &reftitle.seealso; - - GearmanClient::addServer - - - - - diff --git a/reference/gearman/gearmanclient/addtask.xml b/reference/gearman/gearmanclient/addtask.xml deleted file mode 100644 index 473105cc18..0000000000 --- a/reference/gearman/gearmanclient/addtask.xml +++ /dev/null @@ -1,191 +0,0 @@ - - - - - - GearmanClient::addTask - Añade una tarea para ser ejecutada en paralelo - - - - &reftitle.description; - - public GearmanTaskfalseGearmanClient::addTask - stringfunction_name - stringintfloatworkload - mixedcontext&null; - stringnullunique_key&null; - - - Añade una tarea para ser ejecutada en paralelo con otras tareas. Esta - método debe ser llamado para todas las tareas a ejecutar en paralelo, y - posteriormente, debe llamarse al método GearmanClient::runTasks para ejecutar las - tareas. Tenga en cuenta que es necesario contar con suficientes agentes disponibles para ejecutar - en paralelo todas las tareas. - - - - - &reftitle.parameters; - - - function_name - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - context - - - &gearman.parameter.context; - - - - - unique_key - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - Un objeto GearmanTask o &false; - si la tarea no pudo ser añadida. - - - - - &reftitle.examples; - - - Añadir 2 tareas - -addServer(); - -# Define una función a llamar cuando el trabajo está completo -$gmclient->setCompleteCallback("complete"); - -# Añade una tarea que ejecuta la función "reverse" sobre la cadena "Hello World!" -$gmclient->addTask("reverse", "Hello World!", null, "1"); - -# Añade otra tarea que ejecuta la función "reverse" sobre la cadena "!dlroW olleH" -$gmclient->addTask("reverse", "!dlroW olleH", null, "2"); - -# Ejecuta las tareas -$gmclient->runTasks(); - -function complete($task) -{ - print "Completado : " . $task->unique() . ", " . $task->data() . "\n"; -} - -?> -]]> - - &example.outputs.similar; - - - - - - Añadir 2 tareas pasando el contexto de la aplicación - -addServer(); - -# Define una función a llamar cuando el trabajo está completo -$client->setCompleteCallback("reverse_complete"); - -# Añade algunas tareas que contienen un marcador en el lugar donde debe colocarse el resultado -$results = array(); -$client->addTask("reverse", "Hello World!", $results, "t1"); -$client->addTask("reverse", "!dlroW olleH", $results, "t2"); - -$client->runTasks(); - -# El resultado debe estar ahora contenido en las funciones de devolución de llamada -foreach ($results as $id => $result) - echo $id . ": " . $result['handle'] . ", " . $result['data'] . "\n"; - -function reverse_complete($task, $results) -{ - $results[$task->unique()] = array("handle"=>$task->jobHandle(), "data"=>$task->data()); -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - GearmanClient::addTaskHigh - GearmanClient::addTaskLow - GearmanClient::addTaskBackground - GearmanClient::addTaskHighBackground - GearmanClient::addTaskLowBackground - GearmanClient::runTasks - - - - - diff --git a/reference/gearman/gearmanclient/addtaskbackground.xml b/reference/gearman/gearmanclient/addtaskbackground.xml deleted file mode 100644 index 847025a9e5..0000000000 --- a/reference/gearman/gearmanclient/addtaskbackground.xml +++ /dev/null @@ -1,278 +0,0 @@ - - - - - - GearmanClient::addTaskBackground - Añade una tarea de fondo para su ejecución en paralelo - - - - &reftitle.description; - - public GearmanTaskfalseGearmanClient::addTaskBackground - stringfunction_name - stringintfloatworkload - mixedcontext&null; - stringnullunique_key&null; - - - Añade una tarea de fondo para su ejecución en paralelo con otras tareas. - Llámese a este método para todas las tareas que deban ejecutarse en paralelo, y - luego, llámese al método GearmanClient::runTasks para realizar las tareas. - - - - - &reftitle.parameters; - - - function_name - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - context - - - &gearman.parameter.context; - - - - - unique_key - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - Un objeto GearmanTask o &false; si la tarea - no pudo ser añadida. - - - - - &reftitle.examples; - - 2 tareas, una de ellas en segundo plano - - Este ejemplo muestra la diferencia entre la ejecución en segundo plano - y una ejecución normal. El cliente añade 2 tareas que deben ejecutar - la misma función, pero una ha sido añadida con el método - addTaskBackground. Se define una función de retorno - para monitorear el progreso del trabajo. Un agente simple con un retraso - artificial reporta el progreso y el cliente lo procesa mediante la función de retorno. - Se ejecutan 2 agentes en este ejemplo. Obsérvese que la tarea en segundo plano - no es mostrada por el cliente. - - -addServer(); - -# Define 2 funciones de retorno para monitorear el progreso -$gmc->setCompleteCallback("reverse_complete"); -$gmc->setStatusCallback("reverse_status"); - -# Añade una tarea para la función "reverse" -$task= $gmc->addTask("reverse", "Hello World!", null, "1"); - -# Añade otra tarea, pero esta vez, en segundo plano -$task= $gmc->addTaskBackground("reverse", "!dlroW olleH", null, "2"); - -if (! $gmc->runTasks()) -{ - echo "ERROR " . $gmc->error() . "\n"; - exit; -} - -echo "HECHO\n"; - -function reverse_status($task) -{ - echo "ESTADO : " . $task->unique() . ", " . $task->jobHandle() . " - " . $task->taskNumerator() . - "/" . $task->taskDenominator() . "\n"; -} - -function reverse_complete($task) -{ - echo "TERMINADO : " . $task->unique() . ", " . $task->data() . "\n"; -} - -?> -]]> - - -addServer(); - -# Registra la función "reverse" en este servidor. -$gmworker->addFunction("reverse", "reverse_fn"); - -print "Esperando trabajo...\n"; -while($gmworker->work()) -{ - if ($gmworker->returnCode() != GEARMAN_SUCCESS) - { - echo "return_code: " . $gmworker->returnCode() . "\n"; - break; - } -} - -function reverse_fn($job) -{ - echo "Trabajo recibido : " . $job->handle() . "\n"; - - $workload = $job->workload(); - $workload_size = $job->workloadSize(); - - echo "Carga del agente : $workload ($workload_size)\n"; - - # Este ciclo no es necesario, pero ayuda a entender el funcionamiento - for ($x= 0; $x < $workload_size; $x++) - { - echo "Enviando estado : " . ($x + 1) . "/$workload_size complete\n"; - $job->sendStatus($x+1, $workload_size); - $job->sendData(substr($workload, $x, 1)); - sleep(1); - } - - $result= strrev($workload); - echo "Resultado : $result\n"; - - # Se devuelve al cliente lo que se desee. - return $result; -} - -?> -]]> - - - El agente muestra, para los 2 trabajos : - - - - - - Salida del cliente : - - - - - - - - - &reftitle.seealso; - - GearmanClient::addTask - GearmanClient::addTaskHigh - GearmanClient::addTaskLow - GearmanClient::addTaskHighBackground - GearmanClient::addTaskLowBackground - GearmanClient::runTasks - - - - - diff --git a/reference/gearman/gearmanclient/addtaskhigh.xml b/reference/gearman/gearmanclient/addtaskhigh.xml deleted file mode 100644 index cdda13c51b..0000000000 --- a/reference/gearman/gearmanclient/addtaskhigh.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - GearmanClient::addTaskHigh - Añade una tarea de alta prioridad para ser ejecutada en paralelo - - - - &reftitle.description; - - public GearmanTaskfalseGearmanClient::addTaskHigh - stringfunction_name - stringintfloatworkload - mixedcontext&null; - stringnullunique_key&null; - - - Añade una tarea de alta prioridad para ser ejecutada en paralelo con otras tareas. - Esta método debe ser llamado para que todas las tareas se ejecuten simultáneamente, luego - GearmanClient::runTasks debe ser llamado para realizar el trabajo. Las tareas con alta prioridad - serán seleccionadas de la cola antes que las de prioridad más baja. - - - - - &reftitle.parameters; - - - function_name - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - context - - - &gearman.parameter.context; - - - - - unique_key - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - Un objeto GearmanTask o &false; si la tarea no puede ser añadida. - - - - - &reftitle.examples; - - Una tarea de alta prioridad junto con dos tareas normales - - Se añade una tarea de alta prioridad junto con otras dos tareas. Un solo agente - está disponible, de forma que las tareas se ejecutan una a una, con la de alta prioridad - en primer lugar. - - -addServer(); - -# establece el retorno cuando la tarea está completada -$gmc->setCompleteCallback("inverse_complete"); - -# añade tareas, una de ellas con alta prioridad -$task= $gmc->addTask("inverse", "Bonjour le monde!", null, "1"); -$task= $gmc->addTaskHigh("inverse", "!ednom el ruojnoB", null, "2"); -$task= $gmc->addTask("inverse", "Bonjour le monde!", null, "3"); - -if (! $gmc->runTasks()) -{ - echo "ERROR " . $gmc->error() . "\n"; - exit; -} -echo "Hecho\n"; - -function inverse_complete($task) -{ - echo "Completada : " . $task->unique() . ", " . $task->data() . "\n"; -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - GearmanClient::addTask - GearmanClient::addTaskLow - GearmanClient::addTaskBackground - GearmanClient::addTaskHighBackground - GearmanClient::addTaskLowBackground - GearmanClient::runTasks - - - - - diff --git a/reference/gearman/gearmanclient/addtaskhighbackground.xml b/reference/gearman/gearmanclient/addtaskhighbackground.xml deleted file mode 100644 index 3783f5937b..0000000000 --- a/reference/gearman/gearmanclient/addtaskhighbackground.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - GearmanClient::addTaskHighBackground - Añade una tarea de fondo de alta prioridad para ser ejecutada en paralelo - - - - &reftitle.description; - - public GearmanTaskfalseGearmanClient::addTaskHighBackground - stringfunction_name - stringintfloatworkload - mixedcontext&null; - stringnullunique_key&null; - - - Añade una tarea de fondo de alta prioridad para ser ejecutada en paralelo con otras tareas. - Esta método debe ser llamado para que todas las tareas sean ejecutadas simultáneamente, luego - GearmanClient::runTasks debe ser llamado para realizar el trabajo. Las tareas con alta prioridad - serán seleccionadas de la cola antes que las de prioridad más baja. - - - - - &reftitle.parameters; - - - function_name - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - context - - - &gearman.parameter.context; - - - - - unique_key - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - Un objeto GearmanTask o &false; si la tarea no puede ser añadida. - - - - - &reftitle.seealso; - - GearmanClient::addTask - GearmanClient::addTaskHigh - GearmanClient::addTaskLow - GearmanClient::addTaskBackground - GearmanClient::addTaskLowBackground - GearmanClient::runTasks - - - - - diff --git a/reference/gearman/gearmanclient/addtasklow.xml b/reference/gearman/gearmanclient/addtasklow.xml deleted file mode 100644 index 6f9df82545..0000000000 --- a/reference/gearman/gearmanclient/addtasklow.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - GearmanClient::addTaskLow - Añade una tarea de baja prioridad para ser ejecutada en paralelo - - - - &reftitle.description; - - public GearmanTaskfalseGearmanClient::addTaskLow - stringfunction_name - stringintfloatworkload - mixedcontext&null; - stringnullunique_key&null; - - - Añade una tarea de baja prioridad para ser ejecutada en paralelo con otras tareas. - Esta método debe ser llamado para que todas las tareas se ejecuten simultáneamente, luego - debe llamarse a GearmanClient::runTasks para realizar el trabajo. Las tareas con baja prioridad - serán seleccionadas de la cola después de las de mayor prioridad. - - - - - &reftitle.parameters; - - - function_name - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - context - - - &gearman.parameter.context; - - - - - unique_key - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - Un objeto GearmanTask o &false; si la tarea no puede ser añadida. - - - - - &reftitle.examples; - - Una tarea de baja prioridad junto con dos tareas normales - - Se añade una tarea de baja prioridad junto con otras dos tareas. Solo hay un agente - disponible, por lo que las tareas se ejecutan una tras otra, con la de baja prioridad - al final. - - -addServer(); - -# establece la devolución de llamada cuando la tarea está completada -$gmc->setCompleteCallback("inverse_complete"); - -# añade tareas, una de ellas con baja prioridad -$task= $gmc->addTask("inverse", "¡Hola mundo!", null, "1"); -$task= $gmc->addTaskLow("inverse", "!ednom el ruojnoB", null, "2"); -$task= $gmc->addTask("inverse", "¡Hola mundo!", null, "3"); - -if (! $gmc->runTasks()) -{ - echo "ERROR " . $gmc->error() . "\n"; - exit; -} -echo "Hecho\n"; - -function inverse_complete($task) -{ - echo "Completada : " . $task->unique() . ", " . $task->data() . "\n"; -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - GearmanClient::addTask - GearmanClient::addTaskHigh - GearmanClient::addTaskBackground - GearmanClient::addTaskHighBackground - GearmanClient::addTaskLowBackground - GearmanClient::runTasks - - - - - diff --git a/reference/gearman/gearmanclient/addtasklowbackground.xml b/reference/gearman/gearmanclient/addtasklowbackground.xml deleted file mode 100644 index e456d4eca0..0000000000 --- a/reference/gearman/gearmanclient/addtasklowbackground.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - GearmanClient::addTaskLowBackground - Añade una tarea de fondo de baja prioridad para ser ejecutada en paralelo - - - - &reftitle.description; - - public GearmanTaskfalseGearmanClient::addTaskLowBackground - stringfunction_name - stringintfloatworkload - mixedcontext&null; - stringnullunique_key&null; - - - Añade una tarea de fondo de baja prioridad para ser ejecutada en paralelo con otras tareas. - Esta método debe ser llamado para que todas las tareas sean ejecutadas simultáneamente, luego - GearmanClient::runTasks debe ser llamado para realizar el trabajo. Las tareas con baja prioridad - serán seleccionadas de la cola después de las de mayor prioridad. - - - - - &reftitle.parameters; - - - function_name - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - context - - - &gearman.parameter.context; - - - - - unique_key - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - Un objeto GearmanTask o &false; si la tarea no puede ser añadida. - - - - - &reftitle.seealso; - - GearmanClient::addTask - GearmanClient::addTaskHigh - GearmanClient::addTaskLow - GearmanClient::addTaskBackground - GearmanClient::addTaskHighBackground - GearmanClient::runTasks - - - - - diff --git a/reference/gearman/gearmanclient/addtaskstatus.xml b/reference/gearman/gearmanclient/addtaskstatus.xml deleted file mode 100644 index fd26b9ba91..0000000000 --- a/reference/gearman/gearmanclient/addtaskstatus.xml +++ /dev/null @@ -1,160 +0,0 @@ - - - - - - GearmanClient::addTaskStatus - Añade una tarea para obtener el estado - - - - &reftitle.description; - - public GearmanTaskfalseGearmanClient::addTaskStatus - stringjob_handle - mixedcontext&null; - - - Utilizado para solicitar el estado al servidor Gearman, que llamará al retorno de estado - especificado (mediante GearmanClient::setStatusCallback). - - - - - &reftitle.parameters; - - - job_handle - - - El descriptor para la tarea cuyo estado se desea obtener - - - - - context - - - Los datos a pasar al retorno de estado, generalmente una referencia a un array o a un objeto - - - - - - - - &reftitle.returnvalues; - - Un objeto GearmanTask o &false; en caso de error. - - - - - &reftitle.examples; - - Supervisar la finalización de múltiples tareas en segundo plano - - Un retraso artificial se introduce en el agente de este ejemplo para simular un - proceso largo. Solo se lanza un agente en este ejemplo. - - -addServer(); - -/* lanza una tarea en segundo plano y guarda los descriptores */ -$handles = array(); -$handles[0] = $gmclient->doBackground("inverse", "¡Hola mundo!"); -$handles[1] = $gmclient->doBackground("inverse", "!ednom el ruojnoB"); - -$gmclient->setStatusCallback("inverse_estado"); - -/* Consulta al servidor para ver cuándo las tareas en segundo plano terminan; */ -/* un método mejor consiste en llamar a los retornos de evento */ -do -{ - /* Utiliza la variable de contexto para saber cuántas tareas se han completado */ - $done = 0; - $gmclient->addTaskStatus($handles[0], $done); - $gmclient->addTaskStatus($handles[1], $done); - $gmclient->runTasks(); - echo "Completado: $done\n"; - sleep(1); -} -while ($done != 2); - -function inverse_estado($task, $done) -{ - if (!$task->isKnown()) - $done++; -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - GearmanClient::setStatusCallback - - - - - diff --git a/reference/gearman/gearmanclient/clearcallbacks.xml b/reference/gearman/gearmanclient/clearcallbacks.xml deleted file mode 100644 index 8423241110..0000000000 --- a/reference/gearman/gearmanclient/clearcallbacks.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - GearmanClient::clearCallbacks - Elimina todas las funciones de retrollamada de las tareas - - - - &reftitle.description; - - public boolGearmanClient::clearCallbacks - - - - Elimina todas las funciones de retrollamada de las tareas previamente definidas. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Siempre devuelve &true;. - - - - - &reftitle.seealso; - - GearmanClient::setDataCallback - GearmanClient::setCompleteCallback - GearmanClient::setCreatedCallback - GearmanClient::setExceptionCallback - GearmanClient::setFailCallback - GearmanClient::setStatusCallback - GearmanClient::setWarningCallback - GearmanClient::setWorkloadCallback - - - - - diff --git a/reference/gearman/gearmanclient/clone.xml b/reference/gearman/gearmanclient/clone.xml deleted file mode 100644 index 5481ef84a7..0000000000 --- a/reference/gearman/gearmanclient/clone.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - GearmanClient::clone - Crea una copia de un objeto GearmanClient - - - - &reftitle.description; - - public GearmanClientGearmanClient::clone - - - - Crea una copia de un objeto GearmanClient. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un GearmanClient en caso de éxito, &false; si hay fallo. - - - - - diff --git a/reference/gearman/gearmanclient/construct.xml b/reference/gearman/gearmanclient/construct.xml deleted file mode 100644 index d9fbf83bbb..0000000000 --- a/reference/gearman/gearmanclient/construct.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - GearmanClient::__construct - Crea una instancia GearmanClient - - - - &reftitle.description; - - public GearmanClient::__construct - - - - Crea una instancia GearmanClient que representa un cliente - que se conecta a un servidor de tareas y registra tareas a ejecutar. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objeto GearmanClient. - - - - - &reftitle.seealso; - - GearmanClient::clone - - - - - diff --git a/reference/gearman/gearmanclient/context.xml b/reference/gearman/gearmanclient/context.xml deleted file mode 100644 index e60aa9615c..0000000000 --- a/reference/gearman/gearmanclient/context.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - GearmanClient::context - Recupera el contexto de la aplicación - - - - &reftitle.description; - - public stringGearmanClient::context - - - - Recupera el contexto de la aplicación previamente definido - con el método GearmanClient::setContext. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Los datos de contexto idénticos a los definidos - con la función GearmanClient::setContext - - - - - &reftitle.seealso; - - GearmanClient::setContext - - - - - diff --git a/reference/gearman/gearmanclient/data.xml b/reference/gearman/gearmanclient/data.xml deleted file mode 100644 index 9489041575..0000000000 --- a/reference/gearman/gearmanclient/data.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - GearmanClient::data - Retorna los datos de aplicación (obsoleto) - - - - &reftitle.description; - - public stringGearmanClient::data - - - - Obtiene los datos de aplicación fijados anteriormente con - GearmanClient::setData. - - - - Este método fue reemplazado por - GearmanClient::setContext en la versión 0.6.0 de la - extensión Gearman. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El mismo string de datos que fue establecido con - GearmanClient::setData - - - - - &reftitle.seealso; - - GearmanClient::setData - - - - - diff --git a/reference/gearman/gearmanclient/do.xml b/reference/gearman/gearmanclient/do.xml deleted file mode 100644 index 67e7a62320..0000000000 --- a/reference/gearman/gearmanclient/do.xml +++ /dev/null @@ -1,322 +0,0 @@ - - - - - - - GearmanClient::do - Ejecuta una sola tarea y retorna el resultado [obsoleto] - - - - &reftitle.description; - - public stringGearmanClient::do - stringfunction_name - stringworkload - stringunique - - - El método GearmanClient::do es obsoleto desde - pecl/gearman 1.0.0. Use GearmanClient::doNormal. - - - - - &reftitle.parameters; - - - function_name - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - unique - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - Un string representando el resultado de la tarea ejecutada. - - - - - &reftitle.examples; - - - Envío de un trabajo con retorno inmediato - -addServer(); - -echo "Sending job\n"; - -$result = $gmclient->doNormal("reverse", "Hello!"); - -echo "Success: $result\n"; - -?> -]]> - - -addServer(); - -# Registra la función "reverse" en el servidor. Cambiar la función del trabajador -# a "reverse_fn_fast" para usar un trabajar más rápido que no genera salida. -$gmworker->addFunction("reverse", "reverse_fn"); - -print "Waiting for job...\n"; -while($gmworker->work()) -{ - if ($gmworker->returnCode() != GEARMAN_SUCCESS) - { - echo "return_code: " . $gmworker->returnCode() . "\n"; - break; - } -} - -function reverse_fn($job) -{ - return strrev($job->workload()); -} - -?> -]]> - - &example.outputs.similar; - - - - - - Envío de un trabajo y obtención del estado incremental - - Se envía un trabajo y el script comprueba constantemente mediante un bucle - la información de estado. El trabajador tiene un retardo artificial que - provoca un trabajo de larga duración y envía el estado y datos según se van - procesando. - Cada llamada a GearmanClient::do produce información - de estado del trabajo en ejecución. - - -addServer(); - -echo "Sending job\n"; - -# Enviamos trabajo "reverse" -do -{ - $result = $gmclient->doNormal("reverse", "Hello!"); - # Comprobamos llegada de posibles paquetes y errores - - switch($gmclient->returnCode()) - { - case GEARMAN_WORK_DATA: - echo "Data: $result\n"; - break; - case GEARMAN_WORK_STATUS: - list($numerator, $denominator)= $gmclient->doStatus(); - echo "Status: $numerator/$denominator complete\n"; - break; - case GEARMAN_WORK_FAIL: - echo "Failed\n"; - exit; - case GEARMAN_SUCCESS: - break; - default: - echo "RET: " . $gmclient->returnCode() . "\n"; - echo "Error: " . $gmclient->error() . "\n"; - echo "Errno: " . $gmclient->getErrno() . "\n"; - exit; - } -} -while($gmclient->returnCode() != GEARMAN_SUCCESS); - -echo "Success: $result\n"; - -?> -]]> - - -addServer(); - -# Registramos la función "reverse" en el servidor -$gmworker->addFunction("reverse", "reverse_fn"); - -print "Waiting for job...\n"; -while($gmworker->work()) -{ - if ($gmworker->returnCode() != GEARMAN_SUCCESS) - { - echo "return_code: " . $gmworker->returnCode() . "\n"; - break; - } -} - -function reverse_fn($job) -{ - echo "Received job: " . $job->handle() . "\n"; - - $workload = $job->workload(); - $workload_size = $job->workloadSize(); - - echo "Workload: $workload ($workload_size)\n"; - - # Este bucle para comprobar el estado no es necesario, tan sólo muestra como funciona - for ($x= 0; $x < $workload_size; $x++) - { - echo "Sending status: " + $x + 1 . "/$workload_size complete\n"; - $job->sendStatus($x+1, $workload_size); - $job->sendData(substr($workload, $x, 1)); - sleep(1); - } - - $result= strrev($workload); - echo "Result: $result\n"; - - # Retornamos lo que queremos enviar al cliente - return $result; -} - -?> -]]> - - &example.outputs.similar; - - Worker output: - - - - - - Client output: - - - - - - - - - - &reftitle.seealso; - - GearmanClient::doHigh - GearmanClient::doLow - GearmanClient::doBackground - GearmanClient::doHighBackground - GearmanClient::doLowBackground - - - - - diff --git a/reference/gearman/gearmanclient/dobackground.xml b/reference/gearman/gearmanclient/dobackground.xml deleted file mode 100644 index 392e8feb35..0000000000 --- a/reference/gearman/gearmanclient/dobackground.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - GearmanClient::doBackground - Ejecuta una tarea en segundo plano - - - - &reftitle.description; - - public stringGearmanClient::doBackground - stringfunction - stringworkload - stringnullunique&null; - - - Ejecuta una tarea en segundo plano, devuelve el gestor de trabajos - que podrá ser utilizado para recuperar el estado de la tarea en curso. - - - - - &reftitle.parameters; - - - function - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - unique - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - El gestor de trabajos para la tarea enviada. - - - - - &reftitle.examples; - - Envía y supervisa un trabajo en segundo plano - - El agente de este ejemplo tiene un retraso artificial introducido para simular - un trabajo cuya ejecución tarda mucho tiempo. El script del - cliente verifica periódicamente el estado del trabajo en curso. - - -addServer(); - -/* Ejecuta el cliente */ -$job_handle = $gmclient->doBackground("reverse", "this is a test"); - -if ($gmclient->returnCode() != GEARMAN_SUCCESS) -{ - echo "Código de retorno erróneo\n"; - exit; -} - -$done = false; -do -{ - sleep(3); - $stat = $gmclient->jobStatus($job_handle); - if (!$stat[0]) // la tarea es conocida por lo que no está terminada - $done = true; - echo "Ejecución : " . ($stat[1] ? "true" : "false") . ", numerador : " . $stat[2] . ", denominador : " . $stat[3] . "\n"; -} -while(!$done); - -echo "hecho !\n"; - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - GearmanClient::doNormal - GearmanClient::doHigh - GearmanClient::doLow - GearmanClient::doHighBackground - GearmanClient::doLowBackground - - - - - diff --git a/reference/gearman/gearmanclient/dohigh.xml b/reference/gearman/gearmanclient/dohigh.xml deleted file mode 100644 index 9f927f7597..0000000000 --- a/reference/gearman/gearmanclient/dohigh.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - GearmanClient::doHigh - Ejecuta una sola tarea con prioridad alta - - - - &reftitle.description; - - public stringGearmanClient::doHigh - stringfunction - stringworkload - stringnullunique&null; - - - Ejecuta una sola tarea con prioridad alta y devuelve una representación - del resultado en forma de &string;. Corresponde a las funciones - GearmanClient y GearmanWorker acordar - el formato del resultado. Las tareas con prioridad alta se ejecutarán antes que aquellas - con prioridad normal o baja en la cola de espera. - - - - - &reftitle.parameters; - - - function - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - unique - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - El resultado de la tarea en forma de &string;. - - - - - &reftitle.seealso; - - GearmanClient::doNormal - GearmanClient::doLow - GearmanClient::doBackground - GearmanClient::doHighBackground - GearmanClient::doLowBackground - - - - - diff --git a/reference/gearman/gearmanclient/dohighbackground.xml b/reference/gearman/gearmanclient/dohighbackground.xml deleted file mode 100644 index 2d92c26989..0000000000 --- a/reference/gearman/gearmanclient/dohighbackground.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - GearmanClient::doHighBackground - Ejecuta una tarea con prioridad alta en segundo plano - - - - &reftitle.description; - - public stringGearmanClient::doHighBackground - stringfunction - stringworkload - stringnullunique&null; - - - Ejecuta una tarea con prioridad alta en segundo plano, y devuelve - un manejador de trabajo que puede ser utilizado para recuperar - el estado de la tarea. Las tareas con prioridad alta serán ejecutadas - antes que las normales y las bajas de la cola. - - - - - &reftitle.parameters; - - - function - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - unique - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - El manejador de trabajo de la tarea añadida. - - - - - &reftitle.seealso; - - GearmanClient::doNormal - GearmanClient::doHigh - GearmanClient::doLow - GearmanClient::doBackground - GearmanClient::doLowBackground - - - - - diff --git a/reference/gearman/gearmanclient/dojobhandle.xml b/reference/gearman/gearmanclient/dojobhandle.xml deleted file mode 100644 index eeef6c905d..0000000000 --- a/reference/gearman/gearmanclient/dojobhandle.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - GearmanClient::doJobHandle - Obtiene el manejador de trabajos para la tarea en curso - - - - &reftitle.description; - - public stringGearmanClient::doJobHandle - - - - Obtiene el manejador de trabajos para la tarea en curso. Puede ser - utilizado durante múltiples llamadas al método GearmanClient::doNormal. - El manejador de trabajos puede entonces ser utilizado para recuperar las - informaciones sobre la tarea. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El manejador de trabajos para la tarea en curso. - - - - - &reftitle.seealso; - - GearmanClient::jobStatus - - - - - diff --git a/reference/gearman/gearmanclient/dolow.xml b/reference/gearman/gearmanclient/dolow.xml deleted file mode 100644 index e66f469bcd..0000000000 --- a/reference/gearman/gearmanclient/dolow.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - GearmanClient::doLow - Ejecuta una sola tarea con prioridad baja - - - - &reftitle.description; - - public stringGearmanClient::doLow - stringfunction - stringworkload - stringnullunique&null; - - - Ejecuta una sola tarea con prioridad baja y devuelve una representación en forma de &string; del resultado. Es responsabilidad de los métodos - GearmanClient y GearmanWorker validar - el formato del resultado. Las tareas con prioridad normal o alta serán tratadas con preferencia frente a las tareas con prioridad baja en la cola de espera. - - - - - &reftitle.parameters; - - - function - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - unique - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - Una representación en forma de &string; del resultado de la tarea en curso. - - - - - &reftitle.seealso; - - GearmanClient::doNormal - GearmanClient::doHigh - GearmanClient::doBackground - GearmanClient::doHighBackground - GearmanClient::doLowBackground - - - - - diff --git a/reference/gearman/gearmanclient/dolowbackground.xml b/reference/gearman/gearmanclient/dolowbackground.xml deleted file mode 100644 index 68e9e5a6c1..0000000000 --- a/reference/gearman/gearmanclient/dolowbackground.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - GearmanClient::doLowBackground - Ejecuta una tarea en prioridad baja en segundo plano - - - - &reftitle.description; - - public stringGearmanClient::doLowBackground - stringfunction - stringworkload - stringnullunique&null; - - - Ejecuta una tarea en prioridad baja en segundo plano, luego, devuelve - el gestor de trabajos que podrá ser utilizado para recuperar el estado - de la tarea en curso. Las tareas con prioridad normal y alta tendrán - prioridad sobre aquellas con prioridad baja en la cola. - - - - - &reftitle.parameters; - - - function - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - unique - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - El gestor de trabajos de la tarea enviada. - - - - - &reftitle.seealso; - - GearmanClient::doNormal - GearmanClient::doHigh - GearmanClient::doLow - GearmanClient::doBackground - GearmanClient::doHighBackground - - - - - diff --git a/reference/gearman/gearmanclient/donormal.xml b/reference/gearman/gearmanclient/donormal.xml deleted file mode 100644 index 46baec39a1..0000000000 --- a/reference/gearman/gearmanclient/donormal.xml +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - GearmanClient::doNormal - Ejecuta una tarea y devuelve el resultado - - - - &reftitle.description; - - public stringGearmanClient::doNormal - stringfunction - stringworkload - stringnullunique&null; - - - Ejecuta una tarea y devuelve una &string; que representa - el resultado. Corresponde a las clases GearmanClient - y GearmanWorker aceptar el formato del resultado. - - - - - &reftitle.parameters; - - - function - - - &gearman.parameter.functionname; - - - - - workload - - - &gearman.parameter.workload; - - - - - unique - - - &gearman.parameter.unique; - - - - - - - - &reftitle.returnvalues; - - Una &string; que representa el resultado de la tarea ejecutada. - - - - - &reftitle.examples; - - - Envío de una tarea con retorno inmediato - - -]]> - - -addServer(); - -echo "Envío de la tarea\n"; - -$result = $gmclient->doNormal("reverse", "Hello!"); - -echo "Éxito: $result\n"; - -?> -]]> - - -addServer(); - -# Registro de la función "reverse" con el servidor. Modifica la función worker -# a "reverse_fn_fast" para un worker más rápido sin salida. -$gmworker->addFunction("reverse", "reverse_fn"); - -print "Esperando una tarea...\n"; -while($gmworker->work()) -{ - if ($gmworker->returnCode() != GEARMAN_SUCCESS) - { - echo "return_code: " . $gmworker->returnCode() . "\n"; - break; - } -} - -function reverse_fn($job) -{ - return strrev($job->workload()); -} - -?> -]]> - - &example.outputs.similar; - - - - - - Envío de una tarea y recuperación incremental del estado - - Una tarea es enviada y el script se ejecuta en bucle para recuperar las - informaciones de estado. El worker tiene un retraso artificial que lo convierte en una tarea larga - y envía el estado y los datos cuando la ejecución ocurre. - Cada subllamada a la función GearmanClient::doNormal - produce informaciones de estado sobre la tarea en curso. - - -addServer(); - -echo "Envío de la tarea\n"; - -# Envío de la tarea reverse -do -{ - $result = $gmclient->doNormal("reverse", "Hello!"); - # Verifica los paquetes devueltos así como los errores. - - switch($gmclient->returnCode()) - { - case GEARMAN_WORK_DATA: - echo "Datos: $result\n"; - break; - case GEARMAN_WORK_STATUS: - list($numerator, $denominator)= $gmclient->doStatus(); - echo "Estado: $numerator/$denominator completado\n"; - break; - case GEARMAN_WORK_FAIL: - echo "Fallo\n"; - exit; - case GEARMAN_SUCCESS: - break; - default: - echo "RET: " . $gmclient->returnCode() . "\n"; - echo "Error: " . $gmclient->error() . "\n"; - echo "Errno: " . $gmclient->getErrno() . "\n"; - exit; - } -} -while($gmclient->returnCode() != GEARMAN_SUCCESS); - -echo "Éxito: $result\n"; - -?> -]]> - - -addServer(); - -# Registro de la función "reverse" con el servidor. -$gmworker->addFunction("reverse", "reverse_fn"); - -print "Esperando una tarea...\n"; -while($gmworker->work()) -{ - if ($gmworker->returnCode() != GEARMAN_SUCCESS) - { - echo "return_code: " . $gmworker->returnCode() . "\n"; - break; - } -} - -function reverse_fn($job) -{ - echo "Tarea recibida: " . $job->handle() . "\n"; - - $workload = $job->workload(); - $workload_size = $job->workloadSize(); - - echo "Workload: $workload ($workload_size)\n"; - - # Este bucle de estado no es necesario, solo muestra cómo funciona - for ($x= 0; $x < $workload_size; $x++) - { - echo "Envío del estado: " . $x + 1 . "/$workload_size completado\n"; - $job->sendStatus($x+1, $workload_size); - $job->sendData(substr($workload, $x, 1)); - sleep(1); - } - - $result= strrev($workload); - echo "Resultado: $result\n"; - - # Devuelve lo que se desea devolver al cliente. - return $result; -} - -?> -]]> - - &example.outputs.similar; - - Salida del worker: - - - - - - Salida del cliente: - - - - - - - - - - &reftitle.seealso; - - GearmanClient::doHigh - GearmanClient::doLow - GearmanClient::doBackground - GearmanClient::doHighBackground - GearmanClient::doLowBackground - - - - - diff --git a/reference/gearman/gearmanclient/dostatus.xml b/reference/gearman/gearmanclient/dostatus.xml deleted file mode 100644 index c8d3565be2..0000000000 --- a/reference/gearman/gearmanclient/dostatus.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - GearmanClient::doStatus - Recupera el estado de la tarea en curso - - - - &reftitle.description; - - public arrayGearmanClient::doStatus - - - - Devuelve el estado de la tarea en curso. Puede ser utilizado durante - múltiples llamadas al método GearmanClient::doNormal. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un array que representa el porcentaje de realización proporcionado en forma - de fracción, donde el primer elemento es el numerador, y el segundo, - el denominador. - - - - - &reftitle.examples; - - Recupera el estado de un trabajo cuya ejecución tarda tiempo - - El agente en este ejemplo tiene un retraso artificial añadido durante la ejecución de la - función. Después de cada retraso, llama al método GearmanJob::status - del cual el cliente recupera la información. - - -addServer(); - -echo "Envío de un trabajo\n"; - -# Envío del trabajo -do -{ - $result = $gmclient->doNormal("reverse", "Hello!"); - - # Verifica los diferentes paquetes y errores devueltos. - switch($gmclient->returnCode()) - { - case GEARMAN_WORK_DATA: - break; - case GEARMAN_WORK_STATUS: - # Recupera el estado del trabajo en curso - list($numerator, $denominator)= $gmclient->doStatus(); - echo "Estado : $numerator/$denominator complete\n"; - break; - case GEARMAN_WORK_FAIL: - echo "Fallo \n"; - exit; - case GEARMAN_SUCCESS: - break; - default: - echo "RET : " . $gmclient->returnCode() . "\n"; - exit; - } -} -while($gmclient->returnCode() != GEARMAN_SUCCESS); - -echo "Éxito : $result\n"; - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - GearmanClient::doNormal - GearmanJob::status - - - - - diff --git a/reference/gearman/gearmanclient/echo.xml b/reference/gearman/gearmanclient/echo.xml deleted file mode 100644 index 3b57a4a491..0000000000 --- a/reference/gearman/gearmanclient/echo.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - GearmanClient::echo - Envía datos a todos los servidores de trabajo para ver si retornan [obsoleto] - - - - &reftitle.description; - - public boolGearmanClient::echo - stringworkload - - - El método GearmanClient::echo es obsoleto desde - pecl/gearman 1.0.0. Use GearmanClient::ping. - - - - - &reftitle.parameters; - - - workload - - - Datos arbitrarios serializados a ser retornados - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/gearman/gearmanclient/error.xml b/reference/gearman/gearmanclient/error.xml deleted file mode 100644 index ae58430fdd..0000000000 --- a/reference/gearman/gearmanclient/error.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - GearmanClient::error - Devuelve el último error encontrado en forma de &string; - - - - &reftitle.description; - - public stringfalseGearmanClient::error - - - - Devuelve el último error encontrado en forma de &string;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un &string; legible por humanos que representa el último error ocurrido, - o &false; si no hay mensaje de error disponible. - - - - - &reftitle.seealso; - - GearmanClient::getErrno - - - - - diff --git a/reference/gearman/gearmanclient/geterrno.xml b/reference/gearman/gearmanclient/geterrno.xml deleted file mode 100644 index 42f57a5aa1..0000000000 --- a/reference/gearman/gearmanclient/geterrno.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - GearmanClient::getErrno - Obtiene el valor de errno - - - - &reftitle.description; - - public intGearmanClient::getErrno - - - - Devuelve el valor de errno en el caso de un valor de retorno GEARMAN_ERRNO. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un valor de errno de Gearman válido. - - - - - &reftitle.seealso; - - GearmanClient::error - - - - - diff --git a/reference/gearman/gearmanclient/jobstatus.xml b/reference/gearman/gearmanclient/jobstatus.xml deleted file mode 100644 index 2436ab42b6..0000000000 --- a/reference/gearman/gearmanclient/jobstatus.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - GearmanClient::jobStatus - gearman_job_status - Recupera el estado de un trabajo en segundo plano - - - - &reftitle.description; - &style.oop; (método) : - - public arrayGearmanClient::jobStatus - stringjob_handle - - - Recupera el estado de un trabajo en segundo plano para el gestor de - trabajos proporcionado. Las informaciones de estado especifican si el trabajo es conocido, - si el trabajo está actualmente en ejecución, así como el porcentaje - de realización. - - - - - &reftitle.parameters; - - - job_handle - - - &gearman.parameter.jobhandle; - - - - - - - - &reftitle.returnvalues; - - Un array que contiene las informaciones de estado para el trabajo - correspondiente al gestor de trabajos proporcionado. El primer elemento es un - bool indicando si el trabajo es conocido, el segundo es un bool indicando - si el trabajo está en ejecución, el tercero y el cuarto corresponden al numerador y denominador del porcentaje de realización. - - - - - &reftitle.examples; - - Supervisa el estado de un trabajo en segundo plano que tarda en ejecutarse - -addServer(); - -/* Ejecuta el cliente */ -$job_handle = $gmclient->doBackground("reverse", "this is a test"); - -if ($gmclient->returnCode() != GEARMAN_SUCCESS) -{ - echo "Código de retorno incorrecto\n"; - exit; -} - -$done = false; -do -{ - sleep(3); - $stat = $gmclient->jobStatus($job_handle); - if (!$stat[0]) // el trabajo es conocido, significando que no ha terminado - $done = true; - echo "Ejecución : " . ($stat[1] ? "true" : "false") . ", numerador : " . $stat[2] . ", denominador : " . $stat[3] . "\n"; -} -while(!$done); - -echo "hecho !\n"; - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - GearmanClient::doStatus - - - - - diff --git a/reference/gearman/gearmanclient/ping.xml b/reference/gearman/gearmanclient/ping.xml deleted file mode 100644 index f615576963..0000000000 --- a/reference/gearman/gearmanclient/ping.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - GearmanClient::ping - Envío de datos a todos los servidores de tareas para verificar que siguen en funcionamiento - - - - &reftitle.description; - - public boolGearmanClient::ping - stringworkload - - - Envío de datos arbitrarios a todos los servidores de tareas para - verificar que siguen en funcionamiento. Los datos enviados no son - utilizados ni analizados en ningún caso. La utilidad principal de - esta función es durante las pruebas y la depuración. - - - - - &reftitle.parameters; - - - workload - - - Algunos datos arbitrarios que serán devueltos. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/gearman/gearmanclient/removeoptions.xml b/reference/gearman/gearmanclient/removeoptions.xml deleted file mode 100644 index 13977829de..0000000000 --- a/reference/gearman/gearmanclient/removeoptions.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - GearmanClient::removeOptions - Elimina las opciones del cliente - - - - &reftitle.description; - - public boolGearmanClient::removeOptions - intoption - - - Elimina una o varias opciones. - - - - - &reftitle.parameters; - - - option - - - Las opciones a eliminar. - - - - - - - - &reftitle.returnvalues; - - Siempre devuelve &true;. - - - - - diff --git a/reference/gearman/gearmanclient/returncode.xml b/reference/gearman/gearmanclient/returncode.xml deleted file mode 100644 index 0decb99f8c..0000000000 --- a/reference/gearman/gearmanclient/returncode.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - GearmanClient::returnCode - Obtiene el último código Gearman devuelto - - - - &reftitle.description; - - public intGearmanClient::returnCode - - - - Devuelve el último código Gearman devuelto. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un código de retorno Gearman válido. - - - - - diff --git a/reference/gearman/gearmanclient/runtasks.xml b/reference/gearman/gearmanclient/runtasks.xml deleted file mode 100644 index ca02cc48c9..0000000000 --- a/reference/gearman/gearmanclient/runtasks.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - GearmanClient::runTasks - Ejecuta una lista de tareas en paralelo - - - - &reftitle.description; - - public boolGearmanClient::runTasks - - - - Para un conjunto de tareas previamente añadidas con los métodos GearmanClient::addTask, - GearmanClient::addTaskHigh, GearmanClient::addTaskLow, - GearmanClient::addTaskBackground, GearmanClient::addTaskHighBackground, o - GearmanClient::addTaskLowBackground, este método - inicia la ejecución de las tareas en paralelo. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanClient::addTask - - - - - diff --git a/reference/gearman/gearmanclient/setclientcallback.xml b/reference/gearman/gearmanclient/setclientcallback.xml deleted file mode 100644 index 7cf3f16bfe..0000000000 --- a/reference/gearman/gearmanclient/setclientcallback.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - GearmanClient::setClientCallback - Define una función de retrollamada cuando se recibe un paquete de datos para una tarea (obsoleto) - - - - &reftitle.description; - - public voidGearmanClient::setClientCallback - callablecallback - - - Define una función de retrollamada cuando se recibe un paquete de datos para una tarea. - - - - Este método ha sido reemplazado por el método - GearmanClient::setDataCallback desde - la versión 0.6.0 de la extensión Gearman. - - - &gearman.note.callback; - - - - &reftitle.parameters; - - &gearman.parameter.callback; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanClient::setCompleteCallback - GearmanClient::setCreatedCallback - GearmanClient::setDataCallback - GearmanClient::setExceptionCallback - GearmanClient::setFailCallback - GearmanClient::setStatusCallback - GearmanClient::setWarningCallback - GearmanClient::setWorkloadCallback - - - - - diff --git a/reference/gearman/gearmanclient/setcompletecallback.xml b/reference/gearman/gearmanclient/setcompletecallback.xml deleted file mode 100644 index 30fbe35872..0000000000 --- a/reference/gearman/gearmanclient/setcompletecallback.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - GearmanClient::setCompleteCallback - Define una función a llamar una vez finalizada la tarea - - - - &reftitle.description; - - public boolGearmanClient::setCompleteCallback - callablecallback - - - Define una función de retrollamada a ejecutar cuando una GearmanTask - finaliza, o cuando GearmanJob::sendComplete es - llamado por el worker (dependiendo de lo que ocurra primero). - - - Esta función de retrollamada se ejecuta únicamente durante la ejecución de una GearmanTask mediante GearmanClient::runTasks. - No se utiliza para trabajos individuales. - - &gearman.note.callback; - - - - &reftitle.parameters; - - &gearman.parameter.callback; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanClient::setDataCallback - GearmanClient::setCreatedCallback - GearmanClient::setExceptionCallback - GearmanClient::setFailCallback - GearmanClient::setStatusCallback - GearmanClient::setWarningCallback - GearmanClient::setWorkloadCallback - - - - - diff --git a/reference/gearman/gearmanclient/setcontext.xml b/reference/gearman/gearmanclient/setcontext.xml deleted file mode 100644 index 915abf0d99..0000000000 --- a/reference/gearman/gearmanclient/setcontext.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - GearmanClient::setContext - Define el contexto de una aplicación - - - - &reftitle.description; - - public boolGearmanClient::setContext - stringdata - - - Define una cadena arbitraria para proporcionar como contexto de - la aplicación que podrá ser recuperada más tarde mediante el método - GearmanClient::context. - - - - - &reftitle.parameters; - - - data - - - Datos de contexto - - - - - - - - &reftitle.returnvalues; - - Siempre devuelve &true;. - - - - - &reftitle.seealso; - - GearmanClient::context - - - - - diff --git a/reference/gearman/gearmanclient/setcreatedcallback.xml b/reference/gearman/gearmanclient/setcreatedcallback.xml deleted file mode 100644 index c551493b0a..0000000000 --- a/reference/gearman/gearmanclient/setcreatedcallback.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - GearmanClient::setCreatedCallback - Define una función de retrollamada a llamar cuando una tarea es colocada en la cola - - - - &reftitle.description; - - public boolGearmanClient::setCreatedCallback - callablecallback - - - Define una función de retrollamada a llamar cuando una tarea es colocada en la cola - del servidor de trabajos gearman. - - &gearman.note.callback; - - - - &reftitle.parameters; - - &gearman.parameter.callback; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanClient::setDataCallback - GearmanClient::setCompleteCallback - GearmanClient::setExceptionCallback - GearmanClient::setFailCallback - GearmanClient::setStatusCallback - GearmanClient::setWarningCallback - GearmanClient::setWorkloadCallback - - - - - diff --git a/reference/gearman/gearmanclient/setdata.xml b/reference/gearman/gearmanclient/setdata.xml deleted file mode 100644 index 3f9c28eb69..0000000000 --- a/reference/gearman/gearmanclient/setdata.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - GearmanClient::setData - Establece los datos de aplicación (obsoleto) - - - - &reftitle.description; - - public boolGearmanClient::setData - stringdata - - - Establece datos arbitrarios para la aplicación que pueden ser leídos - posteriormente con GearmanClient::data. - - - - Este método ha sido reemplazado por GearmanClient::setContext - en la versión 0.6.0 de la extensión Gearman. - - - - - - &reftitle.parameters; - - - data - - - - - - - - - - &reftitle.returnvalues; - - Siempre retorna &true;. - - - - - &reftitle.seealso; - - GearmanClient::data - - - - - diff --git a/reference/gearman/gearmanclient/setdatacallback.xml b/reference/gearman/gearmanclient/setdatacallback.xml deleted file mode 100644 index aba4b13c10..0000000000 --- a/reference/gearman/gearmanclient/setdatacallback.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - GearmanClient::setDataCallback - Define una función de retrollamada a llamar cuando se recibe un paquete de datos para una tarea - - - - &reftitle.description; - - public boolGearmanClient::setDataCallback - callablecallback - - - Define una función de retrollamada a llamar cuando se recibe un paquete de datos para una tarea. - - &gearman.note.callback; - - - - &reftitle.parameters; - - &gearman.parameter.callback; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanClient::setCompleteCallback - GearmanClient::setCreatedCallback - GearmanClient::setExceptionCallback - GearmanClient::setFailCallback - GearmanClient::setStatusCallback - GearmanClient::setWarningCallback - GearmanClient::setWorkloadCallback - - - - - diff --git a/reference/gearman/gearmanclient/setexceptioncallback.xml b/reference/gearman/gearmanclient/setexceptioncallback.xml deleted file mode 100644 index 9d7aa4867f..0000000000 --- a/reference/gearman/gearmanclient/setexceptioncallback.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - GearmanClient::setExceptionCallback - Define una función de retrollamada para las excepciones emitidas por el agente - - - - &reftitle.description; - - public boolGearmanClient::setExceptionCallback - callablecallback - - - Especifica una función de retrollamada a llamar cuando un agente emite una excepción. - - &gearman.note.callback; - - - - &reftitle.parameters; - - &gearman.parameter.callback; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanClient::setDataCallback - GearmanClient::setCompleteCallback - GearmanClient::setCreatedCallback - GearmanClient::setFailCallback - GearmanClient::setStatusCallback - GearmanClient::setWarningCallback - GearmanClient::setWorkloadCallback - - - - - diff --git a/reference/gearman/gearmanclient/setfailcallback.xml b/reference/gearman/gearmanclient/setfailcallback.xml deleted file mode 100644 index cc858f7a8d..0000000000 --- a/reference/gearman/gearmanclient/setfailcallback.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - GearmanClient::setFailCallback - Define una función de retrollamada a llamar cuando un trabajo falla - - - - &reftitle.description; - - public boolGearmanClient::setFailCallback - callablecallback - - - Define una función de retrollamada a utilizar cuando una tarea falla. - - &gearman.note.callback; - - - - &reftitle.parameters; - - &gearman.parameter.callback; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanClient::setDataCallback - GearmanClient::setCompleteCallback - GearmanClient::setCreatedCallback - GearmanClient::setExceptionCallback - GearmanClient::setStatusCallback - GearmanClient::setWarningCallback - GearmanClient::setWorkloadCallback - - - - - diff --git a/reference/gearman/gearmanclient/setoptions.xml b/reference/gearman/gearmanclient/setoptions.xml deleted file mode 100644 index af9f6de731..0000000000 --- a/reference/gearman/gearmanclient/setoptions.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - GearmanClient::setOptions - Define las opciones del cliente - - - - &reftitle.description; - - public boolGearmanClient::setOptions - intoption - - - Define una o varias opciones del cliente. - - - - - &reftitle.parameters; - - - option - - - Las opciones a definir. - - - - - - - - &reftitle.returnvalues; - - Retorna siempre &true;. - - - - - diff --git a/reference/gearman/gearmanclient/setstatuscallback.xml b/reference/gearman/gearmanclient/setstatuscallback.xml deleted file mode 100644 index b239fae540..0000000000 --- a/reference/gearman/gearmanclient/setstatuscallback.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - GearmanClient::setStatusCallback - Define una función de retorno para recolectar los estados de una tarea - - - - &reftitle.description; - - public boolGearmanClient::setStatusCallback - callablecallback - - - Define una función de retorno para utilizar al recuperar las - informaciones de estado actualizadas desde el agente. - - &gearman.note.callback; - - - - &reftitle.parameters; - - &gearman.parameter.callback; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanClient::setDataCallback - GearmanClient::setCompleteCallback - GearmanClient::setCreatedCallback - GearmanClient::setExceptionCallback - GearmanClient::setFailCallback - GearmanClient::setWarningCallback - GearmanClient::setWorkloadCallback - - - - - diff --git a/reference/gearman/gearmanclient/settimeout.xml b/reference/gearman/gearmanclient/settimeout.xml deleted file mode 100644 index d86089a1fe..0000000000 --- a/reference/gearman/gearmanclient/settimeout.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - GearmanClient::setTimeout - Establece el tiempo de espera de una actividad del socket I/O - - - - &reftitle.description; - - public boolGearmanClient::setTimeout - inttimeout - - - Establece el tiempo de espera de una actividad del socket I/O. - - - - - &reftitle.parameters; - - - timeout - - - Un intervalo de tiempo, en milisegundos. - - - - - - - - &reftitle.returnvalues; - - Siempre devuelve &true;. - - - - - diff --git a/reference/gearman/gearmanclient/setwarningcallback.xml b/reference/gearman/gearmanclient/setwarningcallback.xml deleted file mode 100644 index dd5166dfb5..0000000000 --- a/reference/gearman/gearmanclient/setwarningcallback.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - GearmanClient::setWarningCallback - Define una función de retrollamada al emitir una alerta desde el agente - - - - &reftitle.description; - - public boolGearmanClient::setWarningCallback - callablecallback - - - Define una función de retrollamada a llamar cuando un agente lanza una alerta. - - &gearman.note.callback; - - - - &reftitle.parameters; - - &gearman.parameter.callback; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanClient::setDataCallback - GearmanClient::setCompleteCallback - GearmanClient::setCreatedCallback - GearmanClient::setExceptionCallback - GearmanClient::setFailCallback - GearmanClient::setStatusCallback - GearmanClient::setWorkloadCallback - - - - - diff --git a/reference/gearman/gearmanclient/setworkloadcallback.xml b/reference/gearman/gearmanclient/setworkloadcallback.xml deleted file mode 100644 index 0a65d6efd9..0000000000 --- a/reference/gearman/gearmanclient/setworkloadcallback.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - GearmanClient::setWorkloadCallback - Define una función de retrollamada al recibir actualizaciones de datos incrementales - - - - &reftitle.description; - - public boolGearmanClient::setWorkloadCallback - callablecallback - - - Define una función de retrollamada a llamar cuando un agente necesita enviar datos antes - de finalizar un trabajo. Un agente puede hacerlo cuando debe enviar actualizaciones, - enviar resultados parciales, o enviar datos en tiempo real durante la ejecución - de trabajos que requieren mucho tiempo. - - &gearman.note.callback; - - - - &reftitle.parameters; - - &gearman.parameter.callback; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanClient::setDataCallback - GearmanClient::setCompleteCallback - GearmanClient::setCreatedCallback - GearmanClient::setExceptionCallback - GearmanClient::setFailCallback - GearmanClient::setStatusCallback - GearmanClient::setWarningCallback - - - - - diff --git a/reference/gearman/gearmanclient/timeout.xml b/reference/gearman/gearmanclient/timeout.xml deleted file mode 100644 index 5861c25cdc..0000000000 --- a/reference/gearman/gearmanclient/timeout.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - GearmanClient::timeout - Obtiene el valor del tiempo de espera de actividad del socket I/O - - - - &reftitle.description; - - public intGearmanClient::timeout - - - - Devuelve el valor del tiempo de espera, en milisegundos, para una actividad del socket I/O. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El tiempo de espera, en milisegundos, para una actividad I/O. - Un valor negativo indica que el tiempo de espera es infinito. - - - - - &reftitle.seealso; - - GearmanClient::setTimeout - - - - - diff --git a/reference/gearman/gearmanclient/wait.xml b/reference/gearman/gearmanclient/wait.xml deleted file mode 100644 index 63ea4e3fe4..0000000000 --- a/reference/gearman/gearmanclient/wait.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - GearmanClient::wait - Espera la actividad de E/S en todas las conexiones de un cliente - - - - &reftitle.description; - - public boolGearmanClient::wait - - - - Esto espera la actividad de cualquiera de los servidores conectados. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; en caso de éxito, &false; en caso de error. - - - - - &reftitle.seealso; - - GearmanWorker::wait - - - - - diff --git a/reference/gearman/gearmanexception.xml b/reference/gearman/gearmanexception.xml deleted file mode 100644 index 2c288a83ef..0000000000 --- a/reference/gearman/gearmanexception.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - La clase GearmanException - GearmanException - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - - GearmanException - - - &InheritedProperties; - - - &Methods; - - - &InheritedMethods; - - - - - -
- -
- -
- diff --git a/reference/gearman/gearmanjob.xml b/reference/gearman/gearmanjob.xml deleted file mode 100644 index 74fb3799a4..0000000000 --- a/reference/gearman/gearmanjob.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - La clase GearmanJob - GearmanJob - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - - GearmanJob - - - &Methods; - - - - - - -
- -
- - &reference.gearman.entities.gearmanjob; - -
- diff --git a/reference/gearman/gearmanjob/complete.xml b/reference/gearman/gearmanjob/complete.xml deleted file mode 100644 index 3d80f2d2ba..0000000000 --- a/reference/gearman/gearmanjob/complete.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - GearmanJob::complete - Envía el resultado y el estado completo (obsoleto) - - - - &reftitle.description; - - public boolGearmanJob::complete - stringresult - - - Envía los datos que han resultado del proceso y actualiza el estado a completo - para este trabajo. - - - - Este método ha sido reemplazado por GearmanJob::sendComplete - en la versión 0.6.0 de la extensión Gearman. - - - - - - &reftitle.parameters; - - - result - - - Los datos que han resultado en formato serializado. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanJob::sendFail - GearmanJob::setReturn - - - - - diff --git a/reference/gearman/gearmanjob/construct.xml b/reference/gearman/gearmanjob/construct.xml deleted file mode 100644 index f09ca03d9f..0000000000 --- a/reference/gearman/gearmanjob/construct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - GearmanJob::__construct - Crea una instancia de GearmanJob - - - - &reftitle.description; - - public GearmanJob::__construct - - - - Crea una instancia de GearmanJob que representa un trabajo - que un trabajador debe completar. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objeto GearmanJob. - - - - - diff --git a/reference/gearman/gearmanjob/data.xml b/reference/gearman/gearmanjob/data.xml deleted file mode 100644 index 686b2be37b..0000000000 --- a/reference/gearman/gearmanjob/data.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - GearmanJob::data - Envía datos para un trabajo en ejecución (obsoleto) - - - - &reftitle.description; - - public boolGearmanJob::data - stringdata - - - Envía datos al servidor de trabajos (y a cualquier cliente a la escucha) - para este trabajo. - - - - Este método ha sido reemplazado por GearmanJob::sendData - en la versión 0.6.0 de la extensión Gearman. - - - - - - &reftitle.parameters; - - - data - - - Datos arbitrarios serializados. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanJob::workload - GearmanTask::data - - - - - diff --git a/reference/gearman/gearmanjob/exception.xml b/reference/gearman/gearmanjob/exception.xml deleted file mode 100644 index 91d31baa2f..0000000000 --- a/reference/gearman/gearmanjob/exception.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - GearmanJob::exception - Envía una excepción para un trabajo en ejecución (obsoleto) - - - - &reftitle.description; - - public boolGearmanJob::exception - stringexception - - - Envía la excepción indicada cuando este trabajo está siendo ejecutado. - - - - Este método ha sido reemplazado por GearmanJob::sendException - en la versión 0.6.0 de la extensión Gearman. - - - - - - &reftitle.parameters; - - - exception - - - Descripción de la excepción. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanJob::setReturn - GearmanJob::sendStatus - GearmanJob::sendWarning - - - - - diff --git a/reference/gearman/gearmanjob/fail.xml b/reference/gearman/gearmanjob/fail.xml deleted file mode 100644 index b563511759..0000000000 --- a/reference/gearman/gearmanjob/fail.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - GearmanJob::fail - Envía el estado de fallo (obsoleto) - - - - &reftitle.description; - - public boolGearmanJob::fail - - - - Envía el estado de fallo para este trabajo, indicando que el trabajo ha fallado - por razones conocidas (en contraposición a un fallo debido al lanzamiento de - una excepción). - - - - Este método ha sido reemplazado por GearmanJob::sendFail - en la versión 0.6.0 de la extensión Gearman. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanJob::sendException - GearmanJob::setReturn - GearmanJob::sendStatus - GearmanJob::sendWarning - - - - - diff --git a/reference/gearman/gearmanjob/functionname.xml b/reference/gearman/gearmanjob/functionname.xml deleted file mode 100644 index c8e20e56cd..0000000000 --- a/reference/gearman/gearmanjob/functionname.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - GearmanJob::functionName - Obtiene el nombre de la función - - - - &reftitle.description; - - public falsestringGearmanJob::functionName - - - - Devuelve el nombre de la función para este trabajo. Es la función ejecutada - por el agente para ejecutar el trabajo. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El nombre de la función, o &false; si el trabajo no ha sido inicializado. - - - - - &reftitle.seealso; - - GearmanTask::function - - - - - diff --git a/reference/gearman/gearmanjob/handle.xml b/reference/gearman/gearmanjob/handle.xml deleted file mode 100644 index 5419f7ee2e..0000000000 --- a/reference/gearman/gearmanjob/handle.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - GearmanJob::handle - Obtiene el manejador de trabajos - - - - &reftitle.description; - - public falsestringGearmanJob::handle - - - - Devuelve el manejador de trabajos asignado por el servidor de trabajos. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un manejador de trabajos, o &false; si el trabajo no ha sido inicializado. - - - - - &reftitle.seealso; - - GearmanTask::jobHandle - - - - - diff --git a/reference/gearman/gearmanjob/returncode.xml b/reference/gearman/gearmanjob/returncode.xml deleted file mode 100644 index bbfa7abd0d..0000000000 --- a/reference/gearman/gearmanjob/returncode.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - GearmanJob::returnCode - Obtiene el último código devuelto - - - - &reftitle.description; - - public intGearmanJob::returnCode - - - - Devuelve el último código devuelto por el servidor de trabajos. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un código de retorno válido de Gearman. - - - - - &reftitle.seealso; - - GearmanTask::returnCode - - - - - diff --git a/reference/gearman/gearmanjob/sendcomplete.xml b/reference/gearman/gearmanjob/sendcomplete.xml deleted file mode 100644 index c2cc6379cc..0000000000 --- a/reference/gearman/gearmanjob/sendcomplete.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - GearmanJob::sendComplete - Envía el resultado junto con el estado completo - - - - &reftitle.description; - - public boolGearmanJob::sendComplete - stringresult - - - Envía los datos del resultado junto con el estado completo actualizado para este trabajo. - - - - - &reftitle.parameters; - - - result - - - Los datos serializados del resultado. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanJob::sendFail - GearmanJob::setReturn - - - - - diff --git a/reference/gearman/gearmanjob/senddata.xml b/reference/gearman/gearmanjob/senddata.xml deleted file mode 100644 index 164e32f360..0000000000 --- a/reference/gearman/gearmanjob/senddata.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - GearmanJob::sendData - Envía los datos para un trabajo en ejecución - - - - &reftitle.description; - - public boolGearmanJob::sendData - stringdata - - - Envía los datos al servidor de trabajos (y a todos los clientes que escuchen) - para este trabajo. - - - - - &reftitle.parameters; - - - data - - - Datos serializados arbitrarios. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanJob::workload - GearmanTask::data - - - - - diff --git a/reference/gearman/gearmanjob/sendexception.xml b/reference/gearman/gearmanjob/sendexception.xml deleted file mode 100644 index bf1e1a63fa..0000000000 --- a/reference/gearman/gearmanjob/sendexception.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - GearmanJob::sendException - Envía una excepción para un trabajo en ejecución - - - - &reftitle.description; - - public boolGearmanJob::sendException - stringexception - - - Envía la excepción proporcionada durante la ejecución de este trabajo. - - - - - &reftitle.parameters; - - - exception - - - Una descripción de excepción. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanJob::setReturn - GearmanJob::sendStatus - GearmanJob::sendWarning - - - - - diff --git a/reference/gearman/gearmanjob/sendfail.xml b/reference/gearman/gearmanjob/sendfail.xml deleted file mode 100644 index 4006527b3f..0000000000 --- a/reference/gearman/gearmanjob/sendfail.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - GearmanJob::sendFail - Envía un estado de fallo - - - - &reftitle.description; - - public boolGearmanJob::sendFail - - - - Envía un estado de fallo para este trabajo, indicando que el trabajo ha fallado - de forma inesperada (a diferencia de un error que emite una excepción). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanJob::sendException - GearmanJob::setReturn - GearmanJob::sendStatus - GearmanJob::sendWarning - - - - - diff --git a/reference/gearman/gearmanjob/sendstatus.xml b/reference/gearman/gearmanjob/sendstatus.xml deleted file mode 100644 index f860ca15b9..0000000000 --- a/reference/gearman/gearmanjob/sendstatus.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - GearmanJob::sendStatus - Envía un estado - - - - &reftitle.description; - - public boolGearmanJob::sendStatus - intnumerator - intdenominator - - - Envía información de estado al servidor de trabajos - así como a todos los clientes que estén escuchando. Utilícese esta función - para especificar el porcentaje de realización del trabajo actual. - - - - - &reftitle.parameters; - - - numerator - - - El numerador de la tasa de realización, en forma de fracción. - - - - - denominator - - - El denominador de la tasa de realización, en forma de fracción. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanClient::jobStatus - GearmanTask::taskDenominator - GearmanTask::taskNumerator - - - - - diff --git a/reference/gearman/gearmanjob/sendwarning.xml b/reference/gearman/gearmanjob/sendwarning.xml deleted file mode 100644 index de882f7fc4..0000000000 --- a/reference/gearman/gearmanjob/sendwarning.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - GearmanJob::sendWarning - Envía una alerta - - - - &reftitle.description; - - public boolGearmanJob::sendWarning - stringwarning - - - Envía una alerta para este trabajo durante su ejecución. - - - - - &reftitle.parameters; - - - warning - - - Un mensaje de alerta. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanJob::sendComplete - GearmanJob::sendException - GearmanJob::sendFail - - - - - diff --git a/reference/gearman/gearmanjob/setreturn.xml b/reference/gearman/gearmanjob/setreturn.xml deleted file mode 100644 index 99cd0e3683..0000000000 --- a/reference/gearman/gearmanjob/setreturn.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - GearmanJob::setReturn - Define un valor de retorno - - - - &reftitle.description; - - public boolGearmanJob::setReturn - intgearman_return_t - - - Define un valor de retorno para este trabajo, indicando la forma en que - terminó este trabajo. - - - - - &reftitle.parameters; - - - gearman_return_t - - - Un valor de retorno válido de Gearman. - - - - - - - - &reftitle.returnvalues; - - - - - - diff --git a/reference/gearman/gearmanjob/status.xml b/reference/gearman/gearmanjob/status.xml deleted file mode 100644 index aa651039ec..0000000000 --- a/reference/gearman/gearmanjob/status.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - GearmanJob::status - Envía el estado (obsoleto) - - - - &reftitle.description; - - public boolGearmanJob::status - intnumerator - intdenominator - - - Envía información de estado al servidor de trabajo y a cualquier cliente a la - escucha. Usar para especificar qué porcentaje del trabajo ha sido completado. - - - - Este método ha sido reemplazado por GearmanJob::sendStatus - en la versión 0.6.0 de la extensión Gearman. - - - - - - &reftitle.parameters; - - - numerator - - - El numerador del porcentaje completado, expresado como una fracción. - - - - - denominator - - - El denominador del porcentaje completado, expresado como una fracción. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanClient::jobStatus - GearmanTask::taskDenominator - GearmanTask::taskNumerator - - - - - diff --git a/reference/gearman/gearmanjob/unique.xml b/reference/gearman/gearmanjob/unique.xml deleted file mode 100644 index a1c63f4d46..0000000000 --- a/reference/gearman/gearmanjob/unique.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - GearmanJob::unique - Obtiene el identificador único - - - - &reftitle.description; - - public falsestringGearmanJob::unique - - - - Devuelve el identificador único para este trabajo. - El identificador es asignado por el cliente. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El identificador único, o &false; si el trabajo no ha sido inicializado. - - - - - &reftitle.seealso; - - GearmanClient::do - GearmanTask::uuid - - - - - diff --git a/reference/gearman/gearmanjob/warning.xml b/reference/gearman/gearmanjob/warning.xml deleted file mode 100644 index b098d5d255..0000000000 --- a/reference/gearman/gearmanjob/warning.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - GearmanJob::warning - Envía un aviso (obsoleto) - - - - &reftitle.description; - - public boolGearmanJob::warning - stringwarning - - - Envía un aviso para el trabajo mientras está en ejecución. - - - - Este método ha sido reemplazado por GearmanJob::sendWarning - en la versión 0.6.0 de la extensión Gearman. - - - - - - &reftitle.parameters; - - - warning - - - Un mensaje de aviso. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - GearmanJob::sendComplete - GearmanJob::sendException - GearmanJob::sendFail - - - - - diff --git a/reference/gearman/gearmanjob/workload.xml b/reference/gearman/gearmanjob/workload.xml deleted file mode 100644 index f3e3d6cf3e..0000000000 --- a/reference/gearman/gearmanjob/workload.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - GearmanJob::workload - Obtiene la carga de trabajo - - - - &reftitle.description; - - public stringGearmanJob::workload - - - - Obtiene la carga para este trabajo. Son los datos serializados - a analizar por el agente. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Los datos serializados. - - - - - &reftitle.seealso; - - GearmanClient::do - GearmanJob::workloadSize - - - - - diff --git a/reference/gearman/gearmanjob/workloadsize.xml b/reference/gearman/gearmanjob/workloadsize.xml deleted file mode 100644 index b4f7549c86..0000000000 --- a/reference/gearman/gearmanjob/workloadsize.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - GearmanJob::workloadSize - Obtiene el tamaño de la carga de trabajo - - - - &reftitle.description; - - public intGearmanJob::workloadSize - - - - Devuelve el tamaño de la carga para este trabajo (los datos que el agente debe procesar) - en bytes. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El tamaño, en bytes. - - - - - &reftitle.seealso; - - GearmanJob::workload - - - - - diff --git a/reference/gearman/gearmantask.xml b/reference/gearman/gearmantask.xml deleted file mode 100644 index 2e2f8f885c..0000000000 --- a/reference/gearman/gearmantask.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - La clase GearmanTask - GearmanTask - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - - GearmanTask - - - &Methods; - - - - - - - - - -
- -
- - &reference.gearman.entities.gearmantask; - -
- diff --git a/reference/gearman/gearmantask/construct.xml b/reference/gearman/gearmantask/construct.xml deleted file mode 100644 index b0e416a6bf..0000000000 --- a/reference/gearman/gearmantask/construct.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - GearmanTask::__construct - Crea una instancia GearmanTask - - - - &reftitle.description; - - public GearmanTask::__construct - - - - Crea una instancia GearmanTask que representa una tarea - a enviar al servidor de tareas. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objeto GearmanTask. - - - - - diff --git a/reference/gearman/gearmantask/create.xml b/reference/gearman/gearmantask/create.xml deleted file mode 100644 index 145b5faa51..0000000000 --- a/reference/gearman/gearmantask/create.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - GearmanTask::create - Crea una tarea (deprecado) - - - - &reftitle.description; - - public GearmanTaskfalseGearmanTask::create - - - - Devuelve un nuevo objeto GearmanTask. - - - - Este método fue eliminado desde la versión - 0.6.0 de la extensión Gearman. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objeto GearmanTask&return.falseforfailure;. - - - - - diff --git a/reference/gearman/gearmantask/data.xml b/reference/gearman/gearmantask/data.xml deleted file mode 100644 index 2c0ea06de0..0000000000 --- a/reference/gearman/gearmantask/data.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - GearmanTask::data - Recupera los datos devueltos por una tarea - - - - &reftitle.description; - - public falsestringGearmanTask::data - - - - Devuelve los datos devueltos por una tarea por un agente. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Los datos serializados, o &false; si no hay datos. - - - - - &reftitle.seealso; - - GearmanTask::dataSize - - - - - diff --git a/reference/gearman/gearmantask/datasize.xml b/reference/gearman/gearmantask/datasize.xml deleted file mode 100644 index ed616819a3..0000000000 --- a/reference/gearman/gearmantask/datasize.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - GearmanTask::dataSize - Obtiene el tamaño de los datos devueltos - - - - &reftitle.description; - - public intfalseGearmanTask::dataSize - - - - Devuelve el tamaño de los datos devueltos de una tarea. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El tamaño de los datos, o &false; si no hay datos. - - - - - &reftitle.seealso; - - GearmanTask::data - - - - - diff --git a/reference/gearman/gearmantask/function.xml b/reference/gearman/gearmantask/function.xml deleted file mode 100644 index 5087b21a6a..0000000000 --- a/reference/gearman/gearmantask/function.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - GearmanTask::function - Obtiene el nombre de la función asociada (obsoleto) - - - - &reftitle.description; - - public stringGearmanTask::function - - - - Retorna el nombre de la función que esta tarea tiene asociada con, por ejemplo, la función - que el trabajador de Gearman llama. - - - - Este método ha sido reemplazado por GearmanTask::functionName - en la versión 0.6.0 de la extensión Gearman. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El nombre de la función. - - - - - diff --git a/reference/gearman/gearmantask/functionname.xml b/reference/gearman/gearmantask/functionname.xml deleted file mode 100644 index 62fa18be94..0000000000 --- a/reference/gearman/gearmantask/functionname.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - GearmanTask::functionName - Obtiene el nombre de la función asociada - - - - &reftitle.description; - - public falsestringGearmanTask::functionName - - - - Devuelve el nombre de la función asociada a esta tarea, es decir, - la función llamada por el agente Gearman. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un nombre de función, o &false; si la tarea no ha sido creada aún. - - - - - diff --git a/reference/gearman/gearmantask/isknown.xml b/reference/gearman/gearmantask/isknown.xml deleted file mode 100644 index 0f5c6289ad..0000000000 --- a/reference/gearman/gearmantask/isknown.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - GearmanTask::isKnown - Verifica si una tarea es conocida - - - - &reftitle.description; - - public boolGearmanTask::isKnown - - - - Obtiene las informaciones de estado si la tarea es conocida en el servidor - de trabajos. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; si la tarea es conocida, &false; en caso contrario. - - - - - diff --git a/reference/gearman/gearmantask/isrunning.xml b/reference/gearman/gearmantask/isrunning.xml deleted file mode 100644 index 5abcf1c2aa..0000000000 --- a/reference/gearman/gearmantask/isrunning.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - GearmanTask::isRunning - Verifica si la tarea está actualmente en funcionamiento - - - - &reftitle.description; - - public boolGearmanTask::isRunning - - - - Indica si la tarea está actualmente en funcionamiento. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; si la tarea está en funcionamiento, &false; en caso contrario. - - - - - diff --git a/reference/gearman/gearmantask/jobhandle.xml b/reference/gearman/gearmantask/jobhandle.xml deleted file mode 100644 index e7f94e0f33..0000000000 --- a/reference/gearman/gearmantask/jobhandle.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - GearmanTask::jobHandle - gearman_job_handle - Obtiene el manejador de trabajos - - - - &reftitle.description; - - public falsestringGearmanTask::jobHandle - - - - Obtiene el manejador de trabajos para esta tarea. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El manejador de trabajos, o &false; si la tarea no ha sido creada aún. - - - - - &reftitle.seealso; - - GearmanClient::doJobHandle - - - - - diff --git a/reference/gearman/gearmantask/recvdata.xml b/reference/gearman/gearmantask/recvdata.xml deleted file mode 100644 index 83ed3e50e1..0000000000 --- a/reference/gearman/gearmantask/recvdata.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - GearmanTask::recvData - Lee el trabajo o los datos devueltos por una tarea en un buffer - - - - &reftitle.description; - - public falsearrayGearmanTask::recvData - intdata_len - - - - &warn.experimental.func; - - - - &reftitle.parameters; - - - data_len - - - Longitud de los datos a leer. - - - - - - - - &reftitle.returnvalues; - - Un array cuyo primer elemento es la longitud de los datos - leídos, y el segundo, el buffer de datos. - Devuelve &false; si la lectura falla. - - - - - &reftitle.seealso; - - GearmanTask::sendData - - - - - diff --git a/reference/gearman/gearmantask/returncode.xml b/reference/gearman/gearmantask/returncode.xml deleted file mode 100644 index 12a0425122..0000000000 --- a/reference/gearman/gearmantask/returncode.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - GearmanTask::returnCode - Obtiene el último código devuelto - - - - &reftitle.description; - - public intGearmanTask::returnCode - - - - Devuelve el último código devuelto por Gearman para una tarea. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un código de retorno válido de Gearman. - - - - - &reftitle.seealso; - - GearmanClient::returnCode - - - - - diff --git a/reference/gearman/gearmantask/senddata.xml b/reference/gearman/gearmantask/senddata.xml deleted file mode 100644 index 0b8cc87261..0000000000 --- a/reference/gearman/gearmantask/senddata.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - GearmanTask::sendData - Envía datos para una tarea (deprecado) - - - - &reftitle.description; - - public intGearmanTask::sendData - stringdata - - - - &warn.experimental.func; - - - - &reftitle.parameters; - - - data - - - Datos a enviar al agente. - - - - - - - - &reftitle.returnvalues; - - La longitud de los datos enviados, o &false; si el envío - ha fallado. - - - - - &reftitle.seealso; - - GearmanTask::recvData - - - - - diff --git a/reference/gearman/gearmantask/sendworkload.xml b/reference/gearman/gearmantask/sendworkload.xml deleted file mode 100644 index 04db19cf81..0000000000 --- a/reference/gearman/gearmantask/sendworkload.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - GearmanTask::sendWorkload - Envía los datos para una tarea - - - - &reftitle.description; - - public intfalseGearmanTask::sendWorkload - stringdata - - - - &warn.experimental.func; - - - - - &reftitle.parameters; - - - data - - - Datos a enviar al agente. - - - - - - - - &reftitle.returnvalues; - - La longitud de los datos a enviar, o &false; - si el envío falla. - - - - - &reftitle.seealso; - - GearmanTask::recvData - - - - - diff --git a/reference/gearman/gearmantask/taskdenominator.xml b/reference/gearman/gearmantask/taskdenominator.xml deleted file mode 100644 index 740034537b..0000000000 --- a/reference/gearman/gearmantask/taskdenominator.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - GearmanTask::taskDenominator - Obtiene el denominador de la tasa de realización - - - - &reftitle.description; - - public falseintGearmanTask::taskDenominator - - - - Devuelve el denominador de la tasa de realización de la tarea. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un número entre 0 y 100, o &false; si no puede ser determinado. - - - - - &reftitle.seealso; - - GearmanTask::taskNumerator - - - - - diff --git a/reference/gearman/gearmantask/tasknumerator.xml b/reference/gearman/gearmantask/tasknumerator.xml deleted file mode 100644 index 0b481dc9a1..0000000000 --- a/reference/gearman/gearmantask/tasknumerator.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - GearmanTask::taskNumerator - Obtiene el numerador de la tasa de realización - - - - &reftitle.description; - - public falseintGearmanTask::taskNumerator - - - - Devuelve el numerador de la tasa de realización de la tarea. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un número entre 0 y 100, o &false; si no puede ser determinado. - - - - - &reftitle.seealso; - - GearmanTask::taskDenominator - - - - - diff --git a/reference/gearman/gearmantask/unique.xml b/reference/gearman/gearmantask/unique.xml deleted file mode 100644 index e29074d767..0000000000 --- a/reference/gearman/gearmantask/unique.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - GearmanTask::unique - Obtiene el identificador único de la tarea - - - - &reftitle.description; - - public falsestringGearmanTask::unique - - - - Devuelve el identificador único de la tarea. Este es asignado por el método - GearmanClient, a diferencia del gestor de trabajos que es definido por el servidor de trabajos Gearman. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El identificador único, o &false; si no se ha asignado ningún identificador. - - - - - &reftitle.seealso; - - GearmanClient::do - GearmanClient::addTask - - - - - diff --git a/reference/gearman/gearmantask/uuid.xml b/reference/gearman/gearmantask/uuid.xml deleted file mode 100644 index 30819eb7d0..0000000000 --- a/reference/gearman/gearmantask/uuid.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - GearmanTask::uuid - Recupera el identificador único para una tarea (obsoleto) - - - - &reftitle.description; - - public stringGearmanTask::uuid - - - - Devuelve el identificador único para una tarea. Es asignado por el - método GearmanClient, a diferencia del gestor - de trabajos que es definido por el servidor de trabajos Gearman. - - - - Este método ha sido reemplazado por el método - GearmanTask::unique desde la versión - 0.6.0 de la extensión Gearman. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El identificador único, o &false; si ningún identificador está asignado. - - - - - &reftitle.seealso; - - GearmanClient::do - GearmanClient::addTask - - - - - diff --git a/reference/gearman/gearmanworker.xml b/reference/gearman/gearmanworker.xml deleted file mode 100644 index 84f2969473..0000000000 --- a/reference/gearman/gearmanworker.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - La clase GearmanWorker - GearmanWorker - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - - GearmanWorker - - - &Methods; - - - - - - - - - -
- -
- - &reference.gearman.entities.gearmanworker; - -
- diff --git a/reference/gearman/gearmanworker/addfunction.xml b/reference/gearman/gearmanworker/addfunction.xml deleted file mode 100644 index b1ebf78b02..0000000000 --- a/reference/gearman/gearmanworker/addfunction.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - GearmanWorker::addFunction - Registra y añade una función de retrollamada - - - - &reftitle.description; - - public boolGearmanWorker::addFunction - stringfunction_name - callablefunction - mixedcontext&null; - inttimeout0 - - - Registra una función de retrollamada con el servidor de trabajos - y especifica una retrollamada correspondiente a esta función. Opcionalmente, - fija datos de contexto de la aplicación a utilizar cuando - la función de retrollamada es llamada, así como un tiempo límite de ejecución. - - - - - &reftitle.parameters; - - - function_name - - - El nombre de la función a registrar con el servidor de trabajos - - - - - function - - - Una función de retrollamada a llamar cuando un trabajo es enviado - - - - - context - - - Una referencia a datos de contexto de la aplicación - que pueden ser modificados por la función del agente. - - - - - timeout - - - Un intervalo de tiempo, en segundos. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Agente simple que utiliza datos de contexto de la aplicación - -addServer(); - -# Define una variable que contiene los datos de la aplicación -$count= 0; - -# Añade la función "reverse" -$worker->addFunction("reverse", "reverse_cb", $count); - -# Inicia el agente -while ($worker->work()); - -function reverse_cb($job, &$count) -{ - $count++; - return "$count: " . strrev($job->workload()); -} - -?> -]]> - - - La ejecución de un cliente que envía 2 trabajos para la función reverse mostrará - algo como: - - - - - - - - - &reftitle.seealso; - - GearmanClient::do - - - - - diff --git a/reference/gearman/gearmanworker/addoptions.xml b/reference/gearman/gearmanworker/addoptions.xml deleted file mode 100644 index b3c57c5a41..0000000000 --- a/reference/gearman/gearmanworker/addoptions.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - GearmanWorker::addOptions - Añadir opciones al trabajador - - - - &reftitle.description; - - public trueGearmanWorker::addOptions - intoption - - - Añade una o varias opciones al trabajador. - - - - - &reftitle.parameters; - - - option - - - Las opciones a añadir - - - - - - - - &reftitle.returnvalues; - - &return.true.always; - - - - - &reftitle.seealso; - - GearmanWorker::options - GearmanClient::setOptions - GearmanClient::removeOptions - - - - - diff --git a/reference/gearman/gearmanworker/addserver.xml b/reference/gearman/gearmanworker/addserver.xml deleted file mode 100644 index c592cee65b..0000000000 --- a/reference/gearman/gearmanworker/addserver.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - GearmanWorker::addServer - Añade un servidor de trabajos - - - - &reftitle.description; - - public boolGearmanWorker::addServer - stringhost&null; - intport0 - boolsetupExceptionHandler&true; - - - Añade un servidor de trabajos a este agente. Será añadido a una lista de - servidores a utilizar para ejecutar los trabajos. - No se realiza ninguna operación de I/O de socket aquí. - - - - - &reftitle.parameters; - - - host - - - &gearman.parameter.host; - - - - - port - - - &gearman.parameter.port; - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Añadir servidores Gearman - -addServer("10.0.0.1"); -$worker->addServer("10.0.0.2", 7003); -?> -]]> - - - - - - &reftitle.seealso; - - GearmanWorker::addServers - - - - - diff --git a/reference/gearman/gearmanworker/addservers.xml b/reference/gearman/gearmanworker/addservers.xml deleted file mode 100644 index 3a42e02df8..0000000000 --- a/reference/gearman/gearmanworker/addservers.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - GearmanWorker::addServers - Añade múltiples servidores de trabajos - - - - &reftitle.description; - - public boolGearmanWorker::addServers - stringservers&null; - boolsetupExceptionHandler&true; - - - Añade uno o múltiples servidores de trabajos al agente. - Serán añadidos a una lista de servidores que podrán - ser utilizados para ejecutar trabajos. No se realiza - ninguna operación de I/O de socket aquí. - - - - - &reftitle.parameters; - - - servers - - - Una lista de servidores de trabajos separados por comas, en formato - host:port. Si el puerto no se especifica, se utilizará el valor por omisión - 4730. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Añadir 2 servidores de trabajos - -addServers("10.0.0.1,10.0.0.2:7003"); - -?> -]]> - - - - - - &reftitle.seealso; - - GearmanWorker::addServer - - - - - diff --git a/reference/gearman/gearmanworker/clone.xml b/reference/gearman/gearmanworker/clone.xml deleted file mode 100644 index cf8d441e70..0000000000 --- a/reference/gearman/gearmanworker/clone.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - GearmanWorker::clone - Crea una copia del trabajador - - - - &reftitle.description; - - public voidGearmanWorker::clone - - - - Crea una copia del trabajador. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objeto GearmanWorker - - - - - diff --git a/reference/gearman/gearmanworker/construct.xml b/reference/gearman/gearmanworker/construct.xml deleted file mode 100644 index 120cb4e756..0000000000 --- a/reference/gearman/gearmanworker/construct.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - GearmanWorker::__construct - Crea una instancia GearmanWorker - - - - &reftitle.description; - - public GearmanWorker::__construct - - - - Crea una nueva instancia de GearmanWorker - que representa un agente que se conecta al servidor de trabajos y acepta - tareas a ejecutar. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objeto GearmanWorker. - - - - - &reftitle.seealso; - - GearmanWorker::clone - - - - - diff --git a/reference/gearman/gearmanworker/echo.xml b/reference/gearman/gearmanworker/echo.xml deleted file mode 100644 index f908e8d450..0000000000 --- a/reference/gearman/gearmanworker/echo.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - GearmanWorker::echo - Comprueba la respuesta de un servidor de trabajo - - - - &reftitle.description; - - public boolGearmanWorker::echo - stringworkload - - - Envía datos a todos los servidores de trabajo para comprobar si los retornan. Esta es - una función de prueba para ver si los servidores de trabajo están respondiendo de - forma adecuada. - - - - - &reftitle.parameters; - - - workload - - - Datos arbitrarios serializados - - - - - - - - &reftitle.returnvalues; - - Valor de retorno estándar de Gearman. - - - - - &reftitle.seealso; - - GearmanClient::echo - - - - - diff --git a/reference/gearman/gearmanworker/error.xml b/reference/gearman/gearmanworker/error.xml deleted file mode 100644 index 0dd9befa85..0000000000 --- a/reference/gearman/gearmanworker/error.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - GearmanWorker::error - Obtiene el último error ocurrido - - - - &reftitle.description; - - public stringfalseGearmanWorker::error - - - - Devuelve el último error ocurrido, en forma de &string;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Una &string; legible por humanos que representa el último error ocurrido, - o &false; si no hay mensaje de error disponible. - - - - - &reftitle.seealso; - - GearmanWorker::getErrno - - - - - diff --git a/reference/gearman/gearmanworker/geterrno.xml b/reference/gearman/gearmanworker/geterrno.xml deleted file mode 100644 index ad52beb3e9..0000000000 --- a/reference/gearman/gearmanworker/geterrno.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - GearmanWorker::getErrno - Obtiene el valor de errno - - - - &reftitle.description; - - public intGearmanWorker::getErrno - - - - Devuelve el valor de errno en caso de que el valor de retorno - sea GEARMAN_ERRNO. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un valor errno válido. - - - - - &reftitle.seealso; - - GearmanWorker::error - - - - - diff --git a/reference/gearman/gearmanworker/options.xml b/reference/gearman/gearmanworker/options.xml deleted file mode 100644 index c5d53d9c4c..0000000000 --- a/reference/gearman/gearmanworker/options.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - GearmanWorker::options - Obtiene las opciones del agente - - - - &reftitle.description; - - public intGearmanWorker::options - - - - Obtiene las opciones previamente definidas para el agente. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Las opciones actualmente definidas para el agente. - - - - - &reftitle.seealso; - - GearmanWorker::setOptions - - - - - diff --git a/reference/gearman/gearmanworker/register.xml b/reference/gearman/gearmanworker/register.xml deleted file mode 100644 index cc30d8c35a..0000000000 --- a/reference/gearman/gearmanworker/register.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - GearmanWorker::register - Registra una función en un servidor de trabajos - - - - &reftitle.description; - - public boolGearmanWorker::register - stringfunction_name - inttimeout0 - - - Se registra un nombre de función con un servidor de trabajos con un tiempo máximo de ejecución opcional. - Este tiempo especifica el número de segundos que el servidor debe esperar antes de marcar una tarea como fallida. - Si este tiempo se establece en cero, no habrá ningún límite. - - - - - &reftitle.parameters; - - - function_name - - - El nombre de la función a registrar con el servidor de trabajos. - - - - - timeout - - - Un intervalo de tiempo, en segundos. - - - - - - - - &reftitle.returnvalues; - - Un valor de retorno estándar de Gearman. - - - - - &reftitle.seealso; - - GearmanWorker::unregister - GearmanWorker::unregisterAll - - - - - diff --git a/reference/gearman/gearmanworker/removeoptions.xml b/reference/gearman/gearmanworker/removeoptions.xml deleted file mode 100644 index babc353e4a..0000000000 --- a/reference/gearman/gearmanworker/removeoptions.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - GearmanWorker::removeOptions - Elimina opciones del agente - - - - &reftitle.description; - - public trueGearmanWorker::removeOptions - intoption - - - Elimina una o varias opciones del agente. - - - - - &reftitle.parameters; - - - option - - - Las opciones a eliminar - - - - - - - - &reftitle.returnvalues; - - &return.true.always; - - - - - &reftitle.seealso; - - GearmanWorker::options - GearmanWorker::setOptions - GearmanWorker::addOptions - - - - - diff --git a/reference/gearman/gearmanworker/returncode.xml b/reference/gearman/gearmanworker/returncode.xml deleted file mode 100644 index 55b4f567a6..0000000000 --- a/reference/gearman/gearmanworker/returncode.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - GearmanWorker::returnCode - Obtiene el último código Gearman devuelto - - - - &reftitle.description; - - public intGearmanWorker::returnCode - - - - Devuelve el último código Gearman devuelto. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un código de retorno Gearman válido. - - - - - &reftitle.seealso; - - GearmanWorker::error - GearmanWorker::getErrno - - - - - diff --git a/reference/gearman/gearmanworker/setid.xml b/reference/gearman/gearmanworker/setid.xml deleted file mode 100644 index d2d188b310..0000000000 --- a/reference/gearman/gearmanworker/setid.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - GearmanWorker::setId - Define un identificador para el worker - - - - &reftitle.description; - - public boolGearmanWorker::setId - stringid - - - Asigna un identificador al worker, permitiendo así que pueda ser identificado cuando - gearman solicita la lista de workers disponibles. - - - - - &reftitle.parameters; - - - id - - - Un identificador. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>GearmanWorker::setId</function> - - Define un identificador para un worker simple. - - -setId('test'); -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/gearman/gearmanworker/setoptions.xml b/reference/gearman/gearmanworker/setoptions.xml deleted file mode 100644 index 9923966aff..0000000000 --- a/reference/gearman/gearmanworker/setoptions.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - GearmanWorker::setOptions - Define las opciones del trabajador - - - - &reftitle.description; - - public trueGearmanWorker::setOptions - intoption - - - Define una o más opciones del trabajador. - - - - - &reftitle.parameters; - - - option - - - Las opciones a definir. - - - - - - - - &reftitle.returnvalues; - - &return.true.always; - - - - - &reftitle.seealso; - - GearmanWorker::options - GearmanWorker::addOptions - GearmanWorker::removeOptions - GearmanClient::setOptions - - - - - diff --git a/reference/gearman/gearmanworker/settimeout.xml b/reference/gearman/gearmanworker/settimeout.xml deleted file mode 100644 index 32fea488e8..0000000000 --- a/reference/gearman/gearmanworker/settimeout.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - GearmanWorker::setTimeout - Define el tiempo de espera máximo de actividad del socket I/O - - - - &reftitle.description; - - public trueGearmanWorker::setTimeout - inttimeout - - - Define el intervalo de tiempo para esperar actividad del socket I/O. - - - - - &reftitle.parameters; - - - timeout - - - Un intervalo de tiempo, en milisegundos. Un valor negativo indica - que el tiempo de espera será infinito. - - - - - - - - &reftitle.returnvalues; - - &return.true.always; - - - - - &reftitle.examples; - - Un agente simple que espera 5 segundos - -addServer(); - -# Registra una función "reverse" con el servidor. -$gmworker->addFunction("reverse", "reverse_fn"); - -# Define el tiempo de espera a 5 segundos -$gmworker->setTimeout(5000); - -echo "Esperando trabajo...\n"; -while(@$gmworker->work() || $gmworker->returnCode() == GEARMAN_TIMEOUT) -{ - if ($gmworker->returnCode() == GEARMAN_TIMEOUT) - { - # Normalmente, debería realizarse alguna tarea útil aquí... - echo "Tiempo de espera expirado. Esperando el próximo trabajo...\n"; - continue; - } - - if ($gmworker->returnCode() != GEARMAN_SUCCESS) - { - echo "return_code: " . $gmworker->returnCode() . "\n"; - break; - } -} - -echo "Hecho\n"; - -function reverse_fn($job) -{ - return strrev($job->workload()); -} - -?> -]]> - - - La ejecución de un agente sin ningún trabajo enviado generará una salida - que se asemejará a algo como: - - - - - - - - - &reftitle.seealso; - - GearmanWorker::timeout - - - - - diff --git a/reference/gearman/gearmanworker/timeout.xml b/reference/gearman/gearmanworker/timeout.xml deleted file mode 100644 index ecc8e8e660..0000000000 --- a/reference/gearman/gearmanworker/timeout.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - GearmanWorker::timeout - Obtiene el tiempo de espera de la actividad del socket I/O - - - - &reftitle.description; - - public intGearmanWorker::timeout - - - - Devuelve el tiempo de espera actual, en milisegundos, de la actividad - del socket I/O. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un período de tiempo, en milisegundos. Un valor negativo indica - que el tiempo de espera es infinito. - - - - - &reftitle.seealso; - - GearmanWorker::setTimeout - - - - - diff --git a/reference/gearman/gearmanworker/unregister.xml b/reference/gearman/gearmanworker/unregister.xml deleted file mode 100644 index de60b42e3c..0000000000 --- a/reference/gearman/gearmanworker/unregister.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - GearmanWorker::unregister - Elimina una función de los servidores de trabajos - - - - &reftitle.description; - - public boolGearmanWorker::unregister - stringfunction_name - - - Elimina una función de los servidores de trabajos, haciendo que ningún trabajo - sea enviado al agente para esta función. - - - - - &reftitle.parameters; - - - function_name - - - El nombre de una función a eliminar del servidor de trabajos. - - - - - - - - &reftitle.returnvalues; - - Un valor de retorno estándar de Gearman. - - - - - &reftitle.seealso; - - GearmanWorker::register - GearmanWorker::unregisterAll - - - - - diff --git a/reference/gearman/gearmanworker/unregisterall.xml b/reference/gearman/gearmanworker/unregisterall.xml deleted file mode 100644 index ffb89c5107..0000000000 --- a/reference/gearman/gearmanworker/unregisterall.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - GearmanWorker::unregisterAll - Elimina todas las funciones de los servidores de trabajos - - - - &reftitle.description; - - public boolGearmanWorker::unregisterAll - - - - Elimina todas las funciones previamente registradas, asegurando así - que ningún trabajo será enviado al agente con estas funciones. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un valor de retorno estándar de Gearman. - - - - - &reftitle.seealso; - - GearmanWorker::register - GearmanWorker::unregister - - - - - diff --git a/reference/gearman/gearmanworker/wait.xml b/reference/gearman/gearmanworker/wait.xml deleted file mode 100644 index 59be73e8db..0000000000 --- a/reference/gearman/gearmanworker/wait.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - GearmanWorker::wait - Espera una actividad de uno o varios servidores de trabajos - - - - &reftitle.description; - - public boolGearmanWorker::wait - - - - Pone a espera al agente de una actividad de uno o varios servidores de trabajos durante - un funcionamiento en modo I/O no bloqueante. En caso de fallo, se emitirá una advertencia de nivel - E_WARNING con el contenido del último error Gearman ocurrido. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejecutar un agente en modo no bloqueante - -addOptions(GEARMAN_WORKER_NON_BLOCKING); - -# Añade un servidor por defecto (localhost, puerto 4730) -$worker->addServer(); - -# Añade una función "reverse" -$worker->addFunction('reverse', 'reverse_fn'); - -# Intenta obtener un trabajo -while (@$worker->work() || - $worker->returnCode() == GEARMAN_IO_WAIT || - $worker->returnCode() == GEARMAN_NO_JOBS) -{ - if ($worker->returnCode() == GEARMAN_SUCCESS) - continue; - - echo "Esperando el primer trabajo...\n"; - if (!@$worker->wait()) - { - if ($worker->returnCode() == GEARMAN_NO_ACTIVE_FDS) - { - # No estamos conectados a ningún servidor; por lo tanto, esperamos un poco - # antes de intentar una reconexión. - sleep(5); - continue; - } - break; - } -} - -echo "Error del agente: " . $worker->error() . "\n"; - -function reverse_fn($job) -{ - return strrev($job->workload()); -} - -?> -]]> - - - - - - &reftitle.seealso; - - GearmanWorker::work - - - - - diff --git a/reference/gearman/gearmanworker/work.xml b/reference/gearman/gearmanworker/work.xml deleted file mode 100644 index 63e4d969e8..0000000000 --- a/reference/gearman/gearmanworker/work.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - GearmanWorker::work - Atender y ejecutar un trabajo - - - - &reftitle.description; - - public boolGearmanWorker::work - - - - Espera un trabajo y llama a la función de devolución de llamada correspondiente. - Emite una advertencia de tipo E_WARNING que contiene - el último error de Gearman si el código devuelto no es una - de las siguientes constantes: GEARMAN_SUCCESS, GEARMAN_IO_WAIT, - o GEARMAN_WORK_FAIL. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <methodname>GearmanWorker::work</methodname> - -addServer(); - -# Añade la función "reverse" -$worker->addFunction("reverse", "my_reverse_function"); - -# Inicia la escucha del agente para obtener un trabajo -while ($worker->work()); - -function my_reverse_function($job) -{ - return strrev($job->workload()); -} - -?> -]]> - - - - - - &reftitle.seealso; - - GearmanWorker::addFunction - - - - - diff --git a/reference/gearman/setup.xml b/reference/gearman/setup.xml deleted file mode 100644 index a905f36a5c..0000000000 --- a/reference/gearman/setup.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - &reftitle.setup; - -
- &reftitle.required; - - - Esta extensión requiere las bibliotecas - libgearman, - libevent y - uuid así como un - servidor Gearman. - -
- - - &reference.gearman.configure; - - -
- diff --git a/reference/gender/book.xml b/reference/gender/book.xml deleted file mode 100644 index ceff5b3819..0000000000 --- a/reference/gender/book.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - Determina el género de un nombre - Gender - - - &reftitle.intro; - - La extensión PHP Gender es un puerto del programa gender.c - originalmente escrito por Joerg Michael. El objetivo principal de - este programa es encontrar el género de un nombre. La base de datos - actual contiene más de 40000 nombres de 54 países. - - - - &reference.gender.setup; - &reference.gender.examples; - &reference.gender.gender; - - - diff --git a/reference/gender/configure.xml b/reference/gender/configure.xml deleted file mode 100644 index 80d111685f..0000000000 --- a/reference/gender/configure.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - - -
- &reftitle.install; - - - &pecl.info; - &url.pecl.package;gender - - - -
- diff --git a/reference/gender/examples.xml b/reference/gender/examples.xml deleted file mode 100644 index 0d194be8f3..0000000000 --- a/reference/gender/examples.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - &reftitle.examples; -
- Ejemplo de uso. - - Ejemplo de uso de la clase Gender. - - - Ejemplo de uso. - -get($nombre, $país); - -$datos = $género->country($país); - -switch($resultado) { - case Gender::IS_FEMALE: - printf("El nombre %s es femenino en %s\n", $nombre, $datos['country']); - break; - - - case Gender::IS_MOSTLY_FEMALE: - printf("El nombre %s es habitualmente femenino en %s\n", $nombre, $datos['country']); - break; - - - case Gender::IS_MALE: - printf("El nombre %s es masculino en %s\n", $nombre, $datos['country']); - break; - - - case Gender::IS_MOSTLY_MALE: - printf("El nombre %s es habitualmente masculino en %s\n", $nombre, $datos['country']); - break; - - - case Gender::IS_UNISEX_NAME: - printf("El nombre %s es unisex en %s\n", $nombre, $datos['country']); - break; - - - case Gender::IS_A_COUPLE: - printf("El nombre %s es masculino y femenino en %s\n", $nombre, $datos['country']); - break; - - - case Gender::NAME_NOT_FOUND: - printf("El nombre %s no se encontró en %s\n", $nombre, $datos['country']); - break; - - - case Gender::ERROR_IN_NAME: - echo "¡Hay un error con el nombre proporcionado!\n"; - break; - - default: - echo "¡Ocurrió un error!\n"; - break; - -} -]]> - - -
-
- diff --git a/reference/gender/gender.xml b/reference/gender/gender.xml deleted file mode 100644 index d146b3468b..0000000000 --- a/reference/gender/gender.xml +++ /dev/null @@ -1,888 +0,0 @@ - - - - - - - La clase Gender\Gender - Gender\Gender - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - Gender\Gender - - - - - Gender\Gender - - - - &Constants; - - const - int - Gender\Gender::IS_FEMALE - 70 - - - const - int - Gender\Gender::IS_MOSTLY_FEMALE - 102 - - - const - int - Gender\Gender::IS_MALE - 77 - - - const - int - Gender\Gender::IS_MOSTLY_MALE - 109 - - - const - int - Gender\Gender::IS_UNISEX_NAME - 63 - - - const - int - Gender\Gender::IS_A_COUPLE - 67 - - - const - int - Gender\Gender::NAME_NOT_FOUND - 32 - - - const - int - Gender\Gender::ERROR_IN_NAME - 69 - - - const - int - Gender\Gender::ANY_COUNTRY - 0 - - - const - int - Gender\Gender::BRITAIN - 1 - - - const - int - Gender\Gender::IRELAND - 2 - - - const - int - Gender\Gender::USA - 3 - - - const - int - Gender\Gender::SPAIN - 4 - - - const - int - Gender\Gender::PORTUGAL - 5 - - - const - int - Gender\Gender::ITALY - 6 - - - const - int - Gender\Gender::MALTA - 7 - - - const - int - Gender\Gender::FRANCE - 8 - - - const - int - Gender\Gender::BELGIUM - 9 - - - const - int - Gender\Gender::LUXEMBOURG - 10 - - - const - int - Gender\Gender::NETHERLANDS - 11 - - - const - int - Gender\Gender::GERMANY - 12 - - - const - int - Gender\Gender::EAST_FRISIA - 13 - - - const - int - Gender\Gender::AUSTRIA - 14 - - - const - int - Gender\Gender::SWISS - 15 - - - const - int - Gender\Gender::ICELAND - 16 - - - const - int - Gender\Gender::DENMARK - 17 - - - const - int - Gender\Gender::NORWAY - 18 - - - const - int - Gender\Gender::SWEDEN - 19 - - - const - int - Gender\Gender::FINLAND - 20 - - - const - int - Gender\Gender::ESTONIA - 21 - - - const - int - Gender\Gender::LATVIA - 22 - - - const - int - Gender\Gender::LITHUANIA - 23 - - - const - int - Gender\Gender::POLAND - 24 - - - const - int - Gender\Gender::CZECH_REP - 25 - - - const - int - Gender\Gender::SLOVAKIA - 26 - - - const - int - Gender\Gender::HUNGARY - 27 - - - const - int - Gender\Gender::ROMANIA - 28 - - - const - int - Gender\Gender::BULGARIA - 29 - - - const - int - Gender\Gender::BOSNIA - 30 - - - const - int - Gender\Gender::CROATIA - 31 - - - const - int - Gender\Gender::KOSOVO - 32 - - - const - int - Gender\Gender::MACEDONIA - 33 - - - const - int - Gender\Gender::MONTENEGRO - 34 - - - const - int - Gender\Gender::SERBIA - 35 - - - const - int - Gender\Gender::SLOVENIA - 36 - - - const - int - Gender\Gender::ALBANIA - 37 - - - const - int - Gender\Gender::GREECE - 38 - - - const - int - Gender\Gender::RUSSIA - 39 - - - const - int - Gender\Gender::BELARUS - 40 - - - const - int - Gender\Gender::MOLDOVA - 41 - - - const - int - Gender\Gender::UKRAINE - 42 - - - const - int - Gender\Gender::ARMENIA - 43 - - - const - int - Gender\Gender::AZERBAIJAN - 44 - - - const - int - Gender\Gender::GEORGIA - 45 - - - const - int - Gender\Gender::KAZAKH_UZBEK - 46 - - - const - int - Gender\Gender::TURKEY - 47 - - - const - int - Gender\Gender::ARABIA - 48 - - - const - int - Gender\Gender::ISRAEL - 49 - - - const - int - Gender\Gender::CHINA - 50 - - - const - int - Gender\Gender::INDIA - 51 - - - const - int - Gender\Gender::JAPAN - 52 - - - const - int - Gender\Gender::KOREA - 53 - - - &Methods; - - - - - - - - - -
- - -
- &reftitle.constants; - - - - Gender\Gender::IS_FEMALE - - - - - - - Gender\Gender::IS_MOSTLY_FEMALE - - - - - - - Gender\Gender::IS_MALE - - - - - - - Gender\Gender::IS_MOSTLY_MALE - - - - - - - Gender\Gender::IS_UNISEX_NAME - - - - - - - Gender\Gender::IS_A_COUPLE - - - - - - - Gender\Gender::NAME_NOT_FOUND - - - - - - - Gender\Gender::ERROR_IN_NAME - - - - - - - Gender\Gender::ANY_COUNTRY - - - - - - - Gender\Gender::BRITAIN - - - - - - - Gender\Gender::IRELAND - - - - - - - Gender\Gender::USA - - - - - - - Gender\Gender::SPAIN - - - - - - - Gender\Gender::PORTUGAL - - - - - - - Gender\Gender::ITALY - - - - - - - Gender\Gender::MALTA - - - - - - - Gender\Gender::FRANCE - - - - - - - Gender\Gender::BELGIUM - - - - - - - Gender\Gender::LUXEMBOURG - - - - - - - Gender\Gender::NETHERLANDS - - - - - - - Gender\Gender::GERMANY - - - - - - - Gender\Gender::EAST_FRISIA - - - - - - - Gender\Gender::AUSTRIA - - - - - - - Gender\Gender::SWISS - - - - - - - Gender\Gender::ICELAND - - - - - - - Gender\Gender::DENMARK - - - - - - - Gender\Gender::NORWAY - - - - - - - Gender\Gender::SWEDEN - - - - - - - Gender\Gender::FINLAND - - - - - - - Gender\Gender::ESTONIA - - - - - - - Gender\Gender::LATVIA - - - - - - - Gender\Gender::LITHUANIA - - - - - - - Gender\Gender::POLAND - - - - - - - Gender\Gender::CZECH_REP - - - - - - - Gender\Gender::SLOVAKIA - - - - - - - Gender\Gender::HUNGARY - - - - - - - Gender\Gender::ROMANIA - - - - - - - Gender\Gender::BULGARIA - - - - - - - Gender\Gender::BOSNIA - - - - - - - Gender\Gender::CROATIA - - - - - - - Gender\Gender::KOSOVO - - - - - - - Gender\Gender::MACEDONIA - - - - - - - Gender\Gender::MONTENEGRO - - - - - - - Gender\Gender::SERBIA - - - - - - - Gender\Gender::SLOVENIA - - - - - - - Gender\Gender::ALBANIA - - - - - - - Gender\Gender::GREECE - - - - - - - Gender\Gender::RUSSIA - - - - - - - Gender\Gender::BELARUS - - - - - - - Gender\Gender::MOLDOVA - - - - - - - Gender\Gender::UKRAINE - - - - - - - Gender\Gender::ARMENIA - - - - - - - Gender\Gender::AZERBAIJAN - - - - - - - Gender\Gender::GEORGIA - - - - - - - Gender\Gender::KAZAKH_UZBEK - - - - - - - Gender\Gender::TURKEY - - - - - - - Gender\Gender::ARABIA - - - - - - - Gender\Gender::ISRAEL - - - - - - - Gender\Gender::CHINA - - - - - - - Gender\Gender::INDIA - - - - - - - Gender\Gender::JAPAN - - - - - - - Gender\Gender::KOREA - - - - - - -
- - -
- - &reference.gender.entities.gender; - -
- diff --git a/reference/gender/gender/connect.xml b/reference/gender/gender/connect.xml deleted file mode 100644 index 561be3863a..0000000000 --- a/reference/gender/gender/connect.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - Gender\Gender::connect - Conexión a un diccionario externo - - - - &reftitle.description; - - public boolGender\Gender::connect - stringdsn - - - Conexión a un diccionario externo. - Actualmente, solo los flujos son soportados. - - - - - &reftitle.parameters; - - - dsn - - - DSN a abrir. - - - - - - - - &reftitle.returnvalues; - - Un booleano en caso de éxito o de fracaso. - - - - diff --git a/reference/gender/gender/construct.xml b/reference/gender/gender/construct.xml deleted file mode 100644 index 3b5a9807d6..0000000000 --- a/reference/gender/gender/construct.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - Gender\Gender::__construct - Construye un objeto Gender - - - - &reftitle.description; - - public Gender\Gender::__construct - stringdsn - - - Crea un objeto Gender, conectándose, opcionalmente, a un - diccionario externo. Cuando no se proporciona ninguna base de datos, - se utilizarán los datos compilados internamente. - - - - - &reftitle.parameters; - - - dsn - - - DSN a abrir. - - - - - - - - diff --git a/reference/gender/gender/country.xml b/reference/gender/gender/country.xml deleted file mode 100644 index 7cfccb6104..0000000000 --- a/reference/gender/gender/country.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - Gender\Gender::country - Obtiene la representación textual de un país - - - - &reftitle.description; - - public arrayfalseGender\Gender::country - intcountry - - - Obtiene la representación textual de un país desde - la constante de la clase Gender. - - - - - &reftitle.parameters; - - - country - - - Identificador del país (corresponde a una constante de la clase - Gender\Gender). - - - - - - - - &reftitle.returnvalues; - - Devuelve un array que contiene los nombres cortos y largos - del país en caso de éxito &return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo con <methodname>Gender\Gender::country</methodname> - -country(Gender\Gender::BRITAIN)); -]]> - - &example.outputs; - - - string(2) "UK" - 'country' => - string(13) "Great Britain" -} -]]> - - - - - diff --git a/reference/gender/gender/get.xml b/reference/gender/gender/get.xml deleted file mode 100644 index cd49466df8..0000000000 --- a/reference/gender/gender/get.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - Gender\Gender::get - Obtiene el género de un nombre - - - - &reftitle.description; - - public intGender\Gender::get - stringname - intcountry - - - Obtiene el género de un nombre para un país específico. - - - - - &reftitle.parameters; - - - name - - - El nombre a verificar. - - - - - country - - - El identificador del país (una constante de la clase Gender). - - - - - - - - &reftitle.returnvalues; - - Devuelve el género del nombre. - - - - - diff --git a/reference/gender/gender/isnick.xml b/reference/gender/gender/isnick.xml deleted file mode 100644 index 181c1dc5ae..0000000000 --- a/reference/gender/gender/isnick.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - Gender\Gender::isNick - Verifica si name0 es un alias de name1 - - - - &reftitle.description; - - public arrayGender\Gender::isNick - stringname0 - stringname1 - intcountry - - - Verifica si name0 es un alias de name1. - - - - - &reftitle.parameters; - - - name0 - - - Nombre a verificar. - - - - - name1 - - - Nombre a verificar. - - - - - country - - - Identificador del país, identificado por la constante de la - clase Gender. Si se omite, ANY_COUNTRY será utilizado. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/gender/gender/similarnames.xml b/reference/gender/gender/similarnames.xml deleted file mode 100644 index 96fe8d4aa1..0000000000 --- a/reference/gender/gender/similarnames.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - Gender\Gender::similarNames - Obtiene nombres similares - - - - &reftitle.description; - - public arrayGender\Gender::similarNames - stringname - intcountry - - - Obtiene nombres similares para el nombre y el país proporcionados. - - - - - &reftitle.parameters; - - - name - - - Nombre a verificar. - - - - - country - - - Identificador del país, identificado por la constante de clase - Gender. Si se omite, se utilizará ANY_COUNTRY. - - - - - - - - &reftitle.returnvalues; - - Devuelve un array que contiene los nombres similares encontrados. - - - - - diff --git a/reference/gender/setup.xml b/reference/gender/setup.xml deleted file mode 100644 index 1f8c86865b..0000000000 --- a/reference/gender/setup.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - &reftitle.setup; - - - -
- &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;gender. - -
- - - -
- diff --git a/reference/geoip/book.xml b/reference/geoip/book.xml deleted file mode 100644 index f6406d2418..0000000000 --- a/reference/geoip/book.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - Localización geográfica de las IPs - GeoIP - - - &reftitle.intro; - - La extensión GeoIP permite localizar una dirección IP. La ciudad, el estado, el país, - la longitud, la latitud y otra información como el ISP y el tipo de conexión - pueden ser obtenidos gracias a GeoIP. - - - - Esta extensión no soporta las bases de datos "GeoIP2" - actuales de MaxMind, únicamente los ficheros de base de datos "GeoIP Legacy". - - - - - &reference.geoip.setup; - &reference.geoip.constants; - &reference.geoip.reference; - - - diff --git a/reference/geoip/constants.xml b/reference/geoip/constants.xml deleted file mode 100644 index 45c9456a7f..0000000000 --- a/reference/geoip/constants.xml +++ /dev/null @@ -1,191 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - GEOIP_COUNTRY_EDITION - (int) - - - - - - - - - - GEOIP_REGION_EDITION_REV0 - (int) - - - - - - - - - - GEOIP_CITY_EDITION_REV0 - (int) - - - - - - - - - - GEOIP_ORG_EDITION - (int) - - - - - - - - - - GEOIP_ISP_EDITION - (int) - - - - - - - - - - GEOIP_CITY_EDITION_REV1 - (int) - - - - - - - - - - GEOIP_REGION_EDITION_REV1 - (int) - - - - - - - - - - GEOIP_PROXY_EDITION - (int) - - - - - - - - - - GEOIP_ASNUM_EDITION - (int) - - - - - - - - - - GEOIP_NETSPEED_EDITION - (int) - - - - - - - - - - GEOIP_DOMAIN_EDITION - (int) - - - - - - - - - - Las constantes siguientes se utilizan para la velocidad de red: - - - - - GEOIP_UNKNOWN_SPEED - (int) - - - - - - - - GEOIP_DIALUP_SPEED - (int) - - - - - - - - GEOIP_CABLEDSL_SPEED - (int) - - - - - - - - GEOIP_CORPORATE_SPEED - (int) - - - - - - - - diff --git a/reference/geoip/functions/geoip-asnum-by-name.xml b/reference/geoip/functions/geoip-asnum-by-name.xml deleted file mode 100644 index 2ad95e9d5e..0000000000 --- a/reference/geoip/functions/geoip-asnum-by-name.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - geoip_asnum_by_name - Recupera el ASN (Autonomous System Numbers) - - - &reftitle.description; - - stringgeoip_asnum_by_name - stringhostname - - - - La función geoip_asnum_by_name recupera el ASN - (Autonomous System Numbers) asociado con la dirección IP. - - - - - &reftitle.parameters; - - - hostname - - - El nombre de host o la dirección IP. - - - - - - - &reftitle.returnvalues; - - Devuelve el ASN en caso de éxito, o &false; si la dirección no puede - ser encontrada en la base de datos. - - - - - &reftitle.examples; - - Ejemplo con <function>geoip_asnum_by_name</function> - - Este ejemplo mostrará el ASN para el host www.example.com. - - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/geoip/functions/geoip-continent-code-by-name.xml b/reference/geoip/functions/geoip-continent-code-by-name.xml deleted file mode 100644 index 4e02b53916..0000000000 --- a/reference/geoip/functions/geoip-continent-code-by-name.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - - geoip_continent_code_by_name - Lee el código de continente de una IP - - - &reftitle.description; - - stringgeoip_continent_code_by_name - stringhostname - - - - geoip_continent_code_by_name devuelve el código de dos letras del continente correspondiente a un nombre de host o una dirección IP. - - - - - &reftitle.parameters; - - - hostname - - - El nombre de host o la dirección IP que se está estudiando. - - - - - - - &reftitle.returnvalues; - - Devuelve el código de dos letras del nombre del continente, en caso de éxito, - y &false; si la dirección no ha podido ser encontrada en la base. - - - Códigos de continente - - - - Código - Nombre del continente - - - - - AF - África - - - AN - Antártida - - - AS - Asia - - - EU - Europa - - - NA - América del Norte - - - OC - Oceanía - - - SA - América del Sur - - - -
-
- - - &reftitle.examples; - - Ejemplo con <function>geoip_continent_code_by_name</function> - - Este script mostrará el continente del host example.com. - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - geoip_country_code_by_name - - - -
- diff --git a/reference/geoip/functions/geoip-country-code-by-name.xml b/reference/geoip/functions/geoip-country-code-by-name.xml deleted file mode 100644 index 3e16a678a7..0000000000 --- a/reference/geoip/functions/geoip-country-code-by-name.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - geoip_country_code_by_name - Recupera las dos letras del código del país - - - &reftitle.description; - - stringgeoip_country_code_by_name - stringhostname - - - - La función geoip_country_code_by_name - devuelve las dos letras del código del país correspondiente al nombre del host o - a la dirección IP. - - - - - &reftitle.parameters; - - - hostname - - - El nombre del host o la dirección IP - - - - - - - &reftitle.returnvalues; - - Devuelve las dos letras del código del país ISO en caso de éxito, o - &false; si la dirección no pudo ser encontrada en la base de datos. - - - - - &reftitle.examples; - - Ejemplo con <function>geoip_country_code_by_name</function> - - Este ejemplo muestra la localización del host example.com. - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.notes; - - - Consulte la página - &url.maxmind.iso3166; - para una lista completa de los valores devueltos posibles, incluyendo - los códigos especiales. - - - - - - &reftitle.seealso; - - geoip_country_code3_by_name - geoip_country_name_by_name - - - - - diff --git a/reference/geoip/functions/geoip-country-code3-by-name.xml b/reference/geoip/functions/geoip-country-code3-by-name.xml deleted file mode 100644 index 08ed5b371a..0000000000 --- a/reference/geoip/functions/geoip-country-code3-by-name.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - geoip_country_code3_by_name - Recupera las tres letras del código del país - - - &reftitle.description; - - stringgeoip_country_code3_by_name - stringhostname - - - - La función geoip_country_code3_by_name - devuelve las tres letras del código del país correspondiente al nombre del host o - a la dirección IP. - - - - - &reftitle.parameters; - - - hostname - - - El nombre del host o la dirección IP - - - - - - - &reftitle.returnvalues; - - Devuelve las tres letras del código del país en caso de éxito, o &false; - si la dirección no pudo ser encontrada en la base de datos. - - - - - &reftitle.examples; - - Ejemplo con <function>geoip_country_code3_by_name</function> - - Este ejemplo muestra dónde está localizado el host example.com. - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - geoip_country_code_by_name - geoip_country_name_by_name - - - - diff --git a/reference/geoip/functions/geoip-country-name-by-name.xml b/reference/geoip/functions/geoip-country-name-by-name.xml deleted file mode 100644 index c3f251dcc6..0000000000 --- a/reference/geoip/functions/geoip-country-name-by-name.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - geoip_country_name_by_name - Recupera el nombre completo del país - - - &reftitle.description; - - stringgeoip_country_name_by_name - stringhostname - - - - La función geoip_country_name_by_name devuelve - el nombre completo del país correspondiente al nombre del host o a la - dirección IP. - - - - - &reftitle.parameters; - - - hostname - - - El nombre del host o la dirección IP - - - - - - - &reftitle.returnvalues; - - Devuelve el nombre del país en caso de éxito, o &false; si la dirección - no pudo ser encontrada en la base de datos. - - - - - &reftitle.examples; - - Ejemplo con <function>geoip_country_name_by_name</function> - - Este ejemplo muestra la localización del host example.com. - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - geoip_country_code_by_name - geoip_country_code3_by_name - - - - - diff --git a/reference/geoip/functions/geoip-database-info.xml b/reference/geoip/functions/geoip-database-info.xml deleted file mode 100644 index cadfaca1ca..0000000000 --- a/reference/geoip/functions/geoip-database-info.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - geoip_database_info - Recupera la información de la base de datos GeoIP - - - &reftitle.description; - - stringgeoip_database_info - intdatabaseGEOIP_COUNTRY_EDITION - - - - La función geoip_database_info devuelve - la versión de la base de datos GeoIP tal como se define en el fichero binario. - - - - Si esta función se llama sin argumento, devuelve la versión - de la GeoIP Free Country Edition. - - - - - &reftitle.parameters; - - - database - - - El tipo de base de datos, como entero. Se pueden utilizar - diversas constantes definidas - con esta extensión (ie: GEOIP_*_EDITION). - - - - - - - - &reftitle.returnvalues; - - Devuelve la versión correspondiente de la base de datos, o &null; - si ocurre un error. - - - - - &reftitle.examples; - - Ejemplo con <function>geoip_database_info</function> - - Este ejemplo muestra la información contenida en la base de datos. - - - -]]> - - &example.outputs; - - - - - - - diff --git a/reference/geoip/functions/geoip-db-avail.xml b/reference/geoip/functions/geoip-db-avail.xml deleted file mode 100644 index 44f1378b75..0000000000 --- a/reference/geoip/functions/geoip-db-avail.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - geoip_db_avail - Verifica si la base de datos GeoIP está disponible - - - &reftitle.description; - - boolgeoip_db_avail - intdatabase - - - - La función geoip_db_avail verifica si la base - de datos correspondiente está disponible y puede ser abierta en el disco. - - - - La función no indica si el fichero es una base de datos válida, - sino únicamente si es legible. - - - - - &reftitle.parameters; - - - database - - - El tipo de base de datos, en forma de un &integer;. - Se pueden utilizar diversas constantes, - definidas con esta extensión (ie: GEOIP_*_EDITION). - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si la base de datos existe, &false; si no se encuentra, - o &null; si ocurre un error. - - - - - &reftitle.examples; - - Ejemplo con <function>geoip_db_avail</function> - - Esto mostrará la versión de la base de datos actual. - - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/geoip/functions/geoip-db-filename.xml b/reference/geoip/functions/geoip-db-filename.xml deleted file mode 100644 index 31db7319f7..0000000000 --- a/reference/geoip/functions/geoip-db-filename.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - geoip_db_filename - Devuelve el nombre del fichero que contiene la base de datos GeoIP especificada - - - &reftitle.description; - - stringgeoip_db_filename - intdatabase - - - - La función geoip_db_filename devuelve el nombre - del fichero que contiene la base de datos GeoIP especificada. - - - - La función no indica si el fichero existe o no en el disco, sino únicamente - el lugar en el que la biblioteca busca la base de datos. - - - - - &reftitle.parameters; - - - database - - - El tipo de base de datos, en forma de un &integer;. Se pueden - utilizar diversas constantes, - definidas con esta extensión (ie: GEOIP_*_EDITION). - - - - - - - - &reftitle.returnvalues; - - Devuelve el nombre del fichero de la base de datos correspondiente, o - &null; si ocurre un error. - - - - - &reftitle.examples; - - Ejemplo con <function>geoip_db_filename</function> - - Esto mostrará el nombre del fichero correspondiente a la base de datos. - - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/geoip/functions/geoip-db-get-all-info.xml b/reference/geoip/functions/geoip-db-get-all-info.xml deleted file mode 100644 index ad0488a9ed..0000000000 --- a/reference/geoip/functions/geoip-db-get-all-info.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - - geoip_db_get_all_info - Devuelve información detallada sobre todos los tipos de bases de datos GeoIP - - - &reftitle.description; - - arraygeoip_db_get_all_info - - - - - La función geoip_db_get_all_info devuelve información - detallada, en forma de un array multidimensional, sobre - todos los tipos de bases de datos GeoIP. - - - Esta función está disponible incluso si no se ha instalado ninguna base de datos. - Simplemente listará las bases de datos como no disponibles. - - - Los nombres de las diferentes claves del array asociativo devuelto son los siguientes: - - - - - "available" : Booleano, indica si la base de datos está disponible (ver la función - geoip_db_avail) - - - - - "description" : La descripción de la base de datos - - - - - "filename" : El nombre del fichero que contiene la base de datos en el disco (ver la función - geoip_db_filename) - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un array asociativo. - - - - - &reftitle.examples; - - Ejemplo con <function>geoip_db_get_all_info</function> - - Esto mostrará un array que contiene toda la información. - - - -]]> - - &example.outputs; - - - array(3) { - ["available"]=> - bool(true) - ["description"]=> - string(21) "GeoIP Country Edition" - ["filename"]=> - string(32) "/usr/share/GeoIP/GeoIP.dat" - } - -[ ... ] - - [11]=> - array(3) { - ["available"]=> - bool(false) - ["description"]=> - string(25) "GeoIP Domain Name Edition" - ["filename"]=> - string(38) "/usr/share/GeoIP/GeoIPDomain.dat" - } -} -]]> - - - - - Ejemplo con <function>geoip_db_get_all_info</function> - - Se pueden utilizar diversas constantes como claves para recuperar solo - partes de la información. - - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/geoip/functions/geoip-domain-by-name.xml b/reference/geoip/functions/geoip-domain-by-name.xml deleted file mode 100644 index 5c09d3e4cf..0000000000 --- a/reference/geoip/functions/geoip-domain-by-name.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - geoip_domain_by_name - Recupera el segundo nivel del nombre de dominio - - - &reftitle.description; - - stringgeoip_domain_by_name - stringhostname - - - - La función geoip_domain_by_name devuelve el - segundo nivel del dominio asociado con un nombre de host o la dirección IP. - - - Esta función está actualmente disponible solo para los usuarios que - han comprado una edición comercial de GeoIP Domain. Se emitirá una alerta - si no se puede encontrar la base de datos correcta. - - - - - &reftitle.parameters; - - - hostname - - - El nombre de host o la dirección IP. - - - - - - - &reftitle.returnvalues; - - Devuelve el nombre de dominio en caso de éxito, o &false; si la dirección - no puede ser encontrada en la base de datos. - - - - - &reftitle.examples; - - Ejemplo con <function>geoip_domain_by_name</function> - - Este ejemplo mostrará el dominio asociado con la IP 61.106.139.1. - - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/geoip/functions/geoip-id-by-name.xml b/reference/geoip/functions/geoip-id-by-name.xml deleted file mode 100644 index 6e426e719c..0000000000 --- a/reference/geoip/functions/geoip-id-by-name.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - - geoip_id_by_name - Recupera el tipo de conexión a Internet - - - &reftitle.description; - - intgeoip_id_by_name - stringhostname - - - - La función geoip_id_by_name - devuelve el tipo de conexión a Internet correspondiente al nombre del host o - a la dirección IP. - - - El valor devuelto es de tipo numérico y puede ser comparado con - las siguientes constantes: - - - - - GEOIP_UNKNOWN_SPEED - - - - - GEOIP_DIALUP_SPEED - - - - - GEOIP_CABLEDSL_SPEED - - - - - GEOIP_CORPORATE_SPEED - - - - - - - &reftitle.parameters; - - - hostname - - - El nombre del host o la dirección IP cuyo tipo de conexión debe ser examinado. - - - - - - - &reftitle.returnvalues; - - Devuelve el tipo de conexión. - - - - - &reftitle.examples; - - Ejemplo con <function>geoip_id_by_name</function> - - Este ejemplo muestra el tipo de conexión del host example.com. - - - -]]> - - &example.outputs; - - - - - - - diff --git a/reference/geoip/functions/geoip-isp-by-name.xml b/reference/geoip/functions/geoip-isp-by-name.xml deleted file mode 100644 index 50347cb68a..0000000000 --- a/reference/geoip/functions/geoip-isp-by-name.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - geoip_isp_by_name - Recupera el nombre del proveedor de servicios de Internet - - - &reftitle.description; - - stringgeoip_isp_by_name - stringhostname - - - - La función geoip_isp_by_name devuelve el nombre - del ISP al que está asignada la IP. - - - Esta función está actualmente disponible solo para los usuarios que han - adquirido una edición comercial de GeoIP ISP. Se emitirá una advertencia - si la base de datos no puede ser localizada. - - - - - &reftitle.parameters; - - - hostname - - - El nombre del host o la dirección IP. - - - - - - - &reftitle.returnvalues; - - Devuelve el nombre del ISP en caso de éxito, o &false; si la dirección - no puede ser encontrada en la base de datos. - - - - - &reftitle.examples; - - Ejemplo con <function>geoip_isp_by_name</function> - - Esto mostrará el nombre del ISP para el host example.com. - - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/geoip/functions/geoip-netspeedcell-by-name.xml b/reference/geoip/functions/geoip-netspeedcell-by-name.xml deleted file mode 100644 index 5e07ac1657..0000000000 --- a/reference/geoip/functions/geoip-netspeedcell-by-name.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - geoip_netspeedcell_by_name - Recupera la velocidad de la conexión a Internet - - - &reftitle.description; - - stringgeoip_netspeedcell_by_name - stringhostname - - - - La función geoip_netspeedcell_by_name devolverá - el tipo de conexión a Internet así como su velocidad, según un - nombre de host o una dirección IP. - - - Esta función solo está disponible al utilizar la versión - 1.4.8 de la biblioteca GeoIP, o superiores. - - - Esta función está actualmente disponible únicamente para los usuarios - que han comprado una edición comercial de GeoIP NetSpeedCell. Se emitirá una alerta - si no se puede encontrar la base de datos correcta. - - - El valor devuelto será un string cuyos valores comunes son: - - - - - Cable/DSL - - - - - Dialup - - - - - Cellular - - - - - Corporate - - - - - - - &reftitle.parameters; - - - hostname - - - El nombre de host, o la dirección IP. - - - - - - - &reftitle.returnvalues; - - Devuelve la velocidad de la conexión en caso de éxito, o &false; si - la dirección no puede ser encontrada en la base de datos. - - - - - &reftitle.examples; - - Ejemplo con <function>geoip_netspeedcell_by_name</function> - - Este ejemplo mostrará la velocidad de la conexión del host example.com. - - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/geoip/functions/geoip-org-by-name.xml b/reference/geoip/functions/geoip-org-by-name.xml deleted file mode 100644 index 29c58d6d45..0000000000 --- a/reference/geoip/functions/geoip-org-by-name.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - geoip_org_by_name - Recupera el nombre de la organización - - - &reftitle.description; - - stringgeoip_org_by_name - stringhostname - - - - La función geoip_org_by_name devuelve - el nombre de la organización a la que se asigna la dirección IP. - - - Esta función está actualmente disponible únicamente para los usuarios - que han adquirido una licencia comercial GeoIP Organization, - ISP o AS Edition. - Se emitirá una alerta si la base de datos no puede ser encontrada. - - - - &reftitle.parameters; - - - hostname - - - El nombre del host o la dirección IP - - - - - - - &reftitle.returnvalues; - - Devuelve el nombre de la organización en caso de éxito, o &false; - si la dirección no pudo ser encontrada en la base de datos. - - - - - &reftitle.examples; - - Ejemplo con <function>geoip_org_by_name</function> - - Este ejemplo muestra el nombre de la organización para el host example.com. - - - -]]> - - &example.outputs; - - - - - - - diff --git a/reference/geoip/functions/geoip-record-by-name.xml b/reference/geoip/functions/geoip-record-by-name.xml deleted file mode 100644 index 0e069177f1..0000000000 --- a/reference/geoip/functions/geoip-record-by-name.xml +++ /dev/null @@ -1,202 +0,0 @@ - - - - - - geoip_record_by_name - Recupera la información registrada correspondiente al nombre del host o a la dirección IP, encontrada en la base de datos GeoIP - - - &reftitle.description; - - arraygeoip_record_by_name - stringhostname - - - - La función geoip_record_by_name devuelve - la información registrada correspondiente al nombre del host o - a la dirección IP. - - - Esta función está disponible para las bases de datos GeoLite City Edition y - la versión comercial GeoIP City Edition. - Se emitirá una alerta si la base de datos no ha podido ser encontrada. - - - Los nombres de las diferentes claves del array asociativo devuelto son los siguientes: - - - - - "continent_code" : Código del continente en 2 letras (disponible desde - la versión 1.0.4 con libgeoip 1.4.3 o superior) - - - - - "country_code" : Las dos letras del código del país (Véase - geoip_country_code_by_name) - - - - - "country_code3" : Código del país en 3 letras (Véase la función - geoip_country_code3_by_name) - - - - - "country_name" : Nombre del país (Véase la función - geoip_country_name_by_name) - - - - - "region" : El código de la región (ej: CA para California) - - - - - "city" : La ciudad. - - - - - "postal_code" : El código postal, FSA o Zip. - - - - - "latitude" : La latitud como float firmado. - - - - - "longitude" : La longitud como float firmado. - - - - - "dma_code" : Código de la zona de mercado (Solo para EE.UU. - y Canadá) - - - - - "area_code" : El código PSTN (ej: 212) - - - - - - - &reftitle.parameters; - - - hostname - - - El nombre del host o la dirección IP - - - - - - - - &reftitle.returnvalues; - - Devuelve un array asociativo en caso de éxito, o &false; si la dirección - no ha podido ser encontrada en la base de datos. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL geoip 1.0.4 - - Adición de continent_code con la biblioteca GeoIP 1.4.3 o superior únicamente - - - - PECL geoip 1.0.3 - - Adición de country_code3 y de country_name - - - - - - - - - &reftitle.examples; - - Ejemplo con <function>geoip_record_by_name</function> - - Este ejemplo muestra el array que contiene el registro del host - example.com. - - - -]]> - - &example.outputs; - - NA - [country_code] => US - [country_code3] => USA - [country_name] => United States - [region] => CA - [city] => Marina Del Rey - [postal_code] => - [latitude] => 33.9776992798 - [longitude] => -118.435096741 - [dma_code] => 803 - [area_code] => 310 -) -]]> - - - - - diff --git a/reference/geoip/functions/geoip-region-by-name.xml b/reference/geoip/functions/geoip-region-by-name.xml deleted file mode 100644 index 2cbf2d38b3..0000000000 --- a/reference/geoip/functions/geoip-region-by-name.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - geoip_region_by_name - Recupera el código del país y la región - - - &reftitle.description; - - arraygeoip_region_by_name - stringhostname - - - - La función geoip_region_by_name devuelve - el país y la región correspondientes al nombre del host o a la dirección IP. - - - Esta función está actualmente disponible únicamente para los usuarios - que han adquirido una licencia comercial GeoIP Region Edition. Se emitirá una alerta - si la base de datos no ha podido ser encontrada. - - - Los nombres de las diferentes claves del array devuelto son los siguientes: - - - - - "country_code" : Las dos letras del código del país (Ver la función - geoip_country_code_by_name) - - - - - "region" : El código de la región (ej: CA para California) - - - - - - &reftitle.parameters; - - - hostname - - - El nombre del host o la dirección IP - - - - - - - &reftitle.returnvalues; - - Devuelve un array asociativo en caso de éxito, o &false; si la dirección - no ha podido ser encontrada en la base de datos. - - - - - &reftitle.examples; - - Ejemplo con <function>geoip_region_by_name</function> - - Este ejemplo muestra el array que contiene el código del país y la región - del host example.com. - - - -]]> - - &example.outputs; - - US - [region] => CA -) -]]> - - - - - diff --git a/reference/geoip/functions/geoip-region-name-by-code.xml b/reference/geoip/functions/geoip-region-name-by-code.xml deleted file mode 100644 index a6aae029e5..0000000000 --- a/reference/geoip/functions/geoip-region-name-by-code.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - - geoip_region_name_by_code - Devuelve el nombre de la región para un país y un código de región - - - &reftitle.description; - - stringgeoip_region_name_by_code - stringcountry_code - stringregion_code - - - - geoip_region_name_by_code devuelve el nombre de la región correspondiente - a un par país y región. - - - En los Estados Unidos de América, la región corresponde a la abreviatura de dos letras - del estado. En Canadá, esta región corresponde a la abreviatura de la provincia o del - territorio, tal como lo asigna Correos de Canadá. - - - Para el resto del mundo, GeoIP utiliza los códigos FIPS 10-4 para representar las regiones. - Se puede verificar el sitio &url.maxmind.fips; - para obtener una lista detallada de los códigos FIPS 10-4. - - - Esta función está siempre disponible si se utiliza la versión 1.4.1 o superior de la biblioteca GeoIP. Los datos se obtienen directamente de la biblioteca GeoIP y no de una tabla de referencia. - - - - &reftitle.parameters; - - - country_code - - - El código del país, en dos letras (véase - geoip_country_code_by_name) - - - - - region_code - - - El código de la región en dos letras (véase - geoip_region_by_name) - - - - - - - &reftitle.returnvalues; - - Devuelve el nombre de la región en caso de éxito, o &false; si el país, la región o la combinación - de ambos no se encuentra. - - - - - &reftitle.examples; - - - Ejemplo con <function>geoip_region_name_by_code</function> para EE.UU. y Canadá - - Este script mostrará el nombre de la región para la región QC en CA. - - - -]]> - - &example.outputs; - - - - - - Ejemplo con <function>geoip_region_name_by_code</function> utilizando los códigos FIPS - - Este script mostrará el nombre de la región para la región 01 en JP (Japón). - - - -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/geoip/functions/geoip-setup-custom-directory.xml b/reference/geoip/functions/geoip-setup-custom-directory.xml deleted file mode 100644 index cc3b14d951..0000000000 --- a/reference/geoip/functions/geoip-setup-custom-directory.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - geoip_setup_custom_directory - Define un directorio personalizado para la base de datos GeoIP - - - &reftitle.description; - - voidgeoip_setup_custom_directory - stringpath - - - - La función geoip_setup_custom_directory - modificará el directorio por omisión de la base de datos GeoIP. - Esto es equivalente a modificar la opción de configuración - geoip.custom_directory. - - - - - &reftitle.parameters; - - - path - - - La ruta de acceso completa donde se encuentra la base de datos GeoIP en el disco. - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo con <function>geoip_setup_custom_directory</function> - - Este ejemplo modificará la ruta de acceso por omisión hacia la base de datos GeoIP. - - - -]]> - - &example.outputs; - - - - - - - - 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 deleted file mode 100644 index 2a23a8df7f..0000000000 --- a/reference/geoip/functions/geoip-time-zone-by-country-and-region.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - geoip_time_zone_by_country_and_region - Devuelve la zona horaria de ciertos países y regiones del mundo - - - &reftitle.description; - - stringgeoip_time_zone_by_country_and_region - stringcountry_code - stringregion_code - - - - geoip_time_zone_by_country_and_region devuelve la zona horaria - correspondiente a un país y una región. - - - En los Estados Unidos de América, la región corresponde a la abreviatura de dos letras - del estado. En Canadá, esta región corresponde a la abreviatura de la provincia o del - territorio, tal como lo asigna Correos de Canadá. - - - Para el resto del mundo, GeoIP utiliza los códigos FIPS 10-4 para representar las regiones. - Se puede verificar el sitio &url.maxmind.fips; - para una lista detallada de los códigos FIPS 10-4. - - - Esta función está siempre disponible si se utiliza GeoIP Library - versión 1.4.1 o más reciente. Los datos provienen directamente de GeoIP - Library y no de una tabla de referencia. - - - - &reftitle.parameters; - - - country_code - - - El código del país, en dos letras (véase - geoip_country_code_by_name) - - - - - region_code - - - El código de región en dos letras (véase - geoip_region_by_name) - - - - - - - &reftitle.returnvalues; - - Devuelve la zona horaria en caso de éxito, y &false; si el país, - la región o la combinación de ambos no se encuentra. - - - - - &reftitle.examples; - - - Ejemplo con <function>geoip_time_zone_by_country_and_region</function> para EE.UU. y Canadá - - Este script mostrará la zona horaria de Quebec, Canadá. - - - -]]> - - &example.outputs; - - - - - - Ejemplo con <function>geoip_time_zone_by_country_and_region</function> y los códigos FIPS - - Este script mostrará la zona horaria de Japón, región 01 (Aichi). - - - -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/geoip/ini.xml b/reference/geoip/ini.xml deleted file mode 100644 index 6d4048c97a..0000000000 --- a/reference/geoip/ini.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - -
- &reftitle.runtime; - &extension.runtime; - - GeoIP &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - geoip.custom_directory - "" - INI_ALL - - - - -
- - &ini.descriptions.title; - - - - - geoip.custom_directory - string - - - - Vacío por omisión, pero puede ser utilizado para cargar una base - de datos diferente de la incluida en la biblioteca. - - - - -
diff --git a/reference/geoip/reference.xml b/reference/geoip/reference.xml deleted file mode 100644 index e3b693f66f..0000000000 --- a/reference/geoip/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - - - &Functions; GeoIP - &reference.geoip.entities.functions; - - - diff --git a/reference/geoip/setup.xml b/reference/geoip/setup.xml deleted file mode 100644 index e460bf99e1..0000000000 --- a/reference/geoip/setup.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - &reftitle.setup; - -
- &reftitle.required; - - Esta extensión requiere la biblioteca GeoIP versión 1.4.0 o posterior. - La última versión puede ser obtenida en - &url.maxmind.geoip; - y compilada por usted mismo. - - - Por omisión, solo se puede acceder a la base de datos - Free GeoIP Country o GeoLite - City. Aunque este módulo puede funcionar con otros tipos - de bases de datos, es necesario adquirir una licencia comercial en - Maxmind. - -
- -
- &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;geoip. - -
- - &reference.geoip.ini; - -
- diff --git a/reference/gmagick/book.xml b/reference/gmagick/book.xml deleted file mode 100644 index 40604f51e4..0000000000 --- a/reference/gmagick/book.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - - Gmagick - Gmagick - - - &reftitle.intro; - &warn.experimental; - - Gmagick es una extensión PHP para crear, modificar y obtener información méta sobre imágenes utilizando la API GraphicsMagick. - - - GraphicsMagick se enorgullece de ser el cuchillo suizo del tratamiento de imágenes. Funciona con aproximadamente 88 formatos principales, incluyendo formatos importantes como DPX, GIF, JPEG, JPEG-2000, PNG, PDF, PNM y TIFF. - - - Gmagick se compone de una clase principal Gmagick, una clase GmagickDraw que se encarga del dibujo y una clase GmagickPixel cuyas instancias representan un solo píxel de una imagen (color, opacidad). - - - - &reference.gmagick.setup; - &reference.gmagick.constants; - &reference.gmagick.examples; - &reference.gmagick.gmagick; - &reference.gmagick.gmagickdraw; - &reference.gmagick.gmagickpixel; - &reference.gmagick.gmagickexception; - &reference.gmagick.gmagickpixelexception; - - diff --git a/reference/gmagick/constants.xml b/reference/gmagick/constants.xml deleted file mode 100644 index c62fd64f78..0000000000 --- a/reference/gmagick/constants.xml +++ /dev/null @@ -1,3137 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - Constantes relativas a los tipos de color - - - Gmagick::COLOR_BLACK - (int) - - - - Negro - - - - - - Gmagick::COLOR_BLUE - (int) - - - - Azul - - - - - - Gmagick::COLOR_CYAN - (int) - - - - Cian - - - - - - Gmagick::COLOR_GREEN - (int) - - - - Verde - - - - - - Gmagick::COLOR_RED - (int) - - - - Rojo - - - - - - Gmagick::COLOR_YELLOW - (int) - - - - Amarillo - - - - - - Gmagick::COLOR_MAGENTA - (int) - - - - Magenta - - - - - - Gmagick::COLOR_OPACITY - (int) - - - - Opacidad - - - - - - Gmagick::COLOR_ALPHA - (int) - - - - Alpha - - - - - - Gmagick::COLOR_FUZZ - (int) - - - - Fuzz - - - - - - Constantes relativas a los operadores compuestos - - - Gmagick::COMPOSITE_DEFAULT - (int) - - - - El operador compuesto por defecto - - - - - - Gmagick::COMPOSITE_UNDEFINED - (int) - - - - Operador compuesto indefinido - - - - - - Gmagick::COMPOSITE_NO - (int) - - - - Ningún operador compuesto definido - - - - - - Gmagick::COMPOSITE_ADD - (int) - - - - El resultado de una imagen + una imagen - - - - - - Gmagick::COMPOSITE_ATOP - (int) - - - - El resultado es la misma forma que una imagen; donde la imagen compuesta - oscurece la imagen, la imagen de la forma la superpone. - - - - - - Gmagick::COMPOSITE_BLEND - (int) - - - - Mezcla la imagen - - - - - - Gmagick::COMPOSITE_BUMPMAP - (int) - - - - Idéntico a COMPOSITE_MULTIPLY, excepto que la fuente - se convierte primero a niveles de gris. - - - - - - Gmagick::COMPOSITE_CLEAR - (int) - - - - Hace que la imagen de destino sea transparente - - - - - - Gmagick::COMPOSITE_COLORBURN - (int) - - - - Oscurece la imagen de destino para reflejar la imagen fuente - - - - - - Gmagick::COMPOSITE_COLORDODGE - (int) - - - - Aclara la imagen de destino para reflejar la imagen fuente - - - - - - Gmagick::COMPOSITE_COLORIZE - (int) - - - - Colorea la imagen de destino utilizando la imagen compuesta - - - - - - Gmagick::COMPOSITE_COPYBLACK - (int) - - - - Copia los negros desde la fuente hacia la imagen de destino - - - - - - Gmagick::COMPOSITE_COPYBLUE - (int) - - - - Copia los azules desde la fuente hacia la imagen de destino - - - - - - Gmagick::COMPOSITE_COPY - (int) - - - - Copia la imagen fuente sobre la imagen de destino - - - - - - Gmagick::COMPOSITE_COPYCYAN - (int) - - - - Copia el cian desde la fuente hacia la imagen de destino - - - - - - Gmagick::COMPOSITE_COPYGREEN - (int) - - - - Copia el verde desde la fuente hacia la imagen de destino - - - - - - Gmagick::COMPOSITE_COPYMAGENTA - (int) - - - - Copia el magenta desde la fuente hacia la imagen de destino - - - - - - Gmagick::COMPOSITE_COPYOPACITY - (int) - - - - Copia la opacidad desde la fuente hacia la imagen de destino - - - - - - Gmagick::COMPOSITE_COPYRED - (int) - - - - Copia el rojo desde la fuente hacia la imagen de destino - - - - - - Gmagick::COMPOSITE_COPYYELLOW - (int) - - - - Copia el amarillo desde la fuente hacia la imagen de destino - - - - - - Gmagick::COMPOSITE_DARKEN - (int) - - - - Oscurece la imagen de destino - - - - - - Gmagick::COMPOSITE_DSTATOP - (int) - - - - La parte de la imagen de destino que está dentro de la fuente - se compone sobre la fuente y reemplaza la imagen de destino - - - - - - Gmagick::COMPOSITE_DST - (int) - - - - La imagen de destino se conserva sin modificación - - - - - - Gmagick::COMPOSITE_DSTIN - (int) - - - - La parte de la fuente reemplaza la imagen de destino - - - - - - Gmagick::COMPOSITE_DSTOUT - (int) - - - - La parte fuera de la fuente reemplaza la imagen de destino - - - - - - Gmagick::COMPOSITE_DSTOVER - (int) - - - - La imagen de destino reemplaza la fuente - - - - - - Gmagick::COMPOSITE_DIFFERENCE - (int) - - - - Resta el color más oscuro de los dos colores elementales del más claro - - - - - - Gmagick::COMPOSITE_DISPLACE - (int) - - - - Desplaza los píxeles de la imagen de destino según lo definido por la fuente - - - - - - Gmagick::COMPOSITE_DISSOLVE - (int) - - - - Disuelve la fuente en la imagen de destino - - - - - - Gmagick::COMPOSITE_EXCLUSION - (int) - - - - Produce un efecto similar a Gmagick::COMPOSITE_DIFFERENCE, - pero aparece con un contraste más bajo - - - - - - Gmagick::COMPOSITE_HARDLIGHT - (int) - - - - Multiplica o superpone los colores, dependiendo del valor de color de la fuente - - - - - - Gmagick::COMPOSITE_HUE - (int) - - - - Modifica el tono de la imagen de destino según lo definido por la fuente - - - - - - Gmagick::COMPOSITE_IN - (int) - - - - Realiza una composición de la fuente en la imagen de destino - - - - - - Gmagick::COMPOSITE_LIGHTEN - (int) - - - - Aclara la imagen de destino según lo definido por la fuente - - - - - - Gmagick::COMPOSITE_LUMINIZE - (int) - - - - Ilumina la imagen de destino según lo definido por la fuente - - - - - - Gmagick::COMPOSITE_MINUS - (int) - - - - Resta la fuente de la imagen de destino - - - - - - Gmagick::COMPOSITE_MODULATE - (int) - - - - Modula la luminosidad, saturación y tono de la imagen de destino según lo definido - por la fuente - - - - - - Gmagick::COMPOSITE_MULTIPLY - (int) - - - - Multiplica la imagen de destino por la fuente - - - - - - Gmagick::COMPOSITE_OUT - (int) - - - - Realiza una composición de las partes exteriores de la - fuente sobre la imagen de destino - - - - - - Gmagick::COMPOSITE_OVER - (int) - - - - Realiza una composición sobre la imagen de destino - - - - - - Gmagick::COMPOSITE_OVERLAY - (int) - - - - Superpone la fuente sobre la imagen de destino - - - - - - Gmagick::COMPOSITE_PLUS - (int) - - - - Añade la fuente a la imagen de destino - - - - - - Gmagick::COMPOSITE_REPLACE - (int) - - - - Reemplaza la imagen de destino por la fuente - - - - - - Gmagick::COMPOSITE_SATURATE - (int) - - - - Satura la imagen de destino según lo definido por la fuente - - - - - - Gmagick::COMPOSITE_SCREEN - (int) - - - - La fuente y la imagen de destino son complementadas, luego multiplicadas, luego - reemplazan la imagen de destino - - - - - - Gmagick::COMPOSITE_SOFTLIGHT - (int) - - - - Oscurece o aclara los colores, siguiendo la fuente - - - - - - Gmagick::COMPOSITE_SRCATOP - (int) - - - - La parte de la fuente que se encuentra dentro de la imagen de destino se compone - sobre la imagen de destino - - - - - - Gmagick::COMPOSITE_SRC - (int) - - - - La fuente se copia hacia la imagen de destino - - - - - - Gmagick::COMPOSITE_SRCIN - (int) - - - - La parte de la fuente que se encuentra dentro de la imagen de destino reemplaza la imagen de destino - - - - - - Gmagick::COMPOSITE_SRCOUT - (int) - - - - La parte de la fuente que se encuentra fuera de la imagen de destino reemplaza la imagen de destino - - - - - - Gmagick::COMPOSITE_SRCOVER - (int) - - - - La fuente reemplaza la imagen de destino - - - - - - Gmagick::COMPOSITE_SUBTRACT - (int) - - - - Resta los colores de la imagen fuente en la imagen de destino - - - - - - Gmagick::COMPOSITE_THRESHOLD - (int) - - - - La fuente se compone de la imagen de destino, según lo definido por la fuente - - - - - - Gmagick::COMPOSITE_XOR - (int) - - - - La parte de la fuente que se encuentra fuera de la imagen de destino se - combina con la parte de la imagen de destino que se encuentra fuera de la fuente - - - - - - Constantes de modo de montaje - - - Gmagick::MONTAGEMODE_FRAME - (int) - - - - - - - - - - Gmagick::MONTAGEMODE_UNFRAME - (int) - - - - - - - - - - Gmagick::MONTAGEMODE_CONCATENATE - (int) - - - - - - - - - - Constantes de estilo - - - Gmagick::STYLE_NORMAL - (int) - - - - - - - - - - Gmagick::STYLE_ITALIC - (int) - - - - - - - - - - Gmagick::STYLE_OBLIQUE - (int) - - - - - - - - - - Gmagick::STYLE_ANY - (int) - - - - - - - - - - Constantes de filtro - - - Gmagick::FILTER_UNDEFINED - (int) - - - - - - - - - - Gmagick::FILTER_POINT - (int) - - - - - - - - - - Gmagick::FILTER_BOX - (int) - - - - - - - - - - Gmagick::FILTER_TRIANGLE - (int) - - - - - - - - - - Gmagick::FILTER_HERMITE - (int) - - - - - - - - - - Gmagick::FILTER_HANNING - (int) - - - - - - - - - - Gmagick::FILTER_HAMMING - (int) - - - - - - - - - - Gmagick::FILTER_BLACKMAN - (int) - - - - - - - - - - Gmagick::FILTER_GAUSSIAN - (int) - - - - - - - - - - Gmagick::FILTER_QUADRATIC - (int) - - - - - - - - - - Gmagick::FILTER_CUBIC - (int) - - - - - - - - - - Gmagick::FILTER_CATROM - (int) - - - - - - - - - - Gmagick::FILTER_MITCHELL - (int) - - - - - - - - - - Gmagick::FILTER_LANCZOS - (int) - - - - - - - - - - Gmagick::FILTER_BESSEL - (int) - - - - - - - - - - Gmagick::FILTER_SINC - (int) - - - - - - - - - - Constantes de tipo de imagen - - - Gmagick::IMGTYPE_UNDEFINED - (int) - - - - - - - - - - Gmagick::IMGTYPE_BILEVEL - (int) - - - - - - - - - - Gmagick::IMGTYPE_GRAYSCALE - (int) - - - - - - - - - - Gmagick::IMGTYPE_GRAYSCALEMATTE - (int) - - - - - - - - - - Gmagick::IMGTYPE_PALETTE - (int) - - - - - - - - - - Gmagick::IMGTYPE_PALETTEMATTE - (int) - - - - - - - - - - Gmagick::IMGTYPE_TRUECOLOR - (int) - - - - - - - - - - Gmagick::IMGTYPE_TRUECOLORMATTE - (int) - - - - - - - - - - Gmagick::IMGTYPE_COLORSEPARATION - (int) - - - - - - - - - - Gmagick::IMGTYPE_COLORSEPARATIONMATTE - (int) - - - - - - - - - - Gmagick::IMGTYPE_OPTIMIZE - (int) - - - - - - - - - - Constantes de resolución - - - Gmagick::RESOLUTION_UNDEFINED - (int) - - - - - - - - - - Gmagick::RESOLUTION_PIXELSPERINCH - (int) - - - - - - - - - - Gmagick::RESOLUTION_PIXELSPERCENTIMETER - (int) - - - - - - - - - - Constantes de compresión - - - Gmagick::COMPRESSION_UNDEFINED - (int) - - - - - - - - - - Gmagick::COMPRESSION_NO - (int) - - - - - - - - - - Gmagick::COMPRESSION_BZIP - (int) - - - - - - - - - - Gmagick::COMPRESSION_FAX - (int) - - - - - - - - - - Gmagick::COMPRESSION_GROUP4 - (int) - - - - - - - - - - Gmagick::COMPRESSION_JPEG - (int) - - - - - - - - - - Gmagick::COMPRESSION_JPEG2000 - (int) - - - - - - - - - - Gmagick::COMPRESSION_LOSSLESSJPEG - (int) - - - - - - - - - - Gmagick::COMPRESSION_LZW - (int) - - - - - - - - - - Gmagick::COMPRESSION_RLE - (int) - - - - - - - - - - Gmagick::COMPRESSION_ZIP - (int) - - - - - - - - - - Constantes de dibujo - - - Gmagick::PAINT_POINT - (int) - - - - - - - - - - Gmagick::PAINT_REPLACE - (int) - - - - - - - - - - Gmagick::PAINT_FLOODFILL - (int) - - - - - - - - - - Gmagick::PAINT_FILLTOBORDER - (int) - - - - - - - - - - Gmagick::PAINT_RESET - (int) - - - - - - - - - - Constantes de gravedad - - - Gmagick::GRAVITY_NORTHWEST - (int) - - - - - - - - - - Gmagick::GRAVITY_NORTH - (int) - - - - - - - - - - Gmagick::GRAVITY_NORTHEAST - (int) - - - - - - - - - - Gmagick::GRAVITY_WEST - (int) - - - - - - - - - - Gmagick::GRAVITY_CENTER - (int) - - - - - - - - - - Gmagick::GRAVITY_EAST - (int) - - - - - - - - - - Gmagick::GRAVITY_SOUTHWEST - (int) - - - - - - - - - - Gmagick::GRAVITY_SOUTH - (int) - - - - - - - - - - Gmagick::GRAVITY_SOUTHEAST - (int) - - - - - - - - - - Constantes de estiramiento - - - Gmagick::STRETCH_NORMAL - (int) - - - - - - - - - - Gmagick::STRETCH_ULTRACONDENSED - (int) - - - - - - - - - - Gmagick::STRETCH_CONDENSED - (int) - - - - - - - - - - Gmagick::STRETCH_SEMICONDENSED - (int) - - - - - - - - - - Gmagick::STRETCH_SEMIEXPANDED - (int) - - - - - - - - - - Gmagick::STRETCH_EXPANDED - (int) - - - - - - - - - - Gmagick::STRETCH_EXTRAEXPANDED - (int) - - - - - - - - - - Gmagick::STRETCH_ULTRAEXPANDED - (int) - - - - - - - - - - Gmagick::STRETCH_ANY - (int) - - - - - - - - - - Constantes de alineación - - - Gmagick::ALIGN_UNDEFINED - (int) - - - - - - - - - - Gmagick::ALIGN_LEFT - (int) - - - - - - - - - - Gmagick::ALIGN_CENTER - (int) - - - - - - - - - - Gmagick::ALIGN_RIGHT - (int) - - - - - - - - - - Constantes de decoración - - - Gmagick::DECORATION_NO - (int) - - - - - - - - - - Gmagick::DECORATION_UNDERLINE - (int) - - - - - - - - - - Gmagick::DECORATION_OVERLINE - (int) - - - - - - - - - - Gmagick::DECORATION_LINETROUGH - (int) - - - - - - - - - - Constantes de ruido - - - Gmagick::NOISE_UNIFORM - (int) - - - - - - - - - - Gmagick::NOISE_GAUSSIAN - (int) - - - - - - - - - - Gmagick::NOISE_MULTIPLICATIVEGAUSSIAN - (int) - - - - - - - - - - Gmagick::NOISE_IMPULSE - (int) - - - - - - - - - - Gmagick::NOISE_LAPLACIAN - (int) - - - - - - - - - - Gmagick::NOISE_POISSON - (int) - - - - - - - - - - Constantes de canal - - - Gmagick::CHANNEL_UNDEFINED - (int) - - - - - - - - - - Gmagick::CHANNEL_RED - (int) - - - - - - - - - - Gmagick::CHANNEL_GRAY - (int) - - - - - - - - - - Gmagick::CHANNEL_CYAN - (int) - - - - - - - - - - Gmagick::CHANNEL_GREEN - (int) - - - - - - - - - - Gmagick::CHANNEL_MAGENTA - (int) - - - - - - - - - - Gmagick::CHANNEL_BLUE - (int) - - - - - - - - - - Gmagick::CHANNEL_YELLOW - (int) - - - - - - - - - - Gmagick::CHANNEL_ALPHA - (int) - - - - - - - - - - Gmagick::CHANNEL_OPACITY - (int) - - - - - - - - - - Gmagick::CHANNEL_MATTE - (int) - - - - - - - - - - Gmagick::CHANNEL_BLACK - (int) - - - - - - - - - - Gmagick::CHANNEL_INDEX - (int) - - - - - - - - - - Gmagick::CHANNEL_ALL - (int) - - - - - - - - - - Constantes de medida - - - Gmagick::METRIC_UNDEFINED - (int) - - - - - - - - - - Gmagick::METRIC_MEANABSOLUTEERROR - (int) - - - - - - - - - - Gmagick::METRIC_MEANSQUAREERROR - (int) - - - - - - - - - - Gmagick::METRIC_PEAKABSOLUTEERROR - (int) - - - - - - - - - - Gmagick::METRIC_PEAKSIGNALTONOISERATIO - (int) - - - - - - - - - - Gmagick::METRIC_ROOTMEANSQUAREDERROR - (int) - - - - - - - - - - Constantes de píxel - - - Gmagick::PIXEL_CHAR - (int) - - - - - - - - - - Gmagick::PIXEL_DOUBLE - (int) - - - - - - - - - - Gmagick::PIXEL_FLOAT - (int) - - - - - - - - - - Gmagick::PIXEL_INTEGER - (int) - - - - - - - - - - Gmagick::PIXEL_LONG - (int) - - - - - - - - - - Gmagick::PIXEL_QUANTUM - (int) - - - - - - - - - - Gmagick::PIXEL_SHORT - (int) - - - - - - - - - - Constantes de espacio de color - - - Gmagick::COLORSPACE_UNDEFINED - (int) - - - - - - - - - - Gmagick::COLORSPACE_RGB - (int) - - - - - - - - - - Gmagick::COLORSPACE_GRAY - (int) - - - - - - - - - - Gmagick::COLORSPACE_TRANSPARENT - (int) - - - - - - - - - - Gmagick::COLORSPACE_OHTA - (int) - - - - - - - - - - Gmagick::COLORSPACE_LAB - (int) - - - - - - - - - - Gmagick::COLORSPACE_XYZ - (int) - - - - - - - - - - Gmagick::COLORSPACE_YCBCR - (int) - - - - - - - - - - Gmagick::COLORSPACE_YCC - (int) - - - - - - - - - - Gmagick::COLORSPACE_YIQ - (int) - - - - - - - - - - Gmagick::COLORSPACE_YPBPR - (int) - - - - - - - - - - Gmagick::COLORSPACE_YUV - (int) - - - - - - - - - - Gmagick::COLORSPACE_CMYK - (int) - - - - - - - - - - Gmagick::COLORSPACE_SRGB - (int) - - - - - - - - - - Gmagick::COLORSPACE_HSB - (int) - - - - - - - - - - Gmagick::COLORSPACE_HSL - (int) - - - - - - - - - - Gmagick::COLORSPACE_HWB - (int) - - - - - - - - - - Gmagick::COLORSPACE_REC601LUMA - (int) - - - - - - - - - - Gmagick::COLORSPACE_REC709LUMA - (int) - - - - - - - - - - Gmagick::COLORSPACE_LOG - (int) - - - - - - - - - - Constantes de método para píxeles virtuales - - - Gmagick::VIRTUALPIXELMETHOD_UNDEFINED - (int) - - - - - - - - - - Gmagick::VIRTUALPIXELMETHOD_BACKGROUND - (int) - - - - - - - - - - Gmagick::VIRTUALPIXELMETHOD_CONSTANT - (int) - - - - - - - - - - Gmagick::VIRTUALPIXELMETHOD_EDGE - (int) - - - - - - - - - - Gmagick::VIRTUALPIXELMETHOD_MIRROR - (int) - - - - - - - - - - Gmagick::VIRTUALPIXELMETHOD_TILE - (int) - - - - - - - - - - Gmagick::VIRTUALPIXELMETHOD_TRANSPARENT - (int) - - - - - - - - - - Constantes de vista previa - - - Gmagick::PREVIEW_UNDEFINED - (int) - - - - - - - - - - Gmagick::PREVIEW_ROTATE - (int) - - - - - - - - - - Gmagick::PREVIEW_SHEAR - (int) - - - - - - - - - - Gmagick::PREVIEW_ROLL - (int) - - - - - - - - - - Gmagick::PREVIEW_HUE - (int) - - - - - - - - - - Gmagick::PREVIEW_SATURATION - (int) - - - - - - - - - - Gmagick::PREVIEW_BRIGHTNESS - (int) - - - - - - - - - - Gmagick::PREVIEW_GAMMA - (int) - - - - - - - - - - Gmagick::PREVIEW_SPIFF - (int) - - - - - - - - - - Gmagick::PREVIEW_DULL - (int) - - - - - - - - - - Gmagick::PREVIEW_GRAYSCALE - (int) - - - - - - - - - - Gmagick::PREVIEW_QUANTIZE - (int) - - - - - - - - - - Gmagick::PREVIEW_DESPECKLE - (int) - - - - - - - - - - Gmagick::PREVIEW_REDUCENOISE - (int) - - - - - - - - - - Gmagick::PREVIEW_ADDNOISE - (int) - - - - - - - - - - Gmagick::PREVIEW_SHARPEN - (int) - - - - - - - - - - Gmagick::PREVIEW_BLUR - (int) - - - - - - - - - - Gmagick::PREVIEW_THRESHOLD - (int) - - - - - - - - - - Gmagick::PREVIEW_EDGEDETECT - (int) - - - - - - - - - - Gmagick::PREVIEW_SPREAD - (int) - - - - - - - - - - Gmagick::PREVIEW_SOLARIZE - (int) - - - - - - - - - - Gmagick::PREVIEW_SHADE - (int) - - - - - - - - - - Gmagick::PREVIEW_RAISE - (int) - - - - - - - - - - Gmagick::PREVIEW_SEGMENT - (int) - - - - - - - - - - Gmagick::PREVIEW_SWIRL - (int) - - - - - - - - - - Gmagick::PREVIEW_IMPLODE - (int) - - - - - - - - - - Gmagick::PREVIEW_WAVE - (int) - - - - - - - - - - Gmagick::PREVIEW_OILPAINT - (int) - - - - - - - - - - Gmagick::PREVIEW_CHARCOALDRAWING - (int) - - - - - - - - - - Gmagick::PREVIEW_JPEG - (int) - - - - - - - - - - Constantes de renderizado - - - Gmagick::RENDERINGINTENT_UNDEFINED - (int) - - - - - - - - - - Gmagick::RENDERINGINTENT_SATURATION - (int) - - - - - - - - - - Gmagick::RENDERINGINTENT_PERCEPTUAL - (int) - - - - - - - - - - Gmagick::RENDERINGINTENT_ABSOLUTE - (int) - - - - - - - - - - Gmagick::RENDERINGINTENT_RELATIVE - (int) - - - - - - - - - - Constantes de regla de relleno - - - Gmagick::FILLRULE_UNDEFINED - (int) - - - - - - - - - - Gmagick::FILLRULE_EVENODD - (int) - - - - - - - - - - Gmagick::FILLRULE_NONZERO - (int) - - - - - - - - - - Constantes de unidad de ruta - - - Gmagick::PATHUNITS_UNDEFINED - (int) - - - - - - - - - - Gmagick::PATHUNITS_USERSPACE - (int) - - - - - - - - - - Gmagick::PATHUNITS_USERSPACEONUSE - (int) - - - - - - - - - - Gmagick::PATHUNITS_OBJECTBOUNDINGBOX - (int) - - - - - - - - - - Constantes de extremo de línea - - - Gmagick::LINECAP_UNDEFINED - (int) - - - - - - - - - - Gmagick::LINECAP_BUTT - (int) - - - - - - - - - - Gmagick::LINECAP_ROUND - (int) - - - - - - - - - - Gmagick::LINECAP_SQUARE - (int) - - - - - - - - - - Constantes de unión de líneas - - - Gmagick::LINEJOIN_UNDEFINED - (int) - - - - - - - - - - Gmagick::LINEJOIN_MITER - (int) - - - - - - - - - - Gmagick::LINEJOIN_ROUND - (int) - - - - - - - - - - Gmagick::LINEJOIN_BEVEL - (int) - - - - - - - - - - Constantes de tipo de recurso - - - Gmagick::RESOURCETYPE_UNDEFINED - (int) - - - - - - - - - - Gmagick::RESOURCETYPE_AREA - (int) - - - - - - - - - - Gmagick::RESOURCETYPE_DISK - (int) - - - - - - - - - - Gmagick::RESOURCETYPE_FILE - (int) - - - - - - - - - - Gmagick::RESOURCETYPE_MAP - (int) - - - - - - - - - - Gmagick::RESOURCETYPE_MEMORY - (int) - - - - - - - - - - Constantes de orientación - - - Gmagick::ORIENTATION_UNDEFINED - (int) - - - - - - - - - - Gmagick::ORIENTATION_TOPLEFT - (int) - - - - - - - - - - Gmagick::ORIENTATION_TOPRIGHT - (int) - - - - - - - - - - Gmagick::ORIENTATION_BOTTOMRIGHT - (int) - - - - - - - - - - Gmagick::ORIENTATION_BOTTOMLEFT - (int) - - - - - - - - - - Gmagick::ORIENTATION_LEFTTOP - (int) - - - - - - - - - - Gmagick::ORIENTATION_RIGHTTOP - (int) - - - - - - - - - - Gmagick::ORIENTATION_RIGHTBOTTOM - (int) - - - - - - - - - - Gmagick::ORIENTATION_LEFTBOTTOM - (int) - - - - - - - - - - Constantes de entrelazado - - - Gmagick::INTERLACE_UNDEFINED - (int) - - - - - - - - - - Gmagick::INTERLACE_NO - (int) - - - - - - - - - - Gmagick::INTERLACE_NONE - (int) - - - - - - - - - - Gmagick::INTERLACE_LINE - (int) - - - - - - - - - - Gmagick::INTERLACE_PLANE - (int) - - - - - - - - - - Gmagick::INTERLACE_PARTITION - (int) - - - - - - - - - - - diff --git a/reference/gmagick/examples.xml b/reference/gmagick/examples.xml deleted file mode 100644 index 5b3574431f..0000000000 --- a/reference/gmagick/examples.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - &reftitle.examples; - - A continuación se muestran algunas operaciones comunes con Gmagick. - - - Ejemplo de Gmagick - -thumbnailimage(100, 0); - -// Crea un borde alrededor de la imagen, luego simula cómo se renderizará la imagen -// después de un renderizado a pintura al óleo. -// Observe el encadenamiento de métodos soportado por Gmagick -$image->borderimage("yellow", 8, 8)->oilpaintimage(0.3); - -// Escribe la imagen actual en un fichero -$image->write('example_thumbnail.jpg'); -?> -]]> - - - - diff --git a/reference/gmagick/gmagick.xml b/reference/gmagick/gmagick.xml deleted file mode 100644 index 6be6d1e681..0000000000 --- a/reference/gmagick/gmagick.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - La clase Gmagick - Gmagick - - - - -
- &reftitle.intro; - - -
- - -
- &reftitle.classsynopsis; - - - - Gmagick - - - - - Gmagick - - - - &Methods; - - - - - - - - - -
-
- - &reference.gmagick.entities.gmagick; - -
- diff --git a/reference/gmagick/gmagick/addimage.xml b/reference/gmagick/gmagick/addimage.xml deleted file mode 100644 index e7444da9ea..0000000000 --- a/reference/gmagick/gmagick/addimage.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - Gmagick::addimage - Añade una nueva imagen a la lista de imágenes del objeto Gmagick - - - - &reftitle.description; - - public GmagickGmagick::addimage - Gmagicksource - - - Añade una nueva imagen al objeto Gmagick desde la posición actual del objeto de origen. - Después de la operación la posición del iterador se mueve al final de la lista. - - - - - &reftitle.parameters; - - - source - - - El objeto Gmagick de origen - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick con la imagen añadida - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/addnoiseimage.xml b/reference/gmagick/gmagick/addnoiseimage.xml deleted file mode 100644 index a8fc895f18..0000000000 --- a/reference/gmagick/gmagick/addnoiseimage.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - Gmagick::addnoiseimage - Añade ruido aleatorio a la imagen - - - - &reftitle.description; - - public GmagickGmagick::addnoiseimage - intnoise_type - - - Añade ruido aleatorio a la imagen. - - - - - &reftitle.parameters; - - - noise_type - - - El tipo de ruido. Consulte esta lista de constantes de ruido. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick con el ruido añadido. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/annotateimage.xml b/reference/gmagick/gmagick/annotateimage.xml deleted file mode 100644 index 0e271b72ab..0000000000 --- a/reference/gmagick/gmagick/annotateimage.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Gmagick::annotateimage - Anota una imagen con texto - - - - &reftitle.description; - - public GmagickGmagick::annotateimage - GmagickDrawGmagickDraw - floatx - floaty - floatangle - stringtext - - - Anota una imagen con texto. - - - - - &reftitle.parameters; - - - GmagickDraw - - - El objeto GmagickDraw que contiene la configuración para dibujar el texto - - - - - x - - - El índice horizontal en píxeles a la izquierda del texto. - - - - - y - - - El índice vertical en píxeles a la línea base del texto. - - - - - angle - - - El ángulo en el que escribir el texto. - - - - - text - - - La cadena a dibujar. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick con la anotación hecha. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/blurimage.xml b/reference/gmagick/gmagick/blurimage.xml deleted file mode 100644 index 5b1d7426bd..0000000000 --- a/reference/gmagick/gmagick/blurimage.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - Gmagick::blurimage - Añade un filtro de borrosidad a la imagen - - - - &reftitle.description; - - public GmagickGmagick::blurimage - floatradius - floatsigma - intchannel - - - Añade un filtro de borrosidad a la imagen. - - - - - &reftitle.parameters; - - - radius - - - Radio de borrosidad - - - - - sigma - - - Desviación estándar - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick borroso - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/borderimage.xml b/reference/gmagick/gmagick/borderimage.xml deleted file mode 100644 index 7d100cfe17..0000000000 --- a/reference/gmagick/gmagick/borderimage.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Gmagick::borderimage - Rodea la imagen con un borde - - - - &reftitle.description; - - public GmagickGmagick::borderimage - GmagickPixelcolor - intwidth - intheight - - - Rodea la imagen con un borde del color definido por el objeto GmagickPixel de color de borde o - por una cadena de color. - - - - - &reftitle.parameters; - - - color - - - El objeto GmagickPixel o una cadena que contiene el color del borde - - - - - width - - - Ancho del borode. - - - - - height - - - Alto del borde. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick con el borde definido - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/charcoalimage.xml b/reference/gmagick/gmagick/charcoalimage.xml deleted file mode 100644 index 39b85fb7cf..0000000000 --- a/reference/gmagick/gmagick/charcoalimage.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - Gmagick::charcoalimage - Simula un dibujo a carboncillo - - - - &reftitle.description; - - public GmagickGmagick::charcoalimage - floatradius - floatsigma - - - Simula un dibujo a carboncillo. - - - - - &reftitle.parameters; - - - radius - - - El radio gaussiano, en píxeles, sin contar el píxel central. - - - - - sigma - - - La desviación estándar gaussiana, en píxeles. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick con la simulación de carboncillo - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/chopimage.xml b/reference/gmagick/gmagick/chopimage.xml deleted file mode 100644 index a1f4269b0b..0000000000 --- a/reference/gmagick/gmagick/chopimage.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - Gmagick::chopimage - Elimina una región de una imagen y la recorta - - - - &reftitle.description; - - public GmagickGmagick::chopimage - intwidth - intheight - intx - inty - - - Elimina una región de una imagen y colapsa la imagen para ocupar la porción eliminada. - - - - - &reftitle.parameters; - - - width - - - Ancho del área recortada. - - - - - height - - - Alto del área recortada. - - - - - x - - - Origen X del área recortada. - - - - - y - - - Origen Y del área recortada. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick recortado. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/clear.xml b/reference/gmagick/gmagick/clear.xml deleted file mode 100644 index f36a1fd68d..0000000000 --- a/reference/gmagick/gmagick/clear.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - Gmagick::clear - Limpia todos los recursos asociados con el objeto Gmagick - - - - &reftitle.description; - - public GmagickGmagick::clear - - - - Limpia todos los recursos asociados al objeto Gmagick. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El objeto Gmagick limpiado. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/commentimage.xml b/reference/gmagick/gmagick/commentimage.xml deleted file mode 100644 index 9b5ec34b0a..0000000000 --- a/reference/gmagick/gmagick/commentimage.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - Gmagick::commentimage - Añade un comentario a una imagen - - - - &reftitle.description; - - public GmagickGmagick::commentimage - stringcomment - - - Añade un comentario a una imagen. - - - - - &reftitle.parameters; - - - comment - - - El comentario a añadir. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick con el comentario añadido. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/compositeimage.xml b/reference/gmagick/gmagick/compositeimage.xml deleted file mode 100644 index b33de51a2a..0000000000 --- a/reference/gmagick/gmagick/compositeimage.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - Gmagick::compositeimage - Compone una imagen en otra - - - - &reftitle.description; - - public GmagickGmagick::compositeimage - Gmagicksource - intCOMPOSE - intx - inty - - - Compone una imagen en otra en el índice especificado. - - - - - - &reftitle.parameters; - - - source - - - Objeto Gmagick que contiene la imagen compuesta - - - - - COMPOSE - - - Operador de composción. - - - - - x - - - El índice de columna de la imagen compuesta. - - - - - y - - - El índice de fila de la imagen compuesta. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick con composiciones. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/construct.xml b/reference/gmagick/gmagick/construct.xml deleted file mode 100644 index 91851f93e1..0000000000 --- a/reference/gmagick/gmagick/construct.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - Gmagick::__construct - El constructor Gmagick - - - - &reftitle.description; - - public Gmagick::__construct - stringfilename - - - El constructor Gmagick - - - - - - &reftitle.parameters; - - - filename - - - La ruta a una imagen para cargar o una matriz de rutas. - - - - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/cropimage.xml b/reference/gmagick/gmagick/cropimage.xml deleted file mode 100644 index f2347371a2..0000000000 --- a/reference/gmagick/gmagick/cropimage.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - Gmagick::cropimage - Extrae una región de la imagen - - - - &reftitle.description; - - public GmagickGmagick::cropimage - - int - width - - - int - height - - intx - inty - - - Extrae una región de la imagen. - - - - - - - &reftitle.parameters; - - - - - width - - - - El ancho del recorte. - - - - - - height - - - - El alto del recorte. - - - - - x - - - La coordenada X de la esquina superior izquierda de la región recortada. - - - - - y - - - La coordenada Y de la esquina superior izquierda de la región recortada. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick recortado - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/cropthumbnailimage.xml b/reference/gmagick/gmagick/cropthumbnailimage.xml deleted file mode 100644 index e304de48c7..0000000000 --- a/reference/gmagick/gmagick/cropthumbnailimage.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Gmagick::cropthumbnailimage - Crea una miniatura recortada - - - - &reftitle.description; - - public GmagickGmagick::cropthumbnailimage - intwidth - intheight - - - Crea una miniatura de tamaño fijo ampliando o reduciendo de escala la imagen y recortando - un área específica desde el centro. - - - - - &reftitle.parameters; - - - width - - - El ancho de la miniatura. - - - - - height - - - El alto de la miniatura. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick recortado. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/current.xml b/reference/gmagick/gmagick/current.xml deleted file mode 100644 index 57fff8d0b5..0000000000 --- a/reference/gmagick/gmagick/current.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - Gmagick::current - Devuelve la refencia al objeto Gmagick acutal - - - - &reftitle.description; - - public GmagickGmagick::current - - - - Devuelve la refencia al objeto Gmagick acutal con el puntero de imagen apuntando a la secuencia correcta. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Se devuelve a sí mismo si se tuvo éxito. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/cyclecolormapimage.xml b/reference/gmagick/gmagick/cyclecolormapimage.xml deleted file mode 100644 index 38e26ebd96..0000000000 --- a/reference/gmagick/gmagick/cyclecolormapimage.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - Gmagick::cyclecolormapimage - Desplaza un mapa de color de una imagen - - - - &reftitle.description; - - public GmagickGmagick::cyclecolormapimage - intdisplace - - - Desplaza un mapa de color de una imagen por el número de posiciones dado. Si se - realiza un ciclo del mapa de colores varias veces se puede obtener un efecto - psicodélico. - - - - - - &reftitle.parameters; - - - displace - - - La cantidad a desplazar el mapa de color. - - - - - - - - &reftitle.returnvalues; - - Se devuelve a sí mismo si se tuvo éxito. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/deconstructimages.xml b/reference/gmagick/gmagick/deconstructimages.xml deleted file mode 100644 index 02f63215db..0000000000 --- a/reference/gmagick/gmagick/deconstructimages.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - Gmagick::deconstructimages - Devuelve ciertas diferencias de píxeles entre imágenes - - - - &reftitle.description; - - public GmagickGmagick::deconstructimages - - - - Compara cada imagen con la siguiente en una secuencia y devuelve la región circundante máxima de cualquier diferencia de píxeles que se descubra. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un nuevo objeto Gmagick en caso de éxito. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/despeckleimage.xml b/reference/gmagick/gmagick/despeckleimage.xml deleted file mode 100644 index 8bef9bef75..0000000000 --- a/reference/gmagick/gmagick/despeckleimage.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - Gmagick::despeckleimage - Reduce el ruido granular de una imagen - - - - &reftitle.description; - - public GmagickGmagick::despeckleimage - - - - Reduce el ruido granular de una imagen mientras preserva los bordes de la imagen original. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El objeto Gmagick con el ruido granular reducido si se tuvo éxito. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - &reftitle.examples; - - Ejemplo de <methodname>Gmagick::despeckleimage</methodname> - - -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/gmagick/gmagick/destroy.xml b/reference/gmagick/gmagick/destroy.xml deleted file mode 100644 index 66d6cd738b..0000000000 --- a/reference/gmagick/gmagick/destroy.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - Gmagick::destroy - Destruye un objeto Gmagick - - - - &reftitle.description; - - public boolGmagick::destroy - - - - Destruye un objeto Gmagick y libera todos los recursos asociados con él - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/drawimage.xml b/reference/gmagick/gmagick/drawimage.xml deleted file mode 100644 index d9f91d33ba..0000000000 --- a/reference/gmagick/gmagick/drawimage.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - Gmagick::drawimage - Renderiza el objeto GmagickDraw en la imagen actual - - - - &reftitle.description; - - public GmagickGmagick::drawimage - GmagickDrawGmagickDraw - - - Renderiza el objeto GmagickDraw en la imagen actual - - - - - - - &reftitle.parameters; - - - GmagickDraw - - - Las operaciones de dibujo para renderizar sobre la imagen. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick dibujado - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/edgeimage.xml b/reference/gmagick/gmagick/edgeimage.xml deleted file mode 100644 index 158c251cc5..0000000000 --- a/reference/gmagick/gmagick/edgeimage.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - Gmagick::edgeimage - Mejora los bordes dentro de una imagen - - - - &reftitle.description; - - public GmagickGmagick::edgeimage - floatradius - - - Mejora los bordes dentro de una imagen con un filtro de convolución del radio dado. - Use un radio de 0 y éste será seleccionado automáticamente. - - - - - - - &reftitle.parameters; - - - radius - - - El radio de la operación. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick con los bordes mejorados. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/embossimage.xml b/reference/gmagick/gmagick/embossimage.xml deleted file mode 100644 index 927bc4f9d5..0000000000 --- a/reference/gmagick/gmagick/embossimage.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Gmagick::embossimage - Devuelve una imagen en escala de grises con un efecto tridimensional - - - - &reftitle.description; - - public GmagickGmagick::embossimage - floatradius - floatsigma - - - Devuelve una imagen en escala de grises con un efecto tridimensional. Se convoluciona - la imagen con un operador gaussiano del radio y desviación estándar (sigma) dados. - Para obtener resultados razonables, el radio debería ser mayor que - sigma. Use un radio de 0 y se elegirá un radio apropiado automáticamente. - - - - - - - &reftitle.parameters; - - - radius - - - El radio del efecto. - - - - - sigma - - - El valor sigma del efecto. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick "repujado". - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/enhanceimage.xml b/reference/gmagick/gmagick/enhanceimage.xml deleted file mode 100644 index 44c3be0b2e..0000000000 --- a/reference/gmagick/gmagick/enhanceimage.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - Gmagick::enhanceimage - Mejora la calidad de una imagen con ruido - - - - &reftitle.description; - - public GmagickGmagick::enhanceimage - - - - Aplica un filtro digital que mejora la calidad de una imagen con ruido. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El objeto Gmagick mejorado. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - - diff --git a/reference/gmagick/gmagick/equalizeimage.xml b/reference/gmagick/gmagick/equalizeimage.xml deleted file mode 100644 index b3fc009993..0000000000 --- a/reference/gmagick/gmagick/equalizeimage.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - Gmagick::equalizeimage - Ecualiza el histograma de la imagen - - - - &reftitle.description; - - public GmagickGmagick::equalizeimage - - - - Ecualiza el histograma de la imagen. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El objeto Gmagick ecualizado. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/flipimage.xml b/reference/gmagick/gmagick/flipimage.xml deleted file mode 100644 index 31a647a891..0000000000 --- a/reference/gmagick/gmagick/flipimage.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - Gmagick::flipimage - Crea una imagen espejo vertical - - - - &reftitle.description; - - public GmagickGmagick::flipimage - - - - Crea una imagen espejo vertical reflejando los píxeles alrededor del eje x central. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El objeto Gmagick volteado. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - &reftitle.seealso; - - Gmagick::flopimage - - - - - diff --git a/reference/gmagick/gmagick/flopimage.xml b/reference/gmagick/gmagick/flopimage.xml deleted file mode 100644 index cd6b75cac2..0000000000 --- a/reference/gmagick/gmagick/flopimage.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - Gmagick::flopimage - Crea una imagen espejo horizontal - - - - &reftitle.description; - - public GmagickGmagick::flopimage - - - - Crea una imagen espejo horizontal reflejando los píxeles alrededor del eje y central. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El objeto Gmagick volteado. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - &reftitle.seealso; - - Gmagick::flipimage - - - - - diff --git a/reference/gmagick/gmagick/frameimage.xml b/reference/gmagick/gmagick/frameimage.xml deleted file mode 100644 index 2018f4c4f7..0000000000 --- a/reference/gmagick/gmagick/frameimage.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - Gmagick::frameimage - Añade un borde tridimensional simulado - - - - &reftitle.description; - - public GmagickGmagick::frameimage - GmagickPixelcolor - intwidth - intheight - intinner_bevel - intouter_bevel - - - Añade un borde tridimensional simulado alrededor de la imagen. - El ancho y alto especifican el ancho del borde de las caras verticales y - horizontales del marco. Los biseles interior y exterior - indican el ancho de las sombras interiores y exteriores del - marco. - - - - - - &reftitle.parameters; - - - color - - - Objeto GmagickPixel o un valor de tipo float que representa el color mate - - - - - width - - - El ancho del borde. - - - - - height - - - El alto del borde. - - - - - inner_bevel - - - El ancho del bisel interior. - - - - - outer_bevel - - - El ancho del bisel exterior. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick enmarcado. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/gammaimage.xml b/reference/gmagick/gmagick/gammaimage.xml deleted file mode 100644 index 4f83c6a7b7..0000000000 --- a/reference/gmagick/gmagick/gammaimage.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Gmagick::gammaimage - Corrección gamma de una imagen - - - - &reftitle.description; - - public GmagickGmagick::gammaimage - floatgamma - - - Corrección gamma de una imagen. La misma imagen vista en diferentes dispositivos tendrá - diferencias perceptuales en la manera en que la intensidad de la imagen esté representada - en la pantalla. Especifique niveles gamma indivuduales para los canales rojo, - verde y azul, o ajústelos todos con el parámetro gamma. - El rango de valores es típicamente desde 0.8 a 2.3. - - - - - - &reftitle.parameters; - - - gamma - - - La cantidad de corrección gamma. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick con el valor gamma corregido. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getcopyright.xml b/reference/gmagick/gmagick/getcopyright.xml deleted file mode 100644 index f8f8d2b2af..0000000000 --- a/reference/gmagick/gmagick/getcopyright.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - Gmagick::getcopyright - Devuelve el copyright de la API GraphicsMagick como una cadena - - - - &reftitle.description; - - public stringGmagick::getcopyright - - - - Devuelve el copyright de la API GraphicsMagick como una cadena. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una cadena que contiene el anuncio del copyright de la API GraphicsMagick y - de la API de C Magickwand. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getfilename.xml b/reference/gmagick/gmagick/getfilename.xml deleted file mode 100644 index 2c6b5953e1..0000000000 --- a/reference/gmagick/gmagick/getfilename.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - Gmagick::getfilename - El nombre de archivo asociado a una secuencia de imágenes - - - - &reftitle.description; - - public stringGmagick::getfilename - - - - Devuelve el nombre de archivo asociado a una secuencia de imágenes. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una cadena si se tuvo éxito. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagebackgroundcolor.xml b/reference/gmagick/gmagick/getimagebackgroundcolor.xml deleted file mode 100644 index 5f2b4bfb82..0000000000 --- a/reference/gmagick/gmagick/getimagebackgroundcolor.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - Gmagick::getimagebackgroundcolor - Devuelve el color de fondo de la imagen - - - - &reftitle.description; - - public GmagickPixelGmagick::getimagebackgroundcolor - - - - Devuelve el color de fondo de la imagen. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un objeto GmagickPixel establecido al color de fondo de la imagen. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimageblueprimary.xml b/reference/gmagick/gmagick/getimageblueprimary.xml deleted file mode 100644 index 7de88f5c49..0000000000 --- a/reference/gmagick/gmagick/getimageblueprimary.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Gmagick::getimageblueprimary - Devuelve el punto primario azul de la cromaticidad - - - - &reftitle.description; - - public arrayGmagick::getimageblueprimary - - - - Devuelve el punto primario azul de la cromaticidad de una imagen. - - - - - - - &reftitle.parameters; - - - x - - - El punto x primario azul de la cromaticidad. - - - - - y - - - El punto y primario azul de la cromaticidad. - - - - - - - - &reftitle.returnvalues; - - Matriz consistente en las coordenadas "x" e "y" del punto. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagebordercolor.xml b/reference/gmagick/gmagick/getimagebordercolor.xml deleted file mode 100644 index afdefa93ef..0000000000 --- a/reference/gmagick/gmagick/getimagebordercolor.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - Gmagick::getimagebordercolor - Devuelve el color del borde de la imagen - - - - &reftitle.description; - - public GmagickPixelGmagick::getimagebordercolor - - - - Devuelve el color del borde de la imagen. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Objeto GmagickPixel que representa el color del borde - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagechanneldepth.xml b/reference/gmagick/gmagick/getimagechanneldepth.xml deleted file mode 100644 index 08941325e6..0000000000 --- a/reference/gmagick/gmagick/getimagechanneldepth.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - Gmagick::getimagechanneldepth - Obtiene la profundidad de un canal de imagen en particular - - - - &reftitle.description; - - public intGmagick::getimagechanneldepth - intchannel_type - - - Obtiene la profundidad de un canal de imagen en particular. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La profundidad del canal de la imagen - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagecolors.xml b/reference/gmagick/gmagick/getimagecolors.xml deleted file mode 100644 index 8daedc6921..0000000000 --- a/reference/gmagick/gmagick/getimagecolors.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - Gmagick::getimagecolors - Devuelve el color del índice del mapa de color especificado - - - - &reftitle.description; - - public intGmagick::getimagecolors - - - - Devuelve el color del índice del mapa de color especificado. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El número de colores en la imagen. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagecolorspace.xml b/reference/gmagick/gmagick/getimagecolorspace.xml deleted file mode 100644 index 0580c811e0..0000000000 --- a/reference/gmagick/gmagick/getimagecolorspace.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - Gmagick::getimagecolorspace - Obtiene el espacio de colores de la imagen - - - - &reftitle.description; - - public intGmagick::getimagecolorspace - - - - Obtiene el espacio de colores de la imagen. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El espacio de colores - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagecompose.xml b/reference/gmagick/gmagick/getimagecompose.xml deleted file mode 100644 index 3e38cb0991..0000000000 --- a/reference/gmagick/gmagick/getimagecompose.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - Gmagick::getimagecompose - Devuelve el operador de composición asociado a la imagen - - - - &reftitle.description; - - public intGmagick::getimagecompose - - - - Devuelve el operador de composición asociado a la imagen. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el operador de composición asociado a la imagen. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagedelay.xml b/reference/gmagick/gmagick/getimagedelay.xml deleted file mode 100644 index 04b51421f0..0000000000 --- a/reference/gmagick/gmagick/getimagedelay.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - Gmagick::getimagedelay - Obetiene el retraso de la imagen - - - - &reftitle.description; - - public intGmagick::getimagedelay - - - - Obetiene el retraso de la imagen - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el operados de composción asociado con la imagen. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagedepth.xml b/reference/gmagick/gmagick/getimagedepth.xml deleted file mode 100644 index 917f72230f..0000000000 --- a/reference/gmagick/gmagick/getimagedepth.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - Gmagick::getimagedepth - Obtiene la profundidad de la imagen - - - - &reftitle.description; - - public intGmagick::getimagedepth - - - - Obtiene la profundidad de la imagen. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La profundidad de la imagen. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagedispose.xml b/reference/gmagick/gmagick/getimagedispose.xml deleted file mode 100644 index 5883d6e20b..0000000000 --- a/reference/gmagick/gmagick/getimagedispose.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - Gmagick::getimagedispose - Obtiene el método de disposición de la imagen - - - - &reftitle.description; - - public intGmagick::getimagedispose - - - - Obtiene el método de disposición de la imagen - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el método de disposición si se tuvo éxito. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimageextrema.xml b/reference/gmagick/gmagick/getimageextrema.xml deleted file mode 100644 index 9098bb3919..0000000000 --- a/reference/gmagick/gmagick/getimageextrema.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Gmagick::getimageextrema - Obtiene los extremos de la imagen - - - - &reftitle.description; - - public arrayGmagick::getimageextrema - - - - Devuelve una matriz asociativa con las claves "min" y "max". &gmagick.gmagickexception.throw; - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una matriz asociativa con las claves "min" y "max". - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagefilename.xml b/reference/gmagick/gmagick/getimagefilename.xml deleted file mode 100644 index 413bc9c97c..0000000000 --- a/reference/gmagick/gmagick/getimagefilename.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Gmagick::getimagefilename - Devuelve el nombre de archivo de una imagen en particular de una secuencia - - - - &reftitle.description; - - public stringGmagick::getimagefilename - - - - Devuelve el nombre de archivo de una imagen en particular de una secuencia - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una cadena con el nombre de archivo de la imagen - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimageformat.xml b/reference/gmagick/gmagick/getimageformat.xml deleted file mode 100644 index 4f1d6c9b46..0000000000 --- a/reference/gmagick/gmagick/getimageformat.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Gmagick::getimageformat - Devuelve el formato de una imagen en particular de una secuencia - - - - &reftitle.description; - - public stringGmagick::getimageformat - - - - Devuelve el formato de una imagen en particular de una secuencia. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una cadena que contiene el formato de imagen si se tuvo éxito. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagegamma.xml b/reference/gmagick/gmagick/getimagegamma.xml deleted file mode 100644 index 1359731235..0000000000 --- a/reference/gmagick/gmagick/getimagegamma.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - Gmagick::getimagegamma - Obtiene el valor gamma de la imagen - - - - &reftitle.description; - - public floatGmagick::getimagegamma - - - - Obtiene el valor gamma de la imagen - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el valor gamma de la imagen si se tuvo éxito - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/getimagegreenprimary.xml b/reference/gmagick/gmagick/getimagegreenprimary.xml deleted file mode 100644 index 6b55e034ec..0000000000 --- a/reference/gmagick/gmagick/getimagegreenprimary.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - Gmagick::getimagegreenprimary - Devuelve el punto primario verde de la cromaticidad - - - - &reftitle.description; - - public arrayGmagick::getimagegreenprimary - - - - Devuelve el punto primario verde de la cromaticidad. Devuelve una matriz con las claves "x" e "y". - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una matriz con las claves "x" e "y" si se tuvo éxito. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/getimageheight.xml b/reference/gmagick/gmagick/getimageheight.xml deleted file mode 100644 index b74fe44540..0000000000 --- a/reference/gmagick/gmagick/getimageheight.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Gmagick::getimageheight - Devuelve el alto de la imagen - - - - &reftitle.description; - - public intGmagick::getimageheight - - - - Devuelve el alto de la imagen - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el alto de la imagen en píxeles. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagehistogram.xml b/reference/gmagick/gmagick/getimagehistogram.xml deleted file mode 100644 index 6e25afca58..0000000000 --- a/reference/gmagick/gmagick/getimagehistogram.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Gmagick::getimagehistogram - Obtiene el histograma de la imagen - - - - &reftitle.description; - - public arrayGmagick::getimagehistogram - - - - Devuelve el histograma de la imagen como una matriz de objetos GmagickPixel. Lanza una - excepción de tipo GmagickException si se produjo un error. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el histograma de la imagen como una matriz de objetos GmagickPixel. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimageindex.xml b/reference/gmagick/gmagick/getimageindex.xml deleted file mode 100644 index e71dca105e..0000000000 --- a/reference/gmagick/gmagick/getimageindex.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - Gmagick::getimageindex - Obtiene el índice de la imagen activa actual - - - - &reftitle.description; - - public intGmagick::getimageindex - - - - Devuelve el índice de la imagen activa actual dentro del objeto Gmagick. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El índice de la imagen activa actual. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimageinterlacescheme.xml b/reference/gmagick/gmagick/getimageinterlacescheme.xml deleted file mode 100644 index eaf6faefee..0000000000 --- a/reference/gmagick/gmagick/getimageinterlacescheme.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Gmagick::getimageinterlacescheme - Obtiene la combinación de entrelazado de la imagen - - - - &reftitle.description; - - public intGmagick::getimageinterlacescheme - - - - Obtiene la combinación de entrelazado de la imagen. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la combinación de entrelazado como un integer si se tuvo éxito - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimageiterations.xml b/reference/gmagick/gmagick/getimageiterations.xml deleted file mode 100644 index d50476dc9d..0000000000 --- a/reference/gmagick/gmagick/getimageiterations.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - Gmagick::getimageiterations - Obtiene las iteraciones de la imagen - - - - &reftitle.description; - - public intGmagick::getimageiterations - - - - Obtiene las iteraciones de la imagen. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve las iteraciones de la imagen como un valor integer. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagematte.xml b/reference/gmagick/gmagick/getimagematte.xml deleted file mode 100644 index 39893673d4..0000000000 --- a/reference/gmagick/gmagick/getimagematte.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - Gmagick::getimagematte - Comprobar si la imagen tiene un canal mate - - - - &reftitle.description; - - public intGmagick::getimagematte - - - - Devuelve &true; si la imagen tiene un canal mate, si no, devuelve &false;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si la imagen tiene un canal mate, si no, devuelve &false;. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagemattecolor.xml b/reference/gmagick/gmagick/getimagemattecolor.xml deleted file mode 100644 index 433b3006bd..0000000000 --- a/reference/gmagick/gmagick/getimagemattecolor.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - Gmagick::getimagemattecolor - Devuelve el color mate de la imagen - - - - &reftitle.description; - - public GmagickPixelGmagick::getimagemattecolor - - - - Devuelve un objeto GmagickPixel si se tuvo éxtito. Lanza un excepción GmagickException si se produjo un error. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un objeto GmagickPixel si se tuvo éxito. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimageprofile.xml b/reference/gmagick/gmagick/getimageprofile.xml deleted file mode 100644 index 76f4985168..0000000000 --- a/reference/gmagick/gmagick/getimageprofile.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Gmagick::getimageprofile - Devuelve el perfil nominado de la imagen - - - - &reftitle.description; - - public stringGmagick::getimageprofile - stringname - - - Devuelve el perfil nominado de la imagen. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una cadena que contiene el perfil de la imagen. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimageredprimary.xml b/reference/gmagick/gmagick/getimageredprimary.xml deleted file mode 100644 index e82db41140..0000000000 --- a/reference/gmagick/gmagick/getimageredprimary.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Gmagick::getimageredprimary - Devuelve el punto primario rojo de la cromaticidad - - - - &reftitle.description; - - public arrayGmagick::getimageredprimary - - - - Devuelve el punto primario rojo de la cromaticidad como una matriz con las claves "x" e "y". - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el punto primario rojo de la cromaticidad como una matriz con las claves "x" e "y". - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagerenderingintent.xml b/reference/gmagick/gmagick/getimagerenderingintent.xml deleted file mode 100644 index 69e5c7e4f6..0000000000 --- a/reference/gmagick/gmagick/getimagerenderingintent.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - Gmagick::getimagerenderingintent - Obtiene la propuesta de renderización de la imagen - - - - &reftitle.description; - - public intGmagick::getimagerenderingintent - - - - Obtiene la propuesta de renderización de la imagen - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Extrae una región de la imagen y la devuelve como una nueva varita - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimageresolution.xml b/reference/gmagick/gmagick/getimageresolution.xml deleted file mode 100644 index e9e539f02b..0000000000 --- a/reference/gmagick/gmagick/getimageresolution.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Gmagick::getimageresolution - Obtiene la resolución X e Y de la imagen - - - - &reftitle.description; - - public arrayGmagick::getimageresolution - - - - Devuelve la resolución como una matriz. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la resolución como una matriz. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagescene.xml b/reference/gmagick/gmagick/getimagescene.xml deleted file mode 100644 index 11e5a59093..0000000000 --- a/reference/gmagick/gmagick/getimagescene.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Gmagick::getimagescene - Obtiene la escena de la imagen - - - - &reftitle.description; - - public intGmagick::getimagescene - - - - Obtiene la escena de la imagen. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la escena de la imagen. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagesignature.xml b/reference/gmagick/gmagick/getimagesignature.xml deleted file mode 100644 index 543f95f869..0000000000 --- a/reference/gmagick/gmagick/getimagesignature.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - Gmagick::getimagesignature - Genera un resumen de un mensaje SHA-256 - - - - &reftitle.description; - - public stringGmagick::getimagesignature - - - - Genera un resumen de un mensaje SHA-256 para el flujo de píxeles de la imagen. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una cadena que contiene el hash SHA-256 del archivo. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimagetype.xml b/reference/gmagick/gmagick/getimagetype.xml deleted file mode 100644 index d1a7f230de..0000000000 --- a/reference/gmagick/gmagick/getimagetype.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - Gmagick::getimagetype - Obtiene el tipo de imagen potencial - - - - &reftitle.description; - - public intGmagick::getimagetype - - - - Obtiene el tipo de imagen potencial. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el tipo de imagen potencial. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getimageunits.xml b/reference/gmagick/gmagick/getimageunits.xml deleted file mode 100644 index 5876cf7345..0000000000 --- a/reference/gmagick/gmagick/getimageunits.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Gmagick::getimageunits - Obtiene las unidades de resolución de la imagen - - - - &reftitle.description; - - public intGmagick::getimageunits - - - - Obtiene las unidades de resolución de la imagen. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve las unidades de resolución de la imagen. - - - - - - diff --git a/reference/gmagick/gmagick/getimagewhitepoint.xml b/reference/gmagick/gmagick/getimagewhitepoint.xml deleted file mode 100644 index 0dc4191f89..0000000000 --- a/reference/gmagick/gmagick/getimagewhitepoint.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - Gmagick::getimagewhitepoint - Devuelve el punto blanco de la cromaticidad - - - - &reftitle.description; - - public arrayGmagick::getimagewhitepoint - - - - Devuelve el punto blanco de la cromaticidad como una matriz asociativa con las claves "x" e "y". - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el punto blanco de la cromaticidad como una matriz asociativa con las claves "x" e "y". - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/getimagewidth.xml b/reference/gmagick/gmagick/getimagewidth.xml deleted file mode 100644 index 4dbb50a828..0000000000 --- a/reference/gmagick/gmagick/getimagewidth.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - Gmagick::getimagewidth - Devuelve el ancho de la imagen - - - - &reftitle.description; - - public intGmagick::getimagewidth - - - - Devuelve el ancho de la imagen. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el ancho de la imagen. - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getpackagename.xml b/reference/gmagick/gmagick/getpackagename.xml deleted file mode 100644 index de4ab91409..0000000000 --- a/reference/gmagick/gmagick/getpackagename.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - Gmagick::getpackagename - Devuelve el nombre del paquete de GraphicsMagick - - - - &reftitle.description; - - public stringGmagick::getpackagename - - - - Devuelve el nombre del paquete de GraphicsMagick. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el nombre del paquete de GraphicsMagick como una cadena. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getquantumdepth.xml b/reference/gmagick/gmagick/getquantumdepth.xml deleted file mode 100644 index 04c0b217b3..0000000000 --- a/reference/gmagick/gmagick/getquantumdepth.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - Gmagick::getquantumdepth - Obtiene la profundidad de la cuantía de Gmagick como una cadena - - - - &reftitle.description; - - public arrayGmagick::getquantumdepth - - - - Obtiene la profundidad de la cuantía de Gmagick como una cadena. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Obtiene la profundidad de la cuantía de Gmagick como una cadena. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getreleasedate.xml b/reference/gmagick/gmagick/getreleasedate.xml deleted file mode 100644 index d011499de4..0000000000 --- a/reference/gmagick/gmagick/getreleasedate.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - Gmagick::getreleasedate - Devuelve la fecha de distribución de GraphicsMagick como una cadena - - - - &reftitle.description; - - public stringGmagick::getreleasedate - - - - Devuelve la fecha de distribución de GraphicsMagick como una cadena. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la fecha de distribución de GraphicsMagick como una cadena. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/getsamplingfactors.xml b/reference/gmagick/gmagick/getsamplingfactors.xml deleted file mode 100644 index 3b77452262..0000000000 --- a/reference/gmagick/gmagick/getsamplingfactors.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Gmagick::getsamplingfactors - Obtiene el factor de muestreo horizontal y vertical - - - - &reftitle.description; - - public arrayGmagick::getsamplingfactors - - - - Obtiene el factor de muestreo horizontal y vertical. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una matriz asociativa con el factor de muestreo horizontal y vertical de la imagen. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getsize.xml b/reference/gmagick/gmagick/getsize.xml deleted file mode 100644 index 322b518fbc..0000000000 --- a/reference/gmagick/gmagick/getsize.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Gmagick::getsize - Devuelve el tamaño asociado con el objeto Gmagick - - - - &reftitle.description; - - public arrayGmagick::getsize - - - - Devuelve el tamaño asociado con el objeto Gmagick como una matriz con las - claves "columns" (columnas) y "rows" (filas). - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el tamaño asociado con el objeto Gmagick como una matriz con las - claves "columns" (columnas) y "rows" (filas). - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/getversion.xml b/reference/gmagick/gmagick/getversion.xml deleted file mode 100644 index a73de3271a..0000000000 --- a/reference/gmagick/gmagick/getversion.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Gmagick::getversion - Devuelve la versión de la API GraphicsMagick - - - - &reftitle.description; - - public arrayGmagick::getversion - - - - Devuelve la versión de la API GraphicsMagick como una cadena y como un número. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la versión de la API GraphicsMagick como una cadena y como un número. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/hasnextimage.xml b/reference/gmagick/gmagick/hasnextimage.xml deleted file mode 100644 index 9ceb85ef06..0000000000 --- a/reference/gmagick/gmagick/hasnextimage.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - Gmagick::hasnextimage - Comprueba si el objeto tiene más imágenes - - - - &reftitle.description; - - public mixedGmagick::hasnextimage - - - - Devuelve &true; si el objeto tiene más imágenes cuando se atraviesa la lista en dirección - hacia delante. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si el objeto tiene más imágenes cuando se atraviesa la lista en dirección - hacia delante, devuelve &false; si no hay ninguna. - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/haspreviousimage.xml b/reference/gmagick/gmagick/haspreviousimage.xml deleted file mode 100644 index 420cd4ba91..0000000000 --- a/reference/gmagick/gmagick/haspreviousimage.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - Gmagick::haspreviousimage - Verifica si el objeto tiene una imagen previa - - - - &reftitle.description; - - public mixedGmagick::haspreviousimage - - - - Devuelve &true; si el objeto tiene más imágenes cuando se atraviesa la lista en la dirección opuesta - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si el objeto tiene más imágenes cuando se atraviesa la lista en la - dirección opuesta, devuelve &false; si no hay ninguna. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/implodeimage.xml b/reference/gmagick/gmagick/implodeimage.xml deleted file mode 100644 index eb6c73fcbf..0000000000 --- a/reference/gmagick/gmagick/implodeimage.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - Gmagick::implodeimage - Crea una nueva imagen como una copia - - - - &reftitle.description; - - public mixedGmagick::implodeimage - floatradius - - - Crea una nueva imagen que es una copia de una existente con los píxeles de la imagen - "implosionados" por el porcentaje especificado. - - - - - - &reftitle.parameters; - - - radius - - - El radio de la implosión. - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto Gmagick implosionado. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/labelimage.xml b/reference/gmagick/gmagick/labelimage.xml deleted file mode 100644 index 1a681042f4..0000000000 --- a/reference/gmagick/gmagick/labelimage.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - Gmagick::labelimage - Añade una etiqueta a una imagen - - - - &reftitle.description; - - public mixedGmagick::labelimage - stringlabel - - - Añade una etiqueta a una imagen. - - - - - - &reftitle.parameters; - - - label - - - La etiqueta a añadir - - - - - - - - &reftitle.returnvalues; - - Objeto Gmagick con etiqueta. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/levelimage.xml b/reference/gmagick/gmagick/levelimage.xml deleted file mode 100644 index e64866e3a1..0000000000 --- a/reference/gmagick/gmagick/levelimage.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - Gmagick::levelimage - Ajusta los niveles de la imagen - - - - &reftitle.description; - - public mixedGmagick::levelimage - floatblackPoint - floatgamma - floatwhitePoint - intchannelGmagick::CHANNEL_DEFAULT - - - Ajusta los niveles de una imagen escalando la caída de los colores - entre los puntos blanco y negro especificados al rango completo de - cuantía disponible. Los parámetros proporcionados representan - los puntos negro, mitad, y blanco. El punto negro especifica - el color más oscuro de la imagen. Los colores más oscuros que el punto - negro se establecen a cero. El punto medio especifica una corrección - gamma a aplicar a la imagen. Mientras que el punto blanco especifica el - color más claro de la imagen. Los colores más claros que el punto - blanco se establecen al valor de cuantía máximo. - - - - - - &reftitle.parameters; - - - blackPoint - - - El punto negro de la imagen. - - - - - gamma - - - El valor gamma - - - - - whitePoint - - - El punto blanco de la imagen. - - - - - channel - - - Proporcione cualquier constante de canal que sea válida para su modo de canal. Para - aplicar más de un canal, combine las constantes channeltype usando - operadores a nivel de bits. Consulte esta lista de - constantes de canal. - - - - - - - - &reftitle.returnvalues; - - Objeto Gmagick con la imagen nivelada. - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/magnifyimage.xml b/reference/gmagick/gmagick/magnifyimage.xml deleted file mode 100644 index 4e5d424f0d..0000000000 --- a/reference/gmagick/gmagick/magnifyimage.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - Gmagick::magnifyimage - Redimensiona una imagen por 2 manteniendo las proporciones - - - - &reftitle.description; - - public mixedGmagick::magnifyimage - - - - Redimensiona una imagen por 2 manteniendo las proporciones. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El objeto Gmagick modificado. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/mapimage.xml b/reference/gmagick/gmagick/mapimage.xml deleted file mode 100644 index 8a8b9dc32a..0000000000 --- a/reference/gmagick/gmagick/mapimage.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - Gmagick::mapimage - Sustituye los colores de una imagen por los colores más cercanos de una imagen de referencia - - - - &reftitle.description; - - public GmagickGmagick::mapimage - gmagickgmagick - booldither - - - Sustituye los colores de una imagen por los colores más cercanos de una imagen de referencia. - - - - - &reftitle.parameters; - - - gmagick - - - La imagen de referencia. - - - - - dither - - - Entero mayor que 0 para difuminar la imagen mapeada. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/medianfilterimage.xml b/reference/gmagick/gmagick/medianfilterimage.xml deleted file mode 100644 index dda9284248..0000000000 --- a/reference/gmagick/gmagick/medianfilterimage.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - Gmagick::medianfilterimage - Aplica un filtro digital - - - - &reftitle.description; - - public voidGmagick::medianfilterimage - floatradius - - - Aplica un filtro digital que mejora la calidad del ruido de una imagen. - Cada píxel es reemplazado por la mediana en un conjunto de píxeles vecinos - tal como se define por el radio. - - - - - &reftitle.parameters; - - - radius - - - El radio de los píxeles vecinos. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick al cual se le aplicó el filtro. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/minifyimage.xml b/reference/gmagick/gmagick/minifyimage.xml deleted file mode 100644 index 4b4c68a6b0..0000000000 --- a/reference/gmagick/gmagick/minifyimage.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - Gmagick::minifyimage - Reduce una imagen a la mitad manteniendo las proporciones - - - - &reftitle.description; - - public GmagickGmagick::minifyimage - - - - Reduce una imagen a la mitad manteniendo las proporciones. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/modulateimage.xml b/reference/gmagick/gmagick/modulateimage.xml deleted file mode 100644 index 3d078c93da..0000000000 --- a/reference/gmagick/gmagick/modulateimage.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - Gmagick::modulateimage - Controla la luminosidad, la saturación y el tono - - - - &reftitle.description; - - public GmagickGmagick::modulateimage - floatbrightness - floatsaturation - floathue - - - Permite controlar la luminosidad, la saturación y el tono de una imagen. - El tono es un porcentaje de una rotación absoluta desde la posición - actual. Por ejemplo, 50 corresponde a una rotación de 90 grados en el sentido - contrario a las agujas de un reloj, 150, una rotación de 90 grados en el sentido - de las agujas de un reloj, o bien, 0 o 200 corresponde a una rotación de 180 - grados. - - - - - &reftitle.parameters; - - - brightness - - - El número de porcentaje a modificar para la luminosidad (-100 a +100). - - - - - saturation - - - El número de porcentaje a modificar para la saturación (-100 a +100). - - - - - hue - - - El número de porcentaje a modificar para el tono (-100 a +100). - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/motionblurimage.xml b/reference/gmagick/gmagick/motionblurimage.xml deleted file mode 100644 index 43872bc5df..0000000000 --- a/reference/gmagick/gmagick/motionblurimage.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - - Gmagick::motionblurimage - Simula un desenfoque cinético - - - - &reftitle.description; - - public GmagickGmagick::motionblurimage - floatradius - floatsigma - floatangle - - - Simula un desenfoque cinético. La imagen es procesada con un operador Gaussiano de un radio - dado y una desviación estándar (sigma). Para obtener buenos resultados, el radio - debe ser mayor que el sigma. Utilice un radio de 0 y el método - Gmagick::motionblurimage selecciona el mejor radio automáticamente. El argumento - angle proporciona el ángulo del desenfoque cinético. - - - - - &reftitle.parameters; - - - radius - - - El radio del Gaussiano, en píxeles, sin contar el píxel central. - - - - - sigma - - - La desviación estándar del Gaussiano, en píxeles. - - - - - angle - - - Aplica el efecto a lo largo del ángulo. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/newimage.xml b/reference/gmagick/gmagick/newimage.xml deleted file mode 100644 index 1580bc1334..0000000000 --- a/reference/gmagick/gmagick/newimage.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - Gmagick::newimage - Crea una nueva imagen - - - - &reftitle.description; - - public GmagickGmagick::newimage - intwidth - intheight - stringbackground - stringformat - - - Crea una nueva imagen con el color de fondo especificado. - - - - - &reftitle.parameters; - - - width - - - Ancho de la nueva imagen. - - - - - height - - - Alto de la nueva imagen. - - - - - background - - - El color de fondo a utilizar para la imagen (en forma de número de punto flotante). - - - - - format - - - El formato de la imagen. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/nextimage.xml b/reference/gmagick/gmagick/nextimage.xml deleted file mode 100644 index 584a331acc..0000000000 --- a/reference/gmagick/gmagick/nextimage.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - Gmagick::nextimage - Se desplaza a la imagen siguiente - - - - &reftitle.description; - - public boolGmagick::nextimage - - - - Asocia la imagen siguiente en la lista de imágenes con un objeto - Gmagick. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/normalizeimage.xml b/reference/gmagick/gmagick/normalizeimage.xml deleted file mode 100644 index d6ae02ab18..0000000000 --- a/reference/gmagick/gmagick/normalizeimage.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - Gmagick::normalizeimage - Mejora el contraste del color de la imagen - - - - &reftitle.description; - - public GmagickGmagick::normalizeimage - intchannel - - - Mejora el contraste del color de la imagen ajustando - el color de los píxeles para que correspondan al intervalo de colores - disponibles. - - - - - &reftitle.parameters; - - - channel - - - Canal a normalizar. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/oilpaintimage.xml b/reference/gmagick/gmagick/oilpaintimage.xml deleted file mode 100644 index 5f3225e81b..0000000000 --- a/reference/gmagick/gmagick/oilpaintimage.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - Gmagick::oilpaintimage - Simula una pintura al óleo - - - - &reftitle.description; - - public GmagickGmagick::oilpaintimage - - float - radius - - - - Aplica un filtro de efecto especial que simula una pintura al óleo. - Cada píxel es reemplazado por el color más frecuente que suceda en una - región circular definida por el radio. - - - - - - - - &reftitle.parameters; - - - - radius - - - - El radio de la zona inmediata circular. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick si se tuvo éxito - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/previousimage.xml b/reference/gmagick/gmagick/previousimage.xml deleted file mode 100644 index 1a935168fb..0000000000 --- a/reference/gmagick/gmagick/previousimage.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - Gmagick::previousimage - Moverse a la imagen previa del objeto - - - - &reftitle.description; - - public boolGmagick::previousimage - - - - Asocia la imagen previa de una lista de imágenes con el objeto Gmagick. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/profileimage.xml b/reference/gmagick/gmagick/profileimage.xml deleted file mode 100644 index 9178f0c8d3..0000000000 --- a/reference/gmagick/gmagick/profileimage.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - Gmagick::profileimage - Añade o elimina un perfil de una imagen - - - - &reftitle.description; - - public GmagickGmagick::profileimage - stringname - stringprofile - - - Añade o elimina un perfil ICC, IPTC o genérico de una imagen. - Si el perfil es &null;, será eliminado de la imagen, de lo contrario, - será añadido. Utilice * como nombre y un perfil &null; para - eliminar todos los perfiles de la imagen. - - - - - &reftitle.parameters; - - - name - - - Nombre del perfil a añadir o eliminar: perfil ICC, IPTC o genérico. - - - - - profile - - - El perfil. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/quantizeimage.xml b/reference/gmagick/gmagick/quantizeimage.xml deleted file mode 100644 index 22213063a4..0000000000 --- a/reference/gmagick/gmagick/quantizeimage.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - Gmagick::quantizeimage - Analiza los colores dentro de una imagen de referencia - - - - &reftitle.description; - - public GmagickGmagick::quantizeimage - intnumColors - intcolorspace - inttreeDepth - booldither - boolmeasureError - - - Analiza los colores dentro de una imagen de referencia y elige un número fijo de - colores que representan la imagen. El objetivo del algoritmo es minimizar la diferencia - de colores entre la imagen de entrada y de salida mientras minimiza el tiempo de procesamiento. - - - - - - - - &reftitle.parameters; - - - numColors - - - El número de colores. - - - - - colorspace - - - Lleva a cabo una reducción de color en este espacio de color, normalmaente RGBColorspace. - - - - - treeDepth - - - Normalmente, este valor de tipo integer es cero o uno. Un cero o uno indica a Quantize - que elija una profundidad de árbol óptima de Log4(número_colores).% Un árbol de esta profundidad - generalmente permite la mejor representación de la imagen de referencia con la menor cantidad - de memoria y la velocidad de computación más rápida. En algunos casos, como una imagen con - dispersión de color baja (un número bajo de colores), se requiere un valor distinto de - Log4(número_colores). Para expandir el árbol de colores completamente, use un valor de 8. - - - - - dither - - - Un valor distinto de cero distribuye la diferencia entre una imagen original y el algoritmo - de reducción de color correspondiente a los píxeles de la zona inmediata a lo largo de una - curva de Hilbert. - - - - - measureError - - - Un valor distinto de cero mide la diferencia entre la imagen original y la cuantificada. Esta - diferencia es el error de cuantización total. El error se computa sumando, en todos los píxeles - de una imagen, la distancia al cuadrado en el espacio RGB entre cada valor de píxel de referncia - y su valor cuantizado. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick si se tuvo éxito - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/quantizeimages.xml b/reference/gmagick/gmagick/quantizeimages.xml deleted file mode 100644 index e6ab764d13..0000000000 --- a/reference/gmagick/gmagick/quantizeimages.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - Gmagick::quantizeimages - Analiza los colores dentro de una secuencia de imágenes - - - - &reftitle.description; - - public GmagickGmagick::quantizeimages - intnumColors - intcolorspace - inttreeDepth - booldither - boolmeasureError - - - Analiza los colores dentro de una secuencia de imágenes y elige un número fijo de - colores que representan la imagen. El objetivo del algoritmo es minimizar la diferencia - de colores entre la imagen de entrada y de salida mientras minimiza el tiempo de procesamiento. - - - - - - - - &reftitle.parameters; - - - numColors - - - El número de colores. - - - - - colorspace - - - Lleva a cabo una reducción de color en este espacio de color, normalmaente RGBColorspace. - - - - - treeDepth - - - Normalmente, este valor de tipo integer es cero o uno. Un cero o uno indica a Quantize - que elija una profundidad de árbol óptima de Log4(número_colores).% Un árbol de esta profundidad - generalmente permite la mejor representación de la imagen de referencia con la menor cantidad - de memoria y la velocidad de computación más rápida. En algunos casos, como una imagen con - dispersión de color baja (un número bajo de colores), se requiere un valor distinto de - Log4(número_colores). Para expandir el árbol de colores completamente, use un valor de 8. - - - - - dither - - - Un valor distinto de cero distribuye la diferencia entre una imagen original y el algoritmo - de reducción de color correspondiente a los píxeles de la zona inmediata a lo largo de una - curva de Hilbert. - - - - - measureError - - - Un valor distinto de cero mide la diferencia entre la imagen original y la cuantificada. Esta - diferencia es el error de cuantización total. El error se computa sumando, en todos los píxeles - de una imagen, la distancia al cuadrado en el espacio RGB entre cada valor de píxel de referncia - y su valor cuantizado. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick si se tuvo éxito - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/queryfontmetrics.xml b/reference/gmagick/gmagick/queryfontmetrics.xml deleted file mode 100644 index fb5fff3ea7..0000000000 --- a/reference/gmagick/gmagick/queryfontmetrics.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - Gmagick::queryfontmetrics - Devuelve una matriz que representa las métricas de la fuente - - - - &reftitle.description; - - public arrayGmagick::queryfontmetrics - GmagickDrawdraw - stringtext - - - MagickQueryFontMetrics() devuelve una matriz que representa las métricas de la fuente. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El objeto Gmagick si se tuvo éxito - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/queryfonts.xml b/reference/gmagick/gmagick/queryfonts.xml deleted file mode 100644 index 05c5ce456e..0000000000 --- a/reference/gmagick/gmagick/queryfonts.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Gmagick::queryfonts - Devuelve las fuentes configuradas - - - - &reftitle.description; - - public arrayGmagick::queryfonts - stringpattern"*" - - - Devuelve las fuentes soportadas por Gmagick. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El objeto Gmagick si se tuvo éxito - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/queryformats.xml b/reference/gmagick/gmagick/queryformats.xml deleted file mode 100644 index 68ba021ade..0000000000 --- a/reference/gmagick/gmagick/queryformats.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - Gmagick::queryformats - Devuelve los formatos soportados por Gmagick - - - - &reftitle.description; - - public arrayGmagick::queryformats - stringpattern"*" - - - Devuelve los formatos soportados por Gmagick. - - - - - &reftitle.parameters; - - - pattern - - - Especifica un string que contiene un patrón. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/radialblurimage.xml b/reference/gmagick/gmagick/radialblurimage.xml deleted file mode 100644 index f656d14357..0000000000 --- a/reference/gmagick/gmagick/radialblurimage.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - Gmagick::radialblurimage - Desenfoca una imagen siguiendo un radio - - - - &reftitle.description; - - public GmagickGmagick::radialblurimage - floatangle - intchannelGmagick::CHANNEL_DEFAULT - - - Desenfoca una imagen siguiendo un radio. - - - - - &reftitle.parameters; - - - angle - - - El ángulo de desenfoque, en grados. - - - - - channel - - - Canal afectado. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/raiseimage.xml b/reference/gmagick/gmagick/raiseimage.xml deleted file mode 100644 index 3e234b8fa4..0000000000 --- a/reference/gmagick/gmagick/raiseimage.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - Gmagick::raiseimage - Crea un botón con un efecto 3D - - - - &reftitle.description; - - public GmagickGmagick::raiseimage - intwidth - intheight - intx - inty - boolraise - - - Crea un botón con un efecto 3D aclarando y oscureciendo los ángulos - de la imagen. La altura y el margen de los miembros de raise_info - definen el ancho del borde vertical y horizontal del efecto. - - - - - &reftitle.parameters; - - - width - - - Ancho de la zona a tratar. - - - - - height - - - Altura de la zona a tratar. - - - - - x - - - Coordenada en X. - - - - - y - - - Coordenada en Y. - - - - - raise - - - Un valor, distinto de 0, para crear el efecto 3D; de lo contrario, el efecto será atenuado. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/read.xml b/reference/gmagick/gmagick/read.xml deleted file mode 100644 index 8c8256c987..0000000000 --- a/reference/gmagick/gmagick/read.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - Gmagick::read - Lee una imagen desde un fichero - - - - &reftitle.description; - - public GmagickGmagick::read - stringfilename - - - Lee una imagen desde un fichero. - - - - - &reftitle.parameters; - - - filename - - - El nombre del fichero de imagen. - - - - - - - - &reftitle.returnvalues; - - Un objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/readimage.xml b/reference/gmagick/gmagick/readimage.xml deleted file mode 100644 index aa87f51da8..0000000000 --- a/reference/gmagick/gmagick/readimage.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - Gmagick::readimage - Lee una imagen desde un fichero - - - - &reftitle.description; - - public GmagickGmagick::readimage - stringfilename - - - Lee una imagen desde un fichero. - - - - - &reftitle.parameters; - - - filename - - - El nombre del fichero de imagen. - - - - - - - - &reftitle.returnvalues; - - Un objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/readimageblob.xml b/reference/gmagick/gmagick/readimageblob.xml deleted file mode 100644 index 0e39c82908..0000000000 --- a/reference/gmagick/gmagick/readimageblob.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - Gmagick::readimageblob - Lee una imagen desde una cadena binaria - - - - &reftitle.description; - - public GmagickGmagick::readimageblob - stringimageContents - stringfilename - - - Lee una imagen desde una cadena binaria. - - - - - &reftitle.parameters; - - - imageContents - - - Contenido de la imagen. - - - - - filename - - - El nombre del fichero de imagen. - - - - - - - - &reftitle.returnvalues; - - Un objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/readimagefile.xml b/reference/gmagick/gmagick/readimagefile.xml deleted file mode 100644 index d0784745b6..0000000000 --- a/reference/gmagick/gmagick/readimagefile.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - Gmagick::readimagefile - El propósito de readimagefile - - - - &reftitle.description; - - public GmagickGmagick::readimagefile - resourcefp - stringfilename - - - Lee una imagen o una secuencia de imágenes desde un descriptor de fichero abierto. - - - - - &reftitle.parameters; - - - fp - - - El descriptor de fichero. - - - - - - - - &reftitle.returnvalues; - - Un objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/reducenoiseimage.xml b/reference/gmagick/gmagick/reducenoiseimage.xml deleted file mode 100644 index eb8b20fc8a..0000000000 --- a/reference/gmagick/gmagick/reducenoiseimage.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - Gmagick::reducenoiseimage - Suaviza los contornos de la imagen - - - - &reftitle.description; - - public GmagickGmagick::reducenoiseimage - floatradius - - - Suaviza los contornos de la imagen manteniendo la - información de las esquinas. El algoritmo funciona - reemplazando cada píxel con su vecino más cercano - en valor. Un vecino se define por su radio. - Utilizar un radio de 0 y el método Gmagick::reducenoiseimage - seleccionará un radio apropiado automáticamente. - - - - - &reftitle.parameters; - - - radius - - - El radio del píxel vecino. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/removeimage.xml b/reference/gmagick/gmagick/removeimage.xml deleted file mode 100644 index 4a25474d6c..0000000000 --- a/reference/gmagick/gmagick/removeimage.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - Gmagick::removeimage - Elimina una imagen de la lista de imágenes - - - - &reftitle.description; - - public GmagickGmagick::removeimage - - - - Elimina una imagen de la lista de imágenes. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/removeimageprofile.xml b/reference/gmagick/gmagick/removeimageprofile.xml deleted file mode 100644 index b6b2790fb4..0000000000 --- a/reference/gmagick/gmagick/removeimageprofile.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - Gmagick::removeimageprofile - Elimina el perfil nombrado de la imagen y lo devuelve - - - - &reftitle.description; - - public stringGmagick::removeimageprofile - stringname - - - Elimina el perfil nombrado de la imagen y lo devuelve. - - - - - - - - &reftitle.parameters; - - - name - - - El nombre del perfil a devolver: ICC, IPTC, o perfil genérico. - - - - - - - - &reftitle.returnvalues; - - El perfil nombrado. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/resampleimage.xml b/reference/gmagick/gmagick/resampleimage.xml deleted file mode 100644 index 55bca1db88..0000000000 --- a/reference/gmagick/gmagick/resampleimage.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - Gmagick::resampleimage - Re-muestrea la imagen a la resolución deseada - - - - &reftitle.description; - - public GmagickGmagick::resampleimage - floatxResolution - floatyResolution - intfilter - floatblur - - - Re-muestrea la imagen a la resolución deseada. - - - - - - - - &reftitle.parameters; - - - xResolution - - - La nueva resolución x de la imagen. - - - - - yResolution - - - La nueva resolución x de la imagen. - - - - - filter - - - El filtro de imagen a usar. - - - - - blur - - - El factor de borrosidad donde mayor que que es borroso, menor que uno es nítido. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick si se tuvo éxito - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/resizeimage.xml b/reference/gmagick/gmagick/resizeimage.xml deleted file mode 100644 index 8218dac1a3..0000000000 --- a/reference/gmagick/gmagick/resizeimage.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - Gmagick::resizeimage - Redimensiona una imagen - - - - &reftitle.description; - - public GmagickGmagick::resizeimage - intwidth - intheight - intfilter - floatblur - boolfit&false; - - - Redimensiona una imagen a las dimensiones deseadas, con un filtro. - - - - - - &reftitle.parameters; - - - width - - - El número de columnas en la imagen redimensionada. - - - - - height - - - El número de líneas en la imagen redimensionada. - - - - - filter - - - El filtro de la imagen a utilizar. - - - - - blur - - - El factor de desenfoque, donde los valores superiores a 1 corresponden - a completamente desenfocado, y los valores inferiores a 1, lo contrario. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/rollimage.xml b/reference/gmagick/gmagick/rollimage.xml deleted file mode 100644 index 6ead3ce2aa..0000000000 --- a/reference/gmagick/gmagick/rollimage.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - Gmagick::rollimage - Compensa una imagen - - - - &reftitle.description; - - public GmagickGmagick::rollimage - intx - inty - - - Compensa una imagen tal como está definido por x e y. - - - - - - - - &reftitle.parameters; - - - x - - - El índice x. - - - - - y - - - El índice y. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick si se tuvo éxito - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/rotateimage.xml b/reference/gmagick/gmagick/rotateimage.xml deleted file mode 100644 index 116ea092b3..0000000000 --- a/reference/gmagick/gmagick/rotateimage.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Gmagick::rotateimage - Rota una imagen - - - - &reftitle.description; - - public GmagickGmagick::rotateimage - mixedcolor - floatdegrees - - - Rota una imagen el número de grados especificado. Los triángulos - vacíos sobrantes por la rotación de la imagen se rellenan - con el color de fondo. - - - - - - - - &reftitle.parameters; - - - color - - - El píxel de color de fondo. - - - - - degrees - - - El número de grados que se va a rotar la imagen. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick si se tuvo éxito - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/scaleimage.xml b/reference/gmagick/gmagick/scaleimage.xml deleted file mode 100644 index dd6fa63bc9..0000000000 --- a/reference/gmagick/gmagick/scaleimage.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - Gmagick::scaleimage - Redimensiona una imagen - - - - &reftitle.description; - - public GmagickGmagick::scaleimage - intwidth - intheight - boolfit&false; - - - Redimensiona una imagen a las dimensiones proporcionadas. Los otros parámetros - serán calculados si 0 es pasado como argumento. - - - - - &reftitle.parameters; - - - width - - - El número de columnas en la imagen redimensionada. - - - - - height - - - El número de líneas en la imagen redimensionada. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/separateimagechannel.xml b/reference/gmagick/gmagick/separateimagechannel.xml deleted file mode 100644 index 72f3b02f3d..0000000000 --- a/reference/gmagick/gmagick/separateimagechannel.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - Gmagick::separateimagechannel - Separa un canal de una imagen - - - - &reftitle.description; - - public GmagickGmagick::separateimagechannel - intchannel - - - Separa un canal de una imagen y devuelve una imagen en escala de grises. - Un canal es un componente de un color particular de cada píxel de una imagen. - - - - - &reftitle.parameters; - - - channel - - - Una de las constantes de canales - (Gmagick::CHANNEL_*). - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/setcompressionquality.xml b/reference/gmagick/gmagick/setcompressionquality.xml deleted file mode 100644 index f208a67f56..0000000000 --- a/reference/gmagick/gmagick/setcompressionquality.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Gmagick::setCompressionQuality - Define la calidad de compresión por defecto del objeto - - - - &reftitle.description; - - GmagickGmagick::setCompressionQuality - - intquality - - - - Define la calidad de compresión por defecto del objeto. - - - - - &reftitle.parameters; - - - quality - - - El valor por defecto de GraphicsMagick es 75. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - &reftitle.examples; - - Ejemplo con <function>Gmagick::setCompressionQuality</function> - - read("magick:rose"); -$gm->setCompressionQuality(2); -?> -]]> - - - - - - diff --git a/reference/gmagick/gmagick/setfilename.xml b/reference/gmagick/gmagick/setfilename.xml deleted file mode 100644 index 321f5ac338..0000000000 --- a/reference/gmagick/gmagick/setfilename.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - Gmagick::setfilename - Define el nombre de archivo antes de leer o escribir una imagen - - - - &reftitle.description; - - public GmagickGmagick::setfilename - stringfilename - - - Define el nombre de archivo antes de leer o escribir una imagen. - - - - - &reftitle.parameters; - - - filename - - - El nombre de archivo de la imagen. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/setimagebackgroundcolor.xml b/reference/gmagick/gmagick/setimagebackgroundcolor.xml deleted file mode 100644 index 7870e9a461..0000000000 --- a/reference/gmagick/gmagick/setimagebackgroundcolor.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - Gmagick::setimagebackgroundcolor - Define la color de fondo de la imagen - - - - &reftitle.description; - - public GmagickGmagick::setimagebackgroundcolor - GmagickPixelcolor - - - Define la color de fondo de la imagen. - - - - - &reftitle.parameters; - - - color - - - La color de fondo. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimageblueprimary.xml b/reference/gmagick/gmagick/setimageblueprimary.xml deleted file mode 100644 index 494ed52201..0000000000 --- a/reference/gmagick/gmagick/setimageblueprimary.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - Gmagick::setimageblueprimary - Define el punto azul primario de la imagen cromática - - - - &reftitle.description; - - public GmagickGmagick::setimageblueprimary - floatx - floaty - - - Define el punto azul primario de la imagen cromática. - - - - - &reftitle.parameters; - - - x - - - Coordenada en X del punto del azul primario. - - - - - y - - - Coordenada en Y del punto del azul primario. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimagebordercolor.xml b/reference/gmagick/gmagick/setimagebordercolor.xml deleted file mode 100644 index 89e33042fe..0000000000 --- a/reference/gmagick/gmagick/setimagebordercolor.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - Gmagick::setimagebordercolor - Define la color de la frontera de la imagen - - - - &reftitle.description; - - public GmagickGmagick::setimagebordercolor - GmagickPixelcolor - - - Define la color de la frontera de la imagen. - - - - - &reftitle.parameters; - - - color - - - La color de la frontera. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimagechanneldepth.xml b/reference/gmagick/gmagick/setimagechanneldepth.xml deleted file mode 100644 index 289d2bf21d..0000000000 --- a/reference/gmagick/gmagick/setimagechanneldepth.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - Gmagick::setimagechanneldepth - Define la profundidad de un canal particular de la imagen - - - - &reftitle.description; - - public GmagickGmagick::setimagechanneldepth - intchannel - intdepth - - - Define la profundidad de un canal particular de la imagen. - - - - - &reftitle.parameters; - - - channel - - - Una de las constantes de canales - (Gmagick::CHANNEL_*). - - - - - depth - - - La profundidad de la imagen, en bytes. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimagecolorspace.xml b/reference/gmagick/gmagick/setimagecolorspace.xml deleted file mode 100644 index b659fea4ce..0000000000 --- a/reference/gmagick/gmagick/setimagecolorspace.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - Gmagick::setimagecolorspace - Define el espacio de colores de la imagen - - - - &reftitle.description; - - public GmagickGmagick::setimagecolorspace - intcolorspace - - - Define el espacio de colores de la imagen. - - - - - &reftitle.parameters; - - - colorspace - - - Una de las constantes de espacio de colores de la imagen - (Gmagick::COLORSPACE_*). - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimagecompose.xml b/reference/gmagick/gmagick/setimagecompose.xml deleted file mode 100644 index c9edec000a..0000000000 --- a/reference/gmagick/gmagick/setimagecompose.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - Gmagick::setimagecompose - Establece el operador de composción de una imagen - - - - &reftitle.description; - - public GmagickGmagick::setimagecompose - intcomposite - - - Establece el operador de composción de una imagen. - - - - - - - - &reftitle.parameters; - - - composite - - - El operador de composición de la imagen. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick si se tuvo éxito - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimagedelay.xml b/reference/gmagick/gmagick/setimagedelay.xml deleted file mode 100644 index 718541ecd6..0000000000 --- a/reference/gmagick/gmagick/setimagedelay.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - Gmagick::setimagedelay - Define el retraso de la imagen - - - - &reftitle.description; - - public GmagickGmagick::setimagedelay - intdelay - - - Define el retraso de la imagen. - - - - - &reftitle.parameters; - - - delay - - - El retraso de la imagen, en centésimas de segundo. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimagedepth.xml b/reference/gmagick/gmagick/setimagedepth.xml deleted file mode 100644 index ef3a6c74ed..0000000000 --- a/reference/gmagick/gmagick/setimagedepth.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - Gmagick::setimagedepth - Define la profundidad de la imagen - - - - &reftitle.description; - - public GmagickGmagick::setimagedepth - intdepth - - - Define la profundidad de la imagen. - - - - - - &reftitle.parameters; - - - depth - - - La profundidad de la imagen, en bytes: 8, 16, o 32. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimagedispose.xml b/reference/gmagick/gmagick/setimagedispose.xml deleted file mode 100644 index fc4a16c816..0000000000 --- a/reference/gmagick/gmagick/setimagedispose.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - Gmagick::setimagedispose - Define el método de disposición de la imagen - - - - &reftitle.description; - - public GmagickGmagick::setimagedispose - intdisposeType - - - Define el método de disposición de la imagen. - - - - - &reftitle.parameters; - - - disposeType - - - El tipo de disposición de la imagen. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/setimagefilename.xml b/reference/gmagick/gmagick/setimagefilename.xml deleted file mode 100644 index 55f5ca4494..0000000000 --- a/reference/gmagick/gmagick/setimagefilename.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - Gmagick::setimagefilename - Define el nombre del fichero para una imagen particular de una secuencia - - - - &reftitle.description; - - public GmagickGmagick::setimagefilename - stringfilename - - - Define el nombre del fichero para una imagen particular de una secuencia. - - - - - &reftitle.parameters; - - - filename - - - El nombre del fichero de la imagen. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/setimageformat.xml b/reference/gmagick/gmagick/setimageformat.xml deleted file mode 100644 index 23fed8a1f9..0000000000 --- a/reference/gmagick/gmagick/setimageformat.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - Gmagick::setimageformat - Define el formato de una imagen - - - - &reftitle.description; - - public GmagickGmagick::setimageformat - stringimageFormat - - - Define el formato de una imagen particular de una secuencia. - - - - - &reftitle.parameters; - - - imageFormat - - - El formato de la imagen. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/setimagegamma.xml b/reference/gmagick/gmagick/setimagegamma.xml deleted file mode 100644 index e46ac3a926..0000000000 --- a/reference/gmagick/gmagick/setimagegamma.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - Gmagick::setimagegamma - Define el gamma de la imagen - - - - &reftitle.description; - - public GmagickGmagick::setimagegamma - floatgamma - - - Define el gamma de la imagen. - - - - - &reftitle.parameters; - - - gamma - - - El gamma de la imagen. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimagegreenprimary.xml b/reference/gmagick/gmagick/setimagegreenprimary.xml deleted file mode 100644 index 9db47beae8..0000000000 --- a/reference/gmagick/gmagick/setimagegreenprimary.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - Gmagick::setimagegreenprimary - Define el punto verde en la imagen cromática primaria - - - - &reftitle.description; - - public GmagickGmagick::setimagegreenprimary - floatx - floaty - - - Define el punto verde en la imagen cromática primaria. - - - - - &reftitle.parameters; - - - x - - - Coordenada en X del punto verde de la imagen cromática. - - - - - y - - - Coordenada en Y del punto verde de la imagen cromática. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimageindex.xml b/reference/gmagick/gmagick/setimageindex.xml deleted file mode 100644 index c1f4c59828..0000000000 --- a/reference/gmagick/gmagick/setimageindex.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - Gmagick::setimageindex - Establece el iterador en la posición especificada en la lista de imágenes apuntada por su índice - - - - &reftitle.description; - - public GmagickGmagick::setimageindex - intindex - - - Establece el iterador en la posición especificada en la lista de imágenes apuntada por su índice. - - - - - &reftitle.parameters; - - - index - - - El número de la escena. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimageinterlacescheme.xml b/reference/gmagick/gmagick/setimageinterlacescheme.xml deleted file mode 100644 index fe9667d788..0000000000 --- a/reference/gmagick/gmagick/setimageinterlacescheme.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - Gmagick::setimageinterlacescheme - Define el esquema de entrelazado de la imagen - - - - &reftitle.description; - - public GmagickGmagick::setimageinterlacescheme - intinterlace - - - Define el esquema de entrelazado de la imagen. - - - - - &reftitle.parameters; - - - interlace - - - Una de las constantes de los esquemas de entrelazado de la imagen - (Gmagick::INTERLACE_*). - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagick/setimageiterations.xml b/reference/gmagick/gmagick/setimageiterations.xml deleted file mode 100644 index 563bdf0050..0000000000 --- a/reference/gmagick/gmagick/setimageiterations.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - Gmagick::setimageiterations - Define las iteraciones de la imagen - - - - &reftitle.description; - - public GmagickGmagick::setimageiterations - intiterations - - - Define las iteraciones de la imagen. - - - - - &reftitle.parameters; - - - iterations - - - El tiempo de la imagen en centésimas de segundo. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimageprofile.xml b/reference/gmagick/gmagick/setimageprofile.xml deleted file mode 100644 index 790df2513c..0000000000 --- a/reference/gmagick/gmagick/setimageprofile.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - Gmagick::setimageprofile - Añade un perfil nombrado al objeto Gmagick - - - - &reftitle.description; - - public GmagickGmagick::setimageprofile - stringname - stringprofile - - - Añade un perfil nombrado al objeto Gmagick. Si un perfil con el mismo nobre ya existe, se reemplaza. - Este método difiere del método Gmagick::ProfileImage() en que no aplica ningún perfil de color CMS. - - - - - - - - &reftitle.parameters; - - - name - - - El nombre del perfil a añadir o eliminar: ICC, IPTC, o perfil genérico. - - - - - profile - - - El perfil. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick si se tuvo éxito. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimageredprimary.xml b/reference/gmagick/gmagick/setimageredprimary.xml deleted file mode 100644 index b80d49c38e..0000000000 --- a/reference/gmagick/gmagick/setimageredprimary.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - Gmagick::setimageredprimary - Define el punto rojo en la imagen cromática primaria - - - - &reftitle.description; - - public GmagickGmagick::setimageredprimary - floatx - floaty - - - Define el punto rojo en la imagen cromática primaria. - - - - - &reftitle.parameters; - - - x - - - Coordenada en X del punto rojo de la imagen cromática. - - - - - y - - - Coordenada en Y del punto rojo de la imagen cromática. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick en caso de éxito. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimagerenderingintent.xml b/reference/gmagick/gmagick/setimagerenderingintent.xml deleted file mode 100644 index e58b9471f2..0000000000 --- a/reference/gmagick/gmagick/setimagerenderingintent.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - Gmagick::setimagerenderingintent - Define la imagen de renderizado - - - - &reftitle.description; - - public GmagickGmagick::setimagerenderingintent - intrendering_intent - - - Define la imagen de renderizado. - - - - - &reftitle.parameters; - - - rendering_intent - - - Una de las constantes de renderizado de imagen - (Gmagick::RENDERINGINTENT_*). - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimageresolution.xml b/reference/gmagick/gmagick/setimageresolution.xml deleted file mode 100644 index b0c2816623..0000000000 --- a/reference/gmagick/gmagick/setimageresolution.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - Gmagick::setimageresolution - Establece la resolución de la imagen - - - - &reftitle.description; - - public GmagickGmagick::setimageresolution - floatxResolution - floatyResolution - - - Establece la resolución de la imagen. - - - - - - - - &reftitle.parameters; - - - xResolution - - - La resolución x de la imagen. - - - - - yResolution - - - La resolución y de la imagen. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick si se tuvo éxito. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimagescene.xml b/reference/gmagick/gmagick/setimagescene.xml deleted file mode 100644 index 353223247e..0000000000 --- a/reference/gmagick/gmagick/setimagescene.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - Gmagick::setimagescene - Define la imagen de escena - - - - &reftitle.description; - - public GmagickGmagick::setimagescene - intscene - - - Define la imagen de escena. - - - - - &reftitle.parameters; - - - scene - - - El número de la escena en la imagen. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimagetype.xml b/reference/gmagick/gmagick/setimagetype.xml deleted file mode 100644 index 77ea6bcb7e..0000000000 --- a/reference/gmagick/gmagick/setimagetype.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - Gmagick::setimagetype - Define el tipo de la imagen - - - - &reftitle.description; - - public GmagickGmagick::setimagetype - intimgType - - - Define el tipo de la imagen. - - - - - &reftitle.parameters; - - - imgType - - - Una de las constantes de tipo de imagen - (Gmagick::IMGTYPE_*). - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimageunits.xml b/reference/gmagick/gmagick/setimageunits.xml deleted file mode 100644 index 8c95a745fe..0000000000 --- a/reference/gmagick/gmagick/setimageunits.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - Gmagick::setimageunits - Define las unidades a utilizar para la resolución de la imagen - - - - &reftitle.description; - - public GmagickGmagick::setimageunits - intresolution - - - Define las unidades a utilizar para la resolución de la imagen. - - - - - &reftitle.parameters; - - - resolution - - - Una de las constantes de resolución - (Gmagick::RESOLUTION_*). - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setimagewhitepoint.xml b/reference/gmagick/gmagick/setimagewhitepoint.xml deleted file mode 100644 index a075ff6e44..0000000000 --- a/reference/gmagick/gmagick/setimagewhitepoint.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - Gmagick::setimagewhitepoint - Define el punto blanco en la imagen cromática primaria - - - - &reftitle.description; - - public GmagickGmagick::setimagewhitepoint - floatx - floaty - - - Define el punto blanco en la imagen cromática primaria. - - - - - &reftitle.parameters; - - - x - - - Coordenada en X del punto blanco de la imagen cromática. - - - - - y - - - Coordenada en Y del punto blanco de la imagen cromática. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setsamplingfactors.xml b/reference/gmagick/gmagick/setsamplingfactors.xml deleted file mode 100644 index 58b249cb56..0000000000 --- a/reference/gmagick/gmagick/setsamplingfactors.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - Gmagick::setsamplingfactors - Define los factores de muestreo de la imagen - - - - &reftitle.description; - - public GmagickGmagick::setsamplingfactors - arrayfactors - - - Define los factores de muestreo de la imagen. - - - - - &reftitle.parameters; - - - factors - - - Un array de floats, representando el factor de muestreo - para cada componente de color (en el orden RGB). - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/setsize.xml b/reference/gmagick/gmagick/setsize.xml deleted file mode 100644 index 7068a4f7b5..0000000000 --- a/reference/gmagick/gmagick/setsize.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - Gmagick::setsize - Define el tamaño del objeto Gmagick - - - - &reftitle.description; - - public GmagickGmagick::setsize - intcolumns - introws - - - Define el tamaño del objeto Gmagick. Defínase el tamaño - antes de leer una imagen sin procesar en el formato Gmagick::COLORSPACE_RGB, Gmagick::COLORSPACE_GRAY, o Gmagick::COLORSPACE_CMYK. - - - - - &reftitle.parameters; - - - columns - - - El ancho, en píxeles. - - - - - rows - - - La altura, en píxeles. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/shearimage.xml b/reference/gmagick/gmagick/shearimage.xml deleted file mode 100644 index 27f9b3d404..0000000000 --- a/reference/gmagick/gmagick/shearimage.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - Gmagick::shearimage - Crea un paralelogramo - - - - &reftitle.description; - - public GmagickGmagick::shearimage - mixedcolor - floatxShear - floatyShear - - - Mueve una esquina de la imagen a lo largo de los ejes X o Y para crear un paralelogramo. - Una dirección en X mueve a lo largo del eje X, mientras que una dirección en Y mueve a lo largo - del eje Y. La cantidad de corte se controla mediante un ángulo de corte. Para los cortes en - dirección X, x_shear se mide relativamente al eje Y, e inversamente, para los cortes en - dirección Y, y_shear se mide relativamente al eje X. Los triángulos vacíos así creados - durante el corte de la imagen serán rellenados con el color de fondo. - - - - - &reftitle.parameters; - - - color - - - El píxel de fondo. - - - - - xShear - - - El grado de corte de la imagen. - - - - - yShear - - - El grado de corte de la imagen. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/solarizeimage.xml b/reference/gmagick/gmagick/solarizeimage.xml deleted file mode 100644 index 7d50e0a964..0000000000 --- a/reference/gmagick/gmagick/solarizeimage.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - Gmagick::solarizeimage - Aplica un efecto de solarización a la imagen - - - - &reftitle.description; - - public GmagickGmagick::solarizeimage - intthreshold - - - Aplica un efecto de solarización a la imagen, similar al efecto creado en - una foto en cámara oscura, exponiendo las zonas de una foto sobre papel sensible - a la luz. El umbral varía de 0 a QuantumRange y es una medida de la extensión de la - solarización. - - - - - &reftitle.parameters; - - - threshold - - - Define la extensión de la solarización. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/spreadimage.xml b/reference/gmagick/gmagick/spreadimage.xml deleted file mode 100644 index 7c4b56b4dc..0000000000 --- a/reference/gmagick/gmagick/spreadimage.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - Gmagick::spreadimage - Desplaza aleatoriamente cada píxel de un bloque - - - - &reftitle.description; - - public GmagickGmagick::spreadimage - floatradius - - - Efecto especial que desplaza aleatoriamente cada píxel de un bloque definido - por el argumento radius. - - - - - &reftitle.parameters; - - - radius - - - Selecciona píxeles aleatoriamente en el vecindario de este alcance. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/stripimage.xml b/reference/gmagick/gmagick/stripimage.xml deleted file mode 100644 index 2f4912b095..0000000000 --- a/reference/gmagick/gmagick/stripimage.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - Gmagick::stripimage - Elimina de una imagen todos los perfiles y todos los comentarios - - - - &reftitle.description; - - public GmagickGmagick::stripimage - - - - Elimina de una imagen todos los perfiles y todos los comentarios. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/swirlimage.xml b/reference/gmagick/gmagick/swirlimage.xml deleted file mode 100644 index 7be5bd0273..0000000000 --- a/reference/gmagick/gmagick/swirlimage.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - Gmagick::swirlimage - Remue los píxeles del centro de la imagen - - - - &reftitle.description; - - public GmagickGmagick::swirlimage - floatdegrees - - - Remue los píxeles del centro de la imagen, donde los grados indican el arco de remolino alrededor del cual - los píxeles son desplazados. Se puede obtener un efecto cada vez más pronunciado - modificando los grados de 1 a 360. - - - - - &reftitle.parameters; - - - degrees - - - Define la intensidad del efecto de remolino. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/thumbnailimage.xml b/reference/gmagick/gmagick/thumbnailimage.xml deleted file mode 100644 index c689170083..0000000000 --- a/reference/gmagick/gmagick/thumbnailimage.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - Gmagick::thumbnailimage - Modifica el tamaño de una imagen - - - - &reftitle.description; - - public GmagickGmagick::thumbnailimage - intwidth - intheight - boolfit&false; - - - Modifica el tamaño de una imagen a las dimensiones dadas y elimina los perfiles asociados. - El objetivo es producir una imagen en miniatura, menos pesada, con fines de visualización en la Web. - Si &true; se proporciona como valor del 3er argumento, entonces los argumentos width - y height se utilizan como valores máximos para cada lado. - Ambos lados serán escalados durante la operación. - - - - - &reftitle.parameters; - - - width - - - Ancho de la imagen. - - - - - height - - - Altura de la imagen. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/trimimage.xml b/reference/gmagick/gmagick/trimimage.xml deleted file mode 100644 index c54652e124..0000000000 --- a/reference/gmagick/gmagick/trimimage.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - Gmagick::trimimage - Elimina los bordes de la imagen - - - - &reftitle.description; - - public GmagickGmagick::trimimage - floatfuzz - - - Elimina los bordes que son del color del fondo de la imagen. - - - - - &reftitle.parameters; - - - fuzz - - - Por omisión, el objetivo debe coincidir exactamente con el color del píxel preciso. - Sin embargo, en muchos casos, 2 colores pueden diferir ligeramente. - Este parámetro indica la tolerancia admisible para considerar 2 colores - como idénticos. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - - diff --git a/reference/gmagick/gmagick/write.xml b/reference/gmagick/gmagick/write.xml deleted file mode 100644 index 9cd7a6c084..0000000000 --- a/reference/gmagick/gmagick/write.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - - - Gmagick::write - &Alias; Gmagick::writeimage - - - - &reftitle.description; - - &info.method.alias; Gmagick::writeimage. - - - - - - diff --git a/reference/gmagick/gmagick/writeimage.xml b/reference/gmagick/gmagick/writeimage.xml deleted file mode 100644 index 2593a72991..0000000000 --- a/reference/gmagick/gmagick/writeimage.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - Gmagick::writeimage - Escribe una imagen en un archivo - - - - &reftitle.description; - - public GmagickGmagick::writeimage - stringfilename - boolall_frames&false; - - - Escribe una imagen en un archivo específico. Si el argumento - filename es &null;, la imagen - será escrita en el archivo definido por el método Gmagick::readimage - o el método Gmagick::setimagefilename. - - - - - &reftitle.parameters; - - - filename - - - El nombre del archivo. - - - - - - - - &reftitle.returnvalues; - - El objeto Gmagick. - - - - - &reftitle.errors; - - &gmagick.gmagickexception.throw; - - - - diff --git a/reference/gmagick/gmagickdraw.xml b/reference/gmagick/gmagickdraw.xml deleted file mode 100644 index b4beec2c30..0000000000 --- a/reference/gmagick/gmagickdraw.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - La clase GmagickDraw - GmagickDraw - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - GmagickDraw - - - - - GmagickDraw - - - - - &Methods; - - - - -
- -
- - &reference.gmagick.entities.gmagickdraw; - -
- diff --git a/reference/gmagick/gmagickdraw/annotate.xml b/reference/gmagick/gmagickdraw/annotate.xml deleted file mode 100644 index 25d64f2cb5..0000000000 --- a/reference/gmagick/gmagickdraw/annotate.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - GmagickDraw::annotate - Dibuja texto en la imagen - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::annotate - floatx - floaty - stringtext - - - Dibuja texto en la imagen. - - - - - - - - &reftitle.parameters; - - - x - - - coordenada x a la izquierda del texto - - - - - y - - - coordenada y a la línea base del texto - - - - - text - - - texto a dibujar - - - - - - - - &reftitle.returnvalues; - - El objeto GmagickDraw si se tuvo éxito. - - - - - diff --git a/reference/gmagick/gmagickdraw/arc.xml b/reference/gmagick/gmagickdraw/arc.xml deleted file mode 100644 index ca8334930f..0000000000 --- a/reference/gmagick/gmagickdraw/arc.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - GmagickDraw::arc - Dibuja un arco - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::arc - floatsx - floatsy - floatex - floatey - floatsd - floated - - - Dibuja un arco que cae dentro de un rectángulo circundante en la imagen. - - - - - - - - &reftitle.parameters; - - - sx - - - coordenada x del inicio del rectángulo circundante - - - - - sy - - - coordenada y del inicio del rectángulo circundante - - - - - ex - - - coordenada x del final del rectángulo circundante - - - - - ey - - - coordenada y del final del rectángulo circundante - - - - - sd - - - grados de inicio de rotación - - - - - ed - - - grados finales de rotación - - - - - - - - &reftitle.returnvalues; - - El objeto GmagickDraw si se tuvo éxito. - - - - - - diff --git a/reference/gmagick/gmagickdraw/bezier.xml b/reference/gmagick/gmagickdraw/bezier.xml deleted file mode 100644 index 5eea739619..0000000000 --- a/reference/gmagick/gmagickdraw/bezier.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - GmagickDraw::bezier - Dibuja una curva Bézier - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::bezier - arraycoordinate_array - - - Dibuja una curva Bézier a través de un conjunto de puntos en la imagen. - - - - - - &reftitle.parameters; - - - coordinate_array - - - Matriz de coordenadas - - - - - - - - &reftitle.returnvalues; - - El objeto GmagickDraw si se tuvo éxito - - - - - diff --git a/reference/gmagick/gmagickdraw/ellipse.xml b/reference/gmagick/gmagickdraw/ellipse.xml deleted file mode 100644 index 54f8e3f5b5..0000000000 --- a/reference/gmagick/gmagickdraw/ellipse.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - GmagickDraw::ellipse - Dibuja una elipse en la imagen - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::ellipse - floatox - floatoy - floatrx - floatry - floatstart - floatend - - - Dibuja una elipse en la imagen. - - - - - &reftitle.parameters; - - - ox - - - coordenada x del origen - - - - - oy - - - coordenada y del origen - - - - - rx - - - radio en x - - - - - ry - - - radio en y - - - - - start - - - inicio de rotación en grados - - - - - end - - - final de rotación en grados - - - - - - - - &reftitle.returnvalues; - - El objeto GmagickDraw si se tuvo éxito - - - - - - diff --git a/reference/gmagick/gmagickdraw/getfillcolor.xml b/reference/gmagick/gmagickdraw/getfillcolor.xml deleted file mode 100644 index b2548fd563..0000000000 --- a/reference/gmagick/gmagickdraw/getfillcolor.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - GmagickDraw::getfillcolor - Devuelve el color de relleno - - - - &reftitle.description; - - public GmagickPixelGmagickDraw::getfillcolor - - - - Devuelve el color de relleno usado cuando se dibujan objetos rellenos. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El color de relleno de GmagickPixel usado para dibujar objetos rellenos. - - - - - diff --git a/reference/gmagick/gmagickdraw/getfillopacity.xml b/reference/gmagick/gmagickdraw/getfillopacity.xml deleted file mode 100644 index d6e4d7a617..0000000000 --- a/reference/gmagick/gmagickdraw/getfillopacity.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - GmagickDraw::getfillopacity - Devuelve la opacidad usada cuando se dibuja - - - - &reftitle.description; - - public floatGmagickDraw::getfillopacity - - - - Devuelve la opacidad usada cuando se dibuja - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la opacidad usada cuando se dibuja utilizando el color de relleno o la textura de relleno. Completamente opaco es 1.0. - - - - - diff --git a/reference/gmagick/gmagickdraw/getfont.xml b/reference/gmagick/gmagickdraw/getfont.xml deleted file mode 100644 index e811259832..0000000000 --- a/reference/gmagick/gmagickdraw/getfont.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - GmagickDraw::getfont - Devuelve el tipo de letra - - - - &reftitle.description; - - public mixedGmagickDraw::getfont - - - - Devuelve una cadena que especifica el tipo de letra usado cuando se anota texto. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una cadena si se tuvo éxito y &false; si no está establecido ningún tipo de letra. - - - - - diff --git a/reference/gmagick/gmagickdraw/getfontsize.xml b/reference/gmagick/gmagickdraw/getfontsize.xml deleted file mode 100644 index 02f7141f01..0000000000 --- a/reference/gmagick/gmagickdraw/getfontsize.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - GmagickDraw::getfontsize - Devuelve el tamaño de punto de la fuente - - - - &reftitle.description; - - public floatGmagickDraw::getfontsize - - - - Devuelve el tamaño de punto de la fuente usado cuando se anota texto. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el tamaño de la fuente asociada con el objeto GmagickDraw actual. - - - - - diff --git a/reference/gmagick/gmagickdraw/getfontstyle.xml b/reference/gmagick/gmagickdraw/getfontstyle.xml deleted file mode 100644 index 447140696e..0000000000 --- a/reference/gmagick/gmagickdraw/getfontstyle.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - GmagickDraw::getfontstyle - Devuelve el estilo de fuente - - - - &reftitle.description; - - public intGmagickDraw::getfontstyle - - - - Devuelve el estilo de fuente usado cuando se anota texto. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la constante de estilo de fuente (STYLE_) asociada con el objeto GmagickDraw o 0 si no está establecido ningún estilo. - - - - - diff --git a/reference/gmagick/gmagickdraw/getfontweight.xml b/reference/gmagick/gmagickdraw/getfontweight.xml deleted file mode 100644 index e1dd0fbf55..0000000000 --- a/reference/gmagick/gmagickdraw/getfontweight.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - GmagickDraw::getfontweight - Devuelve el peso de la fuente - - - - &reftitle.description; - - public intGmagickDraw::getfontweight - - - - Devuelve el peso de la fuente usada cuando se anota texto. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un valor de tipo int si se tuvo éxito y 0 si no está establecido el peso. - - - - - diff --git a/reference/gmagick/gmagickdraw/getstrokecolor.xml b/reference/gmagick/gmagickdraw/getstrokecolor.xml deleted file mode 100644 index c7bd857aed..0000000000 --- a/reference/gmagick/gmagickdraw/getstrokecolor.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - GmagickDraw::getstrokecolor - Devuelve el color usado para contornear perfiles de objetos - - - - &reftitle.description; - - public GmagickPixelGmagickDraw::getstrokecolor - - - - Devuelve el color usado para contornear perfiles de objetos. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un objeto GmagickPixel que describe el color. - - - - - diff --git a/reference/gmagick/gmagickdraw/getstrokeopacity.xml b/reference/gmagick/gmagickdraw/getstrokeopacity.xml deleted file mode 100644 index 474c4bef9d..0000000000 --- a/reference/gmagick/gmagickdraw/getstrokeopacity.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - GmagickDraw::getstrokeopacity - Devuelve la opacidad de los perfiles del objeto contorneado - - - - &reftitle.description; - - public floatGmagickDraw::getstrokeopacity - - - - Devuelve la opacidad de los perfiles del objeto contorneado. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un valor de float que describe la opacidad. - - - - - diff --git a/reference/gmagick/gmagickdraw/getstrokewidth.xml b/reference/gmagick/gmagickdraw/getstrokewidth.xml deleted file mode 100644 index 2ee7a3af8c..0000000000 --- a/reference/gmagick/gmagickdraw/getstrokewidth.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - GmagickDraw::getstrokewidth - Devuelve el ancho del contorno usado para dibular perfiles del objeto - - - - &reftitle.description; - - public floatGmagickDraw::getstrokewidth - - - - Devuelve el ancho del contorno usado para dibular perfiles del objeto. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un valor de float que describe el ancho del contorno. - - - - - diff --git a/reference/gmagick/gmagickdraw/gettextdecoration.xml b/reference/gmagick/gmagickdraw/gettextdecoration.xml deleted file mode 100644 index 220fb1b6a2..0000000000 --- a/reference/gmagick/gmagickdraw/gettextdecoration.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - GmagickDraw::gettextdecoration - Devuelve la decoración del texto - - - - &reftitle.description; - - public intGmagickDraw::gettextdecoration - - - - Devuelve la decoración aplicada cuando se anota texto. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una de las constantes DECORATION_ y 0 si no está establecida la decoración. - - - - - diff --git a/reference/gmagick/gmagickdraw/gettextencoding.xml b/reference/gmagick/gmagickdraw/gettextencoding.xml deleted file mode 100644 index 37124008d7..0000000000 --- a/reference/gmagick/gmagickdraw/gettextencoding.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - GmagickDraw::gettextencoding - Devuelve el conjunto de codificación usado para anotaciones de texto - - - - &reftitle.description; - - public mixedGmagickDraw::gettextencoding - - - - Devuelve una cadena que especifica el conjunto de codificación usado para anotaciones de texto. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una cadena que especifica el conjunto de codificación o &false; si no está establecida ningúna codificación. - - - - - diff --git a/reference/gmagick/gmagickdraw/line.xml b/reference/gmagick/gmagickdraw/line.xml deleted file mode 100644 index 91516d3cbf..0000000000 --- a/reference/gmagick/gmagickdraw/line.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - GmagickDraw::line - Dibuja una línea - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::line - floatsx - floatsy - floatex - floatey - - - Dibuja una línea en la imagen usando el color del contorno, la opacidad del contorno, y el ancho del contorno acutales. - - - - - &reftitle.parameters; - - - sx - - - coordenada x de inicio - - - - - sy - - - coordenada y de inicio - - - - - ex - - - coordenada x final - - - - - ey - - - coordenada y final - - - - - - - - &reftitle.returnvalues; - - El objeto GmagickDraw si se tuvo éxito - - - - - diff --git a/reference/gmagick/gmagickdraw/point.xml b/reference/gmagick/gmagickdraw/point.xml deleted file mode 100644 index c2b9663bcb..0000000000 --- a/reference/gmagick/gmagickdraw/point.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - GmagickDraw::point - Dibuja un punto - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::point - floatx - floaty - - - Dibuja un punto usando el color de contorno y el grosor de contorno actuales en las coordenadas especificadas. - - - - - &reftitle.parameters; - - - x - - - coordenada x del objetivo - - - - - y - - - coordenada y del objetivo - - - - - - - - &reftitle.returnvalues; - - El objeto GmagickDraw si se tuvo éxito - - - - - - diff --git a/reference/gmagick/gmagickdraw/polygon.xml b/reference/gmagick/gmagickdraw/polygon.xml deleted file mode 100644 index 4d16ca880e..0000000000 --- a/reference/gmagick/gmagickdraw/polygon.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - GmagickDraw::polygon - Dibuja un polígono - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::polygon - arraycoordinates - - - Dibuja un polígono usando el contorno, el ancho del contorno, y el color o textura de relleno actuales, usando la matriz de coordenadas especificadas. - - - - - &reftitle.parameters; - - - coordinates - - - matriz de coordenadas - - - - - - - - &reftitle.returnvalues; - - El objeto GmagickDraw si se tuvo éxito - - - - - - diff --git a/reference/gmagick/gmagickdraw/polyline.xml b/reference/gmagick/gmagickdraw/polyline.xml deleted file mode 100644 index 885fe179ca..0000000000 --- a/reference/gmagick/gmagickdraw/polyline.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - GmagickDraw::polyline - Dibuja una polilínea - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::polyline - arraycoordinate_array - - - Dibuja una polilínea usando el contorno, el ancho del contorno, y el color o textura de relleno actuales, usando la matriz de coordenadas especificadas. - - - - - &reftitle.parameters; - - - coordinate_array - - - La matriz de coordenadas. - - - - - - - - &reftitle.returnvalues; - - El objeto GmagickDraw si se tuvo éxito - - - - - diff --git a/reference/gmagick/gmagickdraw/rectangle.xml b/reference/gmagick/gmagickdraw/rectangle.xml deleted file mode 100644 index d24cbe7a19..0000000000 --- a/reference/gmagick/gmagickdraw/rectangle.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - GmagickDraw::rectangle - Dibuja un rectángulo - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::rectangle - floatx1 - floaty1 - floatx2 - floaty2 - - - Dibuja un rectángulo dadas dos coordenadas y usando el contorno, el ancho del contorno, y la configuración de relleno actuales. - - - - - - - - &reftitle.parameters; - - - x1 - - - primera coordenada x - - - - - y1 - - - primera coordenada y - - - - - x2 - - - segunda coordenada x - - - - - y2 - - - primera coordenada y - - - - - - - - &reftitle.returnvalues; - - El objeto GmagickDraw si se tuvo éxito - - - - - diff --git a/reference/gmagick/gmagickdraw/rotate.xml b/reference/gmagick/gmagickdraw/rotate.xml deleted file mode 100644 index 6ce171ee47..0000000000 --- a/reference/gmagick/gmagickdraw/rotate.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - GmagickDraw::rotate - Aplica la rotación especificada al espacio de coordenadas actual - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::rotate - floatdegrees - - - Aplica la rotación especificada al espacio de coordenadas actual. - - - - - &reftitle.parameters; - - - degrees - - - grados de rotación - - - - - - - - &reftitle.returnvalues; - - El objeto GmagickDraw si se tuvo éxito - - - - - diff --git a/reference/gmagick/gmagickdraw/roundrectangle.xml b/reference/gmagick/gmagickdraw/roundrectangle.xml deleted file mode 100644 index c137981a13..0000000000 --- a/reference/gmagick/gmagickdraw/roundrectangle.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - GmagickDraw::roundrectangle - Dibuja un rectángulo redondeado - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::roundrectangle - floatx1 - floaty1 - floatx2 - floaty2 - floatrx - floatry - - - Dibuja aun rectángulo redondeado dadas dos coordenadas, los radios de las esquinas x e y, y usando - el contorno, el ancho del contorno, y la configuración de relleno actuales. - - - - - &reftitle.parameters; - - - x1 - - - primera coordenada x - - - - - y1 - - - primera coordenada y - - - - - x2 - - - segunda coordenada x - - - - - y2 - - - segunda coordenada y - - - - - rx - - - radio de la esquina en dirección horizontal - - - - - ry - - - radio de la esquina en dirección vertical - - - - - - - - &reftitle.returnvalues; - - El objeto GmagickDraw si se tuvo éxito - - - - - diff --git a/reference/gmagick/gmagickdraw/scale.xml b/reference/gmagick/gmagickdraw/scale.xml deleted file mode 100644 index aef06ce972..0000000000 --- a/reference/gmagick/gmagickdraw/scale.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - GmagickDraw::scale - Ajusta el factor de escala - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::scale - floatx - floaty - - - Ajusta el factor de escala a aplicar en las direcciones horizontal y vertical al espacio de coordenadas actual. - - - - - &reftitle.parameters; - - - x - - - Factor de escala horizontal - - - - - y - - - Factor de escala vertical - - - - - - - - &reftitle.returnvalues; - - El objeto GmagickDraw si se tuvo éxito - - - - - diff --git a/reference/gmagick/gmagickdraw/setfillcolor.xml b/reference/gmagick/gmagickdraw/setfillcolor.xml deleted file mode 100644 index c9c0234f82..0000000000 --- a/reference/gmagick/gmagickdraw/setfillcolor.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - GmagickDraw::setfillcolor - Establece el color de relleno a usar cuando se dibujan objetos rellenos - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::setfillcolor - mixedcolor - - - Establece el color de relleno a usar cuando se dibujan objetos rellenos. - - - - - - - - &reftitle.parameters; - - - color - - - Un objeto GmagickPixel o un string que indica el color a usar para el relleno. - - - - - - - - &reftitle.returnvalues; - - El objeto GmagickDraw si se tuvo éxito - - - - - diff --git a/reference/gmagick/gmagickdraw/setfillopacity.xml b/reference/gmagick/gmagickdraw/setfillopacity.xml deleted file mode 100644 index 144bbbd8ba..0000000000 --- a/reference/gmagick/gmagickdraw/setfillopacity.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - GmagickDraw::setfillopacity - Establece la opacidad del relleno - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::setfillopacity - floatfill_opacity - - - Establece la opacidad a usar cuando de dibuja untilizando el color de relleno o la textura de relleno. Establecerlo a 1.0 hará al relleno completamente opaco. - - - - - &reftitle.parameters; - - - fill_opacity - - - La opacidad del relleno - - - - - - - - &reftitle.returnvalues; - - El objeto GmagickDraw si se tuvo éxito - - - - - diff --git a/reference/gmagick/gmagickdraw/setfont.xml b/reference/gmagick/gmagickdraw/setfont.xml deleted file mode 100644 index 2e2e27f735..0000000000 --- a/reference/gmagick/gmagickdraw/setfont.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - GmagickDraw::setfont - Establece la fuente especificada completamente a usar cuando se anota texto - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::setfont - stringfont - - - Establece la fuente especificada completamente a usar cuando se anota texto. - - - - - - - - &reftitle.parameters; - - - font - - - El nombre de la fuente - - - - - - - - &reftitle.returnvalues; - - El objeto GmagickDraw si se tuvo éxito - - - - - diff --git a/reference/gmagick/gmagickdraw/setfontsize.xml b/reference/gmagick/gmagickdraw/setfontsize.xml deleted file mode 100644 index 7af5aea500..0000000000 --- a/reference/gmagick/gmagickdraw/setfontsize.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - GmagickDraw::setfontsize - Establece el tamaño de punto de la fuente a usar cuando se anota texto - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::setfontsize - floatpointsize - - - Establece el tamaño de punto de la fuente a usar cuando se anota texto. - - - - - &reftitle.parameters; - - - pointsize - - - El tamaño de punto del texto - - - - - - - - &reftitle.returnvalues; - - El objeto GmagickDraw si se tuvo éxito - - - - - diff --git a/reference/gmagick/gmagickdraw/setfontstyle.xml b/reference/gmagick/gmagickdraw/setfontstyle.xml deleted file mode 100644 index 82a293ab2f..0000000000 --- a/reference/gmagick/gmagickdraw/setfontstyle.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - GmagickDraw::setfontstyle - Establece el estilo de fuente a usar cuando se anota texto - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::setfontstyle - intstyle - - - Establece el estilo de fuente a usar cuando se anota texto. La enumeración AnyStyle actúa como una opción comodín para "no tener cuidado". - - - - - &reftitle.parameters; - - - style - - - El estilo de la fuente (NormalStyle, ItalicStyle, ObliqueStyle, AnyStyle) - - - - - - - - &reftitle.returnvalues; - - El objeto GmagickDraw si se tuvo éxito - - - - - - diff --git a/reference/gmagick/gmagickdraw/setfontweight.xml b/reference/gmagick/gmagickdraw/setfontweight.xml deleted file mode 100644 index 981ed7b554..0000000000 --- a/reference/gmagick/gmagickdraw/setfontweight.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - GmagickDraw::setfontweight - Establece el peso de la fuente - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::setfontweight - intweight - - - Establece el peso de la fuente a usar cuando se anota texto. - - - - - - &reftitle.parameters; - - - weight - - - El peso de la fuente (rango válido 100-900) - - - - - - - - &reftitle.returnvalues; - - El objeto GmagickDraw si se tuvo éxito - - - - - diff --git a/reference/gmagick/gmagickdraw/setstrokecolor.xml b/reference/gmagick/gmagickdraw/setstrokecolor.xml deleted file mode 100644 index eccf40c0a4..0000000000 --- a/reference/gmagick/gmagickdraw/setstrokecolor.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - GmagickDraw::setstrokecolor - Establece el color usado para contornear los perfiles del objeto - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::setstrokecolor - mixedcolor - - - Establece el color usado para contornear los perfiles del objeto. - - - - - &reftitle.parameters; - - - color - - - Un objeto GmagickPixel o un string que representa el color del contorno. - - - - - - - - &reftitle.returnvalues; - - El objeto GmagickDraw si se tuvo éxito - - - - - diff --git a/reference/gmagick/gmagickdraw/setstrokeopacity.xml b/reference/gmagick/gmagickdraw/setstrokeopacity.xml deleted file mode 100644 index ea413e09b5..0000000000 --- a/reference/gmagick/gmagickdraw/setstrokeopacity.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - GmagickDraw::setstrokeopacity - Especifica la opacidad del los perfiles del objeto contorneado - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::setstrokeopacity - floatstroke_opacity - - - Especifica la opacidad del los perfiles del objeto contorneado. - - - - - &reftitle.parameters; - - - stroke_opacity - - - La opacidad del contorno. El valor 1.0 es opaco. - - - - - - - - &reftitle.returnvalues; - - El objeto GmagickDraw si se tuvo éxito - - - - - diff --git a/reference/gmagick/gmagickdraw/setstrokewidth.xml b/reference/gmagick/gmagickdraw/setstrokewidth.xml deleted file mode 100644 index 4a343f5c1f..0000000000 --- a/reference/gmagick/gmagickdraw/setstrokewidth.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - GmagickDraw::setstrokewidth - Establece el ancho del contorno usado para dibujar los perfiles del objeto. - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::setstrokewidth - floatwidth - - - Establece el ancho del contorno usado para dibujar los perfiles del objeto - - - - - &reftitle.parameters; - - - width - - - El ancho del contorno - - - - - - - - &reftitle.returnvalues; - - El objeto GmagickDraw si se tuvo éxito - - - - - diff --git a/reference/gmagick/gmagickdraw/settextdecoration.xml b/reference/gmagick/gmagickdraw/settextdecoration.xml deleted file mode 100644 index f112389e5f..0000000000 --- a/reference/gmagick/gmagickdraw/settextdecoration.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - GmagickDraw::settextdecoration - Especifica una decoración - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::settextdecoration - intdecoration - - - Especifica una decoración que va a ser aplicada cuando se anota texto. - - - - - &reftitle.parameters; - - - int - - - Decoración del texto. Una de estas: NoDecoration, UnderlineDecoration, OverlineDecoration, o LineThroughDecoration - - - - - - - - &reftitle.returnvalues; - - El objeto GmagickDraw si se tuvo éxito - - - - - diff --git a/reference/gmagick/gmagickdraw/settextencoding.xml b/reference/gmagick/gmagickdraw/settextencoding.xml deleted file mode 100644 index fd6ec42046..0000000000 --- a/reference/gmagick/gmagickdraw/settextencoding.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - GmagickDraw::settextencoding - Especifica el conjunto de codificación del texto - - - - &reftitle.description; - - public GmagickDrawGmagickDraw::settextencoding - stringencoding - - - Especifica el conjunto de codificación usado para anotaciones el texto. La única codificación - de caracteres que se puede especificar por ahora es "UTF-8" para representar Unicode como - una secuencia de bytes. Especifique un string vacío para establecer la codificación de texto a la - predeterminada por el sistema. El éxito con la anotación de texto usando Unicode puede - requerir fuentes diseñadas para soportar Unicode. - - - - - &reftitle.parameters; - - - encoding - - - Cadena de caracteres que especifica la codificación de texto - - - - - - - - &reftitle.returnvalues; - - El objeto GmagickDraw en caso de éxito - - - - diff --git a/reference/gmagick/gmagickexception.xml b/reference/gmagick/gmagickexception.xml deleted file mode 100644 index 3081538ceb..0000000000 --- a/reference/gmagick/gmagickexception.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - La clase GmagickException - GmagickException - - - - -
- &reftitle.intro; - - La clase GmagickException - -
- - -
- &reftitle.classsynopsis; - - - - GmagickException - - - - - GmagickException - - - - extends - Exception - - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
- - -
- -
- diff --git a/reference/gmagick/gmagickpixel.xml b/reference/gmagick/gmagickpixel.xml deleted file mode 100644 index d01d4f8580..0000000000 --- a/reference/gmagick/gmagickpixel.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - La clase GmagickPixel - GmagickPixel - - - - -
- &reftitle.intro; - - -
- - -
- &reftitle.classsynopsis; - - - - GmagickPixel - - - - - GmagickPixel - - - - - &Methods; - - - - - - - - - -
- -
- - &reference.gmagick.entities.gmagickpixel; - -
- diff --git a/reference/gmagick/gmagickpixel/construct.xml b/reference/gmagick/gmagickpixel/construct.xml deleted file mode 100644 index ca50a6f3d6..0000000000 --- a/reference/gmagick/gmagickpixel/construct.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - GmagickPixel::__construct - El constructor GmagickPixel - - - - &reftitle.description; - - public GmagickPixel::__construct - stringcolor - - - Construye un nuevo objeto GmagickPixel. - Si se especifica un color, el objeto es construido - y luego inicializado utilizando este color antes de ser devuelto. - - - - - &reftitle.parameters; - - - color - - - El color a utilizar como valor inicial de este objeto (opcional). - - - - - - - - diff --git a/reference/gmagick/gmagickpixel/getcolor.xml b/reference/gmagick/gmagickpixel/getcolor.xml deleted file mode 100644 index 78e197be01..0000000000 --- a/reference/gmagick/gmagickpixel/getcolor.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - GmagickPixel::getcolor - Devuelve el color - - - - &reftitle.description; - - public mixedGmagickPixel::getcolor - boolas_array&false; - boolnormalize_array&false; - - - Devuelve el color descrito por el objeto GmagickPixel, en forma de &string; o un &array;. - Si el color tiene un canal de opacidad definido, este será especificado como cuarto valor - de la lista. - - - - - - &reftitle.parameters; - - - as_array - - - &true; para indicar que el valor devuelto debe ser - un &array; en lugar de una &string;. - - - - - normalize_array - - - &true; para normalizar los valores de color. - - - - - - - - &reftitle.returnvalues; - - Una &string; o un &array; de valores de canales, cada uno normalizado si &true; - es proporcionado para normalize_array. - Emite una excepción GmagickPixelException en caso de error. - - - - - diff --git a/reference/gmagick/gmagickpixel/getcolorcount.xml b/reference/gmagick/gmagickpixel/getcolorcount.xml deleted file mode 100644 index 4ad9fbeba2..0000000000 --- a/reference/gmagick/gmagickpixel/getcolorcount.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - GmagickPixel::getcolorcount - Devuelve el número de colores asociados con este color - - - - &reftitle.description; - - public intGmagickPixel::getcolorcount - - - - Devuelve el número de colores asociados con este color. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el número de colores, en forma de un integer en caso de éxito, y lanza una excepción GmagickPixelException si ocurre un error. - - - - - diff --git a/reference/gmagick/gmagickpixel/getcolorvalue.xml b/reference/gmagick/gmagickpixel/getcolorvalue.xml deleted file mode 100644 index 9f0a9473ed..0000000000 --- a/reference/gmagick/gmagickpixel/getcolorvalue.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - GmagickPixel::getcolorvalue - Obtiene el valor normalizado del canal de color proporcionado - - - - &reftitle.description; - - public floatGmagickPixel::getcolorvalue - intcolor - - - Obtiene el valor normalizado del canal de color proporcionado, - en forma de número de punto flotante comprendido entre 0 y 1. - - - - - - &reftitle.parameters; - - - color - - - El canal a verificar, especificado en forma de una de las constantes de canal - Gmagick. - - - - - - - - &reftitle.returnvalues; - - El valor del canal, en forma de número de punto flotante normalizado, - y emite una excepción GmagickPixelException en caso de error. - - - - - diff --git a/reference/gmagick/gmagickpixel/setcolor.xml b/reference/gmagick/gmagickpixel/setcolor.xml deleted file mode 100644 index 192dba44da..0000000000 --- a/reference/gmagick/gmagickpixel/setcolor.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - GmagickPixel::setcolor - Define la color - - - - &reftitle.description; - - public GmagickPixelGmagickPixel::setcolor - stringcolor - - - Define la color descrita por el objeto GmagickPixel, con una &string; - (i.e. "blue", "#0000ff", "rgb(0,0,255)", "cmyk(100,100,100,10)", etc.). - - - - - - &reftitle.parameters; - - - color - - - La definición de la color a utilizar para inicializar - el objeto GmagickPixel. - - - - - - - - &reftitle.returnvalues; - - El objeto GmagickPixel en caso de éxito. - - - - - diff --git a/reference/gmagick/gmagickpixel/setcolorvalue.xml b/reference/gmagick/gmagickpixel/setcolorvalue.xml deleted file mode 100644 index d8530a0c20..0000000000 --- a/reference/gmagick/gmagickpixel/setcolorvalue.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - GmagickPixel::setcolorvalue - Establece el valor normalizado de uno de los canales - - - - &reftitle.description; - - public GmagickPixelGmagickPixel::setcolorvalue - intcolor - floatvalue - - - Establece el valor del canal especificado de este objeto al valor proporcionado, el cuál debería estar - entre 0 y 1. Esta función se puede usar para proporcionar un canal de opacidad al objeto GmagickPixel. - - - - - - - - &reftitle.parameters; - - - color - - - Una de las constantes de color de canal de Gmagick. - - - - - value - - - El valor para establecer este canal tiene un rango desde 0 a 1. - - - - - - - - &reftitle.returnvalues; - - El objeto GmagickPixel si se tuvo éxtio. - - - - - - diff --git a/reference/gmagick/gmagickpixelexception.xml b/reference/gmagick/gmagickpixelexception.xml deleted file mode 100644 index e6959d1e80..0000000000 --- a/reference/gmagick/gmagickpixelexception.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - La clase GmagickPixelException - GmagickPixelException - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - GmagickPixelException - - - - - GmagickPixelException - - - - extends - Exception - - - - - &InheritedMethods; - - - - - -
- - -
- -
- diff --git a/reference/gmagick/setup.xml b/reference/gmagick/setup.xml deleted file mode 100644 index 94d2d33606..0000000000 --- a/reference/gmagick/setup.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - &reftitle.setup; - -
- &reftitle.required; - - Esta extensión funciona perfectamente con GraphicsMagick versión 1.4+. - Gmagick debería funcionar con versiones anteriores, desde la versión 1.2.6 de GraphicsMagick 1.2.6, pero algunas funcionalidades - y formatos no están soportados. La versión Windows de GraphicsMagick está disponible - desde el sitio web de GraphicsMagick. Para conocer las diferencias - entre ImageMagick y GraphicsMagick, leer la : - FAQ . - -
- - -
- &reftitle.install; - - &pecl.info; - &url.pecl.package;gmagick. - - - - El nombre oficial de esta extensión es gmagick. - - -
- - -
- diff --git a/reference/gnupg/book.xml b/reference/gnupg/book.xml deleted file mode 100644 index dd616be68e..0000000000 --- a/reference/gnupg/book.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - - GNU PG - GnuPG - - - - &reftitle.intro; - - Este módulo permite interactuar con - gnupg. - - - - - &reference.gnupg.setup; - &reference.gnupg.constants; - &reference.gnupg.examples; - - &reference.gnupg.reference; - - - diff --git a/reference/gnupg/configure.xml b/reference/gnupg/configure.xml deleted file mode 100644 index 6ef0a7eb64..0000000000 --- a/reference/gnupg/configure.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - -
- &reftitle.install; - - &pecl.info; - . - -
- diff --git a/reference/gnupg/constants.xml b/reference/gnupg/constants.xml deleted file mode 100644 index bfe9534f4a..0000000000 --- a/reference/gnupg/constants.xml +++ /dev/null @@ -1,306 +0,0 @@ - - - - - - - &reftitle.constants; - - - - GNUPG_SIG_MODE_NORMAL - (int) - - - - - - - - - - GNUPG_SIG_MODE_DETACH - (int) - - - - - - - - - - GNUPG_SIG_MODE_CLEAR - (int) - - - - - - - - - - GNUPG_VALIDITY_UNKNOWN - (int) - - - - - - - - - - GNUPG_VALIDITY_UNDEFINED - (int) - - - - - - - - - - GNUPG_VALIDITY_NEVER - (int) - - - - - - - - - - GNUPG_VALIDITY_MARGINAL - (int) - - - - - - - - - - GNUPG_VALIDITY_FULL - (int) - - - - - - - - - - GNUPG_VALIDITY_ULTIMATE - (int) - - - - - - - - - - GNUPG_PROTOCOL_OpenPGP - (int) - - - - - - - - - - GNUPG_PROTOCOL_CMS - (int) - - - - - - - - - - GNUPG_SIGSUM_VALID - (int) - - - - - - - - - - GNUPG_SIGSUM_GREEN - (int) - - - - - - - - - - GNUPG_SIGSUM_RED - (int) - - - - - - - - - - GNUPG_SIGSUM_KEY_REVOKED - (int) - - - - - - - - - - GNUPG_SIGSUM_KEY_EXPIRED - (int) - - - - - - - - - - GNUPG_SIGSUM_KEY_MISSING - (int) - - - - - - - - - - GNUPG_SIGSUM_SIG_EXPIRED - (int) - - - - - - - - - - GNUPG_SIGSUM_CRL_MISSING - (int) - - - - - - - - - - GNUPG_SIGSUM_CRL_TOO_OLD - (int) - - - - - - - - - - GNUPG_SIGSUM_BAD_POLICY - (int) - - - - - - - - - - GNUPG_SIGSUM_SYS_ERROR - (int) - - - - - - - - - - GNUPG_ERROR_WARNING - (int) - - - - - - - - - - GNUPG_ERROR_EXCEPTION - (int) - - - - - - - - - - GNUPG_ERROR_SILENT - (int) - - - - - - - - - - - diff --git a/reference/gnupg/examples.xml b/reference/gnupg/examples.xml deleted file mode 100644 index e343305cd1..0000000000 --- a/reference/gnupg/examples.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - &reftitle.examples; -
- Firma de texto (clearsign) - - Ejemplo que firma un texto dado. - - - Ejemplo de firma (clearsign) gnupg mediante funciones - - -]]> - - - - Ejemplo de firma gnupg (clearsign) mediante orientación a objetos - -setsignmode(gnupg::SIG_MODE_CLEAR); -// Añade clave con la contraseña 'test' para firmar -$gnupg->addsignkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); -// Firma -$signed = $gnupg->sign("just a test"); -echo $signed; -?> -]]> - - - - keylistiterator - - Esta extensión trae también un Iterator para un juego de claves - - - $userid){ - echo $fingerprint." -> ".$userid."\n"; -} -?> -]]> - - -
-
- diff --git a/reference/gnupg/functions/gnupg-adddecryptkey.xml b/reference/gnupg/functions/gnupg-adddecryptkey.xml deleted file mode 100644 index 82a9dd8f99..0000000000 --- a/reference/gnupg/functions/gnupg-adddecryptkey.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - gnupg_adddecryptkey - Añade una clave para descifrado - - - - &reftitle.description; - - boolgnupg_adddecryptkey - resourceidentifier - stringfingerprint - stringpassphrase - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - fingerprint - - &gnupg.fingerprint; - - - - passphrase - - - La frase de contraseña (similar a la contraseña, pero más larga). - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Ejemplo con <function>gnupg_adddecryptkey</function> (Estilo procedimental) - - -]]> - - - - Ejemplo con <function>gnupg_adddecryptkey</function> (Estilo orientado a objetos) - -adddecryptkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-addencryptkey.xml b/reference/gnupg/functions/gnupg-addencryptkey.xml deleted file mode 100644 index f521f8abbc..0000000000 --- a/reference/gnupg/functions/gnupg-addencryptkey.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - gnupg_addencryptkey - Añade una clave para cifrado - - - - &reftitle.description; - - boolgnupg_addencryptkey - resourceidentifier - stringfingerprint - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - fingerprint - - &gnupg.fingerprint; - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Ejemplo con <function>gnupg_addencryptkey</function> (Estilo procedimental) - - -]]> - - - - Ejemplo con <function>gnupg_addencryptkey</function> (Estilo orientado a objetos) - -addencryptkey("8660281B6051D071D94B5B230549F9DC851566DC"); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-addsignkey.xml b/reference/gnupg/functions/gnupg-addsignkey.xml deleted file mode 100644 index b8550ee75e..0000000000 --- a/reference/gnupg/functions/gnupg-addsignkey.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - gnupg_addsignkey - Añade una clave para firmar - - - - &reftitle.description; - - boolgnupg_addsignkey - resourceidentifier - stringfingerprint - stringpassphrase - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - fingerprint - - &gnupg.fingerprint; - - - - passphrase - - - La frase de contraseña (similar a la contraseña, pero más larga). - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Ejemplo con <function>gnupg_addsignkey</function> (Estilo procedimental) - - -]]> - - - - Ejemplo con <function>gnupg_addsignkey</function> (Estilo orientado a objetos) - -addsignkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-cleardecryptkeys.xml b/reference/gnupg/functions/gnupg-cleardecryptkeys.xml deleted file mode 100644 index 6a8b383832..0000000000 --- a/reference/gnupg/functions/gnupg-cleardecryptkeys.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - gnupg_cleardecryptkeys - Elimina todas las claves que fueron fijadas para el descifrado anteriormente - - - - &reftitle.description; - - boolgnupg_cleardecryptkeys - resourceidentifier - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Ejemplo con <function>gnupg_cleardecryptkeys</function> (Estilo procedimental) - - -]]> - - - - Ejemplo con <function>gnupg_cleardecryptkeys</function> (Estilo orientado a objetos) - -cleardecryptkeys(); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-clearencryptkeys.xml b/reference/gnupg/functions/gnupg-clearencryptkeys.xml deleted file mode 100644 index 62487d76db..0000000000 --- a/reference/gnupg/functions/gnupg-clearencryptkeys.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - gnupg_clearencryptkeys - Elimina todas las claves que fueron establecidas para cifrado con anterioridad - - - - &reftitle.description; - - boolgnupg_clearencryptkeys - resourceidentifier - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Ejemplo con <function>gnupg_clearencryptkeys</function> (Estilo procedimental) - - -]]> - - - - Ejemplo con <function>gnupg_clearencryptkeys</function> (Estilo orientado a objetos) - -clearencryptkeys(); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-clearsignkeys.xml b/reference/gnupg/functions/gnupg-clearsignkeys.xml deleted file mode 100644 index 1e4f045ff9..0000000000 --- a/reference/gnupg/functions/gnupg-clearsignkeys.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - gnupg_clearsignkeys - Elimina todas las claves que fueron fijadas para firma previamente - - - - &reftitle.description; - - boolgnupg_clearsignkeys - resourceidentifier - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Ejemplo con <function>gnupg_clearsignkeys</function> (Estilo procedimental) - - -]]> - - - - Ejemplo con <function>gnupg_clearsignkeys</function> (Estilo orientado a objetos) - -clearsignkeys(); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-decrypt.xml b/reference/gnupg/functions/gnupg-decrypt.xml deleted file mode 100644 index 1e7636b454..0000000000 --- a/reference/gnupg/functions/gnupg-decrypt.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - gnupg_decrypt - Descifra un texto dado - - - - &reftitle.description; - - stringfalsegnupg_decrypt - resourceidentifier - stringtext - - - Descifra un texto dado con las claves que se han establecido con gnupg_adddecryptkey - previamente. - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - text - - - El texto a descifrar. - - - - - - - - &reftitle.returnvalues; - - En caso de éxito, esta función devuelve el texto descifrado. - En caso de error, esta función devuelve &false;. - - - - - &reftitle.examples; - - - Ejemplo con <function>gnupg_decrypt</function> (Estilo procedimental) - - -]]> - - - - Ejemplo con <function>gnupg_decrypt</function> (Estilo orientado a objetos) - -adddecryptkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); -$plain = $gpg->decrypt($encrypted_text); -echo $plain; -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-decryptverify.xml b/reference/gnupg/functions/gnupg-decryptverify.xml deleted file mode 100644 index 44e750d2b2..0000000000 --- a/reference/gnupg/functions/gnupg-decryptverify.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - gnupg_decryptverify - Descifra y verifica un texto dado - - - - &reftitle.description; - - arrayfalsegnupg_decryptverify - resourceidentifier - stringtext - stringplaintext - - - Descifra y verifica un texto dado y devuelve las informaciones sobre - la firma. - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - text - - - El texto a descifrar. - - - - - plaintext - - - El argumento plaintext se rellena con el texto - descifrado. - - - - - - - - &reftitle.returnvalues; - - En caso de éxito, esta función devuelve las informaciones sobre la - firma y rellena el argumento plaintext con el - texto descifrado. En caso de fallo, esta función devuelve &false;. - - - - - &reftitle.examples; - - - Ejemplo con <function>gnupg_decryptverify</function> (Estilo procedimental) - - -]]> - - - - Ejemplo con <function>gnupg_decryptverify</function> (Estilo orientado a objetos) - -adddecryptkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); -$info = $gpg->decryptverify($text,$plaintext); -print_r($info); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-deletekey.xml b/reference/gnupg/functions/gnupg-deletekey.xml deleted file mode 100644 index 0b0cbd3ac5..0000000000 --- a/reference/gnupg/functions/gnupg-deletekey.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - gnupg_deletekey - Elimina una clave del llavero - - - - &reftitle.description; - - boolgnupg_deletekey - resourceidentifier - stringkey - boolallow_secret - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - key - - - La clave a eliminar. - - - - - allow_secret - - - Especifica si se deben eliminar las claves secretas. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Ejemplo procedimental <function>gnupg_deletekey</function> - - -]]> - - - - Ejemplo orientado a objetos <function>gnupg_deletekey</function> - -deletekey("8660281B6051D071D94B5B230549F9DC851566DC"); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-encrypt.xml b/reference/gnupg/functions/gnupg-encrypt.xml deleted file mode 100644 index 4ff7a86800..0000000000 --- a/reference/gnupg/functions/gnupg-encrypt.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - gnupg_encrypt - Cifra un texto dado - - - - &reftitle.description; - - stringfalsegnupg_encrypt - resourceidentifier - stringplaintext - - - Cifra el argumento plaintext con las claves que han - sido establecidas con gnupg_addencryptkey - previamente y devuelve el texto cifrado. - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - plaintext - - - El texto a cifrar. - - - - - - - - &reftitle.returnvalues; - - En caso de éxito, esta función devuelve el texto cifrado. - En caso de error, esta función devuelve &false;. - - - - - &reftitle.examples; - - - Ejemplo con <function>gnupg_encrypt</function> (Estilo procedimental) - - -]]> - - - - Ejemplo con <function>gnupg_encrypt</function> (Estilo orientado a objetos) - -addencryptkey("8660281B6051D071D94B5B230549F9DC851566DC"); -$enc = $gpg->encrypt("sólo una prueba"); -echo $enc; -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-encryptsign.xml b/reference/gnupg/functions/gnupg-encryptsign.xml deleted file mode 100644 index 732a266bf9..0000000000 --- a/reference/gnupg/functions/gnupg-encryptsign.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - gnupg_encryptsign - Cifra y firma un texto dado - - - - &reftitle.description; - - stringfalsegnupg_encryptsign - resourceidentifier - stringplaintext - - - Cifra y firma el parámetro plaintext con las - claves que han sido establecidas con - gnupg_addsignkey y gnupg_addencryptkey - previamente y devuelve el texto cifrado y firmado. - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - plaintext - - - El texto a cifrar. - - - - - - - - &reftitle.returnvalues; - - En caso de éxito, esta función devuelve el texto firmado y cifrado. - En caso de fallo, esta función devuelve &false;. - - - - - &reftitle.examples; - - - Ejemplo con <function>gnupg_encryptsign</function> (Estilo procedimental) - - -]]> - - - - Ejemplo con <function>gnupg_encryptsign</function> (Estilo orientado a objetos) - -addencryptkey("8660281B6051D071D94B5B230549F9DC851566DC"); -$gpg->addsignkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); -$enc = $gpg->encryptsign("sólo una prueba"); -echo $enc; -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-export.xml b/reference/gnupg/functions/gnupg-export.xml deleted file mode 100644 index 097c8c707b..0000000000 --- a/reference/gnupg/functions/gnupg-export.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - gnupg_export - Exporta una clave - - - - &reftitle.description; - - stringfalsegnupg_export - resourceidentifier - stringfingerprint - - - Exporta la clave fingerprint. - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - fingerprint - - &gnupg.fingerprint; - - - - - - - &reftitle.returnvalues; - - En caso de éxito, esta función devuelve los datos de la clave. - En caso de fallo, esta función devuelve &false;. - - - - - &reftitle.examples; - - - Ejemplo con <function>gnupg_export</function> (Estilo procedimental) - - -]]> - - - - Ejemplo con <function>gnupg_export</function> (Estilo orientado a objetos) - -export("8660281B6051D071D94B5B230549F9DC851566DC"); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-getengineinfo.xml b/reference/gnupg/functions/gnupg-getengineinfo.xml deleted file mode 100644 index f3075029d8..0000000000 --- a/reference/gnupg/functions/gnupg-getengineinfo.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - gnupg_getengineinfo - Devuelve la información del motor - - - - &reftitle.description; - - arraygnupg_getengineinfo - resourceidentifier - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - - - - &reftitle.returnvalues; - - Devuelve un array que contiene la información del motor compuesto por protocol, - file_name y home_dir. - - - - - &reftitle.examples; - - - Ejemplo procedimental <function>gnupg_getengineinfo</function> - - -]]> - - &example.outputs; - - - int(0) - ["file_name"]=> - string(12) "/usr/bin/gpg" - ["home_dir"]=> - string(0) "" -} -]]> - - - - Ejemplo orientado a objetos <function>gnupg_getengineinfo</function> - - "/usr/bin/gpg2", "home_dir" => "/var/www/.gnupg"]); -print_r($gpg->getengineinfo()); -?> -]]> - - &example.outputs; - - - int(0) - ["file_name"]=> - string(13) "/usr/bin/gpg2" - ["home_dir"]=> - string(15) "/var/www/.gnupg" -} -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-geterror.xml b/reference/gnupg/functions/gnupg-geterror.xml deleted file mode 100644 index 525284672f..0000000000 --- a/reference/gnupg/functions/gnupg-geterror.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - gnupg_geterror - Devuelve el texto de error, si una función falla - - - - &reftitle.description; - - stringfalsegnupg_geterror - resourceidentifier - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - - - - &reftitle.returnvalues; - - Devuelve el texto de error si se ha producido un error, en caso contrario devuelve - &false;. - - - - - &reftitle.examples; - - - Ejemplo con <function>gnupg_geterror</function> (Estilo procedimental) - - -]]> - - - - Ejemplo con <function>gnupg_geterror</function> (Estilo orientado a objetos) - -geterror(); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-geterrorinfo.xml b/reference/gnupg/functions/gnupg-geterrorinfo.xml deleted file mode 100644 index a6b6886fe2..0000000000 --- a/reference/gnupg/functions/gnupg-geterrorinfo.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - gnupg_geterrorinfo - Devuelve la información de error - - - - &reftitle.description; - - arraygnupg_geterrorinfo - resourceidentifier - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - - - - &reftitle.returnvalues; - - Devuelve un array con la información de error. - - - - - &reftitle.examples; - - - Ejemplo procedimental <function>gnupg_geterrorinfo</function> - - -]]> - - &example.outputs; - - - bool(false) - ["gpgme_code"]=> - int(0) - ["gpgme_source"]=> - string(18) "Unspecified source" - ["gpgme_message"]=> - string(7) "Success" -} -]]> - - - - Ejemplo orientado a objetos <function>gnupg_geterrorinfo</function> - -decrypt('abc'); -// la información de error debe ser mostrada -print_r($gpg->geterrorinfo()); -?> -]]> - - &example.outputs; - - - string(14) "decrypt failed" - ["gpgme_code"]=> - int(117440570) - ["gpgme_source"]=> - string(5) "GPGME" - ["gpgme_message"]=> - string(7) "No data" -} -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-getprotocol.xml b/reference/gnupg/functions/gnupg-getprotocol.xml deleted file mode 100644 index d344b3ca3c..0000000000 --- a/reference/gnupg/functions/gnupg-getprotocol.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - gnupg_getprotocol - Devuelve el protocolo activo actual para todas las operaciones - - - - &reftitle.description; - - intgnupg_getprotocol - resourceidentifier - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - - - - &reftitle.returnvalues; - - Devuelve el protocolo activo actual, que puede ser uno de estos: - GNUPG_PROTOCOL_OpenPGP o - GNUPG_PROTOCOL_CMS. - - - - - &reftitle.examples; - - - Ejemplo con <function>gnupg_getprotocol</function> (Estilo procedimental) - - -]]> - - - - Ejemplo con <function>gnupg_getprotocol</function> (Estilo orientado a objetos) - -getprotocol(); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-gettrustlist.xml b/reference/gnupg/functions/gnupg-gettrustlist.xml deleted file mode 100644 index f395194b53..0000000000 --- a/reference/gnupg/functions/gnupg-gettrustlist.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - gnupg_gettrustlist - Busca los elementos de confianza - - - - &reftitle.description; - - arraynullgnupg_gettrustlist - resourceidentifier - stringpattern - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - pattern - - - Una expresión para limitar la lista de elementos de confianza a los elementos que coinciden con el patrón. - - - - - - - - &reftitle.returnvalues; - - En caso de éxito, esta función devuelve un array de elementos de confianza. - En caso de error, esta función devuelve &null;. - - - - - &reftitle.examples; - - - Ejemplo procedimental <function>gnupg_gettrustlist</function> - - -]]> - - - - Ejemplo orientado a objetos <function>gnupg_gettrustlist</function> - -gettrustlist(); -print_r($items); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-import.xml b/reference/gnupg/functions/gnupg-import.xml deleted file mode 100644 index 34703fa264..0000000000 --- a/reference/gnupg/functions/gnupg-import.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - gnupg_import - Importa una clave - - - - &reftitle.description; - - arrayfalsegnupg_import - resourceidentifier - stringkeydata - - - Importa la clave keydata y devuelve un array con - la información sobre el proceso de importación. - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - keydata - - - La clave a importar. - - - - - - - - &reftitle.returnvalues; - - En caso de éxito, esta función devuelve un array de información sobre - el proceso de importación. - En caso de fallo, esta función devuelve &false;. - - - - - &reftitle.examples; - - - Ejemplo con <function>gnupg_import</function> (Estilo procedimental) - - -]]> - - - - Ejemplo con <function>gnupg_import</function> (Estilo orientado a objetos) - -import($keydata); -print_r($info); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-init.xml b/reference/gnupg/functions/gnupg-init.xml deleted file mode 100644 index d4b4766718..0000000000 --- a/reference/gnupg/functions/gnupg-init.xml +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - - gnupg_init - Inicializa una conexión - - - - &reftitle.description; - - resourcegnupg_init - arraynulloptions&null; - - - - - &reftitle.parameters; - - - options - - - Debe ser un array asociativo. Se utiliza para modificar la configuración - por omisión del motor criptográfico. - - Sustitución de la configuración - - - - Clave - Tipo - Descripción - - - - - file_name - string - - Es el nombre de fichero del programa ejecutable que implementa - este protocolo, que generalmente es la ruta del ejecutable gpg. - - - - home_dir - string - - Es el nombre del directorio de configuración. - También sustituye a la variable de entorno GNUPGHOME - que se utiliza con el mismo propósito. - - - - -
-
-
-
-
-
- - - &reftitle.returnvalues; - - Un recurso de conexión GnuPG, utilizado por otras funciones GnuPG. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL gnupg 1.5.0 - - Se ha añadido el argumento options. - - - - - - - - - &reftitle.examples; - - - Ejemplo con <function>gnupg_init</function> con configuración por omisión (Estilo procedimental) - - -]]> - - - - Ejemplo con <function>gnupg_init</function> con nombre de fichero y directorio de origen sobrescritos (Estilo procedimental) - - "/usr/bin/gpg2", "home_dir" => "/var/www/.gnupg"]); -?> -]]> - - - - Ejemplo con <function>gnupg_init</function> con configuración por omisión (Estilo orientado a objetos) - - -]]> - - - - Ejemplo con <function>gnupg_init</function> con nombre de fichero y directorio de origen sobrescritos (Estilo orientado a objetos) - - "/usr/bin/gpg2", "home_dir" => "/var/www/.gnupg"]); -?> -]]> - - - - -
- diff --git a/reference/gnupg/functions/gnupg-keyinfo.xml b/reference/gnupg/functions/gnupg-keyinfo.xml deleted file mode 100644 index 8de2b1c176..0000000000 --- a/reference/gnupg/functions/gnupg-keyinfo.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - gnupg_keyinfo - Retorna un array con las informaciones acerca de todas las - claves que coinciden con el patrón dado - - - - &reftitle.description; - - arrayfalsegnupg_keyinfo - resourceidentifier - stringpattern - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - pattern - - - La máscara a utilizar sobre las claves. - - - - - - - - &reftitle.returnvalues; - - Retorna un array con las informaciones acerca de todas las claves que - coinciden con el patrón dado o retorna &false; si ha ocurrido un error. - - - - - &reftitle.examples; - - - Ejemplo con <function>gnupg_keyinfo</function> (Estilo procedimental) - - -]]> - - - - Ejemplo con <function>gnupg_keyinfo</function> (Estilo orientado a objetos) - -keyinfo("test"); -print_r($info); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-listsignatures.xml b/reference/gnupg/functions/gnupg-listsignatures.xml deleted file mode 100644 index f78ef96f3b..0000000000 --- a/reference/gnupg/functions/gnupg-listsignatures.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - gnupg_listsignatures - Lista las firmas de clave - - - - &reftitle.description; - - arraynullgnupg_listsignatures - resourceidentifier - stringkeyid - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - keyid - - - El identificador de clave para listar las firmas. - - - - - - - - &reftitle.returnvalues; - - En caso de éxito, esta función devuelve un array de firmas de clave. - En caso de error, esta función devuelve &null;. - - - - - &reftitle.examples; - - - Ejemplo procedimental <function>gnupg_listsignatures</function> - - -]]> - - - - Ejemplo orientado a objetos <function>gnupg_listsignatures</function> - -listsignatures("8660281B6051D071D94B5B230549F9DC851566DC"); -print_r($signatures); -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-setarmor.xml b/reference/gnupg/functions/gnupg-setarmor.xml deleted file mode 100644 index 4f33159bc6..0000000000 --- a/reference/gnupg/functions/gnupg-setarmor.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - gnupg_setarmor - Cambia la salida blindada - - - - &reftitle.description; - - boolgnupg_setarmor - resourceidentifier - intarmor - - - Cambia la salida blindada. - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - armor - - - Pase un valor entero diferente de cero a esta función para activar - la salida blindada (valor por omisión). - Pase 0 para desactivar la salida blindada. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Ejemplo con <function>gnupg_setarmor</function> (Estilo procedimental) - - -]]> - - - - Ejemplo con <function>gnupg_setarmor</function> (Estilo orientado a objetos) - -setarmor(1); // Activa la salida blindada; -$gpg->setarmor(0); // Desactiva la salida blindada; -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-seterrormode.xml b/reference/gnupg/functions/gnupg-seterrormode.xml deleted file mode 100644 index 462b2557ac..0000000000 --- a/reference/gnupg/functions/gnupg-seterrormode.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - gnupg_seterrormode - Establece el modo para error_reporting - - - - &reftitle.description; - - voidgnupg_seterrormode - resourceidentifier - interrormode - - - Establece el modo para error_reporting. - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - errormode - - - El modo de error. - - - errormode acepta una constante que indica qué tipo de - error_reporting debe ser utilizado. Los valores posibles son - GNUPG_ERROR_WARNING, - GNUPG_ERROR_EXCEPTION y - GNUPG_ERROR_SILENT. - Por omisión GNUPG_ERROR_SILENT. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo con <function>gnupg_seterrormode</function> (Estilo procedimental) - - -]]> - - - - Ejemplo con <function>gnupg_seterrormode</function> (Estilo orientado a objetos) - -seterrormode(gnupg::ERROR_EXCEPTION); // lanza una excepción en caso de error -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-setsignmode.xml b/reference/gnupg/functions/gnupg-setsignmode.xml deleted file mode 100644 index 7b7d718bf7..0000000000 --- a/reference/gnupg/functions/gnupg-setsignmode.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - gnupg_setsignmode - Establece el modo para firmar - - - - &reftitle.description; - - boolgnupg_setsignmode - resourceidentifier - intsignmode - - - Establece el modo para firmar. - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - sigmode - - - El modo de firma. - - - signmode acepta una constante que indica qué tipo de - firma debe ser producida. Los valores posibles son: - GNUPG_SIG_MODE_NORMAL, - GNUPG_SIG_MODE_DETACH y - GNUPG_SIG_MODE_CLEAR. - Por omisión, se utiliza GNUPG_SIG_MODE_CLEAR. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Ejemplo con <function>gnupg_setsignmode</function> (Estilo procedimental) - - -]]> - - - - Ejemplo con <function>gnupg_setsignmode</function> (Estilo orientado a objetos) - -setsignmode(gnupg::SIG_MODE_DETACH); // produce una firma desvinculada -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-sign.xml b/reference/gnupg/functions/gnupg-sign.xml deleted file mode 100644 index 9ff6016d7f..0000000000 --- a/reference/gnupg/functions/gnupg-sign.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - gnupg_sign - Firma un texto dado - - - - &reftitle.description; - - stringfalsegnupg_sign - resourceidentifier - stringplaintext - - - Firma el argumento plaintext con las claves que - fueron establecidas con gnupg_addsignkey previamente - y devuelve el texto firmado o la firma, dependiendo de lo que fue - establecido con - gnupg_setsignmode. - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - plaintext - - - El texto a firmar. - - - - - - - - &reftitle.returnvalues; - - En caso de éxito, esta función devuelve el texto firmado o la firma. - En caso de fallo, esta función devuelve &false;. - - - - - &reftitle.examples; - - - Ejemplo con <function>gnupg_sign</function> (Estilo procedimental) - - -]]> - - - - Ejemplo con <function>gnupg_sign</function> (Estilo orientado a objetos) - -addsignkey("8660281B6051D071D94B5B230549F9DC851566DC","test"); -$signed = $gpg->sign("just a test"); -echo $signed; -?> -]]> - - - - - - diff --git a/reference/gnupg/functions/gnupg-verify.xml b/reference/gnupg/functions/gnupg-verify.xml deleted file mode 100644 index 7aefa26b03..0000000000 --- a/reference/gnupg/functions/gnupg-verify.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - - gnupg_verify - Verifica un texto firmado - - - - &reftitle.description; - - arrayfalsegnupg_verify - resourceidentifier - stringsigned_text - stringsignature - stringplaintext - - - Verifica el argumento signed_text y devuelve las - informaciones acerca de la firma. - - - - - &reftitle.parameters; - - - identifier - - &gnupg.identifier; - - - - signed_text - - - El texto firmado. - - - - - signature - - - La firma. Para verificar un texto firmado en claro, se establece la firma - a &false;. - - - - - plaintext - - - El texto. Si este argumento opcional es pasado, se rellena con el plaintext. - - - - - - - - &reftitle.returnvalues; - - En caso de éxito, esta función devuelve informaciones acerca de la - firma. - En caso de fallo, esta función devuelve &false;. - - - - - &reftitle.examples; - - - Ejemplo con <function>gnupg_verify</function> (Estilo procedimental) - - -]]> - - - - Ejemplo con <function>gnupg_verify</function> (Estilo orientado a objetos) - -verify($signed_text,false,$plaintext); -print_r($info); -// firma separada -$info = $gpg->verify($signed_text,$signature); -print_r($info); -?> -]]> - - - - - - diff --git a/reference/gnupg/reference.xml b/reference/gnupg/reference.xml deleted file mode 100644 index eb88c1fa25..0000000000 --- a/reference/gnupg/reference.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - &Functions; GnuPG - - - &reftitle.notes; - - Esta extensión utiliza el trousseau del usuario actual. Este trousseau se - encuentra normalmente en ~/.gnupg/. - Para especificar una ubicación diferente, registrar la ruta del trousseau en la variable de entorno GNUPGHOME. Ver - putenv para más información sobre cómo realizar esto. - - - Algunas funciones requieren la especificación de una clave. Esta especificación puede ser algo que haga referencia a una clave única (userid, key-id, fingerprint, ...). - Esta documentación utiliza los fingerprint en todos los ejemplos. - - - - Como alternativa a las funciones que utilizan explícitamente los - resource, también puede utilizarse un estilo orientado a objetos mediante objetos gnupg. - - - - - &reference.gnupg.entities.functions; - - - diff --git a/reference/gnupg/setup.xml b/reference/gnupg/setup.xml deleted file mode 100644 index e1d8a2524c..0000000000 --- a/reference/gnupg/setup.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - &reftitle.setup; - - -
- &reftitle.required; - - Esta extensión requiere la biblioteca gpgme. - -
- - - - &reference.gnupg.configure; - - -
- diff --git a/reference/hrtime/book.xml b/reference/hrtime/book.xml deleted file mode 100644 index db57b67a28..0000000000 --- a/reference/hrtime/book.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - Gestión del tiempo de alta resolución - HRTime - - - &reftitle.intro; - - La extensión HRTime implementa una clase StopWatch de alta resolución. - Utiliza la mejor de las APIs en las diferentes plataformas, que - proporcionará una resolución a la nanosegundo. Asimismo, es posible - implementar un cronómetro personalizado utilizando los ticks de bajo - nivel, entregados por las APIs subyacentes. - - - - A partir de PHP 7.3.0 la función relacionada hrtime forma - parte del núcleo. - - - - - &reference.hrtime.examples; - &reference.hrtime.hrtime.performancecounter; - &reference.hrtime.hrtime.stopwatch; - &reference.hrtime.hrtime.unit; - - - diff --git a/reference/hrtime/configure.xml b/reference/hrtime/configure.xml deleted file mode 100644 index a87169172d..0000000000 --- a/reference/hrtime/configure.xml +++ /dev/null @@ -1,36 +0,0 @@ - - - - -
- &reftitle.install; - - - Emplee al compilar PHP. - - - - Los usuarios de Windows deberían incluir php_hrtime.dll en &php.ini; - - -
- diff --git a/reference/hrtime/examples.xml b/reference/hrtime/examples.xml deleted file mode 100644 index ac19bc68d8..0000000000 --- a/reference/hrtime/examples.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - &reftitle.examples; -
- Uso básico - - El ejemplo muestra el uso básico de la clase StopWatch - - - Medir la ejecución de varios bloques de código y obtener el total - -start(); -/* medir la ejecución de este bloque de código */ -for ($i = 0; $i < 1024*1024; $i++); -$c->stop(); -$transcurrido0 = $c->getLastElapsedTime(HRTime\Unit::NANOSECOND); - -/* la medición no se ejecuta aquí */ -for ($i = 0; $i < 1024*1024; $i++); - -$c->start(); -/* medir la ejecución de este bloque de código */ -for ($i = 0; $i < 1024*1024; $i++); -$c->stop(); -$transcurrido1 = $c->getLastElapsedTime(HRTime\Unit::NANOSECOND); - -$total_transcurrido = $c->getElapsedTime(HRTime\Unit::NANOSECOND); - -?> -]]> - - -
-
- diff --git a/reference/hrtime/hrtime-performancecounter/getfrequency.xml b/reference/hrtime/hrtime-performancecounter/getfrequency.xml deleted file mode 100644 index 9996d54293..0000000000 --- a/reference/hrtime/hrtime-performancecounter/getfrequency.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - HRTime\PerformanceCounter::getFrequency - Frecuencia del temporizador en ticks por segundo - - - - &reftitle.description; - - public static intHRTime\PerformanceCounter::getFrequency - - - - Se devuelve la frecuencia del temporizador en ticks por segundo. Este - valor es constante tras el inicio del sistema en la mayoría - de los sistemas operativos. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Se devuelve un &integer; que indica la frecuencia del temporizador. - - - - - diff --git a/reference/hrtime/hrtime-performancecounter/getticks.xml b/reference/hrtime/hrtime-performancecounter/getticks.xml deleted file mode 100644 index 5fe013b69d..0000000000 --- a/reference/hrtime/hrtime-performancecounter/getticks.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - HRTime\PerformanceCounter::getTicks - Ticks actuales desde el sistema - - - - &reftitle.description; - - public static intHRTime\PerformanceCounter::getTicks - - - - Devuelve el recuento de ticks. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un &integer; que indica el recuento de ticks. - - - - - diff --git a/reference/hrtime/hrtime-performancecounter/gettickssince.xml b/reference/hrtime/hrtime-performancecounter/gettickssince.xml deleted file mode 100644 index d1be418651..0000000000 --- a/reference/hrtime/hrtime-performancecounter/gettickssince.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - HRTime\PerformanceCounter::getTicksSince - Ticks transcurridos desde el valor proporcionado - - - - &reftitle.description; - - public static intHRTime\PerformanceCounter::getTicksSince - intstart - - - Devuelve el recuento de ticks transcurridos desde el valor de inicio proporcionado. - - - - - &reftitle.parameters; - - - start - - - Valor de ticks de inicio. - - - - - - - - &reftitle.returnvalues; - - Devuelve un &integer; que indica el recuento de ticks. - - - - diff --git a/reference/hrtime/hrtime-stopwatch/getelapsedticks.xml b/reference/hrtime/hrtime-stopwatch/getelapsedticks.xml deleted file mode 100644 index 7efe9fe6cd..0000000000 --- a/reference/hrtime/hrtime-stopwatch/getelapsedticks.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - HRTime\StopWatch::getElapsedTicks - Obtiene los ticks transcurridos para todos los intervalos - - - - &reftitle.description; - - public intHRTime\StopWatch::getElapsedTicks - - - - Obtiene los ticks transcurridos para todos los intervalos cerrados anteriores. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un &integer; que indica los ticks transcurridos. - - - - - diff --git a/reference/hrtime/hrtime-stopwatch/getelapsedtime.xml b/reference/hrtime/hrtime-stopwatch/getelapsedtime.xml deleted file mode 100644 index 5f20ef727a..0000000000 --- a/reference/hrtime/hrtime-stopwatch/getelapsedtime.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - HRTime\StopWatch::getElapsedTime - Obtiene el tiempo transcurrido para todos los intervalos - - - - &reftitle.description; - - public floatHRTime\StopWatch::getElapsedTime - intunit - - - Obtiene el tiempo transcurrido para todos los intervalos anteriores cerrados. - - - - - &reftitle.parameters; - - - unit - - - Unidad de tiempo representada por una constante HRTime\Unit. Por omisión vale HRTime\Unit::SECOND. - - - - - - - - &reftitle.returnvalues; - - Devuelve un &float; que indica el tiempo transcurrido. - - - - - diff --git a/reference/hrtime/hrtime-stopwatch/getlastelapsedticks.xml b/reference/hrtime/hrtime-stopwatch/getlastelapsedticks.xml deleted file mode 100644 index 1b7c018e70..0000000000 --- a/reference/hrtime/hrtime-stopwatch/getlastelapsedticks.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - HRTime\StopWatch::getLastElapsedTicks - Obtiene los ticks transcurridos para el último intervalo - - - - &reftitle.description; - - public intHRTime\StopWatch::getLastElapsedTicks - - - - Obtiene los ticks transcurridos para el último intervalo cerrado. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un &integer; que indica los ticks transcurridos. - - - - - diff --git a/reference/hrtime/hrtime-stopwatch/getlastelapsedtime.xml b/reference/hrtime/hrtime-stopwatch/getlastelapsedtime.xml deleted file mode 100644 index 915967b865..0000000000 --- a/reference/hrtime/hrtime-stopwatch/getlastelapsedtime.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - HRTime\StopWatch::getLastElapsedTime - Obtiene el tiempo transcurrido para el último intervalo - - - - &reftitle.description; - - public floatHRTime\StopWatch::getLastElapsedTime - intunit - - - Obtiene el tiempo transcurrido para el último intervalo. - - - - - - &reftitle.parameters; - - - unit - - - Unidad de tiempo representada por una constante - HRTime\Unit. Por omisión vale HRTime\Unit::SECOND. - - - - - - - - &reftitle.returnvalues; - - Devuelve un &float; que indica el tiempo transcurrido. - - - - - diff --git a/reference/hrtime/hrtime-stopwatch/isrunning.xml b/reference/hrtime/hrtime-stopwatch/isrunning.xml deleted file mode 100644 index 7f72d02f65..0000000000 --- a/reference/hrtime/hrtime-stopwatch/isrunning.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - HRTime\StopWatch::isRunning - Comprueba si la medición del tiempo está en curso - - - - &reftitle.description; - - public boolHRTime\StopWatch::isRunning - - - - Comprueba si la medición del tiempo ha sido iniciada. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un &boolean; que indica si la medición del tiempo está en curso. - - - - diff --git a/reference/hrtime/hrtime-stopwatch/start.xml b/reference/hrtime/hrtime-stopwatch/start.xml deleted file mode 100644 index 3bb622a0b7..0000000000 --- a/reference/hrtime/hrtime-stopwatch/start.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - HRTime\StopWatch::start - Inicia la medición del tiempo - - - - &reftitle.description; - - public voidHRTime\StopWatch::start - - - - Inicia la medición del tiempo. Este método no tiene ningún efecto si la medición ya ha sido iniciada. La medición continuará si ha sido detenida previamente. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - No devuelve ningún valor. - - - - - diff --git a/reference/hrtime/hrtime-stopwatch/stop.xml b/reference/hrtime/hrtime-stopwatch/stop.xml deleted file mode 100644 index 6cf530bb2e..0000000000 --- a/reference/hrtime/hrtime-stopwatch/stop.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - HRTime\StopWatch::stop - Detiene la medición del tiempo - - - - &reftitle.description; - - public voidHRTime\StopWatch::stop - - - - Detiene la medición del tiempo para el intervalo anterior. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve void. - - - - diff --git a/reference/hrtime/hrtime.performancecounter.xml b/reference/hrtime/hrtime.performancecounter.xml deleted file mode 100644 index 80c477d59b..0000000000 --- a/reference/hrtime/hrtime.performancecounter.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - La clase HRTime\PerformanceCounter - HRTime\PerformanceCounter - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - HRTime\PerformanceCounter - - - - - HRTime\PerformanceCounter - - - - - &Methods; - - - - -
- -
- - &reference.hrtime.entities.hrtime-performancecounter; - -
- diff --git a/reference/hrtime/hrtime.stopwatch.xml b/reference/hrtime/hrtime.stopwatch.xml deleted file mode 100644 index f7b330e631..0000000000 --- a/reference/hrtime/hrtime.stopwatch.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - La clase HRTime\StopWatch - HRTime\StopWatch - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - HRTime\StopWatch - - - - - HRTime\StopWatch - - - - extends - HRTime\PerformanceCounter - - - - - &Methods; - - - &InheritedMethods; - - - - - -
- -
- - &reference.hrtime.entities.hrtime-stopwatch; - -
- diff --git a/reference/hrtime/hrtime.unit.xml b/reference/hrtime/hrtime.unit.xml deleted file mode 100644 index 40b0c13423..0000000000 --- a/reference/hrtime/hrtime.unit.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - - La clase HRTime\Unit - HRTime\Unit - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - HRTime\Unit - - - - - HRTime\Unit - - - - &Constants; - - const - int - HRTime\Unit::SECOND - 0 - - - const - int - HRTime\Unit::MILLISECOND - 1 - - - const - int - HRTime\Unit::MICROSECOND - 2 - - - const - int - HRTime\Unit::NANOSECOND - 3 - - - &Methods; - - - - -
- - -
- &reftitle.constants; - - - - HRTime\Unit::SECOND - - - - - - - HRTime\Unit::MILLISECOND - - - - - - - HRTime\Unit::MICROSECOND - - - - - - - HRTime\Unit::NANOSECOND - - - - - - -
- - -
- - - -
- diff --git a/reference/hrtime/setup.xml b/reference/hrtime/setup.xml deleted file mode 100644 index 28ff5d93ef..0000000000 --- a/reference/hrtime/setup.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - &reftitle.setup; - - - -
- &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;hrtime. - - -
- - - -
- diff --git a/reference/ibase/book.xml b/reference/ibase/book.xml deleted file mode 100644 index 9655fd02d1..0000000000 --- a/reference/ibase/book.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - Firebird/InterBase - - - - &reftitle.intro; - - - &pecl.info.dead.git; - &url.php.git.mirror;pecl-database-interbase. - - - - Firebird es una base de datos relacional que ofrece la mayoría de las funcionalidades - descritas en la norma ISO SQL-2003, que funciona en entornos Linux, Windows, - y la mayoría de los sistemas Unix. Firebird ofrece una excelente simultaneidad, - alto rendimiento y un lenguaje eficiente para la escritura de procedimientos almacenados y - disparadores. Se utiliza en sistemas de producción desde 1981. - - - Interbase es el nombre de la variante comercial de esta base de datos - creada por Embarcadero/Inprise. Para más información sobre Interbase, vaya a - &url.ibase;. - - - Firebird es un proyecto comercialmente independiente (fundación) de programadores C++, - asesores técnicos, que apoyan el desarrollo y aseguran la - compatibilidad multiplataforma de la base de datos relacional basada en el - código fuente ofrecido por Inprise Corp. (ahora conocido como Embarcadero) - bajo la licencia "InterBase Public License v.1.0 el 25 de julio de 2000". - Para más información sobre Firebird, vaya a &url.firebird;. - - - - &pecl.moved-ver;7.4.0 - - - Esta extensión soporta Interbase versión 6 y posteriores, así como - Firebird versión 2 y posteriores. - - - - - - &reference.ibase.setup; - &reference.ibase.constants; - &reference.ibase.reference; - - - diff --git a/reference/ibase/configure.xml b/reference/ibase/configure.xml deleted file mode 100644 index 9604ba3988..0000000000 --- a/reference/ibase/configure.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - -
- &reftitle.install; - - &pecl.moved-ver;7.4.0 - - - &pecl.info; - &url.git.hub;FirebirdSQL/php-firebird. - - - Para activar el soporte de Firebird/InterBase, es necesario compilar PHP - con la opción - , donde DIR - es el directorio de instalación de Firebird/InterBase (que por omisión es - /usr). - - - Nota para usuarios Win32/Win64 - - &ext.windows.path.dll; - fbclient.dll,gds32.dll - - - Si se instala un servidor Firebird/InterBase en la misma máquina que la que ejecuta PHP, ya se tendrá esta - biblioteca y fbclient.dll,gds32.dll - (gds32.dll se genera desde el instalador) - debería estar ya en su PATH. - - -
- diff --git a/reference/ibase/constants.xml b/reference/ibase/constants.xml deleted file mode 100644 index 98f174f67b..0000000000 --- a/reference/ibase/constants.xml +++ /dev/null @@ -1,645 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - Las constantes siguientes pueden ser pasadas a ibase_trans - para especificar el comportamiento de las transacciones. - - Constantes Firebird/InterBase - - - - Constante - Descripción - - - - - IBASE_DEFAULT - - Define el comportamiento por omisión. Este comportamiento es determinado por la biblioteca cliente, - que es definida como IBASE_WRITE|IBASE_CONCURRENCY|IBASE_WAIT en - la mayoría de los casos. - - - - IBASE_READ - Inicia una transacción en modo de solo lectura - - - IBASE_WRITE - Inicia una transacción en modo de lectura / escritura - - - IBASE_CONSISTENCY - - Inicia una transacción con el nivel de aislamiento definido a - 'consistency', lo que significa que la transacción actual - no puede leer desde tablas que han sido modificadas por otras transacciones. - - - - IBASE_CONCURRENCY - - Inicia una transacción con el nivel de aislamiento definido a - 'concurrency' (o 'snapshot'), lo que significa - que la transacción puede acceder a todas las tablas, pero no puede ver las - modificaciones realizadas por otras transacciones una vez que la transacción - ha comenzado. - - - - IBASE_COMMITTED - - Inicia una transacción con el nivel de aislamiento definido a - 'read committed'. Este flag debe ser asociado con - la constante IBASE_REC_VERSION o - la constante IBASE_REC_NO_VERSION. - Este nivel de aislamiento permite acceder a las modificaciones realizadas - después del inicio de la transacción. Si la constante - IBASE_REC_NO_VERSION es especificada, - solo la última versión de las filas podrá ser leída. - Si la constante IBASE_REC_VERSION es especificada, - una fila puede ser leída siempre que una modificación esté pendiente en - una transacción concurrente. - - - - IBASE_WAIT - - Indica que la transacción puede esperar y luego reintentar cuando aparece un conflicto. - - - - IBASE_NOWAIT - - Indica que la transacción fallará inmediatamente cuando aparece un conflicto. - - - - -
-
- - - Las constantes siguientes pueden ser pasadas a las funciones - ibase_fetch_row, - ibase_fetch_assoc o ibase_fetch_object - para especificar sus comportamientos. - - Constantes Firebird/InterBase - - - - Constante - Descripción - - - - - IBASE_FETCH_BLOBS - - También disponible bajo el nombre IBASE_TEXT por razones de - compatibilidad ascendente. - Permite leer el contenido de un BLOB "inline" en lugar - de recorrerlo utilizando un identificador de BLOB. - - - - IBASE_FETCH_ARRAYS - - Permite leer un array "inline". - De lo contrario, los identificadores de arrays son devueltos. - Los identificadores de arrays solo pueden ser pasados como argumentos - a las consultas INSERT, ya que ninguna función para manejar los identificadores de arrays - está actualmente disponible. - - - - IBASE_UNIXTIME - - Permite devolver los campos de fecha y hora no como strings - sino como timestamps UNIX (el número de segundos desde la época UNIX, que - es el 1-Jan-1970 0:00 UTC). Esto puede ser problemático si se utilizan fechas - anteriores a 1970 en algunos sistemas. - - - - -
-
- - Las constantes siguientes son utilizadas para pasar consultas y opciones a - la API (ibase_server_info, ibase_db_info, - ibase_backup, ibase_restore y - ibase_maintain_db). - Consulte el manual de Firebird/InterBase para más información - sobre el significado de estas opciones. - - - - IBASE_BKP_IGNORE_CHECKSUMS - - - - Opciones para ibase_backup - - - - - - IBASE_BKP_IGNORE_LIMBO - - - - Opciones para ibase_backup - - - - - - IBASE_BKP_METADATA_ONLY - - - - Opciones para ibase_backup - - - - - - IBASE_BKP_NO_GARBAGE_COLLECT - - - - Opciones para ibase_backup - - - - - - IBASE_BKP_OLD_DESCRIPTIONS - - - - Opciones para ibase_backup - - - - - - IBASE_BKP_NON_TRANSPORTABLE - - - - Opciones para ibase_backup - - - - - - IBASE_BKP_CONVERT - - - - Opciones para ibase_backup - - - - - - IBASE_RES_DEACTIVATE_IDX - - - - Opciones para ibase_restore - - - - - - IBASE_RES_NO_SHADOW - - - - Opciones para ibase_restore - - - - - - IBASE_RES_NO_VALIDITY - - - - Opciones para ibase_restore - - - - - - IBASE_RES_ONE_AT_A_TIME - - - - Opciones para ibase_restore - - - - - - IBASE_RES_REPLACE - - - - - - - - - IBASE_RES_CREATE - - - - Opciones para ibase_restore - - - - - - IBASE_RES_USE_ALL_SPACE - - - - Opciones para ibase_restore - - - - - - IBASE_PRP_PAGE_BUFFERS - - - - - - - - - IBASE_PRP_SWEEP_INTERVAL - - - - - - - - - IBASE_PRP_SHUTDOWN_DB - - - - - - - - - IBASE_PRP_DENY_NEW_TRANSACTIONS - - - - - - - - - IBASE_PRP_DENY_NEW_ATTACHMENTS - - - - - - - - - IBASE_PRP_RESERVE_SPACE - - - - - - - - - IBASE_PRP_RES_USE_FULL - - - - - - - - - IBASE_PRP_RES - - - - - - - - - IBASE_PRP_WRITE_MODE - - - - - - - - - IBASE_PRP_WM_ASYNC - - - - - - - - - IBASE_PRP_WM_SYNC - - - - - - - - - IBASE_PRP_ACCESS_MODE - - - - - - - - - IBASE_PRP_AM_READONLY - - - - - - - - - IBASE_PRP_AM_READWRITE - - - - - - - - - IBASE_PRP_SET_SQL_DIALECT - - - - - - - - - IBASE_PRP_ACTIVATE - - - - - - - - - IBASE_PRP_DB_ONLINE - - - - - - - - - IBASE_RPR_CHECK_DB - - - - - - - - - IBASE_RPR_IGNORE_CHECKSUM - - - - - - - - - IBASE_RPR_KILL_SHADOWS - - - - - - - - - IBASE_RPR_MEND_DB - - - - - - - - - IBASE_RPR_VALIDATE_DB - - - - - - - - - IBASE_RPR_FULL - - - - - - - - - IBASE_RPR_SWEEP_DB - - - - Opciones de ibase_maintain_db - - - - - - IBASE_STS_DATA_PAGES - - - - - - - - - IBASE_STS_DB_LOG - - - - - - - - - IBASE_STS_HDR_PAGES - - - - - - - - - IBASE_STS_IDX_PAGES - - - - - - - - - IBASE_STS_SYS_RELATIONS - - - - Opciones de ibase_db_info - - - - - - IBASE_SVC_SERVER_VERSION - - - - Opciones para ibase_server_info - - - - - - IBASE_SVC_IMPLEMENTATION - - - - Opciones para ibase_server_info - - - - - - IBASE_SVC_GET_ENV - - - - Opciones para ibase_server_info - - - - - - IBASE_SVC_GET_ENV_LOCK - - - - - - - - - IBASE_SVC_GET_ENV_MSG - - - - - - - - - IBASE_SVC_USER_DBPATH - - - - - - - - - IBASE_SVC_SVR_DB_INFO - - - - - - - - - IBASE_SVC_GET_USERS - - - - Opciones para ibase_server_info - - - - - -
- - diff --git a/reference/ibase/functions/fbird-add-user.xml b/reference/ibase/functions/fbird-add-user.xml deleted file mode 100644 index 291e443d84..0000000000 --- a/reference/ibase/functions/fbird-add-user.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - fbird_add_user - &Alias; ibase_add_user - - - - &reftitle.description; - - &info.function.alias; - ibase_add_user. - - - - - &reftitle.seealso; - - fbird_modify_user - fbird_delete_user - - - - - diff --git a/reference/ibase/functions/fbird-affected-rows.xml b/reference/ibase/functions/fbird-affected-rows.xml deleted file mode 100644 index 806a13db60..0000000000 --- a/reference/ibase/functions/fbird-affected-rows.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - fbird_affected_rows - &Alias; ibase_affected_rows - - - - &reftitle.description; - - &info.function.alias; - ibase_affected_rows. - - - - - &reftitle.seealso; - - fbird_query - fbird_execute - - - - - diff --git a/reference/ibase/functions/fbird-backup.xml b/reference/ibase/functions/fbird-backup.xml deleted file mode 100644 index fe0030e201..0000000000 --- a/reference/ibase/functions/fbird-backup.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - - - fbird_backup - &Alias; ibase_backup - - - - &reftitle.description; - - &info.function.alias; - ibase_backup. - - - - - diff --git a/reference/ibase/functions/fbird-blob-add.xml b/reference/ibase/functions/fbird-blob-add.xml deleted file mode 100644 index f92bc67f9d..0000000000 --- a/reference/ibase/functions/fbird-blob-add.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - - fbird_blob_add - &Alias; ibase_blob_add - - - - &reftitle.description; - - &info.function.alias; - ibase_blob_add. - - - - - &reftitle.seealso; - - fbird_blob_cancel - fbird_blob_close - fbird_blob_create - fbird_blob_import - - - - - diff --git a/reference/ibase/functions/fbird-blob-cancel.xml b/reference/ibase/functions/fbird-blob-cancel.xml deleted file mode 100644 index 71b338ff81..0000000000 --- a/reference/ibase/functions/fbird-blob-cancel.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - fbird_blob_cancel - Cancela la creación de un blob - - - - &reftitle.description; - - boolfbird_blob_cancel - resourceblob_handle - - - Esta función descartará un BLOB si no ha sido cerrado aún por - fbird_blob_close. - - - - - &reftitle.parameters; - - - blob_handle - - - Un gestor de BLOB abierto con fbird_blob_create. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - fbird_blob_close - fbird_blob_create - fbird_blob_import - - - - - diff --git a/reference/ibase/functions/fbird-blob-close.xml b/reference/ibase/functions/fbird-blob-close.xml deleted file mode 100644 index 63d5a82833..0000000000 --- a/reference/ibase/functions/fbird-blob-close.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - - fbird_blob_close - &Alias; ibase_blob_close - - - - &reftitle.description; - - &info.function.alias; - ibase_blob_close. - - - - - &reftitle.seealso; - - fbird_blob_create - fbird_blob_cancel - fbird_blob_open - fbird_blob_import - - - - - diff --git a/reference/ibase/functions/fbird-blob-create.xml b/reference/ibase/functions/fbird-blob-create.xml deleted file mode 100644 index 73d4c462d3..0000000000 --- a/reference/ibase/functions/fbird-blob-create.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - - fbird_blob_create - &Alias; ibase_blob_create - - - - &reftitle.description; - - &info.function.alias; - ibase_blob_create. - - - - - &reftitle.seealso; - - fbird_blob_add - fbird_blob_cancel - fbird_blob_close - fbird_blob_import - - - - - diff --git a/reference/ibase/functions/fbird-blob-echo.xml b/reference/ibase/functions/fbird-blob-echo.xml deleted file mode 100644 index d0959082c2..0000000000 --- a/reference/ibase/functions/fbird-blob-echo.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - fbird_blob_echo - &Alias; ibase_blob_echo - - - - &reftitle.description; - - &info.function.alias; - ibase_blob_echo. - - - - - &reftitle.seealso; - - fbird_blob_open - fbird_blob_close - fbird_blob_get - - - - - diff --git a/reference/ibase/functions/fbird-blob-get.xml b/reference/ibase/functions/fbird-blob-get.xml deleted file mode 100644 index 22a650fb01..0000000000 --- a/reference/ibase/functions/fbird-blob-get.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - fbird_blob_get - &Alias; ibase_blob_get - - - - &reftitle.description; - - &info.function.alias; - ibase_blob_get. - - - - - &reftitle.seealso; - - fbird_blob_open - fbird_blob_close - fbird_blob_echo - - - - - diff --git a/reference/ibase/functions/fbird-blob-import.xml b/reference/ibase/functions/fbird-blob-import.xml deleted file mode 100644 index 9a314ca045..0000000000 --- a/reference/ibase/functions/fbird-blob-import.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - - fbird_blob_import - &Alias; ibase_blob_import - - - - &reftitle.description; - - &info.function.alias; - ibase_blob_import. - - - - - &reftitle.seealso; - - fbird_blob_add - fbird_blob_cancel - fbird_blob_close - fbird_blob_create - - - - - diff --git a/reference/ibase/functions/fbird-blob-info.xml b/reference/ibase/functions/fbird-blob-info.xml deleted file mode 100644 index f30aef74b0..0000000000 --- a/reference/ibase/functions/fbird-blob-info.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - fbird_blob_info - &Alias; ibase_blob_info - - - - &reftitle.description; - - &info.function.alias; - ibase_blob_info. - - - - - - diff --git a/reference/ibase/functions/fbird-blob-open.xml b/reference/ibase/functions/fbird-blob-open.xml deleted file mode 100644 index a607582d75..0000000000 --- a/reference/ibase/functions/fbird-blob-open.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - fbird_blob_open - &Alias; ibase_blob_open - - - - &reftitle.description; - - &info.function.alias; - ibase_blob_open. - - - - - &reftitle.seealso; - - fbird_blob_close - fbird_blob_echo - fbird_blob_get - - - - - diff --git a/reference/ibase/functions/fbird-close.xml b/reference/ibase/functions/fbird-close.xml deleted file mode 100644 index 13a134aacd..0000000000 --- a/reference/ibase/functions/fbird-close.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - fbird_close - &Alias; ibase_close - - - - &reftitle.description; - - &info.function.alias; - ibase_close. - - - - - &reftitle.seealso; - - fbird_connect - fbird_pconnect - - - - - diff --git a/reference/ibase/functions/fbird-commit-ret.xml b/reference/ibase/functions/fbird-commit-ret.xml deleted file mode 100644 index 0c455421fe..0000000000 --- a/reference/ibase/functions/fbird-commit-ret.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - fbird_commit_ret - &Alias; ibase_commit_ret - - - - &reftitle.description; - - &info.function.alias; - ibase_commit_ret. - - - - - - diff --git a/reference/ibase/functions/fbird-commit.xml b/reference/ibase/functions/fbird-commit.xml deleted file mode 100644 index bc71e6e173..0000000000 --- a/reference/ibase/functions/fbird-commit.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - fbird_commit - &Alias; ibase_commit - - - - &reftitle.description; - - &info.function.alias; - ibase_commit. - - - - - - diff --git a/reference/ibase/functions/fbird-connect.xml b/reference/ibase/functions/fbird-connect.xml deleted file mode 100644 index 195f735ac5..0000000000 --- a/reference/ibase/functions/fbird-connect.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - fbird_connect - &Alias; ibase_connect - - - - &reftitle.description; - - &info.function.alias; - ibase_connect. - - - - - &reftitle.seealso; - - fbird_pconnect - fbird_close - - - - - diff --git a/reference/ibase/functions/fbird-db-info.xml b/reference/ibase/functions/fbird-db-info.xml deleted file mode 100644 index e98063507a..0000000000 --- a/reference/ibase/functions/fbird-db-info.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - fbird_db_info - &Alias; ibase_db_info - - - - &reftitle.description; - - &info.function.alias; - ibase_db_info. - - - - - - diff --git a/reference/ibase/functions/fbird-delete-user.xml b/reference/ibase/functions/fbird-delete-user.xml deleted file mode 100644 index 4c5f31e973..0000000000 --- a/reference/ibase/functions/fbird-delete-user.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - fbird_delete_user - &Alias; ibase_delete_user - - - - &reftitle.description; - - &info.function.alias; - ibase_delete_user. - - - - - &reftitle.seealso; - - fbird_add_user - fbird_modify_user - - - - - diff --git a/reference/ibase/functions/fbird-drop-db.xml b/reference/ibase/functions/fbird-drop-db.xml deleted file mode 100644 index 4819f860c7..0000000000 --- a/reference/ibase/functions/fbird-drop-db.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - fbird_drop_db - &Alias; ibase_drop_db - - - - &reftitle.description; - - &info.function.alias; - ibase_drop_db. - - - - - &reftitle.seealso; - - fbird_connect - fbird_pconnect - - - - - diff --git a/reference/ibase/functions/fbird-errcode.xml b/reference/ibase/functions/fbird-errcode.xml deleted file mode 100644 index 410a4f04e4..0000000000 --- a/reference/ibase/functions/fbird-errcode.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - - fbird_errcode - &Alias; ibase_errcode - - - - &reftitle.description; - - &info.function.alias; - ibase_errcode. - - - - - &reftitle.seealso; - - fbird_errmsg - - - - - diff --git a/reference/ibase/functions/fbird-errmsg.xml b/reference/ibase/functions/fbird-errmsg.xml deleted file mode 100644 index 579c14050f..0000000000 --- a/reference/ibase/functions/fbird-errmsg.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - - fbird_errmsg - &Alias; ibase_errmsg - - - - &reftitle.description; - - &info.function.alias; - ibase_errmsg. - - - - - &reftitle.seealso; - - fbird_errcode - - - - - diff --git a/reference/ibase/functions/fbird-execute.xml b/reference/ibase/functions/fbird-execute.xml deleted file mode 100644 index da8334a59c..0000000000 --- a/reference/ibase/functions/fbird-execute.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - - fbird_execute - &Alias; ibase_execute - - - - &reftitle.description; - - &info.function.alias; - ibase_execute. - - - - - &reftitle.seealso; - - fbird_query - - - - - diff --git a/reference/ibase/functions/fbird-fetch-assoc.xml b/reference/ibase/functions/fbird-fetch-assoc.xml deleted file mode 100644 index bbeb4213dc..0000000000 --- a/reference/ibase/functions/fbird-fetch-assoc.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - fbird_fetch_assoc - &Alias; ibase_fetch_assoc - - - - &reftitle.description; - - &info.function.alias; - ibase_fetch_assoc. - - - - - &reftitle.seealso; - - fbird_fetch_row - fbird_fetch_object - - - - - diff --git a/reference/ibase/functions/fbird-fetch-object.xml b/reference/ibase/functions/fbird-fetch-object.xml deleted file mode 100644 index f6032dd305..0000000000 --- a/reference/ibase/functions/fbird-fetch-object.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - fbird_fetch_object - &Alias; ibase_fetch_object - - - - &reftitle.description; - - &info.function.alias; - ibase_fetch_object. - - - - - &reftitle.seealso; - - fbird_fetch_row - fbird_fetch_assoc - - - - - diff --git a/reference/ibase/functions/fbird-fetch-row.xml b/reference/ibase/functions/fbird-fetch-row.xml deleted file mode 100644 index 3b2264a96d..0000000000 --- a/reference/ibase/functions/fbird-fetch-row.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - fbird_fetch_row - &Alias; ibase_fetch_row - - - - &reftitle.description; - - &info.function.alias; - ibase_fetch_row. - - - - - &reftitle.seealso; - - fbird_fetch_assoc - fbird_fetch_object - - - - - diff --git a/reference/ibase/functions/fbird-field-info.xml b/reference/ibase/functions/fbird-field-info.xml deleted file mode 100644 index 5eb41e0212..0000000000 --- a/reference/ibase/functions/fbird-field-info.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - - fbird_field_info - &Alias; ibase_field_info - - - - &reftitle.description; - - &info.function.alias; - ibase_field_info. - - - - - &reftitle.seealso; - - fbird_num_fields - - - - - diff --git a/reference/ibase/functions/fbird-free-event-handler.xml b/reference/ibase/functions/fbird-free-event-handler.xml deleted file mode 100644 index 373c8f4d1e..0000000000 --- a/reference/ibase/functions/fbird-free-event-handler.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - - fbird_free_event_handler - &Alias; ibase_free_event_handler - - - - &reftitle.description; - - &info.function.alias; - ibase_free_event_handler. - - - - - &reftitle.seealso; - - fbird_set_event_handler - - - - - diff --git a/reference/ibase/functions/fbird-free-query.xml b/reference/ibase/functions/fbird-free-query.xml deleted file mode 100644 index 8f6eff38f1..0000000000 --- a/reference/ibase/functions/fbird-free-query.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - fbird_free_query - &Alias; ibase_free_query - - - - &reftitle.description; - - &info.function.alias; - ibase_free_query. - - - - - - diff --git a/reference/ibase/functions/fbird-free-result.xml b/reference/ibase/functions/fbird-free-result.xml deleted file mode 100644 index 3c80814c14..0000000000 --- a/reference/ibase/functions/fbird-free-result.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - fbird_free_result - &Alias; ibase_free_result - - - - &reftitle.description; - - &info.function.alias; - ibase_free_result. - - - - - - diff --git a/reference/ibase/functions/fbird-gen-id.xml b/reference/ibase/functions/fbird-gen-id.xml deleted file mode 100644 index 11d7490e32..0000000000 --- a/reference/ibase/functions/fbird-gen-id.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - - - - fbird_gen_id - &Alias; ibase_gen_id - - - - &reftitle.description; - - &info.function.alias; - ibase_gen_id. - - - - - - diff --git a/reference/ibase/functions/fbird-maintain-db.xml b/reference/ibase/functions/fbird-maintain-db.xml deleted file mode 100644 index f6f0e60169..0000000000 --- a/reference/ibase/functions/fbird-maintain-db.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - fbird_maintain_db - &Alias; ibase_maintain_db - - - - &reftitle.description; - - &info.function.alias; - ibase_maintain_db. - - - - - - diff --git a/reference/ibase/functions/fbird-modify-user.xml b/reference/ibase/functions/fbird-modify-user.xml deleted file mode 100644 index bf4b4b555b..0000000000 --- a/reference/ibase/functions/fbird-modify-user.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - fbird_modify_user - &Alias; ibase_modify_user - - - - &reftitle.description; - - &info.function.alias; - ibase_modify_user. - - - - - &reftitle.seealso; - - fbird_add_user - fbird_delete_user - - - - - diff --git a/reference/ibase/functions/fbird-name-result.xml b/reference/ibase/functions/fbird-name-result.xml deleted file mode 100644 index 55c95a5dbc..0000000000 --- a/reference/ibase/functions/fbird-name-result.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - fbird_name_result - &Alias; ibase_name_result - - - - &reftitle.description; - - &info.function.alias; - ibase_name_result. - - - - - &reftitle.seealso; - - fbird_prepare - fbird_execute - - - - - diff --git a/reference/ibase/functions/fbird-num-fields.xml b/reference/ibase/functions/fbird-num-fields.xml deleted file mode 100644 index 3c68847b5a..0000000000 --- a/reference/ibase/functions/fbird-num-fields.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - - fbird_num_fields - &Alias; ibase_num_fields - - - - &reftitle.description; - - &info.function.alias; - ibase_num_fields. - - - - - &reftitle.seealso; - - fbird_field_info - - - - - diff --git a/reference/ibase/functions/fbird-num-params.xml b/reference/ibase/functions/fbird-num-params.xml deleted file mode 100644 index 3779231e97..0000000000 --- a/reference/ibase/functions/fbird-num-params.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - fbird_num_params - &Alias; ibase_num_params - - - - &reftitle.description; - - &info.function.alias; - ibase_num_params. - - - - - &reftitle.seealso; - - fbird_prepare - fbird_param_info - - - - - diff --git a/reference/ibase/functions/fbird-param-info.xml b/reference/ibase/functions/fbird-param-info.xml deleted file mode 100644 index 4d4c120870..0000000000 --- a/reference/ibase/functions/fbird-param-info.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - fbird_param_info - &Alias; ibase_param_info - - - - &reftitle.description; - - &info.function.alias; - ibase_param_info. - - - - - &reftitle.seealso; - - fbird_field_info - fbird_num_params - - - - - diff --git a/reference/ibase/functions/fbird-pconnect.xml b/reference/ibase/functions/fbird-pconnect.xml deleted file mode 100644 index 5036775956..0000000000 --- a/reference/ibase/functions/fbird-pconnect.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - fbird_pconnect - &Alias; ibase_pconnect - - - - &reftitle.description; - - &info.function.alias; - ibase_pconnect. - - - - - &reftitle.seealso; - - fbird_close - fbird_connect - - - - - diff --git a/reference/ibase/functions/fbird-prepare.xml b/reference/ibase/functions/fbird-prepare.xml deleted file mode 100644 index 533fa70f2a..0000000000 --- a/reference/ibase/functions/fbird-prepare.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - fbird_prepare - &Alias; ibase_prepare - - - - &reftitle.description; - - &info.function.alias; - ibase_prepare. - - - - - - diff --git a/reference/ibase/functions/fbird-query.xml b/reference/ibase/functions/fbird-query.xml deleted file mode 100644 index 509c38ee84..0000000000 --- a/reference/ibase/functions/fbird-query.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - - fbird_query - &Alias; ibase_query - - - - &reftitle.description; - - &info.function.alias; - ibase_query. - - - - - &reftitle.seealso; - - fbird_errmsg - fbird_fetch_row - fbird_fetch_object - fbird_free_result - - - - - diff --git a/reference/ibase/functions/fbird-restore.xml b/reference/ibase/functions/fbird-restore.xml deleted file mode 100644 index a9c159f4d5..0000000000 --- a/reference/ibase/functions/fbird-restore.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - fbird_restore - &Alias; ibase_restore - - - - &reftitle.description; - - &info.function.alias; - ibase_restore. - - - - - - diff --git a/reference/ibase/functions/fbird-rollback-ret.xml b/reference/ibase/functions/fbird-rollback-ret.xml deleted file mode 100644 index 0484f8f0d1..0000000000 --- a/reference/ibase/functions/fbird-rollback-ret.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - fbird_rollback_ret - &Alias; ibase_rollback_ret - - - - &reftitle.description; - - &info.function.alias; - ibase_rollback_ret. - - - - - - diff --git a/reference/ibase/functions/fbird-rollback.xml b/reference/ibase/functions/fbird-rollback.xml deleted file mode 100644 index 23bf3b5497..0000000000 --- a/reference/ibase/functions/fbird-rollback.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - fbird_rollback - &Alias; ibase_rollback - - - - &reftitle.description; - - &info.function.alias; - ibase_rollback. - - - - - - diff --git a/reference/ibase/functions/fbird-server-info.xml b/reference/ibase/functions/fbird-server-info.xml deleted file mode 100644 index 09aef1ba27..0000000000 --- a/reference/ibase/functions/fbird-server-info.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - fbird_server_info - &Alias; ibase_server_info - - - - &reftitle.description; - - &info.function.alias; - ibase_server_info. - - - - - - diff --git a/reference/ibase/functions/fbird-service-attach.xml b/reference/ibase/functions/fbird-service-attach.xml deleted file mode 100644 index 58e24ca941..0000000000 --- a/reference/ibase/functions/fbird-service-attach.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - fbird_service_attach - &Alias; ibase_service_attach - - - - &reftitle.description; - - &info.function.alias; - ibase_service_attach. - - - - - - diff --git a/reference/ibase/functions/fbird-service-detach.xml b/reference/ibase/functions/fbird-service-detach.xml deleted file mode 100644 index 7a01cddd2c..0000000000 --- a/reference/ibase/functions/fbird-service-detach.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - fbird_service_detach - &Alias; ibase_service_detach - - - - &reftitle.description; - - &info.function.alias; - ibase_service_detach. - - - - - - diff --git a/reference/ibase/functions/fbird-set-event-handler.xml b/reference/ibase/functions/fbird-set-event-handler.xml deleted file mode 100644 index cabd410acf..0000000000 --- a/reference/ibase/functions/fbird-set-event-handler.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - fbird_set_event_handler - &Alias; ibase_set_event_handler - - - - &reftitle.description; - - &info.function.alias; - ibase_set_event_handler. - - - - - &reftitle.seealso; - - fbird_free_event_handler - fbird_wait_event - - - - - diff --git a/reference/ibase/functions/fbird-trans.xml b/reference/ibase/functions/fbird-trans.xml deleted file mode 100644 index 3b6c69c8c3..0000000000 --- a/reference/ibase/functions/fbird-trans.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - fbird_trans - &Alias; ibase_trans - - - - &reftitle.description; - - &info.function.alias; - ibase_trans. - - - - - - diff --git a/reference/ibase/functions/fbird-wait-event.xml b/reference/ibase/functions/fbird-wait-event.xml deleted file mode 100644 index 24c576fd26..0000000000 --- a/reference/ibase/functions/fbird-wait-event.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - fbird_wait_event - &Alias; ibase_wait_event - - - - &reftitle.description; - - &info.function.alias; - ibase_wait_event. - - - - - &reftitle.seealso; - - fbird_set_event_handler - fbird_free_event_handler - - - - - diff --git a/reference/ibase/functions/ibase-add-user.xml b/reference/ibase/functions/ibase-add-user.xml deleted file mode 100644 index b23c6ec8e8..0000000000 --- a/reference/ibase/functions/ibase-add-user.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - ibase_add_user - Añade un usuario a una base de datos de seguridad - - - - &reftitle.description; - - boolibase_add_user - resourceservice_handle - stringuser_name - stringpassword - stringfirst_name - stringmiddle_name - stringlast_name - - - - - &reftitle.parameters; - - - service_handle - - - El gestor sobre el servicio del servidor de la base de datos. - - - - - user_name - - - El identificador para el nuevo usuario de la base de datos. - - - - - password - - - La contraseña para el nuevo usuario. - - - - - first_name - - - El nombre para el nuevo usuario de la base de datos. - - - - - middle_name - - - El segundo nombre para el nuevo usuario de la base de datos. - - - - - last_name - - - El apellido para el nuevo usuario de la base de datos. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - ibase_modify_user - ibase_delete_user - - - - - diff --git a/reference/ibase/functions/ibase-affected-rows.xml b/reference/ibase/functions/ibase-affected-rows.xml deleted file mode 100644 index 1e84937b87..0000000000 --- a/reference/ibase/functions/ibase-affected-rows.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - ibase_affected_rows - Devuelve el número de filas afectadas por la última consulta iBase - - - - &reftitle.description; - - intibase_affected_rows - resourcelink_identifier - - - Devuelve el número de filas que fueron afectadas por la - última consulta (INSERT, UPDATE o DELETE) que fue ejecutada - en el contexto de transacción especificado por - link_identifier. - - - - - &reftitle.parameters; - - - link_identifier - - - Un contexto de transacción. Si link_identifier - es un recurso de conexión, se utiliza la transacción por omisión. - - - - - - - - &reftitle.returnvalues; - - Devuelve el número de filas, en forma de un &integer;. - - - - - &reftitle.seealso; - - ibase_query - ibase_execute - - - - - diff --git a/reference/ibase/functions/ibase-backup.xml b/reference/ibase/functions/ibase-backup.xml deleted file mode 100644 index 38d179bfde..0000000000 --- a/reference/ibase/functions/ibase-backup.xml +++ /dev/null @@ -1,173 +0,0 @@ - - - - - - - ibase_backup - Inicia una tarea de respaldo en el gestor de servicios y devuelve inmediatamente - - - - &reftitle.description; - - mixedibase_backup - resourceservice_handle - stringsource_db - stringdest_file - intoptions0 - boolverbose&false; - - - Esta función transmite los argumentos al servidor de base de datos (remoto). - Allí, comienza un nuevo proceso de respaldo. - Por consiguiente, no se obtendrá ninguna respuesta. - - - - - &reftitle.parameters; - - - service_handle - - - Una conexión al servidor de base de datos creada previamente. - - - - - source_db - - - La ruta absoluta hacia la base de datos en el servidor de base de datos. - También se puede utilizar un alias de base de datos. - - - - - dest_file - - - La ruta absoluta hacia el fichero de respaldo en el servidor de base de datos. - - - - - options - - - Opciones adicionales a transmitir al servidor de base de datos - para el respaldo. - El parámetro options puede ser una combinación - de las siguientes constantes: - IBASE_BKP_IGNORE_CHECKSUMS, - IBASE_BKP_IGNORE_LIMBO, - IBASE_BKP_METADATA_ONLY, - IBASE_BKP_NO_GARBAGE_COLLECT, - IBASE_BKP_OLD_DESCRIPTIONS, - IBASE_BKP_NON_TRANSPORTABLE o - IBASE_BKP_CONVERT. - Leer la sección sobre para - más información. - - - - - verbose - - - Dado que el proceso de respaldo se realiza en el servidor - de base de datos, no se tiene ninguna posibilidad de obtener su salida. - Este argumento es inútil. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - Dado que el proceso de respaldo se realiza en el servidor (remoto), - esta función solo transmite los argumentos. - Mientras los argumentos sean legales, no se obtendrá &false;. - - - - - &reftitle.examples; - - Ejemplo con <function>ibase_backup</function> - - -]]> - - - - - Ejemplo de <function>ibase_backup</function> con argumentos - - -]]> - - - - - - &reftitle.seealso; - - ibase_restore - - - - - diff --git a/reference/ibase/functions/ibase-blob-add.xml b/reference/ibase/functions/ibase-blob-add.xml deleted file mode 100644 index 8a81eb4e24..0000000000 --- a/reference/ibase/functions/ibase-blob-add.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - ibase_blob_add - Añade datos a un BLOB iBase recién creado - - - - &reftitle.description; - - voidibase_blob_add - resourceblob_handle - stringdata - - - ibase_blob_add añade los datos - data al BLOB - blob_handle, creado - con ibase_blob_create. - - - - - &reftitle.parameters; - - - blob_handle - - - Un recurso blob, abierto con la función - ibase_blob_create. - - - - - data - - - Los datos a añadir. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - ibase_blob_cancel - ibase_blob_close - ibase_blob_create - ibase_blob_import - - - - - diff --git a/reference/ibase/functions/ibase-blob-cancel.xml b/reference/ibase/functions/ibase-blob-cancel.xml deleted file mode 100644 index 83f7807128..0000000000 --- a/reference/ibase/functions/ibase-blob-cancel.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - ibase_blob_cancel - Cancela la creación de un BLOB iBase - - - - &reftitle.description; - - boolibase_blob_cancel - resourceblob_handle - - - ibase_blob_cancel cancela la creación del BLOB - blob_handle, creado por - ibase_blob_create si no ha sido cerrado aún - con ibase_blob_close. - - - - - &reftitle.parameters; - - - blob_handle - - - Un recurso blob, abierto con la función - ibase_blob_create. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - ibase_blob_close - ibase_blob_create - ibase_blob_import - - - - - diff --git a/reference/ibase/functions/ibase-blob-close.xml b/reference/ibase/functions/ibase-blob-close.xml deleted file mode 100644 index 8ba15ac1bd..0000000000 --- a/reference/ibase/functions/ibase-blob-close.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - ibase_blob_close - Cierra un BLOB iBase - - - - &reftitle.description; - - mixedibase_blob_close - resourceblob_handle - - - ibase_blob_close cierra el BLOB - blob_handle, abierto en lectura - con ibase_open_blob o en escritura con - ibase_blob_create. - - - - - &reftitle.parameters; - - - blob_handle - - - Un recurso blob, abierto con la función - ibase_blob_create o la función - ibase_blob_open. - - - - - - - - &reftitle.returnvalues; - - Si el BLOB fue leído, ibase_blob_close devuelve &true; - en caso de éxito, si estaba siendo modificado, - ibase_blob_close devuelve un string - que contiene el identificador del BLOB que le fue asignado por la base de datos. - En caso de fallo, esta función devolverá &false;. - - - - - &reftitle.seealso; - - ibase_blob_cancel - ibase_blob_open - - - - - diff --git a/reference/ibase/functions/ibase-blob-create.xml b/reference/ibase/functions/ibase-blob-create.xml deleted file mode 100644 index 60e84d3e1c..0000000000 --- a/reference/ibase/functions/ibase-blob-create.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - ibase_blob_create - Crea un BLOB iBase para añadir datos - - - - &reftitle.description; - - resourcefalseibase_blob_create - resourcelink_identifier&null; - - - ibase_blob_create crea un nuevo BLOB - para llenar con datos, en la conexión InterBase - link_identifier. - - - - - &reftitle.parameters; - - - link_identifier - - - Un identificador de conexión a InterBase. Si se omite, se utilizará la última - conexión abierta. - - - - - - - - &reftitle.returnvalues; - - Devuelve un identificador de BLOB para usar con - ibase_blob_add&return.falseforfailure;. - - - - - &reftitle.seealso; - - ibase_blob_add - ibase_blob_cancel - ibase_blob_close - ibase_blob_import - - - - - diff --git a/reference/ibase/functions/ibase-blob-echo.xml b/reference/ibase/functions/ibase-blob-echo.xml deleted file mode 100644 index 90faa95018..0000000000 --- a/reference/ibase/functions/ibase-blob-echo.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - ibase_blob_echo - Muestra el contenido de un BLOB iBase en el navegador - - - - &reftitle.description; - - boolibase_blob_echo - stringblob_id - - - boolibase_blob_echo - resourcelink_identifier - stringblob_id - - - ibase_blob_echo abre el BLOB - blob_id en lectura y envía su contenido directamente - a la salida estándar (el navegador en la mayoría de los casos). - - - - - &reftitle.parameters; - - - link_identifier - - - Un identificador de conexión a InterBase. Si se omite, se utilizará la última conexión abierta. - - - - - blob_id - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - ibase_blob_open - ibase_blob_close - ibase_blob_get - - - - - diff --git a/reference/ibase/functions/ibase-blob-get.xml b/reference/ibase/functions/ibase-blob-get.xml deleted file mode 100644 index 809064be58..0000000000 --- a/reference/ibase/functions/ibase-blob-get.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - ibase_blob_get - Lee len bytes de datos en un BLOB iBase abierto - - - - &reftitle.description; - - stringibase_blob_get - resourceblob_handle - intlen - - - ibase_blob_get devuelve como máximo len - bytes del BLOB blob_handle - que ha sido abierto en lectura por ibase_blob_open. - - - - No es posible leer en un BLOB abierto en escritura por - ibase_blob_create. - - - - - - &reftitle.parameters; - - - blob_handle - - - Un recurso blob, abierto con la función - ibase_blob_open. - - - - - len - - - El tamaño de los datos devueltos. - - - - - - - - &reftitle.returnvalues; - - Devuelve como máximo, len bytes del BLOB, o - &false; si ocurre un error. - - - - - &reftitle.examples; - - - Ejemplo con <function>ibase_blob_get</function> - -BLOB_VALUE); -$blob_hndl = ibase_blob_open($data->BLOB_VALUE); -echo ibase_blob_get($blob_hndl, $blob_data[0]); -?> -]]> - - - Este ejemplo no hace más que un - ibase_blob_echo( $data->BLOB_VALUE ), pero muestra cómo recuperar la información en una $variable para manipularla como se desee. - - - - - &reftitle.seealso; - - ibase_blob_open - ibase_blob_close - ibase_blob_echo - - - - - diff --git a/reference/ibase/functions/ibase-blob-import.xml b/reference/ibase/functions/ibase-blob-import.xml deleted file mode 100644 index 0a01b99044..0000000000 --- a/reference/ibase/functions/ibase-blob-import.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - ibase_blob_import - Crea un BLOB iBase, copia un fichero y lo cierra - - - - &reftitle.description; - - stringibase_blob_import - resourcelink_identifier - resourcefile_handle - - - stringibase_blob_import - resourcefile_handle - - - ibase_blob_import crea un nuevo BLOB - en la conexión iBase link_identifier, - copia el fichero file_handle en su totalidad, lo cierra y - devuelve el identificador asignado - - - - - &reftitle.parameters; - - - link_identifier - - - Un identificador de conexión a InterBase. Si se omite, se utilizará la última - conexión abierta. - - - - - file_handle - - - El recurso de fichero, devuelto por la función - fopen. - - - - - - - - &reftitle.returnvalues; - - Devuelve el identificador del BLOB en caso de éxito, o &false; - si ocurre un error. - - - - - &reftitle.examples; - - Ejemplo con <function>ibase_blob_import</function> - - -]]> - - - - - - &reftitle.seealso; - - ibase_blob_add - ibase_blob_cancel - ibase_blob_close - ibase_blob_create - - - - - diff --git a/reference/ibase/functions/ibase-blob-info.xml b/reference/ibase/functions/ibase-blob-info.xml deleted file mode 100644 index 79f35b89a7..0000000000 --- a/reference/ibase/functions/ibase-blob-info.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - ibase_blob_info - Devuelve el tamaño de un BLOB iBase y otra información útil - - - - &reftitle.description; - - arrayibase_blob_info - resourcelink_identifier - stringblob_id - - - arrayibase_blob_info - stringblob_id - - - Devuelve el tamaño de un BLOB iBase y otra información útil. - - - - - &reftitle.parameters; - - - link_identifier - - - Un identificador de conexión a InterBase. Si se omite, se utilizará la última conexión abierta. - - - - - blob_id - - - El identificador del BLOB. - - - - - - - - &reftitle.returnvalues; - - Devuelve un array que contiene información sobre el BLOB blob_id. La información incluye el tamaño del BLOB, el número de segmentos que contiene, el tamaño del segmento más grande y si se trata de un BLOB stream o segmentado. - - - - - diff --git a/reference/ibase/functions/ibase-blob-open.xml b/reference/ibase/functions/ibase-blob-open.xml deleted file mode 100644 index d55ac5792e..0000000000 --- a/reference/ibase/functions/ibase-blob-open.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - ibase_blob_open - Abre un BLOB iBase para recuperar partes de datos - - - - &reftitle.description; - - resourcefalseibase_blob_open - resourcelink_identifier - stringblob_id - - - resourcefalseibase_blob_open - stringblob_id - - - Abre un BLOB iBase para recuperar partes de datos. - - - - - &reftitle.parameters; - - - link_identifier - - - Un identificador de conexión a InterBase. Si se omite, se utilizará la última conexión abierta. - - - - - blob_id - - - El identificador del BLOB. - - - - - - - - &reftitle.returnvalues; - - Devuelve un recurso BLOB para su uso con la función - ibase_blob_get&return.falseforfailure;. - - - - - &reftitle.seealso; - - ibase_blob_close - ibase_blob_echo - ibase_blob_get - - - - - diff --git a/reference/ibase/functions/ibase-close.xml b/reference/ibase/functions/ibase-close.xml deleted file mode 100644 index 914cfdfeb6..0000000000 --- a/reference/ibase/functions/ibase-close.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - ibase_close - Cierra una conexión a una base de datos Interbase - - - - &reftitle.description; - - boolibase_close - resourceconnection_id&null; - - - Cierra una conexión a una base de datos Interbase. Esta función toma - como argumento el identificador de conexión connection_id - devuelto por ibase_connect. Las transacciones por omisión - son validadas y las otras son anuladas. - - - - - &reftitle.parameters; - - - connection_id - - - Un identificador de conexión a InterBase, devuelto por la función - ibase_connect. Si es omitido, la última - conexión abierta será utilizada. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - ibase_connect - ibase_pconnect - - - - - diff --git a/reference/ibase/functions/ibase-commit-ret.xml b/reference/ibase/functions/ibase-commit-ret.xml deleted file mode 100644 index 7c7fd93049..0000000000 --- a/reference/ibase/functions/ibase-commit-ret.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - ibase_commit_ret - Valida una transacción iBase sin cerrarla - - - - &reftitle.description; - - boolibase_commit_ret - resourcelink_or_trans_identifier&null; - - - Valida una transacción iBase sin cerrarla. - - - - - &reftitle.parameters; - - - link_or_trans_identifier - - - Llamada sin argumento, - valida la transacción por omisión de la conexión - por omisión. Si el argumento link_or_trans_identifier - es un identificador de conexión, su transacción por omisión - es validada. Si el argumento link_or_trans_identifier es un - identificador de transacción, esta será validada. - El contexto de la transacción será retenido y, por lo tanto, las consultas ejecutadas - en esta transacción no serán invalidadas. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/ibase/functions/ibase-commit.xml b/reference/ibase/functions/ibase-commit.xml deleted file mode 100644 index 3c494c4137..0000000000 --- a/reference/ibase/functions/ibase-commit.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - ibase_commit - Valida una transacción iBase - - - - &reftitle.description; - - boolibase_commit - resourcelink_or_trans_identifier&null; - - - Valida una transacción iBase. - - - - - &reftitle.parameters; - - - link_or_trans_identifier - - - Llamada sin argumento, - valida la transacción por omisión de la conexión - por omisión. Si el argumento link_or_trans_identifier - es un identificador de conexión, su transacción por omisión - es validada. Si el argumento link_or_trans_identifier es un - identificador de transacción, esta será validada. - El contexto de la transacción será retenido y, por lo tanto, las consultas ejecutadas - en esta transacción no serán invalidadas. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/ibase/functions/ibase-connect.xml b/reference/ibase/functions/ibase-connect.xml deleted file mode 100644 index 117f918514..0000000000 --- a/reference/ibase/functions/ibase-connect.xml +++ /dev/null @@ -1,191 +0,0 @@ - - - - - - - ibase_connect - Abre una conexión a una base de datos - - - - &reftitle.description; - - resourceibase_connect - stringdatabase - stringusername - stringpassword - stringcharset - intbuffers - intdialect - stringrole - intsync - - - Abre una conexión a una base de datos Firebird/InterBase. - - - Si se realiza una segunda llamada con ibase_connect, - pasando los mismos argumentos, no se abrirá una nueva conexión, - sino que se devolverá la conexión ya abierta. La conexión - se cerrará cuando el script termine, a menos que se cierre - explícitamente con ibase_close, - durante el script. - - - - - &reftitle.parameters; - - - database - - - database debe ser una ruta - válida hasta un fichero de base de datos en el servidor en - el cual reside. Si el servidor es remoto, debe ser prefijado - con un nombre de host 'hostname:' (TCP/IP), 'hostname/port:' - (TCP/IP con un servidor interbase en un puerto TCP personalizado), '//hostname/' - (NetBEUI) según el protocolo de comunicación utilizado. - - - - - username - - - El nombre de usuario. Puede ser definido con la directiva - ibase.default_user del fichero &php.ini;. - - - - - password - - - La contraseña correspondiente al usuario username. - Puede ser definida con la directiva - ibase.default_password del fichero &php.ini;. - - - - - charset - - - charset es el juego de caracteres por defecto - para la base de datos. - - - - - buffers - - - buffers es el número de buffers de base a - asignar para la caché del servidor. Si se pasa a 0 o - se omite, el servidor lo elegirá por sí mismo. - - - - - dialect - - - dialect - selecciona el dialecto SQL para las consultas ejecutadas - con esta conexión y, por defecto, utiliza el mejor dialecto - disponible. - - - - - role - - - Funciona solo con InterBase 5 y superiores. - - - - - sync - - - - - - - - - - &reftitle.returnvalues; - - Devuelve un identificador de conexión Firebird/InterBase en caso de éxito, - o &false; si ocurre un error. - - - - - &reftitle.errors; - - Si se encuentran errores como "arithmetic exception, numeric overflow, - or string truncation. Cannot transliterate character between character - sets" (esto ocurre cuando se intenta utilizar algunos caracteres acentuados) al - utilizar ibase_connect - y después ibase_query, se debe especificar un juego de caracteres - correcto (i.e. ISO8859_1 o su juego de caracteres actual). - - - - - &reftitle.examples; - - Ejemplo con <function>ibase_connect</function> - -email, "\n"; -} -ibase_free_result($sth); -ibase_close($dbh); -?> -]]> - - - - - - &reftitle.seealso; - - ibase_pconnect - ibase_close - - - - - diff --git a/reference/ibase/functions/ibase-db-info.xml b/reference/ibase/functions/ibase-db-info.xml deleted file mode 100644 index 68bc8e10fa..0000000000 --- a/reference/ibase/functions/ibase-db-info.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - - ibase_db_info - Solicita estadísticas sobre una base de datos Interbase - - - - &reftitle.description; - - stringibase_db_info - resourceservice_handle - stringdb - intaction - intargumento0 - - - &warn.undocumented.func; - - - - - - diff --git a/reference/ibase/functions/ibase-delete-user.xml b/reference/ibase/functions/ibase-delete-user.xml deleted file mode 100644 index 8be803b862..0000000000 --- a/reference/ibase/functions/ibase-delete-user.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - ibase_delete_user - Elimina un usuario de una base de datos de seguridad - - - - &reftitle.description; - - boolibase_delete_user - resourceservice_handle - stringuser_name - - - - - &reftitle.parameters; - - - service_handle - - - El gestor sobre el servicio del servidor de la base de datos. - - - - - user_name - - - El identificador del usuario que debe ser eliminado de la base de datos. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - ibase_add_user - ibase_modify_user - - - - - diff --git a/reference/ibase/functions/ibase-drop-db.xml b/reference/ibase/functions/ibase-drop-db.xml deleted file mode 100644 index 98915664a7..0000000000 --- a/reference/ibase/functions/ibase-drop-db.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - ibase_drop_db - Elimina una base de datos iBase - - - - &reftitle.description; - - boolibase_drop_db - resourceconnection&null; - - - ibase_drop_db elimina una base de datos - que ha sido abierta por ibase_connect - o ibase_pconnect. La base de datos es - cerrada y eliminada del servidor. - - - - - &reftitle.parameters; - - - connection - - - Un identificador de conexión a InterBase. Si se omite, se utilizará la última - conexión abierta. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - ibase_connect - ibase_pconnect - - - - - diff --git a/reference/ibase/functions/ibase-errcode.xml b/reference/ibase/functions/ibase-errcode.xml deleted file mode 100644 index f6bab163aa..0000000000 --- a/reference/ibase/functions/ibase-errcode.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - ibase_errcode - Devuelve el código de error iBase - - - - &reftitle.description; - - intibase_errcode - - - - Devuelve el código de error resultante de la llamada más reciente a una - función InterBase. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el código de error, en forma de un &integer;, o &false; - si no ha ocurrido ningún error. - - - - - &reftitle.seealso; - - ibase_errmsg - - - - - diff --git a/reference/ibase/functions/ibase-errmsg.xml b/reference/ibase/functions/ibase-errmsg.xml deleted file mode 100644 index 59e4340b43..0000000000 --- a/reference/ibase/functions/ibase-errmsg.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - ibase_errmsg - Devuelve un mensaje de error - - - - &reftitle.description; - - stringibase_errmsg - - - - Devuelve una string que contiene los mensajes de error. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el mensaje de error, en forma de string, o false si no ha ocurrido ningún error. - - - - - &reftitle.seealso; - - ibase_errcode - - - - - diff --git a/reference/ibase/functions/ibase-execute.xml b/reference/ibase/functions/ibase-execute.xml deleted file mode 100644 index 5f558c6385..0000000000 --- a/reference/ibase/functions/ibase-execute.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - - ibase_execute - Ejecuta una consulta iBase preparada - - - - &reftitle.description; - - resourceibase_execute - resourcequery - mixedvalues - - - Ejecuta una consulta iBase preparada. - - - ibase_execute es mucho más eficiente que - ibase_query, si se realiza la misma consulta varias veces - cambiando solo algunos argumentos. - - - - - &reftitle.parameters; - - - query - - - Una consulta InterBase, preparada con la función - ibase_prepare. - - - - - values - - - - - - - - - - &reftitle.returnvalues; - - Si la consulta emite un error, la función devolverá &false;. Si la consulta - tiene éxito, y hay un conjunto de resultados (que puede estar vacío), la función - devuelve un identificador de resultados. Si la consulta tiene éxito y no hay - resultados, la función devuelve &true;. - - - - ibase_execute devuelve el número - de registros afectados por la consulta (si es mayor que 0). - Para una consulta que tiene éxito pero que no devuelve ningún registro - (por ejemplo, un UPDATE en un registro inexistente), - ibase_execute devolverá &true;. - - - - - - &reftitle.examples; - - Ejemplo con <function>ibase_execute</function> - - 'Eric', - 5 => 'Filip', - 7 => 'Larry' -); - -$query = ibase_prepare($dbh, "UPDATE FOO SET BAR = ? WHERE BAZ = ?"); - -foreach ($updates as $baz => $bar) { - ibase_execute($query, $bar, $baz); -} - -?> -]]> - - - - - - &reftitle.seealso; - - ibase_query - - - - - diff --git a/reference/ibase/functions/ibase-fetch-assoc.xml b/reference/ibase/functions/ibase-fetch-assoc.xml deleted file mode 100644 index d62e9c53ab..0000000000 --- a/reference/ibase/functions/ibase-fetch-assoc.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - ibase_fetch_assoc - Recupera una fila del resultado de una consulta en un array asociativo - - - - &reftitle.description; - - arrayibase_fetch_assoc - resourceresult - intfetch_flag0 - - - Recupera una fila del resultado de una consulta en un array asociativo. - - - ibase_fetch_assoc recupera una fila - de datos a partir de result. Si - dos o más columnas tienen el mismo nombre de campo, la última - columna tendrá precedencia. Para acceder a las otras - columnas con el mismo nombre, se debe hacer con sus índices numéricos utilizando ibase_fetch_row - o utilizando alias en la consulta. - - - - - &reftitle.parameters; - - - result - - - El conjunto de resultados. - - - - - fetch_flag - - - fetch_flag es una combinación de las constantes - IBASE_TEXT y IBASE_UNIXTIME. - Pasar IBASE_TEXT hace que se devuelva el contenido del BLOB - en lugar del ID del BLOB. Pasar IBASE_UNIXTIME hace que se devuelvan las fechas/horas - en forma de timestamps UNIX en lugar de strings formateados. - - - - - - - - &reftitle.returnvalues; - - Devuelve un array asociativo que corresponde a la fila recuperada. Las - llamadas siguientes devuelven la fila siguiente en el conjunto de resultados, - o &false; si no hay más filas. - - - - - &reftitle.seealso; - - ibase_fetch_row - ibase_fetch_object - - - - - diff --git a/reference/ibase/functions/ibase-fetch-object.xml b/reference/ibase/functions/ibase-fetch-object.xml deleted file mode 100644 index 0135a0a90a..0000000000 --- a/reference/ibase/functions/ibase-fetch-object.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - ibase_fetch_object - Lee una línea en una base Interbase en un objeto - - - - &reftitle.description; - - objectibase_fetch_object - resourceresult_id - intfetch_flag0 - - - Lee una línea en una base Interbase y la coloca en un pseudo objeto. - - - Las siguientes llamadas a la función ibase_fetch_object - devolverán la siguiente línea del conjunto de resultados. - - - - - &reftitle.parameters; - - - result_id - - - Un identificador de resultado InterBase, obtenido ya sea por la función - ibase_query, ya sea por la función - ibase_execute. - - - - - fetch_flag - - - fetch_flag es una combinación de las constantes - IBASE_TEXT y IBASE_UNIXTIME. - Pasar IBASE_TEXT hace que se devuelva el contenido del BLOB - en lugar del ID del BLOB. Pasar IBASE_UNIXTIME - hace que se devuelvan los valores de fecha/hora en forma de timestamps UNIX en lugar de strings formateados. - - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto que contiene la información de la línea, o &false; - si no hay más líneas. - - - - - &reftitle.examples; - - Ejemplo con <function>ibase_fetch_object</function> - -email . "\n"; -} -ibase_close($dbh); -?> -]]> - - - - - - &reftitle.seealso; - - ibase_fetch_row - ibase_fetch_assoc - - - - - diff --git a/reference/ibase/functions/ibase-fetch-row.xml b/reference/ibase/functions/ibase-fetch-row.xml deleted file mode 100644 index abb2309ffe..0000000000 --- a/reference/ibase/functions/ibase-fetch-row.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - ibase_fetch_row - Lee una línea de una base Interbase - - - - &reftitle.description; - - arrayibase_fetch_row - resourceresult_identifier - intfetch_flag0 - - - ibase_fetch_row recupera una línea de datos - desde el conjunto de resultados dado. - - - Las llamadas siguientes a ibase_fetch_row devolverán - la próxima línea en el resultado, o bien &false; si no hay más - líneas. - - - - - &reftitle.parameters; - - - result_identifier - - - Un identificador de resultado InterBase. - - - - - fetch_flag - - - fetch_flag es una combinación de las constantes - IBASE_TEXT y IBASE_UNIXTIME. - Pasar IBASE_TEXT hace que se devuelva el contenido del BLOB - en lugar del ID del BLOB. Pasar IBASE_UNIXTIME hace - que se devuelvan los valores de fecha/hora en forma de timestamps UNIX en lugar de - strings formateadas. - - - - - - - - &reftitle.returnvalues; - - Devuelve un array correspondiente a la línea recuperada, o &false; - si no hay más líneas. Cada columna del resultado se almacena - en una posición del array, comenzando en 0. - - - - - &reftitle.seealso; - - ibase_fetch_assoc - ibase_fetch_object - - - - - diff --git a/reference/ibase/functions/ibase-field-info.xml b/reference/ibase/functions/ibase-field-info.xml deleted file mode 100644 index f3ba950bf2..0000000000 --- a/reference/ibase/functions/ibase-field-info.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - ibase_field_info - Lee la información sobre un campo iBase - - - - &reftitle.description; - - arrayibase_field_info - resourceresult - intfield_number - - - Devuelve un array que contiene la información de un campo, después de - que una consulta de tipo selección haya sido ejecutada. - - - - - &reftitle.parameters; - - - result - - - Un identificador de resultado InterBase. - - - - - field_number - - - Posición del campo. - - - - - - - - &reftitle.returnvalues; - - Devuelve un array que contiene las siguientes claves: name, - alias, relation, - length y type. - - - - - &reftitle.examples; - - Ejemplo con <function>ibase_field_info</function> - - -]]> - - - - - - &reftitle.seealso; - - ibase_num_fields - - - - - diff --git a/reference/ibase/functions/ibase-free-event-handler.xml b/reference/ibase/functions/ibase-free-event-handler.xml deleted file mode 100644 index 791d5ab381..0000000000 --- a/reference/ibase/functions/ibase-free-event-handler.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - ibase_free_event_handler - Libera un gestor de eventos iBase - - - - &reftitle.description; - - boolibase_free_event_handler - resourceevent - - - ibase_free_event_handler anula el gestor de eventos registrado, especificado - por event. La función de retrollamada no será más ejecutada para los eventos que debía - gestionar. - - - - - &reftitle.parameters; - - - event - - - Un recurso de evento, creado por la función - ibase_set_event_handler. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - ibase_set_event_handler - - - - - diff --git a/reference/ibase/functions/ibase-free-query.xml b/reference/ibase/functions/ibase-free-query.xml deleted file mode 100644 index 9c3535987d..0000000000 --- a/reference/ibase/functions/ibase-free-query.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - ibase_free_query - Libera la memoria reservada por una consulta preparada - - - - &reftitle.description; - - boolibase_free_query - resourcequery - - - Libera la memoria reservada por una consulta preparada. - - - - - &reftitle.parameters; - - - query - - - Una consulta preparada con la función - ibase_prepare. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/ibase/functions/ibase-free-result.xml b/reference/ibase/functions/ibase-free-result.xml deleted file mode 100644 index a5fa37ecd1..0000000000 --- a/reference/ibase/functions/ibase-free-result.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - ibase_free_result - Libera un resultado iBase - - - - &reftitle.description; - - boolibase_free_result - resourceresult_identifier - - - Libera un resultado iBase. - - - - - &reftitle.parameters; - - - result_identifier - - - Un conjunto de caracteres, creado por la función - ibase_query o por la función - ibase_execute. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/ibase/functions/ibase-gen-id.xml b/reference/ibase/functions/ibase-gen-id.xml deleted file mode 100644 index 3cd093bdd1..0000000000 --- a/reference/ibase/functions/ibase-gen-id.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - ibase_gen_id - Incrementa el generador dado y devuelve su nuevo valor - - - - &reftitle.description; - - mixedibase_gen_id - stringgenerator - intincrement1 - resourcelink_identifier&null; - - - &warn.undocumented.func; - - - - - &reftitle.returnvalues; - - Devuelve un nuevo valor generado en forma de &integer; o de &string; si el valor es demasiado grande. - - - - - diff --git a/reference/ibase/functions/ibase-maintain-db.xml b/reference/ibase/functions/ibase-maintain-db.xml deleted file mode 100644 index 65c4f44f30..0000000000 --- a/reference/ibase/functions/ibase-maintain-db.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - ibase_maintain_db - Ejecuta un comando de mantenimiento en una base de datos Interbase - - - - &reftitle.description; - - boolibase_maintain_db - resourceservice_handle - stringdb - intaction - intargumento0 - - - &warn.undocumented.func; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/ibase/functions/ibase-modify-user.xml b/reference/ibase/functions/ibase-modify-user.xml deleted file mode 100644 index 8b6db5b38a..0000000000 --- a/reference/ibase/functions/ibase-modify-user.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - ibase_modify_user - Modifica un usuario en una base de datos de seguridad - - - - &reftitle.description; - - boolibase_modify_user - resourceservice_handle - stringuser_name - stringpassword - stringfirst_name - stringmiddle_name - stringlast_name - - - - - &reftitle.parameters; - - - service_handle - - - El gestor sobre el servicio del servidor de base de datos. - - - - - user_name - - - El identificador del usuario de base de datos a modificar. - - - - - password - - - La nueva contraseña del usuario. - - - - - first_name - - - El nuevo nombre del usuario. - - - - - middle_name - - - El nuevo segundo nombre del usuario. - - - - - last_name - - - El nuevo apellido del usuario. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - ibase_add_user - ibase_delete_user - - - - - diff --git a/reference/ibase/functions/ibase-name-result.xml b/reference/ibase/functions/ibase-name-result.xml deleted file mode 100644 index 801e88f76f..0000000000 --- a/reference/ibase/functions/ibase-name-result.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - ibase_name_result - Asigna un nombre a un conjunto de resultados iBase - - - - &reftitle.description; - - boolibase_name_result - resourceresult - stringname - - - Asigna un nombre a un conjunto de resultados. Este nombre puede ser - utilizado más tarde en las consultas de tipo - UPDATE|DELETE ... WHERE CURRENT OF name. - - - - - &reftitle.parameters; - - - result - - - Un conjunto de resultados InterBase. - - - - - name - - - El nombre a asignar. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>ibase_name_result</function> - - -]]> - - - - - - &reftitle.seealso; - - ibase_prepare - ibase_execute - - - - - diff --git a/reference/ibase/functions/ibase-num-fields.xml b/reference/ibase/functions/ibase-num-fields.xml deleted file mode 100644 index dc2f01c480..0000000000 --- a/reference/ibase/functions/ibase-num-fields.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - ibase_num_fields - Devuelve el número de columnas en un resultado iBase - - - - &reftitle.description; - - intibase_num_fields - resourceresult_id - - - Devuelve el número de columnas en un resultado iBase. - - - - - &reftitle.parameters; - - - result_id - - - Un identificador de resultado InterBase. - - - - - - - - &reftitle.returnvalues; - - Devuelve el número de campos, en forma de un &integer;. - - - - - &reftitle.examples; - - Ejemplo con <function>ibase_num_fields</function> - - -]]> - - - - - - &reftitle.seealso; - - ibase_field_info - - - - - diff --git a/reference/ibase/functions/ibase-num-params.xml b/reference/ibase/functions/ibase-num-params.xml deleted file mode 100644 index 209359d80c..0000000000 --- a/reference/ibase/functions/ibase-num-params.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - ibase_num_params - Devuelve el número de parámetros en una consulta preparada iBase - - - - &reftitle.description; - - intibase_num_params - resourcequery - - - ibase_num_params devuelve el número de parámetros - en la consulta especificada - por query. Es el número de argumentos de - sustitución que deben estar presentes al llamar a - ibase_execute. - - - - - &reftitle.parameters; - - - query - - - La consulta preparada. - - - - - - - - &reftitle.returnvalues; - - Devuelve el número de parámetros, en forma de un &integer;. - - - - - &reftitle.seealso; - - ibase_prepare - ibase_param_info - - - - - diff --git a/reference/ibase/functions/ibase-param-info.xml b/reference/ibase/functions/ibase-param-info.xml deleted file mode 100644 index 0cba03633a..0000000000 --- a/reference/ibase/functions/ibase-param-info.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - ibase_param_info - Devuelve información sobre un argumento en una consulta preparada iBase - - - - &reftitle.description; - - arrayibase_param_info - resourcequery - intparam_number - - - Devuelve un array con información sobre un argumento después de que una consulta haya sido preparada. - - - - - &reftitle.parameters; - - - query - - - Un gestor de consulta preparada InterBase. - - - - - param_number - - - La posición del argumento. - - - - - - - - &reftitle.returnvalues; - - Devuelve un array que contiene las siguientes claves: name, - alias, relation, - length y type. - - - - - &reftitle.seealso; - - ibase_field_info - ibase_num_params - - - - - diff --git a/reference/ibase/functions/ibase-pconnect.xml b/reference/ibase/functions/ibase-pconnect.xml deleted file mode 100644 index 0ca058ba3b..0000000000 --- a/reference/ibase/functions/ibase-pconnect.xml +++ /dev/null @@ -1,164 +0,0 @@ - - - - - - - ibase_pconnect - Abre una conexión persistente a una base de datos InterBase - - - - &reftitle.description; - - resourceibase_pconnect - stringdatabase - stringusername - stringpassword - stringcharset - intbuffers - intdialect - stringrole - intsync - - - Abre una conexión persistente a una base de datos InterBase. - - - ibase_pconnect se comporta de manera similar a - ibase_connect, con dos diferencias - principales. - - - La primera es que, al conectar, la función - intentará encontrar una conexión (persistente) ya abierta. - Si la encuentra, esta última será devuelta, en lugar - de una nueva conexión. De lo contrario, se abrirá una nueva conexión. - - - La segunda es que la conexión no se cerrará al final - del script, sino que permanecerá abierta para su uso posterior. - (ibase_close no cerrará una conexión abierta - con ibase_pconnect). Este tipo de enlace se denomina - 'persistente'. - - - - - &reftitle.parameters; - - - database - - - El argumento database debe ser una ruta de acceso válida - al fichero de la base de datos en el servidor donde reside. Si - el servidor no es local, debe estar precedido por 'hostname:' - (TCP/IP), '//hostname/' (NetBEUI) o 'hostname@' (IPX/SPX), según el - protocolo utilizado. - - - - - username - - - El nombre de usuario. Puede ser definido con la directiva - ibase.default_user del &php.ini;. - - - - - password - - - La contraseña para el usuario username. - Puede ser definida con la directiva - ibase.default_password del &php.ini;. - - - - - charset - - - charset es el conjunto de caracteres por omisión para - la base de datos. - - - - - buffers - - - buffers es el número de buffers de la base de datos - que se asignarán para la caché del lado del servidor. Si este parámetro vale 0 o si se omite, el servidor elegirá este número por sí mismo. - - - - - dialect - - - dialect selecciona el dialecto SQL por omisión para - todas las consultas ejecutadas en la conexión, y valdrá por omisión, - el más alto soportado por la biblioteca cliente. Solo funciona con - InterBase 6 y superiores. - - - - - role - - - Solo funciona con InterBase 5 y superiores. - - - - - sync - - - - - - - - - - &reftitle.returnvalues; - - Devuelve un identificador de conexión InterBase en caso de éxito, - o &false; si ocurre un error. - - - - - &reftitle.seealso; - - ibase_close - ibase_connect - - - - - diff --git a/reference/ibase/functions/ibase-prepare.xml b/reference/ibase/functions/ibase-prepare.xml deleted file mode 100644 index 673d5b12f8..0000000000 --- a/reference/ibase/functions/ibase-prepare.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - ibase_prepare - Prepara una consulta iBase para ligar los argumentos y ejecutarla posteriormente - - - - &reftitle.description; - - resourceibase_prepare - stringquery - - - resourceibase_prepare - resourcelink_identifier - stringquery - - - resourceibase_prepare - resourcelink_identifier - stringtrans - stringquery - - - Prepara una consulta para ligar posteriormente los argumentos y ejecutarla (a través de la función ibase_execute). - - - - - &reftitle.parameters; - - - query - - - Una consulta InterBase. - - - - - link_identifier - - - Un enlace identificador InterBase devuelto por - ibase_connect. Si se omite, se adopta el último enlace abierto. - - - - - trans - - - Un gestor de transacción InterBase con el cual la consulta debe ser asociada. - Si se omite, se adopta la transacción por omisión de la conexión. - - - - - - - - &reftitle.returnvalues; - - Devuelve un gestor de consulta preparada, o &false; si ocurre un error. - - - - - diff --git a/reference/ibase/functions/ibase-query.xml b/reference/ibase/functions/ibase-query.xml deleted file mode 100644 index e4fa484ab2..0000000000 --- a/reference/ibase/functions/ibase-query.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - - ibase_query - Ejecuta una consulta en una base iBase - - - - &reftitle.description; - - resourceibase_query - resourcelink_identifier - stringquery - intbind_args - - - Ejecuta una consulta en una base iBase. - - - - - &reftitle.parameters; - - - link_identifier - - - Un identificador de conexión a InterBase. Si se omite, se utilizará la última - conexión abierta. - - - - - query - - - Una consulta InterBase. - - - - - bind_args - - - - - - - - - - &reftitle.returnvalues; - - Si la consulta emite un error, la función devolverá &false;. Si la - consulta se ejecuta con éxito, y hay un conjunto de resultados (incluso - vacío), la función devolverá un identificador de resultado. Si la consulta - se ejecuta con éxito, y no hay resultado, la función devolverá &true;. - - - - En las versiones 5.0.0 de PHP y siguientes, ibase_query - devuelve el número de registros afectados por las consultas INSERT, - UPDATE y DELETE. - Por razones de compatibilidad ascendente, ibase_query - devolverá &true; si la consulta tiene éxito pero no devuelve ningún registro. - - - - - - &reftitle.errors; - - Si se recibe un error del tipo "arithmetic exception, numeric overflow, - or string truncation. Cannot transliterate character between character - sets" (esto ocurre cuando se intenta utilizar caracteres acentuados) con la función ibase_query, - es necesario elegir un juego de caracteres - (i.e. ISO8859_1 o su juego actual). - - - - - &reftitle.examples; - - Ejemplo con <function>ibase_query</function> - - -]]> - - - - - - &reftitle.seealso; - - ibase_errmsg - ibase_fetch_row - ibase_fetch_object - ibase_free_result - - - - - diff --git a/reference/ibase/functions/ibase-restore.xml b/reference/ibase/functions/ibase-restore.xml deleted file mode 100644 index 9b1e95997e..0000000000 --- a/reference/ibase/functions/ibase-restore.xml +++ /dev/null @@ -1,176 +0,0 @@ - - - - - - - ibase_restore - Inicia una tarea de restauración en el gestor de servicios y devuelve inmediatamente - - - - &reftitle.description; - - mixedibase_restore - resourceservice_handle - stringsource_file - stringdest_db - intoptions0 - boolverbose&false; - - - - Esta función transmite los argumentos al servidor de base de datos (remoto). - Allí, comienza un nuevo proceso de restauración. - Por lo tanto, no se obtendrá ninguna respuesta. - - - - - &reftitle.parameters; - - - service_handle - - - Una conexión al servidor de base de datos creada previamente. - - - - - source_file - - - La ruta absoluta en el servidor donde se encuentra el fichero de respaldo. - - - - - dest_db - - - La ruta para crear la nueva base de datos en el servidor. - También se puede utilizar un alias de base de datos. - - - - - options - - - Opciones adicionales a transmitir al servidor de base de datos - para la restauración. - El parámetro options puede ser una combinación - de las siguientes constantes: - IBASE_RES_DEACTIVATE_IDX, - IBASE_RES_NO_SHADOW, - IBASE_RES_NO_VALIDITY, - IBASE_RES_ONE_AT_A_TIME, - IBASE_RES_REPLACE, - IBASE_RES_CREATE, - IBASE_RES_USE_ALL_SPACE, - IBASE_PRP_PAGE_BUFFERS, - IBASE_PRP_SWEEP_INTERVAL, - IBASE_RES_CREATE. - Leer la sección sobre para - más información. - - - - - verbose - - - Dado que el proceso de restauración se realiza en el servidor - de base de datos, no hay posibilidad de obtener su salida. - Este argumento es inútil. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - Dado que el proceso de restauración se realiza en el servidor (remoto), - esta función solo transmite los argumentos. - Mientras los argumentos sean legales, no se obtendrá &false;. - - - - - &reftitle.examples; - - Ejemplo con <function>ibase_restore</function> - - -]]> - - - - - Ejemplo de <function>ibase_restore</function> con argumentos - - -]]> - - - - - - &reftitle.seealso; - - ibase_backup - - - - - diff --git a/reference/ibase/functions/ibase-rollback-ret.xml b/reference/ibase/functions/ibase-rollback-ret.xml deleted file mode 100644 index ccbb8492fa..0000000000 --- a/reference/ibase/functions/ibase-rollback-ret.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - ibase_rollback_ret - Anula una transacción sin cerrarla - - - - &reftitle.description; - - boolibase_rollback_ret - resourcelink_or_trans_identifier&null; - - - Anula una transacción sin cerrarla. - - - - - &reftitle.parameters; - - - link_or_trans_identifier - - - Si ibase_rollback_ret es llamada sin argumento, - anula la transacción por omisión del enlace por omisión. Si el argumento - link_or_trans_identifier es un identificador de conexión, - la transacción por omisión de esta conexión será anulada. - Si el argumento link_or_trans_identifier - es un identificador de transacción, esta será anulada. - El contexto de la transacción será retenido y, por lo tanto, las consultas ejecutadas - en esta transacción no serán invalidadas. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/ibase/functions/ibase-rollback.xml b/reference/ibase/functions/ibase-rollback.xml deleted file mode 100644 index b11291cf1b..0000000000 --- a/reference/ibase/functions/ibase-rollback.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - ibase_rollback - Anula una transacción interBase - - - - &reftitle.description; - - boolibase_rollback - resourcelink_or_trans_identifier&null; - - - Anula una transacción interBase. - - - - - &reftitle.parameters; - - - link_or_trans_identifier - - - Cuando ibase_rollback es llamada sin argumento, - anula la transacción por omisión del enlace por omisión. Si el argumento - link_or_trans_identifier es un identificador de conexión, - la transacción por omisión de dicha conexión será anulada. - Si el argumento link_or_trans_identifier - es un identificador de transacción, esta será anulada. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/ibase/functions/ibase-server-info.xml b/reference/ibase/functions/ibase-server-info.xml deleted file mode 100644 index 711064f657..0000000000 --- a/reference/ibase/functions/ibase-server-info.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - ibase_server_info - Solicita información sobre un servidor de base de datos - - - - &reftitle.description; - - stringibase_server_info - resourceservice_handle - intaction - - - - - &reftitle.parameters; - - - service_handle - - - Una conexión al servidor de base de datos creada previamente. - - - - - action - - - Una constante válida. - - - - - - - - &reftitle.returnvalues; - - Devuelve diferentes tipos dependiendo del contexto. - - - - - &reftitle.examples; - - Ejemplo con <function>ibase_service_attach</function> - - -]]> - - &example.outputs; - - Array - ( - [user_name] => SYSDBA - [first_name] => Sql - [middle_name] => Server - [last_name] => Administrator - [user_id] => 0 - [group_id] => 0 - ) - -) - -Directorio del servidor: /etc/firebird/ -Ruta de bloqueo del servidor: /tmp/firebird/ -Ruta de la biblioteca del servidor: /usr/lib64/firebird/lib/ -Ruta de la base de datos del usuario: /var/lib/firebird/secdb/security3.fdb -Conexiones establecidas: Array -( - [attachments] => 3 - [databases] => 2 - [0] => /srv/firebird/poss.fdb - [1] => /srv/firebird/employees.fdb -) -]]> - - - - - - - diff --git a/reference/ibase/functions/ibase-service-attach.xml b/reference/ibase/functions/ibase-service-attach.xml deleted file mode 100644 index f9a4f2e478..0000000000 --- a/reference/ibase/functions/ibase-service-attach.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - - ibase_service_attach - Conexión al gestor de servicio - - - - &reftitle.description; - - resourcefalseibase_service_attach - stringhost - stringdba_username - stringdba_password - - - - - &reftitle.parameters; - - - host - - - El nombre o la dirección IP del host de la base de datos. - El puerto puede ser definido añadiendo '/' y el número del puerto. - Si no se especifica ningún puerto, se utilizará el puerto 3050. - - - - - dba_username - - - El nombre de cualquier usuario válido. - - - - - dba_password - - - La contraseña del usuario. - - - - - - - - &reftitle.returnvalues; - - Devuelve un identificador de enlace Interbase / Firebird en caso de éxito&return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo con <function>ibase_service_attach</function> - -"; - echo "Implementación del servidor: " . $server_implementation; - } - else { - // Mostrar un mensaje en caso de error - $conn_error = ibase_errmsg(); - die($conn_error); - } - -?> -]]> - - - - - Ejemplo de<function>ibase_service_attach</function> utilizando la sintaxis <literal>hostname/port</literal> - -"; - echo "Implementación del servidor: " . $server_implementation; - } - else { - // Mostrar un mensaje en caso de error - $conn_error = ibase_errmsg(); - die($conn_error); - } - -?> -]]> - - - - - - &reftitle.seealso; - - ibase_service_detach - - - - - diff --git a/reference/ibase/functions/ibase-service-detach.xml b/reference/ibase/functions/ibase-service-detach.xml deleted file mode 100644 index a9e420abec..0000000000 --- a/reference/ibase/functions/ibase-service-detach.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - ibase_service_detach - Desconexión del gestor de servicio - - - - &reftitle.description; - - boolibase_service_detach - resourceservice_handle - - - - - &reftitle.parameters; - - - service_handle - - - Una conexión al servidor de base de datos creada previamente. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>ibase_service_detach</function> - - -]]> - - - - - diff --git a/reference/ibase/functions/ibase-set-event-handler.xml b/reference/ibase/functions/ibase-set-event-handler.xml deleted file mode 100644 index b96b307505..0000000000 --- a/reference/ibase/functions/ibase-set-event-handler.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - - ibase_set_event_handler - Registra una función de retrollamada para un evento interBase - - - - &reftitle.description; - - resourceibase_set_event_handler - callableevent_handler - stringevent_name - stringevent_names - - - resourceibase_set_event_handler - resourceconnection - callableevent_handler - stringevent_name - stringevent_names - - - ibase_set_event_handler registra la función - PHP event_handler como - gestor de eventos para los eventos - especificados. - - - - - &reftitle.parameters; - - - event_handler - - - Función de retrollamada llamada con el nombre del evento y la conexión de recurso como argumentos cuando un evento - especificado es publicado en la base de datos. - - - La función de retrollamada event_handler debe - devolver &false; si el gestor debe ser cancelado. Cualquier otro - valor de retorno es ignorado. - Esta función acepta hasta 15 argumentos de evento. - - - - - event_name - - - El nombre del evento. - - - - - event_names - - - 15 eventos como máximo están permitidos. - - - - - - - - &reftitle.returnvalues; - - El valor devuelto es un recurso de evento. Puede ser - utilizado para liberar el gestor de eventos utilizando - ibase_free_event_handler. - - - - - &reftitle.examples; - - Ejemplo con <function>ibase_set_event_handler</function> - - -]]> - - - - - - &reftitle.seealso; - - ibase_free_event_handler - ibase_wait_event - - - - - diff --git a/reference/ibase/functions/ibase-trans.xml b/reference/ibase/functions/ibase-trans.xml deleted file mode 100644 index 1368e5eb63..0000000000 --- a/reference/ibase/functions/ibase-trans.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - ibase_trans - Prepara una transacción interBase - - - - &reftitle.description; - - resourceibase_trans - inttrans_args - resourcelink_identifier - - - resourceibase_trans - resourcelink_identifier - - - Prepara una transacción interBase. - - - - La primera llamada a ibase_trans devolverá - la transacción por omisión para la conexión actual. Todas las - transacciones iniciadas por ibase_trans - serán anuladas al final de la ejecución del script si no han sido - validadas o anuladas por las funciones ibase_commit - o ibase_rollback respectivamente. - - - - - ibase_trans acepta varios argumentos - trans_args y link_identifier. - Esto permite realizar transacciones en varias conexiones a diferentes - bases de datos, que serán validadas utilizando el algoritmo - 2-phase. Esto significa que se pueden actualizar - varias bases de datos. Esto NO significa que se puedan utilizar - varias bases de datos en una misma consulta. - - - Si se utilizan las transacciones en varias bases de datos, se debe especificar - link_id y transaction_id - en las funciones ibase_query y ibase_prepare. - - - - - - &reftitle.parameters; - - - trans_args - - - trans_args puede ser una combinación de las siguientes constantes: - IBASE_READ, - IBASE_WRITE, - IBASE_COMMITTED, - IBASE_CONSISTENCY, - IBASE_CONCURRENCY, - IBASE_REC_VERSION, - IBASE_REC_NO_VERSION, - IBASE_WAIT y - IBASE_NOWAIT. - - - - - link_identifier - - - Un identificador de conexión a InterBase. Si se omite, se utilizará la última - conexión abierta. - - - - - - - - &reftitle.returnvalues; - - Devuelve un recurso de transacción, o &false; si ocurre un error. - - - - - diff --git a/reference/ibase/functions/ibase-wait-event.xml b/reference/ibase/functions/ibase-wait-event.xml deleted file mode 100644 index a62240c0b2..0000000000 --- a/reference/ibase/functions/ibase-wait-event.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - ibase_wait_event - Espera un evento interBase - - - - &reftitle.description; - - stringibase_wait_event - stringevent_name - stringevent_names - - - stringibase_wait_event - resourceconnection - stringevent_name - stringevent_names - - - ibase_wait_event suspende la ejecución del script - hasta que uno de los eventos especificados sea publicado por la base - de datos. El nombre del evento que ha sido publicado es entonces devuelto. - Esta función acepta hasta 15 argumentos de eventos. - - - - - &reftitle.parameters; - - - event_name - - - El nombre del evento. - - - - - event_names - - - - - - - - - - &reftitle.returnvalues; - - Devuelve el nombre del evento que ha sido publicado. - - - - - &reftitle.seealso; - - ibase_set_event_handler - ibase_free_event_handler - - - - - diff --git a/reference/ibase/ini.xml b/reference/ibase/ini.xml deleted file mode 100644 index 77cb96f9b1..0000000000 --- a/reference/ibase/ini.xml +++ /dev/null @@ -1,235 +0,0 @@ - - - - -
- &reftitle.runtime; - &extension.runtime; - - - &ConfigureOptions; iBase - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - ibase.allow_persistent - "1" - INI_SYSTEM - - - - ibase.max_persistent - "-1" - INI_SYSTEM - - - - ibase.max_links - "-1" - INI_SYSTEM - - - - ibase.default_db - NULL - INI_SYSTEM - - - - ibase.default_user - NULL - INI_ALL - - - - ibase.default_password - NULL - INI_ALL - - - - ibase.default_charset - NULL - INI_ALL - - - - ibase.timestampformat - "%Y-%m-%d %H:%M:%S" - INI_ALL - - - - ibase.dateformat - "%Y-%m-%d" - INI_ALL - - - - ibase.timeformat - "%H:%M:%S" - INI_ALL - - - - -
- &ini.php.constants; -
- - &ini.descriptions.title; - - - - - ibase.allow_persistent - bool - - - - Acepta o no las - conexiones persistentes - a Firebird/Interbase. - - - - - - - ibase.max_persistent - int - - - - El número máximo de conexiones persistentes Firebird/Interbase por proceso. - Las nuevas conexiones con ibase_pconnect - no serán persistentes si se alcanza este número máximo. - - - - - - - ibase.max_links - int - - - - El número máximo de conexiones Firebird/Interbase por proceso, incluyendo las - conexiones persistentes. - - - - - - ibase.default_db - string - - - - El nombre de la base de datos por defecto cuando ibase_[p]connect() es llamado - sin una base de datos específica. Si este valor está definido y el modo seguro - SQL está activado, no se permitirá la conexión a otras bases de datos que no sean esta. - - - - - - ibase.default_user - string - - - - El nombre de usuario utilizado al conectar a la base de datos cuando no se especifica ninguno. - - - - - - - ibase.default_password - string - - - - La contraseña utilizada al conectar a la base de datos cuando no se especifica ninguna. - - - - - - ibase.default_charset - string - - - - El conjunto de caracteres utilizado al conectar a la base de datos cuando no se especifica ninguno. - - - - - - - - - ibase.timestampformat - string - - - - - - - - - ibase.dateformat - string - - - - - - - - - ibase.timeformat - string - - - - Estas directivas se utilizan para definir los formatos de fechas y horas que serán - utilizados cuando las fechas/horas sean devueltas de un conjunto de resultados, o cuando - se procesen argumentos en parámetros de fechas/horas. - - - - - -
- diff --git a/reference/ibase/reference.xml b/reference/ibase/reference.xml deleted file mode 100644 index 2414426427..0000000000 --- a/reference/ibase/reference.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - &Functions; Firebird/InterBase - - &reference.ibase.entities.functions; - - - - diff --git a/reference/ibase/setup.xml b/reference/ibase/setup.xml deleted file mode 100644 index cdbaf28dac..0000000000 --- a/reference/ibase/setup.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - - - &reftitle.setup; - - - &reference.ibase.configure; - - - - &reference.ibase.ini; - - - - - diff --git a/reference/ibm_db2/book.xml b/reference/ibm_db2/book.xml deleted file mode 100644 index 63b07bdbaf..0000000000 --- a/reference/ibm_db2/book.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - - - Funciones IBM DB2, Cloudscape y Apache Derby - IBM DB2 - - - - &reftitle.intro; - - Estas funciones permiten el acceso a IBM DB2 Universal Database, - IBM Cloudscape y Apache Derby que utilizan - DB2 Call Level Interface (CLI). - - - - - &reference.ibm-db2.setup; - &reference.ibm-db2.constants; - &reference.ibm-db2.reference; - - - diff --git a/reference/ibm_db2/configure.xml b/reference/ibm_db2/configure.xml deleted file mode 100644 index 34d00351a0..0000000000 --- a/reference/ibm_db2/configure.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - -
- &reftitle.install; - - Para compilar la extensión ibm_db2, los archivos de encabezado y de biblioteca - de la aplicación de desarrollo de DB2 deben estar presentes en el - sistema. DB2 no los instala por omisión, por lo que podría ser necesario volver - a la instalación de DB2 y añadir esta opción. El cliente de desarrollo de aplicación DB2 - incluye los archivos de encabezado y está disponible libremente - para su descarga desde el sitio de soporte - de la base de datos universal. - - - Si los archivos de encabezado y de biblioteca de la aplicación de - desarrollo de DB2 se añaden en un sistema Linux o Unix donde DB2 ya está instalado, - el comando db2iupdt -e deberá ejecutarse para actualizar los enlaces simbólicos - hacia los archivos de encabezado y de biblioteca de las instancias DB2. - - - ibm_db2 es una extensión &link.pecl;, por lo que se deben seguir - las instrucciones presentes en para - instalar la extensión ibm_db2 para PHP. Ejecute el comando - configure para indicar la ubicación de los archivos - de encabezado y de biblioteca de DB2 de la siguiente manera: - - - - El comando configure toma el valor por omisión de - /opt/IBM/db2/V8.1. - - - Nota para los usuarios de IIS - - Si el controlador ibm_db2 se utiliza con IIS (Microsoft Internet Information Server), - podría ser necesario tomar las siguientes medidas: - - - - Instalar DB2 con el sistema de seguridad extendido. - - - Añadir la ruta hacia el binario PHP a la variable de entorno - PATH del sistema (Por omisión: C:\php\). - - - Crear otra variable de entorno que contenga la ruta hacia el archivo PHP.INI - (p. ej.: PHPRC = C:\php\). - - - Añadir el usuario IUSR_COMPUTERNAME al grupo DB2USERS. - - - -
- diff --git a/reference/ibm_db2/constants.xml b/reference/ibm_db2/constants.xml deleted file mode 100644 index 83d247d57c..0000000000 --- a/reference/ibm_db2/constants.xml +++ /dev/null @@ -1,252 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - - - DB2_BINARY - (int) - - - - Especifica que los datos binarios serán devueltos tal cual. - Este es el modo por defecto. - - - - - - DB2_CONVERT - (int) - - - - Especifica que los datos binarios serán convertidos a hexadecimal y - devueltos como una cadena ASCII. - - - - - - DB2_PASSTHRU - (int) - - - - Especifica que los datos binarios serán convertidos a valor &null;. - - - - - - DB2_SCROLLABLE - (int) - - - - Especifica el cursor flotante para una declaración de recurso. Este - modo permite un acceso aleatorio a las filas del juego de resultados, pero - actualmente, solo es soportado por IBM DB2 Universal Database. - - - - - - DB2_FORWARD_ONLY - (int) - - - - Especifica un cursor de avance único para una declaración de recurso. - Este es el valor por defecto de este tipo de cursor, y es - soportado por todos los servidores de base de datos. - - - - - - DB2_PARAM_IN - (int) - - - - Especifica que la variable PHP debe ser vinculada como un parámetro - ENTRADA para un procedimiento de registro. - - - - - - DB2_PARAM_OUT - (int) - - - - Especifica que la variable PHP debe ser vinculada como un parámetro - SALIDA para un procedimiento de registro. - - - - - - DB2_PARAM_INOUT - (int) - - - - Especifica que la variable PHP debe ser vinculada como un parámetro - ENTRADA/SALIDA para un procedimiento de registro. - - - - - - DB2_PARAM_FILE - (int) - - - - Especifica que la columna debe ser vinculada directamente a un fichero para - entrada. - - - - - - DB2_AUTOCOMMIT_ON - (int) - - - - Especifica que autocommit debe ser activado. - - - - - - DB2_AUTOCOMMIT_OFF - (int) - - - - Especifica que autocommit debe ser desactivado. - - - - - - DB2_DOUBLE - (int) - - - - Especifica que la variable debe ser vinculada a un tipo DOUBLE, FLOAT o REAL. - - - - - - DB2_LONG - (int) - - - - Especifica que la variable debe ser vinculada a un tipo SMALLINT, INTEGER o - BIGINT. - - - - - - DB2_CHAR - (int) - - - - Especifica que la variable debe ser vinculada a un tipo CHAR o VARCHAR - - - - - - DB2_CASE_NATURAL - (int) - - - - Especifica que los nombres de columnas deben ser devueltos en sus casos naturales. - - - - - - DB2_CASE_LOWER - (int) - - - - Especifica que los nombres de columnas deben ser devueltos en minúsculas. - - - - - - DB2_CASE_UPPER - (int) - - - - Especifica que los nombres de columnas deben ser devueltos en mayúsculas. - - - - - - DB2_DEFERRED_PREPARE_ON - (int) - - - - Especifica que la preparación diferida debe ser activada para el recurso de consulta especificado. - - - - - - DB2_DEFERRED_PREPARE_OFF - (int) - - - - Especifica que la preparación diferida debe ser desactivada para el recurso de consulta especificado. - - - - - - - diff --git a/reference/ibm_db2/functions/db2-autocommit.xml b/reference/ibm_db2/functions/db2-autocommit.xml deleted file mode 100644 index 66a98674e8..0000000000 --- a/reference/ibm_db2/functions/db2-autocommit.xml +++ /dev/null @@ -1,182 +0,0 @@ - - - - - - - db2_autocommit - - Devuelve o modifica el estado AUTOCOMMIT de la conexión a la base de datos - - - - &reftitle.description; - - intbooldb2_autocommit - resourceconnection - intvalue - - - - Modifica o lee el comportamiento de AUTOCOMMIT de la conexión especificada. - - - - - &reftitle.parameters; - - - connection - - - Una variable de conexión a una base de datos válida devuelta por - db2_connect o db2_pconnect. - - - - - value - - - Una de las constantes siguientes : - - - DB2_AUTOCOMMIT_OFF - - - Desactiva AUTOCOMMIT. - - - - - DB2_AUTOCOMMIT_ON - - - Activa AUTOCOMMIT. - - - - - - - - - - - &reftitle.returnvalues; - - Cuando db2_autocommit recibe solo - connection como argumento, la función devuelve - un entero representando el estado actual de AUTOCOMMIT de la conexión proporcionada. - Un valor de DB2_AUTOCOMMIT_OFF indica que AUTOCOMMIT - está desactivado, mientras que un valor de DB2_AUTOCOMMIT_ON - indica que AUTOCOMMIT está activado. - - - Cuando db2_autocommit recibe ambos argumentos - connection y autocommit, - la función intenta modificar el estado AUTOCOMMIT al estado - autocommit de la conexión proporcionada. - &return.success; - - - - - &reftitle.examples; - - - Obtención del valor de AUTOCOMMIT para una conexión - - En el siguiente ejemplo, se prueba una conexión que fue inicializada con el estado AUTOCOMMIT - desactivado utilizando la función db2_autocommit. - - - DB2_AUTOCOMMIT_OFF); -$conn = db2_connect($database, $user, $password, $options); -$ac = db2_autocommit($conn); -if ($ac == DB2_AUTOCOMMIT_OFF) { - print "$ac -- AUTOCOMMIT está desactivado."; -} else { - print "$ac -- AUTOCOMMIT está activado."; -} -?> -]]> - - &example.outputs; - - - - - - Modificación del valor de AUTOCOMMIT para una conexión - - En el siguiente ejemplo, se cambia el comportamiento de una conexión que fue previamente inicializada con - el estado AUTOCOMMIT desactivado al activar el estado AUTOCOMMIT. - - - DB2_AUTOCOMMIT_OFF); -$conn = db2_connect($database, $user, $password, $options); - -// Activa AUTOCOMMIT -$rc = db2_autocommit($conn, DB2_AUTOCOMMIT_ON); -if ($rc) { - print "Activación AUTOCOMMIT exitosa.\n"; -} - -// Verificación del estado AUTOCOMMIT -$ac = db2_autocommit($conn); -if ($ac == DB2_AUTOCOMMIT_OFF) { - print "$ac -- AUTOCOMMIT está desactivado."; -} else { - print "$ac -- AUTOCOMMIT está activado."; -} -?> -]]> - - &example.outputs; - - - - - - - - - - &reftitle.seealso; - - db2_connect - db2_pconnect - - - - - diff --git a/reference/ibm_db2/functions/db2-bind-param.xml b/reference/ibm_db2/functions/db2-bind-param.xml deleted file mode 100644 index dfd2294b50..0000000000 --- a/reference/ibm_db2/functions/db2-bind-param.xml +++ /dev/null @@ -1,307 +0,0 @@ - - - - - - - db2_bind_param - - Asocia una variable PHP a un parámetro de una consulta SQL - - - - &reftitle.description; - - booldb2_bind_param - resourcestmt - intparameter_number - stringvariable_name - intparameter_typeDB2_PARAM_IN - intdata_type0 - intprecision-1 - intscale0 - - - - Asocia una variable PHP a un parámetro en la consulta SQL - devuelta por db2_prepare. Esta función permite - mayor control sobre los tipos de los parámetros, los tipos de datos, la - precisión y la escala para el parámetro que al pasarle simplemente una - variable dentro del array de entrada opcional de la función - db2_execute. - - - - - &reftitle.parameters; - - - stmt - - - Una consulta preparada devuelta por db2_prepare. - - - - - parameter_number - - - Especifica la posición del parámetro comenzando en el índice 1 en la - consulta preparada. - - - - - variable_name - - - Una cadena que especifica el nombre de la variable PHP a asociar al - parámetro especificado por parameter_number. - - - - - parameter_type - - - Una constante que especifica si la variable PHP debe ser asociada al - parámetro SQL como parámetro de entrada - (DB2_PARAM_IN), como parámetro de salida - (DB2_PARAM_OUT) o como parámetro que acepta - entradas y salidas (DB2_PARAM_INOUT). - Para evitar un exceso de consumo de memoria, también puede especificarse - DB2_PARAM_FILE para asociar la variable PHP al - nombre del archivo que contiene los datos del objeto grande (BLOB, CLOB o - DBCLOB). - - - - - data_type - - - Una constante que especifica el tipo de datos SQL que la variable PHP - debe ser asociada. El parámetro debe tomar uno de los siguientes valores: - DB2_BINARY, DB2_CHAR, - DB2_DOUBLE o DB2_LONG. - - - - - precision - - - Especifica la precisión con la que la variable debe ser asociada a - la base de datos. Este parámetro también puede ser utilizado para - recuperar valores de salida XML para procedimientos almacenados. - Un valor no negativo especifica el tamaño máximo de los datos XML - que serán recuperados desde la base de datos. Si este parámetro no es - utilizado, se definirá un tamaño por defecto de 1 MB para recuperar - los valores de tipo XML desde el procedimiento almacenado. - - - - - scale - - - Especifica la escala con la que la variable debe ser asociada a la - base de datos. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Asociación de variables PHP a una consulta preparada - - La consulta SQL en el siguiente ejemplo utiliza dos parámetros de entrada - en la sección WHERE. Se llama a db2_bind_param - para asociar dos variables que no han sido declaradas o asignadas - antes de la llamada a db2_bind_param; en este ejemplo, - $lower_limit es asignada antes de ser llamada a - db2_bind_param, pero $upper_limit - es asignada después de la llamada a db2_bind_param. Las - variables deben ser asociadas y, para los parámetros que aceptan entradas, - se les debe asignar un valor antes de llamar a db2_execute. - - - ? AND poids < ?'; -$conn = db2_connect($database, $user, $password); -$stmt = db2_prepare($conn, $sql); - -// Se puede declarar la variable antes de llamar a db2_bind_param() -$lower_limit = 1; - -db2_bind_param($stmt, 1, "lower_limit", DB2_PARAM_IN); -db2_bind_param($stmt, 2, "upper_limit", DB2_PARAM_IN); - -// También se puede declarar la variable después de llamar a db2_bind_param() -$upper_limit = 15.0; - -if (db2_execute($stmt)) { - while ($row = db2_fetch_array($stmt)) { - print "{$row[0]}, {$row[1]}, {$row[2]}\n"; - } -} -?> -]]> - - &example.outputs; - - - - - - Llamada a procedimientos de registro con parámetros IN y OUT - - El procedimiento de registro concorde_animal en el siguiente ejemplo - acepta tres diferentes parámetros: - - - - un parámetro de entrada (IN) que acepta el nombre del primer animal en - entrada - - - - - un parámetro de entrada-salida (INOUT) que acepta el nombre del segundo - animal en entrada y devuelve un &string; TRUE si un - animal en la base de datos coincide con este nombre - - - - - un parámetro de salida (OUT) que devuelve la suma de los pesos de los dos - animales identificados - - - - Además, el procedimiento de registro devuelve un conjunto de resultados - que contiene los animales listados en orden alfabético comenzando con - el animal correspondiente al valor de entrada del primer parámetro y - terminando con el animal correspondiente al valor de entrada del segundo - parámetro. - - - -]]> - - &example.outputs; - - - - - - Inserción de un objeto grande binario (BLOB) directamente desde un archivo - - Los datos para los objetos grandes normalmente se almacenan en archivos, - como documentos XML o archivos de audio. En lugar de leer el archivo - completo en una variable de PHP y luego asociar la variable PHP en la - consulta SQL, se puede evitar cierto sobrecoste de memoria asociando el - archivo directamente al parámetro de entrada de su consulta SQL. El - siguiente ejemplo demuestra cómo asociar un archivo directamente en una - columna BLOB. - - - -]]> - - - - - - - &reftitle.seealso; - - db2_execute - db2_prepare - - - - - diff --git a/reference/ibm_db2/functions/db2-client-info.xml b/reference/ibm_db2/functions/db2-client-info.xml deleted file mode 100644 index 8ca2db6d73..0000000000 --- a/reference/ibm_db2/functions/db2-client-info.xml +++ /dev/null @@ -1,217 +0,0 @@ - - - - - - - db2_client_info - Devuelve un objeto con propiedades que describen el cliente de base de datos DB2 - - - &reftitle.description; - - stdClassfalsedb2_client_info - resourceconnection - - - - Esta función devuelve un objeto con propiedades en solo lectura que - proporcionan información sobre el cliente de base de datos DB2. La tabla - siguiente lista las propiedades del cliente DB2: - - Propiedades del cliente DB2 - - - - Nombre Propiedad - Tipo de retorno - Descripción - - - - - APPL_CODEPAGE - &integer; - La aplicación es un código de página. - - - CONN_CODEPAGE - &integer; - El código de página para la conexión actual. - - - DATA_SOURCE_NAME - &string; - El nombre de la fuente de datos (DSN) utilizado para crear la conexión - actual a la base de datos. - - - DRIVER_NAME - &string; - El nombre de la biblioteca que implementa la especificación - DB2 Call Level Interface (CLI). - - - DRIVER_ODBC_VER - &string; - La versión de ODBC que el cliente DB2 soporta. Esto devuelve una - &string; "MM.mm" donde MM es la versión mayor y - mm es la versión menor. El cliente DB2 siempre devuelve - "03.51". - - - - DRIVER_VER - &string; - La versión del cliente, en la forma de una &string; "MM.mm.uuuu" - donde MM es la versión mayor, mm - es la versión menor y uuuu es la actualización. - Por ejemplo, "08.02.0001" representa la versión mayor 8, la versión - menor 2, y la actualización 1. - - - - ODBC_SQL_CONFORMANCE - &string; - - El nivel de sintaxis soportado por el cliente: - - - MINIMUM - - - Soporta el mínimo de sintaxis SQL de ODBC. - - - - - CORE - - - Soporta el núcleo de sintaxis SQL de ODBC. - - - - - EXTENDED - - - Soporta la sintaxis extendida SQL de ODBC. - - - - - - - - - ODBC_VER - &string; - La versión de ODBC que el administrador de controladores ODBC soporta. - Esto devuelve una &string; "MM.mm.rrrr" donde MM es la - versión mayor, mm es la versión menor y - rrrr es la actualización. El cliente DB2 siempre devuelve - "03.01.0000". - - - - -
-
- -
- - &reftitle.parameters; - - - connection - - - Especifica la conexión cliente DB2 activa. - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto si la llamada es exitosa,&return.falseforfailure; - - - - - &reftitle.examples; - - Ejemplo con <function>db2_client_info</function> - - Para obtener información sobre el cliente, se debe pasar un recurso de conexión - de base de datos válido a la función db2_client_info. - - -DRIVER_NAME ); - echo "DRIVER_VER: "; var_dump( $client->DRIVER_VER ); - echo "DATA_SOURCE_NAME: "; var_dump( $client->DATA_SOURCE_NAME ); - echo "DRIVER_ODBC_VER: "; var_dump( $client->DRIVER_ODBC_VER ); - echo "ODBC_VER: "; var_dump( $client->ODBC_VER ); - echo "ODBC_SQL_CONFORMANCE: "; var_dump( $client->ODBC_SQL_CONFORMANCE ); - echo "APPL_CODEPAGE: "; var_dump( $client->APPL_CODEPAGE ); - echo "CONN_CODEPAGE: "; var_dump( $client->CONN_CODEPAGE ); -} -else { - echo "Error al obtener la información del cliente. - Quizás su conexión a la base de datos era inválida."; -} -db2_close($conn); - -?>]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_server_info - - - -
- diff --git a/reference/ibm_db2/functions/db2-close.xml b/reference/ibm_db2/functions/db2-close.xml deleted file mode 100644 index 4c7a311a4c..0000000000 --- a/reference/ibm_db2/functions/db2-close.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - db2_close - - Cierra una conexión a base de datos - - - - &reftitle.description; - - booldb2_close - resourceconnection - - - - Esta función cierra una conexión cliente DB2 creada con - db2_connect y devuelve el recurso correspondiente - al servidor de base de datos. - - - Si se tratara de cerrar una conexión de cliente DB2 persistente creada con - db2_pconnect, la petición de cierre se ignoraría y la conexión - de cliente DB2 permanecería disponible para la siguiente llamada. - - - - - &reftitle.parameters; - - - connection - - - Especifica la conexión a cliente DB2 activa. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Cierre de una conexión - - El siguiente ejemplo demuestra un intento de cierre exitoso de una conexión - a una base de datos IBM DB2, Cloudscape, o Apache Derby. - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_connect - db2_pclose - db2_pconnect - - - - - diff --git a/reference/ibm_db2/functions/db2-column-privileges.xml b/reference/ibm_db2/functions/db2-column-privileges.xml deleted file mode 100644 index 4f4a9570fc..0000000000 --- a/reference/ibm_db2/functions/db2-column-privileges.xml +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - - db2_column_privileges - - Devuelve un conjunto de resultados que lista las columnas y sus privilegios de una tabla - - - - &reftitle.description; - - resourcedb2_column_privileges - resourceconnection - stringnullqualifier&null; - stringnullschema&null; - stringnulltable_name&null; - stringnullcolumn_name&null; - - - - Devuelve un conjunto de resultados que lista las columnas y sus privilegios de una - tabla. - - - - - &reftitle.parameters; - - - connection - - - Una conexión válida a una base de datos IBM DB2, Cloudscape o - Apache Derby. - - - - - qualifier - - - Un calificador para las bases de datos DB2 que funcionan en - los servidores OS/390 o z/OS. Para otras bases de datos, - pase &null; o una cadena vacía. - - - - - schema - - - El esquema que contiene las tablas. Para coincidir con todos los - esquemas, pase &null; o una cadena vacía. - - - - - table_name - - - El nombre de la tabla. Para obtener todas las tablas en la base de - datos, pase &null; o una cadena vacía. - - - - - column_name - - - El nombre de la columna. Para obtener todas las columnas de la tabla, - pase &null; o una cadena vacía. - - - - - - - &reftitle.returnvalues; - - Devuelve un recurso con el conjunto de resultados que contiene las filas que - describen los privilegios de las columnas que coinciden con los parámetros - especificados. Las filas están compuestas por las siguientes columnas: - - - - - Nombre de la columna - Descripción - - - - - TABLE_CAT - Nombre del catálogo. El valor es &null; si la tabla no posee - catálogo. - - - TABLE_SCHEM - Nombre del esquema. - - - TABLE_NAME - Nombre de la tabla. - - - COLUMN_NAME - Nombre de la columna. - - - GRANTOR - ID de autorización del usuario que concedió el privilegio. - - - GRANTEE - ID de autorización del usuario al que se le concedió el privilegio. - - - PRIVILEGE - El privilegio para la columna. - - - IS_GRANTABLE - Si GRANTEE está permitido para conceder este privilegio a otros - usuarios. - - - - - - - - - &reftitle.seealso; - - db2_columns - db2_foreign_keys - db2_primary_keys - db2_procedure_columns - db2_procedures - db2_special_columns - db2_statistics - db2_table_privileges - db2_tables - - - - diff --git a/reference/ibm_db2/functions/db2-columns.xml b/reference/ibm_db2/functions/db2-columns.xml deleted file mode 100644 index 4f6048e5d3..0000000000 --- a/reference/ibm_db2/functions/db2-columns.xml +++ /dev/null @@ -1,219 +0,0 @@ - - - - - - - db2_columns - - Devuelve un conjunto de resultados que lista las columnas y sus metadatos de una tabla - - - - &reftitle.description; - - resourcedb2_columns - resourceconnection - stringnullqualifier&null; - stringnullschema&null; - stringnulltable_name&null; - stringnullcolumn_name&null; - - - - Devuelve un conjunto de resultados que lista las columnas y sus metadatos de una - tabla. - - - - - &reftitle.parameters; - - - connection - - - Una conexión válida a una base de datos IBM DB2, Cloudscape o - Apache Derby. - - - - - qualifier - - - Un calificador para las bases de datos DB2 que funcionan en - los servidores OS/390 o z/OS. Para otras bases de datos, se debe pasar - &null; o una cadena vacía. - - - - - schema - - - El esquema que contiene las tablas. Para coincidir con todos los - esquemas, se debe pasar '%'. - - - - - table_name - - - El nombre de la tabla. Para obtener todas las tablas en la base de - datos, se debe pasar &null; o una cadena vacía. - - - - - column_name - - - El nombre de la columna. Para obtener todas las columnas de la tabla, - se debe pasar &null; o una cadena vacía. - - - - - - - &reftitle.returnvalues; - - Devuelve un recurso con el conjunto de resultados que contiene las filas que - describen los privilegios de las columnas que coinciden con los parámetros - especificados. Las filas están compuestas por las siguientes columnas: - - - - - Nombre de la columna - Descripción - - - - - TABLE_CAT - Nombre del catálogo. El valor es &null; si la tabla no posee - catálogo. - - - TABLE_SCHEM - Nombre del esquema. - - - TABLE_NAME - Nombre de la tabla. - - - COLUMN_NAME - Nombre de la columna. - - - DATA_TYPE - El tipo de datos SQL para la columna, representado como un - integer. - - - TYPE_NAME - Una cadena que representa el tipo de datos para la columna. - - - COLUMN_SIZE - Un integer que representa el tamaño de la columna. - - - BUFFER_LENGTH - Número máximo de bytes necesarios para almacenar datos de esta - columna. - - - DECIMAL_DIGITS - La escala de la columna o &null; donde la escala no es - aplicable. - - - NUM_PREC_RADIX - Un integer que puede ser 10 (que representa un - tipo de datos numérico exacto), 2 (que representa un - tipo de datos numéricos aproximado) o &null; (que representa un tipo - de datos para el cual la base no es aplicable). - - - NULLABLE - Un integer que representa si la columna puede ser nula o no. - - - REMARKS - Descripción de la columna. - - - COLUMN_DEF - Valor por defecto de la columna. - - - SQL_DATA_TYPE - Un integer que representa el tamaño de la columna. - - - SQL_DATETIME_SUB - Devuelve un integer que representa un código de subtipo - datetime o - &null; si los tipos de datos SQL no aplican. - - - CHAR_OCTET_LENGTH - Tamaño máximo en bytes para los tipos de datos de carácter de la - columna, que coincide con COLUMN_SIZE para un solo byte de datos o - &null; para un tipo de datos que no son caracteres. - - - ORDINAL_POSITION - La posición de la columna comenzando desde 1 en la tabla. - - - IS_NULLABLE - Una cadena cuyo valor es 'YES' significa que la columna es nula y - 'NO' significa que la columna no puede ser nula. - - - - - - - - - &reftitle.seealso; - - db2_column_privileges - db2_foreign_keys - db2_primary_keys - db2_procedure_columns - db2_procedures - db2_special_columns - db2_statistics - db2_table_privileges - db2_tables - - - - diff --git a/reference/ibm_db2/functions/db2-commit.xml b/reference/ibm_db2/functions/db2-commit.xml deleted file mode 100644 index 1b313b25de..0000000000 --- a/reference/ibm_db2/functions/db2-commit.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - - db2_commit - - Confirmar una transacción - - - - &reftitle.description; - - booldb2_commit - resourceconnection - - - - - Confirma una transacción en progreso en la conexión especificada e - inicia una nueva transacción. Las aplicaciones en PHP normalmente confirman las transacciones automáticamente - debido a que el modo AUTOCOMMIT por defecto está activado, por lo que el uso de - db2_commit no es necesario a menos que el modo AUTOCOMMIT - haya sido desactivado en la conexión especificada. - - - - - &reftitle.parameters; - - - connection - - - Es la conexión válida devuelta por - db2_connect o db2_pconnect. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - &reftitle.seealso; - - db2_autocommit - db2_rollback - - - - - diff --git a/reference/ibm_db2/functions/db2-conn-error.xml b/reference/ibm_db2/functions/db2-conn-error.xml deleted file mode 100644 index 7720a6555c..0000000000 --- a/reference/ibm_db2/functions/db2-conn-error.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - - db2_conn_error - - Devuelve un string que contiene el valor de SQLSTATE devuelto por el último intento - de conexión - - - - &reftitle.description; - - stringdb2_conn_error - resourcenullconnection&null; - - - - db2_conn_error devuelve el valor de SQLSTATE - que representa la razón por la cual el último intento de conexión a - la base de datos ha fallado. Cuando db2_connect - devuelve &false; en caso de un intento de conexión fallido, no se debe - pasar ningún argumento a db2_conn_error para obtener el - valor de SQLSTATE. - - - Si por el contrario la conexión fue exitosa pero se ha vuelto inválida con el - tiempo, se puede pasar el argumento de conexión - connection para obtener el valor de SQLSTATE para la - conexión específica. - - - Para entender los valores de SQLSTATE, se puede ingresar el siguiente comando - en el procesador de línea de comandos de DB2: - db2 '? sqlstate-value'. También - se puede llamar a la función db2_conn_errormsg - para obtener un mensaje de error explícito junto con el valor de SQLCODE asociado. - - - - &reftitle.parameters; - - - connection - - - Un recurso de conexión asociado a la conexión que - previamente fue exitosa, pero que se ha vuelto inválida con el tiempo. - - - - - - - &reftitle.returnvalues; - - Devuelve el valor de SQLSTATE resultante de un intento de - conexión fallido. Devuelve un string vacío si no hay error asociado con - el último intento de conexión. - - - - - &reftitle.examples; - - Obtención del valor de SQLSTATE para un intento de conexión fallido - - El siguiente ejemplo muestra cómo devolver un valor de SQLSTATE después de - pasar un argumento inválido a la función - db2_connect. - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_conn_errormsg - db2_connect - db2_stmt_error - db2_stmt_errormsg - - - - - diff --git a/reference/ibm_db2/functions/db2-conn-errormsg.xml b/reference/ibm_db2/functions/db2-conn-errormsg.xml deleted file mode 100644 index c18bed8161..0000000000 --- a/reference/ibm_db2/functions/db2-conn-errormsg.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - db2_conn_errormsg - - Devuelve el último mensaje de error de conexión junto con el valor de SQLCODE - - - - &reftitle.description; - - stringdb2_conn_errormsg - resourcenullconnection&null; - - - - db2_conn_errormsg devuelve un mensaje de error y el - valor de SQLCODE que representa la razón por la cual el último intento - de conexión a la base de datos ha fallado. Cuando - db2_connect devuelve &false; en caso de un intento de - conexión fallido, no se debe pasar ningún argumento a - db2_conn_errormsg para obtener el mensaje de error y - el valor de SQLCODE. - - - Si, por el contrario, la conexión fue exitosa pero se ha vuelto inválida con - el tiempo, puede pasarse el argumento de conexión - connection para obtener el mensaje de error y el valor - de SQLCODE para la conexión específica. - - - - &reftitle.parameters; - - - connection - - - Un recurso de conexión asociado a la conexión que previamente fue - exitosa, pero que se ha vuelto inválida con el tiempo. - - - - - - - &reftitle.returnvalues; - - Devuelve una cadena que contiene el mensaje de error y el valor de SQLCODE - resultante de un intento de conexión fallido. Devuelve una cadena vacía - si no hay error asociado con el último intento de conexión. - - - - - &reftitle.examples; - - Obtención del mensaje de error devuelto por un intento de conexión fallido - - El siguiente ejemplo muestra cómo devolver un mensaje de error junto con - el valor de SQLCODE después de pasar un argumento inválido a la función - db2_connect. - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_conn_error - db2_connect - db2_stmt_error - db2_stmt_errormsg - - - - - diff --git a/reference/ibm_db2/functions/db2-connect.xml b/reference/ibm_db2/functions/db2-connect.xml deleted file mode 100644 index d147f9d86b..0000000000 --- a/reference/ibm_db2/functions/db2-connect.xml +++ /dev/null @@ -1,723 +0,0 @@ - - - - - - db2_connect - - Devuelve una conexión a una base de datos - - - - &reftitle.description; - - resourcefalsedb2_connect - stringdatabase - stringnullusername - stringnullpassword - arrayoptions[] - - - - Crea una nueva conexión a una base de datos IBM DB2 Universal - Database, IBM Cloudscape o Apache Derby. - - - - - &reftitle.parameters; - - - database - - - Para una conexión catalogada de la base de datos, database - representa el alias de la base de datos en el catálogo cliente DB2 - - - Para una conexión no catalogada de la base de datos, database - representa una cadena completa de conexión que está en el formato - siguiente : - DATABASE=database;HOSTNAME=hostname;PORT=port;PROTOCOL=TCPIP;UID=username;PWD=password; - - - Al conectarse a Db2 en IBM i, las llamadas al sistema subyacentes - SQLDriverConnect, - solo aceptan DSN, UID y PWD para la - cadena de conexión. - Como sigue : - DSN=database;UID=username;PWD=password; - - - donde los parámetros representan los siguientes valores : - - - database - - - El nombre de la base de datos. - - - - - hostname - - - La dirección Internet o IP del servidor de base de datos. - - - - - port - - - El puerto TCP/IP en el que la base de datos escucha las - conexiones. - - - - - username - - - El nombre de usuario con el que se conecta a la base de - datos. - - - - - password - - - La contraseña con la que se conecta a la base de - datos. - - - - - - - - - username - - - El nombre de usuario con el que se conecta a la base de - datos. - - - Para las conexiones no catalogadas, debe pasar un valor - &null; o una cadena vacía. - - - - - password - - - La contraseña con la que se conecta a la base de - datos. - - - Para las conexiones no catalogadas, debe pasar un valor - &null; o una cadena vacía. - - - - - options - - - Un array asociativo de opciones de conexión que afectarán el - comportamiento de la conexión, donde los valores de las claves incluyen : - - - autocommit - - - El valor DB2_AUTOCOMMIT_ON activa el autocommit - en esta conexión. - - - El valor DB2_AUTOCOMMIT_OFF desactiva el - autocommit para esta conexión. - - - - - DB2_ATTR_CASE - - - Pasar el valor DB2_CASE_NATURAL especifica que los - nombres de columnas serán devueltos en sus casos naturales. - - - Pasar el valor DB2_CASE_LOWER especifica que los - nombres de columnas serán devueltos en minúsculas. - - - Pasar el valor DB2_CASE_UPPER especifica que los - nombres de columnas serán devueltos en mayúsculas. - - - - - CURSOR - - - Pasar el valor DB2_FORWARD_ONLY especifica un cursor - solo hacia adelante para un recurso de consulta. Este es el tipo de cursor - por defecto y es soportado en todos los servidores de base de datos. - - - Pasar el valor DB2_SCROLLABLE especifica un - cursor desplazable para un recurso de consulta. Este modo permite - un acceso aleatorio a las filas en un conjunto de resultados, pero actualmente, - solo es soportado por la base de datos IBM DB2 Universal. - - - - - - - La siguiente nueva opción está disponible para las versiones ibm_db2 1.7.0 y - posteriores. - - - trustedcontext - - - Pasar el valor DB2_TRUSTED_CONTEXT_ENABLE activa el contexto para este gestor de conexión. Este parámetro no puede ser definido con la función db2_set_option. - - - Esta clave solo funciona si la base de datos está catalogada - (incluso si la base de datos es local), o si se especifica el DSN completo - al crear la conexión. - - - Para catalogar la base de datos, utilice los siguientes comandos : - - db2 catalog tcpip node loopback remote <SERVERNAME> server <SERVICENAME> -db2 catalog database <LOCALDBNAME> as <REMOTEDBNAME> at node loopback -db2 "update dbm cfg using svcename <SERVICENAME>" -db2set DB2COMM=TCPIP - - - - - - Las siguientes nuevas opciones i5/OS están disponibles en las versiones - ibm_db2 1.5.1 y posteriores. - - - i5_lib - - - Un carácter que indica la biblioteca por defecto que será - utilizada para resolver las referencias a los ficheros no calificados. - Esto no es válido si la conexión utiliza un modo de sistema de - nombres. - - - - - i5_naming - - - El valor DB2_I5_NAMING_ON activa el modo sistema de nombres DB2 UDB CLI - iSeries. Los ficheros son calificados utilizando el delimitador barra (/). Los ficheros no calificados son - resueltos utilizando la lista de bibliotecas para el trabajo. - - - El valor DB2_I5_NAMING_OFF desactiva el modo de nombres por defecto de DB2 UDB - CLI, que es la escritura SQL. Los ficheros son calificados utilizando el delimitador punto (.). Los ficheros - no calificados son resueltos utilizando la biblioteca por defecto o el ID del usuario actual. - - - - - i5_commit - - - El atributo i5_commit debe ser fijado antes - de la llamada a db2_connect. Si el valor es - cambiado después de que la conexión haya sido establecida y la conexión - es a una fuente de datos remota, el cambio solo tendrá efecto en la próxima - llamada a db2_connect. - - - - La configuración php.ini ibm_db2.i5_allow_commit==0 - o DB2_I5_TXN_NO_COMMIT es por defecto, pero - puede ser derivada con la opción i5_commit. - - - - DB2_I5_TXN_NO_COMMIT : no se utiliza el control de envío. - - - DB2_I5_TXN_READ_UNCOMMITTED : lectura antigua, - lectura no repetitiva y ficticia es posible. - - - DB2_I5_TXN_READ_COMMITTED : lectura antigua no - posible. La lectura repetitiva y ficticia es posible. - - - DB2_I5_TXN_REPEATABLE_READ : lectura antigua y - no repetitiva no es posible. Lectura ficticia es posible. - - - DB2_I5_TXN_SERIALIZABLE : las transacciones son - serializadas. Lectura antigua, no repetitiva y ficticia no es - posible. - - - - - i5_query_optimize - - - DB2_FIRST_IO Todas las consultas son - optimizadas con el objetivo de devolver la primera página tan rápido - como sea posible. Este objetivo funciona bien cuando la visualización es - controlada por un usuario que puede cancelar una consulta después - de ver la primera página de los datos. Las consultas son codificadas - con una cláusula "OPTIMIZE nnn ROWS" para - cumplir el objetivo especificado por la cláusula. - - - DB2_ALL_IO Todas las consultas son optimizadas - con el objetivo de devolver la consulta completa en el menor - intervalo de tiempo. Esta es una buena opción cuando la visualización - de una consulta está siendo escrita hacia un fichero o un informe o - cuando la interfaz pone en cola los datos. Las consultas son codificadas - con una cláusula "OPTIMIZE FOR nnn ROWS" para - cumplir el objetivo especificado por la cláusula. Esta es la operación por - defecto. - - - - - i5_dbcs_alloc - - - El valor DB2_I5_DBCS_ALLOC_ON activa el esquema - de asignación DB2 6X para el incremento de los tamaños de columnas. - - - El valor DB2_I5_DBCS_ALLOC_OFF desactiva el - esquema de asignación DB2 6X para el incremento de los tamaños de columnas. - - - Nota : la configuración &php.ini; - ibm_db2.i5_dbcs_alloc==0 o - DB2_I5_DBCS_ALLOC_OFF es por defecto pero puede - ser derivada con la opción i5_dbcs_alloc. - - - - - i5_date_fmt - - - DB2_I5_FMT_ISO : se utiliza el formato de fecha de la organización internacional de - normalización (ISO) "yyyy-mm-dd". Este es el valor por - defecto. - - - DB2_I5_FMT_USA : se utiliza el formato de fecha de - los Estados Unidos "mm/dd/yyyy". - - - DB2_I5_FMT_EUR : se utiliza el formato de fecha Europeo - "dd.mm.yyyy". - - - DB2_I5_FMT_JIS : se utiliza el formato de fecha de - la industria japonesa de estándares "yyyy-mm-dd". - - - DB2_I5_FMT_MDY : se utiliza el formato de fecha "mm/dd/yyyy". - - - DB2_I5_FMT_DMY : se utiliza el formato de fecha "dd/mm/yyyy". - - - DB2_I5_FMT_YMD : se utiliza el formato de fecha "yy/mm/dd". - - - DB2_I5_FMT_JUL : se utiliza el formato de fecha Juliano "yy/ddd". - - - DB2_I5_FMT_JOB : se utiliza el valor por defecto. - - - - - i5_date_sep - - - DB2_I5_SEP_SLASH : se utiliza una barra ( / ) como - separador de fecha. - Este es el valor por defecto. - - - DB2_I5_SEP_DASH : se utiliza un guión ( - ) como - separador de fecha. - - - DB2_I5_SEP_PERIOD : se utiliza un punto ( . ) como - separador de fecha. - - - DB2_I5_SEP_COMMA : se utiliza una coma ( , ) como - separador de fecha. - - - DB2_I5_SEP_BLANK : se utiliza un espacio en blanco como - separador de fecha. - - - DB2_I5_SEP_JOB : se utiliza el valor por defecto. - - - - - i5_time_fmt - - - DB2_I5_FMT_ISO : se utiliza el formato de hora de - la organización internacional de normalización "hh.mm.ss". Este es el valor por - defecto. - - - DB2_I5_FMT_USA : se utiliza el formato de hora de - los Estados Unidos "hh:mmxx", donde "xx" - vale "AM" o "PM". - - - DB2_I5_FMT_EUR : se utiliza el formato de hora Europeo - "hh.mm.ss". - - - DB2_I5_FMT_JIS : se utiliza el formato de hora de - la industria japonesa de estándares "hh:mm:ss". - - - DB2_I5_FMT_HMS : se utiliza el formato "hh:mm:ss". - - - - - i5_time_sep - - - DB2_I5_SEP_COLON : se utiliza un dos puntos ( : ) como - separador de tiempo. Este es el valor por defecto. - - - DB2_I5_SEP_PERIOD : se utiliza un punto ( . ) como - separador de tiempo. - - - DB2_I5_SEP_COMMA : se utiliza una coma ( , ) como - separador de tiempo. - - - DB2_I5_SEP_BLANK : se utiliza un espacio en blanco como - separador de tiempo. - - - DB2_I5_SEP_JOB : se utiliza el valor por defecto. - - - - - i5_decimal_sep - - - DB2_I5_SEP_PERIOD : se utiliza un punto ( . ) como - separador decimal. Este es el valor por defecto. - - - DB2_I5_SEP_COMMA : se utiliza una coma ( , ) como - separador decimal. - - - DB2_I5_SEP_JOB : se utiliza el valor por defecto. - - - - - - - La siguiente nueva opción i5/OS está disponible desde la versión ibm_db2 - 1.8.0 y posteriores. - - - i5_libl - - - Una cadena que indica la lista a utilizar para resolver las referencias - de ficheros no calificados. Especifique la lista separando los - valores con un espacio, como sigue : 'i5_libl'=>"MYLIB YOURLIB ANYLIB". - - - - i5_libl llama a qsys2/qcmdexc('cmd',cmdlen), - que solo está disponible desde i5/OS V5R4. - - - - - - - - - - - - &reftitle.returnvalues; - - Devuelve el recurso de conexión si la tentativa de conexión tiene éxito. Si - la tentativa de conexión falla, db2_connect devuelve - &false;. - - - - - &reftitle.examples; - - - Creación de una conexión catalogada - - Las conexiones catalogadas requieren que haya catalogado previamente la base de datos - especificada utilizando el procesador de línea de comandos DB2 ("Command Line Processor" : cLP) o con el asistente de configuración de DB2. - - - -]]> - - &example.outputs; - - - - - - Creación de una conexión no catalogada - - Una conexión no catalogada permite conectarse dinámicamente - a una base de datos. - - - -]]> - - &example.outputs; - - - - - - Creación de una conexión con autocommit desactivado por defecto - - Pasar un array de opciones a db2_connect - permite modificar el comportamiento por defecto de la conexión. - - - DB2_AUTOCOMMIT_OFF); - -$conn = db2_connect($database, $user, $password, $options); - -if ($conn) { - echo "Conexión exitosa.\n"; - if (db2_autocommit($conn)) { - echo "Autocommit está activado.\n"; - } - else { - echo "Autocommit está desactivado.\n"; - } - db2_close($conn); -} -else { - echo "Conexión fallida."; -} -?> -]]> - - &example.outputs; - - - - - - - Mejor rendimiento i5/OS - - Para lograr utilizar el mejor rendimiento de su i5/OS ibm_db2 - 1.5.1, la aplicación PHP utiliza el host por defecto, el userid y la contraseña para su db2_connect. - - -"qsys2")); - $result = db2_exec($i5, - "select * from systables where table_schema = '$library'"); - while ($row = db2_fetch_both($result)) { - echo $row['TABLE_NAME']."
"; - } - db2_close($i5); -?> -]]> -
- &example.outputs; - - - -
- - Utilización del contexto - - El siguiente ejemplo muestra cómo activar el contexto, cambiar de usuario - y recuperar el ID del usuario actual. - - - DB2_TRUSTED_CONTEXT_ENABLE); - -$tc_conn = db2_connect($dsn, "", "", $options); -if($tc_conn) { - echo "Conexión de confianza explícita exitosa.\n"; - - if(db2_get_option($tc_conn, "trustedcontext")) { - $userBefore = db2_get_option($tc_conn, "trusted_user"); - - //Código como usuario 1. - - //Cambio al usuario de confianza. - $parameters = array("trusted_user" => $tc_user, - "trusted_password" => $tcuser_pass); - $res = db2_set_option ($tc_conn, $parameters, 1); - - $userAfter = db2_get_option($tc_conn, "trusted_user"); - //Código como usuario de confianza. - - if($userBefore != $userAfter) { - echo "El usuario ha cambiado." . "\n"; - } - } - - db2_close($tc_conn); -} -else { - echo "El cambio de contexto de conexión ha fallado.\n"; -} -?> - -]]> - - &example.outputs; - - - - -
-
- - - &reftitle.seealso; - - db2_close - db2_pconnect - - - -
- diff --git a/reference/ibm_db2/functions/db2-cursor-type.xml b/reference/ibm_db2/functions/db2-cursor-type.xml deleted file mode 100644 index d05fc457b8..0000000000 --- a/reference/ibm_db2/functions/db2-cursor-type.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - db2_cursor_type - - Devuelve el tipo de cursor utilizado por un recurso - - - - &reftitle.description; - - intdb2_cursor_type - resourcestmt - - - - Devuelve el tipo de cursor utilizado por un recurso. Utilice esta - función para determinar si se trabaja con un cursor de avance solo o un cursor flotante. - - - - - &reftitle.parameters; - - - stmt - - - Un recurso válido. - - - - - - - &reftitle.returnvalues; - - Devuelve DB2_FORWARD_ONLY si el recurso utiliza un - cursor de avance solo o DB2_SCROLLABLE si el recurso - utiliza un cursor flotante. - - - - - &reftitle.seealso; - - db2_prepare - - - - diff --git a/reference/ibm_db2/functions/db2-escape-string.xml b/reference/ibm_db2/functions/db2-escape-string.xml deleted file mode 100644 index 3a725b7153..0000000000 --- a/reference/ibm_db2/functions/db2-escape-string.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - db2_escape_string - - Escapar ciertos caracteres especiales - - - - - &reftitle.description; - - stringdb2_escape_string - stringstring_literal - - - Agrega un caracter de escape (barra invertida) antes de cada caracter especial de la cadena enviada como parámetro. - - - - - &reftitle.parameters; - - - string_literal - - - La cadena que contiene los caracteres especiales y que necesita ser escapada. - Los caracteres especiales a los que se les agrega el caracter de escape son \x00, - \n, \r, \, - ', " y \x1a. - - - - - - - - &reftitle.returnvalues; - - Devuelve string_literal con todos los caracteres especiales ya escapados. - - - - - &reftitle.examples; - - Ejemplo de <function>db2_escape_string</function> - - Resultado del uso de la función db2_escape_string - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_prepare - - - - - diff --git a/reference/ibm_db2/functions/db2-exec.xml b/reference/ibm_db2/functions/db2-exec.xml deleted file mode 100644 index fc1a6f306c..0000000000 --- a/reference/ibm_db2/functions/db2-exec.xml +++ /dev/null @@ -1,376 +0,0 @@ - - - - - - - db2_exec - - Ejecuta una consulta SQL directamente - - - - &reftitle.description; - - resourcefalsedb2_exec - resourceconnection - stringstatement - arrayoptions[] - - - - Ejecuta una consulta SQL directamente. - - - Si se prevé insertar variables PHP en la consulta SQL, debe entenderse que - esto es una de las fallas de seguridad más comunes. Se recomienda llamar a la - función db2_prepare para preparar una consulta SQL que - contenga marcadores para variables de entrada. Posteriormente, puede llamarse - a la función db2_execute para pasar los valores de - entrada y así evitar ataques por inyección SQL. - - - Si se prevé llamar repetidamente a la misma consulta SQL con diferentes - parámetros, se recomienda utilizar las funciones db2_prepare - y db2_execute para permitir que el servidor de base de - datos reutilice su plan de acceso y así mejorar la eficiencia del acceso a la - base de datos. - - - - - &reftitle.parameters; - - - connection - - - Una variable de tipo resource de conexión válida devuelta por - db2_connect o db2_pconnect. - - - - - statement - - - Una consulta SQL. La consulta no puede contener marcadores. - - - - - options - - - Un array asociativo que contiene las opciones de la consulta. Este - parámetro puede utilizarse para solicitar un cursor flotante en los - servidores de base de datos que soportan esta funcionalidad. - - - Para obtener una descripción de las opciones válidas, consulte la - función db2_set_option. - - - - - - - &reftitle.returnvalues; - - Devuelve una variable de tipo resource si la consulta SQL fue enviada - correctamente o &false; si la base de datos no pudo ejecutar la consulta SQL. - - - - - &reftitle.examples; - - - Creación de una tabla con <function>db2_exec</function> - - El siguiente ejemplo utiliza la función db2_exec para - enviar un conjunto de consultas DDL con el fin de crear una tabla. - - - -]]> - - &example.outputs; - - - - - - - Ejecución de una consulta SELECT con un cursor flotante - - El siguiente ejemplo muestra cómo solicitar un cursor flotante para una - consulta SQL enviada con la función db2_exec. - - - DB2_SCROLLABLE)); - while ($row = db2_fetch_array($stmt)) { - print "$row[0]\n"; - } -} -?> -]]> - - &example.outputs; - - - - - - Devuelve datos XML como ResultSet SQL - - El siguiente ejemplo demuestra cómo utilizar documentos almacenados - en una columna XML utilizando la base de datos SAMPLE. Mediante un simple - SQL/XML, este ejemplo devuelve algunos nodos en un documento XML en un - formato ResultSet SQL con el que la mayoría de los usuarios están - familiarizados. - - -CID $row->NAME $row->PHONE\n"); -} -db2_close($conn); - -?> -]]> - - &example.outputs; - - - - - - Ejecutar un "JOIN" con datos XML - - El siguiente ejemplo trabaja con documentos almacenados en dos columnas - diferentes en la base de datos SAMPLE. Esto crea dos tablas temporales - provenientes de los documentos XML de dos columnas XML diferentes y - devuelve un ResultSet SQL con la información que contiene el estado de - envío para un cliente. - - -CID $row->NAME $row->PHONE $row->PONUM $row->STATUS\n"); -} - -db2_close($conn); - -?> -]]> - - &example.outputs; - - - - - - Devuelve datos SQL que forman parte de un documento XML grande - - El siguiente ejemplo utiliza una porción de los documentos de - PRODUCT.DESCRIPTION en la base de datos SAMPLE. Esto crea un documento - XML que contiene la descripción del producto (datos XML) y la información - sobre el precio (datos SQL). - - - { - for $prod in $doc/product - where $prod/description/price < 10.00 - order by $prod/description/price ascending - return( - { - $prod, - {$start} , - {$end} , - {$promo} - } - ) - } -\' passing by ref DESCRIPTION AS "doc", -PROMOSTART as "start", -PROMOEND as "end", -PROMOPRICE as "promo" -RETURNING SEQUENCE) -AS CLOB (32000)) -AS NEW_PRODUCT_INFO -FROM PRODUCT -WHERE PID = \'100-100-01\' -'; - -$stmt = db2_exec($conn, $query); - -while($row = db2_fetch_array($stmt)){ - printf("$row[0]\n"); -} -db2_close($conn); - -?> -]]> - - &example.outputs; - - - - - - Snow Shovel, Basic 22 inch -
Basic Snow Shovel, 22 inches wide, straight handle with D-Grip
- 9.99 - 1 kg -
-
- 2004-11-19 - 2004-12-19 - 7.25 -
- -]]> -
-
-
-
- - - &reftitle.seealso; - - db2_execute - db2_prepare - - - -
- diff --git a/reference/ibm_db2/functions/db2-execute.xml b/reference/ibm_db2/functions/db2-execute.xml deleted file mode 100644 index b7c402db60..0000000000 --- a/reference/ibm_db2/functions/db2-execute.xml +++ /dev/null @@ -1,371 +0,0 @@ - - - - - - - db2_execute - - Ejecuta una consulta SQL preparada - - - - &reftitle.description; - - booldb2_execute - resourcestmt - arrayparameters[] - - - - db2_execute ejecuta una consulta SQL que ha sido - preparada por db2_prepare. - - - Si la consulta SQL devuelve un conjunto de resultados, por ejemplo, una consulta - SELECT o CALL a un procedimiento de registro devuelve uno o - varios conjuntos de resultados, puede recuperar una fila como un array a partir de la - recurso stmt utilizando - db2_fetch_assoc, - db2_fetch_both o - db2_fetch_array. Alternativamente, puede utilizar - db2_fetch_row para mover el puntero a - la fila siguiente y recuperar una columna a la vez de esta fila con la - función db2_result. - - - Consúltese db2_prepare para una breve discusión - sobre las ventajas de utilizar db2_prepare y - db2_execute en lugar de db2_exec. - - - - - &reftitle.parameters; - - - stmt - - - Una consulta preparada devuelta por db2_prepare. - - - - - parameters - - - Un array de parámetros de entrada que contiene los marcadores de - variables contenidos en la consulta preparada. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Preparación y ejecución de una consulta SQL con marcadores - - El siguiente ejemplo prepara una consulta INSERT que acepta cuatro - marcadores, luego itera sobre el array que contiene los valores de entrada - que será pasado a la función db2_execute. - - - -]]> - - &example.outputs; - - - - - - Llamada a un procedimiento de registro con un parámetro de SALIDA - - El siguiente ejemplo prepara una consulta CALL que acepta un marcador que - representa un parámetro de SALIDA, vincula la variable PHP $my_pets - al parámetro utilizando la función - db2_bind_param y llama a la función - db2_execute para ejecutar la consulta - CALL. Una vez que la consulta CALL ha sido ejecutada, el valor de - $num_pets cambia para reflejar el valor devuelto - por el procedimiento de registro para este parámetro de SALIDA. - - - -]]> - - &example.outputs; - - - - - - Devuelve datos XML como ResultSet SQL - - El siguiente ejemplo demuestra cómo utilizar documentos almacenados - en una columna XML utilizando la base de datos SAMPLE. Utilizando un simple SQL/XML, - este ejemplo devuelve algunos nodos en un documento XML en un formato ResultSet SQL - con el que la mayoría de los usuarios están familiarizados. - - -CID $row->NAME $row->PHONE\n"); - } -} -db2_close($conn); - -?> -]]> - - &example.outputs; - - - - - - Ejecutar un "JOIN" con datos XML - - El siguiente ejemplo trabaja con documentos almacenados en dos - columnas diferentes en la base de datos SAMPLE. Esto crea dos - tablas temporales a partir de los documentos XML de dos diferentes - columnas XML y devuelve un ResultSet SQL con la información que contiene - el estado de envío para un cliente. - - -CID $row->NAME $row->PHONE $row->PONUM $row->STATUS\n"); - } -} - -db2_close($conn); - -?> -]]> - - &example.outputs; - - - - - - Devuelve datos SQL que forman parte de un documento XML grande - - El siguiente ejemplo utiliza una porción de los documentos de - PRODUCT.DESCRIPTION en la base de datos SAMPLE. Esto crea un documento - XML que contiene la descripción del producto (datos XML) y las informaciones - concernientes al precio (datos SQL). - - - { - for $prod in $doc/product - where $prod/description/price < 10.00 - order by $prod/description/price ascending - return( - { - $prod, - {$start} , - {$end} , - {$promo} - } - ) - } -\' passing by ref DESCRIPTION AS "doc", -PROMOSTART as "start", -PROMOEND as "end", -PROMOPRICE as "promo" -RETURNING SEQUENCE) -AS CLOB (32000)) -AS NEW_PRODUCT_INFO -FROM PRODUCT -WHERE PID = ? -'; - -$stmt = db2_prepare($conn, $query); - -$pid = "100-100-01"; - -if ($stmt) { - db2_bind_param($stmt, 1, "pid", DB2_PARAM_IN); - db2_execute($stmt); - - while($row = db2_fetch_array($stmt)){ - printf("$row[0]\n"); - } -} - -db2_close($conn); - -?> -]]> - - &example.outputs; - - - - - - Snow Shovel, Basic 22 inch -
Basic Snow Shovel, 22 inches wide, straight handle with D-Grip
- 9.99 - 1 kg -
-
- 2004-11-19 - 2004-12-19 - 7.25 -
- -]]> -
-
-
-
- - - &reftitle.seealso; - - db2_exec - db2_fetch_array - db2_fetch_assoc - db2_fetch_both - db2_fetch_row - db2_prepare - db2_result - - - -
- diff --git a/reference/ibm_db2/functions/db2-fetch-array.xml b/reference/ibm_db2/functions/db2-fetch-array.xml deleted file mode 100644 index c2a05ab5c6..0000000000 --- a/reference/ibm_db2/functions/db2-fetch-array.xml +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - - db2_fetch_array - - Devuelve un array, indexado por la posición de las columnas, que representa - una línea del conjunto de resultados - - - - &reftitle.description; - - arrayfalsedb2_fetch_array - resourcestmt - introw_number-1 - - - - Devuelve un array, indexado por la posición de las columnas, que representa - una línea del conjunto de resultados. Los índices del array son numéricos y - comienzan por cero. - - - - - &reftitle.parameters; - - - stmt - - - Un recurso stmt válido que contiene el conjunto de - resultados. - - - - - row_number - - - Solicita una línea específica indexada numéricamente que comienza con el - valor 1 en el conjunto de resultados. Al proporcionar este argumento, se - generará una advertencia PHP si el conjunto de resultados - utiliza un cursor de avance solo. - - - - - - - &reftitle.returnvalues; - - Devuelve un array con índices numéricos comenzando en 0 indexado con la posición de las - columnas. Este índice apunta a los datos de la siguiente - línea o la línea solicitada en el conjunto de resultados. Devuelve &false; - si no hay una línea disponible en el conjunto de resultados o si - la línea solicitada por row_number no existe - en el conjunto de resultados. - - - - - &reftitle.examples; - - - Iteración con un cursor de avance solo - - Si se llama a db2_fetch_array sin el número de una - línea específica, la siguiente línea se recuperará automáticamente en el - conjunto de resultados. - - - -]]> - - &example.outputs; - - - - - - - Recuperación de líneas específicas con <function>db2_fetch_array</function> - a partir de un cursor flotante - - Si su conjunto de resultados utiliza un cursor flotante, puede - llamar a la función db2_fetch_array con un número - de línea específico. El siguiente ejemplo recupera cada línea par en - el conjunto de resultados, comenzando con la segunda línea. - - - DB2_SCROLLABLE)); - -$i=2; -while ($row = db2_fetch_array($result, $i)) { - printf ("%-5d %-16s %-32s %10s\n", - $row[0], $row[1], $row[2], $row[3]); - $i = $i + 2; -} -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - db2_fetch_assoc - db2_fetch_both - db2_fetch_object - db2_fetch_row - db2_result - - - - diff --git a/reference/ibm_db2/functions/db2-fetch-assoc.xml b/reference/ibm_db2/functions/db2-fetch-assoc.xml deleted file mode 100644 index 4c392be289..0000000000 --- a/reference/ibm_db2/functions/db2-fetch-assoc.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - - db2_fetch_assoc - - Devuelve un array, indexado por nombre de columna, que representa una fila del conjunto de resultados - - - - &reftitle.description; - - arrayfalsedb2_fetch_assoc - resourcestmt - introw_number-1 - - - - Devuelve un array, indexado por nombre de columna, que representa una fila del conjunto de resultados. - - - - - &reftitle.parameters; - - - stmt - - - Un recurso stmt válido que contiene el conjunto de resultados. - - - - - row_number - - - Solicita una fila específica indexada numéricamente que comienza con el valor 1 en el conjunto de resultados. Al proporcionar este argumento, se generará una advertencia PHP si el conjunto de resultados utiliza un cursor de avance solo. - - - - - - - - &reftitle.returnvalues; - - Devuelve un array asociativo con los valores de las columnas indexados por el nombre de las columnas que representan la siguiente fila o la fila solicitada en el conjunto de resultados. Devuelve &false; si no hay una fila disponible en el conjunto de resultados o si la fila solicitada por row_number no existe en el conjunto de resultados. - - - - - &reftitle.examples; - - - Iteración con un cursor de avance solo - - Si se llama a db2_fetch_assoc sin el número de una fila específica, se recuperará automáticamente la siguiente fila en el conjunto de resultados. - - - -]]> - - &example.outputs; - - - - - - - Recuperación de filas específicas con <function>db2_fetch_assoc</function> desde un cursor flotante - - Si su conjunto de resultados utiliza un cursor flotante, puede llamar a la función db2_fetch_assoc con un número de fila específico. El siguiente ejemplo recupera cada fila par en el conjunto de resultados, comenzando con la segunda fila. - - - DB2_SCROLLABLE)); - -$i=2; -while ($row = db2_fetch_assoc($result, $i)) { - printf ("%-5d %-16s %-32s %10s\n", - $row['ID'], $row['NOM'], $row['RACE'], $row['POIDS']); - $i = $i + 2; -} -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - db2_fetch_array - db2_fetch_both - db2_fetch_object - db2_fetch_row - db2_result - - - - diff --git a/reference/ibm_db2/functions/db2-fetch-both.xml b/reference/ibm_db2/functions/db2-fetch-both.xml deleted file mode 100644 index 99758f78d6..0000000000 --- a/reference/ibm_db2/functions/db2-fetch-both.xml +++ /dev/null @@ -1,173 +0,0 @@ - - - - - - - db2_fetch_both - - Devuelve un array, indexado por nombre de columna y posición, que representa - una fila del conjunto de resultados - - - - &reftitle.description; - - arrayfalsedb2_fetch_both - resourcestmt - introw_number-1 - - - - Devuelve un array, indexado por nombre de columna y posición, que representa - una fila del conjunto de resultados. Tenga en cuenta que la fila devuelta por - db2_fetch_both requiere más memoria que los arrays - simplemente indexados devueltos por - db2_fetch_assoc o - db2_fetch_array. - - - - - &reftitle.parameters; - - - stmt - - - Un recurso stmt válido que contiene el conjunto de - resultados. - - - - - row_number - - - Solicita una fila específica indexada numéricamente que comienza con el - valor 1 en el conjunto de resultados. Al proporcionar este argumento, se - generará una alerta PHP si el conjunto de resultados - utiliza un cursor de avance solo. - - - - - - - - &reftitle.returnvalues; - - Devuelve un array asociativo con los valores de las columnas indexados por - el nombre de las columnas y el número de las columnas comenzando por 0. El array - representa la siguiente fila o la fila solicitada del conjunto de resultados. - Devuelve &false; si no hay una fila disponible en el conjunto de - resultados o si la fila solicitada por row_number - no existe en el conjunto de resultados. - - - - - &reftitle.examples; - - - Iteración con un cursor de avance solo - - Si se llama a db2_fetch_both sin el número de una - fila específica, se recuperará automáticamente la siguiente fila del - conjunto de resultados. El siguiente ejemplo accede a las columnas - devueltas en el array mediante el método de nombres de columna y por índice - numérico. - - - -]]> - - &example.outputs; - - - - - - - Recuperación de filas específicas con <function>db2_fetch_both</function> - a partir de un cursor flotante - - Si su conjunto de resultados utiliza un cursor flotante, puede - llamar a la función db2_fetch_assoc con un número - de fila específico. El siguiente ejemplo recupera cada fila par en - el conjunto de resultados, comenzando con la segunda fila. - - - DB2_SCROLLABLE)); - -$i=2; -while ($row = db2_fetch_both($result, $i)) { - printf ("%-5d %-16s %-32s %10s\n", - $row[0], $row['NOM'], $row[2], $row['POIDS']); - $i = $i + 2; -} -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - db2_fetch_array - db2_fetch_assoc - db2_fetch_object - db2_fetch_row - db2_result - - - - diff --git a/reference/ibm_db2/functions/db2-fetch-object.xml b/reference/ibm_db2/functions/db2-fetch-object.xml deleted file mode 100644 index 7509ab1056..0000000000 --- a/reference/ibm_db2/functions/db2-fetch-object.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - - db2_fetch_object - - Devuelve un objeto con las propiedades que representan columnas en la - fila extraída - - - - &reftitle.description; - - stdClassfalsedb2_fetch_object - resourcestmt - introw_number-1 - - - - Devuelve un objeto en el que cada propiedad representa una columna - devuelta en la fila extraída del conjunto de resultados. - - - - - &reftitle.parameters; - - - stmt - - - Un recurso stmt válido que contiene el conjunto de resultados. - - - - - row_number - - - Solicita una fila específica comenzando en el índice 1 del conjunto de - resultados. Si se pasa este argumento, se generará una - advertencia de PHP si el resultado utiliza un cursor de desplazamiento - solo. - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto que representa una sola fila en el conjunto de resultados. - Las propiedades del objeto corresponden al nombre de las columnas en el conjunto - de resultados. - - - Los servidores IBM DB2, Cloudscape y Apache Derby normalmente rellenan los - nombres de las columnas con mayúsculas, por lo tanto, las propiedades - del objeto reflejarán este caso. - - - Si su consulta SELECT llama a una función escalar para modificar el - valor de una columna, los servidores de base de datos devuelven el número - de columna como nombre de columna en el conjunto de resultados. Si se prefiere - una descripción más detallada del nombre de las columnas y las - propiedades del objeto, se puede utilizar la cláusula AS para asignar un - nombre a la columna en el conjunto de resultados. - - - Devuelve &false; si no se ha recuperado ninguna fila. - - - - - &reftitle.examples; - - Ejemplo con <function>db2_fetch_object</function> - - El ejemplo siguiente envía una consulta SELECT con una función escalar, - RTRIM, que elimina los espacios al final de la columna. En lugar de crear - un objeto con las propiedades "RACE" y "2", se utiliza la cláusula AS en la - consulta SELECT para asignar el nombre "nom" a la columna modificada. El servidor - de base de datos rellena el nombre de las columnas con mayúsculas, por lo que - el objeto tendrá las propiedades "RACE" y "NOM". - - -NOM}, mon petit {$pet->RACE} !"; - } - db2_close($conn); -} -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_fetch_array - db2_fetch_assoc - db2_fetch_both - db2_fetch_row - db2_result - - - - - diff --git a/reference/ibm_db2/functions/db2-fetch-row.xml b/reference/ibm_db2/functions/db2-fetch-row.xml deleted file mode 100644 index 8cbc04d72b..0000000000 --- a/reference/ibm_db2/functions/db2-fetch-row.xml +++ /dev/null @@ -1,191 +0,0 @@ - - - - - - - db2_fetch_row - - Modifica el puntero del conjunto de resultados a la siguiente línea o a la línea - solicitada - - - - &reftitle.description; - - booldb2_fetch_row - resourcestmt - introw_number-1 - - - - Utilice db2_fetch_row para iterar a través de un conjunto - de resultados o para apuntar a una línea específica de un conjunto de resultados - si se ha solicitado un cursor flotante. - - - Para obtener campos individuales del conjunto de resultados, llame a la función - db2_result. - - - En lugar de llamar a las funciones db2_fetch_row y - db2_result, la mayoría de las aplicaciones van a llamar - a la función db2_fetch_assoc, - db2_fetch_both o db2_fetch_array - para avanzar el puntero en el conjunto de resultados y devolver una línea - completa como array. - - - - - &reftitle.parameters; - - - stmt - - - Un recurso stmt válido que contiene el conjunto - de resultados. - - - - - row_number - - - Con cursores flotantes, puede solicitar un número de línea - específico del conjunto de resultados. Los números de líneas comienzan con - el índice 1 - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si la línea solicitada existe en el conjunto de resultados. - Devuelve &false; si la línea solicitada no existe en el conjunto de - resultados. - - - - - &reftitle.examples; - - - Iterar a través de un conjunto de resultados - - El siguiente ejemplo demuestra cómo iterar a través de un conjunto de resultados - con la función db2_fetch_row y recuperar las - columnas del conjunto de resultados con db2_result. - - - -]]> - - &example.outputs; - - - - - - Alternativas recomendadas i5/OS para db2_fetch_row/db2_result - - En i5/OS, se recomienda que utilice - db2_fetch_both, db2_fetch_array - o db2_fetch_object en lugar de - db2_fetch_row/db2_result. - En general - db2_fetch_row/db2_result tiene más - problemas con tipos de columna variados en la traducción de - EBCDIC a ASCII, incluyendo posible - truncamiento en aplicaciones DBCS. - También podría encontrar una mejor performance utilizando - db2_fetch_both, db2_fetch_array - y db2_fetch_object en lugar de - db2_fetch_row/db2_result. - - - DB2_SCROLLABLE)); - while ($row = db2_fetch_both($stmt)){ - echo "
db2_fetch_both {$row['SPECIFIC_NAME']} {$row['ROUTINE_CREATED']} {$row[5]}"; - } - $stmt = db2_exec($conn, $sql, array('cursor' => DB2_SCROLLABLE)); - while ($row = db2_fetch_array($stmt)){ - echo "
db2_fetch_array {$row[1]} {$row[5]}"; - } - $stmt = db2_exec($conn, $sql, array('cursor' => DB2_SCROLLABLE)); - while ($row = db2_fetch_object($stmt)){ - echo "
db2_fetch_object {$row->SPECIFIC_NAME} {$row->ROUTINE_CREATED}"; - } - db2_close($conn); -?> -]]> -
- &example.outputs; - - - -
-
-
- - - &reftitle.seealso; - - db2_fetch_array - db2_fetch_assoc - db2_fetch_both - db2_fetch_object - db2_result - - -
- diff --git a/reference/ibm_db2/functions/db2-field-display-size.xml b/reference/ibm_db2/functions/db2-field-display-size.xml deleted file mode 100644 index d19c4680d5..0000000000 --- a/reference/ibm_db2/functions/db2-field-display-size.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - db2_field_display_size - - Devuelve el máximo de octetos requeridos para mostrar una columna - - - - &reftitle.description; - - intfalsedb2_field_display_size - resourcestmt - intstringcolumn - - - - Devuelve el máximo de octetos requeridos para mostrar una columna en un - conjunto de resultados. - - - - - &reftitle.parameters; - - - stmt - - - Especifica el recurso que contiene el conjunto de resultados. - - - - - column - - - Especifica la columna en el conjunto de resultados. Puede ser un entero - comenzando en la posición 0 que representa el número de la columna - o un string que contiene el nombre de la columna. - - - - - - - &reftitle.returnvalues; - - Devuelve un valor entero con el máximo de octetos requeridos para mostrar - la columna especificada. Si la columna no existe en el conjunto de resultados, - db2_field_display_size devuelve &false;. - - - - - &reftitle.seealso; - - db2_field_name - db2_field_num - db2_field_precision - db2_field_scale - db2_field_type - db2_field_width - - - - diff --git a/reference/ibm_db2/functions/db2-field-name.xml b/reference/ibm_db2/functions/db2-field-name.xml deleted file mode 100644 index 93e9288ed7..0000000000 --- a/reference/ibm_db2/functions/db2-field-name.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - db2_field_name - - Devuelve el nombre de la columna del conjunto de resultados - - - - &reftitle.description; - - stringfalsedb2_field_name - resourcestmt - intstringcolumn - - - - Devuelve el nombre de la columna del conjunto de resultados - - - - - &reftitle.parameters; - - - stmt - - - Especifica el recurso que contiene el conjunto de resultados. - - - - - column - - - Especifica la columna en el conjunto de resultados. Puede ser un entero - comenzando en la posición 0 que representa el número de la columna - o un string que contiene el nombre de la columna. - - - - - - - &reftitle.returnvalues; - - Devuelve un string que contiene el nombre de la columna especificada. Si la columna - especificada no existe en el conjunto de resultados, - db2_field_name devuelve &false;. - - - - - &reftitle.seealso; - - db2_field_display_size - db2_field_num - db2_field_precision - db2_field_scale - db2_field_type - db2_field_width - - - - diff --git a/reference/ibm_db2/functions/db2-field-num.xml b/reference/ibm_db2/functions/db2-field-num.xml deleted file mode 100644 index 5fe37abf18..0000000000 --- a/reference/ibm_db2/functions/db2-field-num.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - db2_field_num - - Devuelve la posición del nombre de la columna del conjunto de resultados - - - - &reftitle.description; - - intfalsedb2_field_num - resourcestmt - intstringcolumn - - - - Devuelve la posición del nombre de la columna del conjunto de resultados - - - - - &reftitle.parameters; - - - stmt - - - Especifica un recurso que contiene un conjunto de resultados. - - - - - column - - - Especifica la columna en el conjunto de resultados. Esto puede ser un entero - comenzando en la posición 0 que representa el número de la columna - o un string que contiene el nombre de la columna. - - - - - - - &reftitle.returnvalues; - - Devuelve un entero que contiene la posición comenzando en 0 del nombre de la - columna en el conjunto de resultados. Si la columna especificada no existe en - el conjunto de resultados, db2_field_num devuelve &false;. - - - - - &reftitle.seealso; - - db2_field_display_size - db2_field_name - db2_field_precision - db2_field_scale - db2_field_type - db2_field_width - - - - diff --git a/reference/ibm_db2/functions/db2-field-precision.xml b/reference/ibm_db2/functions/db2-field-precision.xml deleted file mode 100644 index 1b79b0287d..0000000000 --- a/reference/ibm_db2/functions/db2-field-precision.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - db2_field_precision - - Devuelve la precisión de la columna indicada del conjunto de resultados - - - - &reftitle.description; - - intfalsedb2_field_precision - resourcestmt - intstringcolumn - - - - Devuelve la precisión de la columna indicada del conjunto de resultados. - - - - - &reftitle.parameters; - - - stmt - - - Especifica el recurso que contiene el conjunto de resultados. - - - - - column - - - Especifica la columna en el conjunto de resultados. Esto puede ser un entero - que comienza en la posición 0 representando el número de la columna - o un string que contiene el nombre de la columna. - - - - - - - &reftitle.returnvalues; - - Devuelve un integer que contiene la precisión de la columna especificada. Si la - columna especificada no existe en el conjunto de resultados, - db2_field_precision devuelve &false;. - - - - - &reftitle.seealso; - - db2_field_display_size - db2_field_name - db2_field_num - db2_field_scale - db2_field_type - db2_field_width - - - - diff --git a/reference/ibm_db2/functions/db2-field-scale.xml b/reference/ibm_db2/functions/db2-field-scale.xml deleted file mode 100644 index abbca60cc4..0000000000 --- a/reference/ibm_db2/functions/db2-field-scale.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - db2_field_scale - - Devuelve la escala de la columna indicada del conjunto de resultados - - - - &reftitle.description; - - intfalsedb2_field_scale - resourcestmt - intstringcolumn - - - - Devuelve la escala de la columna indicada del conjunto de resultados. - - - - - &reftitle.parameters; - - - stmt - - - Especifica el recurso que contiene el conjunto de resultados. - - - - - column - - - Especifica la columna en el conjunto de resultados. Esto puede ser un entero - comenzando en la posición 0 que representa el número de la columna - o una cadena que contiene el nombre de la columna. - - - - - - - &reftitle.returnvalues; - - Devuelve un entero que contiene la escala de la columna especificada. Si la - columna especificada no existe en el conjunto de resultados, - db2_field_scale devuelve &false;. - - - - - &reftitle.seealso; - - db2_field_display_size - db2_field_name - db2_field_num - db2_field_precision - db2_field_type - db2_field_width - - - - diff --git a/reference/ibm_db2/functions/db2-field-type.xml b/reference/ibm_db2/functions/db2-field-type.xml deleted file mode 100644 index 2a1679a2ec..0000000000 --- a/reference/ibm_db2/functions/db2-field-type.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - db2_field_type - - Devuelve el tipo de dato de la columna indicada del conjunto de resultados - - - - &reftitle.description; - - stringfalsedb2_field_type - resourcestmt - intstringcolumn - - - - Devuelve el tipo de dato de la columna indicada del conjunto de resultados. - - - - - &reftitle.parameters; - - - stmt - - - Especifica el recurso que contiene el conjunto de resultados. - - - - - column - - - Especifica la columna en el conjunto de resultados. Esto puede ser un entero - comenzando en la posición 0 que representa el número de la columna - o una cadena que contiene el nombre de la columna. - - - - - - - &reftitle.returnvalues; - - Devuelve una cadena que contiene el tipo de dato definido de la columna - especificada. Si la columna especificada no existe en el conjunto de resultados, - db2_field_type devuelve &false;. - - - - - &reftitle.seealso; - - db2_field_display_size - db2_field_name - db2_field_num - db2_field_precision - db2_field_scale - db2_field_width - - - - diff --git a/reference/ibm_db2/functions/db2-field-width.xml b/reference/ibm_db2/functions/db2-field-width.xml deleted file mode 100644 index 60353b4c49..0000000000 --- a/reference/ibm_db2/functions/db2-field-width.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - db2_field_width - - Devuelve el ancho de la columna indicada en el conjunto de resultados - - - - &reftitle.description; - - intfalsedb2_field_width - resourcestmt - intstringcolumn - - - - Devuelve el ancho de la columna indicada en el conjunto de resultados. Esto - es el ancho máximo de la columna para un tipo de datos de longitud fija o el - ancho actual de la columna para un tipo de datos de longitud variable. - - - - - &reftitle.parameters; - - - stmt - - - Especifica el recurso que contiene el conjunto de resultados. - - - - - column - - - Especifica la columna en el conjunto de resultados. Esto puede ser un - entero comenzando en la posición 0 que representa el número de la columna - o un string que contiene el nombre de la columna. - - - - - - - &reftitle.returnvalues; - - Devuelve un integer que contiene el ancho del carácter especificado o de la - columna de tipo binario en el conjunto de resultados. Si la columna - especificada no existe en el conjunto de resultados, db2_field_width - devuelve &false;. - - - - - &reftitle.seealso; - - db2_field_display_size - db2_field_name - db2_field_num - db2_field_precision - db2_field_scale - db2_field_type - - - - diff --git a/reference/ibm_db2/functions/db2-foreign-keys.xml b/reference/ibm_db2/functions/db2-foreign-keys.xml deleted file mode 100644 index 66791318a6..0000000000 --- a/reference/ibm_db2/functions/db2-foreign-keys.xml +++ /dev/null @@ -1,180 +0,0 @@ - - - - - - - db2_foreign_keys - - Devuelve un conjunto de resultados que lista las claves externas de una tabla - - - - &reftitle.description; - - resourcedb2_foreign_keys - resourceconnection - stringnullqualifier - stringnullschema - stringtable_name - - - - Devuelve un conjunto de resultados que lista las claves externas de una tabla. - - - - - &reftitle.parameters; - - - connection - - - Una conexión válida a una base de datos IBM DB2, Cloudscape o - Apache Derby. - - - - - qualifier - - - Un calificador para las bases de datos DB2 que funcionan en - los servidores OS/390 o z/OS. Para otras bases de datos, pase - &null; o una cadena vacía. - - - - - schema - - - El esquema que contiene las tablas. Si schema es - &null;, db2_foreign_keys hace coincidir el esquema - para la conexión actual. - - - - - table_name - - - El nombre de la tabla. - - - - - - - &reftitle.returnvalues; - - Devuelve un recurso con el conjunto de resultados que contiene filas - que describen las claves externas de la tabla especificada. El conjunto de resultados - está compuesto por las siguientes columnas: - - - - - Nombre de la columna - Descripción - - - - - PKTABLE_CAT - Nombre del catálogo de la tabla que contiene la clave primaria. El valor es &null; si la tabla no tiene catálogo. - - - PKTABLE_SCHEM - Nombre del esquema de la tabla que contiene la clave primaria. - - - PKTABLE_NAME - Nombre de la tabla que contiene la clave primaria. - - - PKCOLUMN_NAME - Nombre de la columna que contiene la clave primaria. - - - FKTABLE_CAT - Nombre del catálogo de la tabla que contiene la clave externa. El valor es &null; si la tabla no tiene catálogo. - - - FKTABLE_SCHEM - Nombre del esquema de la tabla que contiene la clave externa. - - - FKTABLE_NAME - Nombre de la tabla que contiene la clave externa. - - - FKCOLUMN_NAME - Nombre de la columna que contiene la clave externa. - - - KEY_SEQ - Posición, comenzando en 1, de la columna en la clave. - - - UPDATE_RULE - Entero que representa la acción aplicada a la clave externa cuando una operación es de tipo UPDATE. - - - DELETE_RULE - Entero que representa la acción aplicada a la clave externa cuando una operación es de tipo DELETE. - - - FK_NAME - Nombre de la clave externa. - - - PK_NAME - Nombre de la clave primaria. - - - DEFERRABILITY - Un entero que representa si el modo diferido de la clave externa es SQL_INITIALLY_DEFERRED, SQL_INITIALLY_IMMEDIATE o SQL_NOT_DEFERRABLE. - - - - - - - - - &reftitle.seealso; - - db2_column_privileges - db2_columns - db2_primary_keys - db2_procedure_columns - db2_procedures - db2_special_columns - db2_statistics - db2_table_privileges - db2_tables - - - - diff --git a/reference/ibm_db2/functions/db2-free-result.xml b/reference/ibm_db2/functions/db2-free-result.xml deleted file mode 100644 index 4c5ac3bcc7..0000000000 --- a/reference/ibm_db2/functions/db2-free-result.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - - db2_free_result - - Liberar los recursos asociados con un resultado - - - - &reftitle.description; - - booldb2_free_result - resourcestmt - - - - Libera los recursos del Sistema y de la Base de Datos que están asociados con un resultado. - Los recursos se liberan automáticamente cuando un script finaliza, pero se puede - llamar a db2_free_result para liberarlos en ese momento - y no hasta que el script finalice. - - - - - &reftitle.parameters; - - - stmt - - - Un recurso válido. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - &reftitle.seealso; - - db2_free_stmt - - - - - diff --git a/reference/ibm_db2/functions/db2-free-stmt.xml b/reference/ibm_db2/functions/db2-free-stmt.xml deleted file mode 100644 index 87edd4fe2a..0000000000 --- a/reference/ibm_db2/functions/db2-free-stmt.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - - db2_free_stmt - - Liberar un recurso indicado - - - - &reftitle.description; - - booldb2_free_stmt - resourcestmt - - - - - Libera los recursos del Sistema y de la Base de Datos que están asociados con un - determinado recurso (de sentencias). Los recursos son liberados automáticamente cuando - un script finaliza, pero se puede llamar a db2_free_stmt para liberarlos - en ese momento y no hasta que el script finalice. - - - - - &reftitle.parameters; - - - stmt - - - Un recurso (de sentencias) válido. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - &reftitle.seealso; - - db2_free_result - - - - - diff --git a/reference/ibm_db2/functions/db2-get-option.xml b/reference/ibm_db2/functions/db2-get-option.xml deleted file mode 100644 index bfc0db0e47..0000000000 --- a/reference/ibm_db2/functions/db2-get-option.xml +++ /dev/null @@ -1,308 +0,0 @@ - - - - - - - db2_get_option - Recupera el valor de una opción para una consulta o conexión - - - - &reftitle.description; - - stringfalsedb2_get_option - resourceresource - stringoption - - - Recupera el valor de una opción especificada para un recurso de consulta o un recurso - de conexión. - - - - - &reftitle.parameters; - - - resource - - - Un recurso de consulta válido devuelto por - db2_prepare o un recurso de conexión válido devuelto por - db2_connect o db2_pconnect. - - - - - option - - - Opciones de consulta o conexión válidas. Las siguientes opciones nuevas están - disponibles desde la versión 1.6.0 de ibm_db2. Proporcionan información de seguimiento útil - que puede ser establecida durante la ejecución con - db2_get_option. - - - Las versiones anteriores de ibm_db no soportan estas nuevas opciones. - - - Cuando un valor en cada opción es establecido, algunos servidores pueden no - soportar el valor total proporcionado y pueden truncar este valor. - - - Para asegurar que los datos especificados en cada opción sean convertidos correctamente - durante la transmisión hacia una base de datos, utilice solo los caracteres de A a Z, 0 a 9 - y los caracteres de subrayado (_) o punto (.). - - - - - userid - - - SQL_ATTR_INFO_USERID : un puntero hacia un &string; utilizado para identificar - el identificador de usuario (ID) enviado hacia el servidor de base de datos durante la conexión a DB2. - - - DB2 para servidores z/OS y OS/390 soportan hasta 16 caracteres. - El user-id no debe ser confundido con la identificación user-id; se trata - solamente de un propósito de identificación y no debe ser autorizado para permisos. - - - - - - - acctstr - - - SQL_ATTR_INFO_ACCTSTR : un puntero hacia un &string; utilizado para identificar - la cuenta del cliente enviada hacia el servidor de base de datos durante la conexión a DB2. - - - DB2 para servidores z/OS y OS/390 soportan hasta 200 caracteres. - - - - - - - applname - - - SQL_ATTR_INFO_APPLNAME : un puntero hacia un &string; utilizado para identificar - el nombre de la aplicación del cliente enviada hacia el servidor de base de datos durante la conexión a DB2. - - - DB2 para servidores z/OS y OS/390 soportan hasta 32 caracteres. - - - - - - - wrkstnname - - - SQL_ATTR_INFO_WRKSTNNAME : un puntero hacia un &string; utilizado para identificar - el nombre de la máquina del cliente enviada hacia el servidor de base de datos durante la conexión a DB2. - - - DB2 para servidores z/OS y OS/390 soportan hasta 18 caracteres. - - - - - - - - - - - - La siguiente tabla especifica qué opciones son compatibles con el tipo - de recurso disponible: - - Matriz recurso parámetro - - - - - - - - - Clave - Valor - Tipo de recurso - - - - - Conexión - Consulta - Conjunto de resultados - - - userid - SQL_ATTR_INFO_USERID - X - X - - - - - acctstr - SQL_ATTR_INFO_ACCTSTR - X - X - - - - - applname - SQL_ATTR_INFO_APPLNAME - X - X - - - - - wrkstnname - SQL_ATTR_INFO_WRKSTNNAME - X - X - - - - - -
-
-
- - - &reftitle.returnvalues; - - Devuelve la configuración actual de la conexión proporcionada en caso de éxito&return.falseforfailure;. - - - - - &reftitle.examples; - - Establece y recupera los parámetros de un recurso de conexión - - 'db2inst1'); -$conn1 = db2_connect($database, $user, $password, $options1); -$val = db2_get_option($conn1, 'userid'); -echo $val . "\n"; - -$options2 = array('acctstr' => 'account'); -$conn2 = db2_connect($database, $user, $password, $options2); -$val = db2_get_option($conn2, 'acctstr'); -echo $val . "\n"; - -$options3 = array('applname' => 'myapp'); -$conn3 = db2_connect($database, $user, $password, $options3); -$val = db2_get_option($conn3, 'applname'); -echo $val . "\n"; - -$options4 = array('wrkstnname' => 'workstation'); -$conn4 = db2_connect($database, $user, $password, $options4); -$val = db2_get_option($conn4, 'wrkstnname'); -echo $val . "\n"; - -echo "Atributos después de la conexión :\n"; - -/* Crea un array asociativo de opciones con los pares clave/valor válidos */ -/* Asigna los atributos después de que la conexión sea realizada */ -/* Accede a las opciones especificadas */ -$options5 = array('userid' => 'db2inst1'); -$conn5 = db2_connect($database, $user, $password); -$rc = db2_set_option($conn5, $options5, 1); -$val = db2_get_option($conn5, 'userid'); -echo $val . "\n"; - -$options6 = array('acctstr' => 'account'); -$conn6 = db2_connect($database, $user, $password); -$rc = db2_set_option($conn6, $options6, 1); -$val = db2_get_option($conn6, 'acctstr'); -echo $val . "\n"; - -$options7 = array('applname' => 'myapp'); -$conn7 = db2_connect($database, $user, $password); -$rc = db2_set_option($conn7, $options7, 1); -$val = db2_get_option($conn7, 'applname'); -echo $val . "\n"; - -$options8 = array('wrkstnname' => 'workstation'); -$conn8 = db2_connect($database, $user, $password); -$rc = db2_set_option($conn8, $options8, 1); -$val = db2_get_option($conn8, 'wrkstnname'); -echo $val . "\n"; -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_connect - db2_cursor_type - db2_exec - db2_set_option - db2_pconnect - db2_prepare - - - -
- diff --git a/reference/ibm_db2/functions/db2-last-insert-id.xml b/reference/ibm_db2/functions/db2-last-insert-id.xml deleted file mode 100644 index 1ee92fbca3..0000000000 --- a/reference/ibm_db2/functions/db2-last-insert-id.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - - db2_last_insert_id - Retorna el último ID generado por la última consulta de inserción - - - - &reftitle.description; - - stringnulldb2_last_insert_id - resourceresource - - - Retorna el último identificador autogenerado por la última consulta de inserción - para la conexión actual. - - - El resultado de esta función no se ve afectado por los siguientes eventos: - - - - Un comando INSERT único con una cláusula VALUES para una tabla - que no dispone de columna de identidad. - - - - - Un comando INSERT múltiple con cláusula VALUES. - - - - - Un comando INSERT con un SELECT. - - - - - Un comando ROLLBACK TO SAVEPOINT. - - - - - - - - &reftitle.parameters; - - - resource - - - Un recurso de conexión válido, creado por db2_connect - o db2_pconnect. El valor de este argumento no puede - ser un recurso de comando o de resultado. - - - - - - - - &reftitle.returnvalues; - - Retorna el identificador autogenerado que pudo ser ejecutado correctamente - en esta conexión. - - - - - &reftitle.examples; - - Ejemplo con <function>db2_last_insert_id</function> - - El siguiente ejemplo muestra cómo retornar un identificador automático - - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/ibm_db2/functions/db2-lob-read.xml b/reference/ibm_db2/functions/db2-lob-read.xml deleted file mode 100644 index 327f257fe5..0000000000 --- a/reference/ibm_db2/functions/db2-lob-read.xml +++ /dev/null @@ -1,193 +0,0 @@ - - - - - - - db2_lob_read - - Recupera grandes objetos binarios de tamaños predefinidos en cada invocación - - - - - &reftitle.description; - - stringfalsedb2_lob_read - resourcestmt - intcolnum - intlength - - - Utilice db2_lob_read para recorrer una columna - específica de un conjunto de resultados y recuperar los grandes objetos binarios de - tamaño predefinido. - - - - - &reftitle.parameters; - - - stmt - - - Un recurso stmt válido que contiene grandes objetos binarios. - - - - - colnum - - - Un número de columna válido en el conjunto de resultados del recurso - stmt. - - - - - length - - - El tamaño de los grandes objetos binarios a recuperar del recurso - stmt. - - - - - - - - &reftitle.returnvalues; - - Devuelve el número de datos especificados. Devuelve &false; si los datos - no pueden ser recuperados. - - - - - &reftitle.examples; - - Iterar a través de diferentes tipos de datos - - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_bind_param - db2_exec - db2_execute - db2_fetch_row - db2_prepare - db2_result - - - - - diff --git a/reference/ibm_db2/functions/db2-next-result.xml b/reference/ibm_db2/functions/db2-next-result.xml deleted file mode 100644 index 83e7c5e0d9..0000000000 --- a/reference/ibm_db2/functions/db2-next-result.xml +++ /dev/null @@ -1,182 +0,0 @@ - - - - - - - db2_next_result - - Solicita el siguiente conjunto de resultados de la recurso indicado - - - - &reftitle.description; - - resourcefalsedb2_next_result - resourcestmt - - - - Un procedimiento de registro puede devolver ningún o múltiples conjuntos de - resultados. El primer conjunto de resultados debe manejarse de la misma manera - que los resultados devueltos por una simple consulta SELECT. Para obtener - el segundo o los siguientes resultados, debe llamarse a la función - db2_next_result y almacenar el resultado en una variable PHP. - - - - - &reftitle.parameters; - - - stmt - - - Una consulta preparada devuelta por db2_exec o - db2_execute. - - - - - - - &reftitle.returnvalues; - - Devuelve un nuevo recurso que contiene el siguiente conjunto de resultados si - el procedimiento contenía otro conjunto de resultados. Devuelve &false; si el - procedimiento no tenía más conjuntos de resultados para devolver. - - - - - &reftitle.examples; - - Ejemplo con <function>db2_next_result</function> - - En el siguiente ejemplo, se llama a un procedimiento que devuelve tres - conjuntos de resultados. El primer conjunto de resultados se recupera directamente - de la misma recurso sobre la cual se invocó una consulta CALL, mientras que - el segundo y tercer conjuntos de resultados se recuperan de las recursos - devueltas por la llamada a la función - db2_next_result. - - - -]]> - - &example.outputs; - - - string(16) "Bubbles " - [1]=> - int(3) -} -array(2) { - [0]=> - string(16) "Gizmo " - [1]=> - int(4) -} - -Recuperación del segundo conjunto de resultados -array(4) { - [0]=> - string(16) "Sweater " - [1]=> - int(6) - [2]=> - string(5) "lama" - [3]=> - string(6) "150.00" -} -array(4) { - [0]=> - string(16) "Smarty " - [1]=> - int(2) - [2]=> - string(5) "cheval" - [3]=> - string(6) "350.00" -} - -Recuperación del tercer conjunto de resultados -array(1) { - [0]=> - string(16) "Bubbles " -} -array(1) { - [0]=> - string(16) "Gizmo " -} -]]> - - - - - - - - diff --git a/reference/ibm_db2/functions/db2-num-fields.xml b/reference/ibm_db2/functions/db2-num-fields.xml deleted file mode 100644 index 7928446230..0000000000 --- a/reference/ibm_db2/functions/db2-num-fields.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - db2_num_fields - - Devuelve el número de campos contenido en el conjunto de resultados - - - - &reftitle.description; - - intfalsedb2_num_fields - resourcestmt - - - - Devuelve el número de campos contenidos en el conjunto de resultados. Esta - función es muy útil cuando se gestionan conjuntos de resultados devueltos - por consultas generadas dinámicamente o para conjuntos de resultados - devueltos por procedimientos de registro, donde la aplicación no puede - hacer otra cosa para obtener y utilizar estos resultados. - - - - - &reftitle.parameters; - - - stmt - - - Un recurso válido que contiene un conjunto de resultados. - - - - - - - &reftitle.returnvalues; - - Devuelve un entero que representa el número de campos en el conjunto de - resultados asociado con el recurso especificado. Devuelve &false; si el - recurso no es válido. - - - - - &reftitle.examples; - - Ejemplo con <function>db2_num_fields</function> - - El siguiente ejemplo demuestra cómo obtener el número de campos devueltos - en el conjunto de resultados. - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_execute - db2_field_display_size - db2_field_name - db2_field_num - db2_field_precision - db2_field_scale - db2_field_type - db2_field_width - - - - diff --git a/reference/ibm_db2/functions/db2-num-rows.xml b/reference/ibm_db2/functions/db2-num-rows.xml deleted file mode 100644 index bde66af5a9..0000000000 --- a/reference/ibm_db2/functions/db2-num-rows.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - db2_num_rows - - Devuelve el número de filas afectadas por una consulta SQL - - - - &reftitle.description; - - intfalsedb2_num_rows - resourcestmt - - - - Devuelve el número de filas eliminadas, añadidas o actualizadas por una - consulta SQL. - - - Para determinar el número de filas que devolverá una consulta SELECT, - utilice la consulta SELECT COUNT(*) con los mismos atributos cuando se - haya ejecutado la consulta SELECT y la recuperación de los valores. - - - Si la lógica de la aplicación verifica el número de filas devueltas por - una consulta SELECT y salta si el número de filas es 0, - modifique la aplicación para intentar devolver la primera fila con - db2_fetch_assoc, db2_fetch_both, - db2_fetch_array o db2_fetch_row, - y salte si la función devuelve &false;. - - - - - Si se envía una consulta SELECT con un cursor flotante, - db2_num_rows devolverá el número de filas devueltas - por la consulta SELECT. Sin embargo, el tiempo de sistema asociado con los - cursores flotantes degrada considerablemente el rendimiento de la - aplicación, por lo que si esta es la única razón para utilizar cursores - flotantes, se deberían utilizar cursores de avance solo y además llamar a - SELECT COUNT(*) o confiar en los valores de retorno de las funciones de - tipo bool para obtener la misma funcionalidad con un - rendimiento mucho mejor. - - - - - - &reftitle.parameters; - - - stmt - - - Un recurso stmt válido que contiene el conjunto de - resultados. - - - - - - - &reftitle.returnvalues; - - Devuelve el número de filas afectadas por la última consulta SQL enviada - por una función que ejecuta consultas SQL, &return.falseforfailure; - - - - - diff --git a/reference/ibm_db2/functions/db2-pclose.xml b/reference/ibm_db2/functions/db2-pclose.xml deleted file mode 100644 index 1eed60de6e..0000000000 --- a/reference/ibm_db2/functions/db2-pclose.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - - db2_pclose - Cierra una conexión persistente a la base de datos - - - - &reftitle.description; - - booldb2_pclose - resourceconnection - - - Esta función cierra una conexión DB2, creada con - db2_pconnect y libera los recursos correspondientes - del servidor. - - - Esta función no está disponible en i5/OS en respuesta a solicitudes - de administración i5/OS. - - - - - Si se tiene una conexión persistente DB2 creada con la función - db2_pconnect, puede utilizarse esta función para - cerrar la conexión. Para evitar costos significativos de conexión, esta - función solo debe utilizarse en casos raros, donde la conexión se haya vuelto - inactiva, o cuando la conexión persistente no será utilizada por un largo tiempo. - - - - - &reftitle.parameters; - - - connection - - - Un recurso de conexión DB2 activo. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Cerrar una conexión DB2 persistente - - El ejemplo a continuación muestra cómo cerrar una conexión - en un servidor IBM DB2 i5/OS. - - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_close - db2_pconnect - - - - - diff --git a/reference/ibm_db2/functions/db2-pconnect.xml b/reference/ibm_db2/functions/db2-pconnect.xml deleted file mode 100644 index 571558b8fa..0000000000 --- a/reference/ibm_db2/functions/db2-pconnect.xml +++ /dev/null @@ -1,699 +0,0 @@ - - - - - - db2_pconnect - - Devuelve una conexión persistente a una base de datos - - - - &reftitle.description; - - resourcefalsedb2_pconnect - stringdatabase - stringnullusername - stringnullpassword - arrayoptions[] - - - - Devuelve una conexión persistente a una base de datos IBM DB2 - Universal Database, IBM Cloudscape o Apache Derby. - - - - Para más información sobre las conexiones persistentes, véase - . - - - - Al llamar a db2_close sobre una conexión persistente, - siempre se recibirá &true;, pero las conexiones de los clientes DB2 - permanecerán abiertas y esperarán para servir la próxima petición de la - función db2_pconnect. - - - - Los usuarios de versiones 1.9.0 o superiores de ibm_db2 deben saber que la extensión - ejecutará un rollback sobre una transacción en una conexión persistente al final - de la consulta, terminando así la transacción. Esto evita un bloqueo transaccional - hacia la consulta siguiente sobre la misma conexión si la ejecución del script termina - antes de la transacción. - - - - - &reftitle.parameters; - - - database - - - Para una conexión catalogada a una base de datos, database - representa el alias de la base de datos en el catálogo del cliente DB2. - - - Para una conexión no catalogada a una base de datos, - database representa una cadena de conexión completa - en el siguiente formato : - DATABASE=database;HOSTNAME=hostname;PORT=port;PROTOCOL=TCPIP;UID=username;PWD=password; - - - Al conectarse a Db2 sobre IBM i, las llamadas al sistema subyacentes - SQLDriverConnect, - solo aceptan DSN, UID y PWD para la - cadena de conexión. - Como sigue : - DSN=database;UID=username;PWD=password; - - - donde los parámetros representan los siguientes valores : - - - database - - - El nombre de la base de datos. - - - - - hostname - - - El nombre de host o la dirección IP del servidor de la base de datos. - - - - - port - - - El puerto TCP/IP en el que la base de datos escucha - las consultas. - - - - - username - - - El nombre de usuario con el que se conecta a la - base de datos. - - - - - password - - - La contraseña con la que se conecta a la base de datos. - - - - - - - - - username - - - El nombre de usuario con el que se conecta a la base de - datos. - - - - - password - - - La contraseña con la que se conecta a la base de datos. - - - - - options - - - Un array asociativo de opciones de conexión que afectarán el - comportamiento de la conexión, donde los valores de las claves incluyen : - - - autocommit - - - El valor DB2_AUTOCOMMIT_ON activa el autocommit - en esta conexión. - - - El valor DB2_AUTOCOMMIT_OFF desactiva el - autocommit para esta conexión. - - - - - DB2_ATTR_CASE - - - Pasar el valor DB2_CASE_NATURAL especifica que los - nombres de columnas serán devueltos en sus casos naturales. - - - Pasar el valor DB2_CASE_LOWER especifica que los - nombres de columnas serán devueltos en minúsculas. - - - Pasar el valor DB2_CASE_UPPER especifica que los - nombres de columnas serán devueltos en mayúsculas. - - - - - CURSOR - - - Pasar el valor DB2_FORWARD_ONLY especifica un cursor - solo hacia adelante para un recurso de consulta. Este es el tipo de cursor - por defecto y es soportado en todos los servidores de base de datos. - - - Pasar el valor DB2_SCROLLABLE especifica un - cursor desplazable para un recurso de consulta. Este modo permite - un acceso aleatorio a las filas en un conjunto de resultados, pero actualmente, - solo es soportado por la base de datos IBM DB2 Universal. - - - - - - - Las siguientes opciones están disponibles desde ibm_db2 versión 1.7.0. - - - trustedcontext - - - Al pasar el valor DB2_TRUSTED_CONTEXT_ENABLE, el contexto de confianza - es activado para esta conexión. Este parámetro no puede ser activado - con db2_set_option. - - - Esta opción solo funciona si la base está catalogada, incluso si la base - es local, o si se especifica un DSN completo al crear la conexión. - - - Para catalogar la base, utilice el siguiente comando : - - db2 catalog tcpip node loopback remote <SERVERNAME> server <SERVICENAME> -db2 catalog database <LOCALDBNAME> as <REMOTEDBNAME> at node loopback -db2 "update dbm cfg using svcename <SERVICENAME>" -db2set DB2COMM=TCPIP - - - - - - - Las siguientes opciones i5/OS están disponibles desde ibm_db2 versión 1.5.1. - - - Atributos de conexión contradictorios, en conjunción con una - conexión persistente pueden producir resultados indeterminados en i5/OS. - La política del sitio debe ser establecida para todas las aplicaciones que - utilizan una conexión persistente. El valor por defecto de - DB2_AUTOCOMMIT_ON es recomendado con las conexiones persistentes. - - - - - i5_lib - - - Un carácter que indica la biblioteca por defecto que será - utilizada para resolver las referencias de ficheros no calificadas. - Esta opción no es válida si la conexión utiliza el modo - de nombramiento del sistema. - - - - - i5_naming - - - DB2_I5_NAMING_ON activa el modo de nombramiento del sistema - de DB2 UDB CLI iSeries. Los ficheros son entonces calificados con el delimitador - slash (/). Los ficheros no calificados son resueltos utilizando la lista - de bibliotecas de la tarea. - - - DB2_I5_NAMING_OFF activa el modo de nombramiento por defecto, - que es el nombramiento SQL. Los ficheros son entonces calificados con el punto (.) . - Los ficheros no calificados son resueltos con la biblioteca por defecto, - o bien el identificador del usuario actual. - - - - - i5_commit - - - El atributo i5_commit debe ser configurado antes - de la llamada a db2_pconnect. Si el valor es cambiado - después de la conexión, y la conexión se efectúa sobre datos remotos, - entonces este cambio no tendrá efectos, hasta la próxima llamada exitosa - a db2_pconnect. - - - La directiva del &php.ini; ibm_db2.i5_allow_commit==0 - o DB2_I5_TXN_NO_COMMIT es el valor por defecto, pero puede - ser reemplazado por la opción i5_commit. - - - - - DB2_I5_TXN_NO_COMMIT : el control de validación no es utilizado. - - - DB2_I5_TXN_READ_UNCOMMITTED : las lecturas inconsistentes, - o no repetibles y los fantasmas son posibles. - - - DB2_I5_TXN_READ_COMMITTED : las lecturas son consistentes. - Las lecturas no repetibles y los fantasmas son posibles. - - - DB2_I5_TXN_REPEATABLE_READ : las lecturas consistentes y - repetibles, pero los fantasmas son posibles. - - - DB2_I5_TXN_SERIALIZABLE : las transacciones son activadas. - Las lecturas inconsistentes, o no repetibles y los fantasmas son imposibles. - - - - - i5_query_optimize - - - DB2_FIRST_IO : todas las consultas son optimizadas - con el objetivo de devolver la primera página lo más rápidamente posible. - Este objetivo funciona bien cuando el resultado es controlado por un - usuario que tiene buenas probabilidades de cancelar la consulta después de ver - las primeras respuestas. Las consultas codificadas con una cláusula - OPTIMIZE FOR nnn ROWS respetan también este objetivo. - - - DB2_ALL_IO : todas las consultas son optimizadas - con el objetivo de procesar la consulta completa lo más rápidamente posible. - Esta es una buena opción cuando el resultado de la consulta debe ser - escrito en un fichero o un informe, o que la interfaz acumula todos - los datos antes de exportarlos. Las consultas codificadas con la cláusula - OPTIMIZE FOR nnn ROWS respetan también este objetivo. - Este es el comportamiento por defecto. - - - - - i5_dbcs_alloc - - - DB2_I5_DBCS_ALLOC_ON activa el esquema de asignación - DB2 6X para el crecimiento de las tallas de columnas de traducción DBCS. - - - DB2_I5_DBCS_ALLOC_OFF desactiva el esquema de asignación - DB2 6X para el crecimiento de las tallas de columnas de traducción DBCS. - - - La directiva del &php.ini; ibm_db2.i5_dbcs_alloc==0 - o DB2_I5_DBCS_ALLOC_OFF es el valor por defecto, pero puede - ser reemplazado por la opción i5_dbcs_alloc. - - - - - - - i5_date_fmt - - - DB2_I5_FMT_ISO : el formato de fecha ISO - (International Organization for Standardization) es - utilizado : yyyy-mm-dd. Este es el formato por defecto. - - - DB2_I5_FMT_USA : el formato de los Estados Unidos de América - es utilizado : mm/dd/yyyy. - - - DB2_I5_FMT_EUR : el formato de fecha europeo - dd.mm.yyyy es utilizado. - - - DB2_I5_FMT_JIS : el formato estándar industrial japonés - yyyy-mm-dd es utilizado. - - - DB2_I5_FMT_MDY : el formato de fecha - mm/dd/yyyy es utilizado. - - - DB2_I5_FMT_DMY : el formato de fecha - dd/mm/yyyy es utilizado. - - - DB2_I5_FMT_YMD : el formato de fecha - yy/mm/dd es utilizado. - - - DB2_I5_FMT_JUL : El formato de fecha juliano - yy/ddd es utilizado. - - - DB2_I5_FMT_JOB : el formato de fecha por defecto es utilizado. - - - - - i5_date_sep - - - DB2_I5_SEP_SLASH : un slash ( / ) es utilizado como separador de fecha. - Este es el formato por defecto. - - - DB2_I5_SEP_DASH : un guión ( - ) es utilizado como separador de fecha. - - - DB2_I5_SEP_PERIOD : un punto ( . ) es utilizado como separador de fecha. - - - DB2_I5_SEP_COMMA : una coma ( , ) es utilizada como separador de fecha. - - - DB2_I5_SEP_BLANK : un espacio es utilizado como separador de fecha. - - - DB2_I5_SEP_JOB : la configuración por defecto es utilizada - - - - - i5_time_fmt - - - DB2_I5_FMT_ISO : el formato de hora ISO - (International Organization for Standardization) es - utilizado : hh.mm.ss. Este es el formato por defecto. - - - DB2_I5_FMT_USA : el formato de los Estados Unidos de América - es utilizado : hh:mmxx es utilizado, donde xx - vale AM o PM. - - - DB2_I5_FMT_EUR : el formato de hora europeo - hh.mm.ss es utilizado. - - - DB2_I5_FMT_JIS : el formato estándar industrial japonés - es utilizado hh:mm:ss. - - - DB2_I5_FMT_HMS : el formato hh:mm:ss - es utilizado. - - - - - i5_time_sep - - - DB2_I5_SEP_COLON : un dos-puntos ( : ) es utilizado como - separador de hora. Este es el defecto. - - - DB2_I5_SEP_PERIOD : un punto ( . ) es utilizado como - separador de hora. - - - DB2_I5_SEP_COMMA : una coma ( , ) es utilizada como - separador de hora. - - - DB2_I5_SEP_BLANK : un espacio es utilizado como - separador de hora. - - - DB2_I5_SEP_JOB : el separador por defecto es utilizado. - - - - - i5_decimal_sep - - - DB2_I5_SEP_PERIOD : un punto ( . ) es utilizado como - separador decimal. Este es el separador por defecto. - - - DB2_I5_SEP_COMMA : una coma ( , ) es utilizada como - separador decimal. - - - DB2_I5_SEP_JOB : el separador por defecto es utilizado. - - - - - - - Las siguientes opciones i5/OS están disponibles desde ibm_db2 versión 1.8.0. - - - i5_libl - - - Un carácter que indica la biblioteca que será utilizada para resolver - las referencias de ficheros no calificadas. Especifique la lista de bibliotecas - en la forma de elementos separados por espacios : - 'i5_libl'=>"MYLIB YOURLIB ANYLIB". - - - i5_libl llama a qsys2/qcmdexc('cmd',cmdlen), que - está disponible desde i5/OS V5R4. - - - - - - - - - - - - - &reftitle.returnvalues; - - Devuelve el recurso de conexión si la tentativa de conexión tiene éxito. - db2_pconnect intenta reutilizar un recurso de - conexión existente que coincide perfectamente con los parámetros tales como la base de datos - database, el usuario username - y la contraseña password. Si la tentativa de - conexión falla, db2_pconnect devuelve &false; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL ibm_db2 1.9.0 - - Las transacciones activas sobre conexiones persistentes serán anuladas al - final de cada consulta. - - - - PECL ibm_db2 1.8.0 - - La opción i5_libl está disponible para los usuarios - de i5/OS. - - - - PECL ibm_db2 1.7.0 - - La opción trustedcontext está disponible. - - - - PECL ibm_db2 1.5.1 - - Las opciones i5_lib, i5_naming, - i5_commit, - i5_query_optimize, - i5_dbcs_alloc, - i5_date_fmt, - i5_date_sep, - i5_time_fmt, i5_time_sep - y i5_decimal_sep están disponibles para los usuarios - de i5/OS. - - - - - - - - - &reftitle.examples; - - - Ejemplo de uso de <function>db2_pconnect</function> - - En el siguiente ejemplo, la primera llamada a - db2_pconnect devuelve un nuevo recurso de - conexión persistente. La segunda llamada a la función - db2_pconnect devuelve un recurso de conexión - persistente que reutiliza el primer recurso de conexión. - - - -]]> - - &example.outputs; - - - - - - Uso de contextos de confianza DB2 - - El siguiente ejemplo muestra cómo activar un usuario de confianza, - cambiar a él, y obtener un identificador de usuario. - - - DB2_TRUSTED_CONTEXT_ENABLE); - -$tc_conn = db2_pconnect($dsn, "", "", $options); -if($tc_conn) { - echo "Conexión de confianza exitosa.\n"; - - if(db2_get_option($tc_conn, "trustedcontext")) { - $userBefore = db2_get_option($tc_conn, "trusted_user"); - - //Trabajo por el usuario 1. - - //Cambio al usuario de confianza. - $parameters = array("trusted_user" => $tc_user, - "trusted_password" => $tcuser_pass); - $res = db2_set_option ($tc_conn, $parameters, 1); - - $userAfter = db2_get_option($tc_conn, "trusted_user"); - //Hacer más trabajo como usuario de confianza. - - if($userBefore != $userAfter) { - echo "Usuario cambiado." . "\n"; - } - } - - db2_close($tc_conn); -} -else { - echo "Conexión de confianza fallida.\n"; -} -?> - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - db2_connect - - - - - diff --git a/reference/ibm_db2/functions/db2-prepare.xml b/reference/ibm_db2/functions/db2-prepare.xml deleted file mode 100644 index 297ee0dbfc..0000000000 --- a/reference/ibm_db2/functions/db2-prepare.xml +++ /dev/null @@ -1,175 +0,0 @@ - - - - - - - db2_prepare - - Prepara una consulta SQL para ser ejecutada - - - - &reftitle.description; - - resourcefalsedb2_prepare - resourceconnection - stringstatement - arrayoptions[] - - - - db2_prepare crea una consulta SQL preparada que puede - incluir ningún o varios marcadores (caracteres ?) - representando los argumentos de entrada, salida o entrada/salida. Se - pueden pasar argumentos a la consulta preparada utilizando la - función db2_bind_param, si solo hay entradas, - se puede utilizar db2_execute. - - - Existen tres ventajas principales de utilizar consultas preparadas en - la aplicación : - - - - Rendimiento : al preparar una consulta, el - servidor de base de datos crea un plan de acceso optimizado para la - recuperación de datos con la consulta. Posteriormente, el envío de la - consulta preparada con db2_execute permite a la - consulta reutilizar el plan de acceso y así evitar sobrecargas del - procesador en cada envío de consulta que crearía dinámicamente un - nuevo plan de acceso. - - - - - Seguridad : al preparar una consulta, se pueden - incluir marcadores para los valores de entrada. Al ejecutar una - consulta preparada con estos valores de entrada, el servidor de - base de datos verifica cada valor de entrada para asegurarse de que - los tipos coincidan con la definición de la columna o del parámetro - de definición. - - - - - Funcionalidad avanzada : Los marcadores permiten - no solo pasar valores de entrada en las consultas SQL preparadas, - sino también recuperar parámetros de SALIDA y de ENTRADA/SALIDA de - los procedimientos de registro utilizando la función - db2_bind_param. - - - - - - - - &reftitle.parameters; - - - connection - - - Una variable recurso de conexión válida devuelta por - db2_connect o db2_pconnect. - - - - - statement - - - Una consulta SQL que puede contener uno o varios marcadores. - - - - - options - - - Un array asociativo que contiene las opciones de la consulta. Se - puede utilizar este parámetro para solicitar un cursor flotante en - los servidores de base de datos que soportan esta funcionalidad. - - - Para una descripción de las opciones válidas, consulte la función - db2_set_option. - - - - - - - &reftitle.returnvalues; - - Devuelve una variable recurso si la consulta SQL fue enviada - correctamente o &false; si el servidor de base de datos ha - devuelto un error. Se puede determinar qué error fue devuelto - llamando a la función - db2_stmt_error o db2_stmt_errormsg. - - - - - &reftitle.examples; - - Preparación y ejecución de una consulta SQL con marcadores - - El siguiente ejemplo prepara una consulta INSERT que acepta cuatro - marcadores, luego itera sobre el array que contiene los valores de - entrada que serán pasados a la función db2_execute. - - - -]]> - - - - - - &reftitle.seealso; - - db2_bind_param - db2_execute - db2_stmt_error - db2_stmt_errormsg - - - - diff --git a/reference/ibm_db2/functions/db2-primary-keys.xml b/reference/ibm_db2/functions/db2-primary-keys.xml deleted file mode 100644 index 93c7376d37..0000000000 --- a/reference/ibm_db2/functions/db2-primary-keys.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - - db2_primary_keys - - Devuelve un conjunto de resultados que lista las claves de una tabla - - - - &reftitle.description; - - resourcedb2_primary_keys - resourceconnection - stringnullqualifier - stringnullschema - stringtable_name - - - - Devuelve un conjunto de resultados que lista las claves de una tabla. - - - - - &reftitle.parameters; - - - connection - - - Una conexión válida a una base de datos IBM DB2, Cloudscape o - Apache Derby. - - - - - qualifier - - - Un calificador para las bases de datos DB2 que funcionan en - los servidores OS/390 o z/OS. Para otras bases de datos, pase - &null; o una cadena vacía. - - - - - schema - - - El esquema que contiene las tablas. Si schema es - &null;, db2_primary_keys hace coincidir el esquema - para la conexión actual. - - - - - table_name - - - El nombre de la tabla. - - - - - - - &reftitle.returnvalues; - - Devuelve un recurso con el conjunto de resultados que contiene filas - que describen las claves primarias de la tabla especificada. El conjunto de resultados - está compuesto por las siguientes columnas: - - - - - Nombre de la columna - Descripción - - - - - TABLE_CAT - Nombre del catálogo de la tabla que contiene la clave primaria. El valor es &null; si la tabla no tiene catálogo. - - - TABLE_SCHEM - Nombre del esquema de la tabla que contiene la clave primaria. - - - TABLE_NAME - Nombre de la tabla que contiene la clave primaria. - - - COLUMN_NAME - Nombre de la columna que contiene la clave primaria. - - - KEY_SEQ - Posición, comenzando en 1, de la columna en la clave. - - - PK_NAME - Nombre de la clave primaria. - - - - - - - - - &reftitle.seealso; - - db2_column_privileges - db2_columns - db2_foreign_keys - db2_procedure_columns - db2_procedures - db2_special_columns - db2_statistics - db2_table_privileges - db2_tables - - - - diff --git a/reference/ibm_db2/functions/db2-procedure-columns.xml b/reference/ibm_db2/functions/db2-procedure-columns.xml deleted file mode 100644 index 62ca61bb31..0000000000 --- a/reference/ibm_db2/functions/db2-procedure-columns.xml +++ /dev/null @@ -1,247 +0,0 @@ - - - - - - - db2_procedure_columns - - Devuelve un conjunto de resultados que lista los argumentos de procedimiento de registro - - - - &reftitle.description; - - resourcedb2_procedure_columns - resourceconnection - stringnullqualifier - stringschema - stringprocedure - stringnullparameter - - - - Devuelve un conjunto de resultados que lista los argumentos para uno o varios - procedimientos de registro. - - - - - &reftitle.parameters; - - - connection - - - Una conexión válida a una base de datos IBM DB2, Cloudscape o - Apache Derby. - - - - - qualifier - - - Un calificador para las bases de datos DB2 que funcionan en - los servidores OS/390 o z/OS. Para otras bases de datos, - pase &null; o una cadena vacía. - - - - - schema - - - El esquema que contiene las tablas. El argumento acepta formas - que contienen _ y % como comodín. - - - - - procedure - - - El nombre del procedimiento. El argumento acepta formas - que contienen _ y % como comodín. - - - - - parameter - - - El nombre del argumento. Este argumento acepta un argumento de búsqueda que - contiene _ y % como comodín. Si este - argumento es &null;, se devuelven todos los argumentos para el procedimiento - de registro especificado. - - - - - - - &reftitle.returnvalues; - - Devuelve un recurso con el conjunto de resultados que contiene las filas que - describen los argumentos para los procedimientos de registro que coinciden - con los argumentos especificados. Las filas están compuestas por las siguientes columnas: - - - - - Nombre de la columna - Descripción - - - - - PROCEDURE_CAT - Nombre del catálogo que contiene la tabla. - El valor es &null; si la tabla no tiene catálogo. - - - PROCEDURE_SCHEM - Nombre del esquema que contiene el procedimiento de registro. - - - PROCEDURE_NAME - Nombre del procedimiento. - - - COLUMN_NAME - Nombre del argumento. - - - COLUMN_TYPE - - - Un integer que representa el tipo del argumento: - - - - - Valor de retorno - Tipo de argumento - - - - - 1 (SQL_PARAM_INPUT) - Argumento de entrada (IN). - - - 2 (SQL_PARAM_INPUT_OUTPUT) - Argumento de entrada/salida (INOUT). - - - 3 (SQL_PARAM_OUTPUT) - Argumento de salida (OUT). - - - - - - - - - DATA_TYPE - El tipo de datos SQL para el argumento representado como integer. - - - TYPE_NAME - Una string que representa el tipo de datos para el argumento. - - - COLUMN_SIZE - Un integer que representa el tamaño del argumento. - - - BUFFER_LENGTH - Número máximo de bytes necesarios para almacenar datos de este argumento. - - - DECIMAL_DIGITS - La escala del argumento o &null; donde la escala no es aplicable. - - - NUM_PREC_RADIX - Un integer que puede ser 10 (que representa un tipo de datos numérico exacto), 2 (que representa una aproximación de tipo de datos numéricos) o &null; (que representa un tipo de datos para el cual la base no es aplicable). - - - NULLABLE - Un integer que representa si el argumento puede ser nulo o no. - - - REMARKS - Descripción del argumento. - - - COLUMN_DEF - Valor por defecto del argumento. - - - SQL_DATA_TYPE - Un integer que representa el tamaño del argumento. - - - SQL_DATETIME_SUB - Devuelve un integer que representa un código de subtipo - datetime o - &null; si los tipos de datos SQL no aplican. - - - CHAR_OCTET_LENGTH - Tamaño máximo en bytes para los tipos de datos de carácter del argumento, que coincide con COLUMN_SIZE para un solo byte de datos o &null; para un tipo de datos que no es de caracteres. - - - ORDINAL_POSITION - La posición del argumento comenzando en 1 en la consulta - CALL. - - - IS_NULLABLE - Una string cuyo valor es YES significa que el argumento - acepta o devuelve valores &null; y NO significa que el - argumento no acepta ni devuelve valores &null;. - - - - - - - - - &reftitle.seealso; - - db2_column_privileges - db2_columns - db2_foreign_keys - db2_primary_keys - db2_procedures - db2_special_columns - db2_statistics - db2_table_privileges - db2_tables - - - - diff --git a/reference/ibm_db2/functions/db2-procedures.xml b/reference/ibm_db2/functions/db2-procedures.xml deleted file mode 100644 index 71fc8eed2d..0000000000 --- a/reference/ibm_db2/functions/db2-procedures.xml +++ /dev/null @@ -1,160 +0,0 @@ - - - - - - - db2_procedures - - Devuelve un conjunto de resultados que lista las proceduras de registro - almacenadas en la base de datos - - - - &reftitle.description; - - resourcedb2_procedures - resourceconnection - stringnullqualifier - stringschema - stringprocedure - - - - Devuelve un conjunto de resultados que lista las proceduras de registro - almacenadas en la base de datos. - - - - - &reftitle.parameters; - - - connection - - - Una conexión válida a una base de datos IBM DB2, Cloudscape o - Apache Derby. - - - - - qualifier - - - Un calificador para las bases de datos DB2 que funcionan en - los servidores OS/390 o z/OS. Para otras bases de datos, - pase &null; o una cadena vacía. - - - - - schema - - - El esquema que contiene las tablas. El parámetro acepta las formas - que contienen _ y % como palabras clave. - - - - - procedure - - - El nombre de la procedura. El parámetro acepta las formas - que contienen _ y % como palabras clave. - - - - - - - &reftitle.returnvalues; - - Devuelve un recurso con el conjunto de resultados que contiene las filas que - describen las proceduras de registro que coinciden con los parámetros - especificados. Las filas están compuestas por las siguientes columnas: - - - - - Nombre de la columna - Descripción - - - - - PROCEDURE_CAT - Nombre del catálogo que contiene la tabla. - El valor es &null; si la tabla no tiene catálogo. - - - PROCEDURE_SCHEM - Nombre del esquema que contiene la procedura de registro. - - - PROCEDURE_NAME - Nombre de la procedura. - - - NUM_INPUT_PARAMS - Número de parámetros de entrada (IN) para la procedura de registro. - - - NUM_OUTPUT_PARAMS - Número de parámetros de salida (OUT) para la procedura de registro. - - - NUM_RESULT_SETS - Número de conjuntos de resultados devueltos por la procedura de registro. - - - REMARKS - Comentarios sobre la procedura de registro. - - - PROCEDURE_TYPE - Siempre devuelve 1, indicando que la - procedura de registro no devuelve ningún valor de retorno. - - - - - - - - - &reftitle.seealso; - - db2_column_privileges - db2_columns - db2_foreign_keys - db2_primary_keys - db2_procedure_columns - db2_special_columns - db2_statistics - db2_table_privileges - db2_tables - - - - diff --git a/reference/ibm_db2/functions/db2-result.xml b/reference/ibm_db2/functions/db2-result.xml deleted file mode 100644 index 4100be7f61..0000000000 --- a/reference/ibm_db2/functions/db2-result.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - db2_result - - Devuelve un valor de una columna de una fila de un conjunto de resultados - - - - &reftitle.description; - - mixednulldb2_result - resourcestmt - intstringcolumn - - - - Utilice db2_result para devolver un valor de una - columna específica en la fila actual de un conjunto de resultados. Debe - llamarse a db2_fetch_row antes de llamar a - db2_result para almacenar los valores apuntados del - conjunto de resultados. - - - - - &reftitle.parameters; - - - stmt - - - Un recurso stmt válido. - - - - - column - - - Un array de enteros que comienza con el índice 0 que apunta a los - campos del conjunto de resultados o una cadena que representa el nombre - de la columna. - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor del campo solicitado si el campo existe en el conjunto de - resultados. Devuelve &null; si el campo no existe y genera una alerta PHP. - - - - - &reftitle.examples; - - Ejemplo de uso de <function>db2_result</function> - - El siguiente ejemplo demuestra cómo iterar a través de un conjunto de - resultados con la función db2_fetch_row y recuperar - las columnas del conjunto de resultados con db2_result. - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_fetch_array - db2_fetch_assoc - db2_fetch_both - db2_fetch_object - db2_fetch_row - - - - diff --git a/reference/ibm_db2/functions/db2-rollback.xml b/reference/ibm_db2/functions/db2-rollback.xml deleted file mode 100644 index 87d20e6296..0000000000 --- a/reference/ibm_db2/functions/db2-rollback.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - - db2_rollback - - Cancelar una transacción - - - - &reftitle.description; - - booldb2_rollback - resourceconnection - - - - Cancela una transacción en progreso en el recurso de conexión especificado - y comienza una nueva transacción. Comunmente las aplicaciones de PHP confirman las - transacciones de manera automática por lo que la función db2_rollback - no tendría efecto a menos que este modo haya sido desactivado para este recurso. - - - - - &reftitle.parameters; - - - connection - - - Un recurso de conexión válido devuelto por - db2_connect o db2_pconnect. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Cancelando una sentencia DELETE - - En el siguiente ejemplo se cuenta el número de filas en una tabla, se cancelan - las confirmaciones automáticas en la conexión, se eliminan todas las filas de la tabla - y devuelve el total de 0 para confirmar que las filas se han borrado. - Cuando se llama a db2_rollback - y se devuelve el total actualizado de filas en la tabla para demostrar que el número es - igual al original (antes de ejecutar la sentancia DELETE). Esto demuestra - que la cancelación de la transacción fue correcto. - - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - db2_autocommit - db2_commit - - - - - diff --git a/reference/ibm_db2/functions/db2-server-info.xml b/reference/ibm_db2/functions/db2-server-info.xml deleted file mode 100644 index 1932755238..0000000000 --- a/reference/ibm_db2/functions/db2-server-info.xml +++ /dev/null @@ -1,393 +0,0 @@ - - - - - - - db2_server_info - Devuelve un objeto con propiedades que describen el servidor de base de datos DB2 - - - &reftitle.description; - - stdClassfalsedb2_server_info - resourceconnection - - - - Esta función devuelve un objeto con propiedades de solo lectura que - proporcionan información sobre el servidor de base de datos IBM DB2, - Cloudscape o Apache Derby. La tabla siguiente lista las propiedades del - servidor de base de datos: - - Propiedades del servidor de base de datos - - - - Nombre de la propiedad - Tipo de retorno - Descripción - - - - - DBMS_NAME - &string; - El nombre del servidor de base de datos al que se está - conectado. Para servidores DB2, es una combinación de - DB2 seguido del sistema operativo en el que - funciona el servidor de base de datos. - - - DBMS_VER - &string; - La versión del servidor de base de datos, en formato de - &string; "MM.mm.uuuu" donde MM es la versión mayor, - mm es la versión menor y uuuu - es la actualización. Por ejemplo, "08.02.0001" representa la versión - mayor 8, la versión menor 2, la actualización 1. - - - - DB_CODEPAGE - &integer; - La página de código de la base de datos a la que se está - conectado. - - - DB_NAME - &string; - El nombre de la base de datos a la que se está conectado. - - - DFT_ISOLATION - &string; - - El nivel predeterminado de aislamiento de transacción soportado por el - servidor: - - - UR - - - Lectura no confirmada (Uncommitted read): los cambios son - inmediatamente visibles para todas las transacciones concurrentes. - - - - - CS - - - Estabilidad del cursor (Cursor stability): una fila leída por una - transacción puede ser modificada y confirmada por una segunda - transacción concurrente. - - - - - RS - - - Estabilidad de lectura (Read stability): una transacción puede - agregar o eliminar filas que coincidan con una condición - de búsqueda o una transacción pendiente. - - - - - RR - - - Lectura repetible (Repeatable read): los datos afectados por las - transacciones pendientes no están disponibles para otras - transacciones. - - - - - NC - - - Sin confirmación (No commit): todo cambio es visible al final - de una operación exitosa. Las confirmaciones explícitas y los retrocesos no están - permitidos. - - - - - - - - - IDENTIFIER_QUOTE_CHAR - &string; - El carácter utilizado para delimitar un identificador. - - - INST_NAME - &string; - La instancia en el servidor de base de datos que contiene la - base de datos. - - - ISOLATION_OPTION - &array; - Un array de opciones de aislamiento soportadas por el servidor de - base de datos. Las opciones de aislamiento se describen en la - propiedad DFT_ISOLATION. - - - KEYWORDS - &array; - Un array de palabras clave reservadas por el servidor de base de - datos. - - - LIKE_ESCAPE_CLAUSE - &boolean; - &true; si el servidor de base de datos soporta el uso de - los caracteres comodín % y - _. &false; si el servidor de base de datos no - soporta estos caracteres comodín. - - - MAX_COL_NAME_LEN - &integer; - Tamaño máximo de un nombre de columna soportado por el servidor de - base de datos, expresado en bytes. - - - MAX_IDENTIFIER_LEN - &integer; - Tamaño máximo de un identificador SQL soportado por los servidores - de base de datos, expresado en caracteres. - - - MAX_INDEX_SIZE - &integer; - Tamaño máximo de las columnas combinadas en un índice soportado - por el servidor de base de datos, expresado en bytes. - - - MAX_PROC_NAME_LEN - &integer; - Tamaño máximo de un nombre de procedimiento soportado por el servidor de - base de datos, expresado en bytes. - - - MAX_ROW_SIZE - &integer; - Tamaño máximo de una fila en la tabla de base soportada por - el servidor de base de datos, expresado en bytes. - - - MAX_SCHEMA_NAME_LEN - &integer; - Tamaño máximo de un nombre de esquema soportado por el servidor de - base de datos, expresado en bytes. - - - MAX_STATEMENT_LEN - &integer; - Tamaño máximo de una consulta SQL soportada por el servidor de - base de datos, expresado en bytes. - - - MAX_TABLE_NAME_LEN - &integer; - Tamaño máximo de un nombre de tabla soportado por el servidor de - base de datos, expresado en bytes. - - - NON_NULLABLE_COLUMNS - &boolean; - &true; si el servidor de base de datos soporta las columnas - que pueden ser definidas como NOT NULL, &false; si el servidor de base - de datos no soporta las columnas definidas como NOT - NULL. - - - PROCEDURES - &boolean; - &true; si el servidor de base de datos soporta el uso de - la consulta CALL para llamar a los procedimientos almacenados, &false; si - el servidor de base de datos no soporta la consulta CALL. - - - SPECIAL_CHARS - &string; - Un &string; que contiene todos los caracteres distintos de las letras - (mayúsculas y minúsculas), los dígitos y el carácter de subrayado - que pueden ser utilizados como nombre de identificador. - - - SQL_CONFORMANCE - &string; - - El nivel de conformidad con la especificación ANSI/ISO SQL-92 - ofrecido por el servidor de base de datos: - - - ENTRY - - - Nivel de conformidad SQL-92. - - - - - FIPS127 - - - Conformidad tradicional FIPS-127-2. - - - - - FULL - - - Nivel completo de conformidad SQL-92. - - - - - INTERMEDIATE - - - Nivel intermedio de conformidad SQL-92. - - - - - - - - - -
-
- -
- - &reftitle.parameters; - - - connection - - - Especifica la conexión cliente DB2 activa. - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto si la llamada es exitosa, &return.falseforfailure; - - - - - &reftitle.examples; - - Ejemplo con <function>db2_server_info</function> - - Para recuperar información sobre el servidor, se debe pasar - un recurso de conexión de base de datos válido a la función - db2_server_info. - - DBMS_NAME ); - echo "DBMS_VER: "; var_dump( $server->DBMS_VER ); - echo "DB_CODEPAGE: "; var_dump( $server->DB_CODEPAGE ); - echo "DB_NAME: "; var_dump( $server->DB_NAME ); - echo "INST_NAME: "; var_dump( $server->INST_NAME ); - echo "SPECIAL_CHARS: "; var_dump( $server->SPECIAL_CHARS ); - echo "KEYWORDS: "; var_dump( sizeof($server->KEYWORDS) ); - echo "DFT_ISOLATION: "; var_dump( $server->DFT_ISOLATION ); - echo "ISOLATION_OPTION: "; - $il = ''; - foreach( $server->ISOLATION_OPTION as $opt ) - { - $il .= $opt." "; - } - var_dump( $il ); - echo "SQL_CONFORMANCE: "; var_dump( $server->SQL_CONFORMANCE ); - echo "PROCEDURES: "; var_dump( $server->PROCEDURES ); - echo "IDENTIFIER_QUOTE_CHAR: "; var_dump( $server->IDENTIFIER_QUOTE_CHAR ); - echo "LIKE_ESCAPE_CLAUSE: "; var_dump( $server->LIKE_ESCAPE_CLAUSE ); - echo "MAX_COL_NAME_LEN: "; var_dump( $server->MAX_COL_NAME_LEN ); - echo "MAX_ROW_SIZE: "; var_dump( $server->MAX_ROW_SIZE ); - echo "MAX_IDENTIFIER_LEN: "; var_dump( $server->MAX_IDENTIFIER_LEN ); - echo "MAX_INDEX_SIZE: "; var_dump( $server->MAX_INDEX_SIZE ); - echo "MAX_PROC_NAME_LEN: "; var_dump( $server->MAX_PROC_NAME_LEN ); - echo "MAX_SCHEMA_NAME_LEN: "; var_dump( $server->MAX_SCHEMA_NAME_LEN ); - echo "MAX_STATEMENT_LEN: "; var_dump( $server->MAX_STATEMENT_LEN ); - echo "MAX_TABLE_NAME_LEN: "; var_dump( $server->MAX_TABLE_NAME_LEN ); - echo "NON_NULLABLE_COLUMNS: "; var_dump( $server->NON_NULLABLE_COLUMNS ); - - db2_close($conn); -} -?>]]> - &example.outputs; - - - - - - &reftitle.seealso; - - db2_client_info - - -
- diff --git a/reference/ibm_db2/functions/db2-set-option.xml b/reference/ibm_db2/functions/db2-set-option.xml deleted file mode 100644 index 07953bd109..0000000000 --- a/reference/ibm_db2/functions/db2-set-option.xml +++ /dev/null @@ -1,963 +0,0 @@ - - - - - - - db2_set_option - Establece opciones para una conexión o recursos - - - &reftitle.description; - - booldb2_set_option - resourceresource - arrayoptions - inttype - - - Establece opciones para un recurso o una conexión. No se pueden - establecer opciones para un conjunto de resultados. - - - - &reftitle.parameters; - - - resource - - - Un recurso válido como el devuelto por - db2_prepare o una conexión válida como - la devuelta por db2_connect o - db2_pconnect. - - - - - options - - - Un array asociativo que contiene opciones de recursos o de - conexión válidas. Este parámetro puede ser utilizado para cambiar - los valores de autocommit, tipos de cursor (flotante o de avance - único) y especificar la capitalización de los nombres de columna (minúscula, - mayúscula o natural) que aparecerá en el conjunto de resultados. - - - autocommit - - - Pasar DB2_AUTOCOMMIT_ON activa - el autocommit para la conexión especificada. - - - Pasar DB2_AUTOCOMMIT_OFF desactiva - el autocommit para la conexión especificada. - - - - - cursor - - - Pasar DB2_FORWARD_ONLY especifica un - cursor de avance único para un recurso. Este es el - tipo por defecto para un cursor y es soportado por todos - los servidores de base de datos. - - - Pasar DB2_SCROLLABLE especifica un - cursor flotante para un recurso. Los cursores - flotantes permiten que las filas de resultados sean - accesibles en un orden no secuencial. Este tipo de - cursor es soportado solo por las bases de datos - IBM DB2 Universal Database. - - - - - binmode - - - Pasar DB2_BINARY especifica que los - datos binarios serán devueltos como tales. Este es el - modo por defecto. Esto es equivalente a la - configuración ibm_db2.binmode=1 en - &php.ini;. - - - Pasar DB2_CONVERT especifica que los - datos binarios serán convertidos a codificación hexadecimal - y serán devueltos así. Esto es equivalente a la - configuración ibm_db2.binmode=2 en - &php.ini;. - - - Pasar DB2_PASSTHRU especifica que los - datos binarios serán convertidos a &null;. - Esto es equivalente a la - configuración ibm_db2.binmode=3 en - &php.ini;. - - - - - db2_attr_case - - - Pasar DB2_CASE_LOWER especifica que los - nombres de las columnas en el conjunto de resultados serán - devueltos en minúsculas. - - - Pasar DB2_CASE_UPPER especifica que los - nombres de las columnas en el conjunto de resultados serán - devueltos en mayúsculas. - - - Pasar DB2_CASE_NATURAL especifica que - los nombres de columnas en el conjunto de resultados serán - devueltos en su capitalización natural. - - - - - deferred_prepare - - - Pasar DB2_DEFERRED_PREPARE_ON activa - la preparación diferida en el recurso de consulta especificado. - - - Pasar DB2_DEFERRED_PREPARE_OFF desactiva - la preparación diferida en el recurso de consulta especificado. - - - - - - - Las siguientes nuevas opciones i5/OS están disponibles desde la - versión 1.5.1 de ibm_db2. Estas opciones se aplican únicamente cuando - PHP e ibm_db2 funcionan de forma nativa en un sistema i5. - - - i5_fetch_only - - - DB2_I5_FETCH_ON: los cursores son de - solo lectura y no pueden ser utilizados para posicionar - actualizaciones y eliminaciones. Este es el valor - por defecto a menos que la variable de entorno - SQL_ATTR_FOR_FETCH_ONLY haya sido establecida a - SQL_FALSE. - - - DB2_I5_FETCH_OFF: los cursores - pueden ser posicionados para actualizaciones y - eliminaciones. - - - - - - - Las siguientes nuevas opciones están disponibles desde - ibm_db2 versión 1.8.0 y posteriores. - - - rowcount - - - DB2_ROWCOUNT_PREFETCH_ON - El cliente puede solicitar - un conteo completo de las filas antes de recuperarlas, lo que - significa que la función db2_num_rows devuelve - el número de filas seleccionadas incluso si se utiliza un cursor - ROLLFORWARD_ONLY. - - - DB2_ROWCOUNT_PREFETCH_OFF - El cliente - no puede solicitar un conteo completo de las filas antes de recuperarlas. - - - - - - - Las siguientes opciones son nuevas y están disponibles desde - ibm_db2 versión 1.7.0. - - - trusted_user - - - Para cambiar al usuario a un usuario de confianza, - indique el identificador de usuario como string del usuario - de confianza que desea utilizar. Esta opción puede ser - configurada solo a nivel de conexión. Para utilizar esta - opción, un contexto de confianza debe estar activado en el recurso - de conexión. - - - - - trusted_password - - - La contraseña, como string, que corresponde al usuario - de confianza. - - - - - - - Las siguientes opciones son nuevas y están disponibles desde - ibm_db2 versión 1.6.0. Estas opciones son útiles para obtener información de - seguimiento, accesible a través de db2_get_option. - - - Cuando el valor de cada opción está a punto de ser definido, algunos - servidores pueden no manejar toda la longitud proporcionada y pueden - truncar el valor. - - - Para asegurarse de que los datos especificados en cada opción se convertirán - correctamente cuando se transmitan al sistema, utilice solo - los caracteres de A a Z, 0 a 9, los guiones bajos (_) y - los puntos (.). - - - - - userid - - - SQL_ATTR_INFO_USERID: un puntero a un &string; - terminado por &null; utilizado para identificar el ID de usuario del cliente enviado - al servidor de base de datos, durante la conexión DB2. - - - DB2 para servidores z/OS y OS/390 soporta una longitud mayor a - 16 caracteres. El ID de usuario no debe confundirse con el ID de usuario - de identificación, se utiliza para los procesos de identificación únicamente - y no para los de autorización. - - - - - - - acctstr - - - SQL_ATTR_INFO_ACCTSTR: un puntero a un &string; - terminado por &null; utilizado para identificar la cuenta del cliente a enviar - al servidor de base de datos durante la conexión DB2. - - - DB2 para servidores z/OS y OS/390 soporta una longitud mayor a - 200 caracteres. - - - - - - - applname - - - SQL_ATTR_INFO_APPLNAME: un puntero a un &string; - terminado por &null; utilizado para identificar el nombre de la aplicación cliente - a enviar al servidor de base de datos durante la conexión DB2. - - - DB2 para servidores z/OS y OS/390 soporta una longitud mayor a - 32 caracteres. - - - - - - - wrkstnname - - - SQL_ATTR_INFO_WRKSTNNAME: un puntero a un &string; - terminado por &null; utilizado para identificar el nombre de la estación a - enviar al servidor de base de datos durante la conexión DB2. - - - DB2 para servidores z/OS y OS/390 soporta una longitud mayor a - 18 caracteres. - - - - - - - - - - - type - - - Un &integer; que especifica el tipo de recurso que ha sido pasado a - la función. El tipo de recurso y valor deben coincidir. - - - Pasar 1 como valor especifica - que un recurso de conexión ha sido pasado a la función. - - - Pasar cualquier &integer; diferente de - 1 como valor especifica que un - recurso ha sido pasado a la función. - - - - - - - - La siguiente tabla especifica qué opciones son compatibles con qué - tipos de recursos: - - Matriz de parámetros de recurso - - - - - - - - - - Clave - Valor - Tipo de recurso - - - - - - Conexión - Consulta - Conjunto de resultados - - - autocommit - DB2_AUTOCOMMIT_ON - X - - - - - - - autocommit - DB2_AUTOCOMMIT_OFF - X - - - - - - - cursor - DB2_SCROLLABLE - - - X - - - - - cursor - DB2_FORWARD_ONLY - - - X - - - - - binmode - DB2_BINARY - X - X - - - - - binmode - DB2_CONVERT - X - X - - - - - binmode - DB2_PASSTHRU - X - X - - - - - db2_attr_case - DB2_CASE_LOWER - X - X - - - - - db2_attr_case - DB2_CASE_UPPER - X - X - - - - - db2_attr_case - DB2_CASE_NATURAL - X - X - - - - - deferred_prepare - DB2_DEFERRED_PREPARE_ON - - - X - - - - - deferred_prepare - DB2_DEFERRED_PREPARE_OFF - - - X - - - - - i5_fetch_only - DB2_I5_FETCH_ON - - - X - - - - - rowcount - DB2_ROWCOUNT_PREFETCH_ON - - - X - - - - - rowcount - DB2_ROWCOUNT_PREFETCH_OFF - - - X - - - - - trusted_user - <USER NAME> (String) - X - - - - - - - trusted_password - <PASSWORD> (String) - X - - - - - - - i5_fetch_only - DB2_I5_FETCH_OFF - - - X - - - - - userid - SQL_ATTR_INFO_USERID - X - X - - - - - acctstr - SQL_ATTR_INFO_ACCTSTR - X - X - - - - - applname - SQL_ATTR_INFO_APPLNAME - X - X - - - - - wrkstnname - SQL_ATTR_INFO_WRKSTNNAME - X - X - - - - - -
-
-
- - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Establecer un parámetro en un recurso de conexión - - DB2_AUTOCOMMIT_ON); - -/* Llamada a la función utilizando el tipo correcto de recurso, el array -* de opciones y el valor type */ -$result = db2_set_option($conn, $options, 1); - -/* Verifica si todas las opciones pueden ser establecidas correctamente */ -if($result) -{ - echo 'Opciones establecidas correctamente'; -} -else -{ - echo 'No se pueden establecer las opciones'; -} -?> -]]> - - &example.outputs; - - - - - - Establece múltiples parámetros con un recurso de conexión - - DB2_AUTOCOMMIT_OFF, -'binmode' => DB2_PASSTHRU, -'db2_attr_case' => DB2_CASE_UPPER, -'cursor' => DB2_SCROLLABLE); - -/* Llamada a la función utilizando el tipo correcto de recurso, el array -* de opciones y el valor type */ -$result = db2_set_option($conn, $options, 1); - -/* Verifica si todas las opciones pueden ser establecidas correctamente */ -if($result) -{ - echo 'Opciones establecidas correctamente'; -} -else -{ - echo 'No se pueden establecer las opciones'; -} -?> -]]> - - &example.outputs; - - - - - - - Establece múltiples parámetros con una clave inválida - - DB2_AUTOCOMMIT_OFF, -'MI_CLAVE_INVÁLIDA' => DB2_PASSTHRU, -'db2_attr_case' => DB2_CASE_UPPER, -'cursor' => DB2_SCROLLABLE); - -/* Llamada a la función utilizando el tipo correcto de recurso, el array -* de opciones y el valor type */ -$result = db2_set_option($conn, $options, 1); - -/* Verifica si todas las opciones pueden ser establecidas correctamente */ -if($result) -{ - echo 'Opciones establecidas correctamente'; -} -else -{ - echo 'No se pueden establecer las opciones'; -} -?> -]]> - - &example.outputs; - - - - - - - Establece múltiples parámetros con un valor inválido - - DB2_AUTOCOMMIT_OFF, -'binmode' => 'VALOR_INVÁLIDO', -'db2_attr_case' => DB2_CASE_UPPER, -'cursor' => DB2_SCROLLABLE); - -/* Llamada a la función utilizando el tipo correcto de recurso, el array -* de opciones y el valor type */ -$result = db2_set_option($conn, $options, 1); - -/* Verifica si todas las opciones pueden ser establecidas correctamente */ -if($result) -{ - echo 'Opciones establecidas correctamente'; -} -else -{ - echo 'No se pueden establecer las opciones'; -} -?> -]]> - - &example.outputs; - - - - - - - Establece múltiples parámetros con un recurso de conexión y un tipo incorrecto - - DB2_AUTOCOMMIT_OFF, -'binmode' => DB2_PASSTHRU, -'db2_attr_case' => DB2_CASE_UPPER, -'cursor' => DB2_SCROLLABLE); - -/* Llamada a la función utilizando el tipo incorrecto de recurso, el array -* de opciones y el valor type inválido */ -$result = db2_set_option($conn, $options, 2); - -/* Verifica si todas las opciones pueden ser establecidas correctamente */ -if($result) -{ - echo 'Opciones establecidas correctamente'; -} -else -{ - echo 'No se pueden establecer las opciones'; -} -?> -]]> - - &example.outputs; - - - - - - - Establece múltiples parámetros con un recurso incorrecto - - DB2_AUTOCOMMIT_OFF, -'binmode' => DB2_PASSTHRU, -'db2_attr_case' => DB2_CASE_UPPER, -'cursor' => DB2_SCROLLABLE); - -$stmt = db2_prepare($conn, 'SELECT * FROM EMPLOYEE'); - -/* Llamada a la función utilizando el tipo incorrecto de recurso, pero el array -* de opciones y el valor type válido */ -$result = db2_set_option($stmt, $options, 1); - -/* Verifica si todas las opciones pueden ser establecidas correctamente */ -if($result) -{ - echo 'Opciones establecidas correctamente'; -} -else -{ - echo 'No se pueden establecer las opciones'; -} -?> -]]> - - &example.outputs; - - - - - - - Todo junto - - DB2_CASE_LOWER, -'cursor' => DB2_SCROLLABLE); - -$stmt = db2_prepare($conn, 'SELECT * FROM EMPLOYEE WHERE EMPNO = ? OR EMPNO = ?'); - -/* Llamada a la función utilizando el tipo correcto de recurso, el array -* de opciones y el valor type */ -$option_result = db2_set_option($stmt, $options, 2); -$result = db2_execute($stmt, array('000130', '000140')); - -/* Obtiene la fila 2 antes que la fila 1 ya que tenemos un cursor flotante */ -print_r(db2_fetch_assoc($stmt, 2)); -print '

'; -print_r(db2_fetch_assoc($stmt, 1)); - -?> -]]> -
- &example.outputs; - - 000140 - [firstnme] => HEATHER - [midinit] => A - [lastname] => NICHOLLS - [workdept] => C01 - [phoneno] => 1793 - [hiredate] => 1976-12-15 - [job] => ANALYST - [edlevel] => 18 - [sex] => F - [birthdate] => 1946-01-19 - [salary] => 28420.00 - [bonus] => 600.00 - [comm] => 2274.00 -) - -Array -( - [empno] => 000130 - [firstnme] => DELORES - [midinit] => M - [lastname] => QUINTANA - [workdept] => C01 - [phoneno] => 4578 - [hiredate] => 1971-07-28 - [job] => ANALYST - [edlevel] => 16 - [sex] => F - [birthdate] => 1925-09-15 - [salary] => 23800.00 - [bonus] => 500.00 - [comm] => 1904.00 -) -]]> - -
- - Los cursores i5/OS son de solo lectura - -"nobody")); -$stmt = db2_prepare($conn, 'select * from names where first = ?'); -$name = "first2"; -db2_bind_param($stmt, 1, "name", DB2_PARAM_IN); -$options = array("i5_fetch_only"=>DB2_I5_FETCH_ON); -db2_set_option($stmt,$options,0); -if (db2_execute($stmt)) { - while ($row = db2_fetch_array($stmt)) { - echo "{$row[0]} {$row[1]}"; - } -} -?> -]]> - - &example.outputs; - - - - -
-
- - &reftitle.seealso; - - db2_connect - db2_pconnect - db2_exec - db2_prepare - db2_cursor_type - - -
- diff --git a/reference/ibm_db2/functions/db2-special-columns.xml b/reference/ibm_db2/functions/db2-special-columns.xml deleted file mode 100644 index c6a2c0bfb9..0000000000 --- a/reference/ibm_db2/functions/db2-special-columns.xml +++ /dev/null @@ -1,238 +0,0 @@ - - - - - - - db2_special_columns - - Devuelve un conjunto de resultados que lista los identificadores únicos de las filas de una tabla - - - - &reftitle.description; - - resourcedb2_special_columns - resourceconnection - stringnullqualifier - stringschema - stringtable_name - intscope - - - - Devuelve un conjunto de resultados que lista los identificadores únicos de las filas - de una tabla. - - - - - &reftitle.parameters; - - - connection - - - Una conexión válida a una base de datos IBM DB2, Cloudscape o - Apache Derby. - - - - - qualifier - - - Un calificador para las bases de datos DB2 que funcionan en - servidores OS/390 o z/OS. Para otras bases de datos, - se debe pasar &null; o una cadena vacía. - - - - - schema - - - El esquema que contiene las tablas. - - - - - table_name - - - El nombre de la tabla. - - - - - scope - - - Un entero que representa el tiempo mínimo para el cual el identificador - único de la fila es válido. Puede ser uno de los siguientes valores: - - - - - Valor entero - Constante SQL - Descripción - - - - - 0 - SQL_SCOPE_CURROW - El identificador de la fila es válido solo cuando - el cursor está posicionado en la fila. - - - 1 - SQL_SCOPE_TRANSACTION - El identificador de la fila es válido durante la duración de la - transacción. - - - 2 - SQL_SCOPE_SESSION - El identificador de la fila es válido durante la duración de la - conexión. - - - - - - - - - - - - &reftitle.returnvalues; - - Devuelve un recurso con un conjunto de resultados que contiene filas con - información única para una tabla. Las filas están compuestas por las - siguientes columnas: - - - - - Nombre de la columna - Descripción - - - - - SCOPE - - - - - - Valor entero - Constante SQL - Descripción - - - - - 0 - SQL_SCOPE_CURROW - El identificador de la fila es válido solo cuando - el cursor está posicionado en la fila. - - - 1 - SQL_SCOPE_TRANSACTION - El identificador de la fila es válido durante la duración de la - transacción. - - - 2 - SQL_SCOPE_SESSION - El identificador de la fila es válido durante la duración de la - conexión. - - - - - - - - COLUMN_NAME - Nombre de la columna única. - - - DATA_TYPE - El tipo de datos SQL para la columna. - - - TYPE_NAME - Una cadena que representa el tipo de datos para la - columna. - - - COLUMN_SIZE - Un entero que representa el tamaño de la columna. - - - BUFFER_LENGTH - Número máximo de bytes necesarios para almacenar datos de esta columna. - - - DECIMAL_DIGITS - La escala de la columna o &null; donde la escala no es - aplicable. - - - NUM_PREC_RADIX - Un entero que puede ser 10 (representando un - tipo de datos numérico exacto), 2 (representando un - tipo de datos numéricos aproximados) o &null; (representando un tipo - de datos para el cual la base no es aplicable). - - - PSEUDO_COLUMN - Siempre devuelve 1. - - - - - - - - - &reftitle.seealso; - - db2_column_privileges - db2_columns - db2_foreign_keys - db2_primary_keys - db2_procedure_columns - db2_procedures - db2_statistics - db2_table_privileges - db2_tables - - - - diff --git a/reference/ibm_db2/functions/db2-statistics.xml b/reference/ibm_db2/functions/db2-statistics.xml deleted file mode 100644 index 5cb19e1f5c..0000000000 --- a/reference/ibm_db2/functions/db2-statistics.xml +++ /dev/null @@ -1,256 +0,0 @@ - - - - - - - db2_statistics - - Devuelve un conjunto de resultados que enumera los índices y estadísticas de una tabla - - - - &reftitle.description; - - resourcedb2_statistics - resourceconnection - stringnullqualifier - stringnullschema - stringtable_name - boolunique - - - - Devuelve un conjunto de resultados que enumera los índices y estadísticas de una tabla. - - - - - &reftitle.parameters; - - - connection - - - Una conexión válida a una base de datos IBM DB2, Cloudscape o Apache Derby. - - - - - qualifier - - - Un calificador para las bases de datos DB2 que funcionan en servidores OS/390 o z/OS. Para otras bases de datos, se debe pasar &null; o una string vacía. - - - - - schema - - - El esquema que contiene las tablas objetivo. Si el argumento es &null;, se devuelven las estadísticas y los índices para el esquema del usuario actual. - - - - - table_name - - - El nombre de la tabla. - - - - - unique - - - Cuando unique es &true;, se devuelve la información relativa a todos los índices de la tabla. De lo contrario, solo se devuelve la información relativa a los índices únicos de la tabla. - - - - - - - &reftitle.returnvalues; - - Devuelve un recurso de sentencia con un conjunto de resultados que contiene filas que describen - las estadísticas e índices para las tablas base que coinciden con los - parámetros especificados. Las filas están compuestas por las columnas siguientes: - - - - - Nombre de la columna - Descripción - - - - - TABLE_CAT - Nombre del catálogo que contiene la tabla. El valor es &null; si la tabla no tiene catálogo. - - - TABLE_SCHEM - Nombre del esquema que contiene la tabla. - - - TABLE_NAME - Nombre de la tabla. - - - NON_UNIQUE - - - Un integer que representa si el índice prohíbe valores únicos o si la fila contiene estadísticas sobre la tabla misma: - - - - - Valor de retorno - Tipo de argumento - - - - - 0 (SQL_FALSE) - El índice permite valores duplicados. - - - 1 (SQL_TRUE) - Los valores del índice deben ser únicos. - - - &null; - La fila contiene información estadística sobre la tabla. - - - - - - - - - INDEX_QUALIFIER - Una string que representa un calificador que debería haber sido previamente fijado a INDEX_NAME para calificar completamente el índice. - - - INDEX_NAME - Una string que representa el nombre del índice. - - - TYPE - - - Un integer que representa el tipo de información contenida en esta fila del conjunto de resultados: - - - - - Valor de retorno - Tipo de argumento - - - - - 0 (SQL_TABLE_STAT) - La fila contiene información estadística sobre la tabla. - - - 1 (SQL_INDEX_CLUSTERED) - La fila contiene información sobre un índice agrupado. - - - 2 (SQL_INDEX_HASH) - La fila contiene información sobre un índice hash. - - - 3 (SQL_INDEX_OTHER) - La fila contiene información sobre un tipo de índice que no es agrupado ni hash. - - - - - - - - - ORDINAL_POSITION - Un array que comienza en el índice 1 indicando la columna en el índice. &null; si la fila contiene información estadística sobre la tabla. - - - COLUMN_NAME - El nombre de la columna en el índice. &null; si la fila contiene información estadística sobre la tabla. - - - ASC_OR_DESC - - A si la columna está ordenada en orden alfabético, D si la columna está ordenada en orden alfabético inverso, &null; si la fila contiene información estadística sobre la tabla. - - - - CARDINALITY - - - Si la fila contiene información sobre un índice, esta columna contendrá un integer que representa el número de valores únicos en el índice. - - - Si la fila contiene información sobre la tabla, esta columna contendrá un integer que representa el número de filas en la tabla. - - - - - PAGES - - - Si la fila contiene información sobre un índice, esta columna contendrá un integer que representa el número de páginas utilizadas para registrar el índice. - - - Si la fila contiene información sobre la tabla, esta columna contendrá un integer que representa el número de páginas utilizadas para registrar la tabla. - - - - - FILTER_CONDITION - Siempre devuelve &null;. - - - - - - - - - &reftitle.seealso; - - db2_column_privileges - db2_columns - db2_foreign_keys - db2_primary_keys - db2_procedure_columns - db2_procedures - db2_special_columns - db2_table_privileges - db2_tables - - - - diff --git a/reference/ibm_db2/functions/db2-stmt-error.xml b/reference/ibm_db2/functions/db2-stmt-error.xml deleted file mode 100644 index c7e21a8619..0000000000 --- a/reference/ibm_db2/functions/db2-stmt-error.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - db2_stmt_error - - Devuelve un string que contiene el valor de SQLSTATE retornado por una consulta SQL - - - - &reftitle.description; - - stringdb2_stmt_error - resourcenullstmt&null; - - - - Devuelve un string que contiene el valor de SQLSTATE retornado por una consulta - SQL. - - - Si no se pasa un recurso como argumento a la función - db2_stmt_error, esta retornará el mensaje - de error asociado con el último intento de retorno de una consulta SQL, por - ejemplo, proveniente de db2_prepare o - db2_exec. - - - Para comprender los valores de SQLSTATE, se puede ingresar el siguiente comando - en el procesador de línea de comandos de DB2: - db2 '? sqlstate-value'. Asimismo, - se puede llamar a la función db2_conn_errormsg - para obtener un mensaje de error explícito junto con el valor de SQLCODE - asociado. - - - - - &reftitle.parameters; - - - stmt - - - Un recurso válido. - - - - - - - &reftitle.returnvalues; - - Devuelve un string que contiene el valor de SQLSTATE. - - - - - &reftitle.seealso; - - db2_conn_error - db2_conn_errormsg - db2_stmt_errormsg - - - - diff --git a/reference/ibm_db2/functions/db2-stmt-errormsg.xml b/reference/ibm_db2/functions/db2-stmt-errormsg.xml deleted file mode 100644 index 173b6b543a..0000000000 --- a/reference/ibm_db2/functions/db2-stmt-errormsg.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - db2_stmt_errormsg - - Devuelve el último mensaje de error de una consulta SQL - - - - &reftitle.description; - - stringdb2_stmt_errormsg - resourcenullstmt&null; - - - - Devuelve el último mensaje de error de una consulta SQL. - - - Si no se pasa un recurso como argumento a la función - db2_stmt_errormsg, devolverá el mensaje - de error asociado con el último intento de retorno de una consulta SQL, por - ejemplo, proveniente de db2_prepare o - db2_exec. - - - - - &reftitle.parameters; - - - stmt - - - Un recurso válido. - - - - - - - &reftitle.returnvalues; - - Devuelve un string que contiene el error del mensaje y el SQLCODE para el - último error que se produjo tras la ejecución de una consulta SQL. - - - - - &reftitle.seealso; - - db2_conn_error - db2_conn_errormsg - db2_stmt_error - - - - diff --git a/reference/ibm_db2/functions/db2-table-privileges.xml b/reference/ibm_db2/functions/db2-table-privileges.xml deleted file mode 100644 index af083036a8..0000000000 --- a/reference/ibm_db2/functions/db2-table-privileges.xml +++ /dev/null @@ -1,161 +0,0 @@ - - - - - - - db2_table_privileges - - Devuelve un conjunto de resultados que lista las tablas y sus privilegios - asociados en una base de datos - - - - &reftitle.description; - - resourcedb2_table_privileges - resourceconnection - stringnullqualifier&null; - stringnullschema&null; - stringnulltable_name&null; - - - - Devuelve un conjunto de resultados que lista las tablas y sus privilegios - asociados en una base de datos. - - - - - &reftitle.parameters; - - - connection - - - Una conexión válida a una base de datos IBM DB2, Cloudscape o - Apache Derby. - - - - - qualifier - - - Un calificador para las bases de datos DB2 que funcionan en - servidores OS/390 o z/OS. Para otras bases de datos, - se debe pasar &null; o una cadena vacía. - - - - - schema - - - El esquema que contiene las tablas. El argumento acepta formas - que contienen _ y % como - comodines. - - - - - table-name - - - El nombre de la tabla. El argumento acepta formas - que contienen _ y % como - comodines. - - - - - - - &reftitle.returnvalues; - - Devuelve un recurso con el conjunto de resultados que contiene las filas que - describen los privilegios para las tablas que coinciden con los argumentos especificados. Las - filas están compuestas por las siguientes columnas: - - - - - Nombre de la columna - Descripción - - - - - TABLE_CAT - Nombre del catálogo que contiene la tabla. - El valor es &null; si la tabla no tiene catálogo. - - - TABLE_SCHEM - Nombre del esquema que contiene la tabla. - - - TABLE_NAME - Nombre de la tabla. - - - GRANTOR - ID de autorización del usuario que otorgó el privilegio. - - - GRANTEE - ID de autorización del usuario al que se otorgó el - privilegio. - - - PRIVILEGE - El privilegio que se otorgó. Puede ser uno de los siguientes: ALTER, CONTROL, DELETE, INDEX, INSERT, REFERENCES, SELECT o - UPDATE. - - - IS_GRANTABLE - Una cadena que contiene "YES" o "NO" que indica si el usuario al - que se otorgó el privilegio puede otorgar el privilegio a otros - usuarios. - - - - - - - - - &reftitle.seealso; - - db2_column_privileges - db2_columns - db2_foreign_keys - db2_primary_keys - db2_procedure_columns - db2_procedures - db2_special_columns - db2_statistics - db2_tables - - - - diff --git a/reference/ibm_db2/functions/db2-tables.xml b/reference/ibm_db2/functions/db2-tables.xml deleted file mode 100644 index b4ee0686d6..0000000000 --- a/reference/ibm_db2/functions/db2-tables.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - - db2_tables - - Devuelve la lista de tablas y sus metadatos - - - - &reftitle.description; - - resourcedb2_tables - resourceconnection - stringnullqualifier&null; - stringnullschema&null; - stringnulltable_name&null; - stringnulltable_type&null; - - - - Devuelve un conjunto de resultados que lista las tablas y sus metadatos - asociados de una base de datos. - - - - - &reftitle.parameters; - - - connection - - - Una conexión válida a una base de datos IBM DB2, Cloudscape o - Apache Derby. - - - - - qualifier - - - Un calificador para las bases de datos DB2 que funcionan en - servidores OS/390 o z/OS. Para otras bases de datos, - se debe pasar &null; o una cadena vacía. - - - - - schema - - - El esquema que contiene las tablas. El argumento acepta formas - que contienen _ y % como - comodines. - - - - - table_name - - - El nombre de la tabla. El argumento acepta formas - que contienen _ y % como - comodines. - - - - - table_type - - - Una lista de identificadores de tipos de tabla delimitada por comas. - Para coincidir con todos los esquemas, se debe pasar &null; o una cadena - vacía. Los identificadores válidos son: - ALIAS, HIERARCHY TABLE, INOPERATIVE VIEW, NICKNAME, - MATERIALIZED QUERY TABLE, SYSTEM TABLE, TABLE, TYPED TABLE, TYPED VIEW - y VIEW. - - - - - - - &reftitle.returnvalues; - - Devuelve un recurso con el conjunto de resultados que contiene las filas que - describen las tablas que coinciden con los argumentos especificados. Las - filas están compuestas por las siguientes columnas: - - - - - Nombre de la columna - Descripción - - - - - TABLE_CAT - Nombre del catálogo que contiene la tabla. - El valor es &null; si la tabla no tiene catálogo. - - - TABLE_SCHEM - Nombre del esquema que contiene la tabla. - - - TABLE_NAME - Nombre de la tabla. - - - TABLE_TYPE - Identificador de la tabla. - - - REMARKS - Descripción de la tabla. - - - - - - - - - &reftitle.seealso; - - db2_column_privileges - db2_columns - db2_foreign_keys - db2_primary_keys - db2_procedure_columns - db2_procedures - db2_special_columns - db2_statistics - db2_table_privileges - - - - diff --git a/reference/ibm_db2/ini.xml b/reference/ibm_db2/ini.xml deleted file mode 100644 index 8c73e9800b..0000000000 --- a/reference/ibm_db2/ini.xml +++ /dev/null @@ -1,542 +0,0 @@ - - - -
- &reftitle.runtime; - &extension.runtime; - - &ConfigureOptions; DB2 - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - ibm_db2.binmode - "1" - INI_ALL - - - - ibm_db2.i5_all_pconnect - "0" - INI_SYSTEM - Disponible a partir de ibm_db2 1.6.5. - - - ibm_db2.i5_allow_commit - "0" - INI_SYSTEM - Disponible a partir de ibm_db2 1.4.9. - - - ibm_db2.i5_blank_userid - "0" - INI_SYSTEM - Disponible a partir de ibm_db2 1.9.7. - - - ibm_db2.i5_char_trim - "0" - INI_SYSTEM - Disponible a partir de ibm_db2 2.1.0. - - - ibm_db2.i5_dbcs_alloc - "0" - INI_SYSTEM - Disponible a partir de ibm_db2 1.5.0. - - - ibm_db2.i5_guard_profile - "0" - INI_SYSTEM - Disponible a partir de ibm_db2 1.9.7. - - - ibm_db2.i5_ignore_userid - "0" - INI_SYSTEM - Disponible a partir de ibm_db2 1.8.0. - - - ibm_db2.i5_job_sort - "0" - INI_SYSTEM - Disponible a partir de ibm_db2 1.8.4. - - - ibm_db2.i5_log_verbose - "0" - INI_SYSTEM - Disponible a partir de ibm_db2 1.9.7. - - - ibm_db2.i5_max_pconnect - "0" - INI_SYSTEM - Disponible a partir de ibm_db2 1.9.7. - - - ibm_db2.i5_override_ccsid - "0" - INI_SYSTEM - Disponible a partir de ibm_db2 1.9.7. - - - ibm_db2.i5_servermode_subsystem - NULL - INI_SYSTEM - Disponible a partir de ibm_db2 1.9.7. - - - ibm_db2.i5_sys_naming - "0" - INI_SYSTEM - Disponible a partir de ibm_db2 1.9.7. - - - ibm_db2.instance_name - NULL - INI_SYSTEM - Disponible a partir de ibm_db2 1.0.2. - - - -
- - &ini.descriptions.title; - - - - - ibm_db2.binmode - (int) - - - - Esta opción controla el modo utilizado para convertir desde o hacia - los datos binarios en la aplicación PHP. - - - - 1 (DB2_BINARY) - - - - - 2 (DB2_CONVERT) - - - - - 3 (DB2_PASSTHRU) - - - - - - - - - ibm_db2.i5_all_pconnect - (int) - - - - Esta opción fuerza todas las conexiones a ser persistentes en IBM i. - Fundamentalmente, todas las llamadas a db2_connect se convierten - automáticamente en llamadas a db2_pconnect. - Por omisión, esta opción es 0. - Esta opción se proporciona por conveniencia en los casos donde las conexiones persistentes son más rápidas. - No debería utilizarse en nuevas aplicaciones. - - - - 0 - Se pueden establecer conexiones persistentes y no persistentes. - - - - - 1 - Todas las conexiones son persistentes. - - - - - - - - - ibm_db2.i5_allow_commit - int - - - - Esta opción controla el modo de aislamiento de la transacción utilizado. - Por omisión, esta opción es 0, por lo que no se utiliza el control de compromiso. - Esta opción puede ser reemplazada durante la conexión si la clave del array - i5_commit está definida en el array de opciones de conexión - pasado a db2_connect o - db2_pconnect. - - - - 0 - No se utiliza el control de compromiso. - - - - - 1 - Lectura no comprometida, lectura sucia posible. - - - - - 2 - Lectura comprometida, lectura sucia imposible. - - - - - 3 - Lectura repetible, lectura sucia y lectura no repetible son imposibles. - - - - - 4 - Serializable, lectura sucia, lectura no repetible y fantasma son imposibles. - - - - - - - - - ibm_db2.i5_blank_userid - int - - - - Esto controla si se debe permitir un identificador de usuario vacío en IBM i. - Por omisión, esta opción es 0. - A diferencia de ibm_db2.i5_ignore_userid, esta opción - no fuerza a que todos los identificadores de usuario sean vacíos o a modificar el comportamiento del trabajo, sino - que simplemente permite pasar un identificador de usuario vacío, para conectarse a Db2 como - usuario actual. - - - - 0 - No permite pasar un identificador de usuario vacío. - - - - - 1 - Permite pasar un identificador de usuario vacío. - - - - - - - - - ibm_db2.i5_char_trim - int - - - - Esta opción controla si se recorta el final de las cadenas en IBM i. - Dado que muchas tablas utilizan tamaños de columnas fijos rellenos de espacios, esto se - proporciona por conveniencia. - Por omisión, esta opción es 0. - - - - 0 - Las columnas no se recortan. - - - - - 1 - Los espacios al final de las columnas de caracteres devueltas se eliminan. - - - - - - - - - ibm_db2.i5_dbcs_alloc - (int) - - - - Esta opción afecta a la estrategia de asignación de memoria de búfer interno en IBM i. - Por omisión, esta opción es 0. - Cuando esta opción está definida, los búferes se asignan con un tamaño mucho mayor, - en caso de que la base de datos subestime el tamaño de una cadena durante la conversión - entre codificaciones. - Esta opción utiliza seis veces más memoria para los búferes (para tener en cuenta - las secuencias UTF-8 más grandes posibles), pero puede ser necesaria si se devuelven datos truncados. - - - - 0 - Se asignan búferes de tamaño mínimo. - - - - - 1 - Se asignan búferes de tamaño mayor. - - - - - - - - - ibm_db2.i5_guard_profile - int - - - - Esta opción verifica si el perfil de usuario de la base de datos ha sido cambiado durante - la conexión a una conexión de base de datos persistente en IBM i, y si es así, - se desconecta de la base de datos. - Por omisión, esta opción está definida en 0. - - - - 0 - No verificar cambios de perfil. - - - - - 1 - Verificar cambios de perfil y desconectarse en caso necesario. - - - - - - - - - ibm_db2.i5_log_verbose - int - - - - Esta opción define si los mensajes de diagnóstico SQL como advertencias y errores son - siempre enviados al registro de errores PHP en IBM i. - Normalmente, solo se envía un breve mensaje en caso de fallo (como "la ejecución - de la sentencia falló") en el registro de errores PHP, ya que esta opción está definida en - 0 por omisión. - Tenga en cuenta que siempre y cuando debe llamar, por ejemplo, - db2_stmt_errormsg manualmente para verificar si - las funciones fallan. - - - - 0 - Solo se registran mensajes breves. - - - - - 1 - Se registra el mensaje de diagnóstico SQL además del mensaje breve. - - - - - - - - - ibm_db2.i5_ignore_userid - (int) - - - - Esta opción ignora el ID de usuario al conectarse a la base de datos al - ejecutarse en IBM i, y ejecuta la funcionalidad SQL/CLI dentro del trabajo PHP, - en lugar de un trabajo separado. - Por omisión, esta opción es 0. - Cuando está activada, ya no utiliza un trabajo de servidor de base de datos separado, y - siempre utiliza el perfil de usuario actual para la base de datos, ignorando el - nombre de usuario y la contraseña pasados a db2_connect y - db2_pconnect. - - - - 0 : db2_(p)connect con un identificador de usuario y contraseña específicos - 0 - Utiliza las credenciales especificadas y utiliza un trabajo de servidor SQL/CLI. - - - - - 1 : db2_(p)connect con un identificador de usuario y contraseña vacíos - 1 - Siempre utiliza credenciales vacías y ejecuta SQL/CLI en el trabajo PHP. - - - - - - - - - ibm_db2.i5_job_sort - int - - - - Controla la opción de ordenación de trabajos en IBM i. - Por omisión, esta opción es 0. - Esto corresponde al atributo SQL_ATTR_CONN_SORT_SEQUENCE - de IBM i SQL/CLI. - - - - 0 - Utiliza la opción de ordenación *HEX, ordenando por bytes. - - - - - 1 - Utiliza la secuencia de ordenación de trabajo definida para el trabajo PHP. - - - - - 2 - Utiliza la secuencia de ordenación de trabajo definida para el trabajo de base de datos. - - - - - - - - - ibm_db2.i5_max_pconnect - int - - - - Esto afectará cuántas veces se puede reutilizar una conexión persistente - al ejecutarse en IBM i. - Por omisión, esto está configurado en 0, lo que significa que una conexión persistente siempre puede ser reutilizada. - Esta opción puede ayudar a evitar problemas en un trabajo de base de datos - de larga duración (es decir, si un procedimiento pierde memoria), - pero obviamente no es una solución a largo plazo. - - - - - - ibm_db2.i5_override_ccsid - int - - - - El CCSID PASE a utilizar para las conversiones de caracteres EBCDIC en IBM i. - Por omisión, es 0, lo que seleccionará el CCSID de trabajo PASE por defecto, - procedente de los parámetros de localización PASE. - Por ejemplo, al configurarlo en 1208, se utilizará el UTF-8. - Solo debe modificarse si el CCSID del trabajo PASE no es el CCSID esperado, - y la localización no puede ser modificada. - - - Para obtener más información sobre los CCSID en IBM i, consulte la - documentación de IBM. - Para saber cómo las localizaciones en IBM i PASE se mapean a los CCSID, consulte la - documentación de IBM. - - - - - - ibm_db2.i5_sys_naming - int - - - - Esta opción controla el modo de nombrado al conectarse a un sistema IBM i. - Por omisión, esta opción es 0. - El modo de nombrado afecta a la resolución de nombres y la sintaxis permitida para - los nombres. - Cuando está configurado en 0, utiliza puntos para calificar los nombres y - utiliza la biblioteca o el identificador de usuario por defecto para resolver los nombres. - Cuando está configurado en 1, utiliza barras diagonales para calificar los nombres y - utiliza la lista de bibliotecas de trabajo para resolver los nombres. - - - - 0 - Utiliza el modo de nombrado SQL ("SCHEMA.TABLE"). - - - - - 1 - Utiliza el modo de nombrado del sistema ("LIBRARY/FILE"). - - - - - - Para obtener más información sobre los modos de nombrado en IBM i, consulte la - documentación de IBM. - - - - - - ibm_db2.i5_servermode-subsystem - string - - - - Esta opción modifica el subsistema bajo el cual se ejecutan los trabajos del servidor de base de datos en - IBM i. - Por omisión, esta opción es &null;, por lo que los trabajos se ejecutarán bajo el subsistema por defecto para los trabajos QSQSRVR. - - - - - - ibm_db2.instance_name - string - - - - En los sistemas operativos Linux y UNIX, esta opción define el nombre de la instancia a utilizar - para las conexiones de base de datos catalogadas. - Por omisión, esta opción es &null;. - Si esta opción está definida, su valor reemplaza la configuración de la variable de entorno - DB2INSTANCE. - - - Esta opción se ignora en los sistemas operativos Windows. - - - - -
- diff --git a/reference/ibm_db2/reference.xml b/reference/ibm_db2/reference.xml deleted file mode 100644 index f2e2561e9f..0000000000 --- a/reference/ibm_db2/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - - &Functions; de IBM DB2 - - &reference.ibm-db2.entities.functions; - - - diff --git a/reference/ibm_db2/setup.xml b/reference/ibm_db2/setup.xml deleted file mode 100644 index 0745fec816..0000000000 --- a/reference/ibm_db2/setup.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - &reftitle.setup; - - -
- &reftitle.required; - - Para conectar a IBM DB2 Universal Database para Linux, Unix y Windows, o a - IBM Cloudscape, o a Apache Derby, se debe instalar el cliente de IBM DB2 - Universal Database en el mismo equipo en que se ejecuta PHP. Esta extensión - se ha desarrollado y probado con DB2 Version 8.2. - - - Para conectar a IBM DB2 Universal Database en z/OS o iSeries, es necesario - también IBM DB2 Connect o un software enrutador DRDA equivalente. - -
- Requisitos en Linux y Unix - - El usuario que invoca el ejecutable de PHP o el SAPI debe especificar la instancia - de DB2 antes de acceder a estas funciones. Se puede establecer el nombre de la instancia - de DB2 en &php.ini; utilizando la opción de configuración - ibm_db2.instance_name, o se puede cargar el perfil de la instancia - de DB2 antes de invocar el ejecutable de PHP. - - - Si se ha creado una instancia de DB2 llamada db2inst1 en - /home/db2inst1/, por ejemplo, se puede añadir la - siguiente línea a &php.ini;: - - - - Si no se establece esta opción en &php.ini;, se debe ejecutar el - siguiente comando para modificar las variables de entorno y habilitar el acceso a - DB2: - - - - Para permitir que el servidor web con PHP acceda a estas funciones, se debe - establecer la opción de configuración ibm_db2.instance_name - en &php.ini;, o cargar el entorno de la instancia de DB2 en el script de inicio - del servidor web (típicamente /etc/init.d/httpd o - /etc/init.d/apache). - -
-
- - - - &reference.ibm-db2.configure; - - - - &reference.ibm-db2.ini; - - - -
- &reftitle.resources; - - La extensión ibm_db2 devuelve recursos de conexión, recursos de sentencias, - y recursos de juegos de resultados. - -
- - -
- diff --git a/reference/iconv/reference.xml b/reference/iconv/reference.xml index 144758f0b6..e6eaaa9409 100644 --- a/reference/iconv/reference.xml +++ b/reference/iconv/reference.xml @@ -8,7 +8,7 @@ &reftitle.seealso; - Ver también funciones de GNU Recode. + Ver también funciones de GNU Recode. diff --git a/reference/igbinary/book.xml b/reference/igbinary/book.xml deleted file mode 100644 index 6adfa07224..0000000000 --- a/reference/igbinary/book.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - Igbinary - Igbinary - - - &reftitle.intro; - - Igbinary es una mejora del proceso estándar de serialización de datos de PHP que no requiere - ningún cambio de configuración. - En lugar de la representación textual, consumidora de tiempo y espacio, utilizada por la función - serialize de PHP, igbinary almacena las estructuras de datos de PHP en un formato binario - compacto. - Los ahorros de memoria son significativos cuando memcached, APCu u otras herramientas de almacenamiento similares - basadas en memoria son utilizadas para los datos serializados. - Las reducciones características de los requisitos de almacenamiento son de aproximadamente 50%. - El porcentaje exacto depende de los datos. - - - - &reference.igbinary.setup; - &reference.igbinary.reference; - - - diff --git a/reference/igbinary/functions/igbinary-serialize.xml b/reference/igbinary/functions/igbinary-serialize.xml deleted file mode 100644 index 38d7a01bdb..0000000000 --- a/reference/igbinary/functions/igbinary-serialize.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - igbinary_serialize - Genera una representación binaria almacenable y compacta de un valor - - - - &reftitle.description; - - stringfalseigbinary_serialize - mixedvalue - - - Genera una representación almacenable de un valor. - - - Es una técnica práctica para almacenar o pasar valores PHP entre scripts, sin perder su estructura ni su tipo. - - - Para reconvertir la cadena sérializada en un valor PHP, - la función igbinary_unserialize puede ser utilizada. - - - - - &reftitle.parameters; - - - value - - - El valor a serializar. igbinary_serialize - gestiona todos los tipos excepto los recursos y ciertos objetos (confiere la nota a continuación). - Incluso los &array;x que contienen referencias a sí mismos pueden ser serializados con igbinary_serialize. - Las referencias circulares dentro de un &array; o de un &object; a serializar serán igualmente almacenadas. - Cualquier otra referencia será perdida. - - - Al serializar objetos, igbinary intentará llamar a los métodos mágicos - __serialize() o - __sleep() antes de la serialización. - Esto permitirá al objeto realizar una limpieza de último momento, etc., antes de ser serializado. - De igual manera, cuando el objeto es restaurado utilizando la función - igbinary_unserialize, uno de los métodos mágicos __unserialize() - o __wakeup() es llamado. - - - - Los atributos privados de un objeto tendrán el nombre de la clase prefijado al nombre del atributo; - los atributos protegidos serán prefijados con un asterisco '*'. - Estos valores prefijados tienen caracteres nulos en ambos lados. - - - - - - - - - &reftitle.returnvalues; - - Retorna una cadena de caracteres que contiene una representación del parámetro value - en forma de flujo de bytes que puede ser almacenado en cualquier lugar. - - - Es de notar que es una cadena binaria que puede incluir caracteres nulos, y debe por lo tanto ser almacenada y gestionada como tal. - Por ejemplo, en una base de datos, la salida de la función igbinary_serialize - debe, en general, ser almacenada en un campo de tipo BLOB - en lugar de en un campo de tipo CHAR o TEXT. - - - - - &reftitle.examples; - - Ejemplo con <function>igbinary_serialize</function> - - -]]> - - &example.outputs; - - 'test', - 1 => 'test', -) -]]> - - - - - - &reftitle.notes; - - - Es de notar que muchos objetos internos de PHP no pueden ser serializados. Sin embargo, aquellos que pueden - implementan ya sea la interfaz Serializable o los métodos mágicos - __serialize()/__unserialize() - o __sleep()/__wakeup(). - Si una clase interna no cumple ninguna de estas condiciones, no puede ser serializada de manera fiable. - - - Existen excepciones históricas a esta regla, donde objetos internos pueden ser serializados - sin implementar ni la interfaz ni los métodos mágicos. - - - - - - &reftitle.seealso; - - serialize - igbinary_unserialize - var_export - json_encode - Serialización de objetos - __sleep() - __wakeup() - __serialize() - __unserialize() - - - - - diff --git a/reference/igbinary/functions/igbinary-unserialize.xml b/reference/igbinary/functions/igbinary-unserialize.xml deleted file mode 100644 index ec83680ef0..0000000000 --- a/reference/igbinary/functions/igbinary-unserialize.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - igbinary_unserialize - - Crea una variable PHP a partir de un valor serializado por igbinary_serialize - - - - - &reftitle.description; - - mixedigbinary_unserialize - stringstr - - - igbinary_unserialize toma una variable serializada por - igbinary_serialize y la convierte en una variable PHP. - - - - Las entradas de usuario no confiables no deben pasarse a la función - igbinary_unserialize. - La deserialización puede resultar en la ejecución de código cargado y ejecutado durante la instanciación - y el autochargado de objetos, y así, un usuario malintencionado puede ser capaz de explotar - este comportamiento. - En su lugar, un estándar de intercambio seguro como JSON (a través de json_decode y - json_encode) debe usarse para pasar datos serializados al usuario. - - - Si es indispensable deserializar datos serializados provenientes del exterior, la función - hash_hmac puede usarse para validar los datos. - Es importante verificar que nadie haya alterado los datos. - - - - - El protocolo de serialización por igbinary no permite distinguir entre los diferentes grupos de - referencias. Todas las referencias PHP a un valor dado son vistas como miembros de un mismo - grupo durante la deserialización, incluso si pertenecían a grupos diferentes antes de la - serialización. - - - - - - &reftitle.parameters; - - - str - - - La cadena serializada, generada por igbinary_serialize. - - - Si la variable deserializada es un &object;, después de reconstruirla con éxito, - PHP intentará automáticamente llamar a los métodos mágicos - __unserialize() o - __wakeup() (si alguno de ellos existe). - - - - La directiva <link linkend="ini.unserialize-callback-func">unserialize_callback_func</link> - - - La función de retrollamada especificada en la directiva - unserialize_callback_func - es llamada cuando una clase no definida es deserializada. - Si ninguna función de retrollamada es especificada, el objeto será instanciado - como __PHP_Incomplete_Class. - - - - - - - - - &reftitle.returnvalues; - - El valor convertido es retornado por la función, y puede ser de tipo &boolean;, - &integer;, &float;, &string;, - &array;, &object;, o de tipo null. - - - Si la cadena pasada no puede ser deserializada, esta función retorna &false; y - un diagnóstico E_NOTICE o E_WARNING es emitido. - - - - - &reftitle.errors; - - Los objetos pueden lanzar un Throwable en su gestor de deserialización. - - - - - &reftitle.notes; - - - &null; o &false; es retornado ya sea en caso de error o después de deserializar - el resultado de la serialización de &null; o &false;. Es posible discriminar entre estos dos casos - especiales comparando el valor del parámetro str con el resultado de la ejecución - de igbinary_serialize(null) o de igbinary_serialize(false) - o bien atrapando un diagnóstico E_NOTICE. - - - - - - &reftitle.seealso; - - unserialize - json_encode - json_decode - hash_hmac - igbinary_serialize - Autocargado de clases - unserialize_callback_func - __wakeup() - __serialize() - __unserialize() - - - - diff --git a/reference/igbinary/ini.xml b/reference/igbinary/ini.xml deleted file mode 100644 index a16e4fc004..0000000000 --- a/reference/igbinary/ini.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - -
- &reftitle.runtime; - &extension.runtime; - - - Igbinary &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - igbinary.compact_strings - 1 - INI_ALL - - - - -
- - Opciones de configuración de sesión que afectan al comportamiento de igbinary - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - session.save_handler - "files" - INI_ALL - - - - -
- &ini.php.constants; -
- - &ini.descriptions.title; - - - - - igbinary.compact_strings - bool - - - - Activa o no el compactado de strings duplicados. - El valor por omisión es On. - - - - - - - session.save_handler - string - - - - Igbinary es utilizado como gestor de sesión al establecer el valor de esta opción a igbinary. - - - - - -
- diff --git a/reference/igbinary/reference.xml b/reference/igbinary/reference.xml deleted file mode 100644 index b01aa7f5b1..0000000000 --- a/reference/igbinary/reference.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - &Functions; de Igbinary - - &reference.igbinary.entities.functions; - - - diff --git a/reference/igbinary/setup.xml b/reference/igbinary/setup.xml deleted file mode 100644 index bf557c15ac..0000000000 --- a/reference/igbinary/setup.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - &reftitle.setup; - -
- &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;igbinary. - - - &pecl.windows.download.avail; - -
- - &reference.igbinary.ini; -
- diff --git a/reference/imagick/book.xml b/reference/imagick/book.xml deleted file mode 100644 index da9288bb61..0000000000 --- a/reference/imagick/book.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - Tratamiento de imágenes (ImageMagick) - ImageMagick - - - - &reftitle.intro; - - Imagick es una extensión PHP nativa para crear y modificar imágenes, - utilizando la API ImageMagick. - - -
- Acerca de ImageMagick - - &warn.experimental; - ImageMagick es una suite de software que permite la creación, edición y composición de imágenes bitmap. - Puede leer, convertir y escribir imágenes en diversos formatos (más de 100) - entre los que se incluyen DPX, EXR, GIF, JPEG, JPEG-2000, PDF, PhotoCD, PNG, Postscript, SVG y TIFF. - - - ImageMagick Studio LLC, una organización sin fines de lucro - cuyo objetivo es hacer disponible libremente el software relativo - a la manipulación de imágenes. - -
- - -
- - - &reference.imagick.setup; - &reference.imagick.constants; - &reference.imagick.examples; - - &reference.imagick.imagick; - &reference.imagick.imagickdraw; - &reference.imagick.imagickdrawexception; - &reference.imagick.imagickexception; - &reference.imagick.imagickkernel; - &reference.imagick.imagickkernelexception; - &reference.imagick.imagickpixel; - &reference.imagick.imagickpixelexception; - &reference.imagick.imagickpixeliterator; - &reference.imagick.imagickpixeliteratorexception; - -
- - diff --git a/reference/imagick/constants.xml b/reference/imagick/constants.xml deleted file mode 100644 index 6d89b665e3..0000000000 --- a/reference/imagick/constants.xml +++ /dev/null @@ -1,4370 +0,0 @@ - - - - - - &reftitle.constants; - &extension.constants; - - Constantes <constant>COLOR_<replaceable>*</replaceable></constant> - Constantes sobre los tipos de color. Estas constantes - se utilizan principalmente con la clase ImagickPixel. - - - - imagick::COLOR_BLACK - (int) - - - - Color negro - - - - - - imagick::COLOR_BLUE - (int) - - - - Color azul - - - - - - imagick::COLOR_CYAN - (int) - - - - Color cian - - - - - - imagick::COLOR_GREEN - (int) - - - - Color verde - - - - - - imagick::COLOR_RED - (int) - - - - Color rojo - - - - - - imagick::COLOR_YELLOW - (int) - - - - Color amarillo - - - - - - imagick::COLOR_MAGENTA - (int) - - - - Color magenta - - - - - - imagick::COLOR_OPACITY - (int) - - - - Color de la opacidad - - - - - - imagick::COLOR_ALPHA - (int) - - - - Color del alpha - - - - - - imagick::COLOR_FUZZ - (int) - - - - Color del fuzz - - - - - - Constantes <constant>DISPOSE_<replaceable>*</replaceable></constant> - Constantes relativas a los tipos de disposición - - - imagick::DISPOSE_UNRECOGNIZED - (int) - - - - Tipo de disposición no reconocido - - - - - - imagick::DISPOSE_UNDEFINED - (int) - - - - Tipo de disposición no definido - - - - - - imagick::DISPOSE_NONE - (int) - - - - Ningún tipo de disposición - - - - - - imagick::DISPOSE_BACKGROUND - (int) - - - - Disposición del fondo - - - - - - imagick::DISPOSE_PREVIOUS - (int) - - - - Disposición previa - - - - - - Constantes <constant>COMPOSITE_<replaceable>*</replaceable></constant> - - - imagick::COMPOSITE_DEFAULT - (int) - - - - El operador de composición por defecto. - - - - - - imagick::COMPOSITE_UNDEFINED - (int) - - - - Operador de composición indefinido - - - - - - imagick::COMPOSITE_NO - (int) - - - - No hay operador de composición definido - - - - - - imagick::COMPOSITE_ADD - (int) - - - - El resultado de imagen + imagen - - - - - - imagick::COMPOSITE_ATOP - (int) - - - - El resultado tiene la misma forma que la imagen, con la imagen compuesta que llena - la imagen donde la forma de la imagen se superpone a la imagen - - - - - - imagick::COMPOSITE_BLEND - (int) - - - - Combina las imágenes imagen (mezcla) - - - - - - imagick::COMPOSITE_BUMPMAP - (int) - - - - Lo mismo que COMPOSITE_MULTIPLY, excepto que la fuente se - convierte primero a niveles de gris - - - - - - imagick::COMPOSITE_CLEAR - (int) - - - - Hace que la imagen de destino sea transparente - - - - - - imagick::COMPOSITE_COLORBURN - (int) - - - - Oscurece la imagen de destino para reflejar la imagen fuente - - - - - - imagick::COMPOSITE_COLORDODGE - (int) - - - - Aclara la imagen de destino para reflejar la imagen fuente - - - - - - imagick::COMPOSITE_COLORIZE - (int) - - - - Colorea la imagen de destino con la imagen compuesta - - - - - - imagick::COMPOSITE_COPYBLACK - (int) - - - - Copia el negro de la fuente al destino - - - - - - imagick::COMPOSITE_COPYBLUE - (int) - - - - Copia el azul de la fuente al destino - - - - - - imagick::COMPOSITE_COPY - (int) - - - - Copia la fuente al destino - - - - - - imagick::COMPOSITE_COPYCYAN - (int) - - - - Copia el cian de la fuente al destino - - - - - - imagick::COMPOSITE_COPYGREEN - (int) - - - - Copia el verde de la fuente al destino - - - - - - imagick::COMPOSITE_COPYMAGENTA - (int) - - - - Copia el magenta de la fuente al destino - - - - - - imagick::COMPOSITE_COPYOPACITY - (int) - - - - Copia la opacidad de la fuente al destino - - - - - - imagick::COMPOSITE_COPYRED - (int) - - - - Copia el rojo de la fuente al destino - - - - - - imagick::COMPOSITE_COPYYELLOW - (int) - - - - Copia el amarillo de la fuente al destino - - - - - - imagick::COMPOSITE_DARKEN - (int) - - - - Oscurece la imagen de destino - - - - - - imagick::COMPOSITE_DSTATOP - (int) - - - - La parte de la imagen de destino que está dentro de la - fuente se compone con la fuente y se coloca en el destino. - - - - - - imagick::COMPOSITE_DST - (int) - - - - El destino se deja intacto - - - - - - imagick::COMPOSITE_DSTIN - (int) - - - - La parte dentro de la fuente reemplaza el destino - - - - - - imagick::COMPOSITE_DSTOUT - (int) - - - - La parte fuera de la fuente reemplaza el destino - - - - - - imagick::COMPOSITE_DSTOVER - (int) - - - - El destino reemplaza la fuente - - - - - - imagick::COMPOSITE_DIFFERENCE - (int) - - - - Resta el color oscuro del color claro - - - - - - imagick::COMPOSITE_DISPLACE - (int) - - - - Desplaza los píxeles del destino según lo definido por la fuente - - - - - - imagick::COMPOSITE_DISSOLVE - (int) - - - - Disuelve la fuente en el destino - - - - - - imagick::COMPOSITE_EXCLUSION - (int) - - - - Produce un efecto similar a imagick::COMPOSITE_DIFFERENCE, pero - con un contraste más bajo - - - - - - imagick::COMPOSITE_HARDLIGHT - (int) - - - - Multiplica o proyecta los colores, dependiendo del valor del color fuente - - - - - - imagick::COMPOSITE_HUE - (int) - - - - Modifica el matiz del destino, según lo definido por la fuente - - - - - - imagick::COMPOSITE_IN - (int) - - - - Compone la fuente en el destino - - - - - - imagick::COMPOSITE_LIGHTEN - (int) - - - - Aclara el destino, según lo definido por la fuente - - - - - - imagick::COMPOSITE_LUMINIZE - (int) - - - - Ilumina el destino según lo definido por la fuente - - - - - - imagick::COMPOSITE_MINUS - (int) - - - - Resta la fuente del destino - - - - - - imagick::COMPOSITE_MODULATE - (int) - - - - Modula la claridad del destino, su saturación y su matiz - según lo definido por el destino - - - - - - imagick::COMPOSITE_MULTIPLY - (int) - - - - Multiplica el destino con la fuente - - - - - - imagick::COMPOSITE_OUT - (int) - - - - Compone el exterior de la fuente en el destino - - - - - - imagick::COMPOSITE_OVER - (int) - - - - Compone la fuente sobre el destino - - - - - - imagick::COMPOSITE_OVERLAY - (int) - - - - Superpone la fuente sobre el destino - - - - - - imagick::COMPOSITE_PLUS - (int) - - - - Añade la fuente sobre el destino - - - - - - imagick::COMPOSITE_REPLACE - (int) - - - - Reemplaza el destino con la fuente - - - - - - imagick::COMPOSITE_SATURATE - (int) - - - - Satura el destino según lo definido por la fuente - - - - - - imagick::COMPOSITE_SCREEN - (int) - - - - La fuente y el destino se complementan, luego se multiplican y finalmente - reemplazan el destino - - - - - - imagick::COMPOSITE_SOFTLIGHT - (int) - - - - Oscurece o aclara los colores, según la fuente - - - - - - imagick::COMPOSITE_SRCATOP - (int) - - - - La parte de la fuente que está en el destino y compuesta sobre el destino - - - - - - imagick::COMPOSITE_SRC - (int) - - - - La fuente se copia sobre el destino - - - - - - imagick::COMPOSITE_SRCIN - (int) - - - - La parte de la fuente que está en el destino, - reemplaza el destino. - - - - - - imagick::COMPOSITE_SRCOUT - (int) - - - - La parte de la fuente que está fuera del destino reemplaza el destino - - - - - - imagick::COMPOSITE_SRCOVER - (int) - - - - La fuente reemplaza el destino - - - - - - imagick::COMPOSITE_SUBTRACT - (int) - - - - Resta los colores en la fuente en el destino - - - - - - imagick::COMPOSITE_THRESHOLD - (int) - - - - La fuente se compone sobre el destino, según lo definido por los umbrales de la fuente - - - - - - imagick::COMPOSITE_XOR - (int) - - - - La parte de la fuente que está fuera del destino y combinada con - la parte del destino que está fuera de la fuente - - - - - - Constantes <constant>MONTAGEMODE_<replaceable>*</replaceable></constant> - - - - imagick::MONTAGEMODE_FRAME - (int) - - - - - - - - - imagick::MONTAGEMODE_UNFRAME - (int) - - - - - - - - - imagick::MONTAGEMODE_CONCATENATE - (int) - - - - - - - - - Constantes <constant>STYLE_<replaceable>*</replaceable></constant> - - - - imagick::STYLE_NORMAL - (int) - - - - - - - - - imagick::STYLE_ITALIC - (int) - - - - - - - - - imagick::STYLE_OBLIQUE - (int) - - - - - - - - - imagick::STYLE_ANY - (int) - - - - - - - - - Constantes <constant>FILTER_<replaceable>*</replaceable></constant> - - - - imagick::FILTER_UNDEFINED - (int) - - - - - - - - - imagick::FILTER_POINT - (int) - - - - - - - - - imagick::FILTER_BOX - (int) - - - - - - - - - imagick::FILTER_TRIANGLE - (int) - - - - - - - - - imagick::FILTER_HERMITE - (int) - - - - - - - - - imagick::FILTER_HANNING - (int) - - - - - - - - - imagick::FILTER_HAMMING - (int) - - - - - - - - - imagick::FILTER_BLACKMAN - (int) - - - - - - - - - imagick::FILTER_GAUSSIAN - (int) - - - - - - - - - imagick::FILTER_QUADRATIC - (int) - - - - - - - - - imagick::FILTER_CUBIC - (int) - - - - - - - - - imagick::FILTER_CATROM - (int) - - - - - - - - - imagick::FILTER_MITCHELL - (int) - - - - - - - - - imagick::FILTER_LANCZOS - (int) - - - - - - - - - imagick::FILTER_BESSEL - (int) - - - - - - - - - imagick::FILTER_SINC - (int) - - - - - - - - - Constantes <constant>IMGTYPE_<replaceable>*</replaceable></constant> - - Un tipo de imagen combina un modelo de color con la presencia o ausencia de - un canal alfa. - Pasar una de estas constantes a - Imagick::setImageType convierte la imagen a ese - tipo. - Imagick::getImageType informa del tipo de una - imagen, pero solo devuelve un tipo que describa datos de píxeles reales, - nunca imagick::IMGTYPE_UNDEFINED ni - imagick::IMGTYPE_OPTIMIZE. - - - Las constantes cuyo nombre termina en MATTE son las - variantes que llevan un canal alfa; las demás no lo tienen. - En ImageMagick 6 el canal alfa se conocía como canal matte, y cuando - Imagick se compila contra ImageMagick 7 cada una de estas constantes existe - también bajo un nombre - IMGTYPE_*ALPHA con el mismo - valor. - - - - imagick::IMGTYPE_UNDEFINED - (int) - - - - El tipo de imagen no se conoce. - Imagick::setImageType no convierte nada para este - valor, pero lo registra igualmente en la imagen. - - - - - - imagick::IMGTYPE_BILEVEL - (int) - - - - Solo dos colores. - La imagen se convierte a escala de grises, se estira su contraste y cada - píxel pasa a ser negro o blanco según sea más claro o más oscuro que el - gris medio; cualquier canal alfa se descarta. - - - - - - imagick::IMGTYPE_GRAYSCALE - (int) - - - - Tonos de gris. - La imagen se convierte al espacio de color de escala de grises y cualquier - canal alfa se descarta. - - - - - - imagick::IMGTYPE_GRAYSCALEMATTE - (int) - - - - Tonos de gris con un canal alfa. - Igual que imagick::IMGTYPE_GRAYSCALE, salvo que el - canal alfa se conserva y, si la imagen no tiene ninguno, se le añade uno - opaco. - - - - - - imagick::IMGTYPE_PALETTE - (int) - - - - Color indexado. - La imagen se convierte a sRGB y, si no está ya indexada o tiene más de 256 - colores, se cuantiza a 256 colores; cualquier canal alfa se descarta. - - - - - - imagick::IMGTYPE_PALETTEMATTE - (int) - - - - Color indexado con un canal alfa. - La imagen se convierte a sRGB, el canal alfa se conserva y, si la imagen - no tiene ninguno, se le añade uno opaco. - A diferencia de imagick::IMGTYPE_PALETTE, los colores - se cuantizan incluso cuando la imagen ya está indexada, y el canal alfa se - incluye en la cuantización. - - - - - - imagick::IMGTYPE_TRUECOLOR - (int) - - - - Color directo: un valor de rojo, verde y azul por píxel, sin paleta. - La imagen se convierte a sRGB y cualquier canal alfa se descarta. - - - - - - imagick::IMGTYPE_TRUECOLORMATTE - (int) - - - - Color directo con un canal alfa. - Igual que imagick::IMGTYPE_TRUECOLOR, salvo que el - canal alfa se conserva y, si la imagen no tiene ninguno, se le añade uno - opaco. - - - - - - imagick::IMGTYPE_COLORSEPARATION - (int) - - - - Un canal por tinta de impresión, sin paleta. - La imagen se convierte al espacio de color CMYK y cualquier canal alfa se - descarta. - - - - - - imagick::IMGTYPE_COLORSEPARATIONMATTE - (int) - - - - Un canal por tinta de impresión, sin paleta, más un canal alfa. - Igual que imagick::IMGTYPE_COLORSEPARATION, salvo que - el canal alfa se conserva y, si la imagen no tiene ninguno, se le añade uno - opaco. - - - - - - imagick::IMGTYPE_PALETTEBILEVELMATTE - (int) - - - - Color indexado con un canal alfa totalmente transparente o totalmente - opaco. - La imagen se convierte a sRGB, se le añade un canal alfa opaco si no tiene - ninguno, ese canal por sí solo se reduce a dos valores y después se - cuantizan los colores. - Este es el tipo de un PNG que usa transparencia binaria. - - - - - - imagick::IMGTYPE_OPTIMIZE - (int) - - - - Imagick::setImageType no convierte nada para este - valor, pero lo registra igualmente en la imagen. - - - - - - Constantes <constant>RESOLUTION_<replaceable>*</replaceable></constant> - - - - imagick::RESOLUTION_UNDEFINED - (int) - - - - - - - - - imagick::RESOLUTION_PIXELSPERINCH - (int) - - - - - - - - - imagick::RESOLUTION_PIXELSPERCENTIMETER - (int) - - - - - - - - - Constantes <constant>COMPRESSION_<replaceable>*</replaceable></constant> - - - - imagick::COMPRESSION_UNDEFINED - (int) - - - - - - - - - imagick::COMPRESSION_NO - (int) - - - - - - - - - imagick::COMPRESSION_BZIP - (int) - - - - - - - - - imagick::COMPRESSION_FAX - (int) - - - - - - - - - imagick::COMPRESSION_GROUP4 - (int) - - - - - - - - - imagick::COMPRESSION_JPEG - (int) - - - - - - - - - imagick::COMPRESSION_JPEG2000 - (int) - - - - - - - - - imagick::COMPRESSION_LOSSLESSJPEG - (int) - - - - - - - - - imagick::COMPRESSION_LZW - (int) - - - - - - - - - imagick::COMPRESSION_RLE - (int) - - - - - - - - - imagick::COMPRESSION_ZIP - (int) - - - - - - - - - imagick::COMPRESSION_DXT1 - (int) - - - - &imagick.constant.available; 6.4.0 o superior. - - - - - - imagick::COMPRESSION_DXT3 - (int) - - - - &imagick.constant.available; 6.4.0 o superior. - - - - - - imagick::COMPRESSION_DXT5 - (int) - - - - &imagick.constant.available; 6.4.0 o superior. - - - - - - Constantes <constant>PAINT_<replaceable>*</replaceable></constant> - - - - imagick::PAINT_POINT - (int) - - - - - - - - - imagick::PAINT_REPLACE - (int) - - - - - - - - - imagick::PAINT_FLOODFILL - (int) - - - - - - - - - imagick::PAINT_FILLTOBORDER - (int) - - - - - - - - - imagick::PAINT_RESET - (int) - - - - - - - - - Constantes <constant>GRAVITY_<replaceable>*</replaceable></constant> - - - - imagick::GRAVITY_NORTHWEST - (int) - - - - - - - - - imagick::GRAVITY_NORTH - (int) - - - - - - - - - imagick::GRAVITY_NORTHEAST - (int) - - - - - - - - - imagick::GRAVITY_WEST - (int) - - - - - - - - - imagick::GRAVITY_CENTER - (int) - - - - - - - - - imagick::GRAVITY_EAST - (int) - - - - - - - - - imagick::GRAVITY_SOUTHWEST - (int) - - - - - - - - - imagick::GRAVITY_SOUTH - (int) - - - - - - - - - imagick::GRAVITY_SOUTHEAST - (int) - - - - - - - - - Constantes <constant>STRETCH_<replaceable>*</replaceable></constant> - - - - imagick::STRETCH_NORMAL - (int) - - - - - - - - - imagick::STRETCH_ULTRACONDENSED - (int) - - - - - - - - - imagick::STRETCH_CONDENSED - (int) - - - - - - - - - imagick::STRETCH_SEMICONDENSED - (int) - - - - - - - - - imagick::STRETCH_SEMIEXPANDED - (int) - - - - - - - - - imagick::STRETCH_EXPANDED - (int) - - - - - - - - - imagick::STRETCH_EXTRAEXPANDED - (int) - - - - - - - - - imagick::STRETCH_ULTRAEXPANDED - (int) - - - - - - - - - imagick::STRETCH_ANY - (int) - - - - - - - - - Constantes <constant>ALIGN_<replaceable>*</replaceable></constant> - - - - imagick::ALIGN_UNDEFINED - (int) - - - - - - - - - imagick::ALIGN_LEFT - (int) - - - - - - - - - imagick::ALIGN_CENTER - (int) - - - - - - - - - imagick::ALIGN_RIGHT - (int) - - - - - - - - - Constantes <constant>DECORATION_<replaceable>*</replaceable></constant> - - - - imagick::DECORATION_NO - (int) - - - - - - - - - imagick::DECORATION_UNDERLINE - (int) - - - - - - - - - imagick::DECORATION_OVERLINE - (int) - - - - - - - - - imagick::DECORATION_LINETROUGH - (int) - - - - - - - - - Constantes <constant>NOISE_<replaceable>*</replaceable></constant> - - - - imagick::NOISE_UNIFORM - (int) - - - - - - - - - imagick::NOISE_GAUSSIAN - (int) - - - - - - - - - imagick::NOISE_MULTIPLICATIVEGAUSSIAN - (int) - - - - - - - - - imagick::NOISE_IMPULSE - (int) - - - - - - - - - imagick::NOISE_LAPLACIAN - (int) - - - - - - - - - imagick::NOISE_POISSON - (int) - - - - - - - - - imagick::NOISE_RANDOM - (int) - - - - &imagick.constant.available; 6.3.6 o superior. - - - - - - Constantes <constant>CHANNEL_<replaceable>*</replaceable></constant> - - - - imagick::CHANNEL_UNDEFINED - (int) - - - - - - - - - imagick::CHANNEL_RED - (int) - - - - - - - - - imagick::CHANNEL_GRAY - (int) - - - - - - - - - imagick::CHANNEL_CYAN - (int) - - - - - - - - - imagick::CHANNEL_GREEN - (int) - - - - - - - - - imagick::CHANNEL_MAGENTA - (int) - - - - - - - - - imagick::CHANNEL_BLUE - (int) - - - - - - - - - imagick::CHANNEL_YELLOW - (int) - - - - - - - - - imagick::CHANNEL_ALPHA - (int) - - - - - - - - - imagick::CHANNEL_OPACITY - (int) - - - - - - - - - imagick::CHANNEL_MATTE - (int) - - - - - - - - - imagick::CHANNEL_BLACK - (int) - - - - - - - - - imagick::CHANNEL_INDEX - (int) - - - - - - - - - imagick::CHANNEL_ALL - (int) - - - - - - - - - imagick::CHANNEL_DEFAULT - (int) - - - - - - - - - Constantes <constant>METRIC_<replaceable>*</replaceable></constant> - - - - imagick::METRIC_UNDEFINED - (int) - - - - - - - - - imagick::METRIC_MEANABSOLUTEERROR - (int) - - - - - - - - - imagick::METRIC_MEANSQUAREERROR - (int) - - - - - - - - - imagick::METRIC_PEAKABSOLUTEERROR - (int) - - - - - - - - - imagick::METRIC_PEAKSIGNALTONOISERATIO - (int) - - - - - - - - - imagick::METRIC_ROOTMEANSQUAREDERROR - (int) - - - - - - - - - Constantes <constant>PIXEL_<replaceable>*</replaceable></constant> - - - - imagick::PIXEL_CHAR - (int) - - - - - - - - - imagick::PIXEL_DOUBLE - (int) - - - - - - - - - imagick::PIXEL_FLOAT - (int) - - - - - - - - - imagick::PIXEL_INTEGER - (int) - - - - Solo disponible con ImageMagick < 7. - - - - - - imagick::PIXEL_LONG - (int) - - - - - - - - - imagick::PIXEL_QUANTUM - (int) - - - - - - - - - imagick::PIXEL_SHORT - (int) - - - - - - - - - Constantes <constant>EVALUATE_<replaceable>*</replaceable></constant> - - - - imagick::EVALUATE_UNDEFINED - (int) - - - - - - - - - imagick::EVALUATE_ADD - (int) - - - - - - - - - imagick::EVALUATE_AND - (int) - - - - - - - - - imagick::EVALUATE_DIVIDE - (int) - - - - - - - - - imagick::EVALUATE_LEFTSHIFT - (int) - - - - - - - - - imagick::EVALUATE_MAX - (int) - - - - - - - - - imagick::EVALUATE_MIN - (int) - - - - - - - - - imagick::EVALUATE_MULTIPLY - (int) - - - - - - - - - imagick::EVALUATE_OR - (int) - - - - - - - - - imagick::EVALUATE_RIGHTSHIFT - (int) - - - - - - - - - imagick::EVALUATE_SET - (int) - - - - - - - - - imagick::EVALUATE_SUBTRACT - (int) - - - - - - - - - imagick::EVALUATE_XOR - (int) - - - - - - - - - imagick::EVALUATE_POW - (int) - - - - &imagick.constant.available; 6.4.4 o superior. - - - - - - imagick::EVALUATE_LOG - (int) - - - - &imagick.constant.available; 6.4.4 o superior. - - - - - - imagick::EVALUATE_THRESHOLD - (int) - - - - &imagick.constant.available; 6.4.4 o superior. - - - - - - imagick::EVALUATE_THRESHOLDBLACK - (int) - - - - &imagick.constant.available; 6.4.4 o superior. - - - - - - imagick::EVALUATE_THRESHOLDWHITE - (int) - - - - &imagick.constant.available; 6.4.4 o superior. - - - - - - imagick::EVALUATE_GAUSSIANNOISE - (int) - - - - &imagick.constant.available; 6.4.4 o superior. - - - - - - imagick::EVALUATE_IMPULSENOISE - (int) - - - - &imagick.constant.available; 6.4.4 o superior. - - - - - - imagick::EVALUATE_LAPLACIANNOISE - (int) - - - - &imagick.constant.available; 6.4.4 o superior. - - - - - - imagick::EVALUATE_MULTIPLICATIVENOISE - (int) - - - - &imagick.constant.available; 6.4.4 o superior. - - - - - - imagick::EVALUATE_POISSONNOISE - (int) - - - - &imagick.constant.available; 6.4.4 o superior. - - - - - - imagick::EVALUATE_UNIFORMNOISE - (int) - - - - &imagick.constant.available; 6.4.4 o superior. - - - - - - imagick::EVALUATE_COSINE - (int) - - - - &imagick.constant.available; 6.4.4 o superior. - - - - - - imagick::EVALUATE_SINE - (int) - - - - &imagick.constant.available; 6.4.4 o superior. - - - - - - imagick::EVALUATE_ADDMODULUS - (int) - - - - &imagick.constant.available; 6.4.4 o superior. - - - - - - Constantes <constant>COLORSPACE_<replaceable>*</replaceable></constant> - - - - imagick::COLORSPACE_UNDEFINED - (int) - - - - - - - - - imagick::COLORSPACE_RGB - (int) - - - - - - - - - imagick::COLORSPACE_GRAY - (int) - - - - - - - - - imagick::COLORSPACE_TRANSPARENT - (int) - - - - - - - - - imagick::COLORSPACE_OHTA - (int) - - - - - - - - - imagick::COLORSPACE_LAB - (int) - - - - - - - - - imagick::COLORSPACE_XYZ - (int) - - - - - - - - - imagick::COLORSPACE_YCBCR - (int) - - - - - - - - - imagick::COLORSPACE_YCC - (int) - - - - - - - - - imagick::COLORSPACE_YIQ - (int) - - - - - - - - - imagick::COLORSPACE_YPBPR - (int) - - - - - - - - - imagick::COLORSPACE_YUV - (int) - - - - - - - - - imagick::COLORSPACE_CMYK - (int) - - - - - - - - - imagick::COLORSPACE_SRGB - (int) - - - - - - - - - imagick::COLORSPACE_HSB - (int) - - - - - - - - - imagick::COLORSPACE_HSL - (int) - - - - - - - - - imagick::COLORSPACE_HWB - (int) - - - - - - - - - imagick::COLORSPACE_REC601LUMA - (int) - - - - - - - - - imagick::COLORSPACE_REC709LUMA - (int) - - - - - - - - - imagick::COLORSPACE_LOG - (int) - - - - - - - - - imagick::COLORSPACE_CMY - (int) - - - - &imagick.constant.available; 6.4.2 o superior. - - - - - - Constantes <constant>VIRTUALPIXELMETHOD_<replaceable>*</replaceable></constant> - - - - imagick::VIRTUALPIXELMETHOD_UNDEFINED - (int) - - - - - - - - - imagick::VIRTUALPIXELMETHOD_BACKGROUND - (int) - - - - - - - - - imagick::VIRTUALPIXELMETHOD_CONSTANT - (int) - - - - - - - - - imagick::VIRTUALPIXELMETHOD_EDGE - (int) - - - - - - - - - imagick::VIRTUALPIXELMETHOD_MIRROR - (int) - - - - - - - - - imagick::VIRTUALPIXELMETHOD_TILE - (int) - - - - - - - - - imagick::VIRTUALPIXELMETHOD_TRANSPARENT - (int) - - - - - - - - - imagick::VIRTUALPIXELMETHOD_MASK - (int) - - - - &imagick.constant.available; 6.4.2 o superior. - - - - - - imagick::VIRTUALPIXELMETHOD_BLACK - (int) - - - - &imagick.constant.available; 6.4.2 o superior. - - - - - - imagick::VIRTUALPIXELMETHOD_GRAY - (int) - - - - &imagick.constant.available; 6.4.2 o superior. - - - - - - imagick::VIRTUALPIXELMETHOD_WHITE - (int) - - - - &imagick.constant.available; 6.4.2 o superior. - - - - - - imagick::VIRTUALPIXELMETHOD_HORIZONTALTILE - (int) - - - - &imagick.constant.available; 6.4.3 o superior. - - - - - - imagick::VIRTUALPIXELMETHOD_VERTICALTILE - (int) - - - - &imagick.constant.available; 6.4.3 o superior. - - - - - - Constantes <constant>PREVIEW_<replaceable>*</replaceable></constant> - - - - imagick::PREVIEW_UNDEFINED - (int) - - - - - - - - - imagick::PREVIEW_ROTATE - (int) - - - - - - - - - imagick::PREVIEW_SHEAR - (int) - - - - - - - - - imagick::PREVIEW_ROLL - (int) - - - - - - - - - imagick::PREVIEW_HUE - (int) - - - - - - - - - imagick::PREVIEW_SATURATION - (int) - - - - - - - - - imagick::PREVIEW_BRIGHTNESS - (int) - - - - - - - - - imagick::PREVIEW_GAMMA - (int) - - - - - - - - - imagick::PREVIEW_SPIFF - (int) - - - - - - - - - imagick::PREVIEW_DULL - (int) - - - - - - - - - imagick::PREVIEW_GRAYSCALE - (int) - - - - - - - - - imagick::PREVIEW_QUANTIZE - (int) - - - - - - - - - imagick::PREVIEW_DESPECKLE - (int) - - - - - - - - - imagick::PREVIEW_REDUCENOISE - (int) - - - - - - - - - imagick::PREVIEW_ADDNOISE - (int) - - - - - - - - - imagick::PREVIEW_SHARPEN - (int) - - - - - - - - - imagick::PREVIEW_BLUR - (int) - - - - - - - - - imagick::PREVIEW_THRESHOLD - (int) - - - - - - - - - imagick::PREVIEW_EDGEDETECT - (int) - - - - - - - - - imagick::PREVIEW_SPREAD - (int) - - - - - - - - - imagick::PREVIEW_SOLARIZE - (int) - - - - - - - - - imagick::PREVIEW_SHADE - (int) - - - - - - - - - imagick::PREVIEW_RAISE - (int) - - - - - - - - - imagick::PREVIEW_SEGMENT - (int) - - - - - - - - - imagick::PREVIEW_SWIRL - (int) - - - - - - - - - imagick::PREVIEW_IMPLODE - (int) - - - - - - - - - imagick::PREVIEW_WAVE - (int) - - - - - - - - - imagick::PREVIEW_OILPAINT - (int) - - - - - - - - - imagick::PREVIEW_CHARCOALDRAWING - (int) - - - - - - - - - imagick::PREVIEW_JPEG - (int) - - - - - - - - - - Constantes <constant>RENDERINGINTENT_<replaceable>*</replaceable></constant> - - - - imagick::RENDERINGINTENT_UNDEFINED - (int) - - - - - - - - - imagick::RENDERINGINTENT_SATURATION - (int) - - - - - - - - - imagick::RENDERINGINTENT_PERCEPTUAL - (int) - - - - - - - - - imagick::RENDERINGINTENT_ABSOLUTE - (int) - - - - - - - - - imagick::RENDERINGINTENT_RELATIVE - (int) - - - - - - - - - - Constantes <constant>INTERLACE_<replaceable>*</replaceable></constant> - - - - imagick::INTERLACE_UNDEFINED - (int) - - - - - - - - - imagick::INTERLACE_NO - (int) - - - - - - - - - imagick::INTERLACE_LINE - (int) - - - - - - - - - imagick::INTERLACE_PLANE - (int) - - - - - - - - - imagick::INTERLACE_PARTITION - (int) - - - - - - - - - imagick::INTERLACE_GIF - (int) - - - - &imagick.constant.available; 6.3.4 o superior. - - - - - - imagick::INTERLACE_JPEG - (int) - - - - - - - - - imagick::INTERLACE_PNG - (int) - - - - - - - - - - Constantes <constant>FILLRULE_<replaceable>*</replaceable></constant> - - - - imagick::FILLRULE_UNDEFINED - (int) - - - - - - - - - imagick::FILLRULE_EVENODD - (int) - - - - - - - - - imagick::FILLRULE_NONZERO - (int) - - - - - - - - - - Constantes <constant>PATHUNITS_<replaceable>*</replaceable></constant> - - - - imagick::PATHUNITS_UNDEFINED - (int) - - - - - - - - - imagick::PATHUNITS_USERSPACE - (int) - - - - - - - - - imagick::PATHUNITS_USERSPACEONUSE - (int) - - - - - - - - - imagick::PATHUNITS_OBJECTBOUNDINGBOX - (int) - - - - - - - - - - Constantes <constant>LINECAP_<replaceable>*</replaceable></constant> - - - - imagick::LINECAP_UNDEFINED - (int) - - - - - - - - - imagick::LINECAP_BUTT - (int) - - - - - - - - - imagick::LINECAP_ROUND - (int) - - - - - - - - - imagick::LINECAP_SQUARE - (int) - - - - - - - - - - Constantes <constant>LINEJOIN_<replaceable>*</replaceable></constant> - - - - imagick::LINEJOIN_UNDEFINED - (int) - - - - - - - - - imagick::LINEJOIN_MITER - (int) - - - - - - - - - imagick::LINEJOIN_ROUND - (int) - - - - - - - - - imagick::LINEJOIN_BEVEL - (int) - - - - - - - - - - Constantes <constant>RESOURCETYPE_<replaceable>*</replaceable></constant> - - - - imagick::RESOURCETYPE_UNDEFINED - (int) - - - - - - - - - imagick::RESOURCETYPE_AREA - (int) - - - - Define el ancho y la altura máximos de una imagen - que puede almacenarse en la caché de píxeles. - - - - - - imagick::RESOURCETYPE_DISK - (int) - - - - Define el tamaño máximo de espacio en disco permitido para almacenar la caché - de píxeles. - - - - - - imagick::RESOURCETYPE_FILE - (int) - - - - Define el número máximo de archivos de caché de píxeles abiertos. - - - - - - imagick::RESOURCETYPE_MAP - (int) - - - - Define el tamaño máximo de memoria en bytes a asignar a la caché - de píxeles. - - - - - - imagick::RESOURCETYPE_MEMORY - (int) - - - - Define el tamaño máximo de la memoria, en bytes, a asignar a la caché - de píxeles. - - - - - - imagick::RESOURCETYPE_THREAD - (int) - - - - Define el número máximo de hilos paralelos. - &imagick.constant.available; 6.7.8 o superior. - - - - - - - Constantes <constant>LAYERMETHOD_<replaceable>*</replaceable></constant> - - - - imagick::LAYERMETHOD_UNDEFINED - (int) - - - - &imagick.constant.available; 6.2.9 o superior. - - - - - - imagick::LAYERMETHOD_COALESCE - (int) - - - - &imagick.constant.available; 6.2.9 o superior. - - - - - - imagick::LAYERMETHOD_COMPAREANY - (int) - - - - &imagick.constant.available; 6.2.9 o superior. - - - - - - imagick::LAYERMETHOD_COMPARECLEAR - (int) - - - - &imagick.constant.available; 6.2.9 o superior. - - - - - - imagick::LAYERMETHOD_COMPAREOVERLAY - (int) - - - - &imagick.constant.available; 6.2.9 o superior. - - - - - - imagick::LAYERMETHOD_DISPOSE - (int) - - - - &imagick.constant.available; 6.2.9 o superior. - - - - - - imagick::LAYERMETHOD_OPTIMIZE - (int) - - - - &imagick.constant.available; 6.2.9 o superior. - - - - - - imagick::LAYERMETHOD_OPTIMIZEPLUS - (int) - - - - &imagick.constant.available; 6.2.9 o superior. - - - - - - imagick::LAYERMETHOD_OPTIMIZEIMAGE - (int) - - - - &imagick.constant.available; 6.3.0 o superior. - - - - - - imagick::LAYERMETHOD_OPTIMIZETRANS - (int) - - - - &imagick.constant.available; 6.3.0 o superior. - - - - - - imagick::LAYERMETHOD_REMOVEDUPS - (int) - - - - &imagick.constant.available; 6.3.0 o superior. - - - - - - imagick::LAYERMETHOD_REMOVEZERO - (int) - - - - &imagick.constant.available; 6.3.0 o superior. - - - - - - imagick::LAYERMETHOD_COMPOSITE - (int) - - - - &imagick.constant.available; 6.3.0 o superior. - - - - - - imagick::LAYERMETHOD_MERGE - (int) - - - - &imagick.constant.available; 6.3.7 o superior. - - - - - - imagick::LAYERMETHOD_FLATTEN - (int) - - - - &imagick.constant.available; 6.3.7 o superior. - - - - - - imagick::LAYERMETHOD_MOSAIC - (int) - - - - &imagick.constant.available; 6.3.7 o superior. - - - - - - - Constantes <constant>ORIENTATION_<replaceable>*</replaceable></constant> - - - - imagick::ORIENTATION_UNDEFINED - (int) - - - - &imagick.constant.available; 6.3.0 o superior. - - - - - - imagick::ORIENTATION_TOPLEFT - (int) - - - - &imagick.constant.available; 6.3.0 o superior. - - - - - - imagick::ORIENTATION_TOPRIGHT - (int) - - - - &imagick.constant.available; 6.3.0 o superior. - - - - - - imagick::ORIENTATION_BOTTOMRIGHT - (int) - - - - &imagick.constant.available; 6.3.0 o superior. - - - - - - imagick::ORIENTATION_BOTTOMLEFT - (int) - - - - &imagick.constant.available; 6.3.0 o superior. - - - - - - imagick::ORIENTATION_LEFTTOP - (int) - - - - &imagick.constant.available; 6.3.0 o superior. - - - - - - imagick::ORIENTATION_RIGHTTOP - (int) - - - - &imagick.constant.available; 6.3.0 o superior. - - - - - - imagick::ORIENTATION_RIGHTBOTTOM - (int) - - - - &imagick.constant.available; 6.3.0 o superior. - - - - - - imagick::ORIENTATION_LEFTBOTTOM - (int) - - - - &imagick.constant.available; 6.3.0 o superior. - - - - - - - Constantes <constant>DISTORTION_<replaceable>*</replaceable></constant> - - - - imagick::DISTORTION_UNDEFINED - (int) - - - - &imagick.constant.available; 6.3.6 o superior. - - - - - - imagick::DISTORTION_AFFINE - (int) - - - - &imagick.constant.available; 6.3.6 o superior. - - - - - - imagick::DISTORTION_AFFINEPROJECTION - (int) - - - - &imagick.constant.available; 6.3.6 o superior. - - - - - - imagick::DISTORTION_ARC - (int) - - - - &imagick.constant.available; 6.3.6 o superior. - - - - - - imagick::DISTORTION_BILINEAR - (int) - - - - &imagick.constant.available; 6.3.6 o superior. - - - - - - imagick::DISTORTION_PERSPECTIVE - (int) - - - - &imagick.constant.available; 6.3.6 o superior. - - - - - - imagick::DISTORTION_PERSPECTIVEPROJECTION - (int) - - - - &imagick.constant.available; 6.3.6 o superior. - - - - - - imagick::DISTORTION_SCALEROTATETRANSLATE - (int) - - - - &imagick.constant.available; 6.3.6 o superior. - - - - - - imagick::DISTORTION_POLYNOMIAL - (int) - - - - &imagick.constant.available; 6.4.6 o superior. - - - - - - imagick::DISTORTION_POLAR - (int) - - - - &imagick.constant.available; 6.4.6 o superior. - - - - - - imagick::DISTORTION_DEPOLAR - (int) - - - - &imagick.constant.available; 6.4.6 o superior. - - - - - - imagick::DISTORTION_BARREL - (int) - - - - &imagick.constant.available; 6.4.6 o superior. - - - - - - imagick::DISTORTION_BARRELINVERSE - (int) - - - - &imagick.constant.available; 6.4.6 o superior. - - - - - - imagick::DISTORTION_SHEPARDS - (int) - - - - &imagick.constant.available; 6.4.6 o superior. - - - - - - imagick::DISTORTION_SENTINEL - (int) - - - - &imagick.constant.available; 6.4.6 o superior. - - - - - - - Constantes <constant>ALPHACHANNEL_<replaceable>*</replaceable></constant> - - - - imagick::ALPHACHANNEL_ACTIVATE - (int) - - - - &imagick.constant.available; 6.3.8 o superior. - - - - - - imagick::ALPHACHANNEL_DEACTIVATE - (int) - - - - &imagick.constant.available; 6.3.8 o superior. - - - - - - imagick::ALPHACHANNEL_RESET - (int) - - - - &imagick.constant.available; 6.3.8 o superior. - - - - - - imagick::ALPHACHANNEL_SET - (int) - - - - &imagick.constant.available; 6.3.8 o superior. - - - - - - imagick::ALPHACHANNEL_UNDEFINED - (int) - - - - &imagick.constant.available; 6.4.6 o superior. - - - - - - imagick::ALPHACHANNEL_COPY - (int) - - - - &imagick.constant.available; 6.4.6 o superior. - - - - - - imagick::ALPHACHANNEL_EXTRACT - (int) - - - - &imagick.constant.available; 6.4.6 o superior. - - - - - - imagick::ALPHACHANNEL_OPAQUE - (int) - - - - &imagick.constant.available; 6.4.6 o superior. - - - - - - imagick::ALPHACHANNEL_SHAPE - (int) - - - - &imagick.constant.available; 6.4.6 o superior. - - - - - - imagick::ALPHACHANNEL_TRANSPARENT - (int) - - - - &imagick.constant.available; 6.4.6 o superior. - - - - - - imagick::ALPHACHANNEL_BACKGROUND - (int) - - - - &imagick.constant.available; 6.5.3 o superior. - - - - - - imagick::ALPHACHANNEL_REMOVE - (int) - - - - &imagick.constant.available; 6.7.8 o superior. - - - - - - imagick::ALPHACHANNEL_ASSOCIATE - (int) - - - - &imagick.constant.available; 6.9.0 o superior. - - - - - - imagick::ALPHACHANNEL_DISSOCIATE - (int) - - - - &imagick.constant.available; 6.9.0 o superior. - - - - - - imagick::ALPHACHANNEL_ON - (int) - - - - &imagick.constant.available; 7.0.0 o superior. - - - - - - imagick::ALPHACHANNEL_OFF - (int) - - - - &imagick.constant.available; 7.0.0 o superior. - - - - - - imagick::ALPHACHANNEL_DISCRETE - (int) - - - - &imagick.constant.available; 7.0.0 o superior. - - - - - - - Constantes <constant>SPARSECOLORMETHOD_<replaceable>*</replaceable></constant> - - - - imagick::SPARSECOLORMETHOD_UNDEFINED - (int) - - - - &imagick.constant.available; 6.4.6 o superior. - - - - - - imagick::SPARSECOLORMETHOD_BARYCENTRIC - (int) - - - - &imagick.constant.available; 6.4.6 o superior. - - - - - - imagick::SPARSECOLORMETHOD_BILINEAR - (int) - - - - &imagick.constant.available; 6.4.6 o superior. - - - - - - imagick::SPARSECOLORMETHOD_POLYNOMIAL - (int) - - - - &imagick.constant.available; 6.4.6 o superior. - - - - - - imagick::SPARSECOLORMETHOD_SPEPARDS - (int) - - - - &imagick.constant.available; 6.4.6 o superior. - - - - - - imagick::SPARSECOLORMETHOD_VORONOI - (int) - - - - &imagick.constant.available; 6.4.6 o superior. - - - - - - - Constantes <constant>FUNCTION_<replaceable>*</replaceable></constant> - - - - imagick::FUNCTION_UNDEFINED - (int) - - - - &imagick.constant.available; 6.4.9 o superior. - - - - - - imagick::FUNCTION_POLYNOMIAL - (int) - - - - &imagick.constant.available; 6.4.9 o superior. - - - - - - imagick::FUNCTION_SINUSOID - (int) - - - - &imagick.constant.available; 6.4.9 o superior. - - - - - - - Constantes <constant>INTERPOLATE_<replaceable>*</replaceable></constant> - - - - imagick::INTERPOLATE_UNDEFINED - (int) - - - - &imagick.constant.available; 6.3.2 o superior. - - - - - - imagick::INTERPOLATE_AVERAGE - (int) - - - - &imagick.constant.available; 6.3.2 o superior. - - - - - - imagick::INTERPOLATE_BICUBIC - (int) - - - - &imagick.constant.available; 6.3.2 o superior. - - - - - - imagick::INTERPOLATE_BILINEAR - (int) - - - - &imagick.constant.available; 6.3.2 o superior. - - - - - - imagick::INTERPOLATE_FILTER - (int) - - - - &imagick.constant.available; 6.3.2 o superior. - - - - - - imagick::INTERPOLATE_INTEGER - (int) - - - - &imagick.constant.available; 6.3.2 o superior. - - - - - - imagick::INTERPOLATE_MESH - (int) - - - - &imagick.constant.available; 6.3.2 o superior. - - - - - - imagick::INTERPOLATE_NEARESTNEIGHBOR - (int) - - - - &imagick.constant.available; 6.3.2 o superior. - - - - - - imagick::INTERPOLATE_SPLINE - (int) - - - - &imagick.constant.available; 6.3.4 o superior. - - - - - - - Constantes <constant>DITHERMETHOD_<replaceable>*</replaceable></constant> - - - - imagick::DITHERMETHOD_UNDEFINED - (int) - - - - &imagick.constant.available; 6.4.6 o superior. - - - - - - imagick::DITHERMETHOD_NO - (int) - - - - &imagick.constant.available; 6.4.6 o superior. - - - - - - imagick::DITHERMETHOD_RIEMERSMA - (int) - - - - &imagick.constant.available; 6.4.6 o superior. - - - - - - imagick::DITHERMETHOD_FLOYDSTEINBERG - (int) - - - - &imagick.constant.available; 6.4.6 o superior. - - - - - - - diff --git a/reference/imagick/examples.xml b/reference/imagick/examples.xml deleted file mode 100644 index 492115496c..0000000000 --- a/reference/imagick/examples.xml +++ /dev/null @@ -1,273 +0,0 @@ - - - - - &reftitle.examples; -
- Uso básico - - Imagick hace que la manipulación de imágenes en PHP sea extremadamente sencilla a través - de una interfaz OO. Aquí está un ejemplo breve de cómo hacer una miniatura: - - Crear una miniatura con Imagick - -thumbnailImage(100, 0); - -echo $imagen; - -?> -]]> - - - - - - Al usar SPL y otras características OO soportadas en Imagick, puede ser sencillo - redimensionar todos los archivos de un directorio (útil para la redimensión por lotes de - muchas imágenes de cámara digital para que sean visibles desde una web). Aquí usamos redimensión, - ya que queremos mantener cierta meta-información: - - Hacer una miniatura de todos los archivos JPG de un directorio - -thumbnailImage(1024,0); - -} - -$imágenes->writeImages(); - -?> -]]> - - - - - Este es un ejemplo de crear un reflejo de una imagen. - El reflejo se crea volteando la imagen y poniendo una capa de gradiente sobre ella. - Ambas, la imagen original y el reflejo, están sobrepuestas en un lienzo. - - Crear un reflejo de una imagen - -thumbnailImage(200, null); - -/* Crear un borde para la imagen */ -$im->borderImage(new ImagickPixel("white"), 5, 5); - -/* Clonar la imagen y voltearla */ -$reflejo = $im->clone(); -$reflejo->flipImage(); - -/* Crear un gradiente. Será sobrepuesto en el reflejo */ -$gradiente = new Imagick(); - -/* El gradiente necesita ser más grande que la imagen y los bordes */ -$gradiente->newPseudoImage($reflejo->getImageWidth() + 10, $reflejo->getImageHeight() + 10, "gradient:transparent-black"); - -/* Componer el gradiente con el reflejo */ -$reflejo->compositeImage($gradiente, imagick::COMPOSITE_OVER, 0, 0); - -/* Añadir algo de opacidad. Requiere ImageMagick 6.2.9 o superior */ -$reflejo->setImageOpacity( 0.3 ); - -/* Crear un lienzo vacío */ -$lienzo = new Imagick(); - -/* El lienzo necesita ser más grande para mantener ambas imágenes */ -$ancho = $im->getImageWidth() + 40; -$alto = ($im->getImageHeight() * 2) + 30; -$lienzo->newImage($ancho, $alto, new ImagickPixel("black")); -$lienzo->setImageFormat("png"); - -/* Componer la imagen original y el reflejo sobre el lienzo */ -$lienzo->compositeImage($im, imagick::COMPOSITE_OVER, 20, 10); -$lienzo->compositeImage($reflejo, imagick::COMPOSITE_OVER, 20, $im->getImageHeight() + 10); - -/* Imprimir la imagen */ -header("Content-Type: image/png"); -echo $lienzo; -?> -]]> - - &example.outputs.similar; - - Salida del ejemplo : Crear un reflejo de una imagen - - - - - - - - Este ejemplo ilustra cómo usar patrones de relleno durante el dibujo. - - Rellenar un texto con un gradiente - -newPseudoImage(50, 50, "gradient:red-black"); - -/* Crear un objeto imagickdraw */ -$dibujo = new ImagickDraw(); - -/* Iniciar un nuevo patrón llamado "gradient" */ -$dibujo->pushPattern('gradient', 0, 0, 50, 50); - -/* Componer el gradiente con el patrón */ -$dibujo->composite(Imagick::COMPOSITE_OVER, 0, 0, 50, 50, $im); - -/* Cerrar el patrón */ -$dibujo->popPattern(); - -/* Usar el patrón llamado "gradient" como el relleno */ -$dibujo->setFillPatternURL('#gradient'); - -/* Establecer el tamaño de fuente a 52 */ -$dibujo->setFontSize(52); - -/* Anotar algo de texto */ -$dibujo->annotation(20, 50, "Hello World!"); - -/* Crear un nuevo lienzo y una imagen blanca */ -$lienzo = new Imagick(); -$lienzo->newImage(350, 70, "white"); - -/* Dibujar el objeto ImagickDraw sobre el lienzo */ -$lienzo->drawImage($dibujo); - -/* Borde negro de 1px alrededor de la imagen */ -$lienzo->borderImage('black', 1, 1); - -/* Establecer el formato a PNG */ -$lienzo->setImageFormat('png'); - -/* Imprimir la imagen */ -header("Content-Type: image/png"); -echo $lienzo; -?> -]]> - - &example.outputs.similar; - - Salida del ejemplo : Rellenar texto con gradiente - - - - - - - - Trabajar con imágenes GIF animadas - - Leer una imágen GIF y redimensionar todos los fotogramas - -thumbnailImage(50, 50); - - /* Establecer el lienzo virtual para corregir el tamaño */ - $fotograma->setImagePage(50, 50, 0, 0); -} - -/* Observe: writeImages en vez de writeImage */ -$im->writeImages("example_small.gif", true); -?> -]]> - - - - - Trabajar con primitivas de elipse y tipos de letra personalizados - - Crear un logo de PHP - -newImage($ancho, $alto, new ImagickPixel('transparent')); - -/* Nueva instancia de ImagickDraw para dibujar la elipse */ -$dibujo = new ImagickDraw(); -/* Establecer el color de relleno púrpura para la elipse */ -$dibujo->setFillColor('#777bb4'); -/* Establecer las dimensiones de la elipse */ -$dibujo->ellipse($ancho / 2, $alto / 2, $ancho / 2, $alto / 2, 0, 360); -/* Dibujar la elipse en el lienzo */ -$img->drawImage($dibujo); - -/* Restablecer el color de relleno de púrpura a negro para el texto (nota: estamos reutilizando el objeto ImagickDraw) */ -$dibujo->setFillColor('black'); -/* Establecer el borde del contorno al color blanco */ -$dibujo->setStrokeColor('white'); -/* Establecer el grosor del borde del contorno */ -$dibujo->setStrokeWidth(2); -/* Establecer el interletraje («kerning») del tipo de letra (un valor negativo significa que las letras están más juntas entre ellas) */ -$dibujo->setTextKerning(-8); -/* Establecer el tamaño del tipo de letra usado para el logo de PHP */ -$dibujo->setFont('Handel Gothic.ttf'); -$dibujo->setFontSize(150); -/* Centrar el texto horizontal y verticalmente */ -$dibujo->setGravity(Imagick::GRAVITY_CENTER); - -/* Añadir en el centro "php" con el índice Y de -10 al lienzo (dentro de la elipse) */ -$img->annotateImage($dibujo, 0, -10, 0, 'php'); -$img->setImageFormat('png'); - -/* Establecer la cabecera apropiada para PNG y generar la imagen */ -header('Content-Type: image/png'); -echo $img; -?> - -]]> - - &example.outputs.similar; - - Salida del ejemplo: Crear el logo de PHP con Imagick - - - - - - -
-
- - diff --git a/reference/imagick/imagick.xml b/reference/imagick/imagick.xml deleted file mode 100644 index b049d9a28b..0000000000 --- a/reference/imagick/imagick.xml +++ /dev/null @@ -1,774 +0,0 @@ - - - - - - La clase <classname>Imagick</classname> - Imagick - -
- &reftitle.classsynopsis; - - Imagick - - Imagick - - Iterator - - - - - - - - - -
- -
- Métodos de imagen y métodos globales - - La clase Imagick permite actuar sobre varias imágenes simultáneamente y esto, - gracias a una pila interna. Siempre hay un puntero interno, apuntando - a la imagen actual. Algunas funciones actúan sobre todas las imágenes - de una clase Imagick, pero la mayoría únicamente sobre la imagen actual - en relación con esta pila. Al igual que las conversiones, los nombres de los métodos - pueden contener el nombre de la imagen, relatando únicamente el efecto - sobre la imagen de la pila. - -
- -
- Métodos de la clase - - Dado el número de métodos, aquí se presenta una lista que los muestra de forma general: - - - - Métodos de la clase - - - - Efectos sobre la imagen - Métodos de recuperación - Métodos de definición - Lectura/escritura de la imagen - Otros - - - - - - Imagick::adaptiveBlurImage - Imagick::getCompression - Imagick::setBackgroundColor - Imagick::__construct - Imagick::clear - - - Imagick::adaptiveResizeImage - Imagick::getFilename - Imagick::setCompressionQuality - Imagick::addImage - Imagick::clone - - - Imagick::adaptiveSharpenImage - Imagick::getFormat - Imagick::setCompression - Imagick::appendImages - Imagick::current - - - Imagick::adaptiveThresholdImage - Imagick::getImageBackgroundColor - Imagick::setFilename - Imagick::getFilename - Imagick::destroy - - - Imagick::addNoiseImage - Imagick::getImageBlob - Imagick::getImagesBlob - Imagick::setFormat - Imagick::getFormat - - - Imagick::affinetransformimage - Imagick::getImageBluePrimary - Imagick::setImageBackgroundColor - Imagick::getImageFilename - Imagick::getHomeURL - - - Imagick::annotateImage - Imagick::getImageBorderColor - Imagick::setFirstIterator - Imagick::getImageFormat - Imagick::commentImage - - - Imagick::averageImages - Imagick::getImageChannelDepth - Imagick::setImageBias - Imagick::getImage - Imagick::getNumberImages - - - Imagick::blackThresholdImage - Imagick::getImageChannelDistortion - Imagick::setImageBluePrimary - Imagick::setImageFilename - Imagick::getReleaseDate - - - Imagick::blurImage - Imagick::getImageChannelExtrema - Imagick::setImageBorderColor - Imagick::setImageFormat - Imagick::getVersion - - - Imagick::borderImage - Imagick::getImageChannelMean - Imagick::setImageChannelDepth - Imagick::readImageFile - Imagick::hasNextImage - - - Imagick::charcoalImage - Imagick::getImageChannelStatistics - Imagick::setImageColormapColor - Imagick::readImage - Imagick::hasPreviousImage - - - Imagick::chopImage - Imagick::getImageColormapColor - Imagick::setImageColorSpace - Imagick::writeImages - Imagick::labelImage - - - Imagick::clipImage - Imagick::getImageColorspace - Imagick::setImageCompose - Imagick::writeImage - Imagick::newImage - - - Imagick::clipPathImage - Imagick::getImageColors - Imagick::setImageCompression - - Imagick::newPseudoImage - - - Imagick::coalesceImages - Imagick::getImageCompose - Imagick::setImageDelay - - Imagick::nextImage - - - Imagick::colorFloodFillImage - Imagick::getImageDelay - Imagick::setImageDepth - - Imagick::pingImageBlob - - - Imagick::colorizeImage - Imagick::getImageDepth - Imagick::setImageDispose - - Imagick::pingImageFile - - - Imagick::combineImages - Imagick::getImageDispose - Imagick::setImageDispose - - Imagick::pingImage - - - Imagick::compareImageChannels - Imagick::getImageDistortion - Imagick::setImageExtent - - Imagick::previousImage - - - Imagick::compareImageLayers - Imagick::getImageExtrema - Imagick::setImageFilename - - Imagick::profileImage - - - Imagick::compositeImage - Imagick::getImageFilename - Imagick::setImageFormat - - Imagick::queryFormats - - - Imagick::contrastImage - Imagick::getImageFormat - Imagick::setImageGamma - - Imagick::removeImageProfile - - - Imagick::contrastStretchImage - Imagick::getImageGamma - Imagick::setImageGreenPrimary - - Imagick::removeImage - - - Imagick::convolveImage - Imagick::getImageGeometry - Imagick::setImageIndex - - Imagick::setFirstIterator - - - Imagick::cropImage - Imagick::getImageGreenPrimary - Imagick::setImageInterpolateMethod - - Imagick::setImageIndex - - - Imagick::cycleColormapImage - Imagick::getImageHeight - Imagick::setImageIterations - - Imagick::valid - - - Imagick::deconstructImages - Imagick::getImageHistogram - Imagick::setImageMatteColor - - Imagick::getCopyright - - - Imagick::drawImage - Imagick::getImageIndex - Imagick::setImageMatte - - - - - Imagick::edgeImage - Imagick::getImageInterlaceScheme - Imagick::setImagePage - - - - - Imagick::embossImage - Imagick::getImageInterpolateMethod - Imagick::setImageProfile - - - - - Imagick::enhanceImage - Imagick::getImageIterations - Imagick::setImageProperty - - - - - Imagick::equalizeImage - Imagick::getImageMatteColor - Imagick::setImageRedPrimary - - - - - Imagick::evaluateImage - Imagick::getImageMatte - Imagick::setImageRenderingIntent - - - - - Imagick::flattenImages - Imagick::getImagePage - Imagick::setImageResolution - - - - - Imagick::flipImage - Imagick::getImagePixelColor - Imagick::setImageScene - - - - - Imagick::flopImage - Imagick::getImageProfile - Imagick::setImageTicksPerSecond - - - - - - Imagick::getImageProperty - Imagick::setImageType - - - - - Imagick::fxImage - Imagick::getImageRedPrimary - Imagick::setImageUnits - - - - - Imagick::gammaImage - Imagick::getImageRegion - Imagick::setImageVirtualPixelMethod - - - - - Imagick::gaussianBlurImage - Imagick::getImageRenderingIntent - Imagick::setImageWhitepoint - - - - - Imagick::implodeImage - Imagick::getImageResolution - Imagick::setInterlaceScheme - - - - - Imagick::levelImage - Imagick::getImageScene - Imagick::setOption - - - - - Imagick::linearStretchImage - Imagick::getImageSignature - Imagick::setPage - - - - - Imagick::magnifyImage - Imagick::getImageTicksPerSecond - Imagick::setResolution - - - - - Imagick::matteFloodFillImage - Imagick::getImageTotalInkDensity - Imagick::setResourceLimit - - - - - Imagick::medianFilterImage - Imagick::getImageType - Imagick::setSamplingFactors - - - - - Imagick::minifyImage - Imagick::getImageUnits - Imagick::setSizeOffset - - - - - Imagick::modulateImage - Imagick::getImageVirtualPixelMethod - Imagick::setSize - - - - - Imagick::montageImage - Imagick::getImageWhitepoint - Imagick::setType - - - - - Imagick::morphImages - Imagick::getImageWidth - - - - - - Imagick::mosaicImages - Imagick::getImage - - - - - - Imagick::motionBlurImage - Imagick::getInterlaceScheme - - - - - - Imagick::negateImage - Imagick::getNumberImages - - - - - - Imagick::normalizeImage - Imagick::getOption - - - - - - Imagick::oilPaintImage - Imagick::getPackageName - - - - - - Imagick::optimizeImageLayers - Imagick::getPage - - - - - - Imagick::paintOpaqueImage - Imagick::getPixelIterator - - - - - - Imagick::paintTransparentImage - Imagick::getPixelRegionIterator - - - - - - Imagick::posterizeImage - Imagick::getQuantumDepth - - - - - - Imagick::radialBlurImage - Imagick::getQuantumRange - - - - - - Imagick::raiseImage - Imagick::getResourceLimit - - - - - - Imagick::randomThresholdImage - Imagick::getResource - - - - - - Imagick::reduceNoiseImage - Imagick::getSamplingFactors - - - - - - Imagick::render - Imagick::getSizeOffset - - - - - - Imagick::resampleImage - Imagick::getSize - - - - - - Imagick::resizeImage - Imagick::identifyImage - - - - - - Imagick::rollImage - Imagick::getImageSize - - - - - - Imagick::rotateImage - - - - - - - Imagick::sampleImage - - - - - - - Imagick::scaleImage - - - - - - - Imagick::separateImageChannel - - - - - - - Imagick::sepiaToneImage - - - - - - - Imagick::shadeImage - - - - - - - Imagick::shadowImage - - - - - - - Imagick::sharpenImage - - - - - - - Imagick::shaveImage - - - - - - - Imagick::shearImage - - - - - - - Imagick::sigmoidalContrastImage - - - - - - - Imagick::sketchImage - - - - - - - Imagick::solarizeImage - - - - - - - Imagick::spliceImage - - - - - - - Imagick::spreadImage - - - - - - - Imagick::steganoImage - - - - - - - Imagick::stereoImage - - - - - - - Imagick::stripImage - - - - - - - Imagick::swirlImage - - - - - - - Imagick::textureImage - - - - - - - Imagick::thresholdImage - - - - - - - Imagick::thumbnailImage - - - - - - - Imagick::tintImage - - - - - - - Imagick::transverseImage - - - - - - - Imagick::trimImage - - - - - - - Imagick::uniqueImageColors - - - - - - - Imagick::unsharpMaskImage - - - - - - - Imagick::vignetteImage - - - - - - - Imagick::waveImage - - - - - - - Imagick::whiteThresholdImage - - - - - - - -
-
-
- &reference.imagick.entities.imagick; -
- - diff --git a/reference/imagick/imagick/adaptiveblurimage.xml b/reference/imagick/imagick/adaptiveblurimage.xml deleted file mode 100644 index c68a0a0b59..0000000000 --- a/reference/imagick/imagick/adaptiveblurimage.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - Imagick::adaptiveBlurImage - Añade un filtro de borrosidad adaptativo a la imagen - - - - &reftitle.description; - - public boolImagick::adaptiveBlurImage - floatradius - floatsigma - intchannelImagick::CHANNEL_DEFAULT - - - Añade un filtro de borrosidad adaptativo a la imagen. La intensidad de una borrosidad adaptativa - depende de si se disminuye dramáticamente en el borde de la imagen, mientras que una borrodidad - estándar es uniforme en toda la imagen. &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - radius - - - El radio gaussiano, en píxeles, sin contar el píxel central. - Proporcione un valor de 0 y el radio será elegido auto-mágicaente. - - - - - sigma - - - La desviación estándar gaussiana, en píxeles. - - - - - channel - - - &imagick.parameter.channel; - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Usar <function>Imagick::adaptiveBlurImage</function>: - - Aplicar borrosidad adaptativa a una imagen, después mostrarla en el navegador. - - -adaptiveBlurImage(5,3); -echo $imagen; - -?> -]]> - - &example.outputs.similar; - - Salida del ejemplo : Usar Imagick::adaptiveBlurImage() - - - - - - - - - - &reftitle.seealso; - - - Imagick::blurImage - Imagick::motionBlurImage - Imagick::radialBlurImage - - - - - - - diff --git a/reference/imagick/imagick/adaptiveresizeimage.xml b/reference/imagick/imagick/adaptiveresizeimage.xml deleted file mode 100644 index f4e4723038..0000000000 --- a/reference/imagick/imagick/adaptiveresizeimage.xml +++ /dev/null @@ -1,183 +0,0 @@ - - - - - Imagick::adaptiveResizeImage - Redimensiona una imagen adaptativamente con información dependiente de la triangulación - - - - &reftitle.description; - - public boolImagick::adaptiveResizeImage - intcolumns - introws - boolbestfit&false; - boollegacy&false; - - - Redimensiona una imagen adaptativamente con información dependiente de la triangulación. - Evita la borrosidad a través de cambios de color bruscos. Muy útil cuando se usa para encoger - ligeramente imágenes a un "tamaño web" ligeramente más pequeño; puede que no tenga una - buena apariencia cuando una imagen a tamaño completo se redimensiona adaptativamente a una miniatura. - &imagick.method.available.0x629; - - &imagick.bestfit.note; - - - - &reftitle.parameters; - - - - columns - - - El número de columnas en la imagen escalada. - - - - - rows - - - El número de filas en la imagen escalada. - - - - - bestfit - - - Si se establece en &true; y las dimensiones proporcionadas son menores que las - dimensiones de la imagen, la imagen se reducirá para ajustarse dentro del cuadro - delimitador. Si se establece en &false; o si la imagen ya es más pequeña que el - cuadro delimitador, la imagen no se escalará. - - - - - legacy - - - El parámetro legacy fue añadido en PECL imagick 3.4.0. - Se realizaron cambios en el comportamiento de bestfit - cuando el parámetro legacy es &true;. - Consulte el registro de cambios para más información. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL imagick 3.4.0 - Se añadió el parámetro legacy. - - - PECL imagick 2.1.0 - Añadido el parámetro opcional de ajuste. - - - PECL imagick 2.1.0 - - Este método ahora soporta escalas proporcionales. - Pase cero como parámetro para escalar proporcionalmente. - - - - - - - - - &reftitle.examples; - - - Usar <function>Imagick::adaptiveResizeImage</function> - - Redimensiona una imagen al tamaño estándar para la web. Este método trabaja mejor - cuando se redimensiona a un tamaño sólo ligeramente menor que el tamaño de la imagen - previa. - - -adaptiveResizeImage(1024,768); - -echo $imagen; -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::chopImage - Imagick::cropImage - Imagick::magnifyImage - Imagick::minifyImage - Imagick::resizeImage - Imagick::scaleImage - Imagick::shaveImage - Imagick::thumbnailImage - Imagick::trimImage - - - - - - - diff --git a/reference/imagick/imagick/adaptivesharpenimage.xml b/reference/imagick/imagick/adaptivesharpenimage.xml deleted file mode 100644 index d066021ea1..0000000000 --- a/reference/imagick/imagick/adaptivesharpenimage.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - Imagick::adaptiveSharpenImage - Afila la imagen adaptativamente - - - - &reftitle.description; - - public boolImagick::adaptiveSharpenImage - floatradius - floatsigma - intchannelImagick::CHANNEL_DEFAULT - - - - Afila la imagen adaptativamente afilando con más intensidad - cerca de los bordes de la imagen y con menos intensidad lejos de los bordes. &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - radius - - - El radio gaussiano, en píxeles, sin contar el píxel central. Use 0 para autoseleccionar. - - - - - sigma - - - La desviación estándar gaussiana, en píxeles. - - - - - channel - - - &imagick.parameter.channel; - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Un ejemplo de <function>Imagick::adaptiveSharpenImage</function> - - Afilar la imagen adaptativamente con radio 2 y sigma 1. - - -adaptiveSharpenImage(2,1); -} catch(ImagickException $e) { - echo 'Error: ' , $e->getMessage(); - die(); -} -header('Content-type: image/png'); -echo $imagen; -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::sharpenImage - - - - - - - diff --git a/reference/imagick/imagick/adaptivethresholdimage.xml b/reference/imagick/imagick/adaptivethresholdimage.xml deleted file mode 100644 index bf3519b776..0000000000 --- a/reference/imagick/imagick/adaptivethresholdimage.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - Imagick::adaptiveThresholdImage - Selecciona un umbral para cada píxel basado en un rango de intensidad - - - - &reftitle.description; - - public boolImagick::adaptiveThresholdImage - intwidth - intheight - intoffset - - - Selecciona un umbral individual para cada píxel basado en un - rango de valores de intensidad en su zona local. Esto - permite establecer el umbral de una imagen cuyo histograma de intensidad - global no contiene picos distintivos. - - - - - &reftitle.parameters; - - - - width - - - Ancho de la zona local. - - - - - height - - - Alto de la zona local. - - - - - offset - - - El índice medio - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::adaptiveThresholdImage</function> - -adaptiveThresholdImage($width, $height, $adaptiveOffsetQuantum); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/addimage.xml b/reference/imagick/imagick/addimage.xml deleted file mode 100644 index 1761ca2acf..0000000000 --- a/reference/imagick/imagick/addimage.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Imagick::addImage - Añade una nueva imagen a la lista de imágenes del objeto Imagick - - - - &reftitle.description; - - public boolImagick::addImage - Imagicksource - - - Añade una nueva imagen al objeto Imagick desde la posición actual del objeto de origen. - Después de la operación la posición del iterador se mueve al final de la lista. - - - - - &reftitle.parameters; - - - - source - - - El objeto Imagick de origen - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/addnoiseimage.xml b/reference/imagick/imagick/addnoiseimage.xml deleted file mode 100644 index 0507b36d51..0000000000 --- a/reference/imagick/imagick/addnoiseimage.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - Imagick::addNoiseImage - Añade ruido aleatorio a la imagen - - - - &reftitle.description; - - public boolImagick::addNoiseImage - intnoise_type - intchannelImagick::CHANNEL_DEFAULT - - - Añade ruido aleatorio a la imagen. - - - - - &reftitle.parameters; - - - - noise_type - - - El tipo de ruido. Consulte esta lista de - constantes de ruido. - - - - - channel - - - &imagick.parameter.channel; - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::addNoiseImage</function> - -addNoiseImage($noiseType, $channel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/affinetransformimage.xml b/reference/imagick/imagick/affinetransformimage.xml deleted file mode 100644 index bf23f6b9fb..0000000000 --- a/reference/imagick/imagick/affinetransformimage.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - Imagick::affineTransformImage - Transforma una imagen - - - - &reftitle.description; - - public boolImagick::affineTransformImage - ImagickDrawmatrix - - - Transforma una imagen como está establecido en la matriz afín. - - - - - &reftitle.parameters; - - - - matrix - - - La matriz afín - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::affineTransformImage</function> - - cos($angle), "sy" => cos($angle), - "rx" => sin($angle), "ry" => -sin($angle), - "tx" => 0, "ty" => 0, - ); - - $draw->affine($affineRotate); - - $imagick->affineTransformImage($draw); - - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/animateimages.xml b/reference/imagick/imagick/animateimages.xml deleted file mode 100644 index 29cbf772e9..0000000000 --- a/reference/imagick/imagick/animateimages.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - Imagick::animateImages - Anima una imagen o imágenes - - - - &reftitle.description; - - public boolImagick::animateImages - stringx_server - - - - Este método anima la imagen en un servidor X local o remoto. Este método - no está disponible en Windows. - &imagick.method.available.0x636; - - - - - &reftitle.parameters; - - - - x_server - - - La dirección del servidor X - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.seealso; - - - Imagick::displayImage - - - - - - - diff --git a/reference/imagick/imagick/annotateimage.xml b/reference/imagick/imagick/annotateimage.xml deleted file mode 100644 index 509b2b6b53..0000000000 --- a/reference/imagick/imagick/annotateimage.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - Imagick::annotateImage - Anota una imagen con texto - - - - &reftitle.description; - - public boolImagick::annotateImage - ImagickDrawdraw_settings - floatx - floaty - floatangle - stringtext - - - Anota una imagen con texto. - - - - - &reftitle.parameters; - - - - draw_settings - - - El objeto ImagickDraw que contiene la configuración para el dibujo de texto - - - - - x - - - El índice horizontal en píxeles a la izquierda del texto - - - - - y - - - El índice vertical en píxeles de la línea base del texto - - - - - angle - - - El ángulo en el que se escribe el texto - - - - - text - - - La cadena a dibujar - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Usar <function>Imagick::annotateImage</function>: - - Anotar texto en una imagen vacía - - -newImage(800, 75, $píxel); - -/* Texto negro */ -$dibujo->setColor('black'); - -/* Propiedades de la fuente */ -$dibujo->setFont('Bookman-DemiItalic'); -$dibujo->setFontSize( 30 ); - -/* Crear texto */ -$imagen->annotateImage($dibujo, 10, 45, 0, 'The quick brown fox jumps over the lazy dog'); - -/* Dar a la imagen un formato */ -$imagen->setImageFormat('png'); - -/* Imprimir la imagen con cabeceras */ -header('Content-type: image/png'); -echo $imagen; - -?> -]]> - - - - - - - &reftitle.seealso; - - - ImagickDraw::annotation - ImagickDraw::setFont - - - - - - - diff --git a/reference/imagick/imagick/appendimages.xml b/reference/imagick/imagick/appendimages.xml deleted file mode 100644 index 0f7739a928..0000000000 --- a/reference/imagick/imagick/appendimages.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - Imagick::appendImages - Añade un conjunto de imágenes - - - - &reftitle.description; - - public ImagickImagick::appendImages - boolstack - - - Añade un conjunto de imágenes en una imagen más grande. - - - - - &reftitle.parameters; - - - - stack - - - Para apilar las imágenes verticalmente. - Por defecto (o si &false; se especifica) las imágenes se apilan de izquierda a derecha. - Si stack es &true;, las imágenes se apilan de arriba hacia abajo. - - - - - - - - - &reftitle.returnvalues; - - Devuelve una instancia Imagick si se tuvo éxito. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Ejemplo de <methodname>Imagick::appendImages</methodname> - -newImage(100, 50, "red"); -$im->newImage(100, 50, "green"); -$im->newImage(100, 50, "blue"); - -/* Añadir las imágenes en una sola */ -$im->resetIterator(); -$combined = $im->appendImages(true); - -/* Imprimir la imagen */ -$combined->setImageFormat("png"); -header("Content-Type: image/png"); -echo $combined; -?> -]]> - - &example.outputs.similar; - - Salida de ejemplo : Imagick::appendImages() - - - - - - - - - - - diff --git a/reference/imagick/imagick/autolevelimage.xml b/reference/imagick/imagick/autolevelimage.xml deleted file mode 100644 index 05f3b88854..0000000000 --- a/reference/imagick/imagick/autolevelimage.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Imagick::autoLevelImage - Ajusta el nivel de un canal de una imagen particular - - - - &reftitle.description; - - public boolImagick::autoLevelImage - intchannelImagick::CHANNEL_DEFAULT - - - Ajusta el nivel de un canal de una imagen particular escalando los valores mínimos y máximos al rango cuántico completo. - - - - - &reftitle.parameters; - - - channel - - - Qué canal debe ser utilizado para el auto-nivelado. - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - <function>Imagick::autoLevelImage</function> - - autoLevelImage(); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/averageimages.xml b/reference/imagick/imagick/averageimages.xml deleted file mode 100644 index f4a8045da2..0000000000 --- a/reference/imagick/imagick/averageimages.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - Imagick::averageImages - Promedio de un conjunto de imágenes - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public ImagickImagick::averageImages - - - - Realiza el promedio de un conjunto de imágenes. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un nuevo objeto Imagick en caso de éxito. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/blackthresholdimage.xml b/reference/imagick/imagick/blackthresholdimage.xml deleted file mode 100644 index e38390f049..0000000000 --- a/reference/imagick/imagick/blackthresholdimage.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - Imagick::blackThresholdImage - Fuerza a todos los píxeles bajo un umbral a ser negros - - - - &reftitle.description; - - public boolImagick::blackThresholdImage - mixedthreshold - - - Es como Imagick::thresholdImage() pero fuerza a todos los píxeles bajo un umbral - a ser negros mientras deja todos los píxeles por encima del umbral sin cambios. - - - - - &reftitle.parameters; - - - - threshold - - - El umbral por debajo del cual todo se vuelve de color negro - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Ahora se permite que una cadena represente el color como un parámetro. - Versiones anteriores sólo permitían un objeto ImagickPixel. - - - - - - - - - - - - &reftitle.examples; - - - <function>Imagick::blackThresholdImage</function> - - blackthresholdimage($thresholdColor); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/blueshiftimage.xml b/reference/imagick/imagick/blueshiftimage.xml deleted file mode 100644 index 9e73d559e9..0000000000 --- a/reference/imagick/imagick/blueshiftimage.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Imagick::blueShiftImage - Atenúa los colores de la imagen - - - - &reftitle.description; - - public boolImagick::blueShiftImage - floatfactor1.5 - - - - Atenúa los colores de la imagen para simular una escena nocturna a la luz de la luna. - - - - - - &reftitle.parameters; - - - factor - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - <function>Imagick::blueShiftImage</function> - - blueShiftImage($blueShift); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/blurimage.xml b/reference/imagick/imagick/blurimage.xml deleted file mode 100644 index ba0a845fbf..0000000000 --- a/reference/imagick/imagick/blurimage.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - Imagick::blurImage - Añade un filtro de borrosidad a la imagen - - - - &reftitle.description; - - public boolImagick::blurImage - floatradius - floatsigma - intchannel - - - Añade un filtro de borrosidad a la imagen. El tercer parámetro opcional es para hacer borroso - un canal específico. - - - - - &reftitle.parameters; - - - - radius - - - Radio de la borrosidad - - - - - sigma - - - Desviación estándar - - - - - channel - - - La constante Channeltype. - Cuando no es proporciona, todos los canales se hacen borrosos. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Usar <function>Imagick::blurImage</function>: - - Hacer borrosa una imagen, después mostrarla en el navegador. - - -blurImage(5,3); -echo $imagen; - -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::adaptiveBlurImage - Imagick::motionBlurImage - Imagick::radialBlurImage - - - - - - - diff --git a/reference/imagick/imagick/borderimage.xml b/reference/imagick/imagick/borderimage.xml deleted file mode 100644 index 6ba8d4ec02..0000000000 --- a/reference/imagick/imagick/borderimage.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - - Imagick::borderImage - Rodea la imagen con un borde - - - - &reftitle.description; - - public boolImagick::borderImage - mixedbordercolor - intwidth - intheight - - - Rodea la imagen con un borde del color definido por el objeto ImagickPixel de color de borde. - - - - - &reftitle.parameters; - - - - bordercolor - - - Objeto ImagickPixel o una cadena que contiene el color del borde - - - - - width - - - Ancho del borde - - - - - height - - - Alto del borde - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Ahora se permite que una cadena represente el color como el primer parámetro. - Versiones anteriores sólo permitían un objeto ImagickPixel. - - - - - - - - - - - - &reftitle.examples; - - - <function>Imagick::borderImage</function> - - borderImage($color, $width, $height); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/brightnesscontrastimage.xml b/reference/imagick/imagick/brightnesscontrastimage.xml deleted file mode 100644 index 2ca8c371ed..0000000000 --- a/reference/imagick/imagick/brightnesscontrastimage.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - Imagick::brightnessContrastImage - Cambia el brillo y/o el contraste de una imagen - - - - &reftitle.description; - - public boolImagick::brightnessContrastImage - floatbrightness - floatcontrast - intchannelImagick::CHANNEL_DEFAULT - - - Cambia el brillo y/o el contraste de una imagen. Convierte los parámetros de brillo y contraste en pendiente e intercepción y llama a una función polinómica para aplicarla a la imagen. - - - - - &reftitle.parameters; - - - brightness - - - - - - - contrast - - - - - - - channel - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - <function>Imagick::brightnessContrastImage</function> - - brightnessContrastImage($brightness, $contrast, $channel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - diff --git a/reference/imagick/imagick/charcoalimage.xml b/reference/imagick/imagick/charcoalimage.xml deleted file mode 100644 index 768dcf4598..0000000000 --- a/reference/imagick/imagick/charcoalimage.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - Imagick::charcoalImage - Simula un dibujo a carboncillo - - - - &reftitle.description; - - public boolImagick::charcoalImage - floatradius - floatsigma - - - Simula un dibujo a carboncillo. - - - - - &reftitle.parameters; - - - - radius - - - El radio gaussiano, en píxeles, sin contar el píxel central - - - - - sigma - - - La desviación estándar gaussiana, en píxeles - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::charcoalImage</function> - - charcoalImage($radius, $sigma); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/chopimage.xml b/reference/imagick/imagick/chopimage.xml deleted file mode 100644 index 912a8c8b05..0000000000 --- a/reference/imagick/imagick/chopimage.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - Imagick::chopImage - Borra una región de una imagen y la recorta - - - - &reftitle.description; - - public boolImagick::chopImage - intwidth - intheight - intx - inty - - - Borra una región de una imagen y colapsa la imagen para ocupar la porción borrada. - - - - - &reftitle.parameters; - - - - width - - - Ancho del área cortada - - - - - height - - - Alto del área cortada - - - - - x - - - El punto de referencia X del área cortada - - - - - y - - - El punto de referencia Y del área cortada - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Usar <function>Imagick::chopImage</function>: - - Ejemplo de uso de Imagick::chopImage - - -newImage(400, 200, $píxel); - -/* Cortar imagen */ -$imagen->chopImage(200, 200, 0, 0); - -/* Dar un formato a la imagen */ -$imagen->setImageFormat('png'); - -/* Imprimir la imagen con cabeceras */ -header('Content-type: image/png'); -echo $imagen; - -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::cropImage - - - - - - - diff --git a/reference/imagick/imagick/clampimage.xml b/reference/imagick/imagick/clampimage.xml deleted file mode 100644 index b70769ddb6..0000000000 --- a/reference/imagick/imagick/clampimage.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Imagick::clampImage - Restringe el rango de colores de 0 a la profundidad cuántica - - - - &reftitle.description; - - public boolImagick::clampImage - intchannelImagick::CHANNEL_DEFAULT - - - Restringe el rango de colores de 0 a la profundidad cuántica. - - - - - &reftitle.parameters; - - - channel - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/imagick/imagick/clear.xml b/reference/imagick/imagick/clear.xml deleted file mode 100644 index 7ecfe0ba4c..0000000000 --- a/reference/imagick/imagick/clear.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - Imagick::clear - Libera todos los recursos asociados a un objeto Imagick - - - - &reftitle.description; - - public boolImagick::clear - - - - Libera todos los recursos asociados a un objeto Imagick. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/clipimage.xml b/reference/imagick/imagick/clipimage.xml deleted file mode 100644 index c978ceeee6..0000000000 --- a/reference/imagick/imagick/clipimage.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::clipImage - Se alinea con el primer camino de un perfil 8BIM - - - - &reftitle.description; - - public boolImagick::clipImage - - - - Se alinea con el primer camino de un perfil 8BIM, si está presente. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/clipimagepath.xml b/reference/imagick/imagick/clipimagepath.xml deleted file mode 100644 index c6503eb6e5..0000000000 --- a/reference/imagick/imagick/clipimagepath.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - Imagick::clipImagePath - Recorta a lo largo de las rutas nombradas del perfil 8BIM, si está presente - - - - &reftitle.description; - - public voidImagick::clipImagePath - stringpathname - stringinside - - - Recorta a lo largo de las rutas nombradas del perfil 8BIM, si está presente. Las operaciones posteriores surten efecto dentro de la ruta. Id puede ser un número si va precedido de #, para trabajar en una ruta numerada, por ejemplo, "#1" para utilizar la primera ruta. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - pathname - - - - - - - - inside - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/imagick/imagick/clippathimage.xml b/reference/imagick/imagick/clippathimage.xml deleted file mode 100644 index 3f674a5b67..0000000000 --- a/reference/imagick/imagick/clippathimage.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Imagick::clipPathImage - Recorta a lo largo de trazados nominados desde un perfil 8BIM - - - - &reftitle.description; - - public boolImagick::clipPathImage - stringpathname - boolinside - - - Recorta a lo largo de trazados nominados desde un perfil 8BIM, si está - presente. Las operaiones posteriores toman efecto dentro del trazado. - Puede ser un número si está precedido de #, para trabajar con un - trazado numerado, p.ej., "#1" para usar el primer trazado. - - - - - &reftitle.parameters; - - - - pathname - - - El nombre del trazado - - - - - inside - - - Si es &true; las operaciones posteriores toman efecto dentro del patrón de recorte. - De otro modo, las operaciones toman efecto fuera del patrón de recorte. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/clone.xml b/reference/imagick/imagick/clone.xml deleted file mode 100644 index 6915a062d4..0000000000 --- a/reference/imagick/imagick/clone.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - - Imagick::clone - Realiza una copia exacta de un objeto Imagick - - - - &reftitle.description; - - public ImagickImagick::clone - - - - Realiza una copia exacta de un objeto Imagick. - - - - Esta función se ha vuelto OBSOLETA a partir de imagick 3.1.0. - Ahora debe utilizarse la palabra clave - clone. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Una copia del objeto Imagick. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 3.1.0 - - Este método se ha vuelto obsoleto en favor de la palabra clave - clone. - - - - - - - - - - &reftitle.examples; - - - Clonación de objeto Imagick con diferentes versiones de Imagick - - clone(); - -// Clonación de un objeto Imagick a partir de la versión 3.1.0: -$newImage = clone $image; -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/clutimage.xml b/reference/imagick/imagick/clutimage.xml deleted file mode 100644 index ed6a37081b..0000000000 --- a/reference/imagick/imagick/clutimage.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - Imagick::clutImage - Reemplaza los colores de una imagen - - - - &reftitle.description; - - public boolImagick::clutImage - Imagicklookup_table - intchannelImagick::CHANNEL_DEFAULT - - - - Reemplaza los colores en una imagen con una paleta de colores. El segundo parámetro - opcional reemplaza los colores de un canal específico. &imagick.method.available.0x636; - - - - - &reftitle.parameters; - - - - lookup_table - - - Objeto Imagick que contiene la paleta de colores - - - - - channel - - - La constante Channeltype. - Cuando no se proporciona, los canales predeterminados se reemplazan. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Usar <function>Imagick::clutImage</function>: - - Reemplazar los colores de una imagen desde una paleta de colores. - - -newImage(1, 1, new ImagickPixel('black')); -$imagen->clutImage($clut); -$imagen->writeImage('test_out.jpg'); -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::adaptiveBlurImage - Imagick::motionBlurImage - Imagick::radialBlurImage - - - - - - - diff --git a/reference/imagick/imagick/coalesceimages.xml b/reference/imagick/imagick/coalesceimages.xml deleted file mode 100644 index d79167caf9..0000000000 --- a/reference/imagick/imagick/coalesceimages.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - Imagick::coalesceImages - Componer un conjunto de imágenes - - - - &reftitle.description; - - public ImagickImagick::coalesceImages - - - - Componer un conjunto de imágenes respetando todas las posiciones y - los métodos de disposición. Las secuencias de animaciones - GIF, MIFF y MNG, comienzan típicamente con una imagen de fondo, - seguida de todas las imágenes siguientes que varían en tamaño y - posición. Retorna un nuevo objeto Imagick donde cada imagen - de la secuencia tiene el mismo tamaño que la primera, y compuesta - con la siguiente en la secuencia. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retorna un nuevo objeto Imagick en caso de éxito. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/colorfloodfillimage.xml b/reference/imagick/imagick/colorfloodfillimage.xml deleted file mode 100644 index e41e7ab7a8..0000000000 --- a/reference/imagick/imagick/colorfloodfillimage.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - Imagick::colorFloodfillImage - Cambia el valor del color de cualquier píxel que coincida con el objetivo - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::colorFloodfillImage - mixedfill - floatfuzz - mixedbordercolor - intx - inty - - - Cambia el valor del color de cualquier píxel que coincida con el objetivo y esté - en el área inmediata. - - - - - &reftitle.parameters; - - - - fill - - - Objeto ImagickPixel que contiene el color de relleno - - - - - fuzz - - - La cantidad de enfoque. Por ejemplo, establecer el enfoque a 10 y el color a rojo con una - intensidad de 100 y 102 respectivamente ahora se interpreta como el - mismo color para los propósitos del relleno. - - - - - bordercolor - - - Objeto ImagickPixel que contiene el color de borde - - - - - x - - - Posición X del inicio del relleno - - - - - y - - - Posición Y del inicio del relleno - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Ahora se permite que una cadena represente el color como el primer y tercer - parámetros. Versiones anteriores sólo permitían un objeto ImagickPixel. - - - - - - - - - - - diff --git a/reference/imagick/imagick/colorizeimage.xml b/reference/imagick/imagick/colorizeimage.xml deleted file mode 100644 index 672317fe82..0000000000 --- a/reference/imagick/imagick/colorizeimage.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - - Imagick::colorizeImage - Mezcla el color de relleno con la imagen - - - - &reftitle.description; - - public boolImagick::colorizeImage - mixedcolorize - mixedopacity - boollegacy&false; - - - Mezcla el color de relleno de cada píxel con la imagen. - - - - - &reftitle.parameters; - - - - colorize - - - Objeto ImagickPixel o una cadena que contiene el color - - - - - opacity - - - Objeto ImagickPixel o un valor float que contiene el valor de la opacidad. - 1.0 es completamente opaco y 0.0 es completamente transparente. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Ahora se permite que una cadena represente el color como el primer parámetro y - que un valor float represente el valor de la opacidad como el segundo parámetro. - Versiones anteriores sólo permitían objetos ImagickPixel. - - - - - - - - - - - - &reftitle.examples; - - - <function>Imagick::colorizeImage</function> - - colorizeImage($color, $opacityColor); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/colormatriximage.xml b/reference/imagick/imagick/colormatriximage.xml deleted file mode 100644 index cac501fc14..0000000000 --- a/reference/imagick/imagick/colormatriximage.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - Imagick::colorMatrixImage - Aplica una transformación de color a una imagen - - - - &reftitle.description; - - public boolImagick::colorMatrixImage - arraycolor_matrix - - - Aplica una transformación de color a una imagen. El método permite cambios de saturación, rotación de tono, luminancia en alfa y diversos otros efectos. Aunque se pueden utilizar matrices de transformación de tamaño variable, generalmente se usa una matriz 5x5 para una imagen RGBA y una 6x6 para CMYKA (o RGBA con desplazamientos). La matriz es similar a las utilizadas por Adobe Flash, excepto que los desplazamientos están en la columna 6 en lugar de la 5 (para soportar imágenes CMYKA) y los desplazamientos están normalizados (divida el desplazamiento Flash por 255). - - - - - &reftitle.parameters; - - - color_matrix - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - <function>Imagick::colorMatrixImage</function> - - setImageOpacity(1); - - //Una matriz de color debería ser similar a: - // $colorMatrix = [ - // 1.5, 0.0, 0.0, 0.0, 0.0, -0.157, - // 0.0, 1.0, 0.5, 0.0, 0.0, -0.157, - // 0.0, 0.0, 1.5, 0.0, 0.0, -0.157, - // 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, - // 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, - // 0.0, 0.0, 0.0, 0.0, 0.0, 1.0 - // ]; - - $background = new \Imagick(); - $background->newPseudoImage($imagick->getImageWidth(), $imagick->getImageHeight(), "pattern:checkerboard"); - - $background->setImageFormat('png'); - - $imagick->setImageFormat('png'); - $imagick->colorMatrixImage($colorMatrix); - - $background->compositeImage($imagick, \Imagick::COMPOSITE_ATOP, 0, 0); - - header("Content-Type: image/png"); - echo $background->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/combineimages.xml b/reference/imagick/imagick/combineimages.xml deleted file mode 100644 index 85ec1a95e5..0000000000 --- a/reference/imagick/imagick/combineimages.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Imagick::combineImages - Combina una o más imágenes en una sóla imagen - - - - &reftitle.description; - - public ImagickImagick::combineImages - intchannelType - - - Combina una o más imágenes en una sóla imagen. El valor de la - escala de grises de los píxeles de cada imagen en la secuencia se asigna - para especificar los canales de la imagen combinada. El orden - típico sería imagen 1 => Red, 2 => Green, - 3 => Blue, etc. - - - - - &reftitle.parameters; - - - - channelType - - - Proporcione cualquier constante de canal que sea válida para su modo de canal. Para - aplicar más de un canal, combine las constantes channeltype usando - operadores a nivel de bits. Consulte esta - lista de constantes de canal. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/commentimage.xml b/reference/imagick/imagick/commentimage.xml deleted file mode 100644 index 7d39827775..0000000000 --- a/reference/imagick/imagick/commentimage.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Imagick::commentImage - Añade un comentario a la imagen - - - - &reftitle.description; - - public boolImagick::commentImage - stringcomment - - - Añade un comentario a la imagen. - - - - - &reftitle.parameters; - - - - comment - - - El comentario a añadir - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Usar <function>Imagick::commentImage</function>: - - Comentar una imagen y recuperar el comentario: - - -newImage(100, 100, new ImagickPixel("red")); - -/* Añadir el comentario a la imagen */ -$im->commentImage("¡Hola Mundo!"); - -/* Mostrar el comentario */ -echo $im->getImageProperty("comment"); - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/compareimagechannels.xml b/reference/imagick/imagick/compareimagechannels.xml deleted file mode 100644 index aca9b261bc..0000000000 --- a/reference/imagick/imagick/compareimagechannels.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - Imagick::compareImageChannels - Devuelve la diferencia entre una o más imágenes - - - - &reftitle.description; - - public arrayImagick::compareImageChannels - Imagickimage - intchannelType - intmetricType - - - Compara una o más imágenes y devuelve la imagen de diferencia. - - - - - &reftitle.parameters; - - - - image - - - Un objeto Imagick que contiene la imagen a comparar. - - - - - channelType - - - Proporcione cualquier constante de canal que sea válida para el modo de canal. Para - aplicar más de un canal, combine las constantes channeltype usando - operadores a nivel de bits. Consulte esta lista de - constantes de canal. - - - - - metricType - - - Una de las constantes de tipos de métrica. - - - - - - - - - &reftitle.returnvalues; - - Array que consiste en new_wand y - distortion. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/compareimagelayers.xml b/reference/imagick/imagick/compareimagelayers.xml deleted file mode 100644 index b914cb2949..0000000000 --- a/reference/imagick/imagick/compareimagelayers.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - Imagick::compareImageLayers - Devuelve la región circundante máxima entre imágenes - - - - &reftitle.description; - - public ImagickImagick::compareImageLayers - intmethod - - - - Compara cada imagen con la siguiente en una secuencia y devuelve la - región circundante máxima de cualesquiera deferencias de píxeles que se descubra. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - method - - - Una de las constantes de método de capas. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Usar <function>Imagick::compareImageLayers</function> - - Comparar las capas de la imagen - - -compareImageLayers(imagick::LAYERMETHOD_COALESCE); - -/* trabajar sobre el $resultado */ -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::optimizeImageLayers - Imagick::writeImages - Imagick::writeImage - - - - - - - diff --git a/reference/imagick/imagick/compareimages.xml b/reference/imagick/imagick/compareimages.xml deleted file mode 100644 index 259c033671..0000000000 --- a/reference/imagick/imagick/compareimages.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - Imagick::compareImages - Compara una imagen con otra reconstruida - - - - &reftitle.description; - - public arrayImagick::compareImages - Imagickcompare - intmetric - - - Devuelve un array que contiene una imagen reconstruida y las diferencias entre las imágenes. - - - - - &reftitle.parameters; - - - - compare - - - Una imagen a comparar. - - - - - metric - - - Proporcione una constante de tipo de métrica válida. Consulte esta lista de - constantes métricas. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un array que contiene una imagen reconstruida y las diferencias entre imágenes. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Uso de <function>Imagick::compareImages</function>: - - Comparar imágenes y mostrar la imagen reconstruida - - -compareImages($imagen1, Imagick::METRIC_MEANSQUAREERROR); -$resultado[0]->setImageFormat("png"); - -header("Content-Type: image/png"); -echo $resultado[0]; - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/compositeimage.xml b/reference/imagick/imagick/compositeimage.xml deleted file mode 100644 index dd0ae75ce2..0000000000 --- a/reference/imagick/imagick/compositeimage.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - - Imagick::compositeImage - Compone una imagen en otra - - - - &reftitle.description; - - public boolImagick::compositeImage - Imagickcomposite_object - intcomposite - intx - inty - intchannelImagick::CHANNEL_DEFAULT - - - Compone una imagen en otra en el índice especificado. Debería proporcionarse cualquier argumento necesario para el algoritmo de composición a setImageArtifact con 'compose:args' como el primer parámetro y los datos como el segundo. - - - - - &reftitle.parameters; - - - - composite_object - - - Objeto Imagick que guarda la imagen compuesta - - - - - compose - - - Operador de composición. Véase Constantes de Operadores - de Composición - - - - - x - - - El índice de la columna de la imagen compuesta - - - - - y - - - El índice de la fila de la imagen compuesta - - - - - channel - - - Proporcione cualquier constante de canal que sea válida para su modo de canal. Para - aplicar más de un canal, combine las constantes channeltype usando - operadores a nivel de bits. Consulte esta lista de - constantes de canal. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - &reftitle.examples; - - - Empleo de <function>Imagick::compositeImage</function>: - - Componer dos imágenes con el método de composición 'mathematics' - - -setImageVirtualPixelMethod(Imagick::VIRTUALPIXELMETHOD_TRANSPARENT); -$src1->setImageArtifact('compose:args', "1,0,-0.5,0.5"); -$src1->compositeImage($src2, Imagick::COMPOSITE_MATHEMATICS, 0, 0); -$src1->writeImage("./output.png"); - -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::setImageArtifact - - - - - - - diff --git a/reference/imagick/imagick/construct.xml b/reference/imagick/imagick/construct.xml deleted file mode 100644 index 488f2b512f..0000000000 --- a/reference/imagick/imagick/construct.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - Imagick::__construct - El constructor Imagick - - - - &reftitle.description; - - public Imagick::__construct - mixedfiles - - - Crea una instancia Imagick para una imagen específica o para un - conjunto de imágenes. - - - - - &reftitle.parameters; - - - files - - - La ruta hasta la imagen a cargar, o un array de rutas. - Pueden incluir comodines en los nombres de los ficheros, o - pueden ser URLs. - - - - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - diff --git a/reference/imagick/imagick/contrastimage.xml b/reference/imagick/imagick/contrastimage.xml deleted file mode 100644 index 58601f4b25..0000000000 --- a/reference/imagick/imagick/contrastimage.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - Imagick::contrastImage - Cambia el contraste de una imagen - - - - &reftitle.description; - - public boolImagick::contrastImage - boolsharpen - - - Mejora la diferencias de intensidad entre elementos claros y - oscuros de la imagen. Establezca la agudización a un valor que no - sea 0 para aumentar el contraste de la imagen, de otro modo el contraste - se reduce. - - - - - &reftitle.parameters; - - - - sharpen - - - El valor de la agudización - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::contrastImage</function> - - contrastImage($contrastType); - } - - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/contraststretchimage.xml b/reference/imagick/imagick/contraststretchimage.xml deleted file mode 100644 index b844d5a4dc..0000000000 --- a/reference/imagick/imagick/contraststretchimage.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Imagick::contrastStretchImage - Mejora el contraste de una imagen en color - - - - &reftitle.description; - - public boolImagick::contrastStretchImage - floatblack_point - floatwhite_point - intchannelImagick::CHANNEL_DEFAULT - - - - Mejora el contraste de una imagen en color ajustando los colores de los - píxeles de color para abarcar el rango completo de los colores disponibles. &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - black_point - - - El punto blanco. - - - - - white_point - - - El punto negro. - - - - - channel - - - Proporcione cualquier constante de canal que sea válida para su modo de canal. Para - aplicar más de un canal, combine las constantes channeltype usando - operadores a nivel de bits. Imagick::CHANNEL_ALL. Consulte esta - lista de constantes de canal. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/convolveimage.xml b/reference/imagick/imagick/convolveimage.xml deleted file mode 100644 index 2b77bba5de..0000000000 --- a/reference/imagick/imagick/convolveimage.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - Imagick::convolveImage - Aplica una semilla de convolución a medida a la imagen - - - - &reftitle.description; - - public boolImagick::convolveImage - arraykernel - intchannelImagick::CHANNEL_DEFAULT - - - Aplica una semilla de convolución a medida a la imagen. - - - - - &reftitle.parameters; - - - - kernel - - - La semilla de convolución - - - - - channel - - - Proporcione cualquier constante de canal que sea válida para su modo de canal. Para - aplicar más de un canal, combine las constantes channeltype usando - operadores a nivel de bits. Consulte esta lista de - constantes de canal. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::convolveImage</function> - - setImageBias($bias * \Imagick::getQuantum()); - $imagick->convolveImage($kernelMatrix); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/count.xml b/reference/imagick/imagick/count.xml deleted file mode 100644 index 663693be5a..0000000000 --- a/reference/imagick/imagick/count.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - Imagick::count - Devuelve el número de imágenes - - - - &reftitle.description; - - public intImagick::count - intmode0 - - - Devuelve el número de imágenes. - - - - - &reftitle.parameters; - - - mode - - - Un argumento no utilizado. Actualmente, existe una funcionalidad no particularmente bien definida en PHP donde la llamada a count() sobre un objeto contable podría (o no) requerir que este método acepte un parámetro. Este parámetro está aquí para ser conforme a la interfaz de countable, incluso si el parámetro no es utilizado. - - - - - - - - &reftitle.returnvalues; - - Devuelve el número de imágenes. - - - - - diff --git a/reference/imagick/imagick/cropimage.xml b/reference/imagick/imagick/cropimage.xml deleted file mode 100644 index f91ac13ea3..0000000000 --- a/reference/imagick/imagick/cropimage.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - - Imagick::cropImage - Extrae una región de la imagen - - - - &reftitle.description; - - public boolImagick::cropImage - intwidth - intheight - intx - inty - - - Extrae una región de la imagen. - - - - - &reftitle.parameters; - - - - width - - - El ancho del recorte - - - - - height - - - El alto del recorte - - - - - x - - - La coordenada X de la esquina superior izquierda de la región recortada - - - - - y - - - La coordenada Y de la esquina superior izquierda de la región recortada - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::cropImage</function> - - cropImage($width, $height, $startX, $startY); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/cropthumbnailimage.xml b/reference/imagick/imagick/cropthumbnailimage.xml deleted file mode 100644 index 384bdf3574..0000000000 --- a/reference/imagick/imagick/cropthumbnailimage.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - Imagick::cropThumbnailImage - Crea una miniatura recortada - - - - &reftitle.description; - - public boolImagick::cropThumbnailImage - intwidth - intheight - boollegacy&false; - - - Crea una miniatura de tamaño fijo ampliando o reduciendo de escala la imagen y recortando - un área específica desde el centro. - - - - - &reftitle.parameters; - - - - width - - - El ancho de la miniatura - - - - - height - - - El alto de la miniatura - - - - - legacy - - - El parámetro legacy fue añadido en PECL imagick 3.4.0. - Consulte el registro de cambios para más información. - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL imagick 3.4.0 - Se añadió el parámetro legacy. - - - - - - - - - diff --git a/reference/imagick/imagick/current.xml b/reference/imagick/imagick/current.xml deleted file mode 100644 index fd073f8056..0000000000 --- a/reference/imagick/imagick/current.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - Imagick::current - Devuelve una referencia al objeto Imagick actual - - - - &reftitle.description; - - public ImagickImagick::current - - - - Devuelve una referencia al objeto actual, a partir de una - referencia de secuencia. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve self en caso de éxito. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/cyclecolormapimage.xml b/reference/imagick/imagick/cyclecolormapimage.xml deleted file mode 100644 index 8baf7604ae..0000000000 --- a/reference/imagick/imagick/cyclecolormapimage.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Imagick::cycleColormapImage - Desplaza el mapa de colores de una imagen - - - - &reftitle.description; - - public boolImagick::cycleColormapImage - intdisplace - - - Desplaza el mapa de colores de una imagen por el número de posiciones dados. Si se - realiza un ciclo del mapa de colores varias veces se puede obtener un efecto - psicodélico. - - - - - &reftitle.parameters; - - - - displace - - - La cantidad de desplazamiento del mapa de colores. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/decipherimage.xml b/reference/imagick/imagick/decipherimage.xml deleted file mode 100644 index f397d54489..0000000000 --- a/reference/imagick/imagick/decipherimage.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - Imagick::decipherImage - Descifra una imagen - - - - &reftitle.description; - - public boolImagick::decipherImage - stringpassphrase - - - - Descifra una imagen que ha sido cifrada anteriormente. La iamgen debe ser cifrada - usando Imagick::encipherImage. - &imagick.method.available.0x639; - - - - - &reftitle.parameters; - - - - passphrase - - - La frase de contraseña - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.seealso; - - - Imagick::encipherImage - - - - - - - diff --git a/reference/imagick/imagick/deconstructimages.xml b/reference/imagick/imagick/deconstructimages.xml deleted file mode 100644 index 4767bcd396..0000000000 --- a/reference/imagick/imagick/deconstructimages.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - Imagick::deconstructImages - Devuelve las diferencias de ciertos píxeles entre dos imágenes - - - - &reftitle.description; - - public ImagickImagick::deconstructImages - - - - Compara cada imagen con la siguiente en la secuencia, y devuelve - la región máxima de encuadre de los píxeles diferentes que descubre. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un nuevo objeto Imagick en caso de éxito. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/deleteimageartifact.xml b/reference/imagick/imagick/deleteimageartifact.xml deleted file mode 100644 index a84095612b..0000000000 --- a/reference/imagick/imagick/deleteimageartifact.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - Imagick::deleteImageArtifact - Borra un artefacto de imagen - - - - &reftitle.description; - - public boolImagick::deleteImageArtifact - stringartifact - - - Borra un artefacto asociado con la imagen. La diferencia entre las propiedades de imagen y - los artefactos de imagen es que las propiedades son públicas y los artefactos son privados. - &imagick.method.available.0x657; - - - - - &reftitle.parameters; - - - - artifact - - - El nombre del artefacto a borrar. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.seealso; - - - Imagick::setImageArtifact - Imagick::getImageArtifact - - - - - - - diff --git a/reference/imagick/imagick/deleteimageproperty.xml b/reference/imagick/imagick/deleteimageproperty.xml deleted file mode 100644 index 21397b4e84..0000000000 --- a/reference/imagick/imagick/deleteimageproperty.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - Imagick::deleteImageProperty - Elimina una propiedad de imagen - - - - &reftitle.description; - - public boolImagick::deleteImageProperty - stringname - - - Elimina una propiedad de imagen. - - - - - &reftitle.parameters; - - - name - - - El nombre de la propiedad a eliminar. - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - diff --git a/reference/imagick/imagick/deskewimage.xml b/reference/imagick/imagick/deskewimage.xml deleted file mode 100644 index fabdaaeaa0..0000000000 --- a/reference/imagick/imagick/deskewimage.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - - Imagick::deskewImage - Elimina la torción de la imagen - - - - &reftitle.description; - - public boolImagick::deskewImage - floatthreshold - - - Eeste método se puede usar para eliminar la torción de, por ejemplo, imágenes escaneadas donde - el papel no estaba debidamente colocado en la superfice del escáner. &imagick.method.available.0x645; - - - - - &reftitle.parameters; - - - - threshold - - - Umbral de detorción - - - - - - - - - &reftitle.returnvalues; - - - - - - - - &reftitle.examples; - - - <function>Imagick::deskewImage</function> - -deskewImage($threshold); - - //El resto de este ejemplo es para hacer el resultado obvio, ya que - //de lo contrario no sería obvio. - $trim = 9; - - $deskewImagick->cropImage($deskewImagick->getImageWidth() - $trim, $deskewImagick->getImageHeight(), $trim, 0); - $imagick->cropImage($imagick->getImageWidth() - $trim, $imagick->getImageHeight(), $trim, 0); - $deskewImagick->resizeimage($deskewImagick->getImageWidth() / 2, $deskewImagick->getImageHeight() / 2, \Imagick::FILTER_LANCZOS, 1); - $imagick->resizeimage($imagick->getImageWidth() / 2, $imagick->getImageHeight() / 2, \Imagick::FILTER_LANCZOS, 1); - $newCanvas = new \Imagick(); - $newCanvas->newimage($imagick->getImageWidth() + $deskewImagick->getImageWidth() + 20, $imagick->getImageHeight(), 'red', 'jpg'); - $newCanvas->compositeimage($imagick, \Imagick::COMPOSITE_COPY, 5, 0); - $newCanvas->compositeimage($deskewImagick, \Imagick::COMPOSITE_COPY, $imagick->getImageWidth() + 10, 0); - - header("Content-Type: image/jpg"); - echo $newCanvas->getImageBlob(); -} - -?> -]]> - - - - - - - diff --git a/reference/imagick/imagick/despeckleimage.xml b/reference/imagick/imagick/despeckleimage.xml deleted file mode 100644 index 8a817133f8..0000000000 --- a/reference/imagick/imagick/despeckleimage.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - - Imagick::despeckleImage - Reduce el ruido speckle de una imagen - - - - &reftitle.description; - - public boolImagick::despeckleImage - - - - Reduce el ruido speckle de una imagen, preservando los bordes - de la imagen original. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Ejemplo con <function>Imagick::despeckleImage</function> - -despeckleImage(); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/destroy.xml b/reference/imagick/imagick/destroy.xml deleted file mode 100644 index a985fd11bf..0000000000 --- a/reference/imagick/imagick/destroy.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - Imagick::destroy - Destruye un objeto Imagick - - - - &reftitle.description; - - public boolImagick::destroy - - - - Destruye el objeto Imagick y libera todos los recursos asociados. - Este método está deprecado, en favor del método - Imagick::clear. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/displayimage.xml b/reference/imagick/imagick/displayimage.xml deleted file mode 100644 index baa20c2f5e..0000000000 --- a/reference/imagick/imagick/displayimage.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - Imagick::displayImage - Muestra una imagen - - - - &reftitle.description; - - public boolImagick::displayImage - stringservername - - - Este método muestra una imagen en un servidor X. - - - - - &reftitle.parameters; - - - - servername - - - El nombre del servidor X - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/displayimages.xml b/reference/imagick/imagick/displayimages.xml deleted file mode 100644 index cfc8d8af5a..0000000000 --- a/reference/imagick/imagick/displayimages.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - Imagick::displayImages - Muestra una imagen o una secuencia de imágenes - - - - &reftitle.description; - - public boolImagick::displayImages - stringservername - - - Muestra una imagen o una secuencia de imágenes en un servidor X. - - - - - &reftitle.parameters; - - - - servername - - - El nombre del servidor X - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/distortimage.xml b/reference/imagick/imagick/distortimage.xml deleted file mode 100644 index 09814fd255..0000000000 --- a/reference/imagick/imagick/distortimage.xml +++ /dev/null @@ -1,172 +0,0 @@ - - - - - Imagick::distortImage - Deforma una imagen utilizando varios métodos de distorsión - - - - &reftitle.description; - - public boolImagick::distortImage - intmethod - arrayarguments - boolbestfit - - - Deforma una imagen utilizando varios métodos de distorsión, mapeando la paleta - de colores de la imagen de origen a una nueva imagen destino normalmente del mismo - tamaño que la imagen de origen, a menos que 'bestfit' esté establecido a &true;. - - - Si 'bestfit' está habilitado, y la distorsión lo permite, la imagen destino - se ajusta para asegurarse de que la 'imagen' de origen entera se ajustará dentro de - la imagen destino final, la cuál será redimensionada e compensada acordemente. También, - en la mayoría de los casos el índice virtual de la imagen de origen será tomado en cuenta - en el mapeado. - - - &imagick.method.available.0x636; - - - - - &reftitle.parameters; - - - - method - - - El método de distorsión de la imagen. Véase constantes de distorsión - - - - - arguments - - - Los argumentos para este método de distorsión - - - - - bestfit - - - Intenta redimensionar la imagen destino para ajustarse a la imagen de origen deformada - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Usar <function>Imagick::distortImage</function>: - - Deformar una imagen y mostrarla en el navegador. - - -newPseudoImage(100, 100, "pattern:checkerboard"); - -/* Establecer el formato de la imagen a png */ -$im->setImageFormat('png'); - -/* Rellenar las nuevas áreas visibles con transparente */ -$im->setImageVirtualPixelMethod(Imagick::VIRTUALPIXELMETHOD_TRANSPARENT); - -/* Activar el mate */ -$im->setImageMatte(true); - -/* Puntos de control para la distorsión */ -$puntosControl = array( 10, 10, - 10, 5, - - 10, $im->getImageHeight() - 20, - 10, $im->getImageHeight() - 5, - - $im->getImageWidth() - 10, 10, - $im->getImageWidth() - 10, 20, - - $im->getImageWidth() - 10, $im->getImageHeight() - 10, - $im->getImageWidth() - 10, $im->getImageHeight() - 30); - -/* Realizar la distorsión */ -$im->distortImage(Imagick::DISTORTION_PERSPECTIVE, $puntosControl, true); - -/* Imprimir la imagen */ -header("Content-Type: image/png"); -echo $im; -?> -]]> - - &example.outputs.similar; - - Salida del ejemplo : Using Imagick::distortImage() - - - - - - - - - - &reftitle.seealso; - - - Imagick::blurImage - Imagick::motionBlurImage - Imagick::radialBlurImage - - - - - - - diff --git a/reference/imagick/imagick/drawimage.xml b/reference/imagick/imagick/drawimage.xml deleted file mode 100644 index ee2d25dad3..0000000000 --- a/reference/imagick/imagick/drawimage.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Imagick::drawImage - Renderiza el objeto ImagickDraw a la imagen actual - - - - &reftitle.description; - - public boolImagick::drawImage - ImagickDrawdraw - - - Renderiza el objeto ImagickDraw a la imagen actual. - - - - - &reftitle.parameters; - - - - draw - - - Las operaciones de dibujo para renderizar a la imagen. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/edgeimage.xml b/reference/imagick/imagick/edgeimage.xml deleted file mode 100644 index 043eae1712..0000000000 --- a/reference/imagick/imagick/edgeimage.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - Imagick::edgeImage - Mejora los bordes de la imagen - - - - &reftitle.description; - - public boolImagick::edgeImage - floatradius - - - Mejora los bordes de la imagen con un filtro de convolución del radio - dado. Use un radio de 0 y éste será autoseleccionado. - - - - - &reftitle.parameters; - - - - radius - - - El radio de la operación. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::edgeImage</function> - - edgeImage($radius); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/embossimage.xml b/reference/imagick/imagick/embossimage.xml deleted file mode 100644 index 5b67e20340..0000000000 --- a/reference/imagick/imagick/embossimage.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - Imagick::embossImage - Devuelve una imagen en escala de grises con un efecto tridimensional - - - - &reftitle.description; - - public boolImagick::embossImage - floatradius - floatsigma - - - Devuelve una imagen en escala de grises con un efecto tridimensional. Se convoluciona - la imagen con un operador gaussiano del radio y desviación estándar (sigma) dados. - Para obtener resultados razonables, el radio debería ser mayor que - sigma. Use un radio de 0 y se elegirá un radio apropiado automáticamente. - - - - - &reftitle.parameters; - - - - radius - - - El radio de el efecto - - - - - sigma - - - El valor sigma del efecto - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::embossImage</function> - - embossImage($radius, $sigma); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/encipherimage.xml b/reference/imagick/imagick/encipherimage.xml deleted file mode 100644 index 4f72f3e429..0000000000 --- a/reference/imagick/imagick/encipherimage.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - Imagick::encipherImage - Cifra una imagen - - - - &reftitle.description; - - public boolImagick::encipherImage - stringpassphrase - - - - Covierte los píxeles planos en píxeles cifrados. La imagen no es legible - hasta que haya sido descifrada usando Imagick::decipherImage - &imagick.method.available.0x639; - - - - - &reftitle.parameters; - - - - passphrase - - - La frase de contraseña - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.seealso; - - - Imagick::decipherImage - - - - - - - diff --git a/reference/imagick/imagick/enhanceimage.xml b/reference/imagick/imagick/enhanceimage.xml deleted file mode 100644 index 0e8af0970f..0000000000 --- a/reference/imagick/imagick/enhanceimage.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - - Imagick::enhanceImage - Mejora la calidad de una imagen ruidosa - - - - &reftitle.description; - - public boolImagick::enhanceImage - - - - Mejora la calidad de una imagen ruidosa con un filtro - digital. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Ejemplo con <function>Imagick::enhanceImage</function> - -enhanceImage(); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/equalizeimage.xml b/reference/imagick/imagick/equalizeimage.xml deleted file mode 100644 index ce3a03d90b..0000000000 --- a/reference/imagick/imagick/equalizeimage.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - Imagick::equalizeImage - Iguala el histograma de una imagen - - - - &reftitle.description; - - public boolImagick::equalizeImage - - - - Iguala el histograma de una imagen. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Ejemplo con <function>Imagick::equalizeImage</function> - -equalizeImage(); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/evaluateimage.xml b/reference/imagick/imagick/evaluateimage.xml deleted file mode 100644 index bae8b55de2..0000000000 --- a/reference/imagick/imagick/evaluateimage.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - Imagick::evaluateImage - Aplica una expresión a una imagen - - - - &reftitle.description; - - public boolImagick::evaluateImage - intop - floatconstant - intchannelImagick::CHANNEL_DEFAULT - - - Aplica una expresión aritmética, relacional o lógica a una imagen. - Utilice estos operadores para aclarar u oscurecer una imagen, para - aumentar o reducir el contraste, o para producir una imagen invertida. - - - - - &reftitle.parameters; - - - - op - - - El operador de evaluación - - - - - constant - - - El valor del operador - - - - - channel - - - Proporciona una constante de canal válida para su modo de canal. - Para utilizar más de un canal, combine las constantes de tipo - de canal utilizando los operadores a nivel de bits. Consulte la lista de - constantes de canal. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Ejemplo con <function>Imagick::evaluateImage</function> - - Uso de evaluateImage para reducir la opacidad - de una imagen. - - -evaluateImage(Imagick::EVALUATE_DIVIDE, 2, Imagick::CHANNEL_ALPHA); - -// Mostrar la imagen -header("Content-Type: image/png"); -echo $im; -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/exportimagepixels.xml b/reference/imagick/imagick/exportimagepixels.xml deleted file mode 100644 index 8b422ad030..0000000000 --- a/reference/imagick/imagick/exportimagepixels.xml +++ /dev/null @@ -1,185 +0,0 @@ - - - - - - - - Imagick::exportImagePixels - Exporta los píxeles brutos de la imagen - - - - &reftitle.description; - - public arrayImagick::exportImagePixels - intx - inty - intwidth - intheight - stringmap - intSTORAGE - - - Exporta los píxeles de la imagen a un array. El mapa define el orden de exportación - de los píxeles. El tamaño del array devuelto corresponde a - width * height * strlen(map). - &imagick.method.available.0x647; - - - - - &reftitle.parameters; - - - - x - - - Coordenada en X del espacio exportado. - - - - - y - - - Coordenada en Y del espacio exportado. - - - - - width - - - Ancho del espacio exportado. - - - - - height - - - Alto del espacio exportado. - - - - - map - - - Orden de los píxeles exportados. Por ejemplo, "RGB". - Los caracteres válidos para el mapa son R, G, B, A, O, C, Y, M, K, I y P. - - - - - STORAGE - - - Consulte la lista de - constantes de tipo pixel - - - - - - - - - &reftitle.returnvalues; - - Devuelve un array que contiene los valores de los píxeles. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Ejemplo con <function>Imagick::exportImagePixels</function> - - Exportación de los píxeles de la imagen a un array. - - -newPseudoImage(0, 0, "magick:rose"); - -/* Exporta los píxeles de la imagen */ -$pixels = $im->exportImagePixels(10, 10, 2, 2, "RGB", Imagick::PIXEL_CHAR); - -/* Visualización */ -var_dump($pixels); -?> -]]> - - &example.outputs; - - - int(72) - [1]=> - int(64) - [2]=> - int(57) - [3]=> - int(69) - [4]=> - int(59) - [5]=> - int(43) - [6]=> - int(124) - [7]=> - int(120) - [8]=> - int(-96) - [9]=> - int(91) - [10]=> - int(84) - [11]=> - int(111) -} -]]> - - - - - - - - diff --git a/reference/imagick/imagick/extentimage.xml b/reference/imagick/imagick/extentimage.xml deleted file mode 100644 index 99c43f9249..0000000000 --- a/reference/imagick/imagick/extentimage.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - Imagick::extentImage - Establecer el tamaño de la imagen - - - - &reftitle.description; - - public boolImagick::extentImage - intwidth - intheight - intx - inty - - - - Método cómodo para establecer el tamaño de una imagen. El método establece el tamaño de la imagen y - permite ajustar las coordenadas x,y donde comienza el nuevo área. - &imagick.method.available.0x631; - - - - - Antes de ImageMagick 6.5.7-8 (1623), $x era positivo cuando se desplazaba hacia la izquierda y negativo cuando se desplazaba hacia la derecha, e $y era positivo cuando se desplazaba una imagen hacia arriba y negativo cuando se desplazaba hacia abajo. - - Entre ImageMagick 6.3.7 (1591) e ImageMagick 6.5.7-8 (1623), los ejes de $x e $y se voltearon, por lo que $x era negativo cuando se desplazaba hacia la izquierda y positivo cuando se desplazaba hacia la derecha, e $y era negativo cuando se desplazaba una imagen hacia arriba y positivo cuando se desplazaba hacia abajo. - - Entre ImageMagick 6.5.7-8 (1623) e ImageMagick 6.6.9-7 (1641), los ejes de $x e $y se volvieron a voltear a la funcionalidad anterior de ImageMagick 6.5.7-8 (1623). - - - - - - - &reftitle.parameters; - - - - width - - - El nuevo ancho - - - - - height - - - El nuevo alto - - - - - x - - - Posición X para el nuevo tamaño - - - - - y - - - Posición Y para el nuevo tamaño - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.seealso; - - - Imagick::resizeImage - Imagick::thumbnailImage - Imagick::cropImage - - - - - - - diff --git a/reference/imagick/imagick/filter.xml b/reference/imagick/imagick/filter.xml deleted file mode 100644 index 4b6a54bbdd..0000000000 --- a/reference/imagick/imagick/filter.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - Imagick::filter - Aplica un núcleo de convolución personalizado a la imagen - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::filter - ImagickKernelImagickKernel - intchannelImagick::CHANNEL_UNDEFINED - - - Aplica un núcleo de convolución personalizado a la imagen. - - - - - &reftitle.parameters; - - - ImagickKernel - - - Una instancia de ImagickKernel que representa un solo núcleo o una serie de núcleos vinculados. - - - - - channel - - - &imagick.parameter.channel; - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - <function>Imagick::filter</function> - - scale($strength, \Imagick::NORMALIZE_KERNEL_VALUE); - $kernel->addUnityKernel(1 - $strength); - - $imagick->filter($kernel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - diff --git a/reference/imagick/imagick/flattenimages.xml b/reference/imagick/imagick/flattenimages.xml deleted file mode 100644 index 4989eec926..0000000000 --- a/reference/imagick/imagick/flattenimages.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - Imagick::flattenImages - Fusiona una secuencia de imágenes - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public ImagickImagick::flattenImages - - - - Fusiona una secuencia de imágenes. Esto es práctico para combinar - una serie de capas de Photoshop en una sola imagen. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/flipimage.xml b/reference/imagick/imagick/flipimage.xml deleted file mode 100644 index 043a733f2b..0000000000 --- a/reference/imagick/imagick/flipimage.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - - Imagick::flipImage - Crea una imagen por espejo vertical - - - - &reftitle.description; - - public boolImagick::flipImage - - - - Crea una imagen por espejo vertical, utilizando una simetría alrededor del eje de las abscisas. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Ejemplo con <function>Imagick::flipImage</function> - -flipImage(); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - &reftitle.seealso; - - Imagick::flopimage - - - - - - diff --git a/reference/imagick/imagick/floodfillpaintimage.xml b/reference/imagick/imagick/floodfillpaintimage.xml deleted file mode 100644 index 6fbf5c9cdd..0000000000 --- a/reference/imagick/imagick/floodfillpaintimage.xml +++ /dev/null @@ -1,177 +0,0 @@ - - - - - - Imagick::floodFillPaintImage - Cambia el valor del color de cualquier píxel que coincida con el objetivo - - - - &reftitle.description; - - public boolImagick::floodFillPaintImage - mixedfill - floatfuzz - mixedtarget - intx - inty - boolinvert - intchannelImagick::CHANNEL_DEFAULT - - - - Cambia el valor del color de cualquier píxel que coincida con el objetivo y esté - en el área inmediata. Este método es un sustituto del método obsoleto - Imagick::paintFloodFillImage. - &imagick.method.available.0x638; - - - - - &reftitle.parameters; - - - - fill - - - Objeto ImagickPixel o una cadena que contiene el color de relleno - - - - - fuzz - - - &imagick.parameter.fuzz; - - - - - target - - - Objeto ImagickPixel o una cadena que contiene el color objetivo a dibujar - - - - - x - - - Posición X del inicio del relleno - - - - - y - - - Posición Y del inicio del relleno - - - - - invert - - - Si es &true; se pinta cualquier píxel que no coincida con el color objetivo. - - - - - channel - - - &imagick.parameter.channel; - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Ejemplo de <methodname>Imagick::floodfillPaintImage</methodname> - -newImage(100, 50, "red"); -$im->newImage(100, 50, "green"); -$im->newImage(100, 50, "blue"); - -/* Añadir las imágenes para que sean una */ -$im->resetIterator(); -$combinado = $im->appendImages(true); - -/* Guardar la imagen intermedia para la comparación */ -$combinado->writeImage("floodfillpaint_intermedia.png"); - -/* El píxel objetivo a pintar */ -$x = 1; -$y = 1; - -/* Obtener el color con el que vamos a pintar */ -$objetivo = $combinado->getImagePixelColor($x, $y); - -/* Pinta el píxel en la posición 1,1 negro y todos los píxeles - cercanos que coincidan con el color objetivo */ -$combinado->floodfillPaintImage("black", 1, $objetivo, $x, $y, false); - -/* Guardar el resultado */ -$combinado->writeImage("floodfillpaint_resultado.png"); -?> -]]> - - &example.outputs.similar; - - Salida del ejemplo : Imagick::floodfillPaintImage() - - - - - - - - - - - - - - diff --git a/reference/imagick/imagick/flopimage.xml b/reference/imagick/imagick/flopimage.xml deleted file mode 100644 index b3f106dc67..0000000000 --- a/reference/imagick/imagick/flopimage.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - - Imagick::flopImage - Crea una imagen por espejo horizontal - - - - &reftitle.description; - - public boolImagick::flopImage - - - - Crea una imagen por espejo horizontal, utilizando una simetría alrededor del eje de las ordenadas. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Ejemplo con <function>Imagick::flopImage</function> - -flopImage(); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - &reftitle.seealso; - - Imagick::flipimage - - - - - - diff --git a/reference/imagick/imagick/forwardfouriertransformimage.xml b/reference/imagick/imagick/forwardfouriertransformimage.xml deleted file mode 100644 index e3981faa5b..0000000000 --- a/reference/imagick/imagick/forwardfouriertransformimage.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - Imagick::forwardFourierTransformImage - Implementa la transformada discreta de Fourier (Discrete Fourier Transform - DFT) - - - - &reftitle.description; - - public boolImagick::forwardFourierTransformimage - boolmagnitude - - - Implementa la transformada discreta de Fourier (DFT) de la imagen ya sea como un par de imágenes magnitud/fase o como un par de imágenes reales/imaginarias. - - - - - &reftitle.parameters; - - - magnitude - - - Si es verdadero, devuelve como un par magnitud/fase, de lo contrario un par de imágenes reales/imaginarias. - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - <function>Imagick::forwardFourierTransformImage</function> - - setStrokeOpacity(0); - $draw->setStrokeColor('rgb(255, 255, 255)'); - $draw->setFillColor('rgb(255, 255, 255)'); - - // Dibuja un círculo en el eje y, con su centro - // en x, y que toca el origen - $draw->circle(250, 250, 220, 250); - - $imagick = new \Imagick(); - $imagick->newImage(512, 512, "black"); - $imagick->drawImage($draw); - $imagick->gaussianBlurImage(20, 20); - $imagick->autoLevelImage(); - - return $imagick; -} - -function forwardFourierTransformImage($imagePath) { - $imagick = new \Imagick(realpath($imagePath)); - $imagick->resizeimage(512, 512, \Imagick::FILTER_LANCZOS, 1); - - $mask = createMask(); - $imagick->forwardFourierTransformImage(true); - - @$imagick->setimageindex(0); - $magnitude = $imagick->getimage(); - - @$imagick->setimageindex(1); - $imagickPhase = $imagick->getimage(); - - if (true) { - $imagickPhase->compositeImage($mask, \Imagick::COMPOSITE_MULTIPLY, 0, 0); - } - - if (false) { - $output = clone $imagickPhase; - $output->setimageformat('png'); - header("Content-Type: image/png"); - echo $output->getImageBlob(); - } - - $magnitude->inverseFourierTransformImage($imagickPhase, true); - - $magnitude->setimageformat('png'); - header("Content-Type: image/png"); - echo $magnitude->getImageBlob(); -} - -?> -]]> - - - - - - - diff --git a/reference/imagick/imagick/frameimage.xml b/reference/imagick/imagick/frameimage.xml deleted file mode 100644 index c05d9c5667..0000000000 --- a/reference/imagick/imagick/frameimage.xml +++ /dev/null @@ -1,172 +0,0 @@ - - - - - - - Imagick::frameImage - Añade un borde tridimensional simulado - - - - &reftitle.description; - - public boolImagick::frameImage - mixedmatte_color - intwidth - intheight - intinner_bevel - intouter_bevel - - - Añade un borde tridimensional simulado alrededor de la imagen. - El ancho y alto especifican el ancho del borde de las caras verticales y - horizontales del marco. Los biseles interior y exterior - indican el ancho de las sombras interiores y exteriores del - marco. - - - - - &reftitle.parameters; - - - - matte_color - - - Objeto ImagickPixel o una cadena que representa el color mate - - - - - width - - - El ancho del borde - - - - - height - - - El alto del borde - - - - - inner_bevel - - - El ancho del bisel interior - - - - - outer_bevel - - - El ancho del bisel exterior - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Ahora se permite que una cadena represente el color como el primer parámetro. - Versiones anteriores sólo permitían un objeto ImagickPixel. - - - - - - - - - - - - &reftitle.examples; - - - <function>Imagick::frameImage</function> - - frameimage( - $color, - $width, - $height, - $innerBevel, - $outerBevel - ); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/functionimage.xml b/reference/imagick/imagick/functionimage.xml deleted file mode 100644 index 7f02dbd4db..0000000000 --- a/reference/imagick/imagick/functionimage.xml +++ /dev/null @@ -1,181 +0,0 @@ - - - - - - - - Imagick::functionImage - Aplica una función sobre la imagen - - - - &reftitle.description; - - public boolImagick::functionImage - intfunction - arrayarguments - intchannelImagick::CHANNEL_DEFAULT - - - Aplica una expresión aritmética, relacional o lógica a una pseudo-imagen. - - - Consulte también los ejemplos - de ImageMagick v6 - Transformaciones de imágenes — Función, evaluación de varios argumentos. - - - &imagick.method.available.0x649; - - - - - &reftitle.parameters; - - - - function - - - Consulte la lista de constantes de función. - - - - - arguments - - - Array de argumentos a pasar a la función. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Crea un gradiente sinusoidal - -newPseudoImage(200, 200, 'gradient:black-white'); -$arguments = array(3, -90); -$imagick->functionImage(Imagick::FUNCTION_SINUSOID, $arguments); - -header("Content-Type: image/png"); -$imagick->setImageFormat("png"); -echo $imagick->getImageBlob(); -?> -]]> - - &example.outputs.similar; - - Resultado de la creación de un gradiente sinusoidal - - - - - - - - Crea un gradiente desde el polinomio (4x^2 - 4x + 1) - -newPseudoImage(200, 200, 'gradient:black-white'); -$arguments = array(4, -4, 1); -$imagick->functionImage(Imagick::FUNCTION_POLYNOMIAL, $arguments); - -header("Content-Type: image/png"); -$imagick->setimageformat("png"); -echo $imagick->getImageBlob(); -?> -]]> - - &example.outputs.similar; - - Resultado de la creación de un gradiente a partir de un polinomio - - - - - - - - - Crea un gradiente complejo desde el - polinomio (4x^2 - 4x^2 + 1) modulado por un gradiente sinusoidal - - -newPseudoImage(200, 200, 'gradient:black-white'); -$arguments = array(9, -90); -$imagick1->functionImage(Imagick::FUNCTION_SINUSOID, $arguments); - -$imagick2 = new Imagick(); -$imagick2->newPseudoImage(200, 200, 'gradient:black-white'); -$arguments = array(0.5, 0); -$imagick2->functionImage(Imagick::FUNCTION_SINUSOID, $arguments); -$imagick1->compositeimage($imagick2, Imagick::COMPOSITE_MULTIPLY, 0, 0); - -header("Content-Type: image/png"); -$imagick1->setImageFormat("png"); -echo $imagick1->getImageBlob(); -?> -]]> - - &example.outputs.similar; - - Resultado de la creación de un gradiente complejo - - - - - - - - - - - - diff --git a/reference/imagick/imagick/fximage.xml b/reference/imagick/imagick/fximage.xml deleted file mode 100644 index 61c435fcec..0000000000 --- a/reference/imagick/imagick/fximage.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - Imagick::fxImage - Evalúa una expresión por cada píxel de la imagen - - - - &reftitle.description; - - public ImagickImagick::fxImage - stringexpression - intchannelImagick::CHANNEL_DEFAULT - - - Evalúa una expresión por cada píxel de la imagen. Consulte El Operador de Imagen de Efectos Especiales - Fx para más información. - - - - - &reftitle.parameters; - - - - expression - - - La expresión. - - - - - channel - - - Proporcione cualquier constante de canal que sea válida para su modo de canal. Para - aplicar más de un canal, combine las constantes channeltype usando - operadores a nivel de bits. Consulte esta lista de - constantes de canal. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::fxImage</function> - - newPseudoImage(200, 200, "xc:white"); - - $fx = 'xx=i-w/2; yy=j-h/2; rr=hypot(xx,yy); (.5-rr/140)*1.2+.5'; - $fxImage = $imagick->fxImage($fx); - - header("Content-Type: image/png"); - $fxImage->setimageformat('png'); - echo $fxImage->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/gammaimage.xml b/reference/imagick/imagick/gammaimage.xml deleted file mode 100644 index 8a8af61b59..0000000000 --- a/reference/imagick/imagick/gammaimage.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - Imagick::gammaImage - Corrección gamma de una imagen - - - - &reftitle.description; - - public boolImagick::gammaImage - floatgamma - intchannelImagick::CHANNEL_DEFAULT - - - Corrección gamma de una imagen. La misma imagen vista en diferentes dispositivos tendrá - diferencias perceptuales en la manera en que la intensidad de la imagen esté representada - en la pantalla. Especifique niveles gamma indivuduales para los canales rojo, - verde y azul, o ajústelos todos con el parámetro gamma. - El rango de valores es típicamente desde 0.8 a 2.3. - - - - - &reftitle.parameters; - - - - gamma - - - La cantidad de corrección gamma. - - - - - channel - - - Proporcione cualquier constante de canal que sea válida para su modo de canal. Para - aplicar más de un canal, combine las constantes channeltype usando - operadores a nivel de bits. Consulte esta lista de - constantes de canal. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::gammaImage</function> - - gammaImage($gamma, $channel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/gaussianblurimage.xml b/reference/imagick/imagick/gaussianblurimage.xml deleted file mode 100644 index 286e84d752..0000000000 --- a/reference/imagick/imagick/gaussianblurimage.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - - Imagick::gaussianBlurImage - Hace borrosa una imagen - - - - &reftitle.description; - - public boolImagick::gaussianBlurImage - floatradius - floatsigma - intchannelImagick::CHANNEL_DEFAULT - - - Hace borrosa una imagen. Se convoluciona la imagen con un operador gaussiano del - radio y la desviación estándar (sigma) dados. Para obtener resultados razonables, el - radio debería ser mayor que sigma. Use un radio de 0 y se seleccionará un - radio adecuado automáticamente. - - - - - &reftitle.parameters; - - - - radius - - - El radio gaussiano, en píxeles, sin contar el píxel central. - - - - - sigma - - - La desviación estándar gaussiana, en píxeles. - - - - - channel - - - Proporcione cualquier constante de canal que sea válida para su modo de canal. Para - aplicar más de un canal, combine las constantes channeltype usando - operadores a nivel de bits. Consulte esta lista de - constantes de canal. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::gaussianBlurImage</function> - - gaussianBlurImage($radius, $sigma, $channel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/getcolorspace.xml b/reference/imagick/imagick/getcolorspace.xml deleted file mode 100644 index 5f4add30c8..0000000000 --- a/reference/imagick/imagick/getcolorspace.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - Imagick::getColorspace - Obtiene el espacio de colores - - - - &reftitle.description; - - public intImagick::getColorspace - - - - Obtiene el valor global del espacio de colores. - &imagick.method.available.0x657; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un entero que puede ser comparado con las - constantes COLORSPACE. - - - - - - diff --git a/reference/imagick/imagick/getcompression.xml b/reference/imagick/imagick/getcompression.xml deleted file mode 100644 index 981639fdf1..0000000000 --- a/reference/imagick/imagick/getcompression.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - Imagick::getCompression - Lee el tipo de compresión - - - - &reftitle.description; - - public intImagick::getCompression - - - - Lee el tipo de compresión. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la constante de compresión. - - - - - - diff --git a/reference/imagick/imagick/getcompressionquality.xml b/reference/imagick/imagick/getcompressionquality.xml deleted file mode 100644 index 2fe783704b..0000000000 --- a/reference/imagick/imagick/getcompressionquality.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - Imagick::getCompressionQuality - Lee la calidad de la compresión - - - - &reftitle.description; - - public intImagick::getCompressionQuality - - - - Lee la calidad de la compresión. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un integer que describe la calidad de la compresión. - - - - - - diff --git a/reference/imagick/imagick/getcopyright.xml b/reference/imagick/imagick/getcopyright.xml deleted file mode 100644 index 4b86a95782..0000000000 --- a/reference/imagick/imagick/getcopyright.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - Imagick::getCopyright - Devuelve el copyright de la API ImageMagick - - - - &reftitle.description; - - public static stringImagick::getCopyright - - - - Devuelve el copyright de la API ImageMagick. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un string, en caso de éxito. - - - - - - diff --git a/reference/imagick/imagick/getfilename.xml b/reference/imagick/imagick/getfilename.xml deleted file mode 100644 index 94b1d65116..0000000000 --- a/reference/imagick/imagick/getfilename.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getFilename - Lee el nombre del fichero asociado a una secuencia - - - - &reftitle.description; - - public stringImagick::getFilename - - - - Lee el nombre del fichero asociado a una secuencia. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una cadena en caso de éxito. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getfont.xml b/reference/imagick/imagick/getfont.xml deleted file mode 100644 index 12de6d7afa..0000000000 --- a/reference/imagick/imagick/getfont.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - Imagick::getFont - Obtiene la fuente de caracteres - - - - &reftitle.description; - - public stringImagick::getFont - - - - Devuelve la propiedad de la fuente de caracteres del objeto. - &imagick.method.available.0x637; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un &string; que contiene el nombre de la fuente de caracteres - o &false; si la fuente no está definida. - - - - - &reftitle.seealso; - - - Imagick::setFont - ImagickDraw::setFont - ImagickDraw::getFont - - - - - - - diff --git a/reference/imagick/imagick/getformat.xml b/reference/imagick/imagick/getformat.xml deleted file mode 100644 index b7f6f73b35..0000000000 --- a/reference/imagick/imagick/getformat.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getFormat - Devuelve el formato de la imagen Imagick - - - - &reftitle.description; - - public stringImagick::getFormat - - - - Devuelve el formato de la imagen Imagick. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el formato de la imagen Imagick. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getgravity.xml b/reference/imagick/imagick/getgravity.xml deleted file mode 100644 index cd2696e850..0000000000 --- a/reference/imagick/imagick/getgravity.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - Imagick::getGravity - Obtiene la gravedad - - - - &reftitle.description; - - public intImagick::getGravity - - - - - Obtiene la propiedad global de gravedad para el objeto - Imagick. - &imagick.method.available.0x640; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la propiedad de gravedad. Consúltese la lista de - constantes de gravedad. - - - - - - diff --git a/reference/imagick/imagick/gethomeurl.xml b/reference/imagick/imagick/gethomeurl.xml deleted file mode 100644 index 259a426ce8..0000000000 --- a/reference/imagick/imagick/gethomeurl.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - Imagick::getHomeURL - Devuelve la URL de ImageMagick - - - - &reftitle.description; - - public static stringImagick::getHomeURL - - - - Devuelve la URL de ImageMagick. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la URL de ImageMagick. - - - - - - diff --git a/reference/imagick/imagick/getimage.xml b/reference/imagick/imagick/getimage.xml deleted file mode 100644 index 12fe1eb40d..0000000000 --- a/reference/imagick/imagick/getimage.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getImage - Devuelve un nuevo objeto Imagick - - - - &reftitle.description; - - public ImagickImagick::getImage - - - - Devuelve un nuevo objeto Imagick. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un nuevo objeto Imagick. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagealphachannel.xml b/reference/imagick/imagick/getimagealphachannel.xml deleted file mode 100644 index 3f7ed71ede..0000000000 --- a/reference/imagick/imagick/getimagealphachannel.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - - Imagick::getImageAlphaChannel - Verifica si la imagen tiene un canal alfa - - - - &reftitle.description; - - public boolImagick::getImageAlphaChannel - - - - - Devuelve si la imagen tiene un canal alfa. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si la imagen tiene un valor de canal alfa y &false; en caso contrario, - es decir, que la imagen es RGB en lugar de RGBA o CMYK en lugar de CMYKA. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL imagick 3.6.0 - - Ahora devuelve un &boolean; ; anteriormente se devolvía un &integer;. - - - - - - - - - diff --git a/reference/imagick/imagick/getimageartifact.xml b/reference/imagick/imagick/getimageartifact.xml deleted file mode 100644 index 7d5951c588..0000000000 --- a/reference/imagick/imagick/getimageartifact.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Imagick::getImageArtifact - Obtener el artefacto de imagen - - - - &reftitle.description; - - public stringImagick::getImageArtifact - stringartifact - - - Obtiene un artefacto asociado con la imagen. La diferencia entre las propiedades de imagen y - los artefactos de imagen es que las propiedades son públicas y los artefactos son privados. - &imagick.method.available.0x657; - - - - - &reftitle.parameters; - - - - artifact - - - El nombre del artefacto - - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor del artefacto si se tuvo éxito. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.seealso; - - - Imagick::setImageArtifact - Imagick::deleteImageArtifact - - - - - - - diff --git a/reference/imagick/imagick/getimageattribute.xml b/reference/imagick/imagick/getimageattribute.xml deleted file mode 100644 index dd066c4684..0000000000 --- a/reference/imagick/imagick/getimageattribute.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Imagick::getImageAttribute - Obtiene un atributo nombrado - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public stringImagick::getImageAttribute - stringkey - - - Obtiene un atributo nombrado. - - - - - &reftitle.parameters; - - - key - - - La clave del atributo a obtener. - - - - - - - - &reftitle.returnvalues; - - - - - - diff --git a/reference/imagick/imagick/getimagebackgroundcolor.xml b/reference/imagick/imagick/getimagebackgroundcolor.xml deleted file mode 100644 index 7c5ddde870..0000000000 --- a/reference/imagick/imagick/getimagebackgroundcolor.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getImageBackgroundColor - Devuelve el color de fondo - - - - &reftitle.description; - - public ImagickPixelImagick::getImageBackgroundColor - - - - Devuelve el color de fondo. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el color de fondo en forma de objeto ImagickPixel. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimageblob.xml b/reference/imagick/imagick/getimageblob.xml deleted file mode 100644 index caa1082733..0000000000 --- a/reference/imagick/imagick/getimageblob.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - Imagick::getImageBlob - Devuelve la secuencia de imágenes como un blob - - - - &reftitle.description; - - public stringImagick::getImageBlob - - - - Implementa un formato directo en memoria. Devuelve la - secuencia de imágenes en forma de string. El formato de la imagen - determina el formato del BLOB devuelto (GIF, JPEG, PNG, etc.). - Para devolver un formato diferente, utilice la función - Imagick::setImageFormat. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un string que contiene las imágenes. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimageblueprimary.xml b/reference/imagick/imagick/getimageblueprimary.xml deleted file mode 100644 index 1d181db412..0000000000 --- a/reference/imagick/imagick/getimageblueprimary.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - Imagick::getImageBluePrimary - Devuelve el punto primario azul de la cromaticidad - - - - &reftitle.description; - - public arrayImagick::getImageBluePrimary - - - - Devuelve el punto primario azul de la cromaticidad de una imagen. - - - - - &reftitle.parameters; - - - - x - - - El punto x primario azul de la cromaticidad. - - - - - y - - - El punto y primario azul de la cromaticidad. - - - - - - - - - &reftitle.returnvalues; - - Matriz consistente en las coordenadas "x" e "y" del punto. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagebordercolor.xml b/reference/imagick/imagick/getimagebordercolor.xml deleted file mode 100644 index 7feb2fc8e0..0000000000 --- a/reference/imagick/imagick/getimagebordercolor.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getImageBorderColor - Devuelve el color del borde de la imagen - - - - &reftitle.description; - - public ImagickPixelImagick::getImageBorderColor - - - - Devuelve el color del borde de la imagen. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagechanneldepth.xml b/reference/imagick/imagick/getimagechanneldepth.xml deleted file mode 100644 index 64ce336950..0000000000 --- a/reference/imagick/imagick/getimagechanneldepth.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - Imagick::getImageChannelDepth - Obtiene la profundidad de un canal de imagen en particular - - - - &reftitle.description; - - public intImagick::getImageChannelDepth - intchannel - - - - Obtiene la profundidad de un canal de imagen en particular. - - - - - &reftitle.parameters; - - - - channel - - - &imagick.parameter.channel; - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/getimagechanneldistortion.xml b/reference/imagick/imagick/getimagechanneldistortion.xml deleted file mode 100644 index b300b82fd9..0000000000 --- a/reference/imagick/imagick/getimagechanneldistortion.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Imagick::getImageChannelDistortion - Compara los canales de imagen de una imagen con una imagen reconstruida - - - - &reftitle.description; - - public floatImagick::getImageChannelDistortion - Imagickreference - intchannel - intmetric - - - Compara uno o más canales de imagen de una imagen con una imagen reconstruida - y devuelve la métrica de distorsión especificada. - - - - - &reftitle.parameters; - - - - reference - - - Objeto Imagick que se va a comparar. - - - - - channel - - - Proporcione cualquier constante de canal que sea válida para su modo de canal. Para - aplicar más de un canal, combine las constantes channeltype usando - operadores a nivel de bits. Consulte esta lista de - constantes de canal. - - - - - metric - - - Una de las constantes de tipo de métrica. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagechanneldistortions.xml b/reference/imagick/imagick/getimagechanneldistortions.xml deleted file mode 100644 index 84da16d53f..0000000000 --- a/reference/imagick/imagick/getimagechanneldistortions.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - Imagick::getImageChannelDistortions - Obtiene las distorsiones de un canal - - - - &reftitle.description; - - public floatImagick::getImageChannelDistortions - Imagickreference - intmetric - intchannelImagick::CHANNEL_DEFAULT - - - - Compara uno o varios canales de una imagen con una imagen reconstruida, y devuelve - las medidas de la distorsión especificada. - &imagick.method.available.0x644; - - - - - &reftitle.parameters; - - - - reference - - - Objeto Imagick que contiene la referencia de la imagen. - - - - - metric - - - Consúltese la lista de - constantes de tipo de medidas. - - - - - channel - - - &imagick.parameter.channel; - - - - - - - - - &reftitle.returnvalues; - - Devuelve un float, que describe la distorsión del canal. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagechannelextrema.xml b/reference/imagick/imagick/getimagechannelextrema.xml deleted file mode 100644 index 2594bd7f30..0000000000 --- a/reference/imagick/imagick/getimagechannelextrema.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - Imagick::getImageChannelExtrema - Obtiene los extremos de uno o más canales de imagen - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public arrayImagick::getImageChannelExtrema - intchannel - - - Obtiene los extremos (mínimo y máximo) de uno o más canales de imagen. El valor devuelto es una - matriz asociativa con las claves "minima" (mínimo) y "maxima" (máximo). - - - - - &reftitle.parameters; - - - - channel - - - Proporcione cualquier constante de canal que sea válida para su modo de canal. Para - aplicar más de un canal, combine las constantes channeltype usando - operadores a nivel de bits. Consulte esta lista de - constantes de canal. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagechannelkurtosis.xml b/reference/imagick/imagick/getimagechannelkurtosis.xml deleted file mode 100644 index 1d642b607a..0000000000 --- a/reference/imagick/imagick/getimagechannelkurtosis.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - Imagick::getImageChannelKurtosis - Obtiene la curtosis y la asimetría estadística de un canal específico - - - - &reftitle.description; - - public arrayImagick::getImageChannelKurtosis - intchannelImagick::CHANNEL_DEFAULT - - - Obtiene la curtosis y la asimetría estadística de un canal específico. &imagick.method.available.0x649; - - - - - &reftitle.parameters; - - - - channel - - - &imagick.parameter.channel; - - - - - - - - - &reftitle.returnvalues; - - Devuelve una matriz con los miembros kurtosis (curtosis) - y skewness (asimetría estadística). - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - diff --git a/reference/imagick/imagick/getimagechannelmean.xml b/reference/imagick/imagick/getimagechannelmean.xml deleted file mode 100644 index 091a68142a..0000000000 --- a/reference/imagick/imagick/getimagechannelmean.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - Imagick::getImageChannelMean - Obtiene la media y la desviación estándar - - - - &reftitle.description; - - public arrayImagick::getImageChannelMean - intchannel - - - Obtiene la media y la desviación estándar de uno o más canales de imagen. - - - - - &reftitle.parameters; - - - - channel - - - Proporcione cualquier constante de canal que sea válida para su modo de canal. Para - aplicar más de un canal, combine las constantes channeltype usando - operadores a nivel de bits. Consulte esta lista de - constantes de canal. - - - - - - - - - &reftitle.returnvalues; - - Devuelve una matriz con miembros "mean" y "standardDeviation". - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagechannelrange.xml b/reference/imagick/imagick/getimagechannelrange.xml deleted file mode 100644 index 2dc0b78c76..0000000000 --- a/reference/imagick/imagick/getimagechannelrange.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Imagick::getImageChannelRange - Obtiene el rango del canal - - - - &reftitle.description; - - public arrayImagick::getImageChannelRange - intchannel - - - - Obtiene el rango de uno o más canales de imagen. - &imagick.method.available.0x640; - - - - - &reftitle.parameters; - - - - channel - - - &imagick.parameter.channel; - - - - - - - - - &reftitle.returnvalues; - - Devuelve una matriz que contiene los valores mínimo y máximo de el/los canal/es. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagechannelstatistics.xml b/reference/imagick/imagick/getimagechannelstatistics.xml deleted file mode 100644 index f0592fe7b4..0000000000 --- a/reference/imagick/imagick/getimagechannelstatistics.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - Imagick::getImageChannelStatistics - Devuelve estadísticas sobre cada canal de la imagen - - - - &reftitle.description; - - public arrayImagick::getImageChannelStatistics - - - - Devuelve estadísticas sobre cada canal de la imagen. Las estadísticas - incluyen la profundidad del canal, sus mínimos y máximos, la media, - y la desviación estándar. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/getimageclipmask.xml b/reference/imagick/imagick/getimageclipmask.xml deleted file mode 100644 index a6a8485f7f..0000000000 --- a/reference/imagick/imagick/getimageclipmask.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - Imagick::getImageClipMask - Obtiene la máscara de recorte de la imagen - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public ImagickImagick::getImageClipMask - - - - - Devuelve la máscara de recorte de la imagen. La máscara de recorte es un objeto - Imagick que contiene la máscara de recorte. - &imagick.method.available.0x636; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un objeto Imagick que contiene la máscara de recorte. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagecolormapcolor.xml b/reference/imagick/imagick/getimagecolormapcolor.xml deleted file mode 100644 index fcdb1aebf3..0000000000 --- a/reference/imagick/imagick/getimagecolormapcolor.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - Imagick::getImageColormapColor - Devuelve el color del índice del mapa de colores especficado - - - - &reftitle.description; - - public ImagickPixelImagick::getImageColormapColor - intindex - - - Devuelve el color del índice del mapa de colores especficado. - - - - - &reftitle.parameters; - - - - index - - - El índice en el mapa de colores de la imagen. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagecolors.xml b/reference/imagick/imagick/getimagecolors.xml deleted file mode 100644 index 3dbcacbf09..0000000000 --- a/reference/imagick/imagick/getimagecolors.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - Imagick::getImageColors - Lee el número de colores únicos de la imagen - - - - &reftitle.description; - - public intImagick::getImageColors - - - - Lee el número de colores únicos de la imagen. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un int, el número de colores únicos en la imagen. - - - - - - diff --git a/reference/imagick/imagick/getimagecolorspace.xml b/reference/imagick/imagick/getimagecolorspace.xml deleted file mode 100644 index 6bf9b69832..0000000000 --- a/reference/imagick/imagick/getimagecolorspace.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - Imagick::getImageColorspace - Obtiene el espacio de colores de la imagen - - - - &reftitle.description; - - public intImagick::getImageColorspace - - - - Obtiene el espacio de colores de la imagen. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un entero que puede ser comparado con las - constantes COLORSPACE. - - - - - - diff --git a/reference/imagick/imagick/getimagecompose.xml b/reference/imagick/imagick/getimagecompose.xml deleted file mode 100644 index 18ef8815ee..0000000000 --- a/reference/imagick/imagick/getimagecompose.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - Imagick::getImageCompose - Devuelve el operador de composición asociado a una imagen - - - - &reftitle.description; - - public intImagick::getImageCompose - - - - Devuelve el operador de composición asociado a una imagen. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/getimagecompression.xml b/reference/imagick/imagick/getimagecompression.xml deleted file mode 100644 index 5ea1629824..0000000000 --- a/reference/imagick/imagick/getimagecompression.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - Imagick::getImageCompression - Lee el tipo de compresión de la imagen - - - - &reftitle.description; - - public intImagick::getImageCompression - - - - - Lee el tipo de compresión de la imagen. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una constante de compresión. - - - - - - diff --git a/reference/imagick/imagick/getimagecompressionquality.xml b/reference/imagick/imagick/getimagecompressionquality.xml deleted file mode 100644 index 3bc8ec2799..0000000000 --- a/reference/imagick/imagick/getimagecompressionquality.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - Imagick::getImageCompressionQuality - Lee la calidad de compresión de la imagen - - - - &reftitle.description; - - public intImagick::getImageCompressionQuality - - - - - Lee la calidad de compresión de la imagen. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un entero que describe la calidad de la compresión de la imagen. - - - - - - diff --git a/reference/imagick/imagick/getimagedelay.xml b/reference/imagick/imagick/getimagedelay.xml deleted file mode 100644 index 393da100c7..0000000000 --- a/reference/imagick/imagick/getimagedelay.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - Imagick::getImageDelay - Lee el retraso de la imagen - - - - &reftitle.description; - - public intImagick::getImageDelay - - - - Lee el retraso de la imagen. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el retraso de la imagen. - &imagick.imagickexception.throw; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagedepth.xml b/reference/imagick/imagick/getimagedepth.xml deleted file mode 100644 index c9a8259584..0000000000 --- a/reference/imagick/imagick/getimagedepth.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - Imagick::getImageDepth - Se lee la profundidad de la imagen - - - - &reftitle.description; - - public intImagick::getImageDepth - - - - Se lee la profundidad de la imagen. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La profundidad de la imagen. - - - - - - diff --git a/reference/imagick/imagick/getimagedispose.xml b/reference/imagick/imagick/getimagedispose.xml deleted file mode 100644 index d30d3f38ee..0000000000 --- a/reference/imagick/imagick/getimagedispose.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getImageDispose - Lee el método de recuperación - - - - &reftitle.description; - - public intImagick::getImageDispose - - - - Lee el método de recuperación. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el método de recuperación en caso de éxito. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagedistortion.xml b/reference/imagick/imagick/getimagedistortion.xml deleted file mode 100644 index a8892cdc87..0000000000 --- a/reference/imagick/imagick/getimagedistortion.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Imagick::getImageDistortion - Compara una imagen con una imagen reconstruida - - - - &reftitle.description; - - public floatImagick::getImageDistortion - MagickWandreference - intmetric - - - Compara una imagen con una imagen reconstruida y devuelve la métrica de distorisión - especificada. - - - - - &reftitle.parameters; - - - - reference - - - Objeto Imagick que se va a comparar. - - - - - metric - - - Una de las constantes de tipo de métrica. - - - - - - - - - &reftitle.returnvalues; - - Devuelve la métrica de distorsión usada en la imagen (o la mejor deducción - de la misma). - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimageextrema.xml b/reference/imagick/imagick/getimageextrema.xml deleted file mode 100644 index 264a40f365..0000000000 --- a/reference/imagick/imagick/getimageextrema.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - Imagick::getImageExtrema - Lee los extremos de una imagen - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public arrayImagick::getImageExtrema - - - - Lee los extremos de una imagen. Devuelve - un array asociativo, con las claves - "min" y "max". - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un array asociativo, con las claves "min" y "max". - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagefilename.xml b/reference/imagick/imagick/getimagefilename.xml deleted file mode 100644 index bd16d2462d..0000000000 --- a/reference/imagick/imagick/getimagefilename.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getImageFilename - Devuelve el nombre de un fichero para una imagen en una secuencia - - - - &reftitle.description; - - public stringImagick::getImageFilename - - - - Devuelve el nombre de un fichero para una imagen en una secuencia. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un string con el nombre del fichero de la imagen. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimageformat.xml b/reference/imagick/imagick/getimageformat.xml deleted file mode 100644 index eaf5c416f0..0000000000 --- a/reference/imagick/imagick/getimageformat.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getImageFormat - Devuelve el formato de una imagen en una secuencia - - - - &reftitle.description; - - public stringImagick::getImageFormat - - - - Devuelve el formato de una imagen en una secuencia. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el formato de una imagen en una secuencia. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagegamma.xml b/reference/imagick/imagick/getimagegamma.xml deleted file mode 100644 index fc65f017a6..0000000000 --- a/reference/imagick/imagick/getimagegamma.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getImageGamma - Obtiene el gamma de la imagen - - - - &reftitle.description; - - public floatImagick::getImageGamma - - - - Obtiene el gamma de la imagen. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el gamma de la imagen en caso de éxito. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagegeometry.xml b/reference/imagick/imagick/getimagegeometry.xml deleted file mode 100644 index 106e1cfe5c..0000000000 --- a/reference/imagick/imagick/getimagegeometry.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - Imagick::getImageGeometry - Lee las dimensiones de la imagen en un array - - - - &reftitle.description; - - public arrayImagick::getImageGeometry - - - - Devuelve el ancho y la altura de la imagen en forma de array asociativo. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un &array; con las dimensiones de la imagen. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Uso de <function>Imagick::getImageGeometry</function> - -newImage(100, 200, "black"); -print_r($imagick->getImageGeometry()); -?> -]]> - - &example.outputs; - - 100 - [height] => 200 -) -]]> - - - - - - - - diff --git a/reference/imagick/imagick/getimagegravity.xml b/reference/imagick/imagick/getimagegravity.xml deleted file mode 100644 index 3aaa83b847..0000000000 --- a/reference/imagick/imagick/getimagegravity.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - - Imagick::getImageGravity - Obtiene la gravedad de la imagen - - - - &reftitle.description; - - public intImagick::getImageGravity - - - - - Obtiene el valor de la gravedad actual de la imagen. - A diferencia del método Imagick::getGravity, - este método devuelve la gravedad definida para la secuencia actual - de la imagen. - &imagick.method.available.0x644; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la propiedad de gravedad de la imagen. Consúltese la lista de - constantes de gravedad. - - - - - - diff --git a/reference/imagick/imagick/getimagegreenprimary.xml b/reference/imagick/imagick/getimagegreenprimary.xml deleted file mode 100644 index 220b791f30..0000000000 --- a/reference/imagick/imagick/getimagegreenprimary.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - Imagick::getImageGreenPrimary - Devuelve la cromaticidad del color verde - - - - &reftitle.description; - - public arrayImagick::getImageGreenPrimary - - - - Devuelve la cromaticidad del color verde. - Devuelve un array con las claves "x" y "y". - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un array con las claves "x" y "y" en caso de éxito. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimageheight.xml b/reference/imagick/imagick/getimageheight.xml deleted file mode 100644 index 571da6bf60..0000000000 --- a/reference/imagick/imagick/getimageheight.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getImageHeight - Devuelve la altura de la imagen - - - - &reftitle.description; - - public intImagick::getImageHeight - - - - Devuelve la altura de la imagen. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la altura de la imagen en píxeles. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagehistogram.xml b/reference/imagick/imagick/getimagehistogram.xml deleted file mode 100644 index 3762118d6f..0000000000 --- a/reference/imagick/imagick/getimagehistogram.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - - - Imagick::getImageHistogram - Devuelve el histograma de la imagen - - - - &reftitle.description; - - public arrayImagick::getImageHistogram - - - - Devuelve el histograma de la imagen, en forma de un - array de objetos ImagickPixel. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un array de objetos ImagickPixel. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Ejemplo con <function>Imagick::getImageHistogram</function> - -getColorValue($colorChannel); - $color = intval($color * 255); - $count = $histogramElement->getColorCount(); - - if (array_key_exists($color, $colorStatistics)) { - $colorStatistics[$color] += $count; - } - else { - $colorStatistics[$color] = $count; - } - } - - ksort($colorStatistics); - - return $colorStatistics; -} - -function getImageHistogram($imagePath) { - - $backgroundColor = 'black'; - - $draw = new \ImagickDraw(); - $draw->setStrokeWidth(0); // hace las líneas lo más finas posible - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - $histogramWidth = 256; - $histogramHeight = 100; // la altura de cada segmento RGB - - $imagick = new \Imagick(realpath($imagePath)); - //Redimensionar la imagen para que sea pequeña, de lo contrario PHP tiende a quedarse sin memoria - //Esto podría llevar a resultados incorrectos para imágenes que son patológicamente 'pixeladas' - $imagick->adaptiveResizeImage(200, 200, true); - $histogramElements = $imagick->getImageHistogram(); - - $histogram = new \Imagick(); - $histogram->newpseudoimage($histogramWidth, $histogramHeight * 3, 'xc:black'); - $histogram->setImageFormat('png'); - - $getMax = function ($carry, $item) { - if ($item > $carry) { - return $item; - } - return $carry; - }; - - $colorValues = [ - 'red' => getColorStatistics($histogramElements, \Imagick::COLOR_RED), - 'lime' => getColorStatistics($histogramElements, \Imagick::COLOR_GREEN), - 'blue' => getColorStatistics($histogramElements, \Imagick::COLOR_BLUE), - ]; - - $max = array_reduce($colorValues['red'] , $getMax, 0); - $max = array_reduce($colorValues['lime'] , $getMax, $max); - $max = array_reduce($colorValues['blue'] , $getMax, $max); - - $scale = $histogramHeight / $max; - - $count = 0; - foreach ($colorValues as $color => $values) { - $draw->setstrokecolor($color); - - $offset = ($count + 1) * $histogramHeight; - - foreach ($values as $index => $value) { - $draw->line($index, $offset, $index, $offset - ($value * $scale)); - } - $count++; - } - - $histogram->drawImage($draw); - - header( "Content-Type: image/png" ); - echo $histogram; -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/getimageindex.xml b/reference/imagick/imagick/getimageindex.xml deleted file mode 100644 index a5f318adf0..0000000000 --- a/reference/imagick/imagick/getimageindex.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - Imagick::getImageIndex - Obtiene el índice de la imagen actual - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public intImagick::getImageIndex - - - - Devuelve el índice de la imagen actual en la secuencia Imagick. - Este método está obsoleto. - Consúltese la función Imagick::getIteratorIndex. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un integer en caso de éxito. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimageinterlacescheme.xml b/reference/imagick/imagick/getimageinterlacescheme.xml deleted file mode 100644 index 5c6018d9b5..0000000000 --- a/reference/imagick/imagick/getimageinterlacescheme.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - Imagick::getImageInterlaceScheme - Se lee el esquema de entrelazado de la imagen - - - - &reftitle.description; - - public intImagick::getImageInterlaceScheme - - - - Se lee el esquema de entrelazado de la imagen. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Se devuelve el esquema de entrelazado de la imagen en caso de éxito. - &imagick.imagickexception.throw; - - - - - - diff --git a/reference/imagick/imagick/getimageinterpolatemethod.xml b/reference/imagick/imagick/getimageinterpolatemethod.xml deleted file mode 100644 index 3afc3bfc5d..0000000000 --- a/reference/imagick/imagick/getimageinterpolatemethod.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - Imagick::getImageInterpolateMethod - Devuelve el método de interpolación - - - - &reftitle.description; - - public intImagick::getImageInterpolateMethod - - - - Devuelve el método de interpolación de la imagen especificada. - El método es una de las constantes Imagick::INTERPOLATE_*. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el método de interpolación en caso de éxito. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimageiterations.xml b/reference/imagick/imagick/getimageiterations.xml deleted file mode 100644 index 29beeead10..0000000000 --- a/reference/imagick/imagick/getimageiterations.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getImageIterations - Obtiene las iteraciones de la imagen - - - - &reftitle.description; - - public intImagick::getImageIterations - - - - Obtiene las iteraciones de la imagen. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve las iteraciones de la imagen. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagelength.xml b/reference/imagick/imagick/getimagelength.xml deleted file mode 100644 index 6e0a6541c3..0000000000 --- a/reference/imagick/imagick/getimagelength.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - Imagick::getImageLength - Devuelve el tamaño de la imagen en bytes - - - - &reftitle.description; - - public intImagick::getImageLength - - - - Devuelve el tamaño de la imagen en bytes. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un integer. - - - - - &reftitle.examples; - - - Ejemplo con <function>Imagick::getImageLength</function>: - - Obtiene el tamaño de la imagen, en bytes - - -getImageLength() . ' bytes'; -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/getimagematte.xml b/reference/imagick/imagick/getimagematte.xml deleted file mode 100644 index 26f1c9a15b..0000000000 --- a/reference/imagick/imagick/getimagematte.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - - Imagick::getImageMatte - Indica si la imagen tiene un canal mat - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::getImageMatte - - - - - Devuelve &true; si la imagen tiene un canal mat, y &false; en caso contrario. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/getimagemattecolor.xml b/reference/imagick/imagick/getimagemattecolor.xml deleted file mode 100644 index 4232797d70..0000000000 --- a/reference/imagick/imagick/getimagemattecolor.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - Imagick::getImageMatteColor - Devuelve el color mate de la imagen - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public ImagickPixelImagick::getImageMatteColor - - - - Devuelve el color mate de la imagen. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un objeto ImagickPixel en caso de éxito. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagemimetype.xml b/reference/imagick/imagick/getimagemimetype.xml deleted file mode 100644 index 1c7530a655..0000000000 --- a/reference/imagick/imagick/getimagemimetype.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - Imagick::getImageMimeType - Devuelve el tipo MIME de la imagen - - - - &reftitle.description; - - public stringImagick::getImageMimeType - - - - Devuelve el tipo MIME de la imagen. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - diff --git a/reference/imagick/imagick/getimageorientation.xml b/reference/imagick/imagick/getimageorientation.xml deleted file mode 100644 index a889f66f81..0000000000 --- a/reference/imagick/imagick/getimageorientation.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - Imagick::getImageOrientation - Lee la orientación de la imagen - - - - &reftitle.description; - - public intImagick::getImageOrientation - - - - Lee la orientación de la imagen. El valor devuelto es una de - las constantes de orientación. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un integer en caso de éxito. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagepage.xml b/reference/imagick/imagick/getimagepage.xml deleted file mode 100644 index ce44d4f847..0000000000 --- a/reference/imagick/imagick/getimagepage.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - Imagick::getImagePage - Devuelve la geometría de la página - - - - &reftitle.description; - - public arrayImagick::getImagePage - - - - Devuelve la geometría de la página de una imagen, en forma de un array - con las claves "width", "height", - "x" y "y". - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la geometría de la página de una imagen, en forma de un array - con las claves "width", "height", - "x" y "y". - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagepixelcolor.xml b/reference/imagick/imagick/getimagepixelcolor.xml deleted file mode 100644 index 2f48e61d56..0000000000 --- a/reference/imagick/imagick/getimagepixelcolor.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - Imagick::getImagePixelColor - Devuelve el color del píxel especificado - - - - &reftitle.description; - - public ImagickPixelImagick::getImagePixelColor - intx - inty - - - Devuelve el color del píxel especificado. - - - - - &reftitle.parameters; - - - - x - - - La coordenada x del píxel - - - - - y - - - La coordenada y del píxel - - - - - - - - - &reftitle.returnvalues; - - Devuelve una instancia de ImagickPixel para el color en las coordenadas dadas. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimageprofile.xml b/reference/imagick/imagick/getimageprofile.xml deleted file mode 100644 index cbe52db832..0000000000 --- a/reference/imagick/imagick/getimageprofile.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - Imagick::getImageProfile - Devuelve el perfil nominado de la imagen - - - - &reftitle.description; - - public stringImagick::getImageProfile - stringname - - - Devuelve el perfil nominado de la imagen. - - - - - &reftitle.parameters; - - - - name - - - El nombre del perfil que se va a devolver. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un string que contiene el perfil de la imagen. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimageprofiles.xml b/reference/imagick/imagick/getimageprofiles.xml deleted file mode 100644 index 41904144c8..0000000000 --- a/reference/imagick/imagick/getimageprofiles.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - Imagick::getImageProfiles - Devuelve los perfiles de la imagen - - - - &reftitle.description; - - public arrayImagick::getImageProfiles - stringpattern"*" - boolinclude_values&true; - - - Devuelve los perfiles de la imagen que coinciden con un patrón. - Si &false; se pasa como segundo argumento, solo se devuelven los nombres de los perfiles. - &imagick.method.available.0x636; - - - - - &reftitle.parameters; - - - - pattern - - - El patrón de perfil a leer. - - - - - include_values - - - Si se deben devolver solo los nombres de los perfiles. - Si &false; se proporciona, solo se devolverán los nombres de las propiedades. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un array con los perfiles de la imagen, o bien - solo los nombres de los perfiles. - - - - - - diff --git a/reference/imagick/imagick/getimageproperties.xml b/reference/imagick/imagick/getimageproperties.xml deleted file mode 100644 index 216ba09492..0000000000 --- a/reference/imagick/imagick/getimageproperties.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - Imagick::getImageProperties - Devuelve las propiedades EXIF de la imagen - - - - &reftitle.description; - - public arrayImagick::getImageProperties - stringpattern"*" - boolinclude_values&true; - - - Devuelve todas las propiedades de la imagen que cumplen con un patrón. - Si se pasa &false; como segundo argumento, solo se devuelven los nombres de las propiedades. &imagick.method.available.0x636; - - - - - &reftitle.parameters; - - - - pattern - - - El patrón para los nombres de propiedades. - - - - - include_values - - - Si se deben devolver únicamente los nombres de las - propiedades. Si se proporciona &false;, entonces solo - se devolverán los nombres de las propiedades. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un array que contiene las propiedades de la imagen, - o sus nombres. - - - - - &reftitle.examples; - - - Ejemplo con <function>Imagick::getImageProperties</function> - - Ejemplo de extracción de información EXIF. - - -getImageProperties("exif:*"); - -/* Recorre las propiedades EXIF */ -foreach ($exifArray as $name => $property) -{ - echo "{$name} => {$property}
\n"; -} - -?> -]]> -
-
-
-
- -
- - diff --git a/reference/imagick/imagick/getimageproperty.xml b/reference/imagick/imagick/getimageproperty.xml deleted file mode 100644 index 76c6a64417..0000000000 --- a/reference/imagick/imagick/getimageproperty.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - - Imagick::getImageProperty - Devuelve una propiedad de una imagen - - - - &reftitle.description; - - public stringImagick::getImageProperty - stringname - - - Devuelve una propiedad de una imagen. - &imagick.method.available.0x632; - - - - - &reftitle.parameters; - - - - name - - - El nombre de la propiedad (por ejemplo, Exif:DateTime) - - - - - - - - - &reftitle.returnvalues; - - Devuelve una propiedad de una imagen, o &false; si el nombre - solicitado no existe. - - - - - &reftitle.examples; - - - Ejemplo con <function>Imagick::getImageProperty</function> - - Definición y recuperación de las propiedades de la imagen. - - -newImage(300, 200, "black"); - -$image->setImageProperty('Exif:Make', 'Imagick'); -echo $image->getImageProperty('Exif:Make'); -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::setImageProperty - - - - - - - diff --git a/reference/imagick/imagick/getimageredprimary.xml b/reference/imagick/imagick/getimageredprimary.xml deleted file mode 100644 index 739e5033ee..0000000000 --- a/reference/imagick/imagick/getimageredprimary.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - - Imagick::getImageRedPrimary - Devuelve la cromaticidad del punto rojo - - - - &reftitle.description; - - public arrayImagick::getImageRedPrimary - - - - Devuelve la cromaticidad del punto rojo en forma de un array - con las claves "x" y "y". - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la cromaticidad del punto rojo en forma de un array - con las claves "x" y "y". - &imagick.imagickexception.throw; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimageregion.xml b/reference/imagick/imagick/getimageregion.xml deleted file mode 100644 index 7220421853..0000000000 --- a/reference/imagick/imagick/getimageregion.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - Imagick::getImageRegion - Extrae una región de la imagen - - - - &reftitle.description; - - public ImagickImagick::getImageRegion - intwidth - intheight - intx - inty - - - Extrae una región de la imagen y la devuelve como un nuevo objeto Imagick. - - - - - &reftitle.parameters; - - - - width - - - El ancho de la región extraída. - - - - - height - - - El alto de la región extraída. - - - - - x - - - Coordenada X de la esquina superior izquierda de la región extraída. - - - - - y - - - Coordenada Y de la esquina superior izquierda de la región extraída. - - - - - - - - - &reftitle.returnvalues; - - Extrae una región de la imagen y la devuleve como una nueva varita mágica. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagerenderingintent.xml b/reference/imagick/imagick/getimagerenderingintent.xml deleted file mode 100644 index d623e507f0..0000000000 --- a/reference/imagick/imagick/getimagerenderingintent.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - Imagick::getImageRenderingIntent - Lee el método de renderizado de la imagen - - - - &reftitle.description; - - public intImagick::getImageRenderingIntent - - - - Lee el método de renderizado de la imagen. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la constante de renderizado. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimageresolution.xml b/reference/imagick/imagick/getimageresolution.xml deleted file mode 100644 index a66bc58d73..0000000000 --- a/reference/imagick/imagick/getimageresolution.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getImageResolution - Lee las resoluciones en X y Y de una imagen - - - - &reftitle.description; - - public arrayImagick::getImageResolution - - - - Lee las resoluciones en X y Y de una imagen. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Lee las resoluciones en X y Y de una imagen. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagesblob.xml b/reference/imagick/imagick/getimagesblob.xml deleted file mode 100644 index f0953bdf29..0000000000 --- a/reference/imagick/imagick/getimagesblob.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - Imagick::getImagesBlob - Devuelve todas las imágenes de la secuencia en un BLOB - - - - &reftitle.description; - - public stringImagick::getImagesBlob - - - - Implementa el formato directo en memoria. Devuelve todas las - imágenes de la secuencia en forma de cadena. El formato de la imagen - determina el formato del BLOB devuelto (GIF, JPEG, PNG, etc.). Para - devolver un formato de imagen diferente, utilice - Imagick::setImageFormat. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una cadena que contiene todas las imágenes. - &imagick.imagickexception.throw; - - - - - - diff --git a/reference/imagick/imagick/getimagescene.xml b/reference/imagick/imagick/getimagescene.xml deleted file mode 100644 index 6374e2a18b..0000000000 --- a/reference/imagick/imagick/getimagescene.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getImageScene - Devuelve la escena de la imagen - - - - &reftitle.description; - - public intImagick::getImageScene - - - - Devuelve la escena de la imagen. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la escena de la imagen. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagesignature.xml b/reference/imagick/imagick/getimagesignature.xml deleted file mode 100644 index c83d4b7066..0000000000 --- a/reference/imagick/imagick/getimagesignature.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getImageSignature - Genera una firma SHA-256 - - - - &reftitle.description; - - public stringImagick::getImageSignature - - - - Genera una firma SHA-256 de la imagen. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una cadena que contiene la firma SHA-256 de la imagen. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagesize.xml b/reference/imagick/imagick/getimagesize.xml deleted file mode 100644 index 3a3ce27398..0000000000 --- a/reference/imagick/imagick/getimagesize.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - - Imagick::getImageSize - Devuelve el tamaño de la imagen en bytes - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public intImagick::getImageSize - - - - Devuelve el tamaño de la imagen en bytes. - Este método está deprecado en favor del método - Imagick::getImageLength() - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un entero que representa el tamaño de la imagen en bytes. - - - - - - diff --git a/reference/imagick/imagick/getimagetickspersecond.xml b/reference/imagick/imagick/getimagetickspersecond.xml deleted file mode 100644 index 01252c7de5..0000000000 --- a/reference/imagick/imagick/getimagetickspersecond.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getImageTicksPerSecond - Se leen los ticks-por-segundo de la imagen - - - - &reftitle.description; - - public intImagick::getImageTicksPerSecond - - - - Se leen los ticks-por-segundo de la imagen. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Se leen los ticks-por-segundo de la imagen. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagetotalinkdensity.xml b/reference/imagick/imagick/getimagetotalinkdensity.xml deleted file mode 100644 index 82a20f17da..0000000000 --- a/reference/imagick/imagick/getimagetotalinkdensity.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - Imagick::getImageTotalInkDensity - Lee la densidad total de tinta de la imagen - - - - &reftitle.description; - - public floatImagick::getImageTotalInkDensity - - - - Lee la densidad total de tinta de la imagen. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Lee la densidad total de tinta de la imagen. - &imagick.imagickexception.throw; - - - - - - diff --git a/reference/imagick/imagick/getimagetype.xml b/reference/imagick/imagick/getimagetype.xml deleted file mode 100644 index cc8387ac6e..0000000000 --- a/reference/imagick/imagick/getimagetype.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - - Imagick::getImageType - Obtiene el tipo de imagen - - - - &reftitle.description; - - public intImagick::getImageType - - - - Devuelve el tipo de la imagen, deducido de su espacio de color, de su clase - de almacenamiento y de si lleva un canal alfa. Los píxeles en sí no se - examinan, por lo que el valor refleja cómo está representada actualmente la - imagen y no el tipo más pequeño al que podría reducirse. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una de las siguientes constantes - imagick::IMGTYPE_*. - imagick::IMGTYPE_UNDEFINED e - imagick::IMGTYPE_OPTIMIZE nunca se devuelven. - - - - - imagick::IMGTYPE_BILEVEL - - - - - imagick::IMGTYPE_GRAYSCALE - - - - - imagick::IMGTYPE_GRAYSCALEMATTE - - - - - imagick::IMGTYPE_PALETTE - - - - - imagick::IMGTYPE_PALETTEMATTE - - - - - imagick::IMGTYPE_TRUECOLOR - - - - - imagick::IMGTYPE_TRUECOLORMATTE - - - - - imagick::IMGTYPE_COLORSEPARATION - - - - - imagick::IMGTYPE_COLORSEPARATIONMATTE - - - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimageunits.xml b/reference/imagick/imagick/getimageunits.xml deleted file mode 100644 index 6afcba4d16..0000000000 --- a/reference/imagick/imagick/getimageunits.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getImageUnits - Devuelve las unidades de resolución de la imagen - - - - &reftitle.description; - - public intImagick::getImageUnits - - - - Devuelve las unidades de resolución de la imagen. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve las unidades de resolución de la imagen. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagevirtualpixelmethod.xml b/reference/imagick/imagick/getimagevirtualpixelmethod.xml deleted file mode 100644 index f0c1169515..0000000000 --- a/reference/imagick/imagick/getimagevirtualpixelmethod.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getImageVirtualPixelMethod - Devuelve el método del píxel virtual - - - - &reftitle.description; - - public intImagick::getImageVirtualPixelMethod - - - - Devuelve el método del píxel virtual para la imagen especificada. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el método del píxel virtual para la imagen especificada. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagewhitepoint.xml b/reference/imagick/imagick/getimagewhitepoint.xml deleted file mode 100644 index 418924eff7..0000000000 --- a/reference/imagick/imagick/getimagewhitepoint.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - - Imagick::getImageWhitePoint - Devuelve la cromaticidad del punto blanco - - - - &reftitle.description; - - public arrayImagick::getImageWhitePoint - - - - Devuelve la cromaticidad del punto blanco, en forma de un array - asociativo con las claves "x" y "y". - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la cromaticidad del punto blanco, en forma de un array - asociativo con las claves "x" y "y". - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getimagewidth.xml b/reference/imagick/imagick/getimagewidth.xml deleted file mode 100644 index 48867cc9d9..0000000000 --- a/reference/imagick/imagick/getimagewidth.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getImageWidth - Devuelve el ancho de la imagen - - - - &reftitle.description; - - public intImagick::getImageWidth - - - - Devuelve el ancho de la imagen. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el ancho de la imagen. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getinterlacescheme.xml b/reference/imagick/imagick/getinterlacescheme.xml deleted file mode 100644 index b5ba0b8667..0000000000 --- a/reference/imagick/imagick/getinterlacescheme.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getInterlaceScheme - Lee el esquema de entrelazado del objeto - - - - &reftitle.description; - - public intImagick::getInterlaceScheme - - - - Lee el esquema de entrelazado del objeto. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Lee la constante de entrelazado. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getiteratorindex.xml b/reference/imagick/imagick/getiteratorindex.xml deleted file mode 100644 index 8495b468a0..0000000000 --- a/reference/imagick/imagick/getiteratorindex.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - - Imagick::getIteratorIndex - Lee el índice de la imagen activa actual - - - - &reftitle.description; - - public intImagick::getIteratorIndex - - - - Lee el índice de la imagen activa actual en el objeto Imagick. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un entero que representa el índice de la imagen en la cola. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Ejemplo con <function>Imagick::getIteratorIndex</function> - - Crea imágenes, define y recupera el índice del iterador. - - -newImage(100, 100, new ImagickPixel("red")); -$im->newImage(100, 100, new ImagickPixel("green")); -$im->newImage(100, 100, new ImagickPixel("blue")); - -$im->setIteratorIndex(1); -echo $im->getIteratorIndex(); -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::setIteratorIndex - Imagick::getImageIndex - Imagick::setImageIndex - - - - - - - diff --git a/reference/imagick/imagick/getnumberimages.xml b/reference/imagick/imagick/getnumberimages.xml deleted file mode 100644 index 3e03b8fbba..0000000000 --- a/reference/imagick/imagick/getnumberimages.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getNumberImages - Devuelve el número de imágenes de un objeto - - - - &reftitle.description; - - public intImagick::getNumberImages - - - - Devuelve el número de imágenes de un objeto Imagick. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el número de imágenes de un objeto Imagick. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getoption.xml b/reference/imagick/imagick/getoption.xml deleted file mode 100644 index a7c9a0b5dd..0000000000 --- a/reference/imagick/imagick/getoption.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - Imagick::getOption - Devuelve un valor asociado con la clave especificada - - - - &reftitle.description; - - public stringImagick::getOption - stringkey - - - Devuelve un valor asociado dentro del objeto para una clave especificada. - - - - - &reftitle.parameters; - - - - key - - - El nombre de la opción - - - - - - - - - &reftitle.returnvalues; - - Devuelve un valor asociado con una varita mágica y la clave especificada. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getpackagename.xml b/reference/imagick/imagick/getpackagename.xml deleted file mode 100644 index 5ebce4881b..0000000000 --- a/reference/imagick/imagick/getpackagename.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getPackageName - Devuelve el nombre del paquete ImageMagick - - - - &reftitle.description; - - public static stringImagick::getPackageName - - - - Devuelve el nombre del paquete ImageMagick. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el nombre del paquete ImageMagick. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getpage.xml b/reference/imagick/imagick/getpage.xml deleted file mode 100644 index 1baf878fe4..0000000000 --- a/reference/imagick/imagick/getpage.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - Imagick::getPage - Devuelve la geometría de la página - - - - &reftitle.description; - - public arrayImagick::getPage - - - - Devuelve la geometría del objeto Imagick, en forma - de un array asociativo, con las claves "width", - "height", "x" y "y". - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la geometría del objeto Imagick, en forma - de un array asociativo, con las claves "width", - "height", "x" y "y". - &imagick.imagickexception.throw; - - - - - - diff --git a/reference/imagick/imagick/getpixeliterator.xml b/reference/imagick/imagick/getpixeliterator.xml deleted file mode 100644 index 6eac663268..0000000000 --- a/reference/imagick/imagick/getpixeliterator.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - - Imagick::getPixelIterator - Devuelve un MagickPixelIterator - - - - &reftitle.description; - - public ImagickPixelIteratorImagick::getPixelIterator - - - - Devuelve un MagickPixelIterator. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un objeto ImagickPixelIterator. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Ejemplo con <function>Imagick::getPixelIterator</function> - -getPixelIterator(); - - foreach ($imageIterator as $row => $pixels) { /* Se recorren las líneas de píxeles */ - foreach ($pixels as $column => $pixel) { /* Se recorren los píxeles en la línea (columna) */ - /** @var $pixel \ImagickPixel */ - if ($column % 2) { - $pixel->setColor("rgba(0, 0, 0, 0)"); /* Se pintan todos los segundos píxeles en negro */ - } - } - $imageIterator->syncIterator(); /* Se sincroniza el iterador, es importante hacerlo en cada iteración */ - } - - header("Content-Type: image/jpg"); - echo $imagick; -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/getpixelregioniterator.xml b/reference/imagick/imagick/getpixelregioniterator.xml deleted file mode 100644 index 470f332a6e..0000000000 --- a/reference/imagick/imagick/getpixelregioniterator.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - - Imagick::getPixelRegionIterator - Obtiene un objeto ImagickPixelIterator de una sección de imagen - - - - &reftitle.description; - - public ImagickPixelIteratorImagick::getPixelRegionIterator - intx - inty - intcolumns - introws - - - Obtiene un objeto ImagickPixelIterator de una sección de imagen. - - - - - &reftitle.parameters; - - - - x - - - La coordenada x de la región. - - - - - y - - - La coordenada y de la región. - - - - - columns - - - El ancho de la región. - - - - - rows - - - El alto de la región. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto ImagickPixelIterator de una sección de imagen. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Ejemplo de <methodname>Imagick::getPixelRegionIterator</methodname> - - Recorrer los píxeles de la parte alta izquierda de la imagen, cambiándolos a negro. - - - getPixelRegionIterator(0, 0, 10, 10); - -foreach ($areaIterator as $rowIterator) { - foreach ($rowIterator as $píxel) { - // Pintar cada píxel de negro - $píxel->setColor("rgba(0, 0, 0, 0)"); - } - $areaIterator->syncIterator(); -} -$im->writeImage("./output.png"); -?> -]]> - - - - - - - diff --git a/reference/imagick/imagick/getpointsize.xml b/reference/imagick/imagick/getpointsize.xml deleted file mode 100644 index 04f269746a..0000000000 --- a/reference/imagick/imagick/getpointsize.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - - Imagick::getPointSize - Obtiene el tamaño del punto - - - - &reftitle.description; - - public floatImagick::getPointSize - - - - Devuelve la propiedad del tamaño del punto del objeto. - &imagick.method.available.0x637; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un &float; que contiene el tamaño del punto. - - - - - &reftitle.seealso; - - - Imagick::setPointSize - - - - - - - diff --git a/reference/imagick/imagick/getquantum.xml b/reference/imagick/imagick/getquantum.xml deleted file mode 100644 index c910bf1a22..0000000000 --- a/reference/imagick/imagick/getquantum.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - Imagick::getQuantum - Devuelve el espacio cuántico de ImageMagick - - - - &reftitle.description; - - public static intImagick::getQuantum - - - - Devuelve el espacio cuántico de ImageMagick. Si HDRI está activado, el tipo es un float, de lo contrario es un integer. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - diff --git a/reference/imagick/imagick/getquantumdepth.xml b/reference/imagick/imagick/getquantumdepth.xml deleted file mode 100644 index 86269eb6c3..0000000000 --- a/reference/imagick/imagick/getquantumdepth.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - Imagick::getQuantumDepth - Lee la profundidad cuántica - - - - &reftitle.description; - - public static arrayImagick::getQuantumDepth - - - - Devuelve la profundidad cuántica. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un array con los miembros "quantumDepthLong" y - "quantumDepthString". - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getquantumrange.xml b/reference/imagick/imagick/getquantumrange.xml deleted file mode 100644 index b7aae8d4eb..0000000000 --- a/reference/imagick/imagick/getquantumrange.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - - Imagick::getQuantumRange - Devuelve el intervalo cuántico de Imagick - - - - &reftitle.description; - - public static arrayImagick::getQuantumRange - - - - Devuelve el intervalo cuántico de la instancia Imagick. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un array asociativo que contiene el intervalo cuántico - en forma de &integer; ("quantumRangeLong") - y en forma de &string; - ("quantumRangeString"). - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getregistry.xml b/reference/imagick/imagick/getregistry.xml deleted file mode 100644 index 28dc795a2a..0000000000 --- a/reference/imagick/imagick/getregistry.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - Imagick::getRegistry - Obtiene un elemento de StringRegistry - - - - &reftitle.description; - - public static stringImagick::getRegistry - stringkey - - - Obtiene la entrada StringRegistry para la clave nombrada o false si no está definida. - - - - - &reftitle.parameters; - - - key - - - La entrada a obtener. - - - - - - - - &reftitle.returnvalues; - - - - - - diff --git a/reference/imagick/imagick/getreleasedate.xml b/reference/imagick/imagick/getreleasedate.xml deleted file mode 100644 index 1952062726..0000000000 --- a/reference/imagick/imagick/getreleasedate.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::getReleaseDate - Devuelve la fecha de publicación de ImageMagick - - - - &reftitle.description; - - public static stringImagick::getReleaseDate - - - - Devuelve la fecha de publicación de ImageMagick, en forma de string. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la fecha de publicación de ImageMagick, en forma de string. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getresource.xml b/reference/imagick/imagick/getresource.xml deleted file mode 100644 index 6ce1f315f7..0000000000 --- a/reference/imagick/imagick/getresource.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - Imagick::getResource - Devuelve el consumo de memoria de la recurso - - - - &reftitle.description; - - public static intImagick::getResource - inttype - - - Devuelve el consumo de memoria de la recurso, en megabytes. - - - - - &reftitle.parameters; - - - - type - - - Véase la lista de - constantes de tipo de recursos. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el consumo de memoria de la recurso, en megabytes. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getresourcelimit.xml b/reference/imagick/imagick/getresourcelimit.xml deleted file mode 100644 index 0096036dca..0000000000 --- a/reference/imagick/imagick/getresourcelimit.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - Imagick::getResourceLimit - Devuelve el límite de la recurso - - - - &reftitle.description; - - public static intImagick::getResourceLimit - inttype - - - Devuelve el límite de la recurso. - - - - - &reftitle.parameters; - - - - type - - - Una de las - constantes de tipo de recursos. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el límite de recurso especificado. - La unidad depende del tipo de recurso que está limitado. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.seealso; - - Imagick::setResourceLimit - - - - - - diff --git a/reference/imagick/imagick/getsamplingfactors.xml b/reference/imagick/imagick/getsamplingfactors.xml deleted file mode 100644 index e43bc4cd78..0000000000 --- a/reference/imagick/imagick/getsamplingfactors.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - Imagick::getSamplingFactors - Lee el factor de muestreo horizontal y vertical - - - - &reftitle.description; - - public arrayImagick::getSamplingFactors - - - - Lee el factor de muestreo horizontal y vertical. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un array asociativo con los factores de muestreo - horizontal y vertical de la imagen. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getsize.xml b/reference/imagick/imagick/getsize.xml deleted file mode 100644 index 90ea5ba25b..0000000000 --- a/reference/imagick/imagick/getsize.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - Imagick::getSize - Retorna el tamaño asociado con un objeto Imagick - - - - &reftitle.description; - - public arrayImagick::getSize - - - - Obtener el tamaño asociado con un objeto Imagick, previamente definido por Imagick::setSize. - - - - Este método retorna simplemente el tamaño que ha sido definido utilizando - Imagick::setSize. Si se desea obtener la - anchura/altura real de la imagen, utilícense Imagick::getImageWidth y - Imagick::getImageHeight. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retorna el tamaño asociado con un objeto Imagick, - en forma de array, con las claves "columns" (columnas) y - "rows" (filas). - - - - - &reftitle.examples; - - - Obtención del tamaño de una imagen RGB cruda definida a 200x400, tras escalado a 400x800 (en relación a la anchura/altura) - -setSize(200, 400); -$img->readImage("image.rgb"); - -$img->scaleImage(400, 800); - -$size = $img->getSize(); -print_r($size); - -echo $img->getImageWidth()."x".$img->getImageHeight(); -?> -]]> - - &example.outputs; - - 200 - [rows] => 400 -) -400x800 -]]> - - - - - - diff --git a/reference/imagick/imagick/getsizeoffset.xml b/reference/imagick/imagick/getsizeoffset.xml deleted file mode 100644 index 4df0b91d02..0000000000 --- a/reference/imagick/imagick/getsizeoffset.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - Imagick::getSizeOffset - Devuelve el tamaño de la posición - - - - &reftitle.description; - - public intImagick::getSizeOffset - - - - Devuelve el tamaño de la posición asociada con el objeto Imagick. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el tamaño de la posición asociada con el objeto Imagick. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/getversion.xml b/reference/imagick/imagick/getversion.xml deleted file mode 100644 index 3020a47e3e..0000000000 --- a/reference/imagick/imagick/getversion.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - - Imagick::getVersion - Devuelve la API de ImageMagick - - - - &reftitle.description; - - public static arrayImagick::getVersion - - - - Devuelve la versión de la API de ImageMagick, en forma de string - y de número. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la versión de la API de ImageMagick, en forma de string - y de número. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/haldclutimage.xml b/reference/imagick/imagick/haldclutimage.xml deleted file mode 100644 index 3100585819..0000000000 --- a/reference/imagick/imagick/haldclutimage.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - - Imagick::haldClutImage - Reemplaza los colores de la imagen - - - - &reftitle.description; - - public boolImagick::haldClutImage - Imagickclut - intchannelImagick::CHANNEL_DEFAULT - - - Reemplaza los colores de la imagen usando una paleta Hald. Las imágenes Hald se pueden crear usando - un codificador de color HALD. - - - - - &reftitle.parameters; - - - - clut - - - Objeto Imagick que contiene la paleta Hald. - - - - - channel - - - &imagick.parameter.channel; - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - &reftitle.examples; - - - <function>Imagick::haldClutImage</function> - - sepiatoneImage(55); - $imagick->haldClutImage($imagickPalette); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/hasnextimage.xml b/reference/imagick/imagick/hasnextimage.xml deleted file mode 100644 index 33c1368151..0000000000 --- a/reference/imagick/imagick/hasnextimage.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - Imagick::hasNextImage - Verifica si un objeto tiene una imagen siguiente - - - - &reftitle.description; - - public boolImagick::hasNextImage - - - - Devuelve &true; si el objeto tiene más imágenes para revisar - la lista. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si el objeto tiene una imagen siguiente, y &false; en caso contrario. - - - - - - diff --git a/reference/imagick/imagick/haspreviousimage.xml b/reference/imagick/imagick/haspreviousimage.xml deleted file mode 100644 index cfabc48c11..0000000000 --- a/reference/imagick/imagick/haspreviousimage.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - Imagick::hasPreviousImage - Verifica si un objeto tiene una imagen anterior - - - - &reftitle.description; - - public boolImagick::hasPreviousImage - - - - Devuelve &true; si el objeto tiene una imagen anterior, para poder - revisar la lista en orden inverso. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si el objeto tiene una imagen anterior, y &false; en caso contrario. - - - - - - diff --git a/reference/imagick/imagick/identifyformat.xml b/reference/imagick/imagick/identifyformat.xml deleted file mode 100644 index e680ad0bd8..0000000000 --- a/reference/imagick/imagick/identifyformat.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - Imagick::identifyFormat - Formatea un string con los detalles de la imagen - - - - &reftitle.description; - - public stringfalseImagick::identifyFormat - stringembedText - - - Reemplaza todos los caracteres de formato integrados por la propiedad de imagen apropiada y devuelve el texto interpretado. Consulte http://www.imagemagick.org/script/escape.php para las secuencias de escape. - - - - - &reftitle.parameters; - - - embedText - - - Un string que contiene secuencias de formato, por ejemplo "Caja de recorte: %@ número de colores únicos: %k". - - - - - - - - &reftitle.returnvalues; - - Devuelve el formato&return.falseforfailure;. - - - - - &reftitle.examples; - - - <function>Imagick::identifyFormat</function> - - "; - $imagick = new \Imagick(realpath("./images/artifact/mask.png")); - $output .= $imagick->identifyFormat("Caja de recorte: %@ número de colores únicos: %k"); - -?> -]]> - - - - - - - diff --git a/reference/imagick/imagick/identifyimage.xml b/reference/imagick/imagick/identifyimage.xml deleted file mode 100644 index 2c55921eb9..0000000000 --- a/reference/imagick/imagick/identifyimage.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - Imagick::identifyImage - Identifica una imagen y obtiene sus atributos - - - - &reftitle.description; - - public arrayImagick::identifyImage - boolappendRawOutput&false; - - - Identifica una imagen y devuelve los atributos. Los atributos incluyen - el ancho, alto, tamaño de la imagen, entre otros. - - - - - &reftitle.parameters; - - - - appendRawOutput - - - Si es &true;, la salida bruta se agrega al array. - - - - - - - - - &reftitle.returnvalues; - - Identifica una imagen y devuelve los atributos. Los atributos incluyen - el ancho, alto, tamaño de la imagen, entre otros. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Ejemplo de formato resultante - - /some/path/image.jpg - [format] => JPEG (Joint Photographic Experts Group JFIF format) - [geometry] => Array - ( - [width] => 90 - [height] => 90 - ) - - [type] => TrueColor - [colorSpace] => RGB - [resolution] => Array - ( - [x] => 300 - [y] => 300 - ) - - [units] => PixelsPerInch - [fileSize] => 1.88672kb - [compression] => JPEG - [signature] => 9a6dc8f604f97d0d691c0286176ddf992e188f0bebba98494b2146ee2d7118da -) -]]> - - - - - - - - diff --git a/reference/imagick/imagick/implodeimage.xml b/reference/imagick/imagick/implodeimage.xml deleted file mode 100644 index 358abd2e48..0000000000 --- a/reference/imagick/imagick/implodeimage.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - Imagick::implodeImage - Crea una nueva imagen como una copia - - - - &reftitle.description; - - public boolImagick::implodeImage - floatradius - - - Crea una nueva imagen que es una copia de una existente con los píxeles de la imagen - "implosionados" por el porcentaje especificado. - - - - - &reftitle.parameters; - - - - radius - - - El radio de la implosión - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::implodeImage</function> - - implodeImage(0.0001); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); - -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/importimagepixels.xml b/reference/imagick/imagick/importimagepixels.xml deleted file mode 100644 index c5eea00df8..0000000000 --- a/reference/imagick/imagick/importimagepixels.xml +++ /dev/null @@ -1,196 +0,0 @@ - - - - - - - Imagick::importImagePixels - Importa los píxeles de una imagen - - - - &reftitle.description; - - public boolImagick::importImagePixels - intx - inty - intwidth - intheight - stringmap - intstorage - arraypixels - - - Importa los píxeles desde una matriz a un imagen. El mapa map normalmete es - 'RGB'. Este método impone las siguientes limitaciones para los parámetros: la cantidad de píxeles - en la matriz debe coincidir con width x height x - longitud del mapa. - &imagick.method.available.0x645; - - - - - - &reftitle.parameters; - - - - x - - - La posición x de la imagen - - - - - y - - - La posición y de la imagen - - - - - width - - - El ancho de la imagen - - - - - height - - - El alto de la imagen - - - - - map - - - Mapa de píxeles ordenados, como una cadena. Esto puede ser por ejemplo RGB. - El valor puede ser cualquier combinación u orden de R = rojo, G = verde, B = azul, A = alfa - (0 es transparente), O = opacidad (0 es opaco), C = cian, Y = amarillo, M = magenta, K = negro, - I = intensidad (para escala de grises), P = relleno. - - - - - storage - - - El método de almacenamiento de los píxeles. - Consulte esta lista de constantes de píxel. - - - - - pixels - - - La matriz de píxeles - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Ejemplo de<methodname>Imagick::importImagePixels</methodname> - -newImage($ancho, $alto, 'gray'); - -/* Importar los píxeles a la imagen. - ancho * alto * strlen("RGB") debe coincidir con count($píxeles) */ -$im->importImagePixels(0, 0, $ancho, $alto, "RGB", Imagick::PIXEL_CHAR, $píxeles); - -/* Imprimir como una imagen jpeg */ -$im->setImageFormat('jpg'); -header("Content-Type: image/jpg"); -echo $im; - -?> -]]> - - &example.outputs.similar; - - Salida del ejemplo : Imagick::importImagePixels() - - - - - - - - - - - - - diff --git a/reference/imagick/imagick/inversefouriertransformimage.xml b/reference/imagick/imagick/inversefouriertransformimage.xml deleted file mode 100644 index 7d800e79e7..0000000000 --- a/reference/imagick/imagick/inversefouriertransformimage.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Imagick::inverseFourierTransformImage - Implementa la transformada inversa de Fourier discreta (Discrete Fourier Transform - DFT) - - - - &reftitle.description; - - public boolImagick::inverseFourierTransformImage - Imagickcomplement - boolmagnitude - - - Implementa la transformada inversa de Fourier discreta (DFT) de la imagen, ya sea como un par de imágenes magnitud/fase o como un par de imágenes reales/imaginarias. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - complement - - - La segunda imagen a combinar con esta para formar ya sea el par de imágenes magnitud/fase o el par de imágenes reales/imaginarias. - - - - - magnitude - - - Si es verdadero, combina como un par magnitud/fase, de lo contrario, un par de imágenes reales/imaginarias. - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - diff --git a/reference/imagick/imagick/labelimage.xml b/reference/imagick/imagick/labelimage.xml deleted file mode 100644 index 6fcc0b60e4..0000000000 --- a/reference/imagick/imagick/labelimage.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Imagick::labelImage - Añade una etiqueta a una imagen - - - - &reftitle.description; - - public boolImagick::labelImage - stringlabel - - - Añade una etiqueta a una imagen. - - - - - &reftitle.parameters; - - - - label - - - La etiqueta a añadir - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/levelimage.xml b/reference/imagick/imagick/levelimage.xml deleted file mode 100644 index ac1114439b..0000000000 --- a/reference/imagick/imagick/levelimage.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - - Imagick::levelImage - Ajusta los niveles de la imagen - - - - &reftitle.description; - - public boolImagick::levelImage - floatblackPoint - floatgamma - floatwhitePoint - intchannelImagick::CHANNEL_DEFAULT - - - Ajusta los niveles de una imagen escalando la caída de los colores - entre los puntos blanco y negro especificados al rango completo de - cuantía disponible. Los parámetros proporcionados representan - los puntos negro, mitad, y blanco. El punto negro especifica - el color más oscuro de la imagen. Los colores más oscuros que el punto - negro se establecen a cero. El punto medio especifica una corrección - gamma a aplicar a la imagen. Mientras que el punto blanco especifica el - color más claro de la imagen. Los colores más claros que el punto - blanco se establecen al valor de cuantía máximo. - - - - - &reftitle.parameters; - - - - blackPoint - - - El punto negro de la imagen - - - - - gamma - - - El valor gamma - - - - - whitePoint - - - El punto blanco de la imagen - - - - - channel - - - Proporcione cualquier constante de canal que sea válida para su modo de canal. Para - aplicar más de un canal, combine las constantes channeltype usando - operadores a nivel de bits. Consulte esta lista de - constantes de canal. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::levelImage</function> - - newPseudoimage(500, 500, 'gradient:black-white'); - - $imagick->setFormat('png'); - $quantum = $imagick->getQuantum(); - $imagick->levelImage($blackPoint / 100 , $gamma, $quantum * $whitePoint / 100); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/linearstretchimage.xml b/reference/imagick/imagick/linearstretchimage.xml deleted file mode 100644 index 2706d06b04..0000000000 --- a/reference/imagick/imagick/linearstretchimage.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - Imagick::linearStretchImage - Estrecha con saturación la intensidad de la imagen - - - - &reftitle.description; - - public boolImagick::linearStretchImage - floatblackPoint - floatwhitePoint - - - - Estrecha con saturación la intensidad de la imagen. - - - - - &reftitle.parameters; - - - - blackPoint - - - El punto negro de la imagen - - - - - whitePoint - - - El punto blanco de la imagen - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::linearStretchImage</function> - - getImageWidth() * $imagick->getImageHeight(); - $imagick->linearStretchImage($blackThreshold * $pixels, $whiteThreshold * $pixels); - - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/liquidrescaleimage.xml b/reference/imagick/imagick/liquidrescaleimage.xml deleted file mode 100644 index 7df140c9f6..0000000000 --- a/reference/imagick/imagick/liquidrescaleimage.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - Imagick::liquidRescaleImage - Anima una imagen o imágenes - - - - &reftitle.description; - - public boolImagick::liquidRescaleImage - intwidth - intheight - floatdelta_x - floatrigidity - - - - Este método escala las imágenes usando un método de re-escalada líquido. Este método - es una implementación de una técnica llamada "seam carving" (talla de costura). Para que este método - funcione como es debido, ImageMagick se debe compilar con el soporte para la biblioteca liblqr. - &imagick.method.available.0x639; - - - - - &reftitle.parameters; - - - - width - - - El ancho del tamaño objetivo - - - - - height - - - El alto del tamaño objetivo - - - - - delta_x - - - Cuánto puede atravesar la costura el eje x. - Pasar 0 causa que las costuras sean rectas. - - - - - rigidity - - - Introduce un sesgo para costuras no rectas. Este parámetro normalmente - es 0. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.seealso; - - - Imagick::resizeImage - - - - - - - diff --git a/reference/imagick/imagick/listregistry.xml b/reference/imagick/imagick/listregistry.xml deleted file mode 100644 index 0747f0148d..0000000000 --- a/reference/imagick/imagick/listregistry.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Imagick::listRegistry - Lista todos los parámetros del registro - - - - &reftitle.description; - - public static arrayImagick::listRegistry - - - - Lista todos los parámetros del registro. Devuelve un array de todas las parejas clave/valor del registro. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un array que contiene las claves/valores del registro. - - - - - - diff --git a/reference/imagick/imagick/magnifyimage.xml b/reference/imagick/imagick/magnifyimage.xml deleted file mode 100644 index f7e9231e8d..0000000000 --- a/reference/imagick/imagick/magnifyimage.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - Imagick::magnifyImage - Duplica el tamaño de una imagen, proporcionalmente - - - - &reftitle.description; - - public boolImagick::magnifyImage - - - - Este método es un atajo para duplicar el tamaño de una imagen. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Ejemplo con <function>Imagick::magnifyImage</function> - -magnifyImage(); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/mapimage.xml b/reference/imagick/imagick/mapimage.xml deleted file mode 100644 index 93c415b6fc..0000000000 --- a/reference/imagick/imagick/mapimage.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - Imagick::mapImage - Reemplaza los colores de una imagen con el color más cercano de una imagen de referencia - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::mapImage - Imagickmap - booldither - - - - - &reftitle.parameters; - - - - map - - - - - - - dither - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/mattefloodfillimage.xml b/reference/imagick/imagick/mattefloodfillimage.xml deleted file mode 100644 index 4920c883fc..0000000000 --- a/reference/imagick/imagick/mattefloodfillimage.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - Imagick::matteFloodfillImage - Cambia el valor de transparencia de un color - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::matteFloodfillImage - floatalpha - floatfuzz - mixedbordercolor - intx - inty - - - Cambia el valor de transparencia de un píxel que coincide con - el objetivo y esté en la zona inmediata. Si el método - FillToBorderMethod se especifica, el valor de transparencia - se cambia por cualquier píxel inmediato que no coincida con - el miembro color del borde de la imagen. - - - - - &reftitle.parameters; - - - - alpha - - - El nivel de transparencia: 1.0 es completamente opaco y 0.0 es completamente - transparente. - - - - - fuzz - - - El miembro enfoque de la imagen define cuánta tolerancia se acepta para - considerar que dos colores son el mismo. - - - - - bordercolor - - - Un objeto ImagickPixel o una cadena que representa el color del borde. - - - - - x - - - La coordenada x de inicio de la operación. - - - - - y - - - La coordenada y de inicio de la operación. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Ahora se permite que una cadena represente el color como tercer parámetro. - Versiones anteriores sólo permitían un objeto ImagickPixel. - - - - - - - - - - - diff --git a/reference/imagick/imagick/medianfilterimage.xml b/reference/imagick/imagick/medianfilterimage.xml deleted file mode 100644 index a4b59e58eb..0000000000 --- a/reference/imagick/imagick/medianfilterimage.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - Imagick::medianFilterImage - Aplica un filtro digital - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::medianFilterImage - floatradius - - - Aplica un filtro digital que mejora la calidad de una - imagen con ruido. Cada píxel es reemplazado por la media en un - conjunto de píxeles inmediatos como está definido por el radio. - - - - - &reftitle.parameters; - - - - radius - - - El radio de la zona inmediata de los píxeles. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::medianFilterImage</function> - - medianFilterImage($radius); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/mergeimagelayers.xml b/reference/imagick/imagick/mergeimagelayers.xml deleted file mode 100644 index 5dfb7cc688..0000000000 --- a/reference/imagick/imagick/mergeimagelayers.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - - Imagick::mergeImageLayers - Fusiona las capas de la imagen - - - - &reftitle.description; - - public ImagickImagick::mergeImageLayers - intlayer_method - - - Fusiona las capas de la imagen en una sola. Este método es útil - al utilizar formatos de imagen que emplean múltiples capas, - como los PSD. La fusión se controla mediante el argumento - layer_method que define la forma en que las capas - deben fusionarse. - &imagick.method.available.0x637; - - - - - &reftitle.parameters; - - - - layer_method - - - Una constante entre las constantes Imagick::LAYERMETHOD_*. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto Imagick que contiene la imagen fusionada. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Ejemplo con <function>Imagick::mergeImageLayers</function> - -addImage($imagick2); - $imagick->setImageFormat('png'); - - $result = $imagick->mergeImageLayers($layerMethodType); - header("Content-Type: image/png"); - echo $result->getImageBlob(); -} - -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::flattenImages - - - - - - - diff --git a/reference/imagick/imagick/minifyimage.xml b/reference/imagick/imagick/minifyimage.xml deleted file mode 100644 index eafaf9d64e..0000000000 --- a/reference/imagick/imagick/minifyimage.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - Imagick::minifyImage - Redimensiona una imagen proporcionalmente para reducirla a la mitad de tamaño - - - - &reftitle.description; - - public boolImagick::minifyImage - - - - Esta función es un atajo práctico para redimensionar - una imagen proporcionalmente para reducirla - a la mitad de tamaño. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/modulateimage.xml b/reference/imagick/imagick/modulateimage.xml deleted file mode 100644 index 27aaa1cd04..0000000000 --- a/reference/imagick/imagick/modulateimage.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - Imagick::modulateImage - Controla el brillo, la saturación y el tono - - - - &reftitle.description; - - public boolImagick::modulateImage - floatbrightness - floatsaturation - floathue - - - Permite controlar el brillo, la saturación y el tono de una imagen. El tono - es el porcentaje de la rotación absoluta desde la posición actual. Por - ejemplo, 50 resulta en una rotación en el sentido contrario a las agujas del reloj - de 90 grados, 150 resulta en una rotación en el sentido de las agujas del reloj de - 90 grados, con 0 y 200 resultando en una rotación de 180 grados. - - - - - &reftitle.parameters; - - - - brightness - - - - - - - saturation - - - - - - - hue - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::modulateImage</function> - - modulateImage($brightness, $saturation, $hue); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/montageimage.xml b/reference/imagick/imagick/montageimage.xml deleted file mode 100644 index fab09bd2e9..0000000000 --- a/reference/imagick/imagick/montageimage.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - Imagick::montageImage - Crea una imagen compuesta - - - - &reftitle.description; - - public ImagickImagick::montageImage - ImagickDrawdraw - stringtile_geometry - stringthumbnail_geometry - intmode - stringframe - - - Crea una imagen compuesta combinando varias imágenes. - Las imágenes se utilizan como baldosas en la imagen compuesta, - con su nombre opcionalmente debajo. - - - - - &reftitle.parameters; - - - - draw - - - El nombre de la fuente, el tamaño y el color se solicitan a este objeto. - - - - - tile_geometry - - - El número de baldosas por filas y por página (ej. 6x4+0+0). - - - - - thumbnail_geometry - - - El tamaño solicitado para la imagen y su borde para cada miniatura - (ej. 120x120+4+3). - - - - - mode - - - El modo de encuadre de las miniaturas. Consulte la lista de constantes de modo de montaje. - - - - - frame - - - Encuadra la imagen con un borde decorativo (ej. 15x15+3+3). La - color del borde es el color mate de la miniatura. - - - - - - - - - &reftitle.returnvalues; - - Crea una imagen compuesta y la devuelve como un nuevo objeto - Imagick. - - - - - diff --git a/reference/imagick/imagick/morphimages.xml b/reference/imagick/imagick/morphimages.xml deleted file mode 100644 index 3d823d32cc..0000000000 --- a/reference/imagick/imagick/morphimages.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - Imagick::morphImages - Metamorfosea un conjunto de imágenes - - - - &reftitle.description; - - public ImagickImagick::morphImages - intnumber_frames - - - Metamorfosea un conjunto de imágenes. Los píxeles de la imagen y el tamaño - son interpolados linealmente para dar la apariencia de una - metamorfosis desde una imagen a la siguiente. - - - - - &reftitle.parameters; - - - - number_frames - - - El número de imágenes intermedias a generar. - - - - - - - - - &reftitle.returnvalues; - - Este método devuelve un nuevo objeto Imagick si se tuvo éxito. - &imagick.imagickexception.throw; - - - - - - diff --git a/reference/imagick/imagick/morphology.xml b/reference/imagick/imagick/morphology.xml deleted file mode 100644 index 0bdbebc3b6..0000000000 --- a/reference/imagick/imagick/morphology.xml +++ /dev/null @@ -1,516 +0,0 @@ - - - - - - Imagick::morphology - Aplica un núcleo personalizado a la imagen según el método de morfología dado - - - - &reftitle.description; - - public boolImagick::morphology - intmorphologyMethod - intiterations - ImagickKernelImagickKernel - intchannelImagick::CHANNEL_DEFAULT - - - Aplica un núcleo personalizado a la imagen según el método de morfología dado. - - - - - &reftitle.parameters; - - - morphologyMethod - - - Qué método de morfología utilizar entre las constantes \Imagick::MORPHOLOGY_*. - - - - - iterations - - - El número de iteraciones a aplicar a la función de morfología. Un valor de -1 significa iterar hasta que no se encuentren más cambios. Cómo se aplica esto puede depender del método de morfología. Típicamente, se trata de un valor de 1. - - - - - ImagickKernel - - - - - - - channel - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Convolución <function>Imagick::morphology</function> - - getCharacter(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_GAUSSIAN, "5,1"); - $imagick->morphology(\Imagick::MORPHOLOGY_CONVOLVE, 2, $kernel); - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -?> -]]> - - - - - Correlación <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromMatrix(self::$correlateMatrix, [2, 2]); - $imagick->morphology(\Imagick::MORPHOLOGY_CORRELATE, 1, $kernel); - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -?> -]]> - - - - - Erosión <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_OCTAGON, "3"); - $canvas->morphology(\Imagick::MORPHOLOGY_ERODE, 2, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); -?> -]]> - - - - - Erosión de intensidad <function>Imagick::morphology</function> - - getCharacter(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_OCTAGON, "1"); - $canvas->morphology(\Imagick::MORPHOLOGY_ERODE_INTENSITY, 2, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); -?> -]]> - - - - - Dilatación <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_OCTAGON, "3"); - $canvas->morphology(\Imagick::MORPHOLOGY_DILATE, 4, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); -?> -]]> - - - - - Dilatación de intensidad <function>Imagick::morphology</function> - - getCharacter(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_OCTAGON, "1"); - $canvas->morphology(\Imagick::MORPHOLOGY_DILATE_INTENSITY, 4, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); -?> -]]> - - - - - Distancia con núcleo de Chebyshev <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_CHEBYSHEV, "3"); - $canvas->morphology(\Imagick::MORPHOLOGY_DISTANCE, 3, $kernel); - $canvas->autoLevelImage(); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); -?> -]]> - - - - - Distancia con núcleo de Manhattan <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_MANHATTAN, "5"); - $canvas->morphology(\Imagick::MORPHOLOGY_DISTANCE, 3, $kernel); - $canvas->autoLevelImage(); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); -?> -]]> - - - - - Distancia con núcleo octagonal <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_OCTAGONAL, "5"); - $canvas->morphology(\Imagick::MORPHOLOGY_DISTANCE, 3, $kernel); - $canvas->autoLevelImage(); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); -?> -]]> - - - - - Distancia con núcleo euclidiano <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_EUCLIDEAN, "4"); - $canvas->morphology(\Imagick::MORPHOLOGY_DISTANCE, 3, $kernel); - $canvas->autoLevelImage(); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); -?> -]]> - - - - - Borde <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_OCTAGON, "3"); - $canvas->morphology(\Imagick::MORPHOLOGY_EDGE, 1, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); -?> -]]> - - - - - Apertura <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_DISK, "6"); - $canvas->morphology(\Imagick::MORPHOLOGY_OPEN, 1, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); -?> -]]> - - - - - Apertura de intensidad <function>Imagick::morphology</function> - - getCharacter(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_DISK, "6"); - $canvas->morphology(\Imagick::MORPHOLOGY_OPEN_INTENSITY, 1, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); -?> -]]> - - - - - Cierre <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_DISK, "6"); - $canvas->morphology(\Imagick::MORPHOLOGY_CLOSE, 1, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); -?> -]]> - - - - - Cierre de intensidad <function>Imagick::morphology</function> - - getCharacter(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_DISK, "6"); - $canvas->morphology(\Imagick::MORPHOLOGY_CLOSE_INTENSITY, 1, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); -?> -]]> - - - - - Suavizado <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_OCTAGON, "3"); - $canvas->morphology(\Imagick::MORPHOLOGY_SMOOTH, 1, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); -?> -]]> - - - - - Borde interior <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_OCTAGON, "3"); - $canvas->morphology(\Imagick::MORPHOLOGY_EDGE_IN, 1, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); -?> -]]> - - - - - Borde exterior <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_OCTAGON, "3"); - $canvas->morphology(\Imagick::MORPHOLOGY_EDGE_OUT, 1, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); -?> -]]> - - - - - El método 'TopHat', o más específicamente 'White Top Hat', devuelve los píxeles que han sido eliminados por una Apertura de la forma, es decir, los píxeles que han sido eliminados para redondear los puntos y los puentes de conexión entre las formas. <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_DISK, "5"); - $canvas->morphology(\Imagick::MORPHOLOGY_TOP_HAT, 1, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); -?> -]]> - - - - - El método 'BottomHat', también conocido como 'Black TopHat', son los píxeles que un Cierre de la forma añade a la imagen. Es decir, los píxeles que han sido utilizados para rellenar los 'huecos', las 'lagunas' y los 'puentes'. <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_DISK, "5"); - $canvas->morphology(\Imagick::MORPHOLOGY_BOTTOM_HAT, 1, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); -?> -]]> - - - - - Golpe y fallo <function>Imagick::morphology</function> - - getCharacterOutline(); - //Esto encuentra todos los píxeles con 3 píxeles del borde derecho - $matrix = [[1, false, false, 0]]; - $kernel = \ImagickKernel::fromMatrix( - $matrix, - [0, 0] - ); - $canvas->morphology(\Imagick::MORPHOLOGY_HIT_AND_MISS, 1, $kernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); -?> -]]> - - - - - Afinamiento <function>Imagick::morphology</function> - - getCharacterOutline(); - $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(); -?> -]]> - - - - - Engrosamiento <function>Imagick::morphology</function> - - getCharacterOutline(); - $leftEdgeKernel = \ImagickKernel::fromMatrix([[0, 1]], [1, 0]); - $rightEdgeKernel = \ImagickKernel::fromMatrix([[1, 0]], [0, 0]); - $leftEdgeKernel->addKernel($rightEdgeKernel); - - $canvas->morphology(\Imagick::MORPHOLOGY_THICKEN, 3, $leftEdgeKernel); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); -?> -]]> - - - - - Afinamiento para generar una cáscara convexa <function>Imagick::morphology</function> - - getCharacterOutline(); - $diamondKernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_DIAMOND, "1"); - $convexKernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_CONVEX_HULL, ""); - - // La morfología de afinamiento no maneja los pequeños espacios. Los cerramos - // con la morfología de cierre. - $canvas->morphology(\Imagick::MORPHOLOGY_CLOSE, 1, $diamondKernel); - $canvas->morphology(\Imagick::MORPHOLOGY_THICKEN, -1, $convexKernel); - $canvas->morphology(\Imagick::MORPHOLOGY_CLOSE, 1, $diamondKernel); - - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); -?> -]]> - - - - - Morfología iterativa <function>Imagick::morphology</function> - - getCharacterOutline(); - $kernel = \ImagickKernel::fromBuiltIn(\Imagick::KERNEL_DISK, "2"); - $canvas->morphology(\Imagick::MORPHOLOGY_ITERATIVE, 3, $kernel); - $canvas->autoLevelImage(); - header("Content-Type: image/png"); - echo $canvas->getImageBlob(); -?> -]]> - - - - - Función de ayuda para obtener un contorno de imagen <function>Imagick::morphology</function> - -newPseudoImage( - $imagick->getImageWidth(), - $imagick->getImageHeight(), - "canvas:white" - ); - $canvas = new \Imagick(); - $canvas->newPseudoImage( - $imagick->getImageWidth(), - $imagick->getImageHeight(), - "canvas:black" - ); - - $character->compositeimage( - $imagick, - \Imagick::COMPOSITE_COPYOPACITY, - 0, 0 - ); - $canvas->compositeimage( - $character, - \Imagick::COMPOSITE_ATOP, - 0, 0 - ); - $canvas->setFormat('png'); - - return $canvas; -} -?> -]]> - - - - - diff --git a/reference/imagick/imagick/mosaicimages.xml b/reference/imagick/imagick/mosaicimages.xml deleted file mode 100644 index 9ccf5ff703..0000000000 --- a/reference/imagick/imagick/mosaicimages.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - - Imagick::mosaicImages - Forma una mosaico de imágenes - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public ImagickImagick::mosaicImages - - - - Alinea las imágenes de una secuencia para formar una sola imagen - coherente. La función devuelve una baguette con cada - imagen de la secuencia, en el lugar del desplazamiento de la imagen. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/motionblurimage.xml b/reference/imagick/imagick/motionblurimage.xml deleted file mode 100644 index 252c47547d..0000000000 --- a/reference/imagick/imagick/motionblurimage.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - Imagick::motionBlurImage - Simula borrosidad en movimiento - - - - &reftitle.description; - - public boolImagick::motionBlurImage - floatradius - floatsigma - floatangle - intchannelImagick::CHANNEL_DEFAULT - - - Simula borrosidad en movimiento. Se convoluciona la imagen con un operador - gaussiano del radio y la desviación estándar (sigma) dados. - Para obtener resultados razonables, el radio debe ser mayor que sigma. - Use un radio de 0 y MotionBlurImage() seleccionará un radio - apropiado automáticamente. El ángulo da el ángulo del movimiento borroso. - - - - - &reftitle.parameters; - - - - radius - - - El radio gaussiano, en píxeles, sin contar el píxel central. - - - - - sigma - - - La desviación estándar gaussiana, en píxeles. - - - - - angle - - - Aplica el efecto a lo largo de este ángulo. - - - - - channel - - - Proporcione cualquier constante de canal que sea válida para su modo de canal. Para - aplicar más de un canal, combine las constantes channeltype usando - operadores a nivel de bits. Consulte esta lista de - constantes de canal. - El argumento channel afecta sólo si Imagick es compilado con la versión 6.4.4 o superior de - ImageMagick. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::motionBlurImage</function> - - motionBlurImage($radius, $sigma, $angle, $channel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/negateimage.xml b/reference/imagick/imagick/negateimage.xml deleted file mode 100644 index 2ba4325d2e..0000000000 --- a/reference/imagick/imagick/negateimage.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - Imagick::negateImage - Invierte los colores en la imagen de referencia - - - - &reftitle.description; - - public boolImagick::negateImage - boolgray - intchannelImagick::CHANNEL_DEFAULT - - - Invierte los colores en la imagen de referencia. La opción de escala de grises - significa que sólo los valores de la escala de grises dentro de la imagen - se inverten. - - - - - &reftitle.parameters; - - - - gray - - - Si sólo se invierten los píxeles de la escala de grises dentro de la imagen. - - - - - channel - - - Proporcione cualquier constante de canal que sea válida para su modo de canal. Para - aplicar más de un canal, combine las constantes channeltype usando - operadores a nivel de bits. Consulte esta lista de - constantes de canal. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::negateImage</function> - - negateImage($grayOnly, $channel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/newimage.xml b/reference/imagick/imagick/newimage.xml deleted file mode 100644 index 616988fcb7..0000000000 --- a/reference/imagick/imagick/newimage.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - Imagick::newImage - Crea una nueva imagen - - - - &reftitle.description; - - public boolImagick::newImage - intcols - introws - mixedbackground - stringformat - - - Crea una nueva imagen y asocia el valor de ImagickPixel al color de fondo - - - - - &reftitle.parameters; - - - - cols - - - Columnas en la nueva imagen - - - - - rows - - - Filas en la nueva imagen - - - - - background - - - El color de fondo usado para esta imagen - - - - - format - - - El formato de la imagen. Este parámetro se añadió en la versión 2.0.1 de Imagick. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Ahora se permite que una cadena represente el color como tercer parámetro - Versiones anteriores sólo permitían un objeto ImagickPixel. - - - - - - - - - - &reftitle.examples; - - - Usar <function>Imagick::newImage</function>: - - Crear una nueva imagen y mostrarla. - - -newImage(100, 100, new ImagickPixel('red')); -$imagen->setImageFormat('png'); - -header('Content-type: image/png'); -echo $imagen; - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/newpseudoimage.xml b/reference/imagick/imagick/newpseudoimage.xml deleted file mode 100644 index 7c95174cec..0000000000 --- a/reference/imagick/imagick/newpseudoimage.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - - Imagick::newPseudoImage - Crea una nueva imagen - - - - &reftitle.description; - - public boolImagick::newPseudoImage - intcolumns - introws - stringpseudoString - - - Crea una nueva imagen usando pseudo-formatos de ImageMagick. - - - - - &reftitle.parameters; - - - - columns - - - columnas en la nueva imagen - - - - - rows - - - filas en la nueva imagen - - - - - pseudoString - - - string que contiene la definición de la pseudo-imagen. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::newPseudoImage</function> - - newPseudoImage(300, 300, $canvasType); - $imagick->setImageFormat("png"); - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -//newPseudoImage('gradient:red-rgba(64, 255, 255, 0.5)'); -//newPseudoImage("radial-gradient:red-blue"); -newPseudoImage("plasma:fractal"); - -?> -]]> - - - - - - - - - diff --git a/reference/imagick/imagick/nextimage.xml b/reference/imagick/imagick/nextimage.xml deleted file mode 100644 index f3cc8e1bbe..0000000000 --- a/reference/imagick/imagick/nextimage.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - Imagick::nextImage - Pasa a la siguiente imagen - - - - &reftitle.description; - - public boolImagick::nextImage - - - - Pasa a la siguiente imagen en la lista del objeto Imagick. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/normalizeimage.xml b/reference/imagick/imagick/normalizeimage.xml deleted file mode 100644 index d8e5d97a5b..0000000000 --- a/reference/imagick/imagick/normalizeimage.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - Imagick::normalizeImage - Mejora el contraste de una imagen a color - - - - &reftitle.description; - - public boolImagick::normalizeImage - intchannelImagick::CHANNEL_DEFAULT - - - Mejora el contraste de una imagen a color ajustando los colores de los - píxeles para abarcar el rango completo de colores disponibles. - - - - - &reftitle.parameters; - - - - channel - - - Proporcione cualquier constante de canal que sea válida para su modo de canal. Para - aplicar más de un canal, combine las constantes channeltype usando - operadores a nivel de bits. Consulte esta lista de - constantes de canal. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::normalizeImage</function> - - cropimage($original->getImageWidth() / 2, $original->getImageHeight(), 0, 0); - $imagick->normalizeImage($channel); - $imagick->compositeimage($original, \Imagick::COMPOSITE_ATOP, 0, 0); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/oilpaintimage.xml b/reference/imagick/imagick/oilpaintimage.xml deleted file mode 100644 index c414e6f02f..0000000000 --- a/reference/imagick/imagick/oilpaintimage.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - Imagick::oilPaintImage - Simula una pintura al óleo - - - - &reftitle.description; - - public boolImagick::oilPaintImage - floatradius - - - Aplica un filtro de efecto especial que simula una pintura al óleo. - Cada píxel es reemplazado por el color más frecuente que suceda en una - región circular definida por el radio. - - - - - &reftitle.parameters; - - - - radius - - - El radio de la zona circular inmediata. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::oilPaintImage</function> - - oilPaintImage($radius); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/opaquepaintimage.xml b/reference/imagick/imagick/opaquepaintimage.xml deleted file mode 100644 index c3696b9f50..0000000000 --- a/reference/imagick/imagick/opaquepaintimage.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Imagick::opaquePaintImage - Cambia el color de cualquier píxel que coincida con el objetivo - - - - &reftitle.description; - - public boolImagick::opaquePaintImage - mixedtarget - mixedfill - floatfuzz - boolinvert - intchannelImagick::CHANNEL_DEFAULT - - - - Cambia cualquier píxel que coincida con el color definido para el relleno. - &imagick.method.available.0x638; - - - - - &reftitle.parameters; - - - - target - - - Objeto ImagickPixel o una cadena que contiene el color a cambiar - - - - - fill - - - El color sustituto - - - - - fuzz - - - &imagick.parameter.fuzz; - - - - - invert - - - Si es &true; pinta cualquier píxel que no coincida con el color objetivo. - - - - - channel - - - &imagick.parameter.channel; - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/optimizeimagelayers.xml b/reference/imagick/imagick/optimizeimagelayers.xml deleted file mode 100644 index c149c5f12a..0000000000 --- a/reference/imagick/imagick/optimizeimagelayers.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - - Imagick::optimizeImageLayers - Elimina las porciones recurrentes de imágenes a optimizar - - - - &reftitle.description; - - public boolImagick::optimizeImageLayers - - - - - Compara cada imagen GIF con la anterior en la secuencia. A partir - de ahí, el método intenta seleccionar la parte más pequeña de la imagen - a reemplazar en cada imagen, manteniendo los resultados de la animación. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Ejemplo con <function>Imagick::optimizeImageLayers</function> - - Lectura, optimización y escritura de una imagen GIF - - -optimizeImageLayers(); - -/* escritura de la imagen */ -$im->writeImages("test_optimized.gif", true); -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::compareImageLayers - Imagick::writeImages - Imagick::writeImage - - - - - - - diff --git a/reference/imagick/imagick/orderedposterizeimage.xml b/reference/imagick/imagick/orderedposterizeimage.xml deleted file mode 100644 index fece27a156..0000000000 --- a/reference/imagick/imagick/orderedposterizeimage.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - - Imagick::orderedPosterizeImage - Realiza un entramado ordenado - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::orderedPosterizeImage - stringthreshold_map - intchannelImagick::CHANNEL_DEFAULT - - - - Realiza un entramado ordenado basado en varios mapas de umbral de entramado predefinidos, - pero sobre múltiples niveles de intensidad, lo que puede ser diferente para distintos canales, - según los argumentos de entrada. &imagick.method.available.0x631; - - - - - &reftitle.parameters; - - - - threshold_map - - - Un string que contiene el nombre del mapa de umbral de entramado que se va a usar - - - - - channel - - - Proporcione cualquier constante de canal que sea válida para su modo de canal. Para - aplicar más de un canal, combine las constantes channeltype usando - operadores a nivel de bits. Consulte esta lista de - constantes de canal. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::orderedPosterizeImage</function> - - orderedPosterizeImage($orderedPosterizeType); - $imagick->setImageFormat('png'); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -//orderedPosterizeImage($imagePath, 'o4x4,3,3'); -//orderedPosterizeImage($imagePath, 'o8x8,6,6'); -orderedPosterizeImage($imagePath, 'h8x8a'); - - - - - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/paintfloodfillimage.xml b/reference/imagick/imagick/paintfloodfillimage.xml deleted file mode 100644 index 95d9738680..0000000000 --- a/reference/imagick/imagick/paintfloodfillimage.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - Imagick::paintFloodfillImage - Cambia el valor del color de cualquier píxel que coincida con el objetivo - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::paintFloodfillImage - mixedfill - floatfuzz - mixedbordercolor - intx - inty - intchannelImagick::CHANNEL_DEFAULT - - - - Cambia el valor del color de cualquier píxel que coincida con el objetivo y esté en - la zona inmediata. A partir de ImageMagick 6.3.8 este método está obsoleto - y se debería usar Imagick::floodfillPaintImage en su lugar. - - - - - &reftitle.parameters; - - - - fill - - - Objeto ImagickPixel o un string que contiene el color de relleno - - - - - fuzz - - - La cantidad de enfoque. Por ejemplo, establecer el enfoque a 10 y el color a rojo con una - intensidad de 100 y 102 respectivamente ahora se interpreta como el - mismo color para los propósitos del relleno. - - - - - bordercolor - - - Objeto ImagickPixel que contiene el color de borde - - - - - x - - - Posición X del inicio del relleno - - - - - y - - - Posición Y del inicio del relleno - - - - - channel - - - &imagick.parameter.channel; - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/paintopaqueimage.xml b/reference/imagick/imagick/paintopaqueimage.xml deleted file mode 100644 index 4941c8a613..0000000000 --- a/reference/imagick/imagick/paintopaqueimage.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - Imagick::paintOpaqueImage - Cambia cualquier píxel que coincida con el color - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::paintOpaqueImage - mixedtarget - mixedfill - floatfuzz - intchannelImagick::CHANNEL_DEFAULT - - - Cambia cualquier píxel que coincida con el color definido por el relleno. - - - - - &reftitle.parameters; - - - - target - - - Cambia este color objetivo por el color de relleno de la imagen. Un - objeto ImagickPixel o una cadena que representa el color objetivo. - - - - - fill - - - Un objeto ImagickPixel o un string que representa el color de relleno. - - - - - fuzz - - - El miembro enfoque de la imagen define cúanta tolerancia es aceptable para - considerar que dos colores son el mismo. - - - - - channel - - - Proporcione cualquier constante de canal que sea válida para su modo de canal. Para - aplicar más de un canal, combine las constantes channeltype usando - operadores a nivel de bits. Consulte esta lista de - constantes de canal. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Ahora se permite que una cadena represente el color como primer y segundo parámetros. - Versiones anteriores sólo permitían un objeto ImagickPixel. - - - - - - - - - - - diff --git a/reference/imagick/imagick/painttransparentimage.xml b/reference/imagick/imagick/painttransparentimage.xml deleted file mode 100644 index b8a6693a74..0000000000 --- a/reference/imagick/imagick/painttransparentimage.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - Imagick::paintTransparentImage - Cambia cualquier píxel que coincida con el color definido para el relleno - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::paintTransparentImage - mixedtarget - floatalpha - floatfuzz - - - Cambia cualquier píxel que coincida con el color definido para el relleno. - - - - - &reftitle.parameters; - - - - target - - - Cambia este color objetivo por el valor de opacidad especificado dentro de la imagen. - - - - - alpha - - - El nivel de transparencia: 1.0 es completamente opaco y 0.0 es completamente - transparente. - - - - - fuzz - - - El miembro enfoque de la imagen define cuánta tolerancia es aceptable para - considerar que dos colores son el mismo. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Ahora se permite que una cadena represente el color como primer parámetro. - Versiones anteriores sólo permitían un objeto ImagickPixel. - - - - - - - - - - - diff --git a/reference/imagick/imagick/pingimage.xml b/reference/imagick/imagick/pingimage.xml deleted file mode 100644 index c7404635f2..0000000000 --- a/reference/imagick/imagick/pingimage.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - Imagick::pingImage - Trae los atributos básicos de una imagen - - - - &reftitle.description; - - public boolImagick::pingImage - stringfilename - - - Este método se puede usar para preguntar por el ancho, alto, tamaño y formato de la imagen - sin leer toda la imagen de la memoria. - - - - - &reftitle.parameters; - - - - filename - - - El nombre de fichero de donde se va a leer la información. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/pingimageblob.xml b/reference/imagick/imagick/pingimageblob.xml deleted file mode 100644 index d46a6806a0..0000000000 --- a/reference/imagick/imagick/pingimageblob.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - Imagick::pingImageBlob - Traer los atributos rápidamente - - - - &reftitle.description; - - public boolImagick::pingImageBlob - stringimage - - - - Este método se puede usar para preguntar por el ancho, alto, tamaño y formato de la imagen - sin leer toda la imagen de la memoria. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - image - - - Un string que contiene la imagen. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Usar <function>Imagick::pingImageBlob</function> - - Hacer ping a una imagen desde un string - - -pingImageBlob($imagen); - -/* imprimir el ancho y alto de la image */ -echo $im->getImageWidth() . 'x' . $im->getImageHeight(); -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::pingImage - Imagick::pingImageFile - Imagick::readImage - Imagick::readImageBlob - Imagick::readImageFile - - - - - - - diff --git a/reference/imagick/imagick/pingimagefile.xml b/reference/imagick/imagick/pingimagefile.xml deleted file mode 100644 index e488b49d33..0000000000 --- a/reference/imagick/imagick/pingimagefile.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - Imagick::pingImageFile - Obtener los atrbutos básicos de la imagen de una manera liviana - - - - &reftitle.description; - - public boolImagick::pingImageFile - resourcefilehandle - stringfileName - - - - Este método se puede usar para preguntar por el ancho, alto, tamaño y formato de la imagen - sin leer toda la imagen de la memoria. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - filehandle - - - Un gestor de archivo abierto a la imagen. - - - - - fileName - - - Nombre de archivo opcional para esta imagen. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Usar <function>Imagick::pingImageFile</function> - - Abrir una ubicación remota - - -pingImageFile($fp); -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::pingImage - Imagick::pingImageBlob - Imagick::readImage - Imagick::readImageBlob - Imagick::readImageFile - - - - - - - diff --git a/reference/imagick/imagick/polaroidimage.xml b/reference/imagick/imagick/polaroidimage.xml deleted file mode 100644 index 8c80abe580..0000000000 --- a/reference/imagick/imagick/polaroidimage.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Imagick::polaroidImage - Simula una fotografía Polaroid - - - - &reftitle.description; - - public boolImagick::polaroidImage - ImagickDrawproperties - floatangle - - - - Simula una fotografía Polaroid. &imagick.method.available.0x632; - - - - - &reftitle.parameters; - - - - properties - - - Las propiedades de polaroid - - - - - angle - - - El ángulo de polaroid - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Un ejemplo de <function>Imagick::polaroidImage</function> - - Un ejemplo usando Imagick::polaroidImage() - - -polaroidImage(new ImagickDraw(), 25); - -/* Imprimir la imagen */ -header('Content-type: image/png'); -echo $imagen; - -?> -]]> - - - - - - - - - diff --git a/reference/imagick/imagick/posterizeimage.xml b/reference/imagick/imagick/posterizeimage.xml deleted file mode 100644 index d60d0ad486..0000000000 --- a/reference/imagick/imagick/posterizeimage.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - Imagick::posterizeImage - Reduce la imagen a un número limitado de niveles de color - - - - &reftitle.description; - - public boolImagick::posterizeImage - intlevels - booldither - - - Reduce la imagen a un número limitado de niveles de color. - - - - - &reftitle.parameters; - - - - levels - - - - - - - dither - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::posterizeImage</function> - - posterizeImage($numberLevels, $posterizeType); - $imagick->setImageFormat('png'); - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -posterizeImage($imagePath, \Imagick::DITHERMETHOD_RIEMERSMA, 8); - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/previewimages.xml b/reference/imagick/imagick/previewimages.xml deleted file mode 100644 index b3cc8a730e..0000000000 --- a/reference/imagick/imagick/previewimages.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - Imagick::previewImages - Precisa rápidamente los parámetros apropiados para el procesamiento de la imagen - - - - &reftitle.description; - - public boolImagick::previewImages - intpreview - - - Crea un mosaico de 9 miniaturas de la imagen especificada con la operación de proceso de - imágenes aplicada en varias intensidades. Esto es de útil para precisar - rápidamente un parámetro apropiado para una operación de proceso de imágenes. - - - - - &reftitle.parameters; - - - - preview - - - Tipo de previsualización. Véase constantes de tipos - de previsualización - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/previousimage.xml b/reference/imagick/imagick/previousimage.xml deleted file mode 100644 index 72b508ab35..0000000000 --- a/reference/imagick/imagick/previousimage.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - Imagick::previousImage - Pasa a la imagen anterior en una secuencia de imágenes - - - - &reftitle.description; - - public boolImagick::previousImage - - - - Pasa a la imagen anterior en una secuencia de imágenes Imagick. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/profileimage.xml b/reference/imagick/imagick/profileimage.xml deleted file mode 100644 index e7ee992e30..0000000000 --- a/reference/imagick/imagick/profileimage.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Imagick::profileImage - Añade o elimina un perfil de una imagen - - - - &reftitle.description; - - public boolImagick::profileImage - stringname - stringprofile - - - Añade o elimina un perfil ICC, IPTC, - o genérico de una imagen. - Si el profile es &null;, - se elimina de la imagen en lugar de añadirse. - - - Para eliminar todos los perfiles de la imagen, use '*' - como name y &null; para el - profile. - - - - - &reftitle.parameters; - - - - name - - - El nombre del perfil. - - - - - profile - - - Datos del perfil. - Si es &null;, el perfil especificado será eliminado. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - diff --git a/reference/imagick/imagick/quantizeimage.xml b/reference/imagick/imagick/quantizeimage.xml deleted file mode 100644 index cac37236af..0000000000 --- a/reference/imagick/imagick/quantizeimage.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - Imagick::quantizeImage - Analiza los colores dentro de una imagen de referencia - - - - &reftitle.description; - - public boolImagick::quantizeImage - intnumberColors - intcolorspace - inttreedepth - booldither - boolmeasureError - - - - - &reftitle.parameters; - - - - numberColors - - - - - - - colorspace - - - - - - - treedepth - - - - - - - dither - - - - - - - measureError - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::quantizeImage</function> - - quantizeImage($numberColors, $colorSpace, $treeDepth, $dither, false); - $imagick->setImageFormat('png'); - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/quantizeimages.xml b/reference/imagick/imagick/quantizeimages.xml deleted file mode 100644 index a9addf9fde..0000000000 --- a/reference/imagick/imagick/quantizeimages.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Imagick::quantizeImages - Analiza los colores dentro de una secuencia de imágenes - - - - &reftitle.description; - - public boolImagick::quantizeImages - intnumberColors - intcolorspace - inttreedepth - booldither - boolmeasureError - - - - - &reftitle.parameters; - - - - numberColors - - - - - - - colorspace - - - - - - - treedepth - - - - - - - dither - - - - - - - measureError - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/queryfontmetrics.xml b/reference/imagick/imagick/queryfontmetrics.xml deleted file mode 100644 index 41705d0d60..0000000000 --- a/reference/imagick/imagick/queryfontmetrics.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - Imagick::queryFontMetrics - Devuelve una matriz que representa las métricas de la fuente - - - - &reftitle.description; - - public arrayImagick::queryFontMetrics - ImagickDrawproperties - stringtext - boolmultiline - - - Devuelve un array multidimensional que representa las métricas de la fuente. - - - - - &reftitle.parameters; - - - - properties - - - Objeto ImagickDraw que contiene las propiedades de la fuente - - - - - text - - - El texto - - - - - multiline - - - Parámetro multilínea. Si se deja vacío se autodetecta - - - - - - - - - - &reftitle.returnvalues; - - Devuelve un array multidimensional que representa las métricas de la fuente. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Usar <function>Imagick::queryFontMetrics</function>: - - Preguntar por las métricas del texto y verter los resultados en la pantalla. - - -setFont('/path/to/font.ttf'); - -/* Verter las métricas de la fuente, autodetectado multilínea */ -var_dump($im->queryFontMetrics($draw, "¡Hola Mundo!")); -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/queryfonts.xml b/reference/imagick/imagick/queryfonts.xml deleted file mode 100644 index aa3de06c25..0000000000 --- a/reference/imagick/imagick/queryfonts.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - - Imagick::queryFonts - Devuelve la lista de fuentes configuradas - - - - &reftitle.description; - - public static arrayImagick::queryFonts - stringpattern"*" - - - Devuelve la lista de fuentes configuradas para Imagick. - - - - - &reftitle.parameters; - - - - pattern - - - El patrón de búsqueda - - - - - - - - - &reftitle.returnvalues; - - Devuelve un array que contiene las fuentes configuradas. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Ejemplo con <function>Imagick::queryFonts</function> - - "; - - $fontList = \Imagick::queryFonts("Helvetica*"); - - foreach ($fontList as $fontName) { - $output .= '
  • '. $fontName."
  • "; - } - - return $output; - -?> -]]> -
    -
    -
    -
    - -
    - - diff --git a/reference/imagick/imagick/queryformats.xml b/reference/imagick/imagick/queryformats.xml deleted file mode 100644 index 936f12e33c..0000000000 --- a/reference/imagick/imagick/queryformats.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - - Imagick::queryFormats - Devuelve los formatos soportados por Imagick - - - - &reftitle.description; - - public static arrayImagick::queryFormats - stringpattern"*" - - - Devuelve los formatos soportados por Imagick. - - - - - &reftitle.parameters; - - - - pattern - - - - - - - - - - - &reftitle.returnvalues; - - Devuelve un array que contiene los formatos soportados por Imagick. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Ejemplo con <function>Imagick::queryFormats</function> - -"; - - for ($i=0; $i < count($input); $i += $columns) { - $output .= ""; - for ($c=0; $c<$columns; $c++) { - $output .= ""; - if (($i + $c) < count($input)) { - $output .= $input[$i + $c]; - } - $output .= ""; - } - $output .= ""; - } - - $output .= ""; - - return $output; - } - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/radialblurimage.xml b/reference/imagick/imagick/radialblurimage.xml deleted file mode 100644 index 21a1b051d5..0000000000 --- a/reference/imagick/imagick/radialblurimage.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - Imagick::radialBlurImage - Hace borrosa de forma radial una imagen - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::radialBlurImage - floatangle - intchannelImagick::CHANNEL_DEFAULT - - - Hace borrosa de forma radial una imagen. - - - - - &reftitle.parameters; - - - - angle - - - - - - - channel - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::radialBlurImage</function> - - radialBlurImage(3); - $imagick->radialBlurImage(5); - $imagick->radialBlurImage(7); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/raiseimage.xml b/reference/imagick/imagick/raiseimage.xml deleted file mode 100644 index 86188d8726..0000000000 --- a/reference/imagick/imagick/raiseimage.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - Imagick::raiseImage - Crea un efecto de botón en 3D simulado - - - - &reftitle.description; - - public boolImagick::raiseImage - intwidth - intheight - intx - inty - boolraise - - - Crea un efecto de botón tridimensional simulado - aclarando y oscureciendo los bordes de la imagen. - Los miembros ancho y alto de la información de elevación definen el ancho - del borde vertical y horizontal del efecto. - - - - - &reftitle.parameters; - - - - width - - - - - - - height - - - - - - - x - - - - - - - y - - - - - - - raise - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::raiseImage</function> - - raiseImage($width, $height, $x, $y, $raise); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/randomthresholdimage.xml b/reference/imagick/imagick/randomthresholdimage.xml deleted file mode 100644 index 9118905cd7..0000000000 --- a/reference/imagick/imagick/randomthresholdimage.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - - Imagick::randomThresholdImage - Crea una imagen de alto contraste y dos colores - - - - &reftitle.description; - - public boolImagick::randomThresholdImage - floatlow - floathigh - intchannelImagick::CHANNEL_DEFAULT - - - - Cambia el valor de píxeles individuales basados en la - instensidad de cada píxel comparado con el umbral. El - resultado es una imagen de alto contraste y dos colores. &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - low - - - El punto bajo - - - - - high - - - El punto alto - - - - - channel - - - Proporcione cualquier constante de canal que sea válida para su modo de canal. Para - aplicar más de un canal, combine las constantes channeltype usando - operadores a nivel de bits. Consulte esta lista de - constantes de canal. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::randomThresholdImage</function> - - randomThresholdimage( - $lowThreshold * \Imagick::getQuantum(), - $highThreshold * \Imagick::getQuantum(), - $channel - ); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/readimage.xml b/reference/imagick/imagick/readimage.xml deleted file mode 100644 index 35c8c1928d..0000000000 --- a/reference/imagick/imagick/readimage.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Imagick::readImage - Lee una imagen desde un nombre de fichero - - - - &reftitle.description; - - public boolImagick::readImage - stringfilename - - - Lee una imagen desde un nombre de fichero - - - - - &reftitle.parameters; - - - - filename - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/readimageblob.xml b/reference/imagick/imagick/readimageblob.xml deleted file mode 100644 index 4ffa0b90c1..0000000000 --- a/reference/imagick/imagick/readimageblob.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - Imagick::readImageBlob - Lee una imagen desde un string binario - - - - &reftitle.description; - - public boolImagick::readImageBlob - stringimage - stringfilename - - - Lee una imagen desde un string binario - - - - - &reftitle.parameters; - - - - image - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::readImageBlob</function> - - readImageBlob($imageBlob); - - header("Content-Type: image/png"); - echo $imagick; -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/readimagefile.xml b/reference/imagick/imagick/readimagefile.xml deleted file mode 100644 index 6210f57e0e..0000000000 --- a/reference/imagick/imagick/readimagefile.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - Imagick::readImageFile - Lee una imagen desde un gestor de fichero abierto - - - - &reftitle.description; - - public boolImagick::readImageFile - resourcefilehandle - stringfileName&null; - - - Lee una imagen desde un gestor de fichero abierto - - - - - &reftitle.parameters; - - - - filehandle - - - - - - - fileName - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - diff --git a/reference/imagick/imagick/readimages.xml b/reference/imagick/imagick/readimages.xml deleted file mode 100644 index d2597b7843..0000000000 --- a/reference/imagick/imagick/readimages.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - Imagick::readImages - Lee una imagen a partir de un array de nombres de ficheros - - - - &reftitle.description; - - public boolImagick::readImages - arrayfilenames - - - Lee una imagen a partir de un array de nombres de ficheros. Todas las imágenes se almacenan en un solo objeto Imagick. - - - - - &reftitle.parameters; - - - filenames - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - diff --git a/reference/imagick/imagick/recolorimage.xml b/reference/imagick/imagick/recolorimage.xml deleted file mode 100644 index 8b4a09266a..0000000000 --- a/reference/imagick/imagick/recolorimage.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - - Imagick::recolorImage - Recolorear la imagen - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::recolorImage - arraymatrix - - - - Traduce, escala, recorta y rota los colores de la imagen. - Este método soporta matrices variables de escalado, pero normalmente, - se utiliza una matriz 5x5 para RGBA y una matriz 6x6 para CMYK. - La última línea debe contener los valores normalizados. - &imagick.method.available.0x636; - - - - - &reftitle.parameters; - - - - matrix - - - La matriz que contiene los valores de los colores. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Ejemplo con <function>Imagick::recolorImage</function> - -recolorImage($remapColor); - - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::displayImage - - - - - - - diff --git a/reference/imagick/imagick/reducenoiseimage.xml b/reference/imagick/imagick/reducenoiseimage.xml deleted file mode 100644 index abcc51444d..0000000000 --- a/reference/imagick/imagick/reducenoiseimage.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - Imagick::reduceNoiseImage - Suaviza los contornos de una imagen - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::reduceNoiseImage - floatradius - - - Suaviza los contornos de una imagen mientras que se preserva todavía la información del - borde. El algoritmo funciona reemplazando cada píxel con su - más cercano inmediato en valor. La zona inmediata está definida por el radio. - Use un radio de 0 y Imagick::reduceNoiseImage() seleccionará - una radio apropiado automáticamente. - - - - - &reftitle.parameters; - - - - radius - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::reduceNoiseImage</function> - - reduceNoiseImage($reduceNoise); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/remapimage.xml b/reference/imagick/imagick/remapimage.xml deleted file mode 100644 index 973514e000..0000000000 --- a/reference/imagick/imagick/remapimage.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - Imagick::remapImage - Re-mapea los colores de una imagen - - - - &reftitle.description; - - public boolImagick::remapImage - Imagickreplacement - intDITHER - - - Reemplaza los colores de una imagen con los definidos por el parámetro - replacement. Los colores son reemplazados con el color más cercano posible. - &imagick.method.available.0x645; - - - - - &reftitle.parameters; - - - - replacement - - - Un objeto Imagick que contiene los colores sustitutos - - - - - DITHER - - - Consulte esta lista de - constantes de métodos de entramado - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - diff --git a/reference/imagick/imagick/removeimage.xml b/reference/imagick/imagick/removeimage.xml deleted file mode 100644 index 0ae4585133..0000000000 --- a/reference/imagick/imagick/removeimage.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::removeImage - Elimina una imagen de la lista - - - - &reftitle.description; - - public boolImagick::removeImage - - - - Elimina una imagen de la lista. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/removeimageprofile.xml b/reference/imagick/imagick/removeimageprofile.xml deleted file mode 100644 index 55898ae9bb..0000000000 --- a/reference/imagick/imagick/removeimageprofile.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - Imagick::removeImageProfile - Elimina el perfil nominado de la imagen y lo devuelve - - - - &reftitle.description; - - public stringImagick::removeImageProfile - stringname - - - Elimina el perfil con nombre de la imagen y lo devuelve. - - - - - &reftitle.parameters; - - - - name - - - - - - - - - - - &reftitle.returnvalues; - - Devuelve un string que contiene el perfil de la imagen. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/render.xml b/reference/imagick/imagick/render.xml deleted file mode 100644 index 6eba1ce176..0000000000 --- a/reference/imagick/imagick/render.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - Imagick::render - Muestra todas las comandos de dibujo previas - - - - &reftitle.description; - - public boolImagick::render - - - - Muestra todas las comandos de dibujo previas. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/resampleimage.xml b/reference/imagick/imagick/resampleimage.xml deleted file mode 100644 index 0391a4c0ac..0000000000 --- a/reference/imagick/imagick/resampleimage.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - Imagick::resampleImage - Remuestrea la imagen a la resolución deseada - - - - &reftitle.description; - - public boolImagick::resampleImage - floatx_resolution - floaty_resolution - intfilter - floatblur - - - Remuestrea la imagen a la resolución deseada. - - - - - &reftitle.parameters; - - - - x_resolution - - - - - - - y_resolution - - - - - - - filter - - - - - - - blur - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::resampleImage</function> - - resampleImage(200, 200, \Imagick::FILTER_LANCZOS, 1); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/resetimagepage.xml b/reference/imagick/imagick/resetimagepage.xml deleted file mode 100644 index 96e2d8bbcb..0000000000 --- a/reference/imagick/imagick/resetimagepage.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - Imagick::resetImagePage - Reinicia una página de imagen - - - - &reftitle.description; - - public boolImagick::resetImagePage - stringpage - - - - La definición de página como un string. El string está en formato WxH+x+y (Ancho+Alto+x+y). - &imagick.method.available.0x636; - - - - - &reftitle.parameters; - - - - page - - - La definición de página. Por ejemplo 7168x5147+0+0 - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/resizeimage.xml b/reference/imagick/imagick/resizeimage.xml deleted file mode 100644 index 3c8f7e9ed5..0000000000 --- a/reference/imagick/imagick/resizeimage.xml +++ /dev/null @@ -1,192 +0,0 @@ - - - - - Imagick::resizeImage - Escala una imagen - - - - &reftitle.description; - - public boolImagick::resizeImage - intcolumns - introws - intfilter - floatblur - boolbestfit&false; - boollegacy&false; - - - Escala una imagen a las dimensiones deseadas con un - filtro. - - &imagick.bestfit.note; - - - - &reftitle.parameters; - - - - columns - - - Ancho de la imagen - - - - - rows - - - Alto de la imagen - - - - - filter - - - Consulte la lista de constantes de filtro. - - - - - blur - - - El factor de borrosidad donde > 1 es borroso, < 1 es nítido. - - - - - bestfit - - - Si se establece en &true; y las dimensiones proporcionadas son menores que las - dimensiones de la imagen, la imagen se reducirá para ajustarse dentro del cuadro - delimitador. Si se establece en &false; o si la imagen ya es más pequeña que el - cuadro delimitador, la imagen no se escalará. - - - - - legacy - - - El parámetro legacy fue añadido en PECL imagick 3.4.0. - Se realizaron cambios en el comportamiento de bestfit - cuando el parámetro legacy es &true;. - Consulte el registro de cambios para más información. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL imagick 3.4.0 - Se añadió el parámetro legacy. - - - PECL imagick 2.1.0 - - Añadido el parámetro opcional de ajuste. Este método ahora soporta escalas proporcionales. - Pase cero como parámetro para escalar proporcionalmente. - - - - - - - - - - - &reftitle.examples; - - - <function>Imagick::resizeImage</function> - - 1 is blurry, < 1 is sharp. - $imagick = new \Imagick(realpath($imagePath)); - - $imagick->resizeImage($width, $height, $filterType, $blur, $bestFit); - - $cropWidth = $imagick->getImageWidth(); - $cropHeight = $imagick->getImageHeight(); - - if ($cropZoom) { - $newWidth = $cropWidth / 2; - $newHeight = $cropHeight / 2; - - $imagick->cropimage( - $newWidth, - $newHeight, - ($cropWidth - $newWidth) / 2, - ($cropHeight - $newHeight) / 2 - ); - - $imagick->scaleimage( - $imagick->getImageWidth() * 4, - $imagick->getImageHeight() * 4 - ); - } - - - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/rollimage.xml b/reference/imagick/imagick/rollimage.xml deleted file mode 100644 index d5b54a5cf1..0000000000 --- a/reference/imagick/imagick/rollimage.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - Imagick::rollImage - Compensa una imagen - - - - &reftitle.description; - - public boolImagick::rollImage - intx - inty - - - Compensa una imagen como está definido por x e y. - - - - - &reftitle.parameters; - - - - x - - - El índice X. - - - - - y - - - El índice Y. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::rollImage</function> - - rollimage($rollX, $rollY); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/rotateimage.xml b/reference/imagick/imagick/rotateimage.xml deleted file mode 100644 index 7ea1459680..0000000000 --- a/reference/imagick/imagick/rotateimage.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - - Imagick::rotateImage - Rota una imagen - - - - &reftitle.description; - - public boolImagick::rotateImage - mixedbackground - floatdegrees - - - Rota una imagen el número de grados especificado. Los triángulos - vacíos sobrantes por la rotación de la imagen se rellenan - con el color de fondo. - - - - - &reftitle.parameters; - - - - background - - - El color de fondo - - - - - degrees - - - Ángulo de rotación, en grados. El ángulo de rotación se interpreta como el - número de grados a rotar la imagen en sentido de las agujas del reloj. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Ahora se permite que una string represente el color como primer parámetro. - Versiones anteriores sólo permitían un objeto ImagickPixel. - - - - - - - - - - - - &reftitle.examples; - - - <function>Imagick::rotateImage</function> - - rotateimage($color, $angle); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/rotationalblurimage.xml b/reference/imagick/imagick/rotationalblurimage.xml deleted file mode 100644 index 9bc7cdc069..0000000000 --- a/reference/imagick/imagick/rotationalblurimage.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - Imagick::rotationalBlurImage - Aplica un desenfoque rotacional a una imagen - - - - &reftitle.description; - - public boolImagick::rotationalBlurImage - floatangle - intchannelImagick::CHANNEL_DEFAULT - - - Aplica un desenfoque rotacional a una imagen. - - - - - &reftitle.parameters; - - - angle - - - El ángulo sobre el cual aplicar el desenfoque. - - - - - channel - - - &imagick.parameter.channel; - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - <function>Imagick::rotationalBlurImage</function> - - rotationalBlurImage(3); - $imagick->rotationalBlurImage(5); - $imagick->rotationalBlurImage(7); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - diff --git a/reference/imagick/imagick/roundcorners.xml b/reference/imagick/imagick/roundcorners.xml deleted file mode 100644 index d2add40eaa..0000000000 --- a/reference/imagick/imagick/roundcorners.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - - - Imagick::roundCorners - Redondea las esquinas de una imagen - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::roundCorners - floatx_rounding - floaty_rounding - floatstroke_width10 - floatdisplace5 - floatsize_correction-6 - - - Redondea las esquinas de una imagen. Los dos primeros argumentos controlan el - nivel de redondeo, y el tercero puede ser utilizado para afinar este proceso. - &imagick.method.available.0x629; - &imagick.method.not.available.0x700; - - - - - &reftitle.parameters; - - - - x_rounding - - - Redondeo en x - - - - - y_rounding - - - Redondeo en y - - - - - stroke_width - - - Ancho del trazo - - - - - displace - - - Desplazamiento de la imagen - - - - - size_correction - - - Corrección de tamaño - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Ejemplo con <function>Imagick::roundCorners</function>: - - Redondea las esquinas de una imagen. - - -newPseudoImage(100, 100, "magick:rose"); -$image->setImageFormat("png"); - -$image->roundCorners(5,3); -$image->writeImage("rounded.png"); -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/sampleimage.xml b/reference/imagick/imagick/sampleimage.xml deleted file mode 100644 index 4a194eba72..0000000000 --- a/reference/imagick/imagick/sampleimage.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Imagick::sampleImage - Escala una imagen con un muestreo de píxeles - - - - &reftitle.description; - - public boolImagick::sampleImage - intcolumns - introws - - - Escala una imagen a las dimensiones deseadas con un muestreo de píxeles. - A diferencia de otros métodos de escala, este método no introduce - colores adicionales en la imagen escalada. - - - - - &reftitle.parameters; - - - - columns - - - - - - - rows - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/scaleimage.xml b/reference/imagick/imagick/scaleimage.xml deleted file mode 100644 index 1add93d376..0000000000 --- a/reference/imagick/imagick/scaleimage.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Imagick::scaleImage - Redimensiona la imagen a una escala específica - - - - &reftitle.description; - - public boolImagick::scaleImage - intcolumns - introws - boolbestfit&false; - boollegacy&false; - - - Redimensiona la imagen a las dimensiones especificadas. En caso de que alguno de los parámetros sea igual a 0, este será calculado automáticamente. - - &imagick.bestfit.note; - - - - &reftitle.parameters; - - - - columns - - - El ancho de la imagen escalada. - - - - - rows - - - El alto de la imagen escalada. - - - - - bestfit - - - Si se establece en &true; y las dimensiones proporcionadas son menores que las - dimensiones de la imagen, la imagen se reducirá para ajustarse dentro del cuadro - delimitador. Si se establece en &false; o si la imagen ya es más pequeña que el - cuadro delimitador, la imagen no se escalará. - - - - - legacy - - - El parámetro legacy fue añadido en PECL imagick 3.4.0. - Se realizaron cambios en el comportamiento de bestfit - cuando el parámetro legacy es &true;. - Consulte el registro de cambios para más información. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL imagick 3.4.0 - Se añadió el parámetro legacy. - - - PECL imagick 2.1.0 - - Se añadió un parámetro opcional de ajuste. Este método soporta ahora el redimensionamiento proporcional. Pase cero en uno de los parámetros para activar esta opción. - - - - - - - - - &reftitle.examples; - - - Ejemplo con <function>Imagick::scaleImage</function> - -scaleImage(150, 150, true); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/segmentimage.xml b/reference/imagick/imagick/segmentimage.xml deleted file mode 100644 index d39ecd0c77..0000000000 --- a/reference/imagick/imagick/segmentimage.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - - - Imagick::segmentImage - Segmenta una imagen - - - - &reftitle.description; - - public boolImagick::segmentImage - intCOLORSPACE - floatcluster_threshold - floatsmooth_threshold - boolverbose&false; - - - Analiza la imagen e identifica las unidades similares. - &imagick.method.available.0x645; - - - - - &reftitle.parameters; - - - - COLORSPACE - - - Una constante entre las constantes COLORSPACE. - - - - - cluster_threshold - - - Un porcentaje que describe el número mínimo de píxeles - contenidos en el hexedro antes de que sea considerado - válido. - - - - - smooth_threshold - - - Elimina el ruido del histograma. - - - - - verbose - - - Si se deben o no mostrar las informaciones detalladas - sobre el reconocimiento de las clases. - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - - Ejemplo con <function>Imagick::segmentImage</function> - -segmentImage($colorSpace, $clusterThreshold, $smoothThreshold); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -segmentImage($imagePath, \Imagick::COLORSPACE_RGB, 5, 5); - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/selectiveblurimage.xml b/reference/imagick/imagick/selectiveblurimage.xml deleted file mode 100644 index 0c4b70b8d5..0000000000 --- a/reference/imagick/imagick/selectiveblurimage.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - Imagick::selectiveBlurImage - Desenfoca selectivamente una imagen dentro de un umbral de contraste - - - - &reftitle.description; - - public boolImagick::selectiveBlurImage - floatradius - floatsigma - floatthreshold - intchannelImagick::CHANNEL_DEFAULT - - - Desenfoca selectivamente una imagen dentro de un umbral de contraste. Es similar al filtro de desenfoque que acentúa todo con un contraste superior a un cierto umbral. - - - - - &reftitle.parameters; - - - radius - - - - - - - sigma - - - - - - - threshold - - - - - - - channel - - - &imagick.parameter.channel; - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - <function>Imagick::selectiveBlurImage</function> - - selectiveBlurImage($radius, $sigma, $threshold, $channel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/separateimagechannel.xml b/reference/imagick/imagick/separateimagechannel.xml deleted file mode 100644 index 84e044644d..0000000000 --- a/reference/imagick/imagick/separateimagechannel.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - Imagick::separateImageChannel - Separa un canal de la imagen - - - - &reftitle.description; - - public boolImagick::separateImageChannel - intchannel - - - Separa un canal de la imagen y devuelve una imagen en escala de grises. Un canal - es un componente de color en particular de cada píxel de la imagen. - - - - - &reftitle.parameters; - - - - channel - - - Qué 'canal' devolver. Para espacios de color distintos del RGB, aún se pueden utilizar las constantes CHANNEL_RED, CHANNEL_GREEN, CHANNEL_BLUE para indicar el primer, segundo y tercer canal. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::separateImageChannel</function> - - separateimagechannel($channel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -separateImageChannel($imagePath, \Imagick::CHANNEL_GREEN); - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/sepiatoneimage.xml b/reference/imagick/imagick/sepiatoneimage.xml deleted file mode 100644 index aad03367ce..0000000000 --- a/reference/imagick/imagick/sepiatoneimage.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - Imagick::sepiaToneImage - Pone una imagen en tono sepia - - - - &reftitle.description; - - public boolImagick::sepiaToneImage - floatthreshold - - - Aplica un efecto especial a la imagen, similar al efecto logrado - en un cuarto oscuro fotográfico aplicando un tono sepia. El umbral tiene un rango desde 0 - hasta el de QuantumRange y es una medida de la extensión del tono sepia. Un - umbral de 80 es un buen punto de partida para un tono razonable. - - - - - &reftitle.parameters; - - - - threshold - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::sepiaToneImage</function> - - sepiaToneImage($sepia); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setbackgroundcolor.xml b/reference/imagick/imagick/setbackgroundcolor.xml deleted file mode 100644 index f873c67bf7..0000000000 --- a/reference/imagick/imagick/setbackgroundcolor.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - Imagick::setBackgroundColor - Establece el color de fondo por omisión del objeto - - - - &reftitle.description; - - public boolImagick::setBackgroundColor - mixedbackground - - - Establece el color de fondo por omisión del objeto. - - - - - &reftitle.parameters; - - - - background - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Ahora se permite que un string represente el color como un parámetro. - Las versiones anteriores sólo permiten un objeto ImagickPixel. - - - - - - - - - - - diff --git a/reference/imagick/imagick/setcolorspace.xml b/reference/imagick/imagick/setcolorspace.xml deleted file mode 100644 index 1afed8fbec..0000000000 --- a/reference/imagick/imagick/setcolorspace.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Imagick::setColorspace - Establecer el espacio de color - - - - &reftitle.description; - - public boolImagick::setColorspace - intCOLORSPACE - - - Establece el valor del espacio de color global para el objeto. - &imagick.method.available.0x657; - - - - - &reftitle.parameters; - - - - COLORSPACE - - - Una de las constantes COLORSPACE - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setcompression.xml b/reference/imagick/imagick/setcompression.xml deleted file mode 100644 index d00922b7fd..0000000000 --- a/reference/imagick/imagick/setcompression.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - Imagick::setCompression - Configura el tipo de compresión del objeto - - - - &reftitle.description; - - public boolImagick::setCompression - intcompression - - - Configura el tipo de compresión del objeto. - - - - - &reftitle.parameters; - - - - compression - - - El tipo de compresión. Ver las constantes Imagick::COMPRESSION_*. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setcompressionquality.xml b/reference/imagick/imagick/setcompressionquality.xml deleted file mode 100644 index c9ac109464..0000000000 --- a/reference/imagick/imagick/setcompressionquality.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - - Imagick::setCompressionQuality - Configura la compresión por defecto del objeto - - - - &reftitle.description; - - public boolImagick::setCompressionQuality - intquality - - - Configura la compresión por defecto del objeto. - - - - Este método solo funciona con nuevas imágenes, es decir, - aquellas creadas con el método Imagick::newPseudoImage. Para imágenes - existentes, debería utilizarse el método - Imagick::setImageCompressionQuality. - - - - - - &reftitle.parameters; - - - - quality - - - Un &integer; entre 1 y 100, 1 = compresión alta, 100 compresión baja. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Ejemplo con <function>Imagick::setCompressionQuality</function> - -setCompressionQuality($quality); - $imagick->newPseudoImage( - $backgroundImagick->getImageWidth(), - $backgroundImagick->getImageHeight(), - 'canvas:white' - ); - - $imagick->compositeImage( - $backgroundImagick, - \Imagick::COMPOSITE_ATOP, - 0, - 0 - ); - - $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 deleted file mode 100644 index bdf68e8aeb..0000000000 --- a/reference/imagick/imagick/setfilename.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Imagick::setFilename - Establece el nombre de archivo antes de que se lea o escriba una imagen - - - - &reftitle.description; - - public boolImagick::setFilename - stringfilename - - - Establece el nombre de fichero antes de que se lea o escriba un fichero de imagen. - - - - - &reftitle.parameters; - - - - filename - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setfirstiterator.xml b/reference/imagick/imagick/setfirstiterator.xml deleted file mode 100644 index e8018ead4f..0000000000 --- a/reference/imagick/imagick/setfirstiterator.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - Imagick::setFirstIterator - Coloca el iterador de Imagick en la primera imagen - - - - &reftitle.description; - - public boolImagick::setFirstIterator - - - - Coloca el iterador de Imagick en la primera imagen. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setfont.xml b/reference/imagick/imagick/setfont.xml deleted file mode 100644 index c00afe61a7..0000000000 --- a/reference/imagick/imagick/setfont.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - - Imagick::setFont - Configura la fuente - - - - &reftitle.description; - - public boolImagick::setFont - stringfont - - - Configura la fuente de la imagen. Este método se utiliza para configurar - la fuente utilizada por el pseudoformato : caption. La fuente - debe estar configurada en la configuración de ImageMagick o bien, un fichero - con el nombre de la fuente font debe existir. Este método no debe confundirse con el método - ImagickDraw::setFont que define la fuente para un objeto - ImagickDraw específico. - &imagick.method.available.0x637; - - - - - &reftitle.parameters; - - - - font - - - El nombre de la fuente o el nombre del fichero - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Ejemplo con <function>Imagick::setFont</function> - - Ejemplo de utilización de Imagick::setFont. - - -setFont("example.ttf"); - -/* Crea un nuevo mensaje */ -$im->newPseudoImage(100, 100, "caption:Hello"); - -/* Continuación del procesamiento de la imagen */ -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::getFont - ImagickDraw::setFont - ImagickDraw::getFont - - - - - - - diff --git a/reference/imagick/imagick/setformat.xml b/reference/imagick/imagick/setformat.xml deleted file mode 100644 index f4ffb93f70..0000000000 --- a/reference/imagick/imagick/setformat.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Imagick::setFormat - Establece el formato del objeto Imagick - - - - &reftitle.description; - - public boolImagick::setFormat - stringformat - - - Establece el formato del objeto Imagick. - - - - - &reftitle.parameters; - - - - format - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setgravity.xml b/reference/imagick/imagick/setgravity.xml deleted file mode 100644 index bd08880a7f..0000000000 --- a/reference/imagick/imagick/setgravity.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - Imagick::setGravity - Establece la gravedad - - - - &reftitle.description; - - public boolImagick::setGravity - intgravity - - - - Establece la propiedad gravedad global para el objeto Imagick. - &imagick.method.available.0x640; - - - - - &reftitle.parameters; - - - - gravity - - - La propiedad gravedad. Consulte esta lista de - constantes de gravedad. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagick/setimage.xml b/reference/imagick/imagick/setimage.xml deleted file mode 100644 index f4ec4fedbf..0000000000 --- a/reference/imagick/imagick/setimage.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Imagick::setImage - Reemplaza una imagen en el objeto - - - - &reftitle.description; - - public boolImagick::setImage - Imagickreplace - - - Reemplaza la secuencia de imágenes actual por la imagen del objeto sustituto. - - - - - &reftitle.parameters; - - - - replace - - - El objeto Imagick sustituto. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Un ejemplo de <function>Imagick::setImage</function> - - Un ejemplo usando Imagick::setImage() - - -setImage($sustituto); - -/* imprimir la imagen */ -header('Content-type: image/jpeg'); -echo $imagen; - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setimagealphachannel.xml b/reference/imagick/imagick/setimagealphachannel.xml deleted file mode 100644 index f933b4f508..0000000000 --- a/reference/imagick/imagick/setimagealphachannel.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - - Imagick::setImageAlphaChannel - Define el canal alfa de la imagen - - - - &reftitle.description; - - public boolImagick::setImageAlphaChannel - intmode - - - Activa o desactiva el canal alfa de la imagen. El mode - es una de las constantes Imagick::ALPHACHANNEL_*. - &imagick.method.available.0x638; - - - - - &reftitle.parameters; - - - - mode - - - Una constante entre las constantes Imagick::ALPHACHANNEL_*. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.seealso; - - - Imagick::setImageMatte - Las constantes del canal Alfa Imagick - - - - - - - diff --git a/reference/imagick/imagick/setimageartifact.xml b/reference/imagick/imagick/setimageartifact.xml deleted file mode 100644 index a88236a231..0000000000 --- a/reference/imagick/imagick/setimageartifact.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - - Imagick::setImageArtifact - Define el artefacto de la imagen - - - - &reftitle.description; - - public boolImagick::setImageArtifact - stringartifact - stringvalue - - - Asocia un artefacto con la imagen. La diferencia entre las propiedades de la imagen - y el artefacto de la imagen es que las propiedades son públicas mientras que los - artefactos son privados. - &imagick.method.available.0x657; - - - - - &reftitle.parameters; - - - - artifact - - - El nombre del artefacto. - - - - - value - - - El valor del artefacto. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Ejemplo con <function>Imagick::setImageArtifact</function> - -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(); -} - -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::getImageArtifact - Imagick::deleteImageArtifact - - - - - - - diff --git a/reference/imagick/imagick/setimageattribute.xml b/reference/imagick/imagick/setimageattribute.xml deleted file mode 100644 index 18e07d1bab..0000000000 --- a/reference/imagick/imagick/setimageattribute.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - Imagick::setImageAttribute - Define un atributo de imagen - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::setImageAttribute - stringkey - stringvalue - - - Define un atributo de imagen. - - - - - - &reftitle.parameters; - - - key - - - - - - - - value - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setimagebackgroundcolor.xml b/reference/imagick/imagick/setimagebackgroundcolor.xml deleted file mode 100644 index 85fde001b0..0000000000 --- a/reference/imagick/imagick/setimagebackgroundcolor.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - Imagick::setImageBackgroundColor - Establece el color de fondo de la imagen - - - - &reftitle.description; - - public boolImagick::setImageBackgroundColor - mixedbackground - - - Establece el color de fondo de la imagen. - - - - - &reftitle.parameters; - - - - background - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Ahora se permite que un string represente el color como un parámetro. - Versiones anteriores sólo permitían un objeto ImagickPixel. - - - - - - - - - - - diff --git a/reference/imagick/imagick/setimagebias.xml b/reference/imagick/imagick/setimagebias.xml deleted file mode 100644 index e2258de80a..0000000000 --- a/reference/imagick/imagick/setimagebias.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - Imagick::setImageBias - Establece el sesgo de la imagen para cualquier método que convolucione una imagen - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::setImageBias - floatbias - - - Establece el sesgo de la imagen para cualquier método que convolucione una imagen (p.ej. Imagick::ConvolveImage()). - - - - - &reftitle.parameters; - - - - bias - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::setImageBias</function> - -setImageBias($bias * \Imagick::getQuantum()); - $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 deleted file mode 100644 index 70c9a5c2b8..0000000000 --- a/reference/imagick/imagick/setimagebiasquantum.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - Imagick::setImageBiasQuantum - Establece el sesgo de la imagen - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public voidImagick::setImageBiasQuantum - floatbias - - - Establece el sesgo de la imagen. El sesgo debe ser escalado con 0 (sin ajuste) a 1 (valor cuántico). - - - - - - &reftitle.parameters; - - - bias - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/imagick/imagick/setimageblueprimary.xml b/reference/imagick/imagick/setimageblueprimary.xml deleted file mode 100644 index a5e85fe1d9..0000000000 --- a/reference/imagick/imagick/setimageblueprimary.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Imagick::setImageBluePrimary - Establece el punto primario azul de la cromaticidad de la imagen - - - - &reftitle.description; - - public boolImagick::setImageBluePrimary - floatx - floaty - - - Establece el punto primario azul de la cromaticidad de la imagen. - - - - - &reftitle.parameters; - - - - x - - - - - - - y - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimagebordercolor.xml b/reference/imagick/imagick/setimagebordercolor.xml deleted file mode 100644 index caaf0378ea..0000000000 --- a/reference/imagick/imagick/setimagebordercolor.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - Imagick::setImageBorderColor - Establece el color de borde de la imagen - - - - &reftitle.description; - - public boolImagick::setImageBorderColor - mixedborder - - - Establece el color de borde de la imagen. - - - - - &reftitle.parameters; - - - - border - - - El color de borde - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Ahora se permite que un string represente el color como parámetro. - Versiones anteriores sólo permitían un objeto ImagickPixel. - - - - - - - - - - - diff --git a/reference/imagick/imagick/setimagechanneldepth.xml b/reference/imagick/imagick/setimagechanneldepth.xml deleted file mode 100644 index b4948cc00d..0000000000 --- a/reference/imagick/imagick/setimagechanneldepth.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Imagick::setImageChannelDepth - Establece la profundidad de una canal de imagen en particular - - - - &reftitle.description; - - public boolImagick::setImageChannelDepth - intchannel - intdepth - - - Establece la profundidad de una canal de imagen en particular. - - - - - &reftitle.parameters; - - - - channel - - - - - - - depth - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimageclipmask.xml b/reference/imagick/imagick/setimageclipmask.xml deleted file mode 100644 index 74d6263a9b..0000000000 --- a/reference/imagick/imagick/setimageclipmask.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - - Imagick::setImageClipMask - Establece la máscara de recorte de una imagen - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::setImageClipMask - Imagickclip_mask - - - - Establece la máscara de recorte de una imagen desde otro objeto Imagick. - &imagick.method.available.0x636; - - - - - &reftitle.parameters; - - - - clip_mask - - - El objeto Imagick que contiene la máscara de recorte - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::setImageClipMask</function> - -readImage(realpath($imagePath)); - - $width = $imagick->getImageWidth(); - $height = $imagick->getImageHeight(); - - $clipMask = new \Imagick(); - $clipMask->newPseudoImage( - $width, - $height, - "canvas:transparent" - ); - - $draw = new \ImagickDraw(); - $draw->setFillColor('white'); - $draw->circle( - $width / 2, - $height / 2, - ($width / 2) + ($width / 4), - $height / 2 - ); - $clipMask->drawImage($draw); - $imagick->setImageClipMask($clipMask); - - $imagick->negateImage(false); - $imagick->setFormat("png"); - - header("Content-Type: image/png"); - echo $imagick->getImagesBlob(); - -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setimagecolormapcolor.xml b/reference/imagick/imagick/setimagecolormapcolor.xml deleted file mode 100644 index 68bc321fa8..0000000000 --- a/reference/imagick/imagick/setimagecolormapcolor.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Imagick::setImageColormapColor - Establece el color de un índice de mapa de color especificado - - - - &reftitle.description; - - public boolImagick::setImageColormapColor - intindex - ImagickPixelcolor - - - Establece el color de un índice de mapa de color especificado. - - - - - &reftitle.parameters; - - - - index - - - - - - - color - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimagecolorspace.xml b/reference/imagick/imagick/setimagecolorspace.xml deleted file mode 100644 index c81c7f10be..0000000000 --- a/reference/imagick/imagick/setimagecolorspace.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - Imagick::setImageColorspace - Establece el espacio de color de una imagen - - - - &reftitle.description; - - public boolImagick::setImageColorspace - intcolorspace - - - Establece el espacio de color de una imagen. Este método debería emplearse al crear imágenes nuevas. Para cambiar el espacio de color de una imagen existente se debería utilizar Imagick::transformImageColorspace. - - - - - &reftitle.parameters; - - - - colorspace - - - Una de las constantes COLORSPACE - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimagecompose.xml b/reference/imagick/imagick/setimagecompose.xml deleted file mode 100644 index 99ad5a79b2..0000000000 --- a/reference/imagick/imagick/setimagecompose.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Imagick::setImageCompose - Establece el operador de composción de una imagen - - - - &reftitle.description; - - public boolImagick::setImageCompose - intcompose - - - Establece el operador de composción de una imagen, útil para especificar cómo - componer la miniatura de la imagen cuando se usa el método - Imagick::montageImage(). - - - - - &reftitle.parameters; - - - - compose - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimagecompression.xml b/reference/imagick/imagick/setimagecompression.xml deleted file mode 100644 index bbabf90b3f..0000000000 --- a/reference/imagick/imagick/setimagecompression.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - Imagick::setImageCompression - Establece la compresión de una imagen - - - - &reftitle.description; - - public boolImagick::setImageCompression - intcompression - - - - - - - &reftitle.parameters; - - - - compression - - - Una de las constantes COMPRESSION - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimagecompressionquality.xml b/reference/imagick/imagick/setimagecompressionquality.xml deleted file mode 100644 index fb77de78f3..0000000000 --- a/reference/imagick/imagick/setimagecompressionquality.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - Imagick::setImageCompressionQuality - Establece la calidad de compresión de una imagen - - - - &reftitle.description; - - public boolImagick::setImageCompressionQuality - intquality - - - Establece la calidad de compresión de una imagen. - - - - - &reftitle.parameters; - - - - quality - - - La calidad de compresión de la imagen como un integer - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::setImageCompressionQuality</function> - - setImageCompressionQuality($quality); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setimagedelay.xml b/reference/imagick/imagick/setimagedelay.xml deleted file mode 100644 index f1d4cf1a5f..0000000000 --- a/reference/imagick/imagick/setimagedelay.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - Imagick::setImageDelay - Establece el retardo de una imagen - - - - &reftitle.description; - - public boolImagick::setImageDelay - intdelay - - - Establece el retardo de una imagen. Para una imagen animada, esto es la cantidad de - tiempo que debería mostrarse este marco de la imagen, antes de mostrar el siguiente - marco. - - - El retardo se puede establecer individualmente para cada marco de una imagen. - - - - - &reftitle.parameters; - - - - delay - - - La cantidad de tiempo expresado en 'ticks' que debería mostrarse - la imagen. Para GIFs animados son 100 ticks por segundo, por lo que un - valor de 20 sería 20/100 de un segundo, es decir 1/5 de un segundo. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Modificar un GIF animado con <function>Imagick::setImageDelay</function> - -coalesceImages(); - -$numMarcos = 0; - -foreach ($imagick as $marco) { - $imagick->setImageDelay((($numMarcos % 11) * 5)); - $numMarcos++; -} - -$imagick = $imagick->deconstructImages(); - -$imagick->writeImages("/ruta/donde/guardar/output.gif", true); - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setimagedepth.xml b/reference/imagick/imagick/setimagedepth.xml deleted file mode 100644 index 26ef8b77bb..0000000000 --- a/reference/imagick/imagick/setimagedepth.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - Imagick::setImageDepth - Establece la profundidad de una imagen - - - - &reftitle.description; - - public boolImagick::setImageDepth - intdepth - - - Establece la profundidad de una imagen. - - - - - &reftitle.parameters; - - - - depth - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimagedispose.xml b/reference/imagick/imagick/setimagedispose.xml deleted file mode 100644 index 40e9944310..0000000000 --- a/reference/imagick/imagick/setimagedispose.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - Imagick::setImageDispose - Establece el método de disposición de una imagen - - - - &reftitle.description; - - public boolImagick::setImageDispose - intdispose - - - Establece el método de disposición de una imagen. - - - - - &reftitle.parameters; - - - - dispose - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimageextent.xml b/reference/imagick/imagick/setimageextent.xml deleted file mode 100644 index e3239db18c..0000000000 --- a/reference/imagick/imagick/setimageextent.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Imagick::setImageExtent - Establece el tamaño de una imagen - - - - &reftitle.description; - - public boolImagick::setImageExtent - intcolumns - introws - - - Establece el tamaño de una imagen (p.ej. columnas y filas). - - - - - &reftitle.parameters; - - - - columns - - - - - - - rows - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimagefilename.xml b/reference/imagick/imagick/setimagefilename.xml deleted file mode 100644 index 52d9ab1bc2..0000000000 --- a/reference/imagick/imagick/setimagefilename.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - Imagick::setImageFilename - Establece el nombre de archivo de una imagen en particular - - - - &reftitle.description; - - public boolImagick::setImageFilename - stringfilename - - - Establece el nombre de fichero de una imagen en particular en una secuencia. - - - - - &reftitle.parameters; - - - - filename - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimageformat.xml b/reference/imagick/imagick/setimageformat.xml deleted file mode 100644 index 0e3b37ba80..0000000000 --- a/reference/imagick/imagick/setimageformat.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - Imagick::setImageFormat - Establece el formato de una imagen en particular - - - - &reftitle.description; - - public boolImagick::setImageFormat - stringformat - - - Establece el formato de una imagen en particular en una secuencia. - - - - - &reftitle.parameters; - - - - format - - - La representación string de un formato de imagen. Los formatos soportados - dependen de la instalación de ImageMagick. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setimagegamma.xml b/reference/imagick/imagick/setimagegamma.xml deleted file mode 100644 index 179030083d..0000000000 --- a/reference/imagick/imagick/setimagegamma.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - Imagick::setImageGamma - Establece el valor gamma de la imagen - - - - &reftitle.description; - - public boolImagick::setImageGamma - floatgamma - - - Establece el valor gamma de la imagen. - - - - - &reftitle.parameters; - - - - gamma - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimagegravity.xml b/reference/imagick/imagick/setimagegravity.xml deleted file mode 100644 index f1fdd26c20..0000000000 --- a/reference/imagick/imagick/setimagegravity.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - Imagick::setImageGravity - Establece la gravedad de la imagen - - - - &reftitle.description; - - public boolImagick::setImageGravity - intgravity - - - - Establece la propiedad gravedad de la imagen actual. Este método se puede usar - para establecer la propiedad gravedad de una sóla secuencia de imágenes. - &imagick.method.available.0x644; - - - - - &reftitle.parameters; - - - - gravity - - - La propiedad gravedad. Consulte esta lista de - constantes de gravedad. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagick/setimagegreenprimary.xml b/reference/imagick/imagick/setimagegreenprimary.xml deleted file mode 100644 index b17b0bc18e..0000000000 --- a/reference/imagick/imagick/setimagegreenprimary.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Imagick::setImageGreenPrimary - Establece el punto primario verde de la cromaticidad de la imagen - - - - &reftitle.description; - - public boolImagick::setImageGreenPrimary - floatx - floaty - - - Establece el punto primario verde de la cromaticidad de la imagen. - - - - - &reftitle.parameters; - - - - x - - - - - - - y - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimageindex.xml b/reference/imagick/imagick/setimageindex.xml deleted file mode 100644 index 6cd23734e9..0000000000 --- a/reference/imagick/imagick/setimageindex.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - Imagick::setImageIndex - Establece la posición del iterador - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::setImageIndex - intindex - - - Establece la posición del iterador en la lista de imágenes especificada con el parámetro - index. - - - Este método ha quedado obsoleto. Véase - Imagick::setIteratorIndex. - - - - - &reftitle.parameters; - - - - index - - - La posición donde se va a establecer el iterador - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimageinterlacescheme.xml b/reference/imagick/imagick/setimageinterlacescheme.xml deleted file mode 100644 index 2e1c511131..0000000000 --- a/reference/imagick/imagick/setimageinterlacescheme.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - Imagick::setImageInterlaceScheme - Establece la compresión de la imagen - - - - &reftitle.description; - - public boolImagick::setImageInterlaceScheme - intinterlace_scheme - - - Establece la compresión de la imagen. - - - - - &reftitle.parameters; - - - - interlace_scheme - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimageinterpolatemethod.xml b/reference/imagick/imagick/setimageinterpolatemethod.xml deleted file mode 100644 index 0ca3109fa0..0000000000 --- a/reference/imagick/imagick/setimageinterpolatemethod.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - Imagick::setImageInterpolateMethod - Configura el método de interpolación de la imagen - - - - &reftitle.description; - - public boolImagick::setImageInterpolateMethod - intmethod - - - Configura el método de interpolación de la imagen. - - - - - &reftitle.parameters; - - - - method - - - Una constante Imagick::INTERPOLATE_*. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setimageiterations.xml b/reference/imagick/imagick/setimageiterations.xml deleted file mode 100644 index fa065806ae..0000000000 --- a/reference/imagick/imagick/setimageiterations.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - Imagick::setImageIterations - Establece las iteraciones de una imagen - - - - &reftitle.description; - - public boolImagick::setImageIterations - intiterations - - - Establece el número de veces que una imagen animada se repite. - - - - - &reftitle.parameters; - - - - iterations - - - El número de veces que la imagen debería mostrarse en bucle. Establecer a '0' para - un bucle infinito. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Uso básico de <function>Imagick::setImageIterations</function> - -coalesceImages(); -$imagick->setImageIterations(1); -$imagick = $imagick->deconstructImages(); - -$imagick->writeImages('/ruta/donde/guardar/UnaVez.gif', true); - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setimagematte.xml b/reference/imagick/imagick/setimagematte.xml deleted file mode 100644 index 6b41d7be2f..0000000000 --- a/reference/imagick/imagick/setimagematte.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - Imagick::setImageMatte - Establece el canal mate de la imagen - - - - &reftitle.description; - - public boolImagick::setImageMatte - boolmatte - - - - Establece el canal mate de la imagen. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - matte - - - Si es true activa el canal mate y si es false lo deshabilita. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setimagemattecolor.xml b/reference/imagick/imagick/setimagemattecolor.xml deleted file mode 100644 index 2c4a2f445d..0000000000 --- a/reference/imagick/imagick/setimagemattecolor.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Imagick::setImageMatteColor - Establece el color mate de la imagen - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::setImageMatteColor - mixedmatte - - - Establece el color mate de la imagen. - - - - - &reftitle.parameters; - - - - matte - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Ahora se permite que un string represente el color como parámetro. - Versiones anteriores sólo permitían un objeto ImagickPixel. - - - - - - - - - - - diff --git a/reference/imagick/imagick/setimageopacity.xml b/reference/imagick/imagick/setimageopacity.xml deleted file mode 100644 index 98767ead38..0000000000 --- a/reference/imagick/imagick/setimageopacity.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - Imagick::setImageOpacity - Establece el nivel de opacidad de la imagen - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public boolImagick::setImageOpacity - floatopacity - - - - Establece el nivel de opacidad de la imagen. &imagick.method.available.0x631; - Este método opera en todos los canales, lo que significa que, por ejemplo, un valor de la opacidad - de 0.5 establecerá todas las áreas transparentes a parcialmente opacas. Para añadir transparencia a - áreas que no lo son ya, use Imagick::evaluateImage() - - - - - &reftitle.parameters; - - - - opacity - - - El nivel de transpariencia: 1.0 es completamente opaco y 0.0 es completamente - transparente. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Un ejemplo de <function>Imagick::setImageOpacity</function> - - Un ejemplo usando Imagick::setImageOpacity() - - -setImageOpacity(0.7); - -/* Mostrar la imagen */ -header('Content-type: image/png'); -echo $imagen; - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setimageorientation.xml b/reference/imagick/imagick/setimageorientation.xml deleted file mode 100644 index 5f0e06fd6f..0000000000 --- a/reference/imagick/imagick/setimageorientation.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - Imagick::setImageOrientation - Establece la orientación de la imagen - - - - &reftitle.description; - - public boolImagick::setImageOrientation - intorientation - - - - Establece la orientación de la imagen. - - - - - &reftitle.parameters; - - - - orientation - - - Una de las constantes de orientación - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::setImageOrientation</function> - - setImageOrientation($orientationType); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setimagepage.xml b/reference/imagick/imagick/setimagepage.xml deleted file mode 100644 index 10d6049757..0000000000 --- a/reference/imagick/imagick/setimagepage.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - Imagick::setImagePage - Establece la geometría de la página de la imagen - - - - &reftitle.description; - - public boolImagick::setImagePage - intwidth - intheight - intx - inty - - - Establece la geometría de la página de la imagen. - - - - - &reftitle.parameters; - - - - width - - - - - - - height - - - - - - - x - - - - - - - y - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimageprofile.xml b/reference/imagick/imagick/setimageprofile.xml deleted file mode 100644 index 3c347e8acc..0000000000 --- a/reference/imagick/imagick/setimageprofile.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - Imagick::setImageProfile - Añade un perfil nominado al objeto Imagick - - - - &reftitle.description; - - public boolImagick::setImageProfile - stringname - stringprofile - - - Añade un perfil nominado al objeto Imagick. Si un perfil - con el mismo nobre ya existe, se reemplaza. Este - método difiere del método Imagick::ProfileImage() en - que no aplica ningún perfil de color CMS. - - - - - &reftitle.parameters; - - - - name - - - - - - - profile - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimageproperty.xml b/reference/imagick/imagick/setimageproperty.xml deleted file mode 100644 index d7323b5542..0000000000 --- a/reference/imagick/imagick/setimageproperty.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - - Imagick::setImageProperty - Configura una propiedad de imagen - - - - &reftitle.description; - - public boolImagick::setImageProperty - stringname - stringvalue - - - Configura la propiedad de imagen name al valor - value. - &imagick.method.available.0x632; - - - - - &reftitle.parameters; - - - - name - - - - - - - value - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Ejemplo con <function>Imagick::setImageProperty</function> - - Define y recupera las propiedades de una imagen. - - -newImage(300, 200, "black"); - -$image->setImageProperty('Exif:Make', 'Imagick'); -echo $image->getImageProperty('Exif:Make'); -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::getImageProperty - - - - - - - diff --git a/reference/imagick/imagick/setimageredprimary.xml b/reference/imagick/imagick/setimageredprimary.xml deleted file mode 100644 index f49264deee..0000000000 --- a/reference/imagick/imagick/setimageredprimary.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Imagick::setImageRedPrimary - Establece el punto primario rojo de la cromaticidad de la imagen - - - - &reftitle.description; - - public boolImagick::setImageRedPrimary - floatx - floaty - - - Establece el punto primario rojo de la cromaticidad de la imagen. - - - - - &reftitle.parameters; - - - - x - - - - - - - y - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimagerenderingintent.xml b/reference/imagick/imagick/setimagerenderingintent.xml deleted file mode 100644 index 3e331ffc9b..0000000000 --- a/reference/imagick/imagick/setimagerenderingintent.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - Imagick::setImageRenderingIntent - Establece el propósito de renderización de la imagen - - - - &reftitle.description; - - public boolImagick::setImageRenderingIntent - intrendering_intent - - - Establece el propósito de renderización de la imagen. - - - - - &reftitle.parameters; - - - - rendering_intent - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimageresolution.xml b/reference/imagick/imagick/setimageresolution.xml deleted file mode 100644 index d4457ab966..0000000000 --- a/reference/imagick/imagick/setimageresolution.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - Imagick::setImageResolution - Establece la resolución de la imagen - - - - &reftitle.description; - - public boolImagick::setImageResolution - floatx_resolution - floaty_resolution - - - Establece la resolución de la imagen. - - - - - &reftitle.parameters; - - - - x_resolution - - - - - - - y_resolution - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::setImageResolution</function> - - 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 deleted file mode 100644 index d3d5270a9c..0000000000 --- a/reference/imagick/imagick/setimagescene.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - Imagick::setImageScene - Establece la escena de la imagen - - - - &reftitle.description; - - public boolImagick::setImageScene - intscene - - - Establece la escena de la imagen. - - - - - &reftitle.parameters; - - - - scene - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setimagetickspersecond.xml b/reference/imagick/imagick/setimagetickspersecond.xml deleted file mode 100644 index 7baddaf0b7..0000000000 --- a/reference/imagick/imagick/setimagetickspersecond.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - - Imagick::setImageTicksPerSecond - Establece los ticks por segundo de la imagen - - - - &reftitle.description; - - public boolImagick::setImageTicksPerSecond - intticks_per_second - - - Ajusta la cantidad de tiempo que se muestra un marco de una imagen animada. - - - - Para GIFs animados, esta función no cambia el número de 'ticks de imagen' - por segundo, el cual está siempre definido como 100. En su lugar, ajusta la cantidad de - tiempo que se muestra un marco para simular el cambio de 'ticks por - segundo'. - - - Por ejemplo, para un GIF animado donde cada marco se muestra para 20 ticks - (1/5 de un segundo), al llamar a este método en cada marco de esa imagen - con un argumento de 50, los marcos se ajustan para que - se muestren por 40 ticks (2/5 de un segundo) y así, la animación se reproducirá - a la mitad de la velocidad original. - - - - - - &reftitle.parameters; - - - - ticks_per_second - - - La duración por la que imagen debería mostrarse expresada en ticks - por segundo. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Modificar un GIF animado con <function>Imagick::setImageTicksPerSecond</function> - -coalesceImages(); - -$totalFrames = $imagick->getNumberImages(); - -$frameCount = 0; - -foreach ($imagick as $frame) { - $imagick->setImageTicksPerSecond(50); - - if ($frameCount < ($totalFrames / 2)) { - // Modificar el marco para que se muestre al doble de lo actual - $imagick->setImageTicksPerSecond(50); - } else { - // Modificar el marco para que se muestre a la mitad de lo actual - $imagick->setImageTicksPerSecond(200); - } - - $frameCount++; -} - -$imagick = $imagick->deconstructImages(); - -$imagick->writeImages("/ruta/donde/guardar/salida.gif", true); - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setimagetype.xml b/reference/imagick/imagick/setimagetype.xml deleted file mode 100644 index a8d9f58328..0000000000 --- a/reference/imagick/imagick/setimagetype.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - Imagick::setImageType - Establece el tipo de imagen - - - - &reftitle.description; - - public boolImagick::setImageType - intimage_type - - - Convierte la imagen al tipo dado, que combina un modelo de color con la - presencia o ausencia de un canal alfa. - Según el tipo, esto puede cambiar el espacio de color, cuantizar los colores - o cambiar si la imagen tiene un canal alfa. - - - Imagick::setImageType modifica la propia imagen. - Para establecer en su lugar el tipo con el que se escriben las imágenes - siguientes, use Imagick::setType. - - - - - &reftitle.parameters; - - - image_type - - - Una de las constantes - imagick::IMGTYPE_*. - imagick::IMGTYPE_UNDEFINED e - imagick::IMGTYPE_OPTIMIZE no convierten nada, pero - se registran igualmente en la imagen. - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setimageunits.xml b/reference/imagick/imagick/setimageunits.xml deleted file mode 100644 index 4a432f94e4..0000000000 --- a/reference/imagick/imagick/setimageunits.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Imagick::setImageUnits - Establece las unidades de resolución de la imagen - - - - &reftitle.description; - - public boolImagick::setImageUnits - intunits - - - Establece las unidades de resolución de la imagen. - - - - - &reftitle.parameters; - - - - units - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setimagevirtualpixelmethod.xml b/reference/imagick/imagick/setimagevirtualpixelmethod.xml deleted file mode 100644 index 45184b8f63..0000000000 --- a/reference/imagick/imagick/setimagevirtualpixelmethod.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Imagick::setImageVirtualPixelMethod - Establece el método de píxel virtual de la imagen - - - - &reftitle.description; - - public boolImagick::setImageVirtualPixelMethod - intmethod - - - Establece el método de píxel virtual de la imagen. - - - - - &reftitle.parameters; - - - - method - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setimagewhitepoint.xml b/reference/imagick/imagick/setimagewhitepoint.xml deleted file mode 100644 index 42204610a3..0000000000 --- a/reference/imagick/imagick/setimagewhitepoint.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Imagick::setImageWhitePoint - Establece el punto blanco de cromaticidad de la imagen - - - - &reftitle.description; - - public boolImagick::setImageWhitePoint - floatx - floaty - - - Establece el punto blanco de cromaticidad de la imagen. - - - - - &reftitle.parameters; - - - - x - - - - - - - y - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/setinterlacescheme.xml b/reference/imagick/imagick/setinterlacescheme.xml deleted file mode 100644 index 330f8ef58f..0000000000 --- a/reference/imagick/imagick/setinterlacescheme.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Imagick::setInterlaceScheme - Establece la compresión de la imagen - - - - &reftitle.description; - - public boolImagick::setInterlaceScheme - intinterlace_scheme - - - Establece la compresión de la imagen. - - - - - &reftitle.parameters; - - - - interlace_scheme - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setiteratorindex.xml b/reference/imagick/imagick/setiteratorindex.xml deleted file mode 100644 index 335132ecc3..0000000000 --- a/reference/imagick/imagick/setiteratorindex.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Imagick::setIteratorIndex - Establece la posición del iterador - - - - &reftitle.description; - - public boolImagick::setIteratorIndex - intindex - - - - Establece el iterador a la posición en la lista de imágenes definida por el parámtro index. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - index - - - La posición donde se va a establecer el iterador - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Usar <function>Imagick::setIteratorIndex</function>: - - Crear imágenes, establecer y obtener el índice del iterador - - -newImage(100, 100, new ImagickPixel("red")); -$im->newImage(100, 100, new ImagickPixel("green")); -$im->newImage(100, 100, new ImagickPixel("blue")); - -$im->setIteratorIndex(1); -echo $im->getIteratorIndex(); -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::getIteratorIndex - Imagick::getImageIndex - Imagick::setImageIndex - - - - - - - diff --git a/reference/imagick/imagick/setlastiterator.xml b/reference/imagick/imagick/setlastiterator.xml deleted file mode 100644 index b674d78a61..0000000000 --- a/reference/imagick/imagick/setlastiterator.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - Imagick::setLastIterator - Posiciona el iterador Imagick en la última imagen - - - - &reftitle.description; - - public boolImagick::setLastIterator - - - - Posiciona el iterador Imagick en la última imagen. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setoption.xml b/reference/imagick/imagick/setoption.xml deleted file mode 100644 index b940c7ed0b..0000000000 --- a/reference/imagick/imagick/setoption.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - - - Imagick::setOption - Configura una opción de un objeto Imagick - - - - &reftitle.description; - - public boolImagick::setOption - stringkey - stringvalue - - - Configura una o varias opciones del objeto Imagick. - - - - - &reftitle.parameters; - - - - key - - - - - - - value - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Intento de alcanzar el tamaño '$extent' con <function>Imagick::setOption</function> - -control->getImagePath(); - $imagick = new \Imagick(realpath($imagePath)); - $imagick->setImageFormat('jpg'); - $imagick->setOption('jpeg:extent', $extent); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); - } - -?> -]]> - - - - - Ejemplo con <function>Imagick::setOption</function> - -setImageFormat('png'); - $imagick->setOption('png:format', $format); - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); - } - - //Guardar como PNG de 64 bits. - renderPNG($imagePath, 'png64'); - -?> -]]> - - - - - Ejemplo con <function>Imagick::setOption</function> - -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"); - $crash = true; - if ($crash) { - echo $imagick->getImageBlob(); - } - else { - $tempFilename = tempnam('./', 'imagick'); - $imagick->writeimage(realpath($tempFilename)); - echo file_get_contents($tempFilename); - } - } - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/setpage.xml b/reference/imagick/imagick/setpage.xml deleted file mode 100644 index eea807ee4e..0000000000 --- a/reference/imagick/imagick/setpage.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Imagick::setPage - Establece la geometría de página del objeto Imagick - - - - &reftitle.description; - - public boolImagick::setPage - intwidth - intheight - intx - inty - - - Establece la geometría de página del objeto Imagick. - - - - - &reftitle.parameters; - - - - width - - - - - - - height - - - - - - - x - - - - - - - y - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setpointsize.xml b/reference/imagick/imagick/setpointsize.xml deleted file mode 100644 index 7e50b5aa77..0000000000 --- a/reference/imagick/imagick/setpointsize.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - - Imagick::setPointSize - Define la medida del punto - - - - &reftitle.description; - - public boolImagick::setPointSize - floatpoint_size - - - Define la propiedad de la medida del punto del objeto. Este método - puede ser utilizado para, por ejemplo, definir la medida de la fuente - para la leyenda: pseudo-formato. - &imagick.method.available.0x637; - - - - - &reftitle.parameters; - - - - point_size - - - La medida del punto. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Ejemplo con <function>Imagick::setPointSize</function> - - Ejemplo de uso del método Imagick::setPointSize - - -setFont("example.ttf"); - -/* Define la medida del punto */ -$im->setPointSize(12); - -/* Crea una nueva leyenda */ -$im->newPseudoImage(100, 100, "caption:Hello"); - -/* Realiza algunas operaciones con la nueva imagen */ -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::getPointSize - - - - - - - diff --git a/reference/imagick/imagick/setprogressmonitor.xml b/reference/imagick/imagick/setprogressmonitor.xml deleted file mode 100644 index 7c0c58bd5c..0000000000 --- a/reference/imagick/imagick/setprogressmonitor.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - Imagick::setProgressMonitor - Define una función de retrollamada a ser llamada durante el procesamiento - - - - &reftitle.description; - - public boolImagick::setProgressMonitor - callablecallback - - - Define una función de retrollamada que será llamada durante el procesamiento de la imagen Imagick. - - - - - - &reftitle.parameters; - - - callback - - - La función de progreso a llamar. Debe retornar true si el procesamiento de la imagen debe continuar, o false si debe ser cancelado. El argumento offset indica la progresión y el argumento span indica la cantidad total de trabajo a realizar. - - - - bool - - callback - - - mixedoffset - - - mixed - span - - - - - - Los valores pasados a la función de retrollamada no son consistentes. En particular, el argumento span puede aumentar durante el procesamiento de la imagen. Debido a esto, el cálculo del porcentaje completo de una operación de imagen no es trivial. - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - <function>Imagick::setProgressMonitor</function> - - control->getImagePath())); - $startTime = time(); - - $callback = function ($offset, $span) use ($startTime, &$abortReason) { - if (((100 * $offset) / $span) > 20) { - $abortReason = "Processing reached 20%"; - return false; - } - - $nowTime = time(); - - if ($nowTime - $startTime > 5) { - $abortReason = "Image processing took more than 5 seconds"; - return false; - } - if (($offset % 5) == 0) { - echo "Progress: $offset / $span
    "; - } - return true; - }; - - $imagick->setProgressMonitor($callback); - - $imagick->waveImage(2, 15); - - echo "Data len is: ".strlen($imagick->getImageBlob()); - } - catch(\ImagickException $e) { - if ($abortReason != null) { - echo "Image processing was aborted: ".$abortReason."
    "; - } - else { - echo "ImagickException caught: ".$e->getMessage()." Exception type is ".get_class($e); - } - } - -?> -]]> -
    -
    -
    -
    - -
    - - diff --git a/reference/imagick/imagick/setregistry.xml b/reference/imagick/imagick/setregistry.xml deleted file mode 100644 index f7ffc4b45f..0000000000 --- a/reference/imagick/imagick/setregistry.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - Imagick::setRegistry - Define la entrada del registro ImageMagick nombrada clave para valor - - - - &reftitle.description; - - public static boolImagick::setRegistry - stringkey - stringvalue - - - Define la entrada del registro ImageMagick nombrada clave para valor. Esto es lo más - útil para definir "temporary-path" que controla dónde ImageMagick - crea imágenes temporales, por ejemplo durante el procesamiento de PDF. - - - - - - &reftitle.parameters; - - - key - - - - - - - - value - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setresolution.xml b/reference/imagick/imagick/setresolution.xml deleted file mode 100644 index eec56f4062..0000000000 --- a/reference/imagick/imagick/setresolution.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - Imagick::setResolution - Establece la resolución de la imagen - - - - &reftitle.description; - - public boolImagick::setResolution - floatx_resolution - floaty_resolution - - - Establece la resolución de la imagen. - - - - - &reftitle.parameters; - - - - x_resolution - - - La resolución horizontal. - - - - - y_resolution - - - La resolución vertical. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.notes; - - Imagick::setResolution se debe invocar antes de - cargar o crear una imagen. - - - - - &reftitle.seealso; - - Imagick::setImageResolution - Imagick::getImageResolution - - - - - - - diff --git a/reference/imagick/imagick/setresourcelimit.xml b/reference/imagick/imagick/setresourcelimit.xml deleted file mode 100644 index 5307334dc9..0000000000 --- a/reference/imagick/imagick/setresourcelimit.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - - Imagick::setResourceLimit - Define la limitación para una recurso particular - - - - &reftitle.description; - - public static boolImagick::setResourceLimit - inttype - intlimit - - - Este método se utiliza para modificar las limitaciones de la recurso - de la biblioteca subyacente ImageMagick. - - - - - &reftitle.parameters; - - - - type - - - Consulte la lista de - constantes de tipo de recursos. - - - - - limit - - - Una de las - constantes de tipo de recursos. - La unidad depende del tipo de la recurso a limitar. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.seealso; - - Imagick::getResourceLimit - - - - - - diff --git a/reference/imagick/imagick/setsamplingfactors.xml b/reference/imagick/imagick/setsamplingfactors.xml deleted file mode 100644 index 32dd16279e..0000000000 --- a/reference/imagick/imagick/setsamplingfactors.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - Imagick::setSamplingFactors - Establece los factores de muestreo de la imagen - - - - &reftitle.description; - - public boolImagick::setSamplingFactors - arrayfactors - - - Establece los factores de muestreo de la imagen. - - - - - &reftitle.parameters; - - - - factors - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::setSamplingFactors</function> - - setImageFormat('jpg'); - $imagick->setSamplingFactors(array('2x2', '1x1', '1x1')); - - $compressed = $imagick->getImageBlob(); - - - $reopen = new \Imagick(); - $reopen->readImageBlob($compressed); - - $reopen->resizeImage( - $reopen->getImageWidth() * 4, - $reopen->getImageHeight() * 4, - \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 deleted file mode 100644 index 0abf6ce845..0000000000 --- a/reference/imagick/imagick/setsize.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Imagick::setSize - Establece el tamaño del objeto Imagick - - - - &reftitle.description; - - public boolImagick::setSize - intcolumns - introws - - - Establece el tamaño del Imagick. Se debe establecer antes de leer un formato de imagen - en bruto como RGB, GRAY, o CMYK. - - - - - &reftitle.parameters; - - - - columns - - - - - - - rows - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/setsizeoffset.xml b/reference/imagick/imagick/setsizeoffset.xml deleted file mode 100644 index 6a595caac0..0000000000 --- a/reference/imagick/imagick/setsizeoffset.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Imagick::setSizeOffset - Establece el tamaño y el índice del objeto Imagick - - - - &reftitle.description; - - public boolImagick::setSizeOffset - intcolumns - introws - intoffset - - - Establece el tamaño y el índice del objeto Imagick. Se debe establecer antes de leer un - formato de imagen en bruto como RGB, GRAY, o CMYK. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - columns - - - El ancho en píxeles. - - - - - rows - - - El alto en píxeles. - - - - - offset - - - El índice de la imagen. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/settype.xml b/reference/imagick/imagick/settype.xml deleted file mode 100644 index c419c93b20..0000000000 --- a/reference/imagick/imagick/settype.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - Imagick::setType - Establece el atributo tipo de imagen - - - - &reftitle.description; - - public boolImagick::setType - intimage_type - - - Establece el tipo de imagen aplicado a las imágenes que se escriban - posteriormente. - Para convertir en su lugar la imagen actual, use - Imagick::setImageType. - - - - - &reftitle.parameters; - - - image_type - - - Una de las constantes - imagick::IMGTYPE_*. - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/shadeimage.xml b/reference/imagick/imagick/shadeimage.xml deleted file mode 100644 index dc572eedb1..0000000000 --- a/reference/imagick/imagick/shadeimage.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - Imagick::shadeImage - Crea un efecto en 3D - - - - &reftitle.description; - - public boolImagick::shadeImage - boolgray - floatazimuth - floatelevation - - - - Hace brillar una luz distante sobre una imagen para crear un efecto tridimensional. - Se controla la posición de la luz con los parámetros azimuth (acimut) y elevation (elevación); - el acimut se mide en grados desde el eje X y la elevación se mide - en píxeles por encima del eje Z. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - gray - - - Un valor distinto de cero sombrea la intensidad de cada píxel. - - - - - azimuth - - - Define la dirección de la fuente de luz. - - - - - elevation - - - Define la dirección de la fuente de luz. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - Lanza una excepción de tipo ImagickException en caso de error. - - - - - - - &reftitle.examples; - - - <function>Imagick::shadeImage</function> - - shadeImage(true, 45, 20); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/shadowimage.xml b/reference/imagick/imagick/shadowimage.xml deleted file mode 100644 index 37a5f81ca0..0000000000 --- a/reference/imagick/imagick/shadowimage.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - Imagick::shadowImage - Simula una sombra de imagen - - - - &reftitle.description; - - public boolImagick::shadowImage - floatopacity - floatsigma - intx - inty - - - Simula una sombra de imagen. - - - - - &reftitle.parameters; - - - - opacity - - - - - - - sigma - - - - - - - x - - - - - - - y - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::shadowImage</function> - -shadowImage(0.4, 10, 50, 5); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/sharpenimage.xml b/reference/imagick/imagick/sharpenimage.xml deleted file mode 100644 index 1686fb8a12..0000000000 --- a/reference/imagick/imagick/sharpenimage.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - Imagick::sharpenImage - Afila una imagen - - - - &reftitle.description; - - public boolImagick::sharpenImage - floatradius - floatsigma - intchannelImagick::CHANNEL_DEFAULT - - - Afila una imagen. Se convoluciona la imagen con un operador gaussiano - del radio y la desviación estándar (sigma) dados. Para obtener resultados - razonables, el radio debería ser mayor que sigma. Use un radio de 0 y - Imagick::sketchImage() seleccionará un radio apropiado - automáticamente. - - - - - &reftitle.parameters; - - - - radius - - - - - - - sigma - - - - - - - channel - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::sharpenImage</function> - - sharpenimage($radius, $sigma, $channel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/shaveimage.xml b/reference/imagick/imagick/shaveimage.xml deleted file mode 100644 index 307b0f9740..0000000000 --- a/reference/imagick/imagick/shaveimage.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - Imagick::shaveImage - Recorta píxeles de los extremos de la imagen - - - - &reftitle.description; - - public boolImagick::shaveImage - intcolumns - introws - - - Recorta píxeles de los extremos de la imagen. Asigna la memoria necesaria para - la estructura de la nueva imagen y devuelve un puntero a la nueva imagen. - - - - - &reftitle.parameters; - - - - columns - - - - - - - rows - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::shaveImage</function> - - shaveImage(100, 50); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/shearimage.xml b/reference/imagick/imagick/shearimage.xml deleted file mode 100644 index af239443e9..0000000000 --- a/reference/imagick/imagick/shearimage.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - Imagick::shearImage - Crea un paralelogramo - - - - &reftitle.description; - - public boolImagick::shearImage - mixedbackground - floatx_shear - floaty_shear - - - Desliza un extremo de una imagen a lo largo del eje X o Y, creando un paralelogramo. - Un recorte en la dirección X desliza un extremo a lo largo del eje X, mientras que un recorte en la - dirección Y desliza un extremo a lo largo del eje Y. La cantidad del recorte se controla - por un ángulo de recorte. Para recortes en la dirección X, x_shear se mide relativo al - eje Y, y de forma similar, para recortes en la dirección Y, y_shear se mide - relativo al eje X. Los triángulos vacíos sobrantes del recorte de la imagen - se rellenan con el color de fondo. - - - - - &reftitle.parameters; - - - - background - - - El color de fondo - - - - - x_shear - - - El número de grados a recortar sobre el eje x - - - - - y_shear - - - El número de grados a recortar sobre el eje y - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Ahora se permite que un string represente el color como primer parámetro. - Versiones previas sólo permitían un objeto ImagickPixel. - - - - - - - - - - - - &reftitle.examples; - - - <function>Imagick::shearImage</function> - - shearimage($color, $shearX, $shearY); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/sigmoidalcontrastimage.xml b/reference/imagick/imagick/sigmoidalcontrastimage.xml deleted file mode 100644 index 3391bbd17c..0000000000 --- a/reference/imagick/imagick/sigmoidalcontrastimage.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - Imagick::sigmoidalContrastImage - Ajusta el contraste de la imagen - - - - &reftitle.description; - - public boolImagick::sigmoidalContrastImage - boolsharpen - floatalpha - floatbeta - intchannelImagick::CHANNEL_DEFAULT - - - Ajusta el contraste de la imagen con un algoritmo de contraste sigmoide - no lineal. Aumenta el contraste de la imagen utilizando una función - de transferencia sigmoide sin saturar las luces altas y las sombras. - alpha indica cuánto debe aumentarse el contraste: - 0.00 para no hacer nada; 3.00 es - un valor típico; 20.00 es un valor extremo. - beta indica dónde estarán los tonos medios en la - imagen resultante, como una fracción del rango del quantum: - 0.0 corresponde a blanco, 0.5 a - gris medio y 1.0 a negro (se debe multiplicar por - getQuantumRange()['quantumRangeLong'] para obtener el valor - a pasar). - - - Consúltense también los ejemplos - de ImageMagick -- Modificaciones de color — Contraste no lineal sigmoide. - - - - - &reftitle.parameters; - - - - sharpen - - - Si es &true;, el contraste aumentará; si es &false;, el contraste disminuirá. - - - - - alpha - - - La cantidad de contraste a aplicar. 1.00 representa una cantidad - muy pequeña, 5.00 una cantidad significativa y - 20.00 un valor extremo. - - - - - beta - - - Dónde debe situarse el punto medio del gradiente. Este valor debe estar - en el intervalo de 0.00 a 1.00, - multiplicado por el valor del quantum para ImageMagick. - - - - - channel - - - Canales de color sobre los cuales debe aplicarse el contraste. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Crea un degradado de imagen utilizando el método - <function>Imagick::sigmoidalContrastImage</function> - para mezclar dos imágenes suavemente, donde la mezcla - está definida por <parameter>alpha</parameter> y <parameter>beta</parameter> - - -newPseudoImage($width, $height, 'gradient:black-white'); - $quanta = $imagick->getQuantumRange(); - $imagick->sigmoidalContrastImage(true, $alpha, $beta * $quanta["quantumRangeLong"]); - - return $imagick; -} -]]> - - - - - - - diff --git a/reference/imagick/imagick/sketchimage.xml b/reference/imagick/imagick/sketchimage.xml deleted file mode 100644 index 4b5bbfab8c..0000000000 --- a/reference/imagick/imagick/sketchimage.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - Imagick::sketchImage - Simula el bosquejo de un lapiz - - - - &reftitle.description; - - public boolImagick::sketchImage - floatradius - floatsigma - floatangle - - - - Simula el bosquejo de un lapiz. Se convoluciona la imagen con un operador gaussiano - del radio y la desviación estándar (sigma) dados. Para obtener resultados - razonables, el radio debería ser mayor que sigma. Use un radio de 0 y - Imagick::sketchImage() seleccionará un radio apropiado automáticamente. El ángulo da el - ángulo del movimiento borroso. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - radius - - - El radio gaussiano, en píxeles, sin contar el píxel central. - - - - - sigma - - - La desviación estándar gaussiana, en píxeles. - - - - - angle - - - Aplica el efecto a lo largo de este ángulo. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::sketchImage</function> - - sketchimage($radius, $sigma, $angle); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/smushimages.xml b/reference/imagick/imagick/smushimages.xml deleted file mode 100644 index c338dcbf62..0000000000 --- a/reference/imagick/imagick/smushimages.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Imagick::smushImages - Toma todas las imágenes del puntero de imagen actual hasta el final de la lista de imágenes y las comprime - - - - &reftitle.description; - - public ImagickImagick::smushImages - boolstack - intoffset - - - Toma todas las imágenes del puntero de imagen actual hasta el final de la lista de imágenes y las comprime - unas sobre otras de arriba hacia abajo si el argumento stack es verdadero, de lo contrario de izquierda a derecha. - - - - - - &reftitle.parameters; - - - stack - - - - - - - - offset - - - - - - - - - - - &reftitle.returnvalues; - - La nueva imagen comprimida. - - - - - &reftitle.examples; - - - <function>Imagick::smushImages</function> - - addimage($imagick2); - $smushed = $imagick->smushImages(false, 50); - $smushed->setImageFormat('jpg'); - header("Content-Type: image/jpg"); - echo $smushed->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/solarizeimage.xml b/reference/imagick/imagick/solarizeimage.xml deleted file mode 100644 index c8d2a09de3..0000000000 --- a/reference/imagick/imagick/solarizeimage.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - Imagick::solarizeImage - Aplica un efecto de solarización a la imagen - - - - &reftitle.description; - - public boolImagick::solarizeImage - intthreshold - - - Aplica un efecto especial a la imagen, similar al efecto conseguido en un cuarto oscuro - fotográfico exponiendo selectivamente áreas del papel sensible fotográfico a la luz. - Los rangos de umbral van desde 0 al de QuantumRange y es una medida de la - extensión de la solarización. - - - - - &reftitle.parameters; - - - - threshold - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::solarizeImage</function> - - solarizeImage($solarizeThreshold * \Imagick::getQuantum()); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/sparsecolorimage.xml b/reference/imagick/imagick/sparsecolorimage.xml deleted file mode 100644 index fc3687b557..0000000000 --- a/reference/imagick/imagick/sparsecolorimage.xml +++ /dev/null @@ -1,270 +0,0 @@ - - - - - - - - Imagick::sparseColorImage - Interpola colores - - - - &reftitle.description; - - public boolImagick::sparseColorImage - intSPARSE_METHOD - arrayarguments - intchannelImagick::CHANNEL_DEFAULT - - - Dada la matriz de argumentos que contiene valores númericos, este método interpola los colores - encontrados en esas coordenadas a través de la imagen completa usando sparse_method. - &imagick.method.available.0x645; - - - - - &reftitle.parameters; - - - - SPARSE_METHOD - - - Consulte esta lista de constantes de métodos de escasez - - - - - arguments - - - Una matriz que contiene las coordenadas. - El formato de la matriz es array(1,1, 2,45) - - - - - channel - - - &imagick.parameter.channel; - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - SPARSECOLORMETHOD_BARYCENTRIC <function>Imagick::sparseColorImage</function> - -getImageBlob(); - } - -?> -]]> - - - - - SPARSECOLORMETHOD_BILINEAR <function>Imagick::sparseColorImage</function> - -getImageBlob(); - } - -?> -]]> - - - - - SPARSECOLORMETHOD_SPEPARDS <function>Imagick::sparseColorImage</function> - -getImageBlob(); - } - -?> -]]> - - - - - SPARSECOLORMETHOD_VORONOI <function>Imagick::sparseColorImage</function> - -getImageBlob(); - } - -?> -]]> - - - - - SPARSECOLORMETHOD_BARYCENTRIC <function>Imagick::sparseColorImage</function> - -getImageBlob(); - } - -?> -]]> - - - - - createGradientImage is used by other examples. <function>Imagick::sparseColorImage</function> - -newImage($width, $height, "white"); - $imagick->setImageFormat("png"); - - $barycentricPoints = array(); - - foreach ($colorPoints as $colorPoint) { - - if ($absolute == true) { - $barycentricPoints[] = $colorPoint[0]; - $barycentricPoints[] = $colorPoint[1]; - } - else { - $barycentricPoints[] = $colorPoint[0] * $width; - $barycentricPoints[] = $colorPoint[1] * $height; - } - - if (is_string($colorPoint[2])) { - $imagickPixel = new \ImagickPixel($colorPoint[2]); - } - else if ($colorPoint[2] instanceof \ImagickPixel) { - $imagickPixel = $colorPoint[2]; - } - else{ - $errorMessage = sprintf( - "Value %s is neither a string nor an ImagickPixel class. Cannot use as a color.", - $colorPoint[2] - ); - - throw new \InvalidArgumentException( - $errorMessage - ); - } - - $red = $imagickPixel->getColorValue(\Imagick::COLOR_RED); - $green = $imagickPixel->getColorValue(\Imagick::COLOR_GREEN); - $blue = $imagickPixel->getColorValue(\Imagick::COLOR_BLUE); - $alpha = $imagickPixel->getColorValue(\Imagick::COLOR_ALPHA); - - $barycentricPoints[] = $red; - $barycentricPoints[] = $green; - $barycentricPoints[] = $blue; - $barycentricPoints[] = $alpha; - } - - $imagick->sparseColorImage($sparseMethod, $barycentricPoints); - - return $imagick; -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/spliceimage.xml b/reference/imagick/imagick/spliceimage.xml deleted file mode 100644 index f659f21581..0000000000 --- a/reference/imagick/imagick/spliceimage.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - Imagick::spliceImage - Une un color sólido en la imagen - - - - &reftitle.description; - - public boolImagick::spliceImage - intwidth - intheight - intx - inty - - - Une un color sólido en la imagen. - - - - - &reftitle.parameters; - - - - width - - - - - - - height - - - - - - - x - - - - - - - y - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::spliceImage</function> - - spliceImage($width, $height, $startX, $startY); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/spreadimage.xml b/reference/imagick/imagick/spreadimage.xml deleted file mode 100644 index fde36ff37e..0000000000 --- a/reference/imagick/imagick/spreadimage.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - Imagick::spreadImage - Despalza aleatoriamente cada píxel en un bloque - - - - &reftitle.description; - - public boolImagick::spreadImage - floatradius - - - Método de efecto especial que desplaza aleatoriamente cada píxel en un bloque - definido por el parámetro radius (radio). - - - - - &reftitle.parameters; - - - - radius - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::spreadImage</function> - - spreadImage($radius); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/statisticimage.xml b/reference/imagick/imagick/statisticimage.xml deleted file mode 100644 index ab8fe9df15..0000000000 --- a/reference/imagick/imagick/statisticimage.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - Imagick::statisticImage - Modifica una imagen utilizando una función estadística - - - - &reftitle.description; - - public boolImagick::statisticImage - inttype - intwidth - intheight - intchannelImagick::CHANNEL_DEFAULT - - - Cada píxel es reemplazado por la estadística correspondiente del vecindario de la anchura y altura especificadas. - - - - - - &reftitle.parameters; - - - type - - - - - - - - width - - - - - - - - height - - - - - - - - channel - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - <function>Imagick::statisticImage</function> - - statisticImage( - $statisticType, - $width, - $height, - $channel - ); - - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -statisticImage($imagePath, \Imagick::STATISTIC_MEDIAN, 5, 5, \Imagick::CHANNEL_DEFAULT); - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/steganoimage.xml b/reference/imagick/imagick/steganoimage.xml deleted file mode 100644 index db6c70528b..0000000000 --- a/reference/imagick/imagick/steganoimage.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Imagick::steganoImage - Oculta una marca de agua digital dentro de la imagen - - - - &reftitle.description; - - public ImagickImagick::steganoImage - Imagickwatermark_wand - intoffset - - - Oculta una marca de agua digital dentro de la imagen. Recupere la marca de agua oculta - después para demostrar la autenticidad de la imagen. El parámetro offset define la posición - inicial dentro de la imagen para ocultar la marca de agua. - - - - - &reftitle.parameters; - - - - watermark_wand - - - - - - - offset - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/stereoimage.xml b/reference/imagick/imagick/stereoimage.xml deleted file mode 100644 index 4d4cf128ec..0000000000 --- a/reference/imagick/imagick/stereoimage.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - Imagick::stereoImage - Compone dos imágenes - - - - &reftitle.description; - - public boolImagick::stereoImage - Imagickoffset_wand - - - Compone dos imágenes y produce una sóla imagen que es la composición - de una imagen izquierda y derecha de una pareja estéreo. - - - - - &reftitle.parameters; - - - - offset_wand - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/stripimage.xml b/reference/imagick/imagick/stripimage.xml deleted file mode 100644 index b1716041bd..0000000000 --- a/reference/imagick/imagick/stripimage.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Imagick::stripImage - Elimina de una imagen todos los perfiles y los comentarios - - - - &reftitle.description; - - public boolImagick::stripImage - - - - Elimina de una imagen todos los perfiles y los comentarios. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - diff --git a/reference/imagick/imagick/subimagematch.xml b/reference/imagick/imagick/subimagematch.xml deleted file mode 100644 index 6b67140f96..0000000000 --- a/reference/imagick/imagick/subimagematch.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - Imagick::subImageMatch - Busca una subimagen en la imagen actual y devuelve una imagen de similitud - - - - &reftitle.description; - - public ImagickImagick::subImageMatch - ImagickImagick - arrayoffset - floatsimilarity - - - Busca una subimagen en la imagen actual y devuelve una imagen de similitud de tal manera que una posición de coincidencia exacta es completamente blanca y si ningún píxel coincide, negro, de lo contrario un cierto nivel de gris entre ambos. Asimismo, pueden pasarse los argumentos opcionales bestMatch y similarity. Tras llamar a la función, similarity será definido en el 'puntuación' de similitud entre la subimagen y la posición correspondiente en la imagen más grande, bestMatch contendrá un array asociativo con los elementos x, y, width, height que describen la región correspondiente. - - - - - &reftitle.parameters; - - - Imagick - - - - - - - - offset - - - - - - - - similarity - - - Una nueva imagen que muestra la cantidad de similitud en cada píxel. - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - - <function>Imagick::subImageMatch</function> - - cropimage(40, 40, 250, 110); - $imagick2->vignetteimage(0, 1, 3, 3); - - $similarity = null; - $bestMatch = null; - $comparison = $imagick->subImageMatch($imagick2, $bestMatch, $similarity); - - $comparison->setImageFormat('png'); - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/swirlimage.xml b/reference/imagick/imagick/swirlimage.xml deleted file mode 100644 index 3656e32ef8..0000000000 --- a/reference/imagick/imagick/swirlimage.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - Imagick::swirlImage - Arremolina los píxeles desde el centro de la imagen - - - - &reftitle.description; - - - boolImagick::swirlImage - floatdegrees - - - Arremolina los píxeles desde el centro de la imagen, donde los grados indican - el alcance del arco a través del cuál cada píxel es movido. Se puede obtener un efecto - más dramático moviendo los grados desde 1 a 360. - - - - - &reftitle.parameters; - - - - degrees - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::swirlImage</function> - - swirlImage($swirl); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/textureimage.xml b/reference/imagick/imagick/textureimage.xml deleted file mode 100644 index 0a0e48539a..0000000000 --- a/reference/imagick/imagick/textureimage.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - - Imagick::textureImage - Repite los mosaicos de la textura de una imagen - - - - &reftitle.description; - - - ImagickImagick::textureImage - Imagicktexture_wand - - - Repite los mosaicos de la textura de una imagen mediante el lienzo de la imagen. - - - - - &reftitle.parameters; - - - - texture_wand - - - Objeto Imagick a utilizar como imagen de textura - - - - - - - - - &reftitle.returnvalues; - - Devuelve un nuevo objeto Imagick, al que se le ha aplicado la textura repetida. - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Ejemplo con <function>Imagick::textureImage</function> - - newImage(640, 480, new \ImagickPixel('pink')); - $image->setImageFormat("jpg"); - $texture = new \Imagick(realpath($imagePath)); - $texture->scaleimage($image->getimagewidth() / 4, $image->getimageheight() / 4); - $image = $image->textureImage($texture); - header("Content-Type: image/jpg"); - echo $image; -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/thresholdimage.xml b/reference/imagick/imagick/thresholdimage.xml deleted file mode 100644 index f867bc43c7..0000000000 --- a/reference/imagick/imagick/thresholdimage.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - Imagick::thresholdImage - Cambia el valor de píexeles individuales basdos en un umbral - - - - &reftitle.description; - - public boolImagick::thresholdImage - floatthreshold - intchannelImagick::CHANNEL_DEFAULT - - - Cambia el valor de píxeles individuales basados en la inatensidad de cada píxel - comparado con el umbral. El resultado es una imagen de alto contraste de dos colores. - - - - - &reftitle.parameters; - - - - threshold - - - - - - - channel - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::thresholdImage</function> - - thresholdimage($threshold * \Imagick::getQuantum(), $channel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/thumbnailimage.xml b/reference/imagick/imagick/thumbnailimage.xml deleted file mode 100644 index 9f6c20364b..0000000000 --- a/reference/imagick/imagick/thumbnailimage.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - - - Imagick::thumbnailImage - Modifica el tamaño de una imagen - - - - &reftitle.description; - - public boolImagick::thumbnailImage - intcolumns - introws - boolbestfit&false; - boolfill&false; - boollegacy&false; - - - Modifica el tamaño de una imagen a las dimensiones dadas y elimina - todos los perfiles asociados. El objetivo es producir una miniatura de bajo costo para su visualización en la web. - Si &true; se proporciona como tercer argumento, entonces los argumentos - columns y rows se utilizarán como máximo para cada lado. Cada lado se reducirá hasta que se alcance el tamaño deseado. - - &imagick.bestfit.note; - - - - &reftitle.parameters; - - - - columns - - - Ancho de la imagen - - - - - rows - - - Alto de la imagen - - - - - bestfit - - - Si se deben forzar los valores máximos - - - - - fill - - - Si la imagen no llena completamente el área, entonces esta se rellena con - el color de fondo de la imagen. - - - - - legacy - - - Redondea la dimensión más pequeña al entero inferior más cercano. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Ejemplo con <function>Imagick::thumbnailImage</function> - - setbackgroundcolor('rgb(64, 64, 64)'); - $imagick->thumbnailImage(100, 100, true, true); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/tintimage.xml b/reference/imagick/imagick/tintimage.xml deleted file mode 100644 index 808a0f557e..0000000000 --- a/reference/imagick/imagick/tintimage.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - - Imagick::tintImage - Aplica un vector de color a cada píxel en la imagen - - - - &reftitle.description; - - public boolImagick::tintImage - mixedtint - mixedopacity - boollegacy&false; - - - Aplica un vector de color a cada píxel en la imagen. La longitud del vector - es 0 para blanco y negro y su máximo para los medios-tonos. La función de precisión - del vector es f(x)=(1-(4.0*((x-0.5)*(x-0.5)))). - - - - - &reftitle.parameters; - - - - tint - - - - - - - opacity - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Ahora se permite que una string represente el color como primer parámetro y - que un valor de tipo float represente la opacidad como segundo parámetro. - Versiones previas sólo permitían un objeto ImagickPixel. - - - - - - - - - - - - &reftitle.examples; - - - <function>Imagick::tintImage</function> - - newPseudoImage(400, 400, 'gradient:black-white'); - - $tint = new \ImagickPixel("rgb($r, $g, $b)"); - $opacity = new \ImagickPixel("rgb(128, 128, 128, $a)"); - $imagick->tintImage($tint, $opacity); - $imagick->setImageFormat('png'); - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/toString.xml b/reference/imagick/imagick/toString.xml deleted file mode 100644 index 330bce4fec..0000000000 --- a/reference/imagick/imagick/toString.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - - Imagick::__toString - Devuelve la imagen como un string - - - - &reftitle.description; - - public stringImagick::__toString - - - - Devuelve la imagen actual como un string. Solamente devolverá una única imagen; no debería usarse con objetos Imagick que contengan varias imágenges, p.ej., un GIF animado o un PDF con varias páginas. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el contenido del string en caso de éxito o un string vacío en caso de fallo. - - - - - - &reftitle.seealso; - - Imagick::getImageBlob - Imagick::getImagesBlob - - - - - - diff --git a/reference/imagick/imagick/transformimage.xml b/reference/imagick/imagick/transformimage.xml deleted file mode 100644 index 1df3312306..0000000000 --- a/reference/imagick/imagick/transformimage.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - Imagick::transformImage - Método conveniente para establecer el tamaño del recorte y la geometría de la imagen - - - - &imagick.deprecated.function-3-4-4; - - - - &reftitle.description; - - public ImagickImagick::transformImage - stringcrop - stringgeometry - - - - Método conveniente para establecer el tamaño del recorte y la geometría de la imagen desde cadenas. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - crop - - - Un string de geometría de recorte. Esta geometría define una sub-región de la imagen a recortar. - - - - - geometry - - - Un string de geometría de imagen. Esta geometría define el tamaño final de la imagen. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto Imagick que contiene la imagen transformada. - - - - - &reftitle.examples; - - - Usar <function>Imagick::transformImage</function>: - - El ejemplo crea una imagen negra de 100x100 black. - - -newImage(300, 200, "black"); -$imagen_nueva = $imagen->transformImage("100x100", "100x100"); -$imagen_nueva->writeImage('test_out.jpg'); -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::cropImage - Imagick::resizeImage - Imagick::thumbnailImage - - - - - - - diff --git a/reference/imagick/imagick/transformimagecolorspace.xml b/reference/imagick/imagick/transformimagecolorspace.xml deleted file mode 100644 index 00a117d733..0000000000 --- a/reference/imagick/imagick/transformimagecolorspace.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - Imagick::transformImageColorspace - Transforma una imagen en un nuevo espacio de color - - - - &reftitle.description; - - - public boolImagick::transformImageColorspace - intcolorspace - - - Transforma una imagen en un nuevo espacio de color. - - - - - &reftitle.parameters; - - - colorspace - - - El espacio de color al que debe transformarse la imagen, una de las constantes COLORSPACE, por ejemplo Imagick::COLORSPACE_CMYK. - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - <methodname>Imagick::transformImageColorspace</methodname> ejemplo - - Transforma una imagen en un nuevo espacio de color, luego extrae un solo canal para que los valores individuales de canal puedan visualizarse. - - - -transformimagecolorspace($colorSpace); - //channel debe ser una de las constantes de canal, por ejemplo \Imagick::CHANNEL_BLUE - $imagick->separateImageChannel($channel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} -?> -]]> - - - - - - - &reftitle.seealso; - - Imagick::setColorSpace - - - - - - diff --git a/reference/imagick/imagick/transparentpaintimage.xml b/reference/imagick/imagick/transparentpaintimage.xml deleted file mode 100644 index 5b1c16e0b0..0000000000 --- a/reference/imagick/imagick/transparentpaintimage.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - - Imagick::transparentPaintImage - Pinta píxeles transparentes - - - - &reftitle.description; - - public boolImagick::transparentPaintImage - mixedtarget - floatalpha - floatfuzz - boolinvert - - - - Pinta píxeles transparente que coincidan con el color objetivo. - &imagick.method.available.0x638; - - - - - &reftitle.parameters; - - - - target - - - El color objetivo a pintar - - - - - alpha - - - &imagick.parameter.alpha; - - - - - fuzz - - - &imagick.parameter.fuzz; - - - - - invert - - - Si es &true; pinta cualquier píxel que no coincida con el color objetivo. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - - &reftitle.examples; - - - <function>Imagick::transparentPaintImage</function> - - setimageformat('png'); - - $imagick->transparentPaintImage( - $color, $alpha, $fuzz * \Imagick::getQuantum(), false - ); - - //Not required, but helps tidy up left over pixels - $imagick->despeckleimage(); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/transposeimage.xml b/reference/imagick/imagick/transposeimage.xml deleted file mode 100644 index 782024bea8..0000000000 --- a/reference/imagick/imagick/transposeimage.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - - - Imagick::transposeImage - Aplica una simetría vertical - - - - &reftitle.description; - - public boolImagick::transposeImage - - - - - Aplica una simetría vertical, creando la reflexión de cada - píxel alrededor de un eje horizontal, con una rotación de 90 grados. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Ejemplo con <function>Imagick::transposeImage</function> - - transposeImage(); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::transverseImage - - - - - - - diff --git a/reference/imagick/imagick/transverseimage.xml b/reference/imagick/imagick/transverseimage.xml deleted file mode 100644 index a173c87dd6..0000000000 --- a/reference/imagick/imagick/transverseimage.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - - Imagick::transverseImage - Crea un espejo horizontal de la imagen - - - - &reftitle.description; - - public boolImagick::transverseImage - - - - Crea un espejo horizontal de la imagen reflejando los píxeles alrededor - de un eje Y central, y realizando una rotación de 270 grados. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Ejemplo con <function>Imagick::transverseImage</function> - - transverseImage(); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::transposeImage - - - - - - - diff --git a/reference/imagick/imagick/trimimage.xml b/reference/imagick/imagick/trimimage.xml deleted file mode 100644 index 9dbdbb9142..0000000000 --- a/reference/imagick/imagick/trimimage.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - Imagick::trimImage - Elimina los extremos de la imagen - - - - &reftitle.description; - - public boolImagick::trimImage - floatfuzz - - - - Elimina los extremos que son el color de fondo de la imagen. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - fuzz - - - Por defecto, el objetivo debe coincidir exactamente con un color de píxel en particular. - Sin embargo, en la mayoría de los casos dos colores pueden diferir por una cantidad pequeña. - El miembro enfoque de la imagen define cuánta tolerancia es aceptable - para considerar que dos colores son el mismo. Este parámetro represenata la variación - del rango de cuantía. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - Usar <function>Imagick::trimImage</function>: - - Recortar una imagen, después mostrarla en el navegador. - - -trimImage(0); - -/* Imprimir la imagen */ -header("Content-Type: image/" . $im->getImageFormat()); -echo $im; -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::getQuantumDepth - Imagick::getQuantumRange - imagecropauto - - - - - - - diff --git a/reference/imagick/imagick/uniqueimagecolors.xml b/reference/imagick/imagick/uniqueimagecolors.xml deleted file mode 100644 index 4dd4b780bd..0000000000 --- a/reference/imagick/imagick/uniqueimagecolors.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - Imagick::uniqueImageColors - Se conserva únicamente un color de píxel - - - - &reftitle.description; - - public boolImagick::uniqueImageColors - - - - - Se conserva únicamente un color de píxel y se eliminan los demás. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Ejemplo con <function>Imagick::uniqueImageColors</function> - -quantizeImage(256, \Imagick::COLORSPACE_YIQ, 0, false, false); - $imagick->uniqueImageColors(); - $imagick->scaleimage($imagick->getImageWidth(), $imagick->getImageHeight() * 20); - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/unsharpmaskimage.xml b/reference/imagick/imagick/unsharpmaskimage.xml deleted file mode 100644 index 169ddd3993..0000000000 --- a/reference/imagick/imagick/unsharpmaskimage.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - - Imagick::unsharpMaskImage - Afila una imagen - - - - &reftitle.description; - - public boolImagick::unsharpMaskImage - floatradius - floatsigma - floatamount - floatthreshold - intchannelImagick::CHANNEL_DEFAULT - - - Afila una imagen. Se convoluciona la imagen con un operador gaussiano - del radio y la desviación estándar (sigma) dados. Para obtener resultados - razonables, el radio debería ser mayor que sigma. Use un radio de 0 y - Imagick::sketchImage() seleccionará un radio apropiado automáticamente. - - - - - &reftitle.parameters; - - - - radius - - - - - - - sigma - - - - - - - amount - - - - - - - threshold - - - - - - - channel - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - - - &reftitle.examples; - - - <function>Imagick::unsharpMaskImage</function> - - unsharpMaskImage($radius, $sigma, $amount, $unsharpThreshold); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagick/valid.xml b/reference/imagick/imagick/valid.xml deleted file mode 100644 index 068d51431c..0000000000 --- a/reference/imagick/imagick/valid.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - Imagick::valid - Verifica si el elemento actual es válido - - - - &reftitle.description; - - public boolImagick::valid - - - - Verifica si el elemento actual es válido. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/vignetteimage.xml b/reference/imagick/imagick/vignetteimage.xml deleted file mode 100644 index 065344f6f2..0000000000 --- a/reference/imagick/imagick/vignetteimage.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - - - Imagick::vignetteImage - Añade un filtro de viñeta a la imagen - - - - &reftitle.description; - - public boolImagick::vignetteImage - floatblackPoint - floatwhitePoint - intx - inty - - - Suaviza los contornos de la imagen, al estilo de las viñetas. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - blackPoint - - - El radio del desenfoque - - - - - whitePoint - - - La desviación estándar - - - - - x - - - La abscisa de la elipse. - - - - - y - - - La ordenada de la elipse. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Ejemplo con <function>Imagick::vignetteImage</function> - - vignetteImage($blackPoint, $whitePoint, $x, $y); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::waveImage - Imagick::swirlImage - - - - - - - diff --git a/reference/imagick/imagick/waveimage.xml b/reference/imagick/imagick/waveimage.xml deleted file mode 100644 index 83a8a3c9ca..0000000000 --- a/reference/imagick/imagick/waveimage.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - - Imagick::waveImage - Añade un filtro de ondas a la imagen - - - - &reftitle.description; - - public boolImagick::waveImage - floatamplitude - floatlength - - - - Añade un filtro de ondas a la imagen. - &imagick.method.available.0x629; - - - - - &reftitle.parameters; - - - - amplitude - - - Amplitud de la onda. - - - - - length - - - Longitud de la onda. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.errors; - - &imagick.imagick.throws; - - - - - &reftitle.examples; - - - WaveImage puede ser muy lento: <function>Imagick::waveImage</function> - -waveImage($amplitude, $length); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - &reftitle.seealso; - - - Imagick::solarizeImage - Imagick::oilpaintImage - Imagick::embossImage - Imagick::addNoiseImage - Imagick::swirlImage - - - - - - - diff --git a/reference/imagick/imagick/whitethresholdimage.xml b/reference/imagick/imagick/whitethresholdimage.xml deleted file mode 100644 index 592d5ac80f..0000000000 --- a/reference/imagick/imagick/whitethresholdimage.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - Imagick::whiteThresholdImage - Fuerza a todos los píxeles por encima del umbral a ser blancos - - - - &reftitle.description; - - public boolImagick::whiteThresholdImage - mixedthreshold - - - Es como Imagick::ThresholdImage() excepto que fuerza a todos los píxeles por encima del umbral - a ser blancos dejando todos los píxeles por debajo del umbral sin cambios. - - - - - &reftitle.parameters; - - - - threshold - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL imagick 2.1.0 - - Ahora se permite que una cadena represente el color como parámetro. - Versiones previas sólo permitían un objeto ImagickPixel. - - - - - - - - - - - - &reftitle.examples; - - - <function>Imagick::whiteThresholdImage</function> - - whiteThresholdImage($color); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - - diff --git a/reference/imagick/imagick/writeimage.xml b/reference/imagick/imagick/writeimage.xml deleted file mode 100644 index 3745f2a7fb..0000000000 --- a/reference/imagick/imagick/writeimage.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - Imagick::writeImage - Escribe una imagen al nombre de fichero especificado - - - - &reftitle.description; - - public boolImagick::writeImage - stringfilenameNULL - - - Escribe una imagen al nombre de fichero especificado. Si el parámetro 'filename' es NULL, - la imagen se escribe en el nombre de fichero establecido por Imagick::readImage() o - Imagick::setImageFilename(). - - - - - &reftitle.parameters; - - - - filename - - - Nombre del fichero donde escribir la imagen. La extensión del nombre de fichero - define el tipo del fichero. - El formato puede ser forzado independientemente del formato que use la extensión del fichero: - usando un prefijo, por ejemplo "jpg:test.png". - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/writeimagefile.xml b/reference/imagick/imagick/writeimagefile.xml deleted file mode 100644 index a5f6766ff6..0000000000 --- a/reference/imagick/imagick/writeimagefile.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - Imagick::writeImageFile - Escribe una imagen en un descriptor de archivo - - - - &reftitle.description; - - public boolImagick::writeImageFile - resourcefilehandle - stringformat - - - - Escribe la secuencia de la imagen en un descriptor de archivo abierto. - El descriptor debe haber sido abierto con, por ejemplo, la función fopen. - &imagick.method.available.0x636; - - - - - &reftitle.parameters; - - - - filehandle - - - Descriptor de archivo en el cual la imagen será escrita. - - - - - format - - - El formato de la imagen. - La lista de especificadores de formato válidos depende del conjunto de funcionalidades compilado de ImageMagick, - y puede ser consultada en tiempo de ejecución mediante Imagick::queryFormats. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.seealso; - - Imagick::queryFormats - - - - diff --git a/reference/imagick/imagick/writeimages.xml b/reference/imagick/imagick/writeimages.xml deleted file mode 100644 index 725b02bf05..0000000000 --- a/reference/imagick/imagick/writeimages.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - Imagick::writeImages - Escribe una imagen o secuencia de imágenes - - - - &reftitle.description; - - public boolImagick::writeImages - stringfilename - booladjoin - - - Escribe una imagen o secuencia de imágenes. - - - - - &reftitle.parameters; - - - - filename - - - - - - - adjoin - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagick/writeimagesfile.xml b/reference/imagick/imagick/writeimagesfile.xml deleted file mode 100644 index 7bc527ddbc..0000000000 --- a/reference/imagick/imagick/writeimagesfile.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - Imagick::writeImagesFile - Escribe los frames en un descriptor de ficheros - - - - &reftitle.description; - - public boolImagick::writeImagesFile - resourcefilehandle - stringformat - - - - Escribe todas las frames de una imagen en un descriptor de fichero. - Este método puede ser utilizado para escribir gifs animados u otras - imágenes compuestas por múltiples frames en un descriptor de fichero abierto. - &imagick.method.available.0x636; - - - - - &reftitle.parameters; - - - - filehandle - - - Descriptor de fichero en el que se escribirán las frames. - - - - - format - - - El formato de la imagen. - La lista de especificadores de formato válidos depende del conjunto de características compiladas de ImageMagick, - y puede ser consultada en tiempo de ejecución mediante Imagick::queryFormats. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.seealso; - - Imagick::queryFormats - - - - diff --git a/reference/imagick/imagickdraw.xml b/reference/imagick/imagickdraw.xml deleted file mode 100644 index 5b5e3f77e8..0000000000 --- a/reference/imagick/imagickdraw.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - La clase <classname>ImagickDraw</classname> - ImagickDraw - -
    - &reftitle.classsynopsis; - - ImagickDraw - - ImagickDraw - - - -
    -
    - - &reference.imagick.entities.imagickdraw; -
    - - diff --git a/reference/imagick/imagickdraw/affine.xml b/reference/imagick/imagickdraw/affine.xml deleted file mode 100644 index 6501b73edf..0000000000 --- a/reference/imagick/imagickdraw/affine.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - ImagickDraw::affine - Ajusta la matriz de transformación afín actual - - - - &reftitle.description; - - public boolImagickDraw::affine - arrayaffine - - &warn.undocumented.func; - - Ajusta la matriz de transformación afín actual con la matriz de transformación - afín especificada. - - - - - &reftitle.parameters; - - - - affine - - - Los parámetros de la matriz afín - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - &reftitle.examples; - - - Ejemplo de <function>ImagickDraw::affine</function> - - setStrokeWidth(1); - $draw->setStrokeOpacity(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(2); - - $PI = 3.141592653589794; - $angle = 60 * $PI / 360; - - //Scale the drawing co-ordinates. - $affineScale = array("sx" => 1.75, "sy" => 1.75, "rx" => 0, "ry" => 0, "tx" => 0, "ty" => 0); - - //Shear the drawing co-ordinates. - $affineShear = array("sx" => 1, "sy" => 1, "rx" => sin($angle), "ry" => -sin($angle), "tx" => 0, "ty" => 0); - - //Rotate the drawing co-ordinates. The shear affine matrix - //produces incorrectly scaled drawings. - $affineRotate = array("sx" => cos($angle), "sy" => cos($angle), "rx" => sin($angle), "ry" => -sin($angle), "tx" => 0, "ty" => 0,); - - //Translate (offset) the drawing - $affineTranslate = array("sx" => 1, "sy" => 1, "rx" => 0, "ry" => 0, "tx" => 30, "ty" => 30); - - //The identity affine matrix - $affineIdentity = array("sx" => 1, "sy" => 1, "rx" => 0, "ry" => 0, "tx" => 0, "ty" => 0); - - $examples = [$affineScale, $affineShear, $affineRotate, $affineTranslate, $affineIdentity,]; - - $count = 0; - - foreach ($examples as $example) { - $draw->push(); - $draw->translate(($count % 2) * 250, intval($count / 2) * 250); - $draw->translate(100, 100); - $draw->affine($example); - $draw->rectangle(-50, -50, 50, 50); - $draw->pop(); - $count++; - } - - //Create an image object which the draw commands can be rendered into - $image = new \Imagick(); - $image->newImage(500, 750, $backgroundColor); - $image->setImageFormat("png"); - - //Render the draw commands in the ImagickDraw object - //into the image. - $image->drawImage($draw); - - //Send the image to the browser - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/annotation.xml b/reference/imagick/imagickdraw/annotation.xml deleted file mode 100644 index 7ba4bca216..0000000000 --- a/reference/imagick/imagickdraw/annotation.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - - ImagickDraw::annotation - Dibuja un texto sobre una imagen - - - - &reftitle.description; - - public boolImagickDraw::annotation - floatx - floaty - stringtext - - &warn.undocumented.func; - - Dibuja un texto sobre una imagen. - - - - - &reftitle.parameters; - - - - x - - - La abscisa del texto a dibujar. - - - - - y - - - La ordenada del texto a dibujar. - - - - - text - - - El texto a dibujar. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/arc.xml b/reference/imagick/imagickdraw/arc.xml deleted file mode 100644 index ab5dc8a6da..0000000000 --- a/reference/imagick/imagickdraw/arc.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - - ImagickDraw::arc - Dibuja un arco - - - - &reftitle.description; - - public boolImagickDraw::arc - floatstart_x - floatstart_y - floatend_x - floatend_y - floatstart_angle - floatend_angle - - &warn.undocumented.func; - - Dibuja un arco, situado dentro de un rectángulo. - - - - - &reftitle.parameters; - - - - start_x - - - Abscisa del punto de inicio del arco en el rectángulo de contorno - - - - - start_y - - - Ordenada del punto de inicio del arco en el rectángulo de contorno - - - - - end_x - - - Abscisa del punto final del arco en el rectángulo de contorno - - - - - end_y - - - Ordenada del punto final del arco en el rectángulo de contorno - - - - - start_angle - - - Grado de rotación inicial - - - - - end_angle - - - Grado de rotación final - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickDraw::arc</function> - -setStrokeWidth(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(2); - - $draw->arc($startX, $startY, $endX, $endY, $startAngle, $endAngle); - - //Create an image object which the draw commands can be rendered into - $image = new \Imagick(); - $image->newImage(IMAGE_WIDTH, IMAGE_HEIGHT, $backgroundColor); - $image->setImageFormat("png"); - - //Render the draw commands in the ImagickDraw object - //into the image. - $image->drawImage($draw); - - //Send the image to the browser - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/bezier.xml b/reference/imagick/imagickdraw/bezier.xml deleted file mode 100644 index c238ec8e04..0000000000 --- a/reference/imagick/imagickdraw/bezier.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - - ImagickDraw::bezier - Dibuja una curva de Bézier - - - - &reftitle.description; - - public boolImagickDraw::bezier - arraycoordinates - - &warn.undocumented.func; - - Dibuja una curva de Bézier a través de un conjunto de puntos en la imagen. - - - - - &reftitle.parameters; - - - - coordinates - - - Array multidimensional como array( array( 'x' => 1, 'y' => 2 ), - array( 'x' => 3, 'y' => 4 ) ) - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo de <function>ImagickDraw::bezier</function> - - setStrokeOpacity(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(2); - - $smoothPointsSet = [ - [ - ['x' => 10.0 * 5, 'y' => 10.0 * 5], - ['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], - ['x' => 70.0 * 5, 'y' => 10.0 * 5], - ['x' => 90.0 * 5, 'y' => 40.0 * 5], - ], - ]; - - foreach ($smoothPointsSet as $points) { - $draw->bezier($points); - } - - $disjointPoints = [ - [ - ['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' => 80 * 5, 'y' => 50 * 5], - ['x' => 70 * 5, 'y' => 10 * 5], - ['x' => 90 * 5, 'y' => 40 * 5], - ] - ]; - $draw->translate(0, 200); - - foreach ($disjointPoints as $points) { - $draw->bezier($points); - } - - //Create an image object which the draw commands can be rendered into - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - //Render the draw commands in the ImagickDraw object - //into the image. - $imagick->drawImage($draw); - - //Send the image to the browser - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/circle.xml b/reference/imagick/imagickdraw/circle.xml deleted file mode 100644 index 5838f6fbc7..0000000000 --- a/reference/imagick/imagickdraw/circle.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - - ImagickDraw::circle - Dibuja un círculo - - - - &reftitle.description; - - public boolImagickDraw::circle - floatorigin_x - floatorigin_y - floatperimeter_x - floatperimeter_y - - &warn.undocumented.func; - - Dibuja un círculo. - - - - - &reftitle.parameters; - - - - origin_x - - - Abscisa del origen - - - - - origin_y - - - Ordenada del origen - - - - - perimeter_x - - - Abscisa del perímetro - - - - - perimeter_y - - - Ordenada del perímetro - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickDraw::circle</function> - -setStrokeOpacity(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(2); - $draw->setFontSize(72); - - $draw->circle($originX, $originY, $endX, $endY); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/clear.xml b/reference/imagick/imagickdraw/clear.xml deleted file mode 100644 index ddec2d0923..0000000000 --- a/reference/imagick/imagickdraw/clear.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - ImagickDraw::clear - Borra el objeto ImagickDraw - - - - &reftitle.description; - - public boolImagickDraw::clear - - - &warn.undocumented.func; - - Borra el objeto ImagickDraw de cualquier comando acumulado, y reinicia la - configuración que contiene a sus valores predeterminados. - - - - - &reftitle.returnvalues; - - Devuelve un objeto ImagickDraw. - - - - - - diff --git a/reference/imagick/imagickdraw/clone.xml b/reference/imagick/imagickdraw/clone.xml deleted file mode 100644 index 2b7f9bf26d..0000000000 --- a/reference/imagick/imagickdraw/clone.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - - ImagickDraw::clone - Realiza una copia exacta del objeto ImagickDraw - - - - &reftitle.description; - - public ImagickDrawImagickDraw::clone - - - &warn.undocumented.func; - - Realiza una copia exacta del objeto ImagickDraw. - - - - - &reftitle.returnvalues; - - Devuelve una copia exacta del objeto ImagickDraw. - - - - - - diff --git a/reference/imagick/imagickdraw/color.xml b/reference/imagick/imagickdraw/color.xml deleted file mode 100644 index 853a738597..0000000000 --- a/reference/imagick/imagickdraw/color.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - ImagickDraw::color - Dibuja un color sobre una imagen - - - - &reftitle.description; - - public boolImagickDraw::color - floatx - floaty - intpaint - - &warn.undocumented.func; - - Dibuja un color sobre una imagen, con el color de relleno actual, - comenzando en una posición dada, y utilizando el método de coloración - indicado. - - - - - &reftitle.parameters; - - - - x - - - Abscisa del punto de pintura - - - - - y - - - Ordenada del punto de pintura - - - - - paint - - - Una de las constantes PAINT - (imagick::PAINT_*). - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/comment.xml b/reference/imagick/imagickdraw/comment.xml deleted file mode 100644 index f6a96c32ad..0000000000 --- a/reference/imagick/imagickdraw/comment.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - ImagickDraw::comment - Añade un comentario - - - - &reftitle.description; - - public boolImagickDraw::comment - stringcomment - - &warn.undocumented.func; - - Añade un comentario al flujo de salida. - - - - - &reftitle.parameters; - - - - comment - - - La cadena de comentario - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/composite.xml b/reference/imagick/imagickdraw/composite.xml deleted file mode 100644 index 3bab5c3433..0000000000 --- a/reference/imagick/imagickdraw/composite.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - - ImagickDraw::composite - Componer una imagen con otra - - - - &reftitle.description; - - public boolImagickDraw::composite - intcomposite - floatx - floaty - floatwidth - floatheight - Imagickimage - - &warn.undocumented.func; - - Componer una imagen con otra, utilizando el operador de composición, en la posición y tamaño indicados. - - - - - &reftitle.parameters; - - - - composite - - - El operador de composición. - Una de las constantes de operador de composición - (imagick::COMPOSITE_*). - - - - - x - - - Abscisa del ángulo superior izquierdo. - - - - - y - - - Ordenada del ángulo superior izquierdo. - - - - - width - - - Ancho de la imagen de composición. - - - - - height - - - Alto de la imagen de composición. - - - - - image - - - El objeto Imagick donde se toma la composición. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickDraw::composite</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setFillOpacity(1); - $draw->setStrokeWidth(2); - $draw->setFontSize(72); - $draw->setStrokeOpacity(1); - $draw->setStrokeColor($strokeColor); - $draw->setStrokeWidth(2); - $draw->setFont("../fonts/CANDY.TTF"); - $draw->setFontSize(140); - $draw->rectangle(0, 0, 1000, 300); - $draw->setFillColor('white'); - $draw->setfillopacity(1); - $draw->annotation(50, 180, "Lorem Ipsum!"); - - //Crea un objeto imagen que sirve de base - $imagick = new \Imagick(); - $imagick->newImage(1000, 302, $backgroundColor); - $imagick->setImageFormat("png"); - - //Se aplican las órdenes de dibujo en el objeto ImagickDraw - //y en la imagen. - $imagick->drawImage($draw); - - //Se envía la imagen al navegador - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/construct.xml b/reference/imagick/imagickdraw/construct.xml deleted file mode 100644 index f7994cf8fd..0000000000 --- a/reference/imagick/imagickdraw/construct.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - ImagickDraw::__construct - El constructor ImagickDraw - - - - &reftitle.description; - - public ImagickDraw::__construct - - - &warn.undocumented.func; - - El constructor de la clase ImagickDraw. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/destroy.xml b/reference/imagick/imagickdraw/destroy.xml deleted file mode 100644 index 984fb17db6..0000000000 --- a/reference/imagick/imagickdraw/destroy.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - ImagickDraw::destroy - Libera todos los recursos asociados - - - - &reftitle.description; - - public boolImagickDraw::destroy - - - &warn.undocumented.func; - - Libera todos los recursos asociados con el objeto ImagickDraw. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/ellipse.xml b/reference/imagick/imagickdraw/ellipse.xml deleted file mode 100644 index 8862d1eb2f..0000000000 --- a/reference/imagick/imagickdraw/ellipse.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - - ImagickDraw::ellipse - Dibuja una elipse sobre una imagen - - - - &reftitle.description; - - public boolImagickDraw::ellipse - floatorigin_x - floatorigin_y - floatradius_x - floatradius_y - floatangle_start - floatangle_end - - &warn.undocumented.func; - - Dibuja una elipse sobre una imagen. - - - - - &reftitle.parameters; - - - - origin_x - - - - - - - origin_y - - - - - - - radius_x - - - - - - - radius_y - - - - - - - angle_start - - - - - - - angle_end - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickDraw::ellipse</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(2); - $draw->setFontSize(72); - - $draw->ellipse(125, 70, 100, 50, 0, 360); - $draw->ellipse(350, 70, 100, 50, 0, 315); - - $draw->push(); - $draw->translate(125, 250); - $draw->rotate(30); - $draw->ellipse(0, 0, 100, 50, 0, 360); - $draw->pop(); - - $draw->push(); - $draw->translate(350, 250); - $draw->rotate(30); - $draw->ellipse(0, 0, 100, 50, 0, 315); - $draw->pop(); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/getclippath.xml b/reference/imagick/imagickdraw/getclippath.xml deleted file mode 100644 index 37d80b14f0..0000000000 --- a/reference/imagick/imagickdraw/getclippath.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - ImagickDraw::getClipPath - Devuelve el identificador del camino actual - - - - &reftitle.description; - - public falsestringImagickDraw::getClipPath - - - &warn.undocumented.func; - - Devuelve el identificador del camino actual. - - - - - &reftitle.returnvalues; - - Devuelve un string, o &false; si no existe ningún camino. - - - - - - diff --git a/reference/imagick/imagickdraw/getcliprule.xml b/reference/imagick/imagickdraw/getcliprule.xml deleted file mode 100644 index ce48549876..0000000000 --- a/reference/imagick/imagickdraw/getcliprule.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - ImagickDraw::getClipRule - Devuelve la regla de relleno de un polígono actual - - - - &reftitle.description; - - public intImagickDraw::getClipRule - - - &warn.undocumented.func; - - Devuelve la regla de relleno de un polígono actual usada por el trazado de recorte. - - - - - &reftitle.returnvalues; - - Devuelve una constante FILLRULE (imagick::FILLRULE_*). - - - - - - diff --git a/reference/imagick/imagickdraw/getclipunits.xml b/reference/imagick/imagickdraw/getclipunits.xml deleted file mode 100644 index 007288c03f..0000000000 --- a/reference/imagick/imagickdraw/getclipunits.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - ImagickDraw::getClipUnits - Devuelve la interpretación de unidades del trazado de recorte - - - - &reftitle.description; - - public intImagickDraw::getClipUnits - - - &warn.undocumented.func; - - Devuelve la interpretación de unidades del trazado de recorte. - - - - - &reftitle.returnvalues; - - Devuelve un &integer; si se tuvo éxito. - - - - - - diff --git a/reference/imagick/imagickdraw/getfillcolor.xml b/reference/imagick/imagickdraw/getfillcolor.xml deleted file mode 100644 index 001e611c5f..0000000000 --- a/reference/imagick/imagickdraw/getfillcolor.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - ImagickDraw::getFillColor - Devuelve el color de relleno - - - - &reftitle.description; - - public ImagickPixelImagickDraw::getFillColor - - - &warn.undocumented.func; - - Devuelve el color de relleno usado cuando se dibujan objetos rellenos. - - - - - &reftitle.returnvalues; - - Devuelve un objeto ImagickPixel. - - - - - - diff --git a/reference/imagick/imagickdraw/getfillopacity.xml b/reference/imagick/imagickdraw/getfillopacity.xml deleted file mode 100644 index ae272f94ed..0000000000 --- a/reference/imagick/imagickdraw/getfillopacity.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - - ImagickDraw::getFillOpacity - Devuelve la opacidad de dibujo - - - - &reftitle.description; - - public floatImagickDraw::getFillOpacity - - - &warn.undocumented.func; - - Devuelve la opacidad de dibujo. 1.0 representa la opacidad total. - - - - - &reftitle.returnvalues; - - La opacidad. - - - - - - diff --git a/reference/imagick/imagickdraw/getfillrule.xml b/reference/imagick/imagickdraw/getfillrule.xml deleted file mode 100644 index c12b648f1e..0000000000 --- a/reference/imagick/imagickdraw/getfillrule.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - ImagickDraw::getFillRule - Devuelve la regla de relleno - - - - &reftitle.description; - - public intImagickDraw::getFillRule - - - &warn.undocumented.func; - - Devuelve la regla de relleno usada mientras se dibujan polígonos. - - - - - &reftitle.returnvalues; - - Devuelve una constante FILLRULE (imagick::FILLRULE_*). - - - - - - diff --git a/reference/imagick/imagickdraw/getfont.xml b/reference/imagick/imagickdraw/getfont.xml deleted file mode 100644 index 46bb939003..0000000000 --- a/reference/imagick/imagickdraw/getfont.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - - ImagickDraw::getFont - Devuelve la fuente - - - - &reftitle.description; - - public stringImagickDraw::getFont - - - &warn.undocumented.func; - - Devuelve un string que especifica la fuente utilizada para las anotaciones. - - - - - &reftitle.returnvalues; - - Devuelve un string en caso de éxito, y &false; en caso contrario. - - - - - - diff --git a/reference/imagick/imagickdraw/getfontfamily.xml b/reference/imagick/imagickdraw/getfontfamily.xml deleted file mode 100644 index 22c5c6aa73..0000000000 --- a/reference/imagick/imagickdraw/getfontfamily.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - - ImagickDraw::getFontFamily - Devuelve la familia de fuentes - - - - &reftitle.description; - - public stringImagickDraw::getFontFamily - - - &warn.undocumented.func; - - Devuelve la familia de fuentes de las anotaciones. - - - - - &reftitle.returnvalues; - - Devuelve la familia de fuentes de las anotaciones, o &false; si la familia de - fuentes no está configurada. - - - - - - diff --git a/reference/imagick/imagickdraw/getfontsize.xml b/reference/imagick/imagickdraw/getfontsize.xml deleted file mode 100644 index 8371742d00..0000000000 --- a/reference/imagick/imagickdraw/getfontsize.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - ImagickDraw::getFontSize - Devuelve el tamaño de punto de la fuente - - - - &reftitle.description; - - public floatImagickDraw::getFontSize - - - &warn.undocumented.func; - - Devuelve el tamaño de punto de la fuente usado cuando se escribe texto. - - - - - &reftitle.returnvalues; - - Devuelve el tamaño de punto de la fuente asociada al objeto ImagickDraw actual. - - - - - - diff --git a/reference/imagick/imagickdraw/getfontstretch.xml b/reference/imagick/imagickdraw/getfontstretch.xml deleted file mode 100644 index 9f09e26624..0000000000 --- a/reference/imagick/imagickdraw/getfontstretch.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - ImagickDraw::getFontStretch - Devuelve el estiramiento de la fuente a utilizar durante la anotación con texto - - - - &reftitle.description; - - public intImagickDraw::getFontStretch - - - - Devuelve el estiramiento de la fuente a utilizar durante la anotación con texto. Devuelve un StretchType. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/imagick/imagickdraw/getfontstyle.xml b/reference/imagick/imagickdraw/getfontstyle.xml deleted file mode 100644 index 78f7e4479e..0000000000 --- a/reference/imagick/imagickdraw/getfontstyle.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - - ImagickDraw::getFontStyle - Devuelve el estilo de la fuente - - - - &reftitle.description; - - public intImagickDraw::getFontStyle - - - &warn.undocumented.func; - - Devuelve el estilo de la fuente. - - - - - &reftitle.returnvalues; - - Devuelve una constante STYLE - (imagick::STYLE_*), asociada al objeto ImagickDraw, - o 0 si el estilo no está definido. - - - - - - diff --git a/reference/imagick/imagickdraw/getfontweight.xml b/reference/imagick/imagickdraw/getfontweight.xml deleted file mode 100644 index adbd658cde..0000000000 --- a/reference/imagick/imagickdraw/getfontweight.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - ImagickDraw::getFontWeight - Devuelve el peso de la fuente - - - - &reftitle.description; - - public intImagickDraw::getFontWeight - - - &warn.undocumented.func; - - Devuelve el peso de la fuente usada cuando se escribe texto. - - - - - &reftitle.returnvalues; - - Devuelve un &integer; si se tuvo éxito o 0 si no está estabecido ningún peso. - - - - - - diff --git a/reference/imagick/imagickdraw/getgravity.xml b/reference/imagick/imagickdraw/getgravity.xml deleted file mode 100644 index 9a290e3d66..0000000000 --- a/reference/imagick/imagickdraw/getgravity.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - - ImagickDraw::getGravity - Devuelve la gravedad de colocación de texto - - - - &reftitle.description; - - public intImagickDraw::getGravity - - - &warn.undocumented.func; - - Devuelve la gravedad de colocación de texto, utilizada durante la anotación. - - - - - &reftitle.returnvalues; - - Devuelve una constante GRAVITY - (imagick::GRAVITY_*) en caso de éxito, o 0 si la - gravedad no está configurada. - - - - - - diff --git a/reference/imagick/imagickdraw/getstrokeantialias.xml b/reference/imagick/imagickdraw/getstrokeantialias.xml deleted file mode 100644 index d85008b42a..0000000000 --- a/reference/imagick/imagickdraw/getstrokeantialias.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - ImagickDraw::getStrokeAntialias - Devuelve la configuración de antialias de contorno actual - - - - &reftitle.description; - - public boolImagickDraw::getStrokeAntialias - - - &warn.undocumented.func; - - Devuelve la configuración antialias de contorno actual. Los perfiles contorneados tienen - antialias por defecto. Cuando se deshabilita el antialias, los píxeles contorneados son - puestos en el umbral para determinar si se debería usar el color de contorno o el color - del lienzo subyacente. - - - - - &reftitle.returnvalues; - - Devuelve &true; si el antialias está on y &false; si está off. - - - - - - diff --git a/reference/imagick/imagickdraw/getstrokecolor.xml b/reference/imagick/imagickdraw/getstrokecolor.xml deleted file mode 100644 index d40f0b979c..0000000000 --- a/reference/imagick/imagickdraw/getstrokecolor.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - ImagickDraw::getStrokeColor - Devuelve el color usado por los perfiles de objetos contorneados - - - - &reftitle.description; - - public ImagickPixelImagickDraw::getStrokeColor - - - &warn.undocumented.func; - - Devuelve el color usado por los perfiles de objetos contorneados. - - - - - &reftitle.parameters; - - - - stroke_color - - - - - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto ImagickPixel que describe el color. - - - - - - diff --git a/reference/imagick/imagickdraw/getstrokedasharray.xml b/reference/imagick/imagickdraw/getstrokedasharray.xml deleted file mode 100644 index 6c406b9fa1..0000000000 --- a/reference/imagick/imagickdraw/getstrokedasharray.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - - ImagickDraw::getStrokeDashArray - Devuelve un array que representa el patrón de trazos - - - - &reftitle.description; - - public arrayImagickDraw::getStrokeDashArray - - - &warn.undocumented.func; - - Devuelve un array que representa el patrón de trazos, - los espacios y los trazos. - - - - - &reftitle.returnvalues; - - Devuelve un array en caso de éxito, y un array vacío en caso contrario. - - - - - - diff --git a/reference/imagick/imagickdraw/getstrokedashoffset.xml b/reference/imagick/imagickdraw/getstrokedashoffset.xml deleted file mode 100644 index d5911a5d7a..0000000000 --- a/reference/imagick/imagickdraw/getstrokedashoffset.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - - ImagickDraw::getStrokeDashOffset - Devuelve el desplazamiento del punto en el patrón - - - - &reftitle.description; - - public floatImagickDraw::getStrokeDashOffset - - - &warn.undocumented.func; - - Devuelve el desplazamiento del punto en el patrón. - - - - - &reftitle.returnvalues; - - Devuelve un número decimal que representa el inicio del punto en el patrón. - - - - - - diff --git a/reference/imagick/imagickdraw/getstrokelinecap.xml b/reference/imagick/imagickdraw/getstrokelinecap.xml deleted file mode 100644 index 0efee52229..0000000000 --- a/reference/imagick/imagickdraw/getstrokelinecap.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - - ImagickDraw::getStrokeLineCap - Devuelve la forma a utilizar para dibujar los extremos de subrutas - - - - &reftitle.description; - - public intImagickDraw::getStrokeLineCap - - - &warn.undocumented.func; - - Devuelve la forma a utilizar para dibujar los extremos de subrutas. - - - - - &reftitle.returnvalues; - - Devuelve una constante LINECAP - (imagick::LINECAP_*), o 0 si los extremos de líneas no están configurados. - - - - - - diff --git a/reference/imagick/imagickdraw/getstrokelinejoin.xml b/reference/imagick/imagickdraw/getstrokelinejoin.xml deleted file mode 100644 index a09532bc82..0000000000 --- a/reference/imagick/imagickdraw/getstrokelinejoin.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - - ImagickDraw::getStrokeLineJoin - Devuelve la forma a utilizar para dibujar las esquinas de un camino - - - - &reftitle.description; - - public intImagickDraw::getStrokeLineJoin - - - &warn.undocumented.func; - - Devuelve la forma a utilizar para dibujar las esquinas de un camino (u otras - formas vectoriales), cuando son dibujadas. - - - - - &reftitle.returnvalues; - - Devuelve una constante LINEJOIN - (imagick::LINEJOIN_*), - o 0 si las esquinas no están configuradas. - - - - - - diff --git a/reference/imagick/imagickdraw/getstrokemiterlimit.xml b/reference/imagick/imagickdraw/getstrokemiterlimit.xml deleted file mode 100644 index bc7fcf6399..0000000000 --- a/reference/imagick/imagickdraw/getstrokemiterlimit.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - ImagickDraw::getStrokeMiterLimit - Devuelve el valor de 'miterLimit' - - - - &reftitle.description; - - public intImagickDraw::getStrokeMiterLimit - - - &warn.undocumented.func; - - Devuelve el valor de 'miterLimit'. Cuando dos segmentos se encuentran en ángulo - agudo y se ha especificado que las uniones miter para - 'lineJoin', - es posible que el miter exceda el grosor del trazo del camino. - La 'miterLimit' establece un límite al ratio entre la longitud del miter - y 'lineWidth'. - - - - - &reftitle.returnvalues; - - Devuelve un entero que describe el valor de 'miterLimit', y - 0 si la 'miterLimit' no está configurada. - - - - - - diff --git a/reference/imagick/imagickdraw/getstrokeopacity.xml b/reference/imagick/imagickdraw/getstrokeopacity.xml deleted file mode 100644 index b0af3d7a1a..0000000000 --- a/reference/imagick/imagickdraw/getstrokeopacity.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - ImagickDraw::getStrokeOpacity - Devuelve la opacidad de los contornos de un objeto - - - - &reftitle.description; - - public floatImagickDraw::getStrokeOpacity - - - &warn.undocumented.func; - - Devuelve la opacidad de los contornos de un objeto. - - - - - &reftitle.returnvalues; - - Devuelve un float que describe la opacidad de los contornos de un objeto. - - - - - - diff --git a/reference/imagick/imagickdraw/getstrokewidth.xml b/reference/imagick/imagickdraw/getstrokewidth.xml deleted file mode 100644 index da73cc3014..0000000000 --- a/reference/imagick/imagickdraw/getstrokewidth.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - ImagickDraw::getStrokeWidth - Devuelve el ancho de trazo utilizado - - - - &reftitle.description; - - public floatImagickDraw::getStrokeWidth - - - &warn.undocumented.func; - - Devuelve el ancho de trazo utilizado. - - - - - &reftitle.returnvalues; - - Devuelve un float que describe el ancho de trazo. - - - - - - diff --git a/reference/imagick/imagickdraw/gettextalignment.xml b/reference/imagick/imagickdraw/gettextalignment.xml deleted file mode 100644 index 9b6b59619b..0000000000 --- a/reference/imagick/imagickdraw/gettextalignment.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - - ImagickDraw::getTextAlignment - Devuelve la alineación del texto - - - - &reftitle.description; - - public intImagickDraw::getTextAlignment - - - &warn.undocumented.func; - - Devuelve la alineación del texto. - - - - - &reftitle.returnvalues; - - Devuelve una constante ALIGN - (imagick::ALIGN_*), o 0 si la alineación no está configurada. - - - - - - diff --git a/reference/imagick/imagickdraw/gettextantialias.xml b/reference/imagick/imagickdraw/gettextantialias.xml deleted file mode 100644 index fb09a3e302..0000000000 --- a/reference/imagick/imagickdraw/gettextantialias.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - ImagickDraw::getTextAntialias - Devuelve la configuración de antialias del texto actual - - - - &reftitle.description; - - public boolImagickDraw::getTextAntialias - - - &warn.undocumented.func; - - Devuelve la configuración de antialias del texto actual, que determina si el texto - tiene antialias o no. El texto tiene antialias por defecto. - - - - - &reftitle.returnvalues; - - Devuelve &true; si el texto tiene antialias y &false; si no. - - - - - - diff --git a/reference/imagick/imagickdraw/gettextdecoration.xml b/reference/imagick/imagickdraw/gettextdecoration.xml deleted file mode 100644 index bc880e6c3e..0000000000 --- a/reference/imagick/imagickdraw/gettextdecoration.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - - ImagickDraw::getTextDecoration - Devuelve la decoración del texto - - - - &reftitle.description; - - public intImagickDraw::getTextDecoration - - - &warn.undocumented.func; - - Devuelve la decoración del texto de anotación. - - - - - &reftitle.returnvalues; - - Devuelve una constante DECORATION - (imagick::DECORATION_*), - o bien 0 si no se ha configurado ninguna decoración. - - - - - - diff --git a/reference/imagick/imagickdraw/gettextencoding.xml b/reference/imagick/imagickdraw/gettextencoding.xml deleted file mode 100644 index 64be99d2bf..0000000000 --- a/reference/imagick/imagickdraw/gettextencoding.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - ImagickDraw::getTextEncoding - Devuelve el juego de caracteres utilizado para las anotaciones de texto - - - - &reftitle.description; - - public falsestringImagickDraw::getTextEncoding - - - &warn.undocumented.func; - - Devuelve el juego de caracteres utilizado para las anotaciones de texto. - - - - - &reftitle.returnvalues; - - Devuelve una cadena que especifica el juego de caracteres, o bien - &false; si el juego de caracteres no está configurado. - - - - - - diff --git a/reference/imagick/imagickdraw/gettextinterlinespacing.xml b/reference/imagick/imagickdraw/gettextinterlinespacing.xml deleted file mode 100644 index 7ad1fad6c6..0000000000 --- a/reference/imagick/imagickdraw/gettextinterlinespacing.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - ImagickDraw::getTextInterlineSpacing - Obtiene el espacio entre líneas de un texto. - - - - &reftitle.description; - - public floatImagickDraw::getTextInterlineSpacing - - - - Obtiene el espacio entre líneas de un texto. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/imagick/imagickdraw/gettextinterwordspacing.xml b/reference/imagick/imagickdraw/gettextinterwordspacing.xml deleted file mode 100644 index 5e7a5d97e5..0000000000 --- a/reference/imagick/imagickdraw/gettextinterwordspacing.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - ImagickDraw::getTextInterwordSpacing - Obtiene el espacio entre palabras de un texto. - - - - &reftitle.description; - - public floatImagickDraw::getTextInterwordSpacing - - - - Obtiene el espacio entre palabras de un texto. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/imagick/imagickdraw/gettextkerning.xml b/reference/imagick/imagickdraw/gettextkerning.xml deleted file mode 100644 index 8484564e93..0000000000 --- a/reference/imagick/imagickdraw/gettextkerning.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - ImagickDraw::getTextKerning - Obtiene el interletraje de un texto. - - - - &reftitle.description; - - public floatImagickDraw::getTextKerning - - - - Obtiene el interletraje de un texto. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/imagick/imagickdraw/gettextundercolor.xml b/reference/imagick/imagickdraw/gettextundercolor.xml deleted file mode 100644 index 5240751836..0000000000 --- a/reference/imagick/imagickdraw/gettextundercolor.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - ImagickDraw::getTextUnderColor - Devuelve el color debajo del texto - - - - &reftitle.description; - - public ImagickPixelImagickDraw::getTextUnderColor - - - &warn.undocumented.func; - - Devuelve el color de un rectángulo de fondo para colocar bajo anotaciones de texto. - - - - - &reftitle.returnvalues; - - Devuelve un objeto ImagickPixel que describe el color. - - - - - - diff --git a/reference/imagick/imagickdraw/getvectorgraphics.xml b/reference/imagick/imagickdraw/getvectorgraphics.xml deleted file mode 100644 index de9f7d6fce..0000000000 --- a/reference/imagick/imagickdraw/getvectorgraphics.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - ImagickDraw::getVectorGraphics - Devuelve una cadena que contiene gráficos vectoriales - - - - &reftitle.description; - - public stringImagickDraw::getVectorGraphics - - - &warn.undocumented.func; - - Devuelve un string que especifica los gráficos vectoriales generados por cualquier - llamada a gráficos hecha desde que el objeto ImagickDraw fue instanciado. - - - - - &reftitle.returnvalues; - - Devuelve un string que contiene los gráficos vectoriales. - - - - - - diff --git a/reference/imagick/imagickdraw/line.xml b/reference/imagick/imagickdraw/line.xml deleted file mode 100644 index 812bf234e1..0000000000 --- a/reference/imagick/imagickdraw/line.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - ImagickDraw::line - Dibuja una línea - - - - &reftitle.description; - - public boolImagickDraw::line - floatstart_x - floatstart_y - floatend_x - floatend_y - - &warn.undocumented.func; - - Dibuja una línea utilizando el color de trazo actual, su opacidad y su - grosor. - - - - - &reftitle.parameters; - - - - start_x - - - La coordenada X de inicio - - - - - start_y - - - La coordenada Y de inicio - - - - - end_x - - - La coordenada X de fin - - - - - end_y - - - La coordenada Y de fin - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickDraw::line</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(2); - $draw->setFontSize(72); - - $draw->line(125, 70, 100, 50); - $draw->line(350, 170, 100, 150); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/matte.xml b/reference/imagick/imagickdraw/matte.xml deleted file mode 100644 index ceabb3df9f..0000000000 --- a/reference/imagick/imagickdraw/matte.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - - ImagickDraw::matte - Dibuja sobre el canal de opacidad de la imagen - - - - &reftitle.description; - - public boolImagickDraw::matte - floatx - floaty - intpaint - - &warn.undocumented.func; - - Dibuja sobre el canal de opacidad de la imagen, con el fin de hacer transparentes - los píxeles indicados. - - - - - &reftitle.parameters; - - - - x - - - Abscisa del mate - - - - - y - - - Ordenada del mate - - - - - paint - - - Una de las constantes PAINT - (imagick::PAINT_*). - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickDraw::matte</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(2); - $draw->setFontSize(72); - - $draw->matte(120, 120, $paintType); - $draw->rectangle(100, 100, 300, 200); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/pathclose.xml b/reference/imagick/imagickdraw/pathclose.xml deleted file mode 100644 index c8961454c1..0000000000 --- a/reference/imagick/imagickdraw/pathclose.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - - ImagickDraw::pathClose - Añade un elemento de camino al camino actual - - - - &reftitle.description; - - public boolImagickDraw::pathClose - - - &warn.undocumented.func; - - Añade un elemento de camino al camino actual, que cerrará el subcamino - dibujando una línea recta desde el punto actual hasta el punto de inicio - más reciente (generalmente, el último punto de desplazamiento). - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathcurvetoabsolute.xml b/reference/imagick/imagickdraw/pathcurvetoabsolute.xml deleted file mode 100644 index 9b7fcca144..0000000000 --- a/reference/imagick/imagickdraw/pathcurvetoabsolute.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - - ImagickDraw::pathCurveToAbsolute - Dibuja una curva de Bézier cúbica, en coordenadas absolutas - - - - &reftitle.description; - - public boolImagickDraw::pathCurveToAbsolute - floatx1 - floaty1 - floatx2 - floaty2 - floatx - floaty - - &warn.undocumented.func; - - Dibuja una curva de Bézier cúbica, a partir del punto actual - (x,y) utilizando el punto - (x1,y1) como punto de - control al inicio de la curva y - (x2,y2) como punto de control - al final de la curva, utilizando coordenadas absolutas. Al final de - la orden, el nuevo punto actual es el punto final - (x,y), utilizado por el polybezier. - - - - - &reftitle.parameters; - - - - x1 - - - Abscisa del primer punto de control - - - - - y1 - - - Ordenada del primer punto de control - - - - - x2 - - - Abscisa del segundo punto de control - - - - - y2 - - - Ordenada del segundo punto de control - - - - - x - - - Abscisa del final de la curva - - - - - y - - - Ordenada del final de la curva - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathcurvetoquadraticbezierabsolute.xml b/reference/imagick/imagickdraw/pathcurvetoquadraticbezierabsolute.xml deleted file mode 100644 index 6b2cc3698f..0000000000 --- a/reference/imagick/imagickdraw/pathcurvetoquadraticbezierabsolute.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - - ImagickDraw::pathCurveToQuadraticBezierAbsolute - Dibuja una curva de Bézier cuadrática, en coordenadas absolutas - - - - &reftitle.description; - - public boolImagickDraw::pathCurveToQuadraticBezierAbsolute - floatx1 - floaty1 - floatx_end - floaty - - &warn.undocumented.func; - - Dibuja una curva de Bézier cuadrática, en coordenadas relativas, con respecto al punto actual (x,y), utilizando el punto (x1,y1) como punto de control. Al finalizar el dibujo, el nuevo punto actual se convierte en el punto final (x,y) utilizado por el polybezier. - - - - - &reftitle.parameters; - - - - x1 - - - Abscisa del punto de control - - - - - y1 - - - Ordenada del punto de control - - - - - x_end - - - Abscisa del punto final - - - - - y - - - Ordenada del punto final - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickDraw::pathCurveToQuadraticBezierAbsolute</function> - -setStrokeOpacity(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(2); - $draw->setFontSize(72); - - $draw->pathStart(); - $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, - 250,250 - ); - - // This specifies a quadratic bezier curve with the current position as the start - // point, the control point is mirrored from the previous curves control point - // and the end point is defined by the x, y values. - $draw->pathCurveToQuadraticBezierSmoothAbsolute( - 450,250 - ); - - // This specifies a quadratic bezier curve with the current position as the start - // point, the control point is mirrored from the previous curves control point - // and the end point is defined relative from the current position by the x, y values. - $draw->pathCurveToQuadraticBezierSmoothRelative( - 200,-100 - ); - - $draw->pathFinish(); - - $imagick = new \Imagick(); - $imagick->newImage(700, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); - -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/pathcurvetoquadraticbezierrelative.xml b/reference/imagick/imagickdraw/pathcurvetoquadraticbezierrelative.xml deleted file mode 100644 index f9efeef1b6..0000000000 --- a/reference/imagick/imagickdraw/pathcurvetoquadraticbezierrelative.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - ImagickDraw::pathCurveToQuadraticBezierRelative - Dibuja una curva de Bézier cuadrática, en coordenadas relativas - - - - &reftitle.description; - - public boolImagickDraw::pathCurveToQuadraticBezierRelative - floatx1 - floaty1 - floatx_end - floaty - - &warn.undocumented.func; - - Dibuja una curva de Bézier cuadrática, en coordenadas relativas, - respecto al punto actual (x,y), - utilizando el punto (x1,y1) como - punto de control. Al finalizar el dibujo, el nuevo punto actual - se convierte en el punto final (x,y) - utilizado por el polybezier. - - - - - &reftitle.parameters; - - - - x1 - - - coordenada x de inicio - - - - - y1 - - - coordenada y de inicio - - - - - x_end - - - coordenada x de fin - - - - - y - - - coordenada y de fin - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathcurvetoquadraticbeziersmoothabsolute.xml b/reference/imagick/imagickdraw/pathcurvetoquadraticbeziersmoothabsolute.xml deleted file mode 100644 index 6df8ea287c..0000000000 --- a/reference/imagick/imagickdraw/pathcurvetoquadraticbeziersmoothabsolute.xml +++ /dev/null @@ -1,147 +0,0 @@ - - - - - - - ImagickDraw::pathCurveToQuadraticBezierSmoothAbsolute - Dibuja una curva Bézier cuadrática - - - - &reftitle.description; - - public boolImagickDraw::pathCurveToQuadraticBezierSmoothAbsolute - floatx - floaty - - - - Dibuja una curva Bézier cuadrática (usando coordenadas absolutas) desde el - punto actual a (x, y). Se asume que el punto de control es la refelxión del - punto de control del comando previo relativo al punto actual. - (Si no hay comando previo o el comando previo no es - DrawPathCurveToQuadraticBezierAbsolute, - DrawPathCurveToQuadraticBezierRelative, - DrawPathCurveToQuadraticBezierSmoothAbsolute - DrawPathCurveToQuadraticBezierSmoothRelative, se asume que el punto de control - coincide con el punto actual). Al final del comando, el nuevo punto actual se - convierte en el par de coordenadas final (x, y) usado en el Bezígono. - - - - Esta función no se puede utilizar para continuar de forma suave una curva Bézier cúbica. Solamente puede continuarse suavemente desde una curva cuadrática. - - - - - &reftitle.parameters; - - - - x - - - coordenada x final - - - - - y - - - coordenada y final - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo de <methodname>ImagickDraw::pathCurveToQuadraticBezierSmoothAbsolute</methodname> - - -setStrokeOpacity(1); -$draw->setStrokeColor("black"); -$draw->setFillColor("blue"); - -$draw->setStrokeWidth(2); -$draw->setFontSize(72); - -$draw->pathStart(); -$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, - 250,250 -); - -// This specifies a quadratic bezier curve with the current position as the start -// point, the control point is mirrored from the previous curves control point -// and the end point is defined by the x, y values. -$draw->pathCurveToQuadraticBezierSmoothAbsolute( - 450,250 -); - -// This specifies a quadratic bezier curve with the current position as the start -// point, the control point is mirrored from the previous curves control point -// and the end point is defined relative from the current position by the x, y values. -$draw->pathCurveToQuadraticBezierSmoothRelative( - 200,-100 -); - -$draw->pathFinish(); - -$imagick = new \Imagick(); -$imagick->newImage(700, 500, $backgroundColor); -$imagick->setImageFormat("png"); - -$imagick->drawImage($draw); - -header("Content-Type: image/png"); -echo $imagick->getImageBlob(); -?> -]]> - - - - - - - diff --git a/reference/imagick/imagickdraw/pathcurvetoquadraticbeziersmoothrelative.xml b/reference/imagick/imagickdraw/pathcurvetoquadraticbeziersmoothrelative.xml deleted file mode 100644 index 491253a525..0000000000 --- a/reference/imagick/imagickdraw/pathcurvetoquadraticbeziersmoothrelative.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - - ImagickDraw::pathCurveToQuadraticBezierSmoothRelative - Dibuja una curva Bézier cuadrática - - - - &reftitle.description; - - public boolImagickDraw::pathCurveToQuadraticBezierSmoothRelative - floatx - floaty - - &warn.undocumented.func; - - Dibuja una curva Bézier cuadrática (usando coordenadas relativas) desde el - punto actual a (x, y). Se asume que el punto de control es la refelxión del - punto de control del comando previo relativo al punto actual. - (Si no hay comando previo o el comando previo no es - DrawPathCurveToQuadraticBezierAbsolute, - DrawPathCurveToQuadraticBezierRelative, - DrawPathCurveToQuadraticBezierSmoothAbsolute - DrawPathCurveToQuadraticBezierSmoothRelative, se asume que el punto de control - coincide con el punto actual). Al final del comando, el nuevo punto actual se - convierte en el par de coordenadas final (x, y) usado en el Bezígono. - - - - Esta función no se puede utilizar para continuar de forma suave una curva Bézier cúbica. Solamente puede continuarse suavemente desde una curva cuadrática. - - - - - &reftitle.parameters; - - - - x - - - coordenada x final - - - - - y - - - coordenada y final - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo de <methodname>ImagickDraw::pathCurveToQuadraticBezierSmoothRelative</methodname> - - -setStrokeOpacity(1); -$draw->setStrokeColor("black"); -$draw->setFillColor("blue"); - -$draw->setStrokeWidth(2); -$draw->setFontSize(72); - -$draw->pathStart(); -$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, - 250,250 -); - -// This specifies a quadratic bezier curve with the current position as the start -// point, the control point is mirrored from the previous curves control point -// and the end point is defined by the x, y values. -$draw->pathCurveToQuadraticBezierSmoothAbsolute( - 450,250 -); - -// This specifies a quadratic bezier curve with the current position as the start -// point, the control point is mirrored from the previous curves control point -// and the end point is defined relative from the current position by the x, y values. -$draw->pathCurveToQuadraticBezierSmoothRelative( - 200,-100 -); - -$draw->pathFinish(); - -$imagick = new \Imagick(); -$imagick->newImage(700, 500, $backgroundColor); -$imagick->setImageFormat("png"); - -$imagick->drawImage($draw); - -header("Content-Type: image/png"); -echo $imagick->getImageBlob(); -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/pathcurvetorelative.xml b/reference/imagick/imagickdraw/pathcurvetorelative.xml deleted file mode 100644 index 15423afa50..0000000000 --- a/reference/imagick/imagickdraw/pathcurvetorelative.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - - ImagickDraw::pathCurveToRelative - Dibuja una curva de Bézier cúbica, en coordenadas relativas - - - - &reftitle.description; - - public boolImagickDraw::pathCurveToRelative - floatx1 - floaty1 - floatx2 - floaty2 - floatx - floaty - - &warn.undocumented.func; - - Dibuja una curva de Bézier cúbica, a partir del punto actual - (x,y) utilizando el punto - (x1,y1) como punto de - control al inicio de la curva y - (x2,y2) como punto de - control al final de la curva, utilizando coordenadas relativas. - Al finalizar la orden, el nuevo punto actual es el punto final - (x,y), utilizado por el polybezier. - - - - - &reftitle.parameters; - - - - x1 - - - Abscisa del punto de inicio - - - - - y1 - - - Ordenada del punto de inicio - - - - - x2 - - - Abscisa del punto de control final - - - - - y2 - - - Ordenada del punto de control final - - - - - x - - - Abscisa del punto final - - - - - y - - - Ordenada del punto final - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathcurvetosmoothabsolute.xml b/reference/imagick/imagickdraw/pathcurvetosmoothabsolute.xml deleted file mode 100644 index 43f00503b1..0000000000 --- a/reference/imagick/imagickdraw/pathcurvetosmoothabsolute.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - - ImagickDraw::pathCurveToSmoothAbsolute - Dibuja una curva de Bézier, en coordenadas absolutas - - - - &reftitle.description; - - public boolImagickDraw::pathCurveToSmoothAbsolute - floatx2 - floaty2 - floatx - floaty - - &warn.undocumented.func; - - Dibuja una curva de Bézier, en coordenadas absolutas, a partir del punto - actual (x,y). - El primer punto de control es la reflexión del segundo - punto de control del comando anterior, relativo al punto actual. - Si no ha habido un comando anterior, o si el comando anterior - no era DrawPathCurveToAbsolute, DrawPathCurveToRelative, - DrawPathCurveToSmoothAbsolute o DrawPathCurveToSmoothRelative, se asume - entonces que el primer punto de control coincide con el punto actual. - (x2,y2) - es el segundo punto de control (es decir, el punto de control al final - de la línea. Al final del comando, el nuevo punto actual es el punto - final, de coordenadas (x,y), - en el polybezier. - - - - - &reftitle.parameters; - - - - x2 - - - abscisa del segundo punto de control - - - - - y2 - - - ordenada del segundo punto de control - - - - - x - - - abscisa del punto de control final - - - - - y - - - ordenada del punto de control final - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathcurvetosmoothrelative.xml b/reference/imagick/imagickdraw/pathcurvetosmoothrelative.xml deleted file mode 100644 index 5d6c69a82c..0000000000 --- a/reference/imagick/imagickdraw/pathcurvetosmoothrelative.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - - ImagickDraw::pathCurveToSmoothRelative - Dibuja una curva de Bézier, en coordenadas relativas - - - - &reftitle.description; - - public boolImagickDraw::pathCurveToSmoothRelative - floatx2 - floaty2 - floatx - floaty - - &warn.undocumented.func; - - Dibuja una curva de Bézier, en coordenadas relativas, a partir del punto - actual (x,y). - El primer punto de control es la reflexión del segundo - punto de control del comando anterior, relativo al punto actual. - Si no ha habido un comando anterior, o si el comando anterior - no era DrawPathCurveToAbsolute, DrawPathCurveToRelative, - DrawPathCurveToSmoothAbsolute o DrawPathCurveToSmoothRelative, se asume - entonces que el primer punto de control coincide con el punto actual. - (x2,y2) - es el segundo punto de control (i.e., el punto de control al final - de la línea. Al final del comando, el nuevo punto actual es el punto - final, de coordenadas (x,y), - en el polybezier. - - - - - &reftitle.parameters; - - - - x2 - - - Abscisa del segundo punto de control - - - - - y2 - - - Ordenada del segundo punto de control - - - - - x - - - Abscisa del punto de control final - - - - - y - - - Ordenada del punto de control final - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathellipticarcabsolute.xml b/reference/imagick/imagickdraw/pathellipticarcabsolute.xml deleted file mode 100644 index b649f590fa..0000000000 --- a/reference/imagick/imagickdraw/pathellipticarcabsolute.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - - ImagickDraw::pathEllipticArcAbsolute - Dibuja un arco de elipse, en coordenadas absolutas - - - - &reftitle.description; - - public boolImagickDraw::pathEllipticArcAbsolute - floatrx - floatry - floatx_axis_rotation - boollarge_arc - boolsweep - floatx - floaty - - &warn.undocumented.func; - - Dibuja un arco de elipse a partir del punto actual (x, y), utilizando - coordenadas relativas. El tamaño y la orientación de la elipse - se definen mediante dos radios, (rx, ry) y una rotación xAxisRotation, - que indica cómo la elipse, en su conjunto, está situada en - el sistema de coordenadas. El centro (cx, cy) de la elipse se calcula - automáticamente para satisfacer las restricciones de los demás parámetros. - Si large_arc es &true;, entonces se dibuja el arco - más grande. - Si sweep es &true;, entonces el dibujo del arco se realiza - en sentido horario. - - - - - &reftitle.parameters; - - - - rx - - - Radio X - - - - - ry - - - Radio Y - - - - - x_axis_rotation - - - Rotación sobre el eje X - - - - - large_arc - - - Opción de large_arc_flag - - - - - sweep - - - Opción sweep_flag - - - - - x - - - La abscisa - - - - - y - - - La ordenada - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathellipticarcrelative.xml b/reference/imagick/imagickdraw/pathellipticarcrelative.xml deleted file mode 100644 index a2473b96e6..0000000000 --- a/reference/imagick/imagickdraw/pathellipticarcrelative.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - - ImagickDraw::pathEllipticArcRelative - Dibuja un arco de elipse, en coordenadas relativas - - - - &reftitle.description; - - public boolImagickDraw::pathEllipticArcRelative - floatrx - floatry - floatx_axis_rotation - boollarge_arc - boolsweep - floatx - floaty - - &warn.undocumented.func; - - Dibuja un arco de elipse a partir del punto actual (x, y), utilizando - coordenadas relativas. El tamaño y la orientación de la elipse - se definen mediante dos radios, (rx, ry) y una rotación xAxisRotation, - que indica cómo la elipse, en su conjunto, está situada en - el sistema de coordenadas. El centro (cx, cy) de la elipse se calcula - automáticamente para satisfacer las restricciones de los demás parámetros. - Si large_arc es &true;, entonces se dibuja el arco más grande. - Si sweep es &true;, entonces el dibujo del arco se realiza - en sentido horario. - - - - - &reftitle.parameters; - - - - rx - - - Radio X - - - - - ry - - - Radio Y - - - - - x_axis_rotation - - - Rotación sobre el eje X - - - - - large_arc - - - La opción de large_arc_flag - - - - - sweep - - - La opción de sweep_flag - - - - - x - - - La abscisa - - - - - y - - - La ordenada - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathfinish.xml b/reference/imagick/imagickdraw/pathfinish.xml deleted file mode 100644 index 7ca1c00392..0000000000 --- a/reference/imagick/imagickdraw/pathfinish.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - - ImagickDraw::pathFinish - Finaliza el camino actual - - - - &reftitle.description; - - public boolImagickDraw::pathFinish - - - &warn.undocumented.func; - - Finaliza el camino actual. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathlinetoabsolute.xml b/reference/imagick/imagickdraw/pathlinetoabsolute.xml deleted file mode 100644 index da5a7a698f..0000000000 --- a/reference/imagick/imagickdraw/pathlinetoabsolute.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - ImagickDraw::pathLineToAbsolute - Dibuja una línea de camino, en coordenadas absolutas - - - - &reftitle.description; - - public boolImagickDraw::pathLineToAbsolute - floatx - floaty - - &warn.undocumented.func; - - Dibuja una línea desde el punto actual hasta el punto objetivo, - utilizando coordenadas absolutas. El punto objetivo se convierte entonces en el punto - actual. - - - - - &reftitle.parameters; - - - - x - - - La abscisa de inicio - - - - - y - - - La abscisa de fin - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathlinetohorizontalabsolute.xml b/reference/imagick/imagickdraw/pathlinetohorizontalabsolute.xml deleted file mode 100644 index aeb21f7218..0000000000 --- a/reference/imagick/imagickdraw/pathlinetohorizontalabsolute.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - ImagickDraw::pathLineToHorizontalAbsolute - Dibuja una línea de camino horizontal, en coordenadas absolutas - - - - &reftitle.description; - - public boolImagickDraw::pathLineToHorizontalAbsolute - floatx - - &warn.undocumented.func; - - Dibuja una línea vertical desde el punto actual hasta el punto objetivo, - utilizando coordenadas relativas. El punto objetivo se convierte entonces en el punto - actual. - - - - - &reftitle.parameters; - - - - x - - - La abscisa - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathlinetohorizontalrelative.xml b/reference/imagick/imagickdraw/pathlinetohorizontalrelative.xml deleted file mode 100644 index 2c571e83a8..0000000000 --- a/reference/imagick/imagickdraw/pathlinetohorizontalrelative.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - ImagickDraw::pathLineToHorizontalRelative - Dibuja una línea de camino horizontal, en coordenadas relativas - - - - &reftitle.description; - - public boolImagickDraw::pathLineToHorizontalRelative - floatx - - &warn.undocumented.func; - - Dibuja una línea horizontal desde el punto actual hasta el punto objetivo, - utilizando coordenadas relativas. El punto objetivo se convierte entonces en el punto - actual. - - - - - &reftitle.parameters; - - - - x - - - La abscisa - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathlinetorelative.xml b/reference/imagick/imagickdraw/pathlinetorelative.xml deleted file mode 100644 index 8bf2736544..0000000000 --- a/reference/imagick/imagickdraw/pathlinetorelative.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - ImagickDraw::pathLineToRelative - Dibuja una línea de camino, en coordenadas relativas - - - - &reftitle.description; - - public boolImagickDraw::pathLineToRelative - floatx - floaty - - &warn.undocumented.func; - - Dibuja una línea a partir del punto actual, hasta el punto objetivo, - utilizando coordenadas relativas. El punto objetivo se convierte entonces en el punto - actual. - - - - - &reftitle.parameters; - - - - x - - - abscisa de inicio - - - - - y - - - ordenada de inicio - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathlinetoverticalabsolute.xml b/reference/imagick/imagickdraw/pathlinetoverticalabsolute.xml deleted file mode 100644 index 63163a0092..0000000000 --- a/reference/imagick/imagickdraw/pathlinetoverticalabsolute.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - ImagickDraw::pathLineToVerticalAbsolute - Dibuja una línea de camino vertical, en coordenadas absolutas - - - - &reftitle.description; - - public boolImagickDraw::pathLineToVerticalAbsolute - floaty - - &warn.undocumented.func; - - Dibuja una línea vertical desde el punto actual hasta el punto objetivo, - utilizando coordenadas absolutas. El punto objetivo se convierte entonces en el punto - actual. - - - - - &reftitle.parameters; - - - - y - - - Ordenada - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathlinetoverticalrelative.xml b/reference/imagick/imagickdraw/pathlinetoverticalrelative.xml deleted file mode 100644 index a0797f76d1..0000000000 --- a/reference/imagick/imagickdraw/pathlinetoverticalrelative.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - ImagickDraw::pathLineToVerticalRelative - Dibuja una línea de camino vertical, en coordenadas relativas - - - - &reftitle.description; - - public boolImagickDraw::pathLineToVerticalRelative - floaty - - &warn.undocumented.func; - - Dibuja una línea vertical desde el punto actual hasta el punto objetivo, - utilizando coordenadas relativas. El punto objetivo se convierte entonces en el punto - actual. - - - - - &reftitle.parameters; - - - - y - - - ordenada objetivo - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathmovetoabsolute.xml b/reference/imagick/imagickdraw/pathmovetoabsolute.xml deleted file mode 100644 index e0db407632..0000000000 --- a/reference/imagick/imagickdraw/pathmovetoabsolute.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - ImagickDraw::pathMoveToAbsolute - Inicia un nuevo subcamino, en coordenadas absolutas - - - - &reftitle.description; - - public boolImagickDraw::pathMoveToAbsolute - floatx - floaty - - &warn.undocumented.func; - - Inicia un nuevo subcamino a partir de las coordenadas indicadas, - utilizando coordenadas absolutas. El punto actual se convierte entonces - en las coordenadas especificadas. - - - - - &reftitle.parameters; - - - - x - - - La abscisa objetivo - - - - - y - - - La ordenada objetivo - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathmovetorelative.xml b/reference/imagick/imagickdraw/pathmovetorelative.xml deleted file mode 100644 index 7e57d13092..0000000000 --- a/reference/imagick/imagickdraw/pathmovetorelative.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - ImagickDraw::pathMoveToRelative - Inicia un nuevo subcamino, en coordenadas relativas - - - - &reftitle.description; - - public boolImagickDraw::pathMoveToRelative - floatx - floaty - - &warn.undocumented.func; - - Inicia un nuevo subcamino a partir de las coordenadas indicadas, - utilizando coordenadas relativas. El punto actual se convierte entonces - en las coordenadas especificadas. - - - - - &reftitle.parameters; - - - - x - - - La abscisa objetivo - - - - - y - - - La ordenada objetivo - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pathstart.xml b/reference/imagick/imagickdraw/pathstart.xml deleted file mode 100644 index 3007995a9e..0000000000 --- a/reference/imagick/imagickdraw/pathstart.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - ImagickDraw::pathStart - Declara el inicio de una lista de dibujo de trazados - - - - &reftitle.description; - - public boolImagickDraw::pathStart - - - &warn.undocumented.func; - - Declara el inicio de una lista de dibujo de trazados que finaliza con un comando - DrawPathFinish() coincidente. Todos los demás comandos DrawPath deben estar encerrados - entre comandos DrawPathFinish(). Ésto es debido a que los comandos de dibujo de trazados - son comandos subordinados y no funcionan por sí mismos. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo de <function>ImagickDraw::pathStart</function> - - setStrokeOpacity(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(2); - $draw->setFontSize(72); - - $draw->pathStart(); - $draw->pathMoveToAbsolute(50, 50); - $draw->pathLineToAbsolute(100, 50); - $draw->pathLineToRelative(0, 50); - $draw->pathLineToHorizontalRelative(-50); - $draw->pathFinish(); - - $draw->pathStart(); - $draw->pathMoveToAbsolute(50, 50); - $draw->pathMoveToRelative(300, 0); - $draw->pathLineToRelative(50, 0); - $draw->pathLineToVerticalRelative(50); - $draw->pathLineToHorizontalAbsolute(350); - $draw->pathclose(); - $draw->pathFinish(); - - $draw->pathStart(); - $draw->pathMoveToAbsolute(50, 300); - $draw->pathCurveToAbsolute(50, 300, 100, 200, 300, 300); - $draw->pathLineToVerticalAbsolute(350); - $draw->pathFinish(); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/point.xml b/reference/imagick/imagickdraw/point.xml deleted file mode 100644 index 278b49d1d6..0000000000 --- a/reference/imagick/imagickdraw/point.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - ImagickDraw::point - Dibuja un punto - - - - &reftitle.description; - - public boolImagickDraw::point - floatx - floaty - - &warn.undocumented.func; - - Dibuja un punto usando el color del contorno y el grosor del contorno en las coordenadas especificadas. - - - - - &reftitle.parameters; - - - - x - - - coordenada x del punto - - - - - y - - - coordenada y del punto - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo de <function>ImagickDraw::point</function> - - setFillColor($fillColor); - - for ($x = 0; $x < 10000; $x++) { - $draw->point(rand(0, 500), rand(0, 500)); - } - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/polygon.xml b/reference/imagick/imagickdraw/polygon.xml deleted file mode 100644 index 7aca79a9fe..0000000000 --- a/reference/imagick/imagickdraw/polygon.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - ImagickDraw::polygon - Dibuja un polígono - - - - &reftitle.description; - - public boolImagickDraw::polygon - arraycoordinates - - &warn.undocumented.func; - - Dibuja un polígono usando el contorno, el ancho del contorno, y el color de relleno o de la - textura actuales, usando el array de coordenadas especificado. - - - - - &reftitle.parameters; - - - - coordinates - - - array multidimensional como array( array( 'x' => 3, 'y' => 4 ), array( 'x' => 2, 'y' => 6 ) ); - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Ejemplo de <function>ImagickDraw::polygon</function> - - setStrokeOpacity(1); - $draw->setStrokeColor($strokeColor); - $draw->setStrokeWidth(4); - - $draw->setFillColor($fillColor); - - $points = [ - ['x' => 40 * 5, 'y' => 10 * 5], - ['x' => 20 * 5, 'y' => 20 * 5], - ['x' => 70 * 5, 'y' => 50 * 5], - ['x' => 60 * 5, 'y' => 15 * 5], - ]; - - $draw->polygon($points); - - $image = new \Imagick(); - $image->newImage(500, 300, $backgroundColor); - $image->setImageFormat("png"); - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/polyline.xml b/reference/imagick/imagickdraw/polyline.xml deleted file mode 100644 index 3df6e56f6a..0000000000 --- a/reference/imagick/imagickdraw/polyline.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - ImagickDraw::polyline - Dibuja una poli-línea - - - - &reftitle.description; - - public boolImagickDraw::polyline - arraycoordinates - - &warn.undocumented.func; - - Dibuja una poli-línea usando el contorno, el ancho del contorno, y el color de relleno - o de la textura actuales, usando el array de coordenadas especificado. - - - - - &reftitle.parameters; - - - - coordinates - - - array de coordenadas x e y: array( array( 'x' => 4, 'y' => 6 ), array( 'x' => 8, 'y' => 10 ) ) - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Ejemplo de <function>ImagickDraw::polyline</function> - - setStrokeOpacity(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(5); - - $points = [ - ['x' => 40 * 5, 'y' => 10 * 5], - ['x' => 20 * 5, 'y' => 20 * 5], - ['x' => 70 * 5, 'y' => 50 * 5], - ['x' => 60 * 5, 'y' => 15 * 5] - ]; - - $draw->polyline($points); - - $image = new \Imagick(); - $image->newImage(500, 300, $backgroundColor); - $image->setImageFormat("png"); - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/pop.xml b/reference/imagick/imagickdraw/pop.xml deleted file mode 100644 index f5bc419d58..0000000000 --- a/reference/imagick/imagickdraw/pop.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - ImagickDraw::pop - Destruye el objeto ImagickDraw actual de la pila, y lo devuelve al objeto ImagickDraw previamente metido - - - - &reftitle.description; - - public boolImagickDraw::pop - - - &warn.undocumented.func; - - Destruye el objeto ImagickDraw actual de la pila, y lo devuelve - al objeto ImagickDraw previamente metido. Pueden existir mútiples objetos ImagickDraw. - Es un error intentar sacar más objetos ImagickDraw de los que se han metido, y es una - forma apropiada sacar todos los objetos ImagickDraw que han sido metidos. - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/imagick/imagickdraw/popclippath.xml b/reference/imagick/imagickdraw/popclippath.xml deleted file mode 100644 index 6d93fb18c1..0000000000 --- a/reference/imagick/imagickdraw/popclippath.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - - ImagickDraw::popClipPath - Finaliza la definición de un camino - - - - &reftitle.description; - - public boolImagickDraw::popClipPath - - - &warn.undocumented.func; - - Finaliza la definición de un camino. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/popdefs.xml b/reference/imagick/imagickdraw/popdefs.xml deleted file mode 100644 index 38bfc72432..0000000000 --- a/reference/imagick/imagickdraw/popdefs.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - ImagickDraw::popDefs - Finaliza una lista de definiciones - - - - &reftitle.description; - - public boolImagickDraw::popDefs - - - &warn.undocumented.func; - - Finaliza una lista de definiciones. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo de <function>ImagickDraw::popDefs</function> - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setstrokeOpacity(1); - $draw->setStrokeWidth(2); - $draw->setFontSize(72); - $draw->pushDefs(); - $draw->setStrokeColor('white'); - $draw->rectangle(50, 50, 200, 200); - $draw->popDefs(); - - $draw->rectangle(300, 50, 450, 200); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/poppattern.xml b/reference/imagick/imagickdraw/poppattern.xml deleted file mode 100644 index 0dd28f40e4..0000000000 --- a/reference/imagick/imagickdraw/poppattern.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - - ImagickDraw::popPattern - Finaliza una definición de patrón - - - - &reftitle.description; - - public boolImagickDraw::popPattern - - - &warn.undocumented.func; - - Finaliza una definición de patrón. - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/imagick/imagickdraw/push.xml b/reference/imagick/imagickdraw/push.xml deleted file mode 100644 index a8ff458c77..0000000000 --- a/reference/imagick/imagickdraw/push.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - ImagickDraw::push - Clona el objeto ImagickDraw actual y lo mete en la pila - - - - &reftitle.description; - - public boolImagickDraw::push - - - &warn.undocumented.func; - - Clona el objeto ImagickDraw actual para crear un nuevo objeto ImagickDraw, que es - añadido a la pila de ImagickDraw. Los objetos de dibujo ImagickDraw originales pueden ser - devueltos invocando a ImagickDraw::pop. Los objetos ImagickDraw son almacenados en una pila - ImagickDraw. Por cada Pop debe haber habido un Push - equivalente. - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Ejemplo de <function>ImagickDraw::push</function> - - setStrokeColor($strokeColor); - $draw->setFillColor($fillModifiedColor); - $draw->setStrokeWidth(2); - $draw->setFontSize(72); - $draw->push(); - $draw->translate(50, 50); - $draw->rectangle(200, 200, 300, 300); - $draw->pop(); - $draw->setFillColor($fillColor); - $draw->rectangle(200, 200, 300, 300); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/pushclippath.xml b/reference/imagick/imagickdraw/pushclippath.xml deleted file mode 100644 index d7e35a6ad8..0000000000 --- a/reference/imagick/imagickdraw/pushclippath.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - ImagickDraw::pushClipPath - Inicia la definición de un trazado de recorte - - - - &reftitle.description; - - public boolImagickDraw::pushClipPath - stringclip_mask_id - - &warn.undocumented.func; - - Inicia la definición de un trazado de recorte el cuál está compuesto por cualquier número de - comandos de dibujo y finalizado por un comando ImagickDraw::popClipPath. - - - - - &reftitle.parameters; - - - - clip_mask_id - - - Id de la máscara de recorte - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pushdefs.xml b/reference/imagick/imagickdraw/pushdefs.xml deleted file mode 100644 index 991a4948bf..0000000000 --- a/reference/imagick/imagickdraw/pushdefs.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - ImagickDraw::pushDefs - Indica que los siguientes comandos crean elementos con nombre para un procesamiento previo - - - - &reftitle.description; - - public boolImagickDraw::pushDefs - - - &warn.undocumented.func; - - Indica que los comandos hasta un comando ImagickDraw::popDefs finalizador - crean elementos nominados (p.ej. trazados de recorte, texturas, etc.) los cuales - pueden ser procesados previamente de forma segura para la eficiencia. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/pushpattern.xml b/reference/imagick/imagickdraw/pushpattern.xml deleted file mode 100644 index f6672d7142..0000000000 --- a/reference/imagick/imagickdraw/pushpattern.xml +++ /dev/null @@ -1,165 +0,0 @@ - - - - - - - ImagickDraw::pushPattern - Indica que los comandos subsiguientes hasta un comando ImagickDraw::opPattern() comprenden la definición de un patrón nominado - - - - &reftitle.description; - - public boolImagickDraw::pushPattern - stringpattern_id - floatx - floaty - floatwidth - floatheight - - &warn.undocumented.func; - - Indica que los comandos subsiguientes hasta un comando DrawPopPattern() - comprenden la definición de un patrón nominado. Al espacio del patrón se le asigna - las coordenadas de la esquina superior izquierda, un ancho y alto, y se convierte en su propio - espacio de dibujo. Cualquier cosa que se pueda dibujar se puede usar en una definición de - patrón. Los patrones nominados se pueden usar como definiciones de contorno o pincel. - - - - - &reftitle.parameters; - - - - pattern_id - - - el id del patrón - - - - - x - - - coordenada x de la esquina superior izquierda - - - - - y - - - coordenada y de la esquina superior izquierda - - - - - width - - - ancho del patrón - - - - - height - - - alto del patrón - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Ejemplo de <function>ImagickDraw::pushPattern</function> - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(1); - $draw->setStrokeOpacity(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(1); - - $draw->pushPattern("MyFirstPattern", 0, 0, 50, 50); - for ($x = 0; $x < 50; $x += 10) { - for ($y = 0; $y < 50; $y += 5) { - $positionX = $x + (($y / 5) % 5); - $draw->rectangle($positionX, $y, $positionX + 5, $y + 5); - } - } - $draw->popPattern(); - - $draw->setFillOpacity(0); - $draw->rectangle(100, 100, 400, 400); - $draw->setFillOpacity(1); - - $draw->setFillOpacity(1); - - $draw->push(); - $draw->setFillPatternURL('#MyFirstPattern'); - $draw->setFillColor('yellow'); - $draw->rectangle(100, 100, 400, 400); - $draw->pop(); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/rectangle.xml b/reference/imagick/imagickdraw/rectangle.xml deleted file mode 100644 index 12e4f52c85..0000000000 --- a/reference/imagick/imagickdraw/rectangle.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - - ImagickDraw::rectangle - Dibuja un rectángulo - - - - &reftitle.description; - - public boolImagickDraw::rectangle - floattop_left_x - floattop_left_y - floatbottom_right_x - floatbottom_right_y - - &warn.undocumented.func; - - Dibuja un rectángulo a partir de sus coordenadas y utilizando - el trazo actual, su ancho y su patrón. - - - - - &reftitle.parameters; - - - - top_left_x - - - - - - - top_left_y - - - ordenada del ángulo superior izquierdo - - - - - bottom_right_x - - - abscisa del ángulo inferior derecho - - - - - bottom_right_y - - - ordenada del ángulo inferior derecho - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickDraw::rectangle</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeOpacity(1); - $draw->setStrokeWidth(2); - - $draw->rectangle(200, 200, 300, 300); - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/render.xml b/reference/imagick/imagickdraw/render.xml deleted file mode 100644 index b1eef05ad7..0000000000 --- a/reference/imagick/imagickdraw/render.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - - ImagickDraw::render - Realiza el renderizado de todos los dibujos en la imagen - - - - &reftitle.description; - - public boolImagickDraw::render - - - &warn.undocumented.func; - - Realiza el renderizado de todos los dibujos en la imagen. - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/imagick/imagickdraw/resetvectorgraphics.xml b/reference/imagick/imagickdraw/resetvectorgraphics.xml deleted file mode 100644 index 2b7b623d19..0000000000 --- a/reference/imagick/imagickdraw/resetvectorgraphics.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - ImagickDraw::resetVectorGraphics - Restablece los gráficos vectoriales - - - - &reftitle.description; - - public boolImagickDraw::resetVectorGraphics - - - - Restablece los gráficos vectoriales. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagickdraw/rotate.xml b/reference/imagick/imagickdraw/rotate.xml deleted file mode 100644 index 6e767a2a9d..0000000000 --- a/reference/imagick/imagickdraw/rotate.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - ImagickDraw::rotate - Aplica la rotación especificada al espacio de coordenadas actual - - - - &reftitle.description; - - public boolImagickDraw::rotate - floatdegrees - - &warn.undocumented.func; - - Aplica la rotación especificada al espacio de coordenadas actual. - - - - - &reftitle.parameters; - - - - degrees - - - grados a rotar. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo de <function>ImagickDraw::rotate</function> - - setStrokeColor($strokeColor); - $draw->setStrokeOpacity(1); - $draw->setFillColor($fillColor); - $draw->rectangle(200, 200, 300, 300); - $draw->setFillColor($fillModifiedColor); - $draw->rotate(15); - $draw->rectangle(200, 200, 300, 300); - - $image = new \Imagick(); - $image->newImage(500, 500, $backgroundColor); - $image->setImageFormat("png"); - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/roundrectangle.xml b/reference/imagick/imagickdraw/roundrectangle.xml deleted file mode 100644 index a1b991294f..0000000000 --- a/reference/imagick/imagickdraw/roundrectangle.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - - ImagickDraw::roundRectangle - Dibuja un rectángulo con esquinas redondeadas - - - - &reftitle.description; - - public boolImagickDraw::roundRectangle - floattop_left_x - floattop_left_y - floatbottom_right_x - floatbottom_right_y - floatrounding_x - floatrounding_y - - &warn.undocumented.func; - - Dibuja un rectángulo con esquinas redondeadas, a partir de dos coordenadas, - x & y, el radio de esquina y utilizando el trazo actual, su grosor - y su color de relleno. - - - - - &reftitle.parameters; - - - - top_left_x - - - La abscisa de la esquina superior izquierda - - - - - top_left_y - - - La ordenada de la esquina superior izquierda - - - - - bottom_right_x - - - La abscisa de la esquina inferior derecha - - - - - bottom_right_y - - - La ordenada de la esquina inferior derecha - - - - - rounding_x - - - El radio en x - - - - - rounding_y - - - El radio en y - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickDraw::roundRectangle</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeOpacity(1); - $draw->setStrokeWidth(2); - - $draw->roundRectangle($startX, $startY, $endX, $endY, $roundX, $roundY); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/scale.xml b/reference/imagick/imagickdraw/scale.xml deleted file mode 100644 index 4c7475be62..0000000000 --- a/reference/imagick/imagickdraw/scale.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - ImagickDraw::scale - Ajusta el factor de escala - - - - &reftitle.description; - - public boolImagickDraw::scale - floatx - floaty - - &warn.undocumented.func; - - Ajusta el factor de escala a aplicar en las direcciones horizontal y vertical - al espacio de coordenadas actual. - - - - - &reftitle.parameters; - - - - x - - - factor horizontal - - - - - y - - - factor vertical - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo de <function>ImagickDraw::scale</function> - - setStrokeColor($strokeColor); - $draw->setStrokeWidth(4); - $draw->setFillColor($fillColor); - $draw->rectangle(200, 200, 300, 300); - $draw->setFillColor($fillModifiedColor); - $draw->scale(1.4, 1.4); - $draw->rectangle(200, 200, 300, 300); - - $image = new \Imagick(); - $image->newImage(500, 500, $backgroundColor); - $image->setImageFormat("png"); - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setclippath.xml b/reference/imagick/imagickdraw/setclippath.xml deleted file mode 100644 index ba9f757d3e..0000000000 --- a/reference/imagick/imagickdraw/setclippath.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - ImagickDraw::setClipPath - Asocia un trazado de recorte nominado con la imagen - - - - &reftitle.description; - - public boolImagickDraw::setClipPath - stringclip_mask - - &warn.undocumented.func; - - Asocia un trazado de recorte nominado con la imagen. Sólo las áreas dibujadas - por el trazado de recorte serán modificadas mientras permanezca el efecto. - - - - - &reftitle.parameters; - - - - clip_mask - - - el nombre del trazado de recorte - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo de <function>ImagickDraw::setClipPath</function> - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeOpacity(1); - $draw->setStrokeWidth(2); - - $clipPathName = 'testClipPath'; - - $draw->pushClipPath($clipPathName); - $draw->rectangle(0, 0, 250, 250); - $draw->popClipPath(); - $draw->setClipPath($clipPathName); - $draw->rectangle(100, 100, 400, 400); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setcliprule.xml b/reference/imagick/imagickdraw/setcliprule.xml deleted file mode 100644 index 6d8ba1e841..0000000000 --- a/reference/imagick/imagickdraw/setcliprule.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - ImagickDraw::setClipRule - Configura la regla de relleno del polígono a utilizar con los caminos - - - - &reftitle.description; - - public boolImagickDraw::setClipRule - intfillrule - - &warn.undocumented.func; - - Configura la regla de relleno del polígono a utilizar con los caminos. - - - - - &reftitle.parameters; - - - - fillrule - - - Una de las constantes FILLRULE - (imagick::FILLRULE_*). - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickDraw::setClipRule</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeOpacity(1); - $draw->setStrokeWidth(2); - //\Imagick::FILLRULE_EVENODD - //\Imagick::FILLRULE_NONZERO - - $clipPathName = 'testClipPath'; - $draw->pushClipPath($clipPathName); - $draw->setClipRule(\Imagick::FILLRULE_EVENODD); - $draw->rectangle(0, 0, 300, 500); - $draw->rectangle(200, 0, 500, 500); - $draw->popClipPath(); - $draw->setClipPath($clipPathName); - $draw->rectangle(200, 200, 300, 300); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setclipunits.xml b/reference/imagick/imagickdraw/setclipunits.xml deleted file mode 100644 index a4f1c7ba28..0000000000 --- a/reference/imagick/imagickdraw/setclipunits.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - ImagickDraw::setClipUnits - Configura el modo de interpretación de las unidades de ruta - - - - &reftitle.description; - - public boolImagickDraw::setClipUnits - intpathunits - - &warn.undocumented.func; - - Configura el modo de interpretación de las unidades de ruta. - - - - - &reftitle.parameters; - - - - pathunits - - - El número de unidades de clip - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickDraw::setClipUnits</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeOpacity(1); - $draw->setStrokeWidth(2); - $clipPathName = 'testClipPath'; - $draw->setClipUnits(\Imagick::RESOLUTION_PIXELSPERINCH); - $draw->pushClipPath($clipPathName); - $draw->rectangle(0, 0, 250, 250); - $draw->popClipPath(); - $draw->setClipPath($clipPathName); - - //RESOLUTION_PIXELSPERINCH - //RESOLUTION_PIXELSPERCENTIMETER - - $draw->rectangle(200, 200, 300, 300); - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setfillalpha.xml b/reference/imagick/imagickdraw/setfillalpha.xml deleted file mode 100644 index 299736f502..0000000000 --- a/reference/imagick/imagickdraw/setfillalpha.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - ImagickDraw::setFillAlpha - Configura la opacidad del color de relleno - - - - &reftitle.description; - - public boolImagickDraw::setFillAlpha - floatalpha - - &warn.undocumented.func; - - Configura la opacidad a utilizar cuando el color de relleno es usado. - 1.0 es completamente opaco. - - - - - &reftitle.parameters; - - - - alpha - - - Canal alpha del color de relleno - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickDraw::setFillAlpha</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeOpacity(1); - $draw->setStrokeWidth(2); - $draw->rectangle(100, 200, 200, 300); - @$draw->setFillAlpha(0.4); - $draw->rectangle(300, 200, 400, 300); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setfillcolor.xml b/reference/imagick/imagickdraw/setfillcolor.xml deleted file mode 100644 index d5c3fbb2e7..0000000000 --- a/reference/imagick/imagickdraw/setfillcolor.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - ImagickDraw::setFillColor - Configura el color de relleno de los objetos dibujados - - - - &reftitle.description; - - public boolImagickDraw::setFillColor - ImagickPixelstringfill_color - - &warn.undocumented.func; - - Configura el color de relleno de los objetos dibujados. - - - - - &reftitle.parameters; - - - - fill_color - - - El objeto ImagickPixel a utilizar para el color. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickDraw::setFillColor</function> - -setStrokeOpacity(1); - $draw->setStrokeWidth(1.5); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->rectangle(50, 50, 150, 150); - - $draw->setFillColor("rgb(200, 32, 32)"); - $draw->rectangle(200, 50, 300, 150); - - $image = new \Imagick(); - $image->newImage(500, 500, $backgroundColor); - $image->setImageFormat("png"); - - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setfillopacity.xml b/reference/imagick/imagickdraw/setfillopacity.xml deleted file mode 100644 index 53bd4ef1b2..0000000000 --- a/reference/imagick/imagickdraw/setfillopacity.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - ImagickDraw::setFillOpacity - Configura la opacidad a utilizar para el relleno - - - - &reftitle.description; - - public boolImagickDraw::setFillOpacity - floatopacity - - &warn.undocumented.func; - - Configura la opacidad a utilizar para el relleno. - Totalmente opaco es 1.0. - - - - - &reftitle.parameters; - - - - opacity - - - La opacidad de relleno. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickDraw::setFillOpacity</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeOpacity(1); - $draw->setStrokeWidth(2); - - $draw->rectangle(100, 200, 200, 300); - - $draw->setFillOpacity(0.4); - $draw->rectangle(300, 200, 400, 300); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setfillpatternurl.xml b/reference/imagick/imagickdraw/setfillpatternurl.xml deleted file mode 100644 index 965ef83455..0000000000 --- a/reference/imagick/imagickdraw/setfillpatternurl.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - - ImagickDraw::setFillPatternURL - Configura la URL del patrón de relleno de superficies - - - - &reftitle.description; - - public boolImagickDraw::setFillPatternURL - stringfill_url - - &warn.undocumented.func; - - Configura la URL del patrón de relleno de superficies. Actualmente, solo se - soportan las URL locales ("#identifier"). Estas URL se - crean normalmente al definir un nombre de patrón de relleno con - DrawPushPattern/DrawPopPattern. - - - - - &reftitle.parameters; - - - - fill_url - - - La URL a utilizar para acceder al patrón. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/imagick/imagickdraw/setfillrule.xml b/reference/imagick/imagickdraw/setfillrule.xml deleted file mode 100644 index afa182340d..0000000000 --- a/reference/imagick/imagickdraw/setfillrule.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - - ImagickDraw::setFillRule - Configura la regla de relleno de los polígonos - - - - &reftitle.description; - - public boolImagickDraw::setFillRule - intfillrule - - &warn.undocumented.func; - - Configura la regla de relleno de los polígonos. - - - - - &reftitle.parameters; - - - - fillrule - - - Una de las constantes FILLRULE - (imagick::FILLRULE_*). - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickDraw::setFillRule</function> - -setStrokeWidth(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $fillRules = [\Imagick::FILLRULE_NONZERO, \Imagick::FILLRULE_EVENODD]; - - $points = 11; - $size = 150; - - $draw->translate(175, 160); - - for ($x = 0; $x < 2; $x++) { - $draw->setFillRule($fillRules[$x]); - $draw->pathStart(); - for ($n = 0; $n < $points * 2; $n++) { - - if ($n >= $points) { - $angle = fmod($n * 360 * 4 / $points, 360) * pi() / 180; - } - else { - $angle = fmod($n * 360 * 3 / $points, 360) * pi() / 180; - } - - $positionX = $size * sin($angle); - $positionY = $size * cos($angle); - - if ($n == 0) { - $draw->pathMoveToAbsolute($positionX, $positionY); - } - else { - $draw->pathLineToAbsolute($positionX, $positionY); - } - } - - $draw->pathClose(); - $draw->pathFinish(); - - $draw->translate(325, 0); - } - - $image = new \Imagick(); - $image->newImage(700, 320, $backgroundColor); - $image->setImageFormat("png"); - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setfont.xml b/reference/imagick/imagickdraw/setfont.xml deleted file mode 100644 index dbe93eaaae..0000000000 --- a/reference/imagick/imagickdraw/setfont.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - ImagickDraw::setFont - Establece la fuente especificada completamente para usarla cuando se escribe texto - - - - &reftitle.description; - - public boolImagickDraw::setFont - stringfont_name - - &warn.undocumented.func; - - Establece la fuente especificada completamente para usarla cuando se escribe texto. - - - - - &reftitle.parameters; - - - - font_name - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Ejemplo de <function>ImagickDraw::setFont</function> - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(2); - $draw->setFontSize(36); - - $draw->setFont("../fonts/Arial.ttf"); - $draw->annotation(50, 50, "Lorem Ipsum!"); - - $draw->setFont("../fonts/Consolas.ttf"); - $draw->annotation(50, 100, "Lorem Ipsum!"); - - $draw->setFont("../fonts/CANDY.TTF"); - $draw->annotation(50, 150, "Lorem Ipsum!"); - - $draw->setFont("../fonts/Inconsolata-dz.otf"); - $draw->annotation(50, 200, "Lorem Ipsum!"); - - $imagick = new \Imagick(); - $imagick->newImage(500, 300, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setfontfamily.xml b/reference/imagick/imagickdraw/setfontfamily.xml deleted file mode 100644 index b6abfa4230..0000000000 --- a/reference/imagick/imagickdraw/setfontfamily.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - ImagickDraw::setFontFamily - Establece la familia de fuentes para usarla cuando se escribe texto - - - - &reftitle.description; - - public boolImagickDraw::setFontFamily - stringfont_family - - &warn.undocumented.func; - - Establece la familia de fuentes para usarla cuando se escribe texto. - - - - - &reftitle.parameters; - - - - font_family - - - la familia de fuentes - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Ejemplo de <function>ImagickDraw::setFontFamily</function> - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(2); - - $draw->setFontSize(48); - - $draw->setFontFamily("Times"); - $draw->annotation(50, 50, "Lorem Ipsum!"); - - $draw->setFontFamily("AvantGarde"); - $draw->annotation(50, 100, "Lorem Ipsum!"); - - $draw->setFontFamily("NewCenturySchlbk"); - $draw->annotation(50, 150, "Lorem Ipsum!"); - - $draw->setFontFamily("Palatino"); - $draw->annotation(50, 200, "Lorem Ipsum!"); - - $imagick = new \Imagick(); - $imagick->newImage(450, 250, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setfontsize.xml b/reference/imagick/imagickdraw/setfontsize.xml deleted file mode 100644 index e8294fbcc1..0000000000 --- a/reference/imagick/imagickdraw/setfontsize.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - ImagickDraw::setFontSize - Configura el tamaño de punto para los textos - - - - &reftitle.description; - - public boolImagickDraw::setFontSize - floatpoint_size - - &warn.undocumented.func; - - Configura el tamaño de punto para los textos. - - - - - &reftitle.parameters; - - - - point_size - - - El tamaño de punto. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickDraw::setFontSize</function> - -setStrokeOpacity(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(2); - $draw->setFont("../fonts/Arial.ttf"); - - $sizes = [24, 36, 48, 60, 72]; - - foreach ($sizes as $size) { - $draw->setFontSize($size); - $draw->annotation(50, ($size * $size / 16), "Lorem Ipsum!"); - } - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setfontstretch.xml b/reference/imagick/imagickdraw/setfontstretch.xml deleted file mode 100644 index 4419e96818..0000000000 --- a/reference/imagick/imagickdraw/setfontstretch.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - - ImagickDraw::setFontStretch - Configura el estiramiento del texto - - - - &reftitle.description; - - public boolImagickDraw::setFontStretch - intstretch - - &warn.undocumented.func; - - Configura el estiramiento del texto para el dibujo de anotaciones. - La enumeración AnyStretch sirve como comodín y - significa "no importa". - - - - - &reftitle.parameters; - - - - stretch - - - Una de las constantes STRETCH - (imagick::STRETCH_*). - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickDraw::setFontStretch</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(2); - $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_ANY - ]; - - $offset = 0; - foreach ($fontStretchTypes as $fontStretch) { - $draw->setFontStretch($fontStretch); - $draw->annotation(50, 75 + $offset, "Lorem Ipsum!"); - $offset += 50; - } - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setfontstyle.xml b/reference/imagick/imagickdraw/setfontstyle.xml deleted file mode 100644 index 703c390720..0000000000 --- a/reference/imagick/imagickdraw/setfontstyle.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - - ImagickDraw::setFontStyle - Configura el estilo de la fuente - - - - &reftitle.description; - - public boolImagickDraw::setFontStyle - intstyle - - &warn.undocumented.func; - - Configura el estilo de la fuente utilizada para dibujar anotaciones. - La enumeración AnyStyle actúa como comodín, - y significa "no importa". - - - - - &reftitle.parameters; - - - - style - - - Una de las constantes STYLE - (imagick::STYLE_*). - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickDraw::setFontStyle</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(1); - $draw->setFontSize(36); - $draw->setFontStyle(\Imagick::STYLE_NORMAL); - $draw->annotation(50, 50, "Lorem Ipsum!"); - - $draw->setFontStyle(\Imagick::STYLE_ITALIC); - $draw->annotation(50, 100, "Lorem Ipsum!"); - - $draw->setFontStyle(\Imagick::STYLE_OBLIQUE); - $draw->annotation(50, 150, "Lorem Ipsum!"); - - $imagick = new \Imagick(); - $imagick->newImage(350, 300, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setfontweight.xml b/reference/imagick/imagickdraw/setfontweight.xml deleted file mode 100644 index c7e220cca0..0000000000 --- a/reference/imagick/imagickdraw/setfontweight.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - ImagickDraw::setFontWeight - Configura el peso de la fuente - - - - &reftitle.description; - - public boolImagickDraw::setFontWeight - intweight - - &warn.undocumented.func; - - Configura el peso de la fuente para dibujar anotaciones. - - - - - &reftitle.parameters; - - - - weight - - - - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickDraw::setFontWeight</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(1); - - $draw->setFontSize(36); - - $draw->setFontWeight(100); - $draw->annotation(50, 50, "Lorem Ipsum!"); - - $draw->setFontWeight(200); - $draw->annotation(50, 100, "Lorem Ipsum!"); - - $draw->setFontWeight(400); - $draw->annotation(50, 150, "Lorem Ipsum!"); - - $draw->setFontWeight(800); - $draw->annotation(50, 200, "Lorem Ipsum!"); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setgravity.xml b/reference/imagick/imagickdraw/setgravity.xml deleted file mode 100644 index 923f144767..0000000000 --- a/reference/imagick/imagickdraw/setgravity.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - - - ImagickDraw::setGravity - Configura la gravedad de colocación de texto - - - - &reftitle.description; - - public boolImagickDraw::setGravity - intgravity - - &warn.undocumented.func; - - Configura la gravedad de colocación de texto, a utilizar para dibujar - las anotaciones. - - - - - &reftitle.parameters; - - - - gravity - - - Una de las constantes GRAVITY - (imagick::GRAVITY_*). - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickDraw::setGravity</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(1); - $draw->setFontSize(24); - - $gravitySettings = array( - \Imagick::GRAVITY_NORTHWEST => 'NorthWest', - \Imagick::GRAVITY_NORTH => 'North', - \Imagick::GRAVITY_NORTHEAST => 'NorthEast', - \Imagick::GRAVITY_WEST => 'West', - \Imagick::GRAVITY_CENTER => 'Centro', - \Imagick::GRAVITY_SOUTHWEST => 'SouthWest', - \Imagick::GRAVITY_SOUTH => 'South', - \Imagick::GRAVITY_SOUTHEAST => 'SouthEast', - \Imagick::GRAVITY_EAST => 'East' - ); - - $draw->setFont("../fonts/Arial.ttf"); - - foreach ($gravitySettings as $type => $description) { - $draw->setGravity($type); - $draw->annotation(50, 50, '"' . $description . '"'); - } - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setresolution.xml b/reference/imagick/imagickdraw/setresolution.xml deleted file mode 100644 index 72d426e903..0000000000 --- a/reference/imagick/imagickdraw/setresolution.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - ImagickDraw::setResolution - Define la resolución - - - - &reftitle.description; - - public boolImagickDraw::setResolution - floatresolution_x - floatresolution_y - - - Define la resolución. - - - - - - &reftitle.parameters; - - - resolution_x - - - - - - - - resolution_y - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagickdraw/setstrokealpha.xml b/reference/imagick/imagickdraw/setstrokealpha.xml deleted file mode 100644 index b83cb73248..0000000000 --- a/reference/imagick/imagickdraw/setstrokealpha.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - ImagickDraw::setStrokeAlpha - Especifica la opacidad de los contornos de los objetos - - - - &reftitle.description; - - public boolImagickDraw::setStrokeAlpha - floatalpha - - &warn.undocumented.func; - - Especifica la opacidad de los contornos de los objetos. - - - - - &reftitle.parameters; - - - - alpha - - - La opacidad - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickDraw::setStrokeAlpha</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(4); - $draw->line(100, 100, 400, 145); - $draw->rectangle(100, 200, 225, 350); - $draw->setStrokeOpacity(0.1); - $draw->line(100, 120, 400, 165); - $draw->rectangle(275, 200, 400, 350); - - $image = new \Imagick(); - $image->newImage(500, 400, $backgroundColor); - $image->setImageFormat("png"); - - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setstrokeantialias.xml b/reference/imagick/imagickdraw/setstrokeantialias.xml deleted file mode 100644 index 46265938ce..0000000000 --- a/reference/imagick/imagickdraw/setstrokeantialias.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - ImagickDraw::setStrokeAntialias - Controla el anti-aliasing de los trazos - - - - &reftitle.description; - - public boolImagickDraw::setStrokeAntialias - boolenabled - - &warn.undocumented.func; - - Controla el anti-aliasing de los trazos. Los contornos a trazos están anti-aliaseados - por omisión. Cuando el anti-aliasing está desactivado, los trazos utilizan - un valor de umbral para definir si el píxel subyacente debe ser coloreado o no. - - - - - &reftitle.parameters; - - - - enabled - - - La configuración de uso del anti-aliasing - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickDraw::setStrokeAntialias</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(1); - $draw->setStrokeAntialias(false); - $draw->line(100, 100, 400, 105); - - $draw->line(100, 140, 400, 185); - - $draw->setStrokeAntialias(true); - $draw->line(100, 110, 400, 115); - $draw->line(100, 150, 400, 195); - - $image = new \Imagick(); - $image->newImage(500, 250, $backgroundColor); - $image->setImageFormat("png"); - - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setstrokecolor.xml b/reference/imagick/imagickdraw/setstrokecolor.xml deleted file mode 100644 index 6570dc169d..0000000000 --- a/reference/imagick/imagickdraw/setstrokecolor.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - ImagickDraw::setStrokeColor - Configura el color utilizado para dibujar objetos - - - - &reftitle.description; - - public boolImagickDraw::setStrokeColor - ImagickPixelstringcolor - - &warn.undocumented.func; - - Configura el color utilizado para dibujar objetos. - - - - - &reftitle.parameters; - - - - color - - - El color del trazo. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickDraw::setStrokeColor</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(5); - - $draw->line(100, 100, 400, 145); - $draw->rectangle(100, 200, 225, 350); - - $draw->setStrokeOpacity(0.1); - $draw->line(100, 120, 400, 165); - $draw->rectangle(275, 200, 400, 350); - - $image = new \Imagick(); - $image->newImage(500, 400, $backgroundColor); - $image->setImageFormat("png"); - - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setstrokedasharray.xml b/reference/imagick/imagickdraw/setstrokedasharray.xml deleted file mode 100644 index f518cf99c8..0000000000 --- a/reference/imagick/imagickdraw/setstrokedasharray.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - ImagickDraw::setStrokeDashArray - Especifica el patrón de trazo discontinuo - - - - &reftitle.description; - - public boolImagickDraw::setStrokeDashArray - arraynulldashes - - &warn.undocumented.func; - - Especifica el patrón de trazo discontinuo, los segmentos de línea continua y los espacios. El objeto - strokeDashArray representa un array de números que especifican las - longitudes de los segmentos de línea continua y los espacios, en píxeles. Si se proporciona un número impar de valores, - entonces la lista se repite para obtener un número par de valores. - Para eliminar un array de patrón existente, se debe pasar un array con cero elementos, y &null; como segundo valor. Un array strokeDashArray típico contiene los miembros 5 3 2. - - - - - &reftitle.parameters; - - - - dashes - - - Un array de números decimales - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickDraw::setStrokeDashArray</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(4); - - $draw->setStrokeDashArray([10, 10]); - $draw->rectangle(100, 50, 225, 175); - - $draw->setStrokeDashArray([20, 5, 20, 5, 5, 5,]); - $draw->rectangle(275, 50, 400, 175); - - $draw->setStrokeDashArray([20, 5, 20, 5, 5]); - $draw->rectangle(100, 200, 225, 350); - - $draw->setStrokeDashArray([1, 1, 1, 1, 2, 2, 3, 3, 5, 5, 8, 8, 13, 13, 21, 21, 34, 34, 55, 55, 89, 89, 144, 144, 233, 233, 377, 377, 610, 610, 987, 987, 1597, 1597, 2584, 2584, 4181, 4181,]); - - $draw->rectangle(275, 200, 400, 350); - - $image = new \Imagick(); - $image->newImage(500, 400, $backgroundColor); - $image->setImageFormat("png"); - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setstrokedashoffset.xml b/reference/imagick/imagickdraw/setstrokedashoffset.xml deleted file mode 100644 index 33b6982e03..0000000000 --- a/reference/imagick/imagickdraw/setstrokedashoffset.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - ImagickDraw::setStrokeDashOffset - Especifica el índice dentro del patrón de discontinuidad para iniciar la discontinuidad - - - - &reftitle.description; - - public boolImagickDraw::setStrokeDashOffset - floatdash_offset - - &warn.undocumented.func; - - Especifica el índice dentro del patrón de discontinuidad para iniciar la discontinuidad. - - - - - &reftitle.parameters; - - - - dash_offset - - - índice de discontinuidad - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo de <function>ImagickDraw::setStrokeDashOffset</function> - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(4); - $draw->setStrokeDashArray([20, 20]); - $draw->setStrokeDashOffset(0); - $draw->rectangle(100, 50, 225, 175); - - //Start the dash effect halfway through the solid portion - $draw->setStrokeDashOffset(10); - $draw->rectangle(275, 50, 400, 175); - - //Start the dash effect on the space portion - $draw->setStrokeDashOffset(20); - $draw->rectangle(100, 200, 225, 350); - $draw->setStrokeDashOffset(5); - $draw->rectangle(275, 200, 400, 350); - - $image = new \Imagick(); - $image->newImage(500, 400, $backgroundColor); - $image->setImageFormat("png"); - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setstrokelinecap.xml b/reference/imagick/imagickdraw/setstrokelinecap.xml deleted file mode 100644 index 27042404b8..0000000000 --- a/reference/imagick/imagickdraw/setstrokelinecap.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - - ImagickDraw::setStrokeLineCap - Especifica la forma a utilizar al final de los subcampos - - - - &reftitle.description; - - public boolImagickDraw::setStrokeLineCap - intlinecap - - &warn.undocumented.func; - - Especifica la forma a utilizar al final de los subcaminos. - - - - - &reftitle.parameters; - - - - linecap - - - Una de las constantes LINECAP - (imagick::LINECAP_*). - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickDraw::setStrokeLineCap</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(25); - - $lineTypes = [\Imagick::LINECAP_BUTT, \Imagick::LINECAP_ROUND, \Imagick::LINECAP_SQUARE,]; - - $offset = 0; - - foreach ($lineTypes as $lineType) { - $draw->setStrokeLineCap($lineType); - $draw->line(50 + $offset, 50, 50 + $offset, 250); - $offset += 50; - } - - $imagick = new \Imagick(); - $imagick->newImage(300, 300, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setstrokelinejoin.xml b/reference/imagick/imagickdraw/setstrokelinejoin.xml deleted file mode 100644 index e864a64f0e..0000000000 --- a/reference/imagick/imagickdraw/setstrokelinejoin.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - - - ImagickDraw::setStrokeLineJoin - Especifica la forma a utilizar para dibujar los extremos de las líneas - - - - &reftitle.description; - - public boolImagickDraw::setStrokeLineJoin - intlinejoin - - &warn.undocumented.func; - - Especifica la forma a utilizar para dibujar los extremos de las líneas - y otras formas vectoriales cuando utilizan un trazo. - - - - - &reftitle.parameters; - - - - linejoin - - - Una de las constantes LINEJOIN - (imagick::LINEJOIN_*). - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickDraw::setStrokeLineJoin</function> - -setStrokeWidth(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - - $draw->setStrokeWidth(20); - - $offset = 220; - - $lineJoinStyle = [ - \Imagick::LINEJOIN_MITER, - \Imagick::LINEJOIN_ROUND, - \Imagick::LINEJOIN_BEVEL, - ]; - - for ($x = 0; $x < count($lineJoinStyle); $x++) { - $draw->setStrokeLineJoin($lineJoinStyle[$x]); - $points = [ - ['x' => 40 * 5, 'y' => 10 * 5 + $x * $offset], - ['x' => 20 * 5, 'y' => 20 * 5 + $x * $offset], - ['x' => 70 * 5, 'y' => 50 * 5 + $x * $offset], - ['x' => 40 * 5, 'y' => 10 * 5 + $x * $offset], - ]; - - $draw->polyline($points); - } - - $image = new \Imagick(); - $image->newImage(500, 700, $backgroundColor); - $image->setImageFormat("png"); - - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setstrokemiterlimit.xml b/reference/imagick/imagickdraw/setstrokemiterlimit.xml deleted file mode 100644 index 1fab24c662..0000000000 --- a/reference/imagick/imagickdraw/setstrokemiterlimit.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - ImagickDraw::setStrokeMiterLimit - Especifica el límite del inglete - - - - &reftitle.description; - - public boolImagickDraw::setStrokeMiterLimit - intmiterlimit - - &warn.undocumented.func; - - Especifica el límite del inglete. Cuando dos segmentos de línea se encuentran en - un águlo agudo y la unión del inglete ha sido especificada para 'lineJoin', es posible que el - inglete se extienda más allá del grosor de la línea que contornea el trazado. - 'miterLimit' impone un límite en la proporción de la longitud del inglete a - 'lineWidth'. - - - - - &reftitle.parameters; - - - - miterlimit - - - el límite del inglete - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo de <function>ImagickDraw::setStrokeMiterLimit</function> - - setStrokeColor($strokeColor); - $draw->setStrokeOpacity(0.6); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(10); - - $yOffset = 100; - - $draw->setStrokeLineJoin(\Imagick::LINEJOIN_MITER); - - for ($y = 0; $y < 3; $y++) { - - $draw->setStrokeMiterLimit(40 * $y); - - $points = [ - ['x' => 22 * 3, 'y' => 15 * 4 + $y * $yOffset], - ['x' => 20 * 3, 'y' => 20 * 4 + $y * $yOffset], - ['x' => 70 * 5, 'y' => 45 * 4 + $y * $yOffset], - ]; - - $draw->polygon($points); - } - - $image = new \Imagick(); - $image->newImage(500, 500, $backgroundColor); - $image->setImageFormat("png"); - $image->drawImage($draw); - - $image->setImageType(\Imagick::IMGTYPE_PALETTE); - $image->setImageCompressionQuality(100); - $image->stripImage(); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setstrokeopacity.xml b/reference/imagick/imagickdraw/setstrokeopacity.xml deleted file mode 100644 index 556e471408..0000000000 --- a/reference/imagick/imagickdraw/setstrokeopacity.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - ImagickDraw::setStrokeOpacity - Especifica la opacidad para dibujar los contornos - - - - &reftitle.description; - - public boolImagickDraw::setStrokeOpacity - floatopacity - - &warn.undocumented.func; - - Especifica la opacidad para dibujar los contornos. - - - - - &reftitle.parameters; - - - - opacity - - - La opacidad del trazo. 1.0 es completamente opaco. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickDraw::setStrokeOpacity</function> - -setStrokeWidth(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(10); - $draw->setStrokeOpacity(1); - $draw->line(100, 80, 400, 125); - $draw->rectangle(25, 200, 150, 350); - $draw->setStrokeOpacity(0.5); - $draw->line(100, 100, 400, 145); - $draw->rectangle(200, 200, 325, 350); - $draw->setStrokeOpacity(0.2); - $draw->line(100, 120, 400, 165); - $draw->rectangle(375, 200, 500, 350); - - $image = new \Imagick(); - $image->newImage(550, 400, $backgroundColor); - $image->setImageFormat("png"); - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setstrokepatternurl.xml b/reference/imagick/imagickdraw/setstrokepatternurl.xml deleted file mode 100644 index 7554b976b9..0000000000 --- a/reference/imagick/imagickdraw/setstrokepatternurl.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - ImagickDraw::setStrokePatternURL - Establece el patrón usado para los perfiles de objetos contorneados - - - - &reftitle.description; - - public boolImagickDraw::setStrokePatternURL - stringstroke_url - - &warn.undocumented.func; - - Establece el patrón usado para los perfiles de objetos contorneados. - - - - - &reftitle.parameters; - - - - stroke_url - - - URL contorneada - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagickdraw/setstrokewidth.xml b/reference/imagick/imagickdraw/setstrokewidth.xml deleted file mode 100644 index 8c20f5f7e7..0000000000 --- a/reference/imagick/imagickdraw/setstrokewidth.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - ImagickDraw::setStrokeWidth - Configura el ancho del trazo para dibujar contornos - - - - &reftitle.description; - - public boolImagickDraw::setStrokeWidth - floatwidth - - &warn.undocumented.func; - - Configura el ancho del trazo para dibujar contornos. - - - - - &reftitle.parameters; - - - - width - - - El ancho del trazo - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickDraw::setStrokeWidth</function> - -setStrokeWidth(1); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->line(100, 100, 400, 145); - $draw->rectangle(100, 200, 225, 350); - $draw->setStrokeWidth(5); - $draw->line(100, 120, 400, 165); - $draw->rectangle(275, 200, 400, 350); - - $image = new \Imagick(); - $image->newImage(500, 400, $backgroundColor); - $image->setImageFormat("png"); - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/settextalignment.xml b/reference/imagick/imagickdraw/settextalignment.xml deleted file mode 100644 index 9263d42184..0000000000 --- a/reference/imagick/imagickdraw/settextalignment.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - ImagickDraw::setTextAlignment - Especifica la alineación del texto - - - - &reftitle.description; - - public boolImagickDraw::setTextAlignment - intalign - - &warn.undocumented.func; - - Especifica la alineación del texto a aplicar al texto de una anotación. - - - - - &reftitle.parameters; - - - - align - - - Una de las constantes ALIGN - (imagick::ALIGN_*). - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickDraw::setTextAlignment</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(1); - $draw->setFontSize(36); - - $draw->setTextAlignment(\Imagick::ALIGN_LEFT); - $draw->annotation(250, 75, "Lorem Ipsum!"); - $draw->setTextAlignment(\Imagick::ALIGN_CENTER); - $draw->annotation(250, 150, "Lorem Ipsum!"); - $draw->setTextAlignment(\Imagick::ALIGN_RIGHT); - $draw->annotation(250, 225, "Lorem Ipsum!"); - $draw->line(250, 0, 250, 500); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/settextantialias.xml b/reference/imagick/imagickdraw/settextantialias.xml deleted file mode 100644 index a7ac6eb027..0000000000 --- a/reference/imagick/imagickdraw/settextantialias.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - ImagickDraw::setTextAntialias - Controla el anti-aliaseo del texto - - - - &reftitle.description; - - public boolImagickDraw::setTextAntialias - boolantialias - - &warn.undocumented.func; - - Controla el anti-aliaseo del texto. El texto es anti-aliaseado por omisión. - - - - - &reftitle.parameters; - - - - antialias - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickDraw::setTextAntialias</function> - -setStrokeColor('none'); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(1); - $draw->setFontSize(32); - $draw->setTextAntialias(false); - $draw->annotation(5, 30, "Lorem Ipsum!"); - $draw->setTextAntialias(true); - $draw->annotation(5, 65, "Lorem Ipsum!"); - - $imagick = new \Imagick(); - $imagick->newImage(220, 80, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - //Scale the image so that people can see the aliasing. - $imagick->scaleImage(220 * 6, 80 * 6); - $imagick->cropImage(640, 480, 0, 0); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/settextdecoration.xml b/reference/imagick/imagickdraw/settextdecoration.xml deleted file mode 100644 index a868e1e261..0000000000 --- a/reference/imagick/imagickdraw/settextdecoration.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - - ImagickDraw::setTextDecoration - Especifica los ornamentos de texto - - - - &reftitle.description; - - public boolImagickDraw::setTextDecoration - intdecoration - - &warn.undocumented.func; - - Especifica los ornamentos de texto utilizados para las anotaciones. - - - - - &reftitle.parameters; - - - - decoration - - - Una de las constantes DECORATION - (imagick::DECORATION_*). - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickDraw::setTextDecoration</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(2); - $draw->setFontSize(72); - $draw->setTextDecoration($textDecoration); - $draw->annotation(50, 75, "Lorem Ipsum!"); - - $imagick = new \Imagick(); - $imagick->newImage(500, 200, $backgroundColor); - $imagick->setImageFormat("png"); - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/settextencoding.xml b/reference/imagick/imagickdraw/settextencoding.xml deleted file mode 100644 index 8961903bbd..0000000000 --- a/reference/imagick/imagickdraw/settextencoding.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - - ImagickDraw::setTextEncoding - Especifica el juego de caracteres - - - - &reftitle.description; - - public boolImagickDraw::setTextEncoding - stringencoding - - &warn.undocumented.func; - - Especifica el juego de caracteres a utilizar para las anotaciones de texto. - El único juego de caracteres que puede ser especificado actualmente es - "UTF-8", que representa el Unicode bajo la forma de una secuencia de octetos. - Especifique una cadena vacía para utilizar el juego de caracteres del sistema. - El dibujo de textos puede requerir una fuente que soporte Unicode. - - - - - &reftitle.parameters; - - - - encoding - - - El juego de caracteres - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/imagick/imagickdraw/settextinterlinespacing.xml b/reference/imagick/imagickdraw/settextinterlinespacing.xml deleted file mode 100644 index 4161507b36..0000000000 --- a/reference/imagick/imagickdraw/settextinterlinespacing.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - ImagickDraw::setTextInterlineSpacing - Define el espacio entre las líneas de un texto - - - - &reftitle.description; - - public boolImagickDraw::setTextInterlineSpacing - floatspacing - - - Define el espacio entre las líneas de un texto. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - spacing - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagickdraw/settextinterwordspacing.xml b/reference/imagick/imagickdraw/settextinterwordspacing.xml deleted file mode 100644 index 7d02fb750a..0000000000 --- a/reference/imagick/imagickdraw/settextinterwordspacing.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - - ImagickDraw::setTextInterwordSpacing - Define el espacio entre las palabras de un texto - - - - &reftitle.description; - - public boolImagickDraw::setTextInterwordSpacing - floatspacing - - - Define el espacio entre las palabras de un texto. - - - - - - &reftitle.parameters; - - - spacing - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagickdraw/settextkerning.xml b/reference/imagick/imagickdraw/settextkerning.xml deleted file mode 100644 index 79e497b47f..0000000000 --- a/reference/imagick/imagickdraw/settextkerning.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - ImagickDraw::setTextKerning - Define el interletraje de un texto - - - - &reftitle.description; - - public boolImagickDraw::setTextKerning - floatkerning - - - Define el interletraje de un texto. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - kerning - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagickdraw/settextundercolor.xml b/reference/imagick/imagickdraw/settextundercolor.xml deleted file mode 100644 index e15f6acc2d..0000000000 --- a/reference/imagick/imagickdraw/settextundercolor.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - ImagickDraw::setTextUnderColor - Especifica el color de fondo de un rectángulo - - - - &reftitle.description; - - public boolImagickDraw::setTextUnderColor - ImagickPixelstringunder_color - - &warn.undocumented.func; - - Especifica el color de fondo de un rectángulo a colocar bajo los textos. - - - - - &reftitle.parameters; - - - - under_color - - - El color de fondo - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickDraw::setTextUnderColor</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(2); - $draw->setFontSize(72); - $draw->annotation(50, 75, "Lorem Ipsum!"); - $draw->setTextUnderColor($textUnderColor); - $draw->annotation(50, 175, "Lorem Ipsum!"); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setvectorgraphics.xml b/reference/imagick/imagickdraw/setvectorgraphics.xml deleted file mode 100644 index 74c9331cf4..0000000000 --- a/reference/imagick/imagickdraw/setvectorgraphics.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - ImagickDraw::setVectorGraphics - Establece los gráficos vectoriales - - - - &reftitle.description; - - public boolImagickDraw::setVectorGraphics - stringxml - - &warn.undocumented.func; - - Establece los gráficos vectoriales asociados al objeto ImagickDraw - especificado. Use este método con ImagickDraw::getVectorGraphics como un método - de persistencia del estado de los gráficos vectoriales. - - - - - &reftitle.parameters; - - - - xml - - - archivo xml que contiene los gráficos vectoriales - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Ejemplo de <function>ImagickDraw::setVectorGraphics</function> - - setFillColor("red"); - $draw->circle(20, 20, 50, 50); - $draw->setFillColor("blue"); - $draw->circle(50, 70, 50, 50); - $draw->rectangle(50, 120, 80, 150); - - //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. - $draw2->setVectorGraphics("".$SVG.""); - - $imagick = new \Imagick(); - $imagick->newImage(200, 200, 'white'); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw2); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/setviewbox.xml b/reference/imagick/imagickdraw/setviewbox.xml deleted file mode 100644 index c9f3bc912c..0000000000 --- a/reference/imagick/imagickdraw/setviewbox.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - - ImagickDraw::setViewbox - Configura el tamaño del lienzo - - - - &reftitle.description; - - public boolImagickDraw::setViewbox - intleft_x - inttop_y - intright_x - intbottom_y - - &warn.undocumented.func; - - Configura el tamaño general del lienzo, a registrar con los datos - vectoriales. Generalmente, este valor se configura con el mismo tamaño - que la imagen. Cuando los datos vectoriales se guardan en SVG o MVG, - la caja de vista se utiliza para especificar el tamaño de la imagen en la que - el visualizador dibujará los datos. - - - - - &reftitle.parameters; - - - - left_x - - - Abscisa izquierda - - - - - top_y - - - Ordenada superior - - - - - right_x - - - Abscisa derecha - - - - - bottom_y - - - Ordenada inferior - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickDraw::setViewBox</function> - -setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->setStrokeWidth(2); - $draw->setFontSize(72); - - /* - Configura el tamaño general del lienzo a registrar con los datos vectoriales. Generalmente, este valor se configura con el mismo tamaño que la imagen. Cuando los datos vectoriales se guardan en SVG o MVG, la caja de vista se utiliza para especificar el tamaño de la imagen en la que el visualizador dibujará los datos. - */ - - $draw->circle(250, 250, 250, 0); - $draw->setviewbox(0, 0, 200, 200); - $draw->circle(125, 250, 250, 250); - $draw->translate(250, 125); - $draw->circle(0, 0, 125, 0); - - $imagick = new \Imagick(); - $imagick->newImage(500, 500, $backgroundColor); - $imagick->setImageFormat("png"); - - $imagick->drawImage($draw); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/skewx.xml b/reference/imagick/imagickdraw/skewx.xml deleted file mode 100644 index 70c5bf83bf..0000000000 --- a/reference/imagick/imagickdraw/skewx.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - ImagickDraw::skewX - Tuerce el sistema de coordenadas actual en la dirección horizontal - - - - &reftitle.description; - - public boolImagickDraw::skewX - floatdegrees - - &warn.undocumented.func; - - Tuerce el sistema de coordenadas actual en la dirección horizontal. - - - - - &reftitle.parameters; - - - - degrees - - - grados de torción - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo de <function>ImagickDraw::skewX</function> - - setStrokeColor($strokeColor); - $draw->setStrokeWidth(2); - $draw->setFillColor($fillColor); - $draw->rectangle($startX, $startY, $endX, $endY); - $draw->setFillColor($fillModifiedColor); - $draw->skewX($skew); - $draw->rectangle($startX, $startY, $endX, $endY); - - $image = new \Imagick(); - $image->newImage(500, 500, $backgroundColor); - $image->setImageFormat("png"); - - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/skewy.xml b/reference/imagick/imagickdraw/skewy.xml deleted file mode 100644 index ebdb622c83..0000000000 --- a/reference/imagick/imagickdraw/skewy.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - ImagickDraw::skewY - Tuerce el sistema de coordenadas actual en la dirección vertical - - - - &reftitle.description; - - public boolImagickDraw::skewY - floatdegrees - - &warn.undocumented.func; - - Tuerce el sistema de coordenadas actual en la dirección vertical. - - - - - &reftitle.parameters; - - - - degrees - - - grados de torción - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo de <function>ImagickDraw::skewY</function> - - setStrokeColor($strokeColor); - $draw->setStrokeWidth(2); - $draw->setFillColor($fillColor); - $draw->rectangle($startX, $startY, $endX, $endY); - $draw->setFillColor($fillModifiedColor); - $draw->skewY($skew); - $draw->rectangle($startX, $startY, $endX, $endY); - - $image = new \Imagick(); - $image->newImage(500, 500, $backgroundColor); - $image->setImageFormat("png"); - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdraw/translate.xml b/reference/imagick/imagickdraw/translate.xml deleted file mode 100644 index d3218145c0..0000000000 --- a/reference/imagick/imagickdraw/translate.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - - ImagickDraw::translate - Aplica una traslación del sistema de coordenadas actual - - - - &reftitle.description; - - public boolImagickDraw::translate - floatx - floaty - - &warn.undocumented.func; - - Aplica una traslación del sistema de coordenadas actual el cuál mueve el - origen del sistema de coordenadas a las coordenadas especifiacadas. - - - - - &reftitle.parameters; - - - - x - - - traslación horizontal - - - - - y - - - traslación vertical - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo de <function>ImagickDraw::translate</function> - - setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->rectangle($startX, $startY, $endX, $endY); - - $draw->setFillColor($fillModifiedColor); - $draw->translate($translateX, $translateY); - $draw->rectangle($startX, $startY, $endX, $endY); - - $image = new \Imagick(); - $image->newImage(500, 500, $backgroundColor); - $image->setImageFormat("png"); - - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickdrawexception.xml b/reference/imagick/imagickdrawexception.xml deleted file mode 100644 index 5de80f9c0d..0000000000 --- a/reference/imagick/imagickdrawexception.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - La clase ImagickDrawException - ImagickDrawException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - - ImagickDrawException - - - - - ImagickDrawException - - - - extends - Exception - - - - Throwable - - - &InheritedProperties; - - - - &InheritedMethods; - - - - - - -
    - -
    - -
    - diff --git a/reference/imagick/imagickexception.xml b/reference/imagick/imagickexception.xml deleted file mode 100644 index b752e8708e..0000000000 --- a/reference/imagick/imagickexception.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - La clase ImagickException - ImagickException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - - ImagickException - - - - - ImagickException - - - - extends - Exception - - - - Throwable - - - &InheritedProperties; - - - - &InheritedMethods; - - - - - - -
    - -
    - -
    - diff --git a/reference/imagick/imagickkernel.xml b/reference/imagick/imagickkernel.xml deleted file mode 100644 index 17969999b7..0000000000 --- a/reference/imagick/imagickkernel.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - La clase ImagickKernel - ImagickKernel - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - ImagickKernel - - - - - ImagickKernel - - - - - &Methods; - - - - -
    - -
    - - &reference.imagick.entities.imagickkernel; - -
    - - diff --git a/reference/imagick/imagickkernel/addkernel.xml b/reference/imagick/imagickkernel/addkernel.xml deleted file mode 100644 index 1a257e4857..0000000000 --- a/reference/imagick/imagickkernel/addkernel.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - ImagickKernel::addKernel - Adjunta otro núcleo a una lista de núcleos - - - - &reftitle.description; - - public voidImagickKernel::addKernel - ImagickKernelImagickKernel - - - Adjunta otro núcleo a este núcleo para permitir que ambos sean aplicados en una sola función de morfología o filtro. Devuelve el nuevo núcleo combinado. - - - - - - &reftitle.parameters; - - - ImagickKernel - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - - <function>ImagickKernel::addKernel</function> - - addKernel($kernel2); - - $imagick = new \Imagick(realpath($imagePath)); - $imagick->filter($kernel1); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); - -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickkernel/addunitykernel.xml b/reference/imagick/imagickkernel/addunitykernel.xml deleted file mode 100644 index 5a3a752785..0000000000 --- a/reference/imagick/imagickkernel/addunitykernel.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - ImagickKernel::addUnityKernel - Añade un núcleo Unity a la lista de núcleos - - - - &reftitle.description; - - public voidImagickKernel::addUnityKernel - floatscale - - - Añade una cantidad dada del núcleo de convolución 'Unity' al núcleo de convolución pre-escalado - y normalizado dado. Esto tiene como efecto añadir esta cantidad de la imagen original - en el núcleo de convolución resultante. El efecto resultante es convertir los núcleos - definidos en desenfoques suaves mezclados, en núcleos no afilados o en núcleos de nitidez. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - - <function>ImagickKernel::addUnityKernel</function> - - "; - - foreach ($matrix as $row) { - $output .= ""; - foreach ($row as $cell) { - $output .= ""; - if ($cell === false) { - $output .= "false"; - } - else { - $output .= round($cell, 3); - } - $output .= ""; - } - $output .= ""; - } - - $output .= ""; - - return $output; - } - - $matrix = [ - [-1, 0, -1], - [ 0, 4, 0], - [-1, 0, -1], - ]; - - $kernel = \ImagickKernel::fromMatrix($matrix); - $kernel->scale(1, \Imagick::NORMALIZE_KERNEL_VALUE); - $output = "Before adding unity kernel:
    "; - $output .= renderKernelTable($kernel->getMatrix()); - $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()); - - echo $output; - -?> -]]> -
    -
    - - - <function>ImagickKernel::addUnityKernel</function> - - scale(4, \Imagick::NORMALIZE_KERNEL_VALUE); - $kernel->addUnityKernel(0.5); - - $imagick = new \Imagick(realpath($imagePath)); - $imagick->filter($kernel); - header("Content-Type: image/jpg"); - echo $imagick->getImageBlob(); - -} - -?> -]]> - - -
    -
    - -
    - - diff --git a/reference/imagick/imagickkernel/frombuiltin.xml b/reference/imagick/imagickkernel/frombuiltin.xml deleted file mode 100644 index 70603f0c19..0000000000 --- a/reference/imagick/imagickkernel/frombuiltin.xml +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - ImagickKernel::fromBuiltIn - Crear un núcleo a partir de un núcleo integrado - - - - &reftitle.description; - - public static ImagickKernelImagickKernel::fromBuiltin - intkernelType - stringkernelString - - - Crear un núcleo a partir de un núcleo integrado. Ver http://www.imagemagick.org/Usage/morphology/#kernel para ejemplos. Actualmente, los símbolos de 'rotación' no son soportados. Ejemplo: - $diamondKernel = ImagickKernel::fromBuiltIn(\Imagick::KERNEL_DIAMOND, "2"); - - - - - - &reftitle.parameters; - - - kerneltype - - - El tipo de núcleo a construir, por ejemplo \Imagick::KERNEL_DIAMOND - - - - - kernelString - - - Una cadena que describe los parámetros, por ejemplo "4,2.5" - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - - <function>ImagickKernel::fromBuiltin</function> - - getMatrix(); - - $imageMargin = 20; - - $tileSize = 20; - $tileSpace = 4; - $shadowSigma = 4; - $shadowDropX = 20; - $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(); - foreach ($row as $cell) { - if ($cell !== false) { - $color = intval(255 * $cell); - $colorString = sprintf("rgb(%f, %f, %f)", $color, $color, $color); - $imagickDraw->setFillColor($colorString); - $imagickDraw->rectangle(0, 0, $tileSize, $tileSize); - } - $imagickDraw->translate(($tileSize + $tileSpace), 0); - } - $imagickDraw->pop(); - $imagickDraw->translate(0, ($tileSize + $tileSpace)); - } - - $imagickDraw->pop(); - - $width = ($columns * $tileSize) + (($columns - 1) * $tileSpace); - $height = ($rows * $tileSize) + (($rows - 1) * $tileSpace); - - $imagickDraw->push(); - $imagickDraw->translate($width/2 , $height/2); - $imagickDraw->setFillColor('rgba(0, 0, 0, 0)'); - $imagickDraw->setStrokeColor('white'); - $imagickDraw->circle(0, 0, $radius - 1, 0); - $imagickDraw->setStrokeColor('black'); - $imagickDraw->circle(0, 0, $radius, 0); - $imagickDraw->pop(); - - $canvasWidth = $width + (2 * $imageMargin); - $canvasHeight = $height + (2 * $imageMargin); - - $kernel = new \Imagick(); - $kernel->newPseudoImage( - $canvasWidth, - $canvasHeight, - 'canvas:none' - ); - - $kernel->setImageFormat('png'); - $kernel->drawImage($imagickDraw); - - /* crear una sombra paralela en su propia capa */ - $canvas = $kernel->clone(); - $canvas->setImageBackgroundColor(new \ImagickPixel('rgb(0, 0, 0)')); - $canvas->shadowImage(100, $shadowSigma, $shadowDropX, $shadowDropY); - - $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'); - - return $canvas; -} - - -function createFromBuiltin($kernelType, $kernelFirstTerm, $kernelSecondTerm, $kernelThirdTerm) { - $string = ''; - - if ($kernelFirstTerm != false && strlen(trim($kernelFirstTerm)) != 0) { - $string .= $kernelFirstTerm; - - if ($kernelSecondTerm != false && strlen(trim($kernelSecondTerm)) != 0) { - $string .= ','.$kernelSecondTerm; - if ($kernelThirdTerm != false && strlen(trim($kernelThirdTerm)) != 0) { - $string .= ','.$kernelThirdTerm; - } - } - } - - $kernel = ImagickKernel::fromBuiltIn( - $kernelType, - $string - ); - - return $kernel; -} - -function fromBuiltin($kernelType, $kernelFirstTerm, $kernelSecondTerm, $kernelThirdTerm) { - $diamondKernel = createFromBuiltin($kernelType, $kernelFirstTerm, $kernelSecondTerm, $kernelThirdTerm); - $imagick = renderKernel($diamondKernel); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -fromBuiltin(\Imagick::KERNEL_DIAMOND, 2, false, false); - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickkernel/frommatrix.xml b/reference/imagick/imagickkernel/frommatrix.xml deleted file mode 100644 index 96d1ce01cb..0000000000 --- a/reference/imagick/imagickkernel/frommatrix.xml +++ /dev/null @@ -1,196 +0,0 @@ - - - - - - ImagickKernel::fromMatrix - Crear un núcleo a partir de una matriz 2D de valores - - - - &reftitle.description; - - public static ImagickKernelImagickKernel::fromMatrix - arraymatrix - arrayorigin - - - Crear un núcleo a partir de una matriz 2D de valores. Cada valor debe ser un float - (si el elemento debe ser utilizado) o 'false' si el elemento debe ser ignorado. Para - las matrices que tienen tamaños impares en ambas dimensiones, el píxel de origen será por defecto - en el centro del núcleo. Para todas las demás dimensiones de núcleo, el píxel de origen debe ser especificado. - - - - - - &reftitle.parameters; - - - array - - - Una matriz (es decir, un array 2D) de valores que definen el núcleo. Cada elemento debe ser un valor float, o FALSE si este elemento no debe ser utilizado por el núcleo. - - - - - array - - - Cuál elemento del núcleo debe ser utilizado como píxel de origen. Por ejemplo, para una matriz 3x3 especificando el origen como [2, 2] especificaría que el elemento en la parte inferior derecha debería ser el píxel de origen. - - - - - - - - &reftitle.returnvalues; - - El objeto ImagickKernel generado. - - - - - &reftitle.examples; - - - <function>ImagickKernel::fromMatrix</function> - - getMatrix(); - - $imageMargin = 20; - - $tileSize = 20; - $tileSpace = 4; - $shadowSigma = 4; - $shadowDropX = 20; - $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(); - foreach ($row as $cell) { - if ($cell !== false) { - $color = intval(255 * $cell); - $colorString = sprintf("rgb(%f, %f, %f)", $color, $color, $color); - $imagickDraw->setFillColor($colorString); - $imagickDraw->rectangle(0, 0, $tileSize, $tileSize); - } - $imagickDraw->translate(($tileSize + $tileSpace), 0); - } - $imagickDraw->pop(); - $imagickDraw->translate(0, ($tileSize + $tileSpace)); - } - - $imagickDraw->pop(); - - $width = ($columns * $tileSize) + (($columns - 1) * $tileSpace); - $height = ($rows * $tileSize) + (($rows - 1) * $tileSpace); - - $imagickDraw->push(); - $imagickDraw->translate($width/2 , $height/2); - $imagickDraw->setFillColor('rgba(0, 0, 0, 0)'); - $imagickDraw->setStrokeColor('white'); - $imagickDraw->circle(0, 0, $radius - 1, 0); - $imagickDraw->setStrokeColor('black'); - $imagickDraw->circle(0, 0, $radius, 0); - $imagickDraw->pop(); - - $canvasWidth = $width + (2 * $imageMargin); - $canvasHeight = $height + (2 * $imageMargin); - - $kernel = new \Imagick(); - $kernel->newPseudoImage( - $canvasWidth, - $canvasHeight, - 'canvas:none' - ); - - $kernel->setImageFormat('png'); - $kernel->drawImage($imagickDraw); - - /* crear una sombra paralela en su propia capa */ - $canvas = $kernel->clone(); - $canvas->setImageBackgroundColor(new \ImagickPixel('rgb(0, 0, 0)')); - $canvas->shadowImage(100, $shadowSigma, $shadowDropX, $shadowDropY); - - $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'); - - return $canvas; -} - -function createFromMatrix() { - $matrix = [ - [0.5, 0, 0.2], - [0, 1, 0], - [0.9, 0, false], - ]; - - $kernel = \ImagickKernel::fromMatrix($matrix); - - return $kernel; -} - -function fromMatrix() { - $kernel = createFromMatrix(); - $imagick = renderKernel($kernel); - - header("Content-Type: image/png"); - echo $imagick->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickkernel/getmatrix.xml b/reference/imagick/imagickkernel/getmatrix.xml deleted file mode 100644 index a8cc88c969..0000000000 --- a/reference/imagick/imagickkernel/getmatrix.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - ImagickKernel::getMatrix - Devuelve la matriz 2D de los valores utilizados en este núcleo - - - - &reftitle.description; - - public arrayImagickKernel::getMatrix - - - - Devuelve la matriz 2D de los valores utilizados en este núcleo. Los elementos son - flotantes para los elementos que son utilizados, o 'false' si el elemento debe ser ignorado. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Una matriz (array 2D) de los valores que representan el núcleo. - - - - - &reftitle.examples; - - - <function>ImagickKernel::getMatrix</function> - - "; - - foreach ($matrix as $row) { - $output .= ""; - foreach ($row as $cell) { - $output .= ""; - if ($cell === false) { - $output .= "false"; - } - else { - $output .= round($cell, 3); - } - $output .= ""; - } - $output .= ""; - } - - $output .= ""; - - return $output; -} - - $output = "El nombre de núcleo interno 'ring' con parámetros de '2,3.5':
    "; - $kernel = \ImagickKernel::fromBuiltIn( - \Imagick::KERNEL_RING, - "2,3.5" - ); - $matrix = $kernel->getMatrix(); - $output .= renderKernelTable($matrix); - - echo $output; - -?> -]]> -
    -
    -
    -
    - -
    - - diff --git a/reference/imagick/imagickkernel/scale.xml b/reference/imagick/imagickkernel/scale.xml deleted file mode 100644 index feab782dc8..0000000000 --- a/reference/imagick/imagickkernel/scale.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - ImagickKernel::scale - Redimensiona una lista de núcleos por la cantidad dada - - - - &reftitle.description; - - public voidImagickKernel::scale - floatscale - intnormalizeFlag - - - Redimensiona la lista de núcleos dada por la cantidad dada, con o sin - normalización de la suma de los valores del núcleo (según los indicadores dados). - - El comportamiento exacto de esta función depende del tipo de normalización utilizado - consúltense http://www.imagemagick.org/api/morphology.php#ScaleKernelInfo para más detalles. - - - - - - &reftitle.parameters; - - - - scale - - - - - - - - normalizeFlag - - - - Imagick::NORMALIZE_KERNEL_NONE - Imagick::NORMALIZE_KERNEL_VALUE - Imagick::NORMALIZE_KERNEL_CORRELATE - Imagick::NORMALIZE_KERNEL_PERCENT - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - - <function>ImagickKernel::scale</function> - - "; - - foreach ($matrix as $row) { - $output .= ""; - foreach ($row as $cell) { - $output .= ""; - if ($cell === false) { - $output .= "false"; - } - else { - $output .= round($cell, 3); - } - $output .= ""; - } - $output .= ""; - } - - $output .= ""; - - return $output; - } - - $output = ""; - - $matrix = [ - [-1, 0, -1], - [ 0, 4, 0], - [-1, 0, -1], - ]; - - $kernel = \ImagickKernel::fromMatrix($matrix); - $kernelClone = clone $kernel; - - $output .= "Núcleo inicial
    "; - $output .= renderKernelTable($kernel->getMatrix()); - - $output .= "Redimensionamiento con NORMALIZE_KERNEL_VALUE. El
    "; - $kernel->scale(2, \Imagick::NORMALIZE_KERNEL_VALUE); - $output .= renderKernelTable($kernel->getMatrix()); - - $kernel = clone $kernelClone; - $output .= "Redimensionamiento por porcentaje
    "; - $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 .= "Redimensionamiento por correlación
    "; - $kernel->scale(1, \Imagick::NORMALIZE_KERNEL_CORRELATE); - $output .= renderKernelTable($kernel->getMatrix()); - - return $output; -?> -]]> -
    -
    -
    -
    - -
    - - diff --git a/reference/imagick/imagickkernel/separate.xml b/reference/imagick/imagickkernel/separate.xml deleted file mode 100644 index 12be826a3d..0000000000 --- a/reference/imagick/imagickkernel/separate.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - ImagickKernel::separate - Separa un conjunto de núcleos vinculados y devuelve un array de ImagickKernels - - - - &reftitle.description; - - public arrayImagickKernel::separate - - - - Separa un conjunto de núcleos vinculados y devuelve un array de ImagickKernels. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - - <function>ImagickKernel::separate</function> - - "; - foreach ($matrix as $row) { - $output .= ""; - foreach ($row as $cell) { - $output .= ""; - if ($cell === false) { - $output .= "false"; - } - else { - $output .= round($cell, 3); - } - $output .= ""; - } - $output .= ""; - } - - $output .= ""; - - return $output; - } - - $matrix = [ - [-1, 0, -1], - [ 0, 4, 0], - [-1, 0, -1], - ]; - - $kernel = \ImagickKernel::fromMatrix($matrix); - $kernel->scale(4, \Imagick::NORMALIZE_KERNEL_VALUE); - $diamondKernel = \ImagickKernel::fromBuiltIn( - \Imagick::KERNEL_DIAMOND, - "2" - ); - - $kernel->addKernel($diamondKernel); - - $kernelList = $kernel->separate(); - - $output = ''; - $count = 0; - foreach ($kernelList as $kernel) { - $output .= "
    Kernel $count
    "; - $output .= renderKernelTable($kernel->getMatrix()); - $count++; - } - - return $output; - -?> -]]> -
    -
    -
    -
    - -
    - - diff --git a/reference/imagick/imagickkernelexception.xml b/reference/imagick/imagickkernelexception.xml deleted file mode 100644 index 679d71fbc0..0000000000 --- a/reference/imagick/imagickkernelexception.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - La clase ImagickKernelException - ImagickKernelException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - ImagickKernelException - - - - - ImagickKernelException - - - - extends - Exception - - - - &InheritedProperties; - - - - &InheritedMethods; - - - - - - -
    - -
    - -
    - - diff --git a/reference/imagick/imagickpixel.xml b/reference/imagick/imagickpixel.xml deleted file mode 100644 index 251b1fc1e3..0000000000 --- a/reference/imagick/imagickpixel.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - - La clase <classname>ImagickPixel</classname> - ImagickPixel - -
    - &reftitle.classsynopsis; - - ImagickPixel - - ImagickPixel - - - -
    -
    - &reference.imagick.entities.imagickpixel; -
    - - diff --git a/reference/imagick/imagickpixel/clear.xml b/reference/imagick/imagickpixel/clear.xml deleted file mode 100644 index fbcb6278dc..0000000000 --- a/reference/imagick/imagickpixel/clear.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - - ImagickPixel::clear - Elimina todos los recursos asociados con el objeto - - - - &reftitle.description; - - public boolImagickPixel::clear - - - &warn.undocumented.func; - - Elimina el objeto ImagickPixel, dejándolo en un estado inicial. - Asimismo, elimina todos los colores asociados con el objeto. - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagickpixel/construct.xml b/reference/imagick/imagickpixel/construct.xml deleted file mode 100644 index 84477ed4eb..0000000000 --- a/reference/imagick/imagickpixel/construct.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - - - ImagickPixel::__construct - El constructor ImagickPixel - - - - &reftitle.description; - - public ImagickPixel::__construct - stringcolor - - &warn.undocumented.func; - - Construye un objeto ImagickPixel. - Si se especifica un color, el objeto - se construye, luego se inicializa con ese color antes de ser devuelto. - - - - - &reftitle.parameters; - - - - color - - - Una cadena que representa el color opcional a utilizar como valor - inicial del objeto. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto ImagickPixel en caso de éxito o lanza - una excepción ImagickPixelException si ocurre un error. - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickPixel::construct</function> - -setstrokewidth(1.0); - $draw->setStrokeColor($black); - $draw->setFillColor($color); - $offsetX = ($count % $columns) * 50 + 5; - $offsetY = intval($count / $columns) * 50 + 5; - $draw->rectangle(0 + $offsetX, 0 + $offsetY, 40 + $offsetX, 40 + $offsetY); - $count++; - } - - $image = new \Imagick(); - $image->newImage(350, 350, "blue"); - $image->setImageFormat("png"); - $image->drawImage($draw); - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickpixel/destroy.xml b/reference/imagick/imagickpixel/destroy.xml deleted file mode 100644 index ebffc25ebb..0000000000 --- a/reference/imagick/imagickpixel/destroy.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - - ImagickPixel::destroy - Libera los recursos asociados con el objeto - - - - &reftitle.description; - - public boolImagickPixel::destroy - - - &warn.undocumented.func; - - Libera todos los recursos utilizados por el objeto ImagickPixel y - elimina todos los colores asociados. El objeto no debe ser utilizado - tras la llamada a esta función. - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagickpixel/getcolor.xml b/reference/imagick/imagickpixel/getcolor.xml deleted file mode 100644 index cb94fdcf9a..0000000000 --- a/reference/imagick/imagickpixel/getcolor.xml +++ /dev/null @@ -1,166 +0,0 @@ - - - - - - - ImagickPixel::getColor - Devuelve el color - - - - &reftitle.description; - - public arrayImagickPixel::getColor - intnormalized0 - - - Devuelve el color descrito por el objeto ImagickPixel, - en forma de un &array;. Si el color contiene un canal de opacidad, este - será proporcionado como cuarta valor de la lista. - - - - - &reftitle.parameters; - - - - normalized - - - Normaliza los valores de color. Los valores posibles son 0, - 1 o 2. - - - - Lista de valores posibles para <parameter>normalized</parameter> - - - - - normalized - &Description; - - - - - - 0 - - - Los valores RGB son devueltos como ints en el intervalo (inclusivo) - 0 a 255. El valor alpha es devuelto como - int y es 0 o 1. - - - - - 1 - - - Los valores RGBA son devueltos como floats en el intervalo (inclusivo) - 0 a 1. - - - - - 2 - - - Los valores RGBA son devueltos como ints en el intervalo (inclusivo) - 0 a 255. - - - - -
    -
    -
    -
    -
    -
    - -
    - - &reftitle.returnvalues; - - Un array de los valores de los canales. Genera - ImagickPixelException en caso de error. - - - - - &reftitle.examples; - - - Uso simple del método <function>Imagick::getColor</function> - -setColorValue(Imagick::COLOR_ALPHA, 64 / 256.0); - -$colorInfo = $color->getColor(); - -echo "Valores estándar :".PHP_EOL; -print_r($colorInfo); - -$colorInfo = $color->getColor(1); - -echo "Valores normalizados :".PHP_EOL; -print_r($colorInfo); - -?> -]]> - - &example.outputs; - - 165 - [g] => 42 - [b] => 42 - [a] => 0 -) -Valores normalizados : -Array -( - [r] => 0.64705882352941 - [g] => 0.16470588235294 - [b] => 0.16470588235294 - [a] => 0.25000381475547 -) - ]]> - - - - - -
    - diff --git a/reference/imagick/imagickpixel/getcolorasstring.xml b/reference/imagick/imagickpixel/getcolorasstring.xml deleted file mode 100644 index bce58266f7..0000000000 --- a/reference/imagick/imagickpixel/getcolorasstring.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - - ImagickPixel::getColorAsString - Devuelve un color - - - - &reftitle.description; - - public stringImagickPixel::getColorAsString - - - - Devuelve el color del objeto ImagickPixel, en forma de &string;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el color del objeto ImagickPixel, en forma de &string;. - - - - - &reftitle.examples; - - - Uso básico del método <function>Imagick::getColorAsString</function> - -setColorValue(Imagick::COLOR_ALPHA, 64 / 256.0); - -$colorInfo = $color->getColorAsString(); - -print_r($colorInfo); -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.notes; - - Alpha no devuelto - - Este método no devuelve el valor del alpha del color en la cadena. - - - - - - - diff --git a/reference/imagick/imagickpixel/getcolorcount.xml b/reference/imagick/imagickpixel/getcolorcount.xml deleted file mode 100644 index 4466310284..0000000000 --- a/reference/imagick/imagickpixel/getcolorcount.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - ImagickPixel::getColorCount - Devuelve el número de colores asociados con un color - - - - &reftitle.description; - - public intImagickPixel::getColorCount - - - - Devuelve el número de colores asociados con el color. - - El número de píxeles de la imagen que tienen el mismo color que este ImagickPixel. - - - ImagickPixel::getColorCount parece funcionar únicamente para los objetos ImagickPixel creados mediante Imagick::getImageHistogram() - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el número de colores, en forma de &integer; en - caso de éxito o lanza una excepción ImagickPixelException - si - ocurre un error. - - - - &reftitle.examples; - - - ImagickPixel <function>getColorCount</function> - -newPseudoImage(640, 480, "magick:logo"); - $histogramElements = $imagick->getImageHistogram(); - $lastColor = array_pop($histogramElements); - echo "Last pixel color count is: ".$lastColor->getColorCount(); -?> -]]> - - - La salida para esto será similar a: - - - - - - - - - - - diff --git a/reference/imagick/imagickpixel/getcolorquantum.xml b/reference/imagick/imagickpixel/getcolorquantum.xml deleted file mode 100644 index 9f55aa9c15..0000000000 --- a/reference/imagick/imagickpixel/getcolorquantum.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - ImagickPixel::getColorQuantum - Devuelve el color del píxel en un array como valores cuánticos - - - - &reftitle.description; - - public arrayImagickPixel::getColorQuantum - - - - Devuelve el color del píxel en un array como valores cuánticos. Si ImageMagick ha sido compilado - como HDRI, estos valores serán floats, de lo contrario serán integers. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un array con las claves "r", "g", - "b", "a". - - - - - - diff --git a/reference/imagick/imagickpixel/getcolorvalue.xml b/reference/imagick/imagickpixel/getcolorvalue.xml deleted file mode 100644 index 4cda83df70..0000000000 --- a/reference/imagick/imagickpixel/getcolorvalue.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - - ImagickPixel::getColorValue - Obtiene el valor normalizado del canal de color proporcionado - - - - &reftitle.description; - - public floatImagickPixel::getColorValue - intcolor - - - Obtiene el valor del canal de color especificado, en forma de número de punto flotante - comprendido entre 0 y 1. - - - - - &reftitle.parameters; - - - - color - - - El color para el cual se obtendrá el valor, especificado - en forma de constante de colores Imagick. Puede ser colores - RGB, colores CMYK, alpha y opacidad, i.e. Imagick::COLOR_BLUE - o Imagick::COLOR_MAGENTA. - - - - - - - - - &reftitle.returnvalues; - - El valor del canal, en forma de número de punto flotante normalizado, - o lanza una excepción ImagickPixelException - si ocurre un error. - - - - - &reftitle.examples; - - - Uso básico del método <function>Imagick::getColorValue</function> - -getColorValue(Imagick::COLOR_ALPHA).PHP_EOL; -echo "".PHP_EOL; -echo "El valor rojo es ".$color->getColorValue(Imagick::COLOR_RED).PHP_EOL; -echo "El valor verde es ".$color->getColorValue(Imagick::COLOR_GREEN).PHP_EOL; -echo "El valor azul es ".$color->getColorValue(Imagick::COLOR_BLUE).PHP_EOL; -echo "".PHP_EOL; -echo "El valor Cian es ".$color->getColorValue(Imagick::COLOR_CYAN).PHP_EOL; -echo "El valor Magenta es ".$color->getColorValue(Imagick::COLOR_MAGENTA).PHP_EOL; -echo "El valor amarillo es ".$color->getColorValue(Imagick::COLOR_YELLOW).PHP_EOL; -echo "El valor negro es ".$color->getColorValue(Imagick::COLOR_BLACK).PHP_EOL; - -?> -]]> - - &example.outputs; - - - - - - - - - - diff --git a/reference/imagick/imagickpixel/getcolorvaluequantum.xml b/reference/imagick/imagickpixel/getcolorvaluequantum.xml deleted file mode 100644 index 375f190a67..0000000000 --- a/reference/imagick/imagickpixel/getcolorvaluequantum.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - ImagickPixel::getColorValueQuantum - Devuelve el valor cuántico de un color en ImagickPixel - - - - &reftitle.description; - - public intfloatImagickPixel::getColorValueQuantum - intcolor - - - Devuelve el valor cuántico de un color en ImagickPixel. El valor de retorno es un float si ImageMagick ha sido compilado con HDRI, de lo contrario un integer. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El valor cuántico del elemento de color. Float si ImageMagick ha sido compilado con HDRI, de lo contrario un integer. - - - - - &reftitle.examples; - - - <function>ImagickPixel::getColorValueQuantum</function> - - getColorValueQuantum(\Imagick::COLOR_RED); - $colorGreen = $color->getColorValueQuantum(\Imagick::COLOR_GREEN); - $colorBlue = $color->getColorValueQuantum(\Imagick::COLOR_BLUE); - $colorAlpha = $color->getColorValueQuantum(\Imagick::COLOR_ALPHA); - - printf( - "Red: %s Green: %s Blue %s Alpha: %s", - $colorRed, - $colorGreen, - $colorBlue, - $colorAlpha - ); - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickpixel/gethsl.xml b/reference/imagick/imagickpixel/gethsl.xml deleted file mode 100644 index a57e109c49..0000000000 --- a/reference/imagick/imagickpixel/gethsl.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - - ImagickPixel::getHSL - Retorna el color HSL normalizado del objeto ImagickPixel - - - - &reftitle.description; - - public arrayImagickPixel::getHSL - - - - Retorna el color HSL normalizado, descrito por el objeto - ImagickPixel, donde cada una de las tres - valores será un número decimal, comprendido entre 0.0 y 1.0. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retorna el valor HSL en un array que contiene las claves - "hue", "saturation" y - "luminosity". Genera una excepción - ImagickPixelException - en caso de error. - - - - - &reftitle.examples; - - - Ejemplo con <function>Imagick::getHSL</function> - -getHSL(); - -print_r($colorInfo); - -?> -]]> - - &example.outputs; - - 0 - [saturation] => 0.80001220740379 - [luminosity] => 0.50000762951095 -) -]]> - - - - - - - &reftitle.notes; - - - Disponible a partir de la versión 6.2.9 y superior de la biblioteca - ImageMagick. - - - - - - - diff --git a/reference/imagick/imagickpixel/getindex.xml b/reference/imagick/imagickpixel/getindex.xml deleted file mode 100644 index 676e24d378..0000000000 --- a/reference/imagick/imagickpixel/getindex.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - ImagickPixel::getIndex - Devuelve el índice de la tabla de colores del píxel - - - - &reftitle.description; - - public intImagickPixel::getIndex - - - - Devuelve el índice de la tabla de colores del píxel. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/imagick/imagickpixel/ispixelsimilar.xml b/reference/imagick/imagickpixel/ispixelsimilar.xml deleted file mode 100644 index 77a4983e43..0000000000 --- a/reference/imagick/imagickpixel/ispixelsimilar.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - ImagickPixel::isPixelSimilar - Verifica la distancia entre este color y otro - - - - &reftitle.description; - - public boolImagickPixel::isPixelSimilar - ImagickPixelcolor - floatfuzz - - - Verifica la distancia entre el color descrito por este objeto ImagickPixel - y el del objeto proporcionado. Si la distancia entre los dos puntos es - inferior al valor del argumento fuzz proporcionado, el color es similar. - Este método reemplaza al método - ImagickPixel::isSimilar() - y normaliza correctamente el valor fuzz de ImageMagick QuantumRange. - - - - - &reftitle.parameters; - - - - color - - - El objeto ImagickPixel a utilizar para la comparación. - - - - - fuzz - - - La distancia máxima para la cual se consideran los colores como - similares. El valor máximo teórico para este argumento es la raíz - cuadrada de tres (1.732). - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagickpixel/ispixelsimilarquantum.xml b/reference/imagick/imagickpixel/ispixelsimilarquantum.xml deleted file mode 100644 index b0b5f762e1..0000000000 --- a/reference/imagick/imagickpixel/ispixelsimilarquantum.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - ImagickPixel::isPixelSimilarQuantum - Indica si dos colores difieren en menos de la distancia especificada - - - - &reftitle.description; - - public boolImagickPixel::isPixelSimilarQuantum - stringcolor - stringfuzz - - - Indica si dos colores difieren en menos de la distancia especificada. - El valor de flou debe estar comprendido entre 0 y QuantumRange. - El valor máximo representa la distancia más larga posible en el espacio colorimétrico. - Por ejemplo, de RGB(0, 0, 0) a RGB(255, 255, 255) para el espacio colorimétrico RGB - - - - - - &reftitle.parameters; - - - color - - - - - - - - fuzz - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/imagick/imagickpixel/issimilar.xml b/reference/imagick/imagickpixel/issimilar.xml deleted file mode 100644 index e6bd1ab481..0000000000 --- a/reference/imagick/imagickpixel/issimilar.xml +++ /dev/null @@ -1,175 +0,0 @@ - - - - - - - - ImagickPixel::isSimilar - Verifica la distancia entre 2 colores - - - - &reftitle.description; - - public boolImagickPixel::isSimilar - ImagickPixelcolor - floatfuzz - - &warn.undocumented.func; - - Verifica la distancia entre la color descrita por el objeto ImagickPixel - y la del objeto proporcionado, colocando sus valores RGB en el cubo - de color. Si la distancia entre los 2 puntos es inferior al valor - del argumento fuzz, la color es similar. - Obsoleto en favor del método - ImagickPixel::isPixelSimilar(). - - - - - &reftitle.parameters; - - - - color - - - El objeto ImagickPixel utilizado para la comparación. - - - - - fuzz - - - La distancia máxima utilizada para considerar que los colores - son similares. El valor máximo teórico es la raíz cuadrada - de 3 (1.732). - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickPixel::isSimilar</function> - - - - - Color 1 - - - Color 2 - - - Test distance * 255 - - - Is within distance - - - "; - - $output .= ""; - - foreach ($tests as $testInfo) { - $color1 = $testInfo[0]; - $color2 = $testInfo[1]; - $distance = $testInfo[2]; - $expectation = $testInfo[3]; - $testDistance = ($distance / 255.0); - - $color1Pixel = new \ImagickPixel($color1); - $color2Pixel = new \ImagickPixel($color2); - - $isSimilar = $color1Pixel->isPixelSimilar($color2Pixel, $testDistance); - - if ($isSimilar !== $expectation) { - echo "Test distance failed. Color [$color1] compared to color [$color2] is not within distance $testDistance FAILED.".NL; - } - - $layout = " - %s - %s - %s - %s - "; - - $output .= sprintf( - $layout, - $color1, - $color2, - $distance, - $isSimilar ? 'yes' : 'no' - ); - } - - $output .= ""; - - return $output; - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickpixel/setcolor.xml b/reference/imagick/imagickpixel/setcolor.xml deleted file mode 100644 index 310b90f69f..0000000000 --- a/reference/imagick/imagickpixel/setcolor.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - - ImagickPixel::setColor - Define la color - - - - &reftitle.description; - - public boolImagickPixel::setColor - stringcolor - - &warn.undocumented.func; - - Define la color, descrita por el objeto ImagickPixel, con un &string; - (por ejemplo, "blue", "#0000ff", - "rgb(0,0,255)", "cmyk(100,100,100,10)", etc.). - - - - - &reftitle.parameters; - - - - color - - - La definición de la color a utilizar para inicializar - el objeto ImagickPixel. - - - - - - - - - &reftitle.returnvalues; - - Retorna &true; si la color especificada ha sido definida o &false; en caso contrario. - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickPixel::setColor</function> - -setColor('rgba(100%, 75%, 0%, 1.0)'); - - $draw->setstrokewidth(3.0); - $draw->setStrokeColor($strokeColor); - $draw->setFillColor($fillColor); - $draw->rectangle(200, 200, 300, 300); - - $image = new \Imagick(); - $image->newImage(500, 500, "SteelBlue2"); - $image->setImageFormat("png"); - - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickpixel/setcolorcount.xml b/reference/imagick/imagickpixel/setcolorcount.xml deleted file mode 100644 index 604bea3af2..0000000000 --- a/reference/imagick/imagickpixel/setcolorcount.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - ImagickPixel::setColorCount - Define la cantidad de colores asociada a este píxel - - - - &reftitle.description; - - public boolImagickPixel::setcolorcount - intcolorCount - - - Define la cantidad de colores asociada a este píxel. - - - - - - &reftitle.parameters; - - - colorCount - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagickpixel/setcolorvalue.xml b/reference/imagick/imagickpixel/setcolorvalue.xml deleted file mode 100644 index 5cbb5738a9..0000000000 --- a/reference/imagick/imagickpixel/setcolorvalue.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - - ImagickPixel::setColorValue - Define el valor normalizado de uno de los canales - - - - &reftitle.description; - - public boolImagickPixel::setColorValue - intcolor - floatvalue - - - Define el valor del canal especificado del objeto al valor especificado, - que debe estar comprendido entre 0 y 1. Esta función puede ser utilizada - para proporcionar un canal de opacidad al objeto ImagickPixel. - - - - - &reftitle.parameters; - - - - color - - - Una constante de color Imagick, i.e. \Imagick::COLOR_GREEN o - \Imagick::COLOR_ALPHA. - - - - - value - - - El valor a definir para este canal, comprendido entre 0 y 1. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Ejemplo con <function>Imagick::setColorValue</function> - -setColorValue(Imagick::COLOR_ALPHA, 0.5); - -print_r($color->getcolor(true)); -?> -]]> - - &example.outputs; - - 0.69803921568627 - [g] => 0.13333333333333 - [b] => 0.13333333333333 - [a] => 0.50000762951095 -) -]]> - - - - - - - - diff --git a/reference/imagick/imagickpixel/setcolorvaluequantum.xml b/reference/imagick/imagickpixel/setcolorvaluequantum.xml deleted file mode 100644 index fbe969aece..0000000000 --- a/reference/imagick/imagickpixel/setcolorvaluequantum.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - ImagickPixel::setColorValueQuantum - Define la valor cuántica de un elemento de color de ImagickPixel - - - - &reftitle.description; - - public boolImagickPixel::setColorValueQuantum - intcolor - intfloatvalue - - - Define la valor cuántica de un elemento de color de ImagickPixel. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - color - - - Color a definir, por ejemplo \Imagick::COLOR_GREEN. - - - - - - value - - - Valor cuántica a definir para el elemento de color. Debería ser un float si ImageMagick ha sido compilado con HDRI, de lo contrario un integer en el rango 0 a Imagick::getQuantum(). - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - <function>ImagickPixel::setColorValueQuantum</function> - - getQuantumRange(); - - $draw = new \ImagickDraw(); - $color = new \ImagickPixel('blue'); - $color->setcolorValueQuantum(\Imagick::COLOR_RED, 128 * $quantumRange['quantumRangeLong'] / 256); - - $draw->setstrokewidth(1.0); - $draw->setStrokeColor($color); - $draw->setFillColor($color); - $draw->rectangle(200, 200, 300, 300); - - $image->newImage(500, 500, "SteelBlue2"); - $image->setImageFormat("png"); - - $image->drawImage($draw); - - header("Content-Type: image/png"); - echo $image->getImageBlob(); -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickpixel/sethsl.xml b/reference/imagick/imagickpixel/sethsl.xml deleted file mode 100644 index 5005ed0ef7..0000000000 --- a/reference/imagick/imagickpixel/sethsl.xml +++ /dev/null @@ -1,147 +0,0 @@ - - - - - - - - ImagickPixel::setHSL - Define el color HSL normalizado - - - - &reftitle.description; - - public boolImagickPixel::setHSL - floathue - floatsaturation - floatluminosity - - - Define el color descrito por el objeto ImagickPixel utilizando - los valores normalizados para la densidad, la saturación y la luminosidad. - - - - - &reftitle.parameters; - - - - hue - - - El valor normalizado para la densidad, descrito por un arco fraccionario - (entre 0 y 1) del círculo de densidad, cuyo valor cero corresponde a - rojo. - - - - - saturation - - - El valor normalizado para la saturación, donde 1 corresponde a una - saturación completa. - - - - - luminosity - - - El valor normalizado para la luminosidad, comprendido entre 0 (negro) - y 1 (blanco), con el valor HS completo a 0.5 de luminosidad. - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickPixel::setHSL</function> para modificar un color - -getHSL(); - -// Realiza una rotación del tono de 180 grados -$newHue = $colorInfo['hue'] + 0.5; -if ($newHue > 1) { - $newHue = $newHue - 1; -} - -// Define el objeto ImagickPixel al nuevo color -$colorInfo = $color->setHSL($newHue, $colorInfo['saturation'], $colorInfo['luminosity']); - -// Verifica que el nuevo color sea azul/verde -$colorInfo = $color->getcolor(); -print_r($colorInfo); - -?> - ]]> - - &example.outputs; - - 26 - [g] => 230 - [b] => 230 - [a] => 255 -) -]]> - - - - - - - &reftitle.notes; - - - Disponible a partir de la versión 6.2.9 de la biblioteca - ImageMagick. - - - - - - - diff --git a/reference/imagick/imagickpixel/setindex.xml b/reference/imagick/imagickpixel/setindex.xml deleted file mode 100644 index ff778238e3..0000000000 --- a/reference/imagick/imagickpixel/setindex.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - ImagickPixel::setIndex - Define el índice de la tabla de colores del píxel - - - - &reftitle.description; - - public boolImagickPixel::setIndex - intindex - - - Define el índice de la tabla de colores del píxel. - - - - - - &reftitle.parameters; - - - index - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagickpixelexception.xml b/reference/imagick/imagickpixelexception.xml deleted file mode 100644 index 32e5b57843..0000000000 --- a/reference/imagick/imagickpixelexception.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - La clase ImagickPixelException - ImagickPixelException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - - ImagickPixelException - - - - - ImagickPixelException - - - - extends - Exception - - - - Throwable - - - &InheritedProperties; - - - - &InheritedMethods; - - - - - - -
    - -
    - -
    - diff --git a/reference/imagick/imagickpixeliterator.xml b/reference/imagick/imagickpixeliterator.xml deleted file mode 100644 index c29bb4003d..0000000000 --- a/reference/imagick/imagickpixeliterator.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - La clase <classname>ImagickPixelIterator</classname> - ImagickPixelIterator - -
    - &reftitle.classsynopsis; - - ImagickPixelIterator - - ImagickPixelIterator - - - -
    -
    - &reference.imagick.entities.imagickpixeliterator; -
    - - - diff --git a/reference/imagick/imagickpixeliterator/clear.xml b/reference/imagick/imagickpixeliterator/clear.xml deleted file mode 100644 index a758bf6de5..0000000000 --- a/reference/imagick/imagickpixeliterator/clear.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - - ImagickPixelIterator::clear - Elimina todos los recursos asociados a PixelIterator - - - - &reftitle.description; - - public boolImagickPixelIterator::clear - - - &warn.undocumented.func; - - Elimina todos los recursos asociados a PixelIterator. - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickPixelIterator::clear</function> - -getPixelRegionIterator(100, 100, 250, 200); - - /* Se recorren las líneas de píxeles */ - foreach ($imageIterator as $pixels) { - /** @var $pixel \ImagickPixel */ - /* Se recorren los píxeles de la línea (columna) */ - foreach ($pixels as $column => $pixel) { - if ($column % 2) { - /* Pintar cada segundo píxel de negro */ - $pixel->setColor("rgba(0, 0, 0, 0)"); - } - } - /* Se sincroniza el iterador, esto es importante en cada iteración */ - $imageIterator->syncIterator(); - } - - $imageIterator->clear(); - - header("Content-Type: image/jpg"); - echo $imagick; -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickpixeliterator/construct.xml b/reference/imagick/imagickpixeliterator/construct.xml deleted file mode 100644 index bd1e9e2e77..0000000000 --- a/reference/imagick/imagickpixeliterator/construct.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - - ImagickPixelIterator::__construct - El constructor de la clase ImagickPixelIterator - - - - &reftitle.description; - - public ImagickPixelIterator::__construct - Imagickwand - - &warn.undocumented.func; - - El constructor de la clase ImagickPixelIterator. - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickPixelIterator::construct</function> - - $pixel) { - /** @var $pixel \ImagickPixel */ - if ($column % 2) { - /* Se tiñen todos los dos píxeles en negro */ - $pixel->setColor("rgba(0, 0, 0, 0)"); - } - } - /* Se sincroniza el iterador, esto es importante en cada iteración */ - $imageIterator->syncIterator(); - } - - header("Content-Type: image/jpg"); - echo $imagick; -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickpixeliterator/destroy.xml b/reference/imagick/imagickpixeliterator/destroy.xml deleted file mode 100644 index 17dfea8601..0000000000 --- a/reference/imagick/imagickpixeliterator/destroy.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - - ImagickPixelIterator::destroy - Libera los recursos asociados a PixelIterator - - - - &reftitle.description; - - public boolImagickPixelIterator::destroy - - - &warn.undocumented.func; - - Libera los recursos asociados a PixelIterator. - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagickpixeliterator/getcurrentiteratorrow.xml b/reference/imagick/imagickpixeliterator/getcurrentiteratorrow.xml deleted file mode 100644 index d554248ba4..0000000000 --- a/reference/imagick/imagickpixeliterator/getcurrentiteratorrow.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - - ImagickPixelIterator::getCurrentIteratorRow - Devuelve la fila actual de los objetos ImagickPixel - - - - &reftitle.description; - - public arrayImagickPixelIterator::getCurrentIteratorRow - - - &warn.undocumented.func; - - Devuelve la fila actual, en forma de array, de los objetos ImagickPixel - desde el iterador de píxeles. - - - - - &reftitle.returnvalues; - - Devuelve una fila, en forma de array, de los objetos ImagickPixel, - que puede ser iterada a su vez. - - - - - - diff --git a/reference/imagick/imagickpixeliterator/getiteratorrow.xml b/reference/imagick/imagickpixeliterator/getiteratorrow.xml deleted file mode 100644 index af93da9c47..0000000000 --- a/reference/imagick/imagickpixeliterator/getiteratorrow.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - - ImagickPixelIterator::getIteratorRow - Devuelve la fila actual del iterador de píxeles - - - - &reftitle.description; - - public intImagickPixelIterator::getIteratorRow - - - &warn.undocumented.func; - - Devuelve la fila actual del iterador de píxeles. - - - - - &reftitle.returnvalues; - - Devuelve la posición, en forma de &integer; de la fila - o lanza una excepción ImagickPixelIteratorException en caso de error. - - - - - - diff --git a/reference/imagick/imagickpixeliterator/getnextiteratorrow.xml b/reference/imagick/imagickpixeliterator/getnextiteratorrow.xml deleted file mode 100644 index 63fcb05180..0000000000 --- a/reference/imagick/imagickpixeliterator/getnextiteratorrow.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - - ImagickPixelIterator::getNextIteratorRow - Devuelve la siguiente línea del iterador de píxeles - - - - &reftitle.description; - - public arrayImagickPixelIterator::getNextIteratorRow - - - &warn.undocumented.func; - - Devuelve la siguiente línea, en forma de &array;, desde el iterador - de píxeles. - - - - - &reftitle.returnvalues; - - Devuelve la siguiente línea, en forma de &array; de objetos ImagickPixel, - o lanza una excepción ImagickPixelIteratorException en caso de error. - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickPixelIterator::getNextIteratorRow</function> - -getPixelIterator(); - - $count = 0; - while ($pixels = $imageIterator->getNextIteratorRow()) { - if (($count % 3) == 0) { - /* Se recorren los píxeles de la línea (columna) */ - foreach ($pixels as $column => $pixel) { - /** @var $pixel \ImagickPixel */ - if ($column % 2) { - /* Se tiñen todos los dos píxeles en negro */ - $pixel->setColor("rgba(0, 0, 0, 0)"); - } - } - /* Se sincroniza el iterador, esto es importante en cada iteración */ - $imageIterator->syncIterator(); - } - - $count += 1; - } - - header("Content-Type: image/jpg"); - echo $imagick; -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickpixeliterator/getpreviousiteratorrow.xml b/reference/imagick/imagickpixeliterator/getpreviousiteratorrow.xml deleted file mode 100644 index cf44a48f03..0000000000 --- a/reference/imagick/imagickpixeliterator/getpreviousiteratorrow.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - - ImagickPixelIterator::getPreviousIteratorRow - Devuelve la línea anterior - - - - &reftitle.description; - - public arrayImagickPixelIterator::getPreviousIteratorRow - - - &warn.undocumented.func; - - Devuelve la línea anterior, en forma de &array;, desde el iterador de píxeles. - - - - - &reftitle.returnvalues; - - Devuelve la línea anterior, en forma de &array; de objetos ImagickPixelWand, - o lanza una excepción ImagickPixelIteratorException en caso de error. - - - - - - diff --git a/reference/imagick/imagickpixeliterator/newpixeliterator.xml b/reference/imagick/imagickpixeliterator/newpixeliterator.xml deleted file mode 100644 index 18bacd3b20..0000000000 --- a/reference/imagick/imagickpixeliterator/newpixeliterator.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - - ImagickPixelIterator::newPixelIterator - Devuelve un nuevo píxel del iterador - - - - &reftitle.description; - - public boolImagickPixelIterator::newPixelIterator - Imagickwand - - &warn.undocumented.func; - - Devuelve un nuevo píxel del iterador. - - - - - &reftitle.returnvalues; - - &imagick.return.success;. - Se lanza una excepción ImagickPixelIteratorException en caso de error. - - - - - - diff --git a/reference/imagick/imagickpixeliterator/newpixelregioniterator.xml b/reference/imagick/imagickpixeliterator/newpixelregioniterator.xml deleted file mode 100644 index afd21c5732..0000000000 --- a/reference/imagick/imagickpixeliterator/newpixelregioniterator.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - - ImagickPixelIterator::newPixelRegionIterator - Devuelve un nuevo iterador de píxeles - - - - &reftitle.description; - - public boolImagickPixelIterator::newPixelRegionIterator - Imagickwand - intx - inty - intcolumns - introws - - &warn.undocumented.func; - - Devuelve un nuevo iterador de píxeles. - - - - - &reftitle.parameters; - - - - wand - - - - - - - x - - - - - - - y - - - - - - - columns - - - - - - - rows - - - - - - - - - - - &reftitle.returnvalues; - - Devuelve un nuevo ImagickPixelIterator en caso de éxito o - lanza una excepción ImagickPixelIteratorException - si ocurre un error. - - - - - - diff --git a/reference/imagick/imagickpixeliterator/resetiterator.xml b/reference/imagick/imagickpixeliterator/resetiterator.xml deleted file mode 100644 index 9c1aab418c..0000000000 --- a/reference/imagick/imagickpixeliterator/resetiterator.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - ImagickPixelIterator::resetIterator - Reinicia el iterador de píxeles - - - - &reftitle.description; - - public boolImagickPixelIterator::resetIterator - - - &warn.undocumented.func; - - Reinicia el iterador de píxeles. Utilice este método con - ImagickPixelIterator::getNextIteratorRow() para iterar sobre todos los - píxeles de un contenedor de píxeles. - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickPixelIterator::resetIterator</function> - -getPixelIterator(); - - /* Se recorren las líneas de píxeles */ - foreach ($imageIterator as $pixels) { - /* Se recorren los píxeles de la línea (columna) */ - foreach ($pixels as $column => $pixel) { - /** @var $pixel \ImagickPixel */ - if ($column % 2) { - - /* Cada dos píxeles, se añade un 25% de rojo */ - $pixel->setColorValue(\Imagick::COLOR_RED, 64); - } - } - /* Se sincroniza el iterador, esto es importante en cada iteración */ - $imageIterator->syncIterator(); - } - - $imageIterator->resetiterator(); - - /* Se recorren las líneas de píxeles */ - foreach ($imageIterator as $pixels) { - /* Se recorren los píxeles de la línea (columna) */ - foreach ($pixels as $column => $pixel) { - /** @var $pixel \ImagickPixel */ - if ($column % 3) { - $pixel->setColorValue(\Imagick::COLOR_BLUE, 64); /* Cada dos píxeles, se los hace un poco más azules */ - //$pixel->setColor("rgba(0, 0, 128, 0)"); /* Se tiñen todos los dos píxeles en negro */ - } - } - $imageIterator->syncIterator(); /* Se sincroniza el iterador, esto es importante en cada iteración */ - } - - $imageIterator->clear(); - - header("Content-Type: image/jpg"); - echo $imagick; -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickpixeliterator/setiteratorfirstrow.xml b/reference/imagick/imagickpixeliterator/setiteratorfirstrow.xml deleted file mode 100644 index 54c39b1496..0000000000 --- a/reference/imagick/imagickpixeliterator/setiteratorfirstrow.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - - ImagickPixelIterator::setIteratorFirstRow - Establece el iterador de píxeles en la primera línea de píxeles - - - - &reftitle.description; - - public boolImagickPixelIterator::setIteratorFirstRow - - - &warn.undocumented.func; - - Establece el iterador de píxeles en la primera línea de píxeles. - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagickpixeliterator/setiteratorlastrow.xml b/reference/imagick/imagickpixeliterator/setiteratorlastrow.xml deleted file mode 100644 index 7639aab656..0000000000 --- a/reference/imagick/imagickpixeliterator/setiteratorlastrow.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - - ImagickPixelIterator::setIteratorLastRow - Define el iterador de píxeles en la última línea de píxeles - - - - &reftitle.description; - - public boolImagickPixelIterator::setIteratorLastRow - - - &warn.undocumented.func; - - Define el iterador de píxeles en la última línea de píxeles. - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagickpixeliterator/setiteratorrow.xml b/reference/imagick/imagickpixeliterator/setiteratorrow.xml deleted file mode 100644 index 109d0f7f38..0000000000 --- a/reference/imagick/imagickpixeliterator/setiteratorrow.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - - ImagickPixelIterator::setIteratorRow - Define la línea del iterador de píxeles - - - - &reftitle.description; - - public boolImagickPixelIterator::setIteratorRow - introw - - &warn.undocumented.func; - - Define la línea del iterador de píxeles. - - - - - &reftitle.parameters; - - - - row - - - - - - - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - &reftitle.examples; - - - Ejemplo con <function>ImagickPixelIterator::setIteratorRow</function> - -getPixelRegionIterator(200, 100, 200, 200); - - for ($x = 0; $x < 20; $x++) { - $imageIterator->setIteratorRow($x * 5); - $pixels = $imageIterator->getCurrentIteratorRow(); - /* Se recorren los píxeles de la línea (columna) */ - foreach ($pixels as $pixel) { - /** @var $pixel \ImagickPixel */ - /* Se tiñen todos los píxeles en negro */ - $pixel->setColor("rgba(0, 0, 0, 0)"); - } - - /* Se sincroniza el iterador; esto es importante en cada iteración */ - $imageIterator->syncIterator(); - } - - header("Content-Type: image/jpg"); - echo $imagick; -} - -?> -]]> - - - - - - - - diff --git a/reference/imagick/imagickpixeliterator/synciterator.xml b/reference/imagick/imagickpixeliterator/synciterator.xml deleted file mode 100644 index 3b9053bef7..0000000000 --- a/reference/imagick/imagickpixeliterator/synciterator.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - - ImagickPixelIterator::syncIterator - Sincroniza el iterador de píxeles - - - - &reftitle.description; - - public boolImagickPixelIterator::syncIterator - - - &warn.undocumented.func; - - Sincroniza el iterador de píxeles. - - - - - &reftitle.returnvalues; - - &imagick.return.success; - - - - - - diff --git a/reference/imagick/imagickpixeliteratorexception.xml b/reference/imagick/imagickpixeliteratorexception.xml deleted file mode 100644 index 481168d751..0000000000 --- a/reference/imagick/imagickpixeliteratorexception.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - La clase ImagickPixelIteratorException - ImagickPixelIteratorException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - - ImagickPixelIteratorException - - - - - ImagickPixelIteratorException - - - - extends - Exception - - - - Throwable - - - &InheritedProperties; - - - - &InheritedMethods; - - - - - - -
    - -
    - -
    - diff --git a/reference/imagick/ini.xml b/reference/imagick/ini.xml deleted file mode 100644 index 175cace2de..0000000000 --- a/reference/imagick/ini.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - -
    - &reftitle.runtime; - &extension.runtime; - - - Opciones de configuración de Imagick - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - imagick.locale_fix - &false; - INI_ALL - Disponible a partir de 2.1.0 - - - imagick.progress_monitor - &false; - INI_SYSTEM - Disponible a partir de Imagick 2.2.2 - - - imagick.skip_version_check - &false; - INI_SYSTEM - Disponible a partir de Imagick 3.3.0 - - - -
    - &ini.php.constants; -
    - - &ini.descriptions.title; - - - - - - imagick.locale_fix - bool - - - - Corrige un error en el dibujo cuando las configuraciones locales utilizan - el carácter ',' como separadores. - - - - - - - imagick.progress_monitor - bool - - - - Se utiliza para activar la supervisión de la progresión de la imagen. - - - - - - - - imagick.skip_version_check - bool - - - - Cuando Imagick se carga, se verifica el número de versión de ImageMagick - utilizado durante la compilación, y se compara con el número de versión - actualmente utilizado; se emite una alerta si las dos versiones no coinciden. - Esta alerta puede ser eliminada activando esta opción de configuración. - - - El uso de una versión de Imagick diferente a la versión de ImageMagick no es recomendado. - Aunque esto puede funcionar, puede resultar en errores aleatorios o comportamientos no definidos. - - - - - - -
    - - diff --git a/reference/imagick/setup.xml b/reference/imagick/setup.xml deleted file mode 100644 index 152e1a06e4..0000000000 --- a/reference/imagick/setup.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - &reftitle.setup; - - -
    - &reftitle.required; -
    - Configuración necesaria para la instalación en plataformas distintas de Windows - - Se requiere ImageMagick >= 6.2.4. El número de formatos soportados - por Imagick depende totalmente de los soportados por la instalación - de ImageMagick. Por ejemplo, Imagemagick necesita ghostscript para realizar - las operaciones relativas a los PDF. - -
    -
    - - - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;imagick. - - - - El nombre oficial de esta extensión es imagick. - - - - Los usuarios de Windows pueden descargar una DLL preconstruida desde - el sitio de PECL : PECL. - Estos paquetes contienen ya la DLL de extensión (php_imagick.dll) - que debe ser colocada en el extension_dir. - Contienen también las DLL de ImageMagick, que deben ser colocadas en algún lugar del PATH. - A partir de Imagick 3.6.0, contienen también archivos de configuración XML en config; - para usarlos en lugar de los valores por omisión integrados, - deben ser colocados en %USERPROFILE%/.config/ImageMagick, - o alternativamente en el camino dado por la variable de entorno MAGICK_CONFIGURE_PATH. - Consúltense la Documentación sobre los archivos de configuración de ImageMagick para más detalles. - -
    - - - &reference.imagick.ini; - -
    - - diff --git a/reference/inotify/book.xml b/reference/inotify/book.xml deleted file mode 100644 index 02ca1f6824..0000000000 --- a/reference/inotify/book.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - Inotify - - - - &reftitle.intro; - - La extensión inotify expone las funciones inotify inotify_init, - inotify_add_watch e inotify_rm_watch. - - - - Así como la función inotify_init de C devuelve un file - descriptor, inotify_init de PHP devuelve un recurso de flujo, - que puede ser usado con las funciones de flujo estándar, como - stream_select, stream_set_blocking y - fclose. inotify_read sustituye la - manera C de leer eventos inotify. - - - - - &reference.inotify.setup; - &reference.inotify.constants; - &reference.inotify.reference; - - - diff --git a/reference/inotify/constants.xml b/reference/inotify/constants.xml deleted file mode 100644 index f950ea8278..0000000000 --- a/reference/inotify/constants.xml +++ /dev/null @@ -1,293 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - Constantes Inotify utilizables con <function>inotify_add_watch</function> y/o devueltos por <function>inotify_read</function> - - - IN_ACCESS - (int) - - - - El fichero fue accedido (lectura) (*) - - - - - - IN_MODIFY - (int) - - - - El fichero fue modificado (*) - - - - - - IN_ATTRIB - (int) - - - - Metadatos cambiados (por ejemplo: permisos, mtime, etc) (*) - - - - - - IN_CLOSE_WRITE - (int) - - - - El fichero, previamente abierto para escritura, fue cerrado (*) - - - - - - IN_CLOSE_NOWRITE - (int) - - - - El fichero, no abierto para escritura, fue cerrado (*) - - - - - - IN_OPEN - (int) - - - - El fichero fue abierto (*) - - - - - - IN_MOVED_TO - (int) - - - - Un fichero fue movido dentro del directorio observado (*) - - - - - - IN_MOVED_FROM - (int) - - - - Un fichero fue movido fuera del directorio observado (*) - - - - - - IN_CREATE - (int) - - - - Un fichero o directorio fue creado en el directorio observado (*) - - - - - - IN_DELETE - (int) - - - - Fichero o directorio borrado en el directorio observado (*) - - - - - - IN_DELETE_SELF - (int) - - - - El fichero o directorio observado fue borrado - - - - - - IN_MOVE_SELF - (int) - - - - El fichero o directorio observado fue movido - - - - - - IN_CLOSE - (int) - - - - Similar a IN_CLOSE_WRITE | IN_CLOSE_NOWRITE - - - - - - IN_MOVE - (int) - - - - Similar a IN_MOVED_FROM | IN_MOVED_TO - - - - - - IN_ALL_EVENTS - (int) - - - - Máscara de bits de todas las constantes anteriores - - - - - - IN_UNMOUNT - (int) - - - - Sistema de ficheros que contiene objetos observados fue desmontado - - - - - - IN_Q_OVERFLOW - (int) - - - - Cola de eventos desbordada (wd es -1 para este evento) - - - - - - IN_IGNORED - (int) - - - - Seguimiento borrado (explicitamente indicado por inotify_rm_watch - o debido a que el fichero fue eliminado o el sistema de ficheros desmontado) - - - - - - IN_ISDIR - (int) - - - - El sujeto del evento es un directorio - - - - - - IN_ONLYDIR - (int) - - - - Observar la ruta solamente si se trata de un directorio (A partir de Linux 2.6.15) - - - - - - IN_DONT_FOLLOW - (int) - - - - No eliminar la ruta de referencia si es un enlace simbólico (A partir de Linux 2.6.15). - - - - - - IN_MASK_ADD - (int) - - - - Agregar eventos para observar la máscara de esta ruta de acceso si ya existe - (en lugar de reemplazar la máscara). - - - - - - IN_ONESHOT - (int) - - - - Monitorea una ruta para un evento, a continuación elimina de la lista de - vigilancia. - - - - - - - Los eventos más arriba marcados con un asterisco (*) pueden producirse para - ficheros en directorios observados. - - - - - diff --git a/reference/inotify/functions/inotify-add-watch.xml b/reference/inotify/functions/inotify-add-watch.xml deleted file mode 100644 index 752cd22afd..0000000000 --- a/reference/inotify/functions/inotify-add-watch.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - inotify_add_watch - Añade un punto de vigilancia a una instancia inotify - - - - &reftitle.description; - - intfalseinotify_add_watch - resourceinotify_instance - stringpathname - intmask - - - inotify_add_watch añade un punto de vigilancia - a una instancia inotify o modifica un punto de vigilancia en curso - hacia un nuevo fichero o directorio especificado por la ruta - pathname. - - - Utilizar inotify_add_watch sobre un objeto ya en vigilancia - modifica la configuración. Utilizar la constante IN_MASK_ADD - añade los eventos (operación OR lógica). - - - - - &reftitle.parameters; - - - inotify_instance - - - &inotify.instance.description; - - - - - pathname - - - Fichero o directorio a vigilar. - - - - - mask - - - Eventos a vigilar. Véase - &ReservedConstants;. - - - - - - - - &reftitle.returnvalues; - - El valor devuelto es un puntero inotify único (inotify instance wide), - &return.falseforfailure;. - - - - - &reftitle.seealso; - - inotify_init - - - - - diff --git a/reference/inotify/functions/inotify-init.xml b/reference/inotify/functions/inotify-init.xml deleted file mode 100644 index 931905c5f6..0000000000 --- a/reference/inotify/functions/inotify-init.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - - inotify_init - Inicializa una instancia inotify - - - - &reftitle.description; - - resourcefalseinotify_init - - - - Inicializa una instancia inotify para ser utilizada con la función - inotify_add_watch - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un flujo o &false; en caso de error. - - - - - &reftitle.examples; - - - Ejemplo de utilización de inotify - - 0, inotify_read() no bloqueará - -// Detener la vigilancia de __FILE__ -inotify_rm_watch($fd, $watch_descriptor); - -// Destrucción de la instancia inotify -// Esto habría detenido todas las vigilancias si no se hubiera hecho ya -fclose($fd); - -?> -]]> - - &example.outputs.similar; - - 1, // Igual al $watch_descriptor - 'mask' => 4, // El bit IN_ATTRIB está activado - 'cookie' => 0, // Identificador único para vincular eventos (e.g. - // IN_MOVE_FROM y IN_MOVE_TO) - 'name' => '', // El nombre del fichero (e.g. si un directorio estaba bajo vigilancia) - ), -); -]]> - - - - - - - &reftitle.seealso; - - inotify_add_watch - inotify_rm_watch - inotify_queue_len - inotify_read - fclose - - - - - diff --git a/reference/inotify/functions/inotify-queue-len.xml b/reference/inotify/functions/inotify-queue-len.xml deleted file mode 100644 index f6f2f9cdc6..0000000000 --- a/reference/inotify/functions/inotify-queue-len.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - inotify_queue_len - Devuelve un número superior a cero si hay eventos pendientes - - - - &reftitle.description; - - intinotify_queue_len - resourceinotify_instance - - - Esta función permite saber si inotify_read bloqueará o no. - Si un número superior a cero es devuelto, hay eventos pendientes e - inotify_read no bloqueará. - - - - - &reftitle.parameters; - - - inotify_instance - - - &inotify.instance.description; - - - - - - - - &reftitle.returnvalues; - - Devuelve un número superior a cero si hay eventos pendientes. - - - - - &reftitle.seealso; - - inotify_init - stream_select - stream_set_blocking - - - - - diff --git a/reference/inotify/functions/inotify-read.xml b/reference/inotify/functions/inotify-read.xml deleted file mode 100644 index 9663bd557b..0000000000 --- a/reference/inotify/functions/inotify-read.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - inotify_read - Lee eventos de una instancia inotify - - - - &reftitle.description; - - arrayinotify_read - resourceinotify_instance - - - Leer eventos inotify de una instancia inotify. - - - - - &reftitle.parameters; - - - inotify_instance - - - &inotify.instance.description; - - - - - - - - &reftitle.returnvalues; - - Un array de eventos inotify o &false; si no hay eventos pendientes e - inotify_instance no es de bloqueo. Cada evento es un array con las siguientes claves: - - wd es un descriptor de seguimiento devuelto por - inotify_add_watch - mask es una máscara de bits de - eventos - cookie es un identificador único para conectar los eventos - relacionados (por ejemplo: IN_MOVE_FROM e - IN_MOVE_TO) - name es el nombre de un fichero (por ejemplo: si un fichero se ha modificado en un directorio observado) - - - - - - &reftitle.seealso; - - inotify_init - stream_select - stream_set_blocking - inotify_queue_len - - - - - diff --git a/reference/inotify/functions/inotify-rm-watch.xml b/reference/inotify/functions/inotify-rm-watch.xml deleted file mode 100644 index b4cf861838..0000000000 --- a/reference/inotify/functions/inotify-rm-watch.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - inotify_rm_watch - Elimina un seguimiento existente de una instancia inotify - - - - &reftitle.description; - - boolinotify_rm_watch - resourceinotify_instance - intwatch_descriptor - - - inotify_rm_watch elimina el seguimiento - watch_descriptor de la instancia inotify - inotify_instance. - - - - - &reftitle.parameters; - - - inotify_instance - - - &inotify.instance.description; - - - - - watch_descriptor - - - Seguimiento a eliminar de la instancia - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - inotify_init - - - - - diff --git a/reference/inotify/reference.xml b/reference/inotify/reference.xml deleted file mode 100644 index 88a8f8eb19..0000000000 --- a/reference/inotify/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - &Functions; Inotify - - &reference.inotify.entities.functions; - - - - - diff --git a/reference/inotify/setup.xml b/reference/inotify/setup.xml deleted file mode 100644 index d1b6ac60d8..0000000000 --- a/reference/inotify/setup.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - &reftitle.setup; - - -
    - &reftitle.setup; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;inotify. - -
    - - - -
    - &reftitle.resources; - - Esta extensión define un flujo de datos, retornado por - inotify_init. - -
    - - -
    - diff --git a/reference/libxml/book.xml b/reference/libxml/book.xml index c5a00d141f..7680241cf4 100644 --- a/reference/libxml/book.xml +++ b/reference/libxml/book.xml @@ -16,11 +16,11 @@ libxml, SimpleXML, SOAP, - WDDX, + WDDX, XSL, XML, XMLReader, - XMLRPC&listendand; + XMLRPC&listendand; XMLWriter. diff --git a/reference/lua/book.xml b/reference/lua/book.xml deleted file mode 100644 index fdd3f885ca..0000000000 --- a/reference/lua/book.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - Lua - Lua - - - &reftitle.intro; - - "Lua es un lenguaje de programación muy potente, rápido, ligero e integrable." - Esta extensión incorpora el intérprete de Lua y ofrece una API Orientada a Objectos a las - variables y funciones de Lua. - - - - &reference.lua.setup; - - &reference.lua.lua; - &reference.lua.luaclosure; - &reference.lua.luaexception; - - diff --git a/reference/lua/configure.xml b/reference/lua/configure.xml deleted file mode 100644 index 50612a38bc..0000000000 --- a/reference/lua/configure.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;lua - - - -
    - diff --git a/reference/lua/lua.xml b/reference/lua/lua.xml deleted file mode 100644 index bce9ad07fd..0000000000 --- a/reference/lua/lua.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - La clase Lua - Lua - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Lua - - - - - Lua - - - - Constants - - const - string - Lua::LUA_VERSION - Lua 5.1.4 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - Lua::LUA_VERSION - - - - - - -
    - - - -
    - - &reference.lua.entities.lua; - -
    - diff --git a/reference/lua/lua/assign.xml b/reference/lua/lua/assign.xml deleted file mode 100644 index e09077200a..0000000000 --- a/reference/lua/lua/assign.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - Lua::assign - Asigna una variable de PHP a Lua - - - - &reftitle.description; - - public mixedLua::assign - stringname - stringvalue - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - name - - - - - - - - value - - - - - - - - - - - &reftitle.returnvalues; - - Devuelve $this o &null; en caso de error. - - - - - &reftitle.examples; - - Ejemplo de <function>Lua::assign</function> - -assign("php_var", array(1=>1, 2, 3)); //índice de la tabla empieza en 1 -$lua->eval(<< -]]> - - &example.outputs; - - 1 - [2] => 2 - [3] => 3 - ) -]]> - - - - - - diff --git a/reference/lua/lua/call.xml b/reference/lua/lua/call.xml deleted file mode 100644 index 0573940bbb..0000000000 --- a/reference/lua/lua/call.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - - Lua::call - Lua::__call - Llama funciones de Lua - - - - &reftitle.description; - - public mixedLua::call - callablelua_func - arrayargs - intuse_self0 - - - public mixedLua::__call - callablelua_func - arrayargs - intuse_self0 - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - lua_func - - - Nombre de la función en Lua - - - - - args - - - Argumentos pasados a la función de Lua - - - - - use_self - - - Cuando se debe usar self - - - - - - - - &reftitle.returnvalues; - - Devuelve el resultado de la función llamada, &null; si los argumentos son inválidos o - &false; en caso de error. - - - - - &reftitle.examples; - - Ejemplo de la función <function>Lua::call</function> - -eval(<<call("dummy", array("Lua", "geiliable\n")); -var_dump($lua->call(array("table", "concat"), array(array(1=>1, 2=>2, 3=>3), "-"))); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Lua::__call - - - - - diff --git a/reference/lua/lua/construct.xml b/reference/lua/lua/construct.xml deleted file mode 100644 index fb7a31c2bc..0000000000 --- a/reference/lua/lua/construct.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Lua::__construct - Constructor Lua - - - - &reftitle.description; - - public Lua::__construct - stringlua_script_fileNULL - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - lua_script_file - - - - - - - - - - &reftitle.returnvalues; - - - - - - - diff --git a/reference/lua/lua/eval.xml b/reference/lua/lua/eval.xml deleted file mode 100644 index 3a95d0d09a..0000000000 --- a/reference/lua/lua/eval.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - Lua::eval - Evalúa una cadena de texto como código Lua - - - - &reftitle.description; - - public mixedLua::eval - stringstatements - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - statements - - - - - - - - - - - &reftitle.returnvalues; - - Devuelve el resultado del código evaluado, &null; si los parámetros son inválidos o &false; en - caseo de error. - - - - - &reftitle.examples; - - Ejemplo de la función <function>Lua::eval</function> - -eval(<< -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/lua/lua/getversion.xml b/reference/lua/lua/getversion.xml deleted file mode 100644 index a338b69baf..0000000000 --- a/reference/lua/lua/getversion.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - Lua::getVersion - Obtiene la versión - - - - &reftitle.description; - - public stringLua::getVersion - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve Lua::LUA_VERSION. - - - - - - diff --git a/reference/lua/lua/include.xml b/reference/lua/lua/include.xml deleted file mode 100644 index 32e3786390..0000000000 --- a/reference/lua/lua/include.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - Lua::include - Analiza un fichero script Lua - - - - &reftitle.description; - - public mixedLua::include - stringfile - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - file - - - - - - - - - - - &reftitle.returnvalues; - - Devuelve el resultado del código incluido, &null; en caso que los argumentos pasados sean erróneos o &false; - para cualquier otro tipo de error. - - - - - - diff --git a/reference/lua/lua/registercallback.xml b/reference/lua/lua/registercallback.xml deleted file mode 100644 index 069d2e75d0..0000000000 --- a/reference/lua/lua/registercallback.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - Lua::registerCallback - Registra una función PHP en Lua - - - - &reftitle.description; - - public mixedLua::registerCallback - stringname - callablefunction - - - Registra una función PHP en Lua con el nombre de función que se indique en "$name" - - - - - - &reftitle.parameters; - - - name - - - - - - - - function - - - Una función de llamada de retorno válida PHP - - - - - - - - &reftitle.returnvalues; - - Devuelve $this, &null; en caso que los argumentos sean erróneos o &false; para - cualquier otro tipo de error. - - - - - &reftitle.examples; - - Ejemplo de <function>Lua::registerCallback</function> - -registerCallback("echo", "var_dump"); -$lua->eval(<< -]]> - - &example.outputs; - - - float(1) - [2]=> - float(2) - [3]=> - float(3) -} -]]> - - - - - - diff --git a/reference/lua/luaclosure.xml b/reference/lua/luaclosure.xml deleted file mode 100644 index 18edd81b8d..0000000000 --- a/reference/lua/luaclosure.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - La clase LuaClosure - LuaClosure - - - - -
    - &reftitle.intro; - - LuaClosure es una clase contenedor para LUA_TFUNCTION que puede ser devuelta - al llamar a la función Lua. - -
    - - -
    - &reftitle.classsynopsis; - - - - LuaClosure - - - - - LuaClosure - - - - - &Methods; - - - - -
    - -
    - - &reference.lua.entities.luaclosure; - -
    - diff --git a/reference/lua/luaclosure/invoke.xml b/reference/lua/luaclosure/invoke.xml deleted file mode 100644 index 1d2a5b6e52..0000000000 --- a/reference/lua/luaclosure/invoke.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - LuaClosure::__invoke - Invoca el luaclosure - - - - &reftitle.description; - - public voidLuaClosure::__invoke - mixedargs - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - args - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo de <function>LuaClosure::__invoke</function> - -eval(<<call($closure); -$closure(); -?> -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/lua/luaexception.xml b/reference/lua/luaexception.xml deleted file mode 100644 index 9284a9a17e..0000000000 --- a/reference/lua/luaexception.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - La clase LuaException - LuaException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - LuaException - - - - - LuaException - - - - extends - Exception - - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - - -
    - -
    - diff --git a/reference/lua/setup.xml b/reference/lua/setup.xml deleted file mode 100644 index bcc1d6949c..0000000000 --- a/reference/lua/setup.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Para utilizar esta extensión, debe instalarse Lua, disponible en la página del proyecto Lua. - -
    - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;lua. - -
    - -
    - diff --git a/reference/luasandbox/book.xml b/reference/luasandbox/book.xml deleted file mode 100644 index ab696e6a76..0000000000 --- a/reference/luasandbox/book.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - LuaSandbox - LuaSandbox - - - &reftitle.intro; - - LuaSandbox es una extensión para PHP 7 y PHP 8 que permite ejecutar de manera segura código Lua 5.1 no confiable desde PHP. - - - Las diferencias con respecto a la extensión Lua : - - - - LuaSandbox tiene soporte para límites de tiempo y memoria. - - - - - LuaSandbox proporciona un entorno seguro por omisión para la ejecución de código no confiable. - Las funciones estándar de Lua han sido examinadas para la seguridad, y varias han sido corregidas en - consecuencia. - - - - - LuaSandbox tiene una interfaz PHP más compleja, precisa y potente, - pero es menos práctica para los desarrolladores. - - - - - LuaSandbox solo soporta Lua 5.1. Es difícil cambiar esto, ya que - LuaSandbox utiliza bibliotecas estándar de Lua fuertemente modificadas, y - debido a la falta de compatibilidad ascendente entre las principales versiones de Lua. - LuaSandbox tiene como objetivo maximizar la compatibilidad ascendente con los scripts proporcionados - por el usuario. - - - - - - - &reference.luasandbox.setup; - &reference.luasandbox.differences; - &reference.luasandbox.examples; - - - &reference.luasandbox.luasandbox; - &reference.luasandbox.luasandboxfunction; - &reference.luasandbox.luasandboxerror; - &reference.luasandbox.luasandboxerrorerror; - &reference.luasandbox.luasandboxfatalerror; - &reference.luasandbox.luasandboxmemoryerror; - &reference.luasandbox.luasandboxruntimeerror; - &reference.luasandbox.luasandboxsyntaxerror; - &reference.luasandbox.luasandboxtimeouterror; - - - diff --git a/reference/luasandbox/configure.xml b/reference/luasandbox/configure.xml deleted file mode 100644 index 4dd4a5fadb..0000000000 --- a/reference/luasandbox/configure.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;luasandbox - - -
    - diff --git a/reference/luasandbox/differences.xml b/reference/luasandbox/differences.xml deleted file mode 100644 index 6f7376688d..0000000000 --- a/reference/luasandbox/differences.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - Diferencias con Lua estándar - - LuaSandbox proporciona un entorno seguro que difiere en algunos aspectos de Lua 5.1 estándar. - - - - Funcionalidades no disponibles - - - - Los paquetes dofile(), loadfile(), y io, ya que permiten acceso directo al sistema de ficheros. Si es necesario, el acceso al sistema de ficheros debe realizarse a través de funciones de retrollamada PHP. - - - - - El paquete package, incluyendo require() y module(), ya que depende en gran medida del acceso directo al sistema de ficheros. Una reescritura pura de Lua como la utilizada en la extensión MediaWiki Scribunto puede ser utilizada en su lugar. - - - - - load() y loadstring(), para permitir el análisis estático del código Lua. - - - - - print(), ya que escribe en la salida estándar. Si es necesario, la salida debe realizarse a través de funciones de retrollamada PHP. - - - - - La mayoría del paquete os, ya que permite la manipulación del proceso y la ejecución de otros procesos. - - - - - os.clock(), os.date(), os.difftime(), y os.time() siguen estando disponibles. - - - - - - - La mayoría del paquete debug, ya que permite la manipulación del estado Lua y de los metadatos de manera que puede romper el aislamiento. - - - - - debug.traceback() sigue estando disponible. - - - - - - - string.dump(), ya que puede exponer datos internos. - - - - - El paquete collectgarbage(), gcinfo(), y coroutine no han sido examinados en cuanto a seguridad. - - - - - - - Funcionalidades que han sido modificadas - - - - pcall() y xpcall() no pueden capturar ciertos errores, en particular los errores de tiempo límite. - - - - - tostring() no incluye las direcciones de puntero. - - - - - string.match() ha sido parcheado para limitar la profundidad de recursión y para verificar periódicamente un tiempo límite. - - - - - math.random() y math.randomseed() son reemplazados por versiones que no comparten el estado con rand() de PHP. - - - - - Las meta métodos de Lua 5.2 __pairs y __ipairs son soportadas por pairs() y ipairs(). - - - - - - - diff --git a/reference/luasandbox/examples.xml b/reference/luasandbox/examples.xml deleted file mode 100644 index 7befeefd91..0000000000 --- a/reference/luasandbox/examples.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - &reftitle.examples; - - -
    - Uso básico de LuaSandbox - - Una vez que se ha compilado PHP con soporte para LuaSandbox, se puede comenzar a utilizar LuaSandbox para ejecutar de manera segura el código Lua proporcionado por el usuario. - - - Ejecutar código Lua - -setMemoryLimit( 50 * 1024 * 1024 ); -$sandbox->setCPULimit( 10 ); - -// Registrar algunas funciones en el entorno Lua - -function frobnosticate( $v ) { - return [ $v + 42 ]; -} - -$sandbox->registerLibrary( 'php', [ - 'frobnosticate' => 'frobnosticate', - 'output' => function ( $string ) { - echo "$string\n"; - }, - 'error' => function () { - throw new LuaSandboxRuntimeError( "Something is wrong" ); - } -] ); - -// Ejecutar código Lua, incluyendo funciones de retrollamada en PHP y en Lua - -$luaCode = <<loadString( $luaCode )->call(); -assert( $frob->call( 4000 ) === [ 4242 ] ); - -// Las excepciones LuaSandboxRuntimeError lanzadas por PHP pueden ser capturadas en PHP - -list( $ok, $message ) = $sandbox->loadString( 'return pcall( php.error )' )->call(); -assert( !$ok ); -assert( $message === 'Something is wrong' ); - -?> -]]> - - -
    - -
    - diff --git a/reference/luasandbox/luasandbox.xml b/reference/luasandbox/luasandbox.xml deleted file mode 100644 index dd598b3941..0000000000 --- a/reference/luasandbox/luasandbox.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - La clase LuaSandbox - LuaSandbox - - - - -
    - &reftitle.intro; - - La clase LuaSandbox crea un entorno Lua y permite la ejecución de - código Lua. - -
    - - -
    - &reftitle.classsynopsis; - - - - LuaSandbox - - - - - LuaSandbox - - - - &Constants; - - const - int - LuaSandbox::SAMPLES - 0 - - - const - int - LuaSandbox::SECONDS - 1 - - - const - int - LuaSandbox::PERCENT - 2 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - LuaSandbox::SAMPLES - - - Utilizado con LuaSandbox::getProfilerFunctionReport para devolver las duraciones en muestras. - - - - - - LuaSandbox::SECONDS - - - Utilizado con LuaSandbox::getProfilerFunctionReport para devolver las duraciones en segundos. - - - - - - LuaSandbox::PERCENT - - - Utilizado con LuaSandbox::getProfilerFunctionReport para devolver las duraciones en porcentajes del total. - - - - - -
    - - -
    - - &reference.luasandbox.entities.luasandbox; - -
    - diff --git a/reference/luasandbox/luasandbox/callfunction.xml b/reference/luasandbox/luasandbox/callfunction.xml deleted file mode 100644 index 164a5bb11e..0000000000 --- a/reference/luasandbox/luasandbox/callfunction.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - LuaSandbox::callFunction - Llama a una función en una variable global Lua - - - - &reftitle.description; - - public arrayboolLuaSandbox::callFunction - stringname - mixedargs - - - Llama a una función en una variable global Lua. - - - Si el nombre contiene caracteres ".", la función se localiza a través - de accesos recursivos a la tabla, como si el nombre fuera una expresión Lua. - - - Si la variable no existe, o no es una función, se devolverá false y se emitirá un aviso. - - - Para más información sobre la llamada de funciones Lua y los valores de retorno, - ver LuaSandboxFunction::call. - - - - - &reftitle.parameters; - - - name - - - Nombre de la variable Lua. - - - - - args - - - Argumentos de la función. - - - - - - - - &reftitle.returnvalues; - - Devuelve un array de los valores devueltos por la función Lua, que puede estar vacío, &return.falseforfailure;. - - - - - &reftitle.examples; - - Llamada a una función Lua - -callFunction( 'string.match', $string, $pattern ); - -?> -]]> - - - - - - diff --git a/reference/luasandbox/luasandbox/disableprofiler.xml b/reference/luasandbox/luasandbox/disableprofiler.xml deleted file mode 100644 index e6620528c1..0000000000 --- a/reference/luasandbox/luasandbox/disableprofiler.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - LuaSandbox::disableProfiler - Desactiva el perfilador - - - - &reftitle.description; - - public voidLuaSandbox::disableProfiler - - - - Desactiva el perfilador. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - LuaSandbox::enableProfiler - LuaSandbox::getProfilerFunctionReport - - - - - diff --git a/reference/luasandbox/luasandbox/enableprofiler.xml b/reference/luasandbox/luasandbox/enableprofiler.xml deleted file mode 100644 index 5dd4899bff..0000000000 --- a/reference/luasandbox/luasandbox/enableprofiler.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - LuaSandbox::enableProfiler - Activa el perfilador - - - - &reftitle.description; - - public boolLuaSandbox::enableProfiler - floatperiod0.02 - - - Activa el perfilador. El perfilado comenzará cuando se ingrese código Lua. - - - El perfilador muestrea periódicamente el entorno Lua para registrar la función en ejecución. Las pruebas indican que, al menos en Linux, un período inferior a 1ms resultará en un número elevado de desbordamientos, pero sin problemas de rendimiento. - - - - - - &reftitle.parameters; - - - period - - - Muestreo en segundos. - - - - - - - - &reftitle.returnvalues; - - Devuelve un bool indicando si el perfilador está activado. - - - - - &reftitle.seealso; - - LuaSandbox::disableProfiler - LuaSandbox::getProfilerFunctionReport - - - - - diff --git a/reference/luasandbox/luasandbox/getcpuusage.xml b/reference/luasandbox/luasandbox/getcpuusage.xml deleted file mode 100644 index 679effd652..0000000000 --- a/reference/luasandbox/luasandbox/getcpuusage.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - LuaSandbox::getCPUUsage - Recupera el uso actual del tiempo de CPU del entorno Lua - - - - &reftitle.description; - - public floatLuaSandbox::getCPUUsage - - - - Recupera el uso actual del tiempo de CPU del entorno Lua. - - - Esto incluye el tiempo pasado en las funciones de retrollamada PHP. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el uso actual del tiempo de CPU en segundos. - - - - En Windows, esta función siempre devuelve cero. En los sistemas operativos que no soportan CLOCK_THREAD_CPUTIME_ID, - como FreeBSD y Mac OS X, esta función devolverá el tiempo transcurrido en el reloj, no el tiempo de CPU. - - - - - - &reftitle.seealso; - - LuaSandbox::getMemoryUsage - LuaSandbox::getPeakMemoryUsage - LuaSandbox::setCPULimit - - - - - diff --git a/reference/luasandbox/luasandbox/getmemoryusage.xml b/reference/luasandbox/luasandbox/getmemoryusage.xml deleted file mode 100644 index bd86d16b3f..0000000000 --- a/reference/luasandbox/luasandbox/getmemoryusage.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - LuaSandbox::getMemoryUsage - Recupera el uso actual de la memoria del entorno Lua - - - - &reftitle.description; - - public intLuaSandbox::getMemoryUsage - - - - Recupera el uso actual de la memoria del entorno Lua. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el uso actual de la memoria en bytes. - - - - - &reftitle.seealso; - - LuaSandbox::getPeakMemoryUsage - LuaSandbox::getCPUUsage - LuaSandbox::setMemoryLimit - - - - - diff --git a/reference/luasandbox/luasandbox/getpeakmemoryusage.xml b/reference/luasandbox/luasandbox/getpeakmemoryusage.xml deleted file mode 100644 index 3b19bbbd37..0000000000 --- a/reference/luasandbox/luasandbox/getpeakmemoryusage.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - LuaSandbox::getPeakMemoryUsage - Recupera el pico de uso de memoria del entorno Lua - - - - &reftitle.description; - - public intLuaSandbox::getPeakMemoryUsage - - - - Recupera el pico de uso de memoria del entorno Lua. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el pico de uso de memoria en bytes. - - - - - &reftitle.seealso; - - LuaSandbox::getMemoryUsage - LuaSandbox::getCPUUsage - LuaSandbox::setMemoryLimit - - - - - diff --git a/reference/luasandbox/luasandbox/getprofilerfunctionreport.xml b/reference/luasandbox/luasandbox/getprofilerfunctionreport.xml deleted file mode 100644 index 18ea5b4f76..0000000000 --- a/reference/luasandbox/luasandbox/getprofilerfunctionreport.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - LuaSandbox::getProfilerFunctionReport - Recupera los datos del perfilador - - - - &reftitle.description; - - public arrayLuaSandbox::getProfilerFunctionReport - intunitsLuaSandbox::SECONDS - - - Para una instancia de perfilado previamente iniciada por - LuaSandbox::enableProfiler, recupera un - informe del costo de cada función. - - - La medición del costo se determina por el argumento - $units: - - - - LuaSandbox::SAMPLES - Medición en número de muestras. - - - LuaSandbox::SECONDS - Medición en segundos de tiempo CPU. - - - LuaSandbox::PERCENT - Medición en porcentaje de tiempo CPU. - - - - - - &reftitle.parameters; - - - units - - - La unidad de medida constante. - - - - - - - - &reftitle.returnvalues; - - Devuelve las mediciones del perfilador, ordenadas en orden descendente, en forma - de un array asociativo. Las claves son los nombres de las funciones Lua (con el fichero fuente y la línea - definidos entre corchetes angulares), los valores son las mediciones en int - o float. - - - - En Windows, esta función siempre devuelve cero. En los sistemas operativos que no soportan CLOCK_THREAD_CPUTIME_ID, - como FreeBSD y Mac OS X, esta función devolverá el tiempo transcurrido - en el reloj, no el tiempo CPU. - - - - - - &reftitle.examples; - - Perfilado de código Lua - -enableProfiler( 0.01 ); - -// ... Ejecute código Lua aquí ... - -// Recupera los datos del perfilador -$data = $sandbox->getProfilerFunctionReport(); - -?> -]]> - - - - - - diff --git a/reference/luasandbox/luasandbox/getversioninfo.xml b/reference/luasandbox/luasandbox/getversioninfo.xml deleted file mode 100644 index 55ea9ed293..0000000000 --- a/reference/luasandbox/luasandbox/getversioninfo.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - LuaSandbox::getVersionInfo - Devuelve las versiones de LuaSandbox y Lua - - - - &reftitle.description; - - public static arrayLuaSandbox::getVersionInfo - - - - Devuelve las versiones de LuaSandbox y Lua. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un array con dos claves: - - - - - elementotipodescripción - - - - LuaSandbox - string - La versión de la extensión LuaSandbox. - - - Lua - string - El nombre y la versión de la biblioteca Lua, tal como se define por la macro LUA_RELEASE, por ejemplo, "Lua 5.1.5". - - - - - - - - diff --git a/reference/luasandbox/luasandbox/loadbinary.xml b/reference/luasandbox/luasandbox/loadbinary.xml deleted file mode 100644 index 51ad3e9553..0000000000 --- a/reference/luasandbox/luasandbox/loadbinary.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - LuaSandbox::loadBinary - Carga un fragmento binario precompilado en el entorno Lua - - - - &reftitle.description; - - public LuaSandboxFunctionLuaSandbox::loadBinary - stringcode - stringchunkName'' - - - Carga los datos generados por LuaSandboxFunction::dump. - - - - - &reftitle.parameters; - - - code - - - Los datos de LuaSandboxFunction::dump. - - - - - chunkName - - - El nombre del fragmento para la función cargada. - - - - - - - - &reftitle.returnvalues; - - Devuelve una LuaSandboxFunction. - - - - - &reftitle.seealso; - - LuaSandbox::loadString - - - - - diff --git a/reference/luasandbox/luasandbox/loadstring.xml b/reference/luasandbox/luasandbox/loadstring.xml deleted file mode 100644 index d35b3d4cb6..0000000000 --- a/reference/luasandbox/luasandbox/loadstring.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - LuaSandbox::loadString - Carga código Lua en el entorno Lua - - - - &reftitle.description; - - public LuaSandboxFunctionLuaSandbox::loadString - stringcode - stringchunkName'' - - - Carga código Lua en el entorno Lua. - - - Esto es equivalente a la función loadstring() de Lua estándar. - - - - - - &reftitle.parameters; - - - code - - - El código Lua. - - - - - chunkName - - - El nombre del fragmento cargado, para su uso en los rastros de error. - - - - - - - - &reftitle.returnvalues; - - Devuelve una LuaSandboxFunction que, al ejecutarse, ejecutará el $code pasado. - - - - - &reftitle.examples; - - Carga de código en Lua - -loadString( -<<call() ); - -?> -]]> - - &example.outputs; - - - string(12) "Hello, world" -} -]]> - - - - - - &reftitle.seealso; - - LuaSandbox::registerLibrary - LuaSandbox::wrapPhpFunction - - - - - diff --git a/reference/luasandbox/luasandbox/pauseusagetimer.xml b/reference/luasandbox/luasandbox/pauseusagetimer.xml deleted file mode 100644 index 9755d3bfc3..0000000000 --- a/reference/luasandbox/luasandbox/pauseusagetimer.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - LuaSandbox::pauseUsageTimer - Pausa el temporizador de uso de la CPU - - - - &reftitle.description; - - public boolLuaSandbox::pauseUsageTimer - - - - Pausa el temporizador de uso de la CPU. - - - Esto solo tiene efecto cuando se llama desde una retrollamada de Lua. Cuando - la ejecución vuelve a Lua, el temporizador se reiniciará automáticamente. - Si se realiza una nueva llamada a Lua, el temporizador se reiniciará - durante la duración de esa llamada. - - - Si una retrollamada PHP llama nuevamente a Lua con el temporizador sin pausar, y - esa función Lua llama nuevamente a PHP, la segunda llamada PHP no podrá - pausar el temporizador. La lógica es que incluso si la segunda llamada PHP - evita contar el uso de la CPU contra el límite, la primera - llamada sigue contándolo. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un bool indicando si el temporizador está ahora en pausa. - - - - - &reftitle.examples; - - Manipulando el temporizador de uso - -setCPULimit( 1 ); - -function doWait( $t ) { - $end = microtime( true ) + $t; - while ( microtime( true ) < $end ) { - // gasta ciclos de CPU - } -} - -// Registrar una función de retrollamada PHP -$sandbox->registerLibrary( 'php', [ - 'test' => function () use ( $sandbox ) { - $sandbox->pauseUsageTimer(); - doWait( 5 ); - - $sandbox->unpauseUsageTimer(); - doWait( 0.1 ); - }, - 'test2' => function () use ( $sandbox ) { - $sandbox->pauseUsageTimer(); - $sandbox->unpauseUsageTimer(); - doWait( 1.1 ); - } -] ); - -echo "Esto no debería agotar el tiempo...\n"; -$sandbox->loadString( 'php.test()' )->call(); - -echo "Esto debería agotar el tiempo.\n"; -try { - $sandbox->loadString( 'php.test2()' )->call(); - echo "¿No lo hizo?\n"; -} catch ( LuaSandboxTimeoutError $ex ) { - echo "¡Lo hizo! " . $ex->getMessage() . "\n"; -} - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - LuaSandbox::setCPULimit - LuaSandbox::unpauseUsageTimer - - - - - diff --git a/reference/luasandbox/luasandbox/registerlibrary.xml b/reference/luasandbox/luasandbox/registerlibrary.xml deleted file mode 100644 index b923138ad8..0000000000 --- a/reference/luasandbox/luasandbox/registerlibrary.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - LuaSandbox::registerLibrary - Registra un conjunto de funciones PHP como una biblioteca Lua - - - - &reftitle.description; - - public voidLuaSandbox::registerLibrary - stringlibname - arrayfunctions - - - Registra un conjunto de funciones PHP como una biblioteca Lua, de modo que Lua pueda - llamar al código PHP correspondiente. - - - Para más información sobre la llamada de funciones Lua y los valores de retorno, - ver LuaSandboxFunction::call. - - - - - - &reftitle.parameters; - - - libname - - - El nombre de la biblioteca. En el estado Lua, la variable global de este - nombre se definirá en la tabla de funciones. Si la tabla ya existe, - las nuevas funciones se añadirán a ella. - - - - - functions - - - Un array, donde cada clave es un nombre de función, y cada valor es un - callable PHP correspondiente. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Registro de funciones PHP para ser llamadas desde Lua - -registerLibrary( 'php', [ - 'frobnosticate' => 'frobnosticate', - 'output' => function ( $string ) { - echo "$string\n"; - }, - 'error' => function () { - throw new LuaSandboxRuntimeError( "Something is wrong" ); - } -] ); - -?> -]]> - - - - - - &reftitle.seealso; - - LuaSandbox::loadString - LuaSandbox::wrapPhpFunction - - - - - diff --git a/reference/luasandbox/luasandbox/setcpulimit.xml b/reference/luasandbox/luasandbox/setcpulimit.xml deleted file mode 100644 index d53246ae11..0000000000 --- a/reference/luasandbox/luasandbox/setcpulimit.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - LuaSandbox::setCPULimit - Define la limitación de tiempo CPU para el entorno Lua - - - - &reftitle.description; - - public voidLuaSandbox::setCPULimit - floatboollimit - - - Define la limitación de tiempo CPU para el entorno Lua. - - - Si el tiempo total de usuario y sistema utilizado por el entorno después - de la llamada a este método excede este límite, se lanza una excepción - LuaSandboxTimeoutError. - - - El tiempo utilizado en las funciones de retrollamada PHP se incluye en el límite. - - - Definir el tiempo límite a una función de retrollamada Lua en ejecución provoca - que el temporizador se reinicie, o se inicie si no estaba ya en ejecución. - - - - En Windows, la limitación de tiempo CPU será ignorada. En los sistemas operativos - que no soportan CLOCK_THREAD_CPUTIME_ID, como FreeBSD y Mac OS X, el tiempo transcurrido en el muro, en lugar del tiempo CPU, será limitado. - - - - - - &reftitle.parameters; - - - limit - - - El límite como float en segundos, o &false; para ningún límite. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Llamada a una función Lua - -setCPULimit( 2 ); - -// lanza el código Lua -$sandbox->loadString( 'while true do end' )->call(); - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - LuaSandbox::getCPUUsage - LuaSandbox::setMemoryLimit - - - - - diff --git a/reference/luasandbox/luasandbox/setmemorylimit.xml b/reference/luasandbox/luasandbox/setmemorylimit.xml deleted file mode 100644 index 59b6834613..0000000000 --- a/reference/luasandbox/luasandbox/setmemorylimit.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - LuaSandbox::setMemoryLimit - Define el límite de memoria para el entorno Lua - - - - &reftitle.description; - - public voidLuaSandbox::setMemoryLimit - intlimit - - - Define el límite de memoria para el entorno Lua. - - - Si se supera este límite, se lanza una - excepción LuaSandboxMemoryError. - - - - - - &reftitle.parameters; - - - limit - - - El límite de memoria en bytes. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Llamando a una función Lua - -setMemoryLimit( 50 * 1024 * 1024 ); - -// ejecuta el código Lua -$sandbox->loadString( 'local x = "x"; while true do x = x .. x; end' )->call(); - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - LuaSandbox::getMemoryUsage - LuaSandbox::getPeakMemoryUsage - LuaSandbox::setCPULimit - - - - - diff --git a/reference/luasandbox/luasandbox/unpauseusagetimer.xml b/reference/luasandbox/luasandbox/unpauseusagetimer.xml deleted file mode 100644 index 78e2045651..0000000000 --- a/reference/luasandbox/luasandbox/unpauseusagetimer.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - LuaSandbox::unpauseUsageTimer - Reanuda el temporizador de uso pausado por LuaSandbox::pauseUsageTimer - - - - &reftitle.description; - - public voidLuaSandbox::unpauseUsageTimer - - - - Reanuda el temporizador de uso pausado por LuaSandbox::pauseUsageTimer. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - LuaSandbox::pauseUsageTimer - LuaSandbox::setCPULimit - - - - - diff --git a/reference/luasandbox/luasandbox/wrapphpfunction.xml b/reference/luasandbox/luasandbox/wrapphpfunction.xml deleted file mode 100644 index e8174543cc..0000000000 --- a/reference/luasandbox/luasandbox/wrapphpfunction.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - LuaSandbox::wrapPhpFunction - Envuelve una función PHP en una LuaSandboxFunction - - - - &reftitle.description; - - public LuaSandboxFunctionLuaSandbox::wrapPhpFunction - callablefunction - - - Envuelve una función PHP en una LuaSandboxFunction, de modo - que pueda ser pasada a Lua como una función anónima. - - - La función debe devolver un array de valores (que puede estar vacío), - o &null; que es equivalente a devolver el array vacío. - - - Las excepciones serán lanzadas como errores en Lua, sin embargo, solo las - excepciones LuaSandboxRuntimeError pueden ser capturadas - dentro de Lua con pcall() o xpcall(). - - - Para más información sobre la llamada de funciones Lua y los valores de retorno, - ver LuaSandboxFunction::call. - - - - - &reftitle.parameters; - - - function - - - La función de retrollamada a envolver. - - - - - - - - &reftitle.returnvalues; - - Devuelve un LuaSandboxFunction. - - - - - &reftitle.seealso; - - LuaSandbox::loadString - LuaSandbox::registerLibrary - - - - - diff --git a/reference/luasandbox/luasandboxerror.xml b/reference/luasandbox/luasandboxerror.xml deleted file mode 100644 index 85c08f0f96..0000000000 --- a/reference/luasandbox/luasandboxerror.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - La clase LuaSandboxError - LuaSandboxError - - - - -
    - &reftitle.intro; - - La clase base para las excepciones LuaSandbox - -
    - - -
    - &reftitle.classsynopsis; - - - - LuaSandboxError - - - - - LuaSandboxError - - - - extends - Exception - - - - &Constants; - - const - int - LuaSandboxError::RUN - 2 - - - const - int - LuaSandboxError::SYNTAX - 3 - - - const - int - LuaSandboxError::MEM - 4 - - - const - int - LuaSandboxError::ERR - 5 - - - &InheritedProperties; - - - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.constants; - - - - LuaSandboxError::RUN - - - - - - - LuaSandboxError::SYNTAX - - - - - - - LuaSandboxError::MEM - - - - - - - LuaSandboxError::ERR - - - - - - -
    - - -
    - - - -
    - diff --git a/reference/luasandbox/luasandboxerrorerror.xml b/reference/luasandbox/luasandboxerrorerror.xml deleted file mode 100644 index 1edf3fe212..0000000000 --- a/reference/luasandbox/luasandboxerrorerror.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - La clase LuaSandboxErrorError - LuaSandboxErrorError - - - - -
    - &reftitle.intro; - - Excepción lanzada cuando Lua encuentra un error dentro de un gestor de errores. - -
    - - -
    - &reftitle.classsynopsis; - - - - LuaSandboxErrorError - - - - - LuaSandboxErrorError - - - - extends - LuaSandboxFatalError - - - - - &InheritedProperties; - - - - - &InheritedMethods; - - - - - -
    - -
    - - - -
    - diff --git a/reference/luasandbox/luasandboxfatalerror.xml b/reference/luasandbox/luasandboxfatalerror.xml deleted file mode 100644 index b7c18c0d7b..0000000000 --- a/reference/luasandbox/luasandboxfatalerror.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - La clase LuaSandboxFatalError - LuaSandboxFatalError - - - - -
    - &reftitle.intro; - - Las excepciones LuaSandbox que no pueden ser atrapadas. - - - Estas excepciones no pueden ser atrapadas en Lua utilizando - pcall() o xpcall(). - -
    - - -
    - &reftitle.classsynopsis; - - - - LuaSandboxFatalError - - - - - LuaSandboxFatalError - - - - extends - LuaSandboxError - - - - - &InheritedProperties; - - - - - &InheritedMethods; - - - - - -
    - -
    - - - -
    - diff --git a/reference/luasandbox/luasandboxfunction.xml b/reference/luasandbox/luasandboxfunction.xml deleted file mode 100644 index 78f577d976..0000000000 --- a/reference/luasandbox/luasandboxfunction.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - La clase LuaSandboxFunction - LuaSandboxFunction - - - - -
    - &reftitle.intro; - - Representa una función Lua, permitiendo llamarla desde PHP. - - - Una LuaSandboxFunction puede ser obtenida como valor de retorno desde Lua, como argumento - pasado a una retrollamada desde Lua, o utilizando - LuaSandbox::wrapPhpFunction, - LuaSandbox::loadString, o - LuaSandbox::loadBinary. - -
    - - -
    - &reftitle.classsynopsis; - - - - LuaSandboxFunction - - - - - LuaSandboxFunction - - - - - &Methods; - - - - -
    - -
    - - &reference.luasandbox.entities.luasandboxfunction; - -
    - diff --git a/reference/luasandbox/luasandboxfunction/call.xml b/reference/luasandbox/luasandboxfunction/call.xml deleted file mode 100644 index e9668d1c75..0000000000 --- a/reference/luasandbox/luasandboxfunction/call.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - LuaSandboxFunction::call - Llama a una función Lua - - - - &reftitle.description; - - public arrayboolLuaSandboxFunction::call - stringargs - - - Llama a una función Lua. - - - Los errores considerados como culpa del código PHP harán que la función devuelva el valor &false; y emita E_WARNING, por ejemplo, un tipo resource utilizado como argumento. Los errores Lua lanzarán una excepción LuaSandboxRuntimeError. - - - Los tipos PHP y Lua se convierten de la siguiente manera: - - - - Los &null; de PHP son Lua nil, y viceversa. - - - - Los ints de PHP y floats se convierten en números Lua. El infinito y NAN son soportados. - - - - - Los números Lua sin parte fraccionaria entre aproximadamente -2**53 y 2**53 se convierten en ints PHP, los demás se convierten en floats PHP. - - - - Los bools de PHP son booleanos Lua, y viceversa. - - - Los strings de PHP son cadenas Lua, y viceversa. - - - - Las funciones Lua son objetos PHP LuaSandboxFunction, y viceversa. Los callables PHP generales no son soportados. - - - - - Los arrays de PHP se convierten en tablas Lua, y viceversa. - - - - - Se debe tener en cuenta que Lua indexa típicamente los arrays a partir de 1, mientras que PHP indexa los arrays a partir de 0. No se hace ningún ajuste para estas diferentes convenciones. - - - - Los arrays auto-referenciales no son soportados en ambos sentidos. - - - Las referencias PHP son desreferenciadas. - - - - Los __pairs y __ipairs de Lua son tratados. __index es ignorado. - - - - - Al convertir de PHP a Lua, las claves enteras entre -2**53 y 2**53 se representan como números Lua. Todas las demás claves se representan como cadenas Lua. - - - - - Al convertir de Lua a PHP, las claves distintas de las cadenas y los números enteros resultarán en un error, así como las colisiones al convertir números en cadenas o viceversa (ya que PHP considera cosas como $a[0] y $a["0"] como equivalentes). - - - - - - - Todos los demás tipos no son soportados y resultarán en un error/excepción, incluyendo los objects PHP generales y los tipos userdata y thread Lua. - - - - - Las funciones Lua devuelven intrínsecamente una lista de resultados. Por lo tanto, en caso de éxito, este método devuelve un array que contiene todos los valores devueltos por Lua, con claves int comenzando en cero. Lua puede no devolver ningún resultado, en cuyo caso se devuelve un array vacío. - - - - - &reftitle.parameters; - - - args - - - Los argumentos pasados a la función. - - - - - - - - &reftitle.returnvalues; - - Devuelve un array de los valores devueltos por la función, que puede estar vacío, &return.falseforfailure;. - - - - - diff --git a/reference/luasandbox/luasandboxfunction/construct.xml b/reference/luasandbox/luasandboxfunction/construct.xml deleted file mode 100644 index 1fe8e74541..0000000000 --- a/reference/luasandbox/luasandboxfunction/construct.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - LuaSandboxFunction::__construct - No utilizado - - - - &reftitle.description; - - final private LuaSandboxFunction::__construct - - - - Los LuaSandboxFunction se obtienen como valor de retorno de Lua, - como argumento pasado a una retrollamada desde Lua, o utilizando - LuaSandbox::wrapPhpFunction, - LuaSandbox::loadString, o - LuaSandbox::loadBinary. No pueden ser construidos directamente. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - diff --git a/reference/luasandbox/luasandboxfunction/dump.xml b/reference/luasandbox/luasandboxfunction/dump.xml deleted file mode 100644 index 64ffa2a57d..0000000000 --- a/reference/luasandbox/luasandboxfunction/dump.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - LuaSandboxFunction::dump - Muestra la función como un blob binario - - - - &reftitle.description; - - public stringLuaSandboxFunction::dump - - - - Muestra la función como un blob binario. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un string que puede ser pasado a LuaSandbox::loadBinary. - - - - - diff --git a/reference/luasandbox/luasandboxmemoryerror.xml b/reference/luasandbox/luasandboxmemoryerror.xml deleted file mode 100644 index 2dbffe3be8..0000000000 --- a/reference/luasandbox/luasandboxmemoryerror.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - La clase LuaSandboxMemoryError - LuaSandboxMemoryError - - - - -
    - &reftitle.intro; - - Excepción lanzada cuando Lua no puede asignar memoria. - -
    - - -
    - &reftitle.classsynopsis; - - - - LuaSandboxMemoryError - - - - - LuaSandboxMemoryError - - - - extends - LuaSandboxFatalError - - - - - &InheritedProperties; - - - - - &InheritedMethods; - - - - - -
    - -
    - &reftitle.seealso; - - LuaSandbox::setMemoryLimit - -
    - -
    - - - -
    - diff --git a/reference/luasandbox/luasandboxruntimeerror.xml b/reference/luasandbox/luasandboxruntimeerror.xml deleted file mode 100644 index d53bcb1bfa..0000000000 --- a/reference/luasandbox/luasandboxruntimeerror.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - La clase LuaSandboxRuntimeError - LuaSandboxRuntimeError - - - - -
    - &reftitle.intro; - - Las excepciones de ejecución LuaSandbox que pueden ser capturadas. - - - Estas excepciones pueden ser capturadas en Lua utilizando - pcall() o xpcall(). - -
    - - -
    - &reftitle.classsynopsis; - - - - LuaSandboxRuntimeError - - - - - LuaSandboxRuntimeError - - - - extends - LuaSandboxError - - - - - &InheritedProperties; - - - - - &InheritedMethods; - - - - - -
    - -
    - - - -
    - diff --git a/reference/luasandbox/luasandboxsyntaxerror.xml b/reference/luasandbox/luasandboxsyntaxerror.xml deleted file mode 100644 index 813bad703e..0000000000 --- a/reference/luasandbox/luasandboxsyntaxerror.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - La clase LuaSandboxSyntaxError - LuaSandboxSyntaxError - - - - -
    - &reftitle.intro; - - Excepción lanzada cuando el código Lua no puede ser analizado. - -
    - - -
    - &reftitle.classsynopsis; - - - - LuaSandboxSyntaxError - - - - - LuaSandboxSyntaxError - - - - extends - LuaSandboxFatalError - - - - - &InheritedProperties; - - - - - &InheritedMethods; - - - - - -
    - -
    - - - -
    - diff --git a/reference/luasandbox/luasandboxtimeouterror.xml b/reference/luasandbox/luasandboxtimeouterror.xml deleted file mode 100644 index 481dc77a10..0000000000 --- a/reference/luasandbox/luasandboxtimeouterror.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - La clase LuaSandboxTimeoutError - LuaSandboxTimeoutError - - - - -
    - &reftitle.intro; - - Excepción lanzada cuando se supera el límite de tiempo de CPU configurado. - -
    - - -
    - &reftitle.classsynopsis; - - - - LuaSandboxTimeoutError - - - - - LuaSandboxTimeoutError - - - - extends - LuaSandboxFatalError - - - - - &InheritedProperties; - - - - - &InheritedMethods; - - - - - -
    - -
    - &reftitle.seealso; - - LuaSandbox::setCPULimit - -
    - -
    - - - -
    - diff --git a/reference/luasandbox/setup.xml b/reference/luasandbox/setup.xml deleted file mode 100644 index 2ff8d91154..0000000000 --- a/reference/luasandbox/setup.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Para utilizar esta extensión, Lua 5.1 debe estar instalado, disponible en la página de inicio de Lua. - - - Para utilizar las funcionalidades de temporizador, LuaSandbox debe estar instalado en - Linux. - - - Si se utiliza FreeBSD o Mac OS X, solo se soporta el tiempo real (reloj de pared), las funciones que pretenden devolver el tiempo de CPU devolverán - en realidad el tiempo del reloj de pared. - - - Si se utiliza Windows, ninguna función de temporizador será soportada. Los límites de tiempo - serán inoperantes. - -
    - -
    - &reftitle.install; - - - Si el sistema operativo es Debian 10 o más reciente, o Ubuntu 18.04 o más reciente, entonces - LuaSandbox debería ser típicamente instalado desde el paquete - php-luasandbox: - - - - - - - - Para instalar LuaSandbox mediante PIE, - ejecútese el siguiente comando: - - - - - - - - Las versiones antiguas se encuentran en el paquete PECL LuaSandbox. - - - -
    - -
    - diff --git a/reference/lzf/book.xml b/reference/lzf/book.xml deleted file mode 100644 index 1ff83ed082..0000000000 --- a/reference/lzf/book.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - LZF - LZF - - - - &reftitle.intro; - - LZF es un algoritmo de compresión muy rápido, ideal para ahorrar espacio con - solamente un ligero costo de velocidad. Puede optimizarse para velocidad o espacio a - la hora de compilar. Esta extensión utiliza la librería liblzf - por Marc Lehmann para sus operaciones. - - - - - &reference.lzf.setup; - &reference.lzf.reference; - - - diff --git a/reference/lzf/configure.xml b/reference/lzf/configure.xml deleted file mode 100644 index f8ff690cde..0000000000 --- a/reference/lzf/configure.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - -
    - &reftitle.install; - - &pecl.moved; - &pecl.info; - &url.pecl.package;lzf. - - - Para utilizar estas funciones, PHP debe ser compilado con soporte para - LZF mediante la opción de configuración - . - Asimismo, puede especificarse la opción - - para optimizar LZF en términos de espacio, aunque esto puede afectar negativamente a la velocidad. - - - Los usuarios de Windows deben activar la biblioteca - php_lzf.dll en el &php.ini; - para poder utilizar estas funciones. - -
    - diff --git a/reference/lzf/functions/lzf-compress.xml b/reference/lzf/functions/lzf-compress.xml deleted file mode 100644 index c3ae4f1d76..0000000000 --- a/reference/lzf/functions/lzf-compress.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - lzf_compress - - Compresión LZF - - - - &reftitle.description; - - stringlzf_compress - stringdata - - - lzf_compress comprime el string - data dado utilizando codificación LZF. - - - - &reftitle.parameters; - - - data - - - El string a comprimir. - - - - - - - &reftitle.returnvalues; - - Devuelve los datos comprimidos o &false; si ocurrió un error. - - - - &reftitle.seealso; - - lzf_decompress - - - - diff --git a/reference/lzf/functions/lzf-decompress.xml b/reference/lzf/functions/lzf-decompress.xml deleted file mode 100644 index 6f9eee60fb..0000000000 --- a/reference/lzf/functions/lzf-decompress.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - lzf_decompress - - Descompresión LZF - - - - &reftitle.description; - - stringlzf_decompress - stringdata - - - lzf_compress descomprime la cadena - data dada que contiene los datos codificados en lzf. - - - - &reftitle.parameters; - - - data - - - La cadena comprimida. - - - - - - - &reftitle.returnvalues; - - Devuelve los datos descomprimidos o &false; si ocurrió un error. - - - - &reftitle.seealso; - - lzf_compress - - - - diff --git a/reference/lzf/functions/lzf-optimized-for.xml b/reference/lzf/functions/lzf-optimized-for.xml deleted file mode 100644 index 0a38f047df..0000000000 --- a/reference/lzf/functions/lzf-optimized-for.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - lzf_optimized_for - - Determina para qué fue optimizada la extensión LZF - - - - &reftitle.description; - - intlzf_optimized_for - - - - Determina para qué fue optimizada la extensión LZF durante la compilación. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve 1 si LZF fue optimizada para velocidad, 0 para compresión. - - - - diff --git a/reference/lzf/reference.xml b/reference/lzf/reference.xml deleted file mode 100644 index 2f04fc50f7..0000000000 --- a/reference/lzf/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - &Functions; LZF - - &reference.lzf.entities.functions; - - - - - diff --git a/reference/lzf/setup.xml b/reference/lzf/setup.xml deleted file mode 100644 index 472395347a..0000000000 --- a/reference/lzf/setup.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - - - - - &reftitle.setup; - - - &reference.lzf.configure; - - - - - diff --git a/reference/mailparse/book.xml b/reference/mailparse/book.xml deleted file mode 100644 index 08893bf4a0..0000000000 --- a/reference/mailparse/book.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Mailparse - - - - &reftitle.intro; - - Mailparse es una extensión para analizar y trabajar con los mensajes de correo electrónico. - Esto puede tratarse con los mensajes compatibles RFC 822 y - RFC 2045 (MIME). - - - Mailparse está basado en flujo, lo que significa que no guarda en memoria las - copias de los archivos que procesa - lo que es muy eficiente para recursos cuando - se trata de mensajes de gran tamaño. - - - - Mailparse requiere la extensión mbstring, - y mbstring debe cargarse antes de mailparse. - - - - - - &reference.mailparse.setup; - &reference.mailparse.constants; - - &reference.mailparse.reference; - - - diff --git a/reference/mailparse/configure.xml b/reference/mailparse/configure.xml deleted file mode 100644 index c4e122a35f..0000000000 --- a/reference/mailparse/configure.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - -
    - &reftitle.install; - - &pecl.moved; - &pecl.info; - &url.pecl.package;mailparse. - - - Para poder utilizar estas funciones se debe compilar PHP con soporte para mailparse - mediante la opción de configuración - . - - - Los usuarios de windows deben habilitar php_mailparse.dll en el - fichero &php.ini; con el fin de usar estas funciones. - &pecl.windows.download.avail; - - - Es necesario que la extensión mbstring - esté cargada antes que mailparse. - -
    - diff --git a/reference/mailparse/constants.xml b/reference/mailparse/constants.xml deleted file mode 100644 index 289f544512..0000000000 --- a/reference/mailparse/constants.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - &reftitle.constants; - &extension.constants; - - - - MAILPARSE_EXTRACT_OUTPUT - (int) - - - - - - - - - MAILPARSE_EXTRACT_STREAM - (int) - - - - - - - - - MAILPARSE_EXTRACT_RETURN - (int) - - - - - - - - - - diff --git a/reference/mailparse/functions/mailparse-determine-best-xfer-encoding.xml b/reference/mailparse/functions/mailparse-determine-best-xfer-encoding.xml deleted file mode 100644 index dfffbc1a61..0000000000 --- a/reference/mailparse/functions/mailparse-determine-best-xfer-encoding.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - mailparse_determine_best_xfer_encoding - Obtiene la mejor forma de codificar - - - &reftitle.description; - - stringmailparse_determine_best_xfer_encoding - resourcefp - - - Encuentra la mejor forma de codificar el contenido leído del apuntador de - archivo dado. - - - - - &reftitle.parameters; - - - fp - - - Un apuntador de archivo válido, que reciba operaciones de búsqueda. - - - - - - - - &reftitle.returnvalues; - - Devuelve una de las codificaciones de caracteres soportadas por el módulo - mbstring. - - - - - - &reftitle.examples; - - Ejemplo de - <function>mailparse_determine_best_xfer_encoding</function> - - -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/mailparse/functions/mailparse-msg-create.xml b/reference/mailparse/functions/mailparse-msg-create.xml deleted file mode 100644 index 50531f0790..0000000000 --- a/reference/mailparse/functions/mailparse-msg-create.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - mailparse_msg_create - Crea un recurso de correo mime - - - &reftitle.description; - - resourcemailparse_msg_create - - - - Crea un recurso tipo correo MIME. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un recurso que puede ser usado para interpretar un mensaje. - - - - - &reftitle.notes; - - - Se recomienda llamar a mailparse_msg_free en el resultado - de esta función, cuando ya no sea necesaria, para evitar fugas de memoria - - - - - - &reftitle.seealso; - - mailparse_msg_free - mailparse_msg_parse_file - - - - - diff --git a/reference/mailparse/functions/mailparse-msg-extract-part-file.xml b/reference/mailparse/functions/mailparse-msg-extract-part-file.xml deleted file mode 100644 index 6c85e975a1..0000000000 --- a/reference/mailparse/functions/mailparse-msg-extract-part-file.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - mailparse_msg_extract_part_file - Extrae/decodifica una sección de mensaje - - - &reftitle.description; - - stringmailparse_msg_extract_part_file - resourcemimemail - mixedfilename - callablecallbackfunc - - - Extrae/decodifica una sección de mensaje del archivo indicado. - - - Los contenidos de la sección serán decodificados de acuerdo a su - codificación de transferencia - se soportan base64, - imprimible-con-comillas y texto uuencode. - - - - - &reftitle.parameters; - - - mimemail - - - Un recurso MIME válido, creado con - mailparse_msg_create. - - - - - filename - - - Puede ser un nombre de archivo o un recurso de secuencia válido. - - - - - callbackfunc - - - Si se define, este parámetro debe ser una llamada de retorno válida, - a la cual le será pasada la sección extraída, o &null; para - asegurarse de que esta función devuelva la sección extraída. - - - Si no se especifica, los contenidos serán enviados a "stdout". - - - - - - - - &reftitle.returnvalues; - - Si callbackfunc es diferente de &null; devuelve - &true; en caso de éxito. - - - Si callbackfunc es &null;, devuelve la sección - extraída como una cadena. - - - Devuelve &false; en caso de fallo. - - - - - &reftitle.seealso; - - mailparse_msg_extract_part - mailparse_msg_extract_whole_part_file - - - - - diff --git a/reference/mailparse/functions/mailparse-msg-extract-part.xml b/reference/mailparse/functions/mailparse-msg-extract-part.xml deleted file mode 100644 index bdce286fad..0000000000 --- a/reference/mailparse/functions/mailparse-msg-extract-part.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - mailparse_msg_extract_part - - Extrae/decodifica una sección de mensaje - - - - &reftitle.description; - - voidmailparse_msg_extract_part - resourcemimemail - stringmsgbody - callablecallbackfunc - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - mimemail - - - Un recurso MIME válido. - - - - - msgbody - - - - - - - callbackfunc - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - mailparse_msg_extract_part_file - mailparse_msg_extract_whole_part_file - - - - - diff --git a/reference/mailparse/functions/mailparse-msg-extract-whole-part-file.xml b/reference/mailparse/functions/mailparse-msg-extract-whole-part-file.xml deleted file mode 100644 index bed44f3b95..0000000000 --- a/reference/mailparse/functions/mailparse-msg-extract-whole-part-file.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - mailparse_msg_extract_whole_part_file - Extrae una sección del mensaje incluyendo cabeceras sin descodificar la transferencia codificada - - - &reftitle.description; - - stringmailparse_msg_extract_whole_part_file - resourcemimemail - stringfilename - callablecallbackfunc - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - mimemail - - - Un recurso MIME válido. - - - - - filename - - - - - - - callbackfunc - - - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.seealso; - - mailparse_msg_extract_part - mailparse_msg_extract_part_file - - - - - diff --git a/reference/mailparse/functions/mailparse-msg-free.xml b/reference/mailparse/functions/mailparse-msg-free.xml deleted file mode 100644 index eaa1ff01c2..0000000000 --- a/reference/mailparse/functions/mailparse-msg-free.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - mailparse_msg_free - Libera un recurso MIME - - - &reftitle.description; - - boolmailparse_msg_free - resourcemimemail - - - Libera un recurso MIME. - - - - - &reftitle.parameters; - - - mimemail - - - Un recurso MIME válido reservado por - mailparse_msg_create o - mailparse_msg_parse_file. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - mailparse_msg_create - mailparse_msg_parse_file - - - - - diff --git a/reference/mailparse/functions/mailparse-msg-get-part-data.xml b/reference/mailparse/functions/mailparse-msg-get-part-data.xml deleted file mode 100644 index b3b586ba9a..0000000000 --- a/reference/mailparse/functions/mailparse-msg-get-part-data.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - mailparse_msg_get_part_data - Devuelve una matriz asociativa de información sobre el - mensaje - - - &reftitle.description; - - arraymailparse_msg_get_part_data - resourcemimemail - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - mimemail - - - Un recurso MIME válido. - - - - - - - - diff --git a/reference/mailparse/functions/mailparse-msg-get-part.xml b/reference/mailparse/functions/mailparse-msg-get-part.xml deleted file mode 100644 index 96b8827c2c..0000000000 --- a/reference/mailparse/functions/mailparse-msg-get-part.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - mailparse_msg_get_part - Devuelve un gestor sobre una sección dada en un mensaje - mime - - - &reftitle.description; - - resourcemailparse_msg_get_part - resourcemimemail - stringmimesection - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - mimemail - - - Un recurso MIME válido. - - - - - mimesection - - - - - - - - - - diff --git a/reference/mailparse/functions/mailparse-msg-get-structure.xml b/reference/mailparse/functions/mailparse-msg-get-structure.xml deleted file mode 100644 index 6793af66c8..0000000000 --- a/reference/mailparse/functions/mailparse-msg-get-structure.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - mailparse_msg_get_structure - Devuelve una matriz de nombres de sección mime en el mensaje - dado - - - &reftitle.description; - - arraymailparse_msg_get_structure - resourcemimemail - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - mimemail - - - Un recurso MIME válido. - - - - - - - - diff --git a/reference/mailparse/functions/mailparse-msg-parse-file.xml b/reference/mailparse/functions/mailparse-msg-parse-file.xml deleted file mode 100644 index f4532b26c0..0000000000 --- a/reference/mailparse/functions/mailparse-msg-parse-file.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - mailparse_msg_parse_file - Procesa un archivo - - - &reftitle.description; - - resourcemailparse_msg_parse_file - stringfilename - - - Procesa un archivo. Este es el modo óptimo de interpretar un archivo que - tenga en disco. - - - - - &reftitle.parameters; - - - filename - - - Ruta al archivo que contiene el mensaje. El archivo es abierto y - secuenciado a través del analizador sintáctico. - - - - El mensaje contenido en filename debe terminar con una - nueva línea (CRLF); de lo contrario, no se analizará la última línea del mensaje. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un recurso MIME que representa la estructura, - o &false; en caso de error. - - - - - &reftitle.notes; - - - Se recomienda llamar a mailparse_msg_free en el resultado - de esta función, cuando ya no sea necesaria, para evitar fugas de memoria - - - - - - &reftitle.seealso; - - mailparse_msg_free - mailparse_msg_create - - - - - diff --git a/reference/mailparse/functions/mailparse-msg-parse.xml b/reference/mailparse/functions/mailparse-msg-parse.xml deleted file mode 100644 index 1cfbcf63b0..0000000000 --- a/reference/mailparse/functions/mailparse-msg-parse.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - mailparse_msg_parse - Procesar datos incrementalmente sobre un búfer - - - &reftitle.description; - - boolmailparse_msg_parse - resourcemimemail - stringdata - - - Procesa datos incrementalmente al interior del recurso de correo mime - entregado. - - - Esta función le permite secuenciar porciones de un archivo en pedazos, en - lugar de leer y procesarlo en su totalidad. - - - - - &reftitle.parameters; - - - mimemail - - - Un recurso MIME válido. - - - - - data - - - - El último trozo de data debe terminar con una - nueva línea (CRLF); de lo contrario, - no se analizará la última línea del mensaje. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/mailparse/functions/mailparse-rfc822-parse-addresses.xml b/reference/mailparse/functions/mailparse-rfc822-parse-addresses.xml deleted file mode 100644 index 0487b181b5..0000000000 --- a/reference/mailparse/functions/mailparse-rfc822-parse-addresses.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - mailparse_rfc822_parse_addresses - Procesa direcciones compatibles con RFC 822 - - - &reftitle.description; - - arraymailparse_rfc822_parse_addresses - stringaddresses - - - Procesa una lista de recipientes compatible con RFC 822, tal como la que es encontrada en una - cabecera To:. - - - - - &reftitle.parameters; - - - addresses - - - Una cadena que contiene direcciones, como: - Wez Furlong <wez@example.com>, pepe@example.com - - - - Esta cadena no debe contener el nombre de la cabecera. - - - - - - - - - &reftitle.returnvalues; - - Devuelve una matriz de matrices asociativas con las siguientes claves - para cada recipiente: - - - - - display - - El nombre del recipiente, para propósitos de muestra. Si esta parte - no es definida para un recipiente, esta clave contendrá el mismo - valor que address. - - - - address - La dirección de correo electrónico - - - is_group - &true; si el recipiente es un grupo de noticias, &false; de lo - contrario. - - - - - - - - - &reftitle.examples; - - Ejemplo de - <function>mailparse_rfc822_parse_addresses</function> - -, pepe@example.com'; -var_dump(mailparse_rfc822_parse_addresses($to)); - -?> -]]> - - &example.outputs; - - - array(3) { - ["display"]=> - string(11) "Wez Furlong" - ["address"]=> - string(15) "wez@example.com" - ["is_group"]=> - bool(false) - } - [1]=> - array(3) { - ["display"]=> - string(16) "pepe@example.com" - ["address"]=> - string(16) "pepe@example.com" - ["is_group"]=> - bool(false) - } -} -]]> - - - - - - diff --git a/reference/mailparse/functions/mailparse-stream-encode.xml b/reference/mailparse/functions/mailparse-stream-encode.xml deleted file mode 100644 index 27b86dcd14..0000000000 --- a/reference/mailparse/functions/mailparse-stream-encode.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - mailparse_stream_encode - - Secuencia datos desde un apuntador de archivo, codifica y escribe a - fp_destino - - - - &reftitle.description; - - boolmailparse_stream_encode - resourcesourcefp - resourcedestfp - stringencoding - - - Secuencia datos del apuntador de archivo fuente, aplica la - codificacion y escribe al apuntador de archivo de - destino. - - - - - &reftitle.parameters; - - - sourcefp - - - Un gestor de archivo válido. El archivo es secuenciado a través del - procesador. - - - - - destfp - - - El gestor de archivo de destino, en el cual los datos codificados - serán escritos. - - - - - encoding - - - Una de las codificaciones de caracteres soportadas por el módulo - mbstring. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo de <function>mailparse_stream_encode</function> - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/mailparse/functions/mailparse-uudecode-all.xml b/reference/mailparse/functions/mailparse-uudecode-all.xml deleted file mode 100644 index 07b857d05f..0000000000 --- a/reference/mailparse/functions/mailparse-uudecode-all.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - mailparse_uudecode_all - - Procesa los datos desde un apuntador a archivo y extrae cada archivo - embebido con codificación uu - - - - &reftitle.description; - - arraymailparse_uudecode_all - resourcefp - - - Lee los datos del apuntador de archivo dado y extrae cada archivo - codificado mediante uuencode embebido en un archivo temporal. - - - - - &reftitle.parameters; - - - fp - - - Un apuntador de archivo válido. - - - - - - - - &reftitle.returnvalues; - - Devuelve una matriz de matrices asociativas, listando la información de - cada archivo. - - - - - filename - Ruta al nombre de archivo temporal creado - - - origfilename - El nombre de archivo original, solo para partes codificadas - mediante uuencode - - - - - La primera entrada es el cuerpo del mensaje. Las siguientes son los - archivos uuencode decodificados. - - - - - &reftitle.examples; - - Ejemplo de <function>mailparse_uudecode_all</function> - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/mailparse/reference.xml b/reference/mailparse/reference.xml deleted file mode 100644 index d9167f8618..0000000000 --- a/reference/mailparse/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - - &Functions; Mailparse - -&reference.mailparse.entities.functions; - - - diff --git a/reference/mailparse/setup.xml b/reference/mailparse/setup.xml deleted file mode 100644 index e05f1c47e9..0000000000 --- a/reference/mailparse/setup.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - &reftitle.setup; - - - &reference.mailparse.configure; - - - -
    - &reftitle.runtime; - &extension.runtime; - - - Mailparse &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - mailparse.def_charset - "us-ascii" - INI_SYSTEM - - - - -
    - &ini.php.constants; -
    - - &ini.descriptions.title; - - - - - mailparse.def_charset - string - - - - El juego de caracteres por omisión. - - - - -
    - - - -
    - &reftitle.resources; - - Mailparse define el tipo de recurso mailparse_mail_structure, - que es devuelto por mailparse_msg_create y - mailparse_msg_parse_file. - -
    - - -
    - diff --git a/reference/mcrypt/book.xml b/reference/mcrypt/book.xml deleted file mode 100644 index f23cf32b43..0000000000 --- a/reference/mcrypt/book.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - Mcrypt - - - - &reftitle.intro; - - &warn.deprecated.feature.7-1-0.removed.7-2-0.alternatives; - - - Sodium - (disponible a partir de PHP 7.2.0) - - - OpenSSL - - - - - - - &pecl.moved-ver;7.2.0. - - - - Estas funciones permiten acceder a la biblioteca - mcrypt, que dispone de una gran variedad de algoritmos - de cifrado, como DES, TripleDES, Blowfish (por omisión), 3-WAY, - SAFER-SK64, SAFER-SK128, TWOFISH, TEA, RC2 y GOST en modos CBC, - OFB, CFB y ECB. Asimismo, aceptan también RC6 e IDEA que son - considerados como "no libres". - CFB/OFB es de 8 bits por omisión. - - - - - &reference.mcrypt.setup; - &reference.mcrypt.constants; - &reference.mcrypt.ciphers; - &reference.mcrypt.reference; - - - diff --git a/reference/mcrypt/ciphers.xml b/reference/mcrypt/ciphers.xml deleted file mode 100644 index a81008de78..0000000000 --- a/reference/mcrypt/ciphers.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Modos de cifrado Mcrypt - - A continuación se presenta una lista no exhaustiva de los modos de cifrado de la extensión - mcrypt. Para disponer de una lista completa de los cifrados soportados, - consulte las definiciones en el fichero mcrypt.h. La regla - general con la API mcrypt-2.2.x es que se puede acceder al - modo de cifrado desde PHP con la constante MCRYPT_ciphername. Con - la biblioteca libmcrypt-2.4.x y libmcrypt-2.5.x, estas constantes funcionan - siempre, pero es posible especificar el nombre del cifrado en una cadena, - al llamar a mcrypt_module_open. - - MCRYPT_3DES - MCRYPT_ARCFOUR_IV (libmcrypt > 2.4.x únicamente) - MCRYPT_ARCFOUR (libmcrypt > 2.4.x únicamente) - MCRYPT_BLOWFISH - MCRYPT_CAST_128 - MCRYPT_CAST_256 - MCRYPT_CRYPT - MCRYPT_DES - MCRYPT_DES_COMPAT (libmcrypt 2.2.x únicamente) - MCRYPT_ENIGMA (libmcrypt > 2.4.x únicamente, alias de MCRYPT_CRYPT) - MCRYPT_GOST - MCRYPT_IDEA (no libre) - MCRYPT_LOKI97 (libmcrypt > 2.4.x únicamente) - MCRYPT_MARS (libmcrypt > 2.4.x únicamente, no libre) - MCRYPT_PANAMA (libmcrypt > 2.4.x únicamente) - MCRYPT_RIJNDAEL_128 (libmcrypt > 2.4.x únicamente) - MCRYPT_RIJNDAEL_192 (libmcrypt > 2.4.x únicamente) - MCRYPT_RIJNDAEL_256 (libmcrypt > 2.4.x únicamente) - MCRYPT_RC2 - MCRYPT_RC4 (libmcrypt 2.2.x únicamente) - MCRYPT_RC6 (libmcrypt > 2.4.x únicamente) - MCRYPT_RC6_128 (libmcrypt 2.2.x únicamente) - MCRYPT_RC6_192 (libmcrypt 2.2.x únicamente) - MCRYPT_RC6_256 (libmcrypt 2.2.x únicamente) - MCRYPT_SAFER64 - MCRYPT_SAFER128 - MCRYPT_SAFERPLUS (libmcrypt > 2.4.x únicamente) - MCRYPT_SERPENT(libmcrypt > 2.4.x únicamente) - MCRYPT_SERPENT_128 (libmcrypt 2.2.x únicamente) - MCRYPT_SERPENT_192 (libmcrypt 2.2.x únicamente) - MCRYPT_SERPENT_256 (libmcrypt 2.2.x únicamente) - MCRYPT_SKIPJACK (libmcrypt > 2.4.x únicamente) - MCRYPT_TEAN (libmcrypt 2.2.x únicamente) - MCRYPT_THREEWAY - MCRYPT_TRIPLEDES (libmcrypt > 2.4.x únicamente) - MCRYPT_TWOFISH (para las versiones antiguas de mcrypt 2.x o mcrypt > 2.4.x ) - MCRYPT_TWOFISH128 (TWOFISHxxx está disponible en las nuevas versiones 2.x, - pero no en las versiones 2.4.x) - MCRYPT_TWOFISH192 - MCRYPT_TWOFISH256 - MCRYPT_WAKE (libmcrypt > 2.4.x únicamente) - MCRYPT_XTEA (libmcrypt > 2.4.x únicamente) - - - - Se debe (modo CFB y OFB) - o puede (modo CBC) proporcionar un vector de inicialización - (IV) para estos modos de cifrado. IV debe ser único, y tener el mismo - valor en el cifrado y en el descifrado. Para datos que serán - almacenados después del cifrado, se puede tomar el resultado de una - función como MD5, aplicada al nombre del fichero. De lo contrario, - se puede enviar IV con los datos cifrados, (consulte el capítulo - 9.3 de &book.applied.cryptography; de Schneier (ISBN 0-471-11709-9) - para más detalles sobre el tema). - - - diff --git a/reference/mcrypt/configure.xml b/reference/mcrypt/configure.xml deleted file mode 100644 index 2b2bb78759..0000000000 --- a/reference/mcrypt/configure.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - - -
    - &reftitle.install; - - &pecl.moved-ver;7.2.0 - - - &pecl.info; - &url.pecl.package;mcrypt. - -
    - diff --git a/reference/mcrypt/constants.xml b/reference/mcrypt/constants.xml deleted file mode 100644 index 5e4f692d81..0000000000 --- a/reference/mcrypt/constants.xml +++ /dev/null @@ -1,164 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - Mcrypt puede operar en 4 modos de cifrado (CBC, - OFB, CFB y ECB). - Si está vinculado contra libmcrypt-2.4.x o posterior, las funciones pueden - operar asimismo en modo nOFB y en modo STREAM. - A continuación se encuentra una lista con todos los modos de cifrado soportados con - las constantes que están definidas para el modo de cifrado. Para una referencia - más completa y discusiones, ver &book.applied.cryptography;. - - - - MCRYPT_MODE_ECB (electronic codebook) - es un modo de cifrado por bloques que generalmente es inapropiado para la mayoría - de los usos. El uso de este modo está desaconsejado. - - - - - MCRYPT_MODE_CBC (cipher block chaining) - es un modo de cifrado por bloques que es considerablemente más seguro que - el modo ECB. - - - - - MCRYPT_MODE_CFB (cipher feedback, - en modo de 8 bits) es un modo de cifrado por flujo. - Se recomienda utilizar el modo NCFB en lugar - del modo CFB. - - - - - MCRYPT_MODE_OFB (output feedback, en - 8 bits) es un modo de cifrado por flujo comparable a - CFB, pero puede ser utilizado en aplicaciones donde la - propagación de errores no puede ser tolerada. - Se recomienda utilizar el modo NOFB en lugar - del modo OFB. - - - - - MCRYPT_MODE_NOFB (output feedback, - en modo de n bits) es comparable al modo OFB, - pero opera sobre el tamaño de bloque completo del algoritmo. - - - - - MCRYPT_MODE_STREAM es un modo adicional, para incluir - algoritmos de flujo tales como "WAKE" o "RC4". - - - - - - - Mcrypt soporta otros modos de operación para los cuales no hay constantes - predefinidas. - Pueden ser utilizados pasando un &string; en lugar de las constantes faltantes. - - - - "ctr" (counter mode) es un modo de cifrado por flujo. - - - - - "ncfb" (cipher feedback, - en modo de n bits) es comparable al modo CFB, - pero opera sobre el tamaño de bloque completo del algoritmo. - - - - - - - A continuación se presentan algunos otros modos y métodos de compresión: - - - - MCRYPT_ENCRYPT - (int) - - - - - - - - - - MCRYPT_DECRYPT - (int) - - - - - - - - - - MCRYPT_DEV_RANDOM - (int) - - - - - - - - - - MCRYPT_DEV_URANDOM - (int) - - - - - - - - - - MCRYPT_RAND - (int) - - - - - - - - - - - - diff --git a/reference/mcrypt/functions/mcrypt-create-iv.xml b/reference/mcrypt/functions/mcrypt-create-iv.xml deleted file mode 100644 index 45eb0471ca..0000000000 --- a/reference/mcrypt/functions/mcrypt-create-iv.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - - mcrypt_create_iv - Crea un vector de inicialización (IV) a partir de una fuente aleatoria - - - - - &warn.deprecated.function.7-1-0.removed.7-2-0.alternatives; - - random_bytes - - - - - - &reftitle.description; - - stringmcrypt_create_iv - intsize - intsourceMCRYPT_DEV_URANDOM - - - mcrypt_create_iv crea un IV - (vector de inicialización) a partir de una fuente aleatoria. - - - El vector de inicialización es el único medio de proporcionar una inicialización - de reemplazo a los métodos de inicialización. Este vector no necesita - ser particularmente secreto, aunque es mejor que lo sea. Puede enviarse - con los documentos cifrados sin perder seguridad. - - - - - &reftitle.parameters; - - - size - - - El tamaño del vector. - - - - - source - - - La fuente de un IV. La fuente puede ser MCRYPT_RAND (el generador - de números aleatorios del sistema), MCRYPT_DEV_RANDOM - (lee los datos desde /dev/random) y - MCRYPT_DEV_URANDOM (lee los datos desde - /dev/urandom). Antes de la versión 5.3.0, - MCRYPT_RAND era la única constante - soportada por Windows. - - - Tenga en cuenta que el valor por defecto de este parámetro era - MCRYPT_DEV_RANDOM antes de PHP 5.6.0. - - - - Tenga en cuenta que la constante MCRYPT_DEV_RANDOM - puede bloquearse mientras espera que haya más entropía disponible. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el vector de inicialización, o bien &false; en caso de error. - - - - - &reftitle.examples; - - Ejemplo con <function>mcrypt_create_iv</function> - - -]]> - - - - - - &reftitle.seealso; - - &url.mcrypt.iv; - &url.mcrypt.bcm; - Capítulo 9.3 de &book.applied.cryptography; - random_bytes - - - - diff --git a/reference/mcrypt/functions/mcrypt-decrypt.xml b/reference/mcrypt/functions/mcrypt-decrypt.xml deleted file mode 100644 index b6d72368de..0000000000 --- a/reference/mcrypt/functions/mcrypt-decrypt.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - mcrypt_decrypt - Descifra un texto con los parámetros dados - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - stringfalsemcrypt_decrypt - stringcipher - stringkey - stringdata - stringmode - stringiv - - - Descifra los datos data y devuelve los datos descifrados. - - - - &reftitle.parameters; - - - cipher - - &mcrypt.parameter.cipher; - - - - key - - - La clave utilizada durante el cifrado de los datos. Si el tamaño de la clave - proporcionada no es soportado por el cipher, la función emitirá una - advertencia y devolverá &false; - - - - - data - - - Los datos que serán descifrados utilizando los parámetros - cipher y mode. - Si el tamaño de los datos no corresponde a n * el tamaño del bloque, - los datos serán completados con '\0'. - - - - - mode - - &mcrypt.parameter.mode; - - - - iv - - &mcrypt.parameter.iv.strict; - - - - - - - &reftitle.returnvalues; - - Devuelve los datos descifrados en forma de &string; - &return.falseforfailure;. - - - - - &reftitle.seealso; - - mcrypt_encrypt - - - - diff --git a/reference/mcrypt/functions/mcrypt-enc-get-algorithms-name.xml b/reference/mcrypt/functions/mcrypt-enc-get-algorithms-name.xml deleted file mode 100644 index 1d5be7c236..0000000000 --- a/reference/mcrypt/functions/mcrypt-enc-get-algorithms-name.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - mcrypt_enc_get_algorithms_name - Devuelve el nombre del algoritmo de cifrado - - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - stringmcrypt_enc_get_algorithms_name - resourcetd - - - mcrypt_enc_get_algorithms_name devuelve el nombre de - el algoritmo utilizado por td. - - - - - &reftitle.parameters; - - - td - - - El recurso de cifrado. - - - - - - - - &reftitle.returnvalues; - - Devuelve el nombre del algoritmo actual, en forma de &string; - - - - - &reftitle.examples; - - Ejemplo con <function>mcrypt_enc_get_algorithms_name</function> - - -]]> - - &example.outputs; - - - - - - - diff --git a/reference/mcrypt/functions/mcrypt-enc-get-block-size.xml b/reference/mcrypt/functions/mcrypt-enc-get-block-size.xml deleted file mode 100644 index a8c0588740..0000000000 --- a/reference/mcrypt/functions/mcrypt-enc-get-block-size.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - mcrypt_enc_get_block_size - Devuelve el tamaño de bloque de un algoritmo - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - intmcrypt_enc_get_block_size - resourcetd - - - Obtiene el tamaño de bloque de un algoritmo. - - - - &reftitle.parameters; - - - td - - - El gestor de ficheros. - - - - - - - &reftitle.returnvalues; - - Devuelve el tamaño de bloque del algoritmo, en bytes. - - - - diff --git a/reference/mcrypt/functions/mcrypt-enc-get-iv-size.xml b/reference/mcrypt/functions/mcrypt-enc-get-iv-size.xml deleted file mode 100644 index 6a67104755..0000000000 --- a/reference/mcrypt/functions/mcrypt-enc-get-iv-size.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - mcrypt_enc_get_iv_size - Devuelve el tamaño del VI de un algoritmo - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - intmcrypt_enc_get_iv_size - resourcetd - - - Esta función devuelve el tamaño del VI del algoritmo designado - por td, en bytes. Si el valor devuelto - es 0, es que el algoritmo no requiere de VI. Un VI es - requerido en modo "cbc", "cfb" y - "ofb", y a veces en modo "stream". - - - - &reftitle.parameters; - - - td - - - El gestor de ficheros. - - - - - - - &reftitle.returnvalues; - - Devuelve el tamaño del IV, o 0 si el IV es ignorado por el algoritmo. - - - - diff --git a/reference/mcrypt/functions/mcrypt-enc-get-key-size.xml b/reference/mcrypt/functions/mcrypt-enc-get-key-size.xml deleted file mode 100644 index 52a11ad5e6..0000000000 --- a/reference/mcrypt/functions/mcrypt-enc-get-key-size.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - mcrypt_enc_get_key_size - Devuelve el tamaño máximo de la clave para un modo - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - intmcrypt_enc_get_key_size - resourcetd - - - Devuelve el tamaño máximo de la clave para un modo dado. - - - - &reftitle.parameters; - - - td - - - El gestor de fichero. - - - - - - - &reftitle.returnvalues; - - Devuelve el tamaño máximo de la clave para el modo dado. - - - - diff --git a/reference/mcrypt/functions/mcrypt-enc-get-modes-name.xml b/reference/mcrypt/functions/mcrypt-enc-get-modes-name.xml deleted file mode 100644 index 3bf63b47aa..0000000000 --- a/reference/mcrypt/functions/mcrypt-enc-get-modes-name.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - mcrypt_enc_get_modes_name - Devuelve el nombre del modo - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - stringmcrypt_enc_get_modes_name - resourcetd - - - Devuelve el nombre del modo. - - - - &reftitle.parameters; - - - td - - - El recurso de cifrado. - - - - - - - &reftitle.returnvalues; - - Devuelve el nombre, en forma de &string;. - - - - &reftitle.examples; - - Ejemplo con <function>mcrypt_enc_get_modes_name</function> - - -]]> - - &example.outputs; - - - - - - - diff --git a/reference/mcrypt/functions/mcrypt-enc-get-supported-key-sizes.xml b/reference/mcrypt/functions/mcrypt-enc-get-supported-key-sizes.xml deleted file mode 100644 index ff1f4db4cf..0000000000 --- a/reference/mcrypt/functions/mcrypt-enc-get-supported-key-sizes.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - mcrypt_enc_get_supported_key_sizes - Devuelve un array que contiene los tamaños de clave admitidos por un algoritmo - - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - arraymcrypt_enc_get_supported_key_sizes - resourcetd - - - mcrypt_enc_get_supported_key_sizes lee - los tamaños de clave soportados por el algoritmo actual del - recurso de cifrado td. - - - - - &reftitle.parameters; - - - td - - - El recurso de cifrado. - - - - - - - - &reftitle.returnvalues; - - Devuelve un array que contiene los tamaños de clave soportados por el algoritmo - designado por td. Si devuelve un array - vacío, es que todas las claves entre 1 y - mcrypt_enc_get_key_size son admitidas por - el algoritmo. - - - - - &reftitle.examples; - - Ejemplo con <function>mcrypt_enc_get_supported_key_sizes</function> - - -]]> - - &example.outputs; - - - int(16) - [1]=> - int(24) - [2]=> - int(32) -} -]]> - - - - - diff --git a/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm-mode.xml b/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm-mode.xml deleted file mode 100644 index c12c7a11b9..0000000000 --- a/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm-mode.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - mcrypt_enc_is_block_algorithm_mode - Comprueba si el modo de cifrado es por bloques - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - boolmcrypt_enc_is_block_algorithm_mode - resourcetd - - - Comprueba si el modo de cifrado es por bloques (por ejemplo, - &false; para un flujo, y &true; para "cbc", "cfb", "ofb"). - - - - &reftitle.parameters; - - - td - - - El recurso de cifrado. - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si este modo utiliza algoritmos por bloques, y &false; en caso contrario. - - - - diff --git a/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm.xml b/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm.xml deleted file mode 100644 index 78513ce603..0000000000 --- a/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - mcrypt_enc_is_block_algorithm - Comprueba si el cifrado es por bloques en un algoritmo - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - boolmcrypt_enc_is_block_algorithm - resourcetd - - - Comprueba si el cifrado es por bloques en un algoritmo. - - - - &reftitle.parameters; - - - td - - - El recurso de cifrado. - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si el algoritmo utilizado es un algoritmo por bloques, y &false; - si es un algoritmo por flujo. - - - - diff --git a/reference/mcrypt/functions/mcrypt-enc-is-block-mode.xml b/reference/mcrypt/functions/mcrypt-enc-is-block-mode.xml deleted file mode 100644 index ed850bcd95..0000000000 --- a/reference/mcrypt/functions/mcrypt-enc-is-block-mode.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - mcrypt_enc_is_block_mode - Comprueba si el modo devuelve los datos por bloques - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - boolmcrypt_enc_is_block_mode - resourcetd - - - Comprueba si el modo devuelve los datos por bloques (por ejemplo, &true; para "cbc" - y "ecb", y &false; para "cfb" y un flujo). - - - - &reftitle.parameters; - - - td - - - El recurso de cifrado. - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si el modo devuelve bloques de bytes, - o bien &false; si solo devuelve bytes. - - - - diff --git a/reference/mcrypt/functions/mcrypt-enc-self-test.xml b/reference/mcrypt/functions/mcrypt-enc-self-test.xml deleted file mode 100644 index c9e800b9e8..0000000000 --- a/reference/mcrypt/functions/mcrypt-enc-self-test.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - mcrypt_enc_self_test - Prueba un módulo abierto - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - intmcrypt_enc_self_test - resourcetd - - - Realiza una prueba del módulo abierto y designado por td. - - - - &reftitle.parameters; - - - td - - - El recurso de cifrado. - - - - - - - &reftitle.returnvalues; - - Devuelve 0 en caso de éxito o un &integer; negativo en - caso de fallo. - - - - diff --git a/reference/mcrypt/functions/mcrypt-encrypt.xml b/reference/mcrypt/functions/mcrypt-encrypt.xml deleted file mode 100644 index 1633ea595d..0000000000 --- a/reference/mcrypt/functions/mcrypt-encrypt.xml +++ /dev/null @@ -1,190 +0,0 @@ - - - - - - - mcrypt_encrypt - Cifra un texto - - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - stringfalsemcrypt_encrypt - stringcipher - stringkey - stringdata - stringmode - stringiv - - - mcrypt_encrypt cifra los datos y devuelve - los datos cifrados. - - - - - &reftitle.parameters; - - - cipher - - &mcrypt.parameter.cipher; - - - - key - - - La clave con la que se cifrarán los datos. Si el tamaño de la clave - proporcionada no es compatible con el cipher, la función emitirá una - advertencia y devolverá &false; - - - - - data - - - Los datos que se cifrarán, con el cipher y el - mode indicado. - Si el tamaño de los datos no es un múltiplo del tamaño de bloque, - los datos se rellenarán con caracteres '\0', - según sea necesario. - - - El texto cifrado devuelto puede ser más largo que el tamaño de los datos - pasados como argumento a través de data. - - - - - mode - - &mcrypt.parameter.mode; - - - - iv - - &mcrypt.parameter.iv.strict; - - - - - - - &reftitle.returnvalues; - - Devuelve los datos cifrados, como &string; &return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo con <function>mcrypt_encrypt</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - mcrypt_decrypt - mcrypt_module_open - - - - diff --git a/reference/mcrypt/functions/mcrypt-generic-deinit.xml b/reference/mcrypt/functions/mcrypt-generic-deinit.xml deleted file mode 100644 index edbf7914d7..0000000000 --- a/reference/mcrypt/functions/mcrypt-generic-deinit.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - mcrypt_generic_deinit - Prepara el módulo para la descarga - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - boolmcrypt_generic_deinit - resourcetd - - - Prepara el módulo de cifrado td para la descarga. - Todos los búferes se vacían, pero el módulo no se descarga. - Se debe llamar a mcrypt_module_close manualmente - (aunque PHP lo hará por usted al final del script). - - - - - &reftitle.parameters; - - - td - - - El recurso de cifrado. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - mcrypt_module_open - mcrypt_generic_init - - - - diff --git a/reference/mcrypt/functions/mcrypt-generic-init.xml b/reference/mcrypt/functions/mcrypt-generic-init.xml deleted file mode 100644 index ea4ff8d9f9..0000000000 --- a/reference/mcrypt/functions/mcrypt-generic-init.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - mcrypt_generic_init - Inicializa todos los buffers necesarios - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - intmcrypt_generic_init - resourcetd - stringkey - stringiv - - - Se debe llamar a mcrypt_generic_init - antes de cada llamada a mcrypt_generic o - mdecrypt_generic. - - - - &reftitle.parameters; - - - td - - - El recurso de cifrado. - - - - - key - - - El tamaño máximo de la clave debe ser el devuelto por - mcrypt_enc_get_key_size y todos los valores - inferiores también serán válidos. - - - - - iv - - - El vector de inicialización (VI) debe tener el tamaño de un bloque, - pero se debe leer su tamaño llamando a - mcrypt_enc_get_iv_size. VI es ignorado en modo - ECB. VI DEBE existir en modos "CFB", - "CBC", "STREAM", "nOFB" - y "OFB". Debe ser aleatorio y único (pero no secreto). - El mismo VI debe ser utilizado para el cifrado y el descifrado. - Si no se desea utilizar, se puede rellenar con ceros, pero - no se recomienda. - - - - - - - &reftitle.returnvalues; - - Devuelve un valor negativo en caso de error: -3 si el tamaño - de la clave es incorrecto, -4 cuando hay un problema de asignación de - memoria y cualquier otro valor en caso de error desconocido. Si ocurre un - error, se muestra una alerta. &false; es devuelto si se pasan parámetros - incorrectos a la función. - - - - &reftitle.seealso; - - mcrypt_module_open - - - - diff --git a/reference/mcrypt/functions/mcrypt-generic.xml b/reference/mcrypt/functions/mcrypt-generic.xml deleted file mode 100644 index c97de8bb06..0000000000 --- a/reference/mcrypt/functions/mcrypt-generic.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - mcrypt_generic - Cifra los datos - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - stringmcrypt_generic - resourcetd - stringdata - - - mcrypt_generic cifra los datos - data. Los datos se completan - con "\0" para obtener un tamaño múltiplo del tamaño - de un bloque. Devuelve los datos cifrados. Tenga en cuenta que la longitud - del string devuelto puede ser más larga que la - pasada como argumento, debido al relleno. - - - Si se desea almacenar los datos cifrados en una base de datos - asegúrese de almacenar el string completo devuelto por esta función, - de lo contrario el string no se descifrará correctamente. Si el string original - contiene 10 caracteres y el tamaño de un bloque es de 8 (utilice - mcrypt_enc_get_block_size para determinar este tamaño), - se necesitará al menos 16 caracteres en el campo de la base de datos. - Tenga en cuenta que el string devuelto por mdecrypt_generic tendrá - 16 caracteres de longitud... utilice rtrim($str, "\0") - para eliminar el relleno. - - - Por ejemplo, si se almacenan los datos en una base de datos MySQL, - recuerde que los campos de tipo VARCHAR eliminan automáticamente los - espacios adicionales durante la inserción. Como los datos cifrados pueden - terminar con un espacio (ASCII 32), los datos se dañarán por esta - eliminación. Almacene los datos en un campo de tipo TINYBLOB/TINYTEXT - (o más grande) para que todo funcione normalmente. - - - - - &reftitle.parameters; - - - td - - - El recurso de cifrado. - - - El manejador de cifrado td debe ser - inicializado con la función mcrypt_generic_init, - con una clave y un VI, antes de llamar a esta función. Cuando el cifrado - se realiza, se deben liberar los buffers llamando a la función - mcrypt_generic_deinit. - Consulte mcrypt_module_open para un ejemplo. - - - - - data - - - Los datos a cifrar. - - - - - - - - &reftitle.returnvalues; - - Devuelve los datos cifrados. - - - - - &reftitle.seealso; - - mdecrypt_generic - mcrypt_generic_init - mcrypt_generic_deinit - - - - - diff --git a/reference/mcrypt/functions/mcrypt-get-block-size.xml b/reference/mcrypt/functions/mcrypt-get-block-size.xml deleted file mode 100644 index 2dce8b3cfc..0000000000 --- a/reference/mcrypt/functions/mcrypt-get-block-size.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - mcrypt_get_block_size - Devuelve el tamaño de bloques de un cifrado - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - intfalsemcrypt_get_block_size - intcipher - - - intfalsemcrypt_get_block_size - stringcipher - stringmode - - - El primer prototipo se utiliza cuando PHP está compilado con la biblioteca - libmcrypt 2.2.x, el segundo cuando está compilado con - libmcrypt 2.4.x o 2.5.x. - - - mcrypt_get_block_size sirve para leer el tamaño - de bloques del cifrado cipher (en - combinación con un modo de cifrado). - - - Se recomienda utilizar la función - mcrypt_enc_get_block_size, - ya que utiliza el recurso devuelto por - mcrypt_module_open. - - - - - &reftitle.parameters; - - - cipher - - &mcrypt.parameter.cipher; - - - - mode - - &mcrypt.parameter.mode; - - - - - - - &reftitle.returnvalues; - - Lee el tamaño de bloque, en forma de un &integer;. - - - - - &reftitle.examples; - - Ejemplo con <function>mcrypt_get_block_size</function> - - Este ejemplo muestra cómo utilizar esta función cuando PHP - está compilado con libmcrypt 2.4.x y 2.5.x. - - - -]]> - - - - - - &reftitle.seealso; - - mcrypt_get_key_size - mcrypt_enc_get_block_size - mcrypt_encrypt - - - - diff --git a/reference/mcrypt/functions/mcrypt-get-cipher-name.xml b/reference/mcrypt/functions/mcrypt-get-cipher-name.xml deleted file mode 100644 index 9f446257c7..0000000000 --- a/reference/mcrypt/functions/mcrypt-get-cipher-name.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - mcrypt_get_cipher_name - Lee el nombre del cifrado utilizado - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - stringmcrypt_get_cipher_name - intcipher - - - stringmcrypt_get_cipher_name - stringcipher - - - mcrypt_get_cipher_name devuelve el nombre del cifrado - utilizado. - - - mcrypt_get_cipher_name toma el número de - cifrado (con libmcrypt 2.2.x) o toma el nombre del cifrado - (con libmcrypt 2.4.x) como argumento, y devuelve el nombre del - cifrado, o &false;, si no existe. - - - - - &reftitle.parameters; - - - cipher - - &mcrypt.parameter.cipher; - - - - - - - &reftitle.returnvalues; - - Esta función devuelve el nombre del cipher o &false; si el cipher no existe. - - - - - &reftitle.examples; - - Ejemplo con <function>mcrypt_get_cipher_name</function> - - -]]> - - &example.outputs; - - - - - - - diff --git a/reference/mcrypt/functions/mcrypt-get-iv-size.xml b/reference/mcrypt/functions/mcrypt-get-iv-size.xml deleted file mode 100644 index 29c3f3cccb..0000000000 --- a/reference/mcrypt/functions/mcrypt-get-iv-size.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - mcrypt_get_iv_size - Retorna el tamaño del VI utilizado por un par cifrado/modo - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - intmcrypt_get_iv_size - stringcipher - stringmode - - - mcrypt_get_iv_size retorna el tamaño del - vector de inicialización (VI). Si el algoritmo no utiliza - un vector de inicialización, se retorna cero. - - - Es más útil utilizar la función mcrypt_enc_get_iv_size, - ya que utiliza el recurso retornado por mcrypt_module_open. - - - - - &reftitle.parameters; - - - cipher - - &mcrypt.parameter.cipher; - - - - mode - - &mcrypt.parameter.mode; - - El VI es ignorado en modo ECB, ya que este modo no lo requiere. - Debe tener el mismo VI (punto de partida) durante el cifrado - y el descifrado, de lo contrario, el cifrado fallará. - - - - - - - - &reftitle.returnvalues; - - Retorna el tamaño del vector de inicialización (VI), en bytes. - En caso de error, la función retorna &false;. Si el vector de inicialización - no es necesario, se retorna 0. - - - - - &reftitle.examples; - - Ejemplo con <function>mcrypt_get_iv_size</function> - - -]]> - - - - - - &reftitle.seealso; - - mcrypt_get_block_size - mcrypt_enc_get_iv_size - mcrypt_create_iv - - - - - diff --git a/reference/mcrypt/functions/mcrypt-get-key-size.xml b/reference/mcrypt/functions/mcrypt-get-key-size.xml deleted file mode 100644 index 3b31c3da9d..0000000000 --- a/reference/mcrypt/functions/mcrypt-get-key-size.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - mcrypt_get_key_size - Devuelve el tamaño de la clave de cifrado - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - intfalsemcrypt_get_key_size - intcipher - - - intfalsemcrypt_get_key_size - stringcipher - stringmode - - - La primera sintaxis utiliza libmcrypt 2.2.x, y la segunda - libmcrypt 2.4.x o posterior. - - - mcrypt_get_key_size se utiliza para obtener el tamaño de - la clave del cifrado cipher. - - - Es más interesante utilizar la función - mcrypt_enc_get_key_size ya que utiliza el recurso - devuelto por la función mcrypt_module_open. - - - - - &reftitle.parameters; - - - cipher - - &mcrypt.parameter.cipher; - - - - mode - - &mcrypt.parameter.mode; - - - - - - - &reftitle.returnvalues; - - Devuelve el tamaño máximo soportado para una clave del algoritmo, en bytes - &return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo con <function>mcrypt_get_key_size</function> - - -]]> - - - El ejemplo anterior muestra el uso de la función - cuando ha sido compilada con la biblioteca - 2.4.x o 2.5.x. - - &example.outputs; - - - - - - - - &reftitle.seealso; - - mcrypt_get_block_size - mcrypt_enc_get_key_size - mcrypt_encrypt - - - - - diff --git a/reference/mcrypt/functions/mcrypt-list-algorithms.xml b/reference/mcrypt/functions/mcrypt-list-algorithms.xml deleted file mode 100644 index d204948f04..0000000000 --- a/reference/mcrypt/functions/mcrypt-list-algorithms.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - mcrypt_list_algorithms - Lista todos los algoritmos de cifrado soportados - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - arraymcrypt_list_algorithms - stringlib_dirini_get("mcrypt.algorithms_dir") - - - Lista todos los algoritmos de cifrado de lib_dir. - - - - - &reftitle.parameters; - - - lib_dir - - - Especifica el directorio donde se encuentran los algoritmos. Si se omite, - se utiliza el valor de la directiva mcrypt.algorithms_dir del fichero - &php.ini;. - - - - - - - - &reftitle.returnvalues; - - Devuelve un array con los algoritmos soportados. - - - - - &reftitle.examples; - - Ejemplo con <function>mcrypt_list_algorithms</function> - - -]]> - - &example.outputs.similar; - - cast-128 - [1] => gost - [2] => rijndael-128 - [3] => twofish - [4] => arcfour - [5] => cast-256 - [6] => loki97 - [7] => rijndael-192 - [8] => saferplus - [9] => wake - [10] => blowfish-compat - [11] => des - [12] => rijndael-256 - [13] => serpent - [14] => xtea - [15] => blowfish - [16] => enigma - [17] => rc2 - [18] => tripledes -) -]]> - - - - - diff --git a/reference/mcrypt/functions/mcrypt-list-modes.xml b/reference/mcrypt/functions/mcrypt-list-modes.xml deleted file mode 100644 index a0908d1c27..0000000000 --- a/reference/mcrypt/functions/mcrypt-list-modes.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - mcrypt_list_modes - Lista todos los modos de cifrado soportados - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - arraymcrypt_list_modes - stringlib_dirini_get("mcrypt.modes_dir") - - - Lista todos los modos de cifrado de lib_dir. - - - - - &reftitle.parameters; - - - lib_dir - - - Especifica el directorio donde se encuentran todos los modos. - Si se omite, se utiliza el valor de la directiva mcrypt.modes_dir - en el &php.ini;. - - - - - - - - &reftitle.returnvalues; - - Devuelve un array con todos los modos soportados. - - - - - &reftitle.examples; - - Ejemplo con <function>mcrypt_list_modes</function> - -\n"; -} -?> -]]> - - - El ejemplo anterior mostrará todos los modos soportados - en el directorio por omisión. Si el modo no está definido - por la directiva mcrypt.modes_dir del &php.ini;, - se utilizará el directorio por omisión de mcrypt (el directorio - /usr/local/lib/libmcrypt). - - - - - diff --git a/reference/mcrypt/functions/mcrypt-module-close.xml b/reference/mcrypt/functions/mcrypt-module-close.xml deleted file mode 100644 index 30e858bd55..0000000000 --- a/reference/mcrypt/functions/mcrypt-module-close.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - mcrypt_module_close - Libera el módulo de cifrado - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - boolmcrypt_module_close - resourcetd - - - Libera el módulo td. - - - - &reftitle.parameters; - - - td - - - El recurso de cifrado. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - mcrypt_module_open - - - - diff --git a/reference/mcrypt/functions/mcrypt-module-get-algo-block-size.xml b/reference/mcrypt/functions/mcrypt-module-get-algo-block-size.xml deleted file mode 100644 index 4c1275f211..0000000000 --- a/reference/mcrypt/functions/mcrypt-module-get-algo-block-size.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - mcrypt_module_get_algo_block_size - Devuelve el tamaño de bloques de un algoritmo - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - intmcrypt_module_get_algo_block_size - stringalgorithm - stringlib_dir - - - Devuelve el tamaño de bloques de un algoritmo. - - - - &reftitle.parameters; - - - algorithm - - - El nombre del algoritmo. - - - - - lib_dir - - - El parámetro opcional lib_dir contiene la - ruta de acceso hasta el módulo del algoritmo en el sistema. - - - - - - - &reftitle.returnvalues; - - Devuelve el tamaño de bloques de un algoritmo, en bytes. - - - - diff --git a/reference/mcrypt/functions/mcrypt-module-get-algo-key-size.xml b/reference/mcrypt/functions/mcrypt-module-get-algo-key-size.xml deleted file mode 100644 index e6be7fee11..0000000000 --- a/reference/mcrypt/functions/mcrypt-module-get-algo-key-size.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - mcrypt_module_get_algo_key_size - Devuelve el tamaño máximo de clave - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - &reftitle.description; - - intmcrypt_module_get_algo_key_size - stringalgorithm - stringlib_dir - - - Devuelve el tamaño máximo de clave. - - - - &reftitle.parameters; - - - algorithm - - - El nombre del algoritmo. - - - - - lib_dir - - - El parámetro opcional lib_dir contiene la ruta - hasta el módulo del algoritmo en el sistema. - - - - - - - &reftitle.returnvalues; - - Devuelve el tamaño máximo de la clave soportada por el algoritmo - algorithm. - - - - diff --git a/reference/mcrypt/functions/mcrypt-module-get-supported-key-sizes.xml b/reference/mcrypt/functions/mcrypt-module-get-supported-key-sizes.xml deleted file mode 100644 index ca6b53c8a1..0000000000 --- a/reference/mcrypt/functions/mcrypt-module-get-supported-key-sizes.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - - mcrypt_module_get_supported_key_sizes - Devuelve un array que contiene los tamaños de claves soportados por el algoritmo abierto - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - arraymcrypt_module_get_supported_key_sizes - stringalgorithm - stringlib_dir - - - Devuelve un array que contiene los tamaños de claves soportados por - el algoritmo de cifrado algorithm. - Si devuelve un array vacío, entonces todas las claves entre - 1 y mcrypt_module_get_algo_key_size son - soportadas por el algoritmo. - - - - &reftitle.parameters; - - - algorithm - - - El algoritmo a utilizar. - - - - - lib_dir - - - El parámetro opcional - lib_dir puede contener la ruta de acceso - del directorio de instalación del módulo, en el sistema. - - - - - - - - &reftitle.returnvalues; - - Devuelve un array que contiene los tamaños de claves soportados por - el algoritmo de cifrado algorithm. - Si devuelve un array vacío, entonces todas las claves entre - 1 y mcrypt_module_get_algo_key_size son - soportadas por el algoritmo. - - - - - &reftitle.seealso; - - mcrypt_enc_get_supported_key_sizes - - - - diff --git a/reference/mcrypt/functions/mcrypt-module-is-block-algorithm-mode.xml b/reference/mcrypt/functions/mcrypt-module-is-block-algorithm-mode.xml deleted file mode 100644 index 23e8fef583..0000000000 --- a/reference/mcrypt/functions/mcrypt-module-is-block-algorithm-mode.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - mcrypt_module_is_block_algorithm_mode - Indica si un modo funciona por bloques - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - boolmcrypt_module_is_block_algorithm_mode - stringmode - stringlib_dir - - - Esta función devuelve &true; si el modo debe ser utilizado - con un algoritmo por bloques, de lo contrario, devuelve &false; - (i.e. &false; para un flujo, y &true; para cbc, cfb, ofb). - - - - &reftitle.parameters; - - - mode - - - El modo a verificar. - - - - - lib_dir - - - El argumento opcional lib_dir - puede contener el directorio donde los módulos de algoritmo - se encuentran en el sistema. - - - - - - - - &reftitle.returnvalues; - - Esta función devuelve &true; si el modo debe ser utilizado - con un algoritmo por bloques, de lo contrario, devuelve &false; - (i.e. &false; para un flujo, y &true; para cbc, cfb, ofb). - - - - diff --git a/reference/mcrypt/functions/mcrypt-module-is-block-algorithm.xml b/reference/mcrypt/functions/mcrypt-module-is-block-algorithm.xml deleted file mode 100644 index f49386c17b..0000000000 --- a/reference/mcrypt/functions/mcrypt-module-is-block-algorithm.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - mcrypt_module_is_block_algorithm - Indica si un algoritmo funciona por bloques - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - boolmcrypt_module_is_block_algorithm - stringalgorithm - stringlib_dir - - - Esta función devuelve &true; si algorithm es un algoritmo por bloques, - o &false; si es un algoritmo por flujo. - - - - - &reftitle.parameters; - - - algorithm - - - El algoritmo a verificar. - - - - - lib_dir - - - El parámetro opcional lib_dir - puede contener la ruta donde se encuentran los módulos de los algoritmos - en el disco del sistema. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si el algoritmo especificado es un algoritmo por bloques - o &false; si es un algoritmo por flujo. - - - - - diff --git a/reference/mcrypt/functions/mcrypt-module-is-block-mode.xml b/reference/mcrypt/functions/mcrypt-module-is-block-mode.xml deleted file mode 100644 index 119066f5e1..0000000000 --- a/reference/mcrypt/functions/mcrypt-module-is-block-mode.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - mcrypt_module_is_block_mode - Indica si un modo trabaja por bloques - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - boolmcrypt_module_is_block_mode - stringmode - stringlib_dir - - - Esta función devuelve &true; si este modo proporciona bloques de bytes o - &false; si solo produce bytes. - (i.e. &true; para "cbc" y "ecb", - y &false; para "cfb" y "stream"). - - - - - &reftitle.parameters; - - - mode - - &mcrypt.parameter.mode; - - - - lib_dir - - - El parámetro opcional lib_dir contiene - la ruta de acceso hasta el módulo del algoritmo en el sistema. - - - - - - - - &reftitle.returnvalues; - - Esta función devuelve &true; si este modo proporciona bloques de bytes o - &false; si solo produce bytes. - (i.e. &true; para "cbc" y "ecb", - y &false; para "cfb" y "stream"). - - - - - diff --git a/reference/mcrypt/functions/mcrypt-module-open.xml b/reference/mcrypt/functions/mcrypt-module-open.xml deleted file mode 100644 index 7c4a9d50bd..0000000000 --- a/reference/mcrypt/functions/mcrypt-module-open.xml +++ /dev/null @@ -1,180 +0,0 @@ - - - - - - - mcrypt_module_open - Abre el módulo del algoritmo y del modo a utilizar - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - resourcemcrypt_module_open - stringalgorithm - stringalgorithm_directory - stringmode - stringmode_directory - - - mcrypt_module_open abre el módulo del algoritmo - y del modo a utilizar. El nombre del algoritmo se especifica mediante el parámetro - algorithm (por ejemplo: "twofish"), - o bien una de las constantes MCRYPT_ciphername. La biblioteca se cierra - al llamar a mcrypt_module_close. - - - - - &reftitle.parameters; - - - algorithm - - &mcrypt.parameter.cipher; - - - - algorithm_directory - - - El parámetro algorithm_directory se utiliza - para localizar el módulo de cifrado. Cuando se especifica un - nombre de directorio, se utilizará. Si se especifica una cadena vacía - (""), se utilizará el valor definido en la directiva - mcrypt.algorithms_dir del fichero &php.ini;. Cuando no está definida, el directorio por omisión utilizado - será aquel en el que se encuentre la biblioteca libmcrypt - (habitualmente, /usr/local/lib/libmcrypt). - - - - - mode - - &mcrypt.parameter.mode; - - - - mode_directory - - - El parámetro mode_directory se utiliza para localizar - el módulo de cifrado. Si se especifica un nombre de directorio, se utilizará. - Cuando se especifica una cadena vacía (""), se utilizará el valor - de la directiva mcrypt.modes_dir del fichero &php.ini;. - Si no está definida, el directorio por omisión utilizado - será aquel en el que se encuentre la biblioteca libmcrypt - (habitualmente /usr/local/lib/libmcrypt). - - - - - - - - &reftitle.returnvalues; - - Normalmente, esta función devuelve un descriptor de cifrado, o - &false; si ocurre un error. - - - - - &reftitle.examples; - - Ejemplo con <function>mcrypt_module_open</function> - - -]]> - - - - La primera línea del ejemplo anterior intentará abrir el cifrado - DES, en el directorio por omisión, y el modo ECB en el directorio - /usr/lib/mcrypt-modes. El segundo ejemplo utiliza - las cadenas como nombre para el cifrado y el modo. Esto solo funciona - si la extensión está compilada con libmcrypt 2.4.x o 2.5.x. - - - Utilización de <function>mcrypt_module_open</function> para cifrar - - -]]> - - - - - - &reftitle.seealso; - - mcrypt_module_close - mcrypt_generic - mdecrypt_generic - mcrypt_generic_init - mcrypt_generic_deinit - - - - diff --git a/reference/mcrypt/functions/mcrypt-module-self-test.xml b/reference/mcrypt/functions/mcrypt-module-self-test.xml deleted file mode 100644 index c6309a9d13..0000000000 --- a/reference/mcrypt/functions/mcrypt-module-self-test.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - mcrypt_module_self_test - Prueba un modo - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - boolmcrypt_module_self_test - stringalgorithm - stringlib_dir - - - Realiza una prueba sobre el algoritmo especificado. - - - - - &reftitle.parameters; - - - algorithm - - &mcrypt.parameter.cipher; - - - - lib_dir - - - El argumento opcional lib_dir contiene - la ruta de acceso hasta el módulo del algoritmo en el sistema. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si la prueba funciona, y &false; en caso contrario. - - - - - &reftitle.examples; - - Ejemplo con <function>mcrypt_module_self_test</function> - - -]]> - - &example.outputs; - - - - - - - diff --git a/reference/mcrypt/functions/mdecrypt-generic.xml b/reference/mcrypt/functions/mdecrypt-generic.xml deleted file mode 100644 index 5d2f7a9b24..0000000000 --- a/reference/mcrypt/functions/mdecrypt-generic.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - - mdecrypt_generic - Desencripta los datos - - - &warn.deprecated.function-7-1-0.removed-7-2-0; - - - - &reftitle.description; - - stringmdecrypt_generic - resourcetd - stringdata - - - Desencripta los datos data. Tenga en cuenta que la longitud - del string desencriptado puede ser más larga que el string original, ya que - puede haber sido completado con caracteres. - - - - - &reftitle.parameters; - - - td - - - Un descriptor de cifrado, devuelto por la función - mcrypt_module_open - - - - - data - - - Los datos cifrados. - - - - - - - - &reftitle.returnvalues; - - Devuelve el string desencriptado. - - - - - &reftitle.examples; - - Ejemplo con <function>mdecrypt_generic</function> - - -]]> - - - - El ejemplo anterior muestra cómo verificar que los datos antes - del cifrado son los mismos que después del - cifrado/descifrado. Es muy importante reiniciar - el buffer de cifrado con mcrypt_generic_init - antes de descifrar los datos. - - - El gestor de descifrado debe ser siempre inicializado - por la función mcrypt_generic_init con una clave - y un VI antes de llamar a esta función. Cuando el cifrado está hecho, - es necesario liberar los datos cifrados llamando - a mcrypt_generic_deinit. - Consulte mcrypt_module_open para un ejemplo. - - - - - &reftitle.seealso; - - mcrypt_generic - mcrypt_generic_init - mcrypt_generic_deinit - - - - diff --git a/reference/mcrypt/ini.xml b/reference/mcrypt/ini.xml deleted file mode 100644 index c0b1493004..0000000000 --- a/reference/mcrypt/ini.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - -
    - &reftitle.runtime; - &extension.runtime; - - - &ConfigureOptions; mcrypt - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - mcrypt.algorithms_dir - &null; - INI_ALL - - - - mcrypt.modes_dir - &null; - INI_ALL - - - - -
    - &ini.php.constants; -
    - - &ini.descriptions.title; - - - - mcrypt.algorithms_dir - string - - - - El directorio que contiene los algoritmos. Por omisión es el directorio indicado durante la - compilación de libmcrypt, típicamente se trata de - /usr/local/lib/libmcrypt. Consulte - mcrypt_list_algorithms para más detalles. - - - - - - mcrypt.modes_dir - string - - - - El directorio que contiene los modos. Por omisión es el directorio indicado durante la - compilación de libmcrypt, típicamente se trata de - /usr/local/lib/libmcrypt. Consulte - mcrypt_list_modes para más detalles. - - - - -
    - diff --git a/reference/mcrypt/reference.xml b/reference/mcrypt/reference.xml deleted file mode 100644 index 16695495c2..0000000000 --- a/reference/mcrypt/reference.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - &Functions; Mcrypt - - &reference.mcrypt.entities.functions; - - - - diff --git a/reference/mcrypt/setup.xml b/reference/mcrypt/setup.xml deleted file mode 100644 index 2caef9e8eb..0000000000 --- a/reference/mcrypt/setup.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - Estas funciones utilizan mcrypt. - Para utilizar esta biblioteca, descargue - el fichero libmcrypt-x.x.tar.gz desde - &url.mcrypt; - y siga las instrucciones de instalación proporcionadas. - - - Se requiere la versión 2.5.6 o posterior de la biblioteca libmcrypt. - - - Los usuarios de Windows encontrarán la biblioteca en la versión Windows - de PHP 5.3. La versión binaria de Windows de PHP 5.3 utiliza la versión estática - de la biblioteca MCrypt, no se necesita ninguna DLL. - - - Si se compila PHP con la biblioteca libmcrypt 2.4.x, - se admiten los siguientes algoritmos: "CAST", "LOKI97", "RIJNDAEL", "SAFERPLUS", - "SERPENT" así como los siguientes cifrados: "ENIGMA" (cifrado), "PANAMA", - "RC4" y "WAKE". Con libmcrypt 2.4.x otro modo de cifrado - está disponible: "nOFB". - -
    - - - - &reference.mcrypt.configure; - - - - &reference.mcrypt.ini; - - - -
    - &reftitle.resources; - - mcrypt_module_open devuelve un puntero de cifrado. - -
    - - -
    - diff --git a/reference/memcache/book.xml b/reference/memcache/book.xml deleted file mode 100644 index d8aeb3fd08..0000000000 --- a/reference/memcache/book.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - Memcache - - - - &reftitle.intro; - - El módulo Memcache proporciona una interfaz procedimental manejable - así como orientada a objetos a Memcache, un demonio altamente eficiente en - la gestión de la caché, que está principalmente destinado a reducir la carga de las bases - de datos en las aplicaciones web dinámicas. - - - El módulo Memcache proporciona asimismo un - gestor de sesión (memcache). - - - Más información sobre Memcache puede ser - consultada en &url.memcache;. - - - - - &reference.memcache.setup; - &reference.memcache.constants; - &reference.memcache.examples; - &reference.memcache.memcache; - &reference.memcache.reference; - - - diff --git a/reference/memcache/configure.xml b/reference/memcache/configure.xml deleted file mode 100644 index d3455ee8d2..0000000000 --- a/reference/memcache/configure.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - -
    - &reftitle.install; - - &pecl.moved; - &pecl.info; - &url.pecl.package;memcache. - - - - Es posible desactivar el gestor de sesiones memcache. La opción 'pecl install' - pregunta por esta opción (por defecto está activada) de todas formas cuando se compila - estáticamente en PHP se puede utilizar la opción de configuración - . - - - -
    - diff --git a/reference/memcache/constants.xml b/reference/memcache/constants.xml deleted file mode 100644 index fa14655870..0000000000 --- a/reference/memcache/constants.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - - &reftitle.constants; - - Constantes MemCache - - - - Nombre - Descripción - - - - - - MEMCACHE_COMPRESSED - (int) - - - Utilizada para activar a la volada la compresión de los datos con las funciones - Memcache::set, - Memcache::add&listendand; - Memcache::replace. - - - - - MEMCACHE_HAVE_SESSION - (int) - - - 1 si el gestor de sesión Memcache está disponible, 0 en caso contrario. - - - - - MEMCACHE_USER1 - (int) - - - Utilizado para activar los flags de aplicación definidos - por los usuarios, con los métodos - Memcache::set, - Memcache::add&listendand; - Memcache::replace. - - - - - MEMCACHE_USER2 - (int) - - - Utilizado para activar los flags de aplicación definidos - por los usuarios, con los métodos - Memcache::set, - Memcache::add&listendand; - Memcache::replace. - - - - - MEMCACHE_USER3 - (int) - - - Utilizado para activar los flags de aplicación definidos - por los usuarios, con los métodos - Memcache::set, - Memcache::add&listendand; - Memcache::replace. - - - - - MEMCACHE_USER4 - (int) - - - Utilizado para activar los flags de aplicación definidos - por los usuarios, con los métodos - Memcache::set, - Memcache::add&listendand; - Memcache::replace. - - - - -
    -
    - - diff --git a/reference/memcache/examples.xml b/reference/memcache/examples.xml deleted file mode 100644 index c251db45e9..0000000000 --- a/reference/memcache/examples.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - &reftitle.examples; -
    - Uso básico - - Ejemplos de la extensión memcache extension - - En este ejemplo, se guarda un objeto en cache y luego se devuelve de nuevo. - Objetos y otros tipos no escalares se serializan antes de guardarse, por lo - tanto es imposible guardar recursos. (ej. identificadores de conexión y otros - tipos) en caché. - - -connect('localhost', 11211) or die ("No se pudo contectar"); - -$version = $memcache->getVersion(); -echo "Versión del servidor: ".$version."
    \n"; - -$tmp_object = new stdClass; -$tmp_object->str_attr = 'test'; -$tmp_object->int_attr = 123; - -$memcache->set('key', $tmp_object, false, 10) or die ("Falló al intentar guardar datos en el servidor"); -echo "Guarda datos en caché (los datos expirarán en 10 segundos)
    \n"; - -$get_result = $memcache->get('key'); -echo "Datos desde la caché:
    \n"; - -var_dump($get_result); - -?> -]]> -
    -
    - - Usando el gestor de sesiones de memcache - - -]]> - - -
    -
    - diff --git a/reference/memcache/functions/memcache-debug.xml b/reference/memcache/functions/memcache-debug.xml deleted file mode 100644 index c3cd569069..0000000000 --- a/reference/memcache/functions/memcache-debug.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - memcache_debug - Activa/desactiva debug output - - - - &reftitle.description; - - boolmemcache_debug - boolon_off - - - - memcache_debug activa el debug output si el parámetro - on_off es igual a &true; y lo desactiva si es igual a - &false;. - - - Solamente se puede acceder a memcache_debug si PHP fue compilado - con la opción --enable-debug y en este caso siempre retorna &true;. - De lo contrario, esta función no tiene ningún efecto y siempre devuelve &false;. - - - - - - - - &reftitle.parameters; - - - on_off - - - Activa debug output si es igual a &true;. - Desactiva debug output si es igual a &false;. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si PHP fue compilado con la opción --enable-debug, de lo contrario - devuelve &false;. - - - - - diff --git a/reference/memcache/ini.xml b/reference/memcache/ini.xml deleted file mode 100644 index 08c8dcfb69..0000000000 --- a/reference/memcache/ini.xml +++ /dev/null @@ -1,313 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - - &ConfigureOptions; memcache - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - memcache.allow_failover - "1" - INI_ALL - Disponible a partir de memcache 2.0.2. - - - memcache.max_failover_attempts - "20" - INI_ALL - Disponible a partir de memcache 2.1.0. - - - memcache.chunk_size - "8192" - INI_ALL - Disponible a partir de memcache 2.0.2. - - - memcache.default_port - "11211" - INI_ALL - Disponible a partir de memcache 2.0.2. - - - memcache.hash_strategy - "standard" - INI_ALL - Disponible a partir de memcache 2.2.0. - - - memcache.hash_function - "crc32" - INI_ALL - Disponible a partir de memcache 2.2.0. - - - memcache.protocol - ascii - INI_ALL - Supportado a partir de memcache 3.0.0 - - - memcache.redundancy - 1 - INI_ALL - Supportado a partir de memcache 3.0.0 - - - memcache.session_redundancy - 2 - INI_ALL - Supportado a partir de memcache 3.0.0 - - - memcache.compress_threshold - 20000 - INI_ALL - Supportado a partir de memcache 3.0.3 - - - memcache.lock_timeout - 15 - INI_ALL - Supportado a partir de memcache 3.0.4 - - - -
    - - Opciones de Configuración de Sesión que Afectan el Comportamiento de Memcache - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - session.save_handler - "files" - INI_ALL - Supportado a partir de memcache 2.1.2 - - - session.save_path - "" - INI_ALL - Supportado a partir de memcache 2.1.2 - - - -
    - &ini.php.constants; -
    - -&ini.descriptions.title; - - - - - - memcache.allow_failover - bool - - - - Si se debe cambiar a otros servidores en caso de error. - - - - - - - memcache.max_failover_attempts - int - - - - Define cuántos servidores intentar cuando se fijan o recuperan - datos. Utilice solo en conjunción con memcache.allow_failover. - - - - - - - memcache.chunk_size - int - - - - Los datos deben transferirse en fragmentos de este tamaño; - Configurar este valor a un valor pequeño provoca más escrituras - en la red. Intente aumentar este valor a 32768 si se encuentran - retrasos inexplicables. - - - - - - - memcache.default_port - string - - - - El número de puerto TCP por defecto a utilizar al conectarse - al servidor memcache si no se especifica otro puerto. - - - - - - - memcache.hash_strategy - string - - - - Controla la estrategia a aplicar al mapear las claves en los servidores. - Definir este valor a consistent para activar el hash consistente - que permite añadir o eliminar servidores del grupo sin necesidad de - remapear las claves. Definir este valor a standard hará que se utilice - la estrategia antigua. - - - - - - - memcache.hash_function - string - - - - Controla la función de hash a aplicar al mapear las claves - en los servidores, crc32 utilizará el CRC32 estándar, - mientras que fnv utilizará FNV-1a. - - - - - - - memcache.protocol - string - - - - - - - - - - memcache.redundancy - int - - - - - - - - - - memcache.session_redundancy - int - - - - - - - - - - memcache.compress_threshold - int - - - - - - - - - - memcache.lock_timeout - int - - - - - - - - - - session.save_handler - string - - - - Utilice memcache como gestor de sesión definiendo este valor a - memcache. - - - - - - - session.save_path - string - - - - Define las URL de servidor, separadas por comas, a utilizar para el almacenamiento de - las sesiones, por ejemplo: "tcp://host1:11211, tcp://host2:11211". - - - Cada URL puede contener parámetros que serán aplicados al servidor, de la misma - forma que para el método Memcache::addServer. Por ejemplo: - "tcp://host1:11211?persistent=1&weight=1&timeout=1&retry_interval=15" - - - - - -
    - diff --git a/reference/memcache/memcache.xml b/reference/memcache/memcache.xml deleted file mode 100644 index 01fa39c86d..0000000000 --- a/reference/memcache/memcache.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - La clase Memcache - Memcache - - - - -
    - &reftitle.intro; - - Representa una conexión a un conjunto de servidores memcache. - -
    - - -
    - &reftitle.classsynopsis; - - - - Memcache - - - - - Memcache - - - - - - - - -
    - -
    - - &reference.memcache.entities.memcache; - -
    - diff --git a/reference/memcache/memcache/add.xml b/reference/memcache/memcache/add.xml deleted file mode 100644 index 7baea497b1..0000000000 --- a/reference/memcache/memcache/add.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - Memcache::add - memcache_add - Añade un elemento en el servidor - - - - &reftitle.description; - - boolMemcache::add - stringkey - mixedvar - intflag - intexpire - - - boolmemcache_add - Memcachememcache - stringkey - mixedvar - intflag - intexpire - - - - Memcache::add almacena la variable - var con la clave key solo si esta - clave no existe ya en el servidor. - - - - - - &reftitle.parameters; - - - key - - - La clave a asociar al elemento. - - - - - var - - - La variable a almacenar. Los strings y los integers se almacenan tal cual, - los otros tipos se serializan. - - - - - flag - - - Utilice MEMCACHE_COMPRESSED para comprimir el elemento - (utiliza zlib). - - - - - expire - - - Tiempo de expiración del elemento. Si es igual a cero, el elemento nunca - expirará. También puede utilizarse un timestamp Unix o un número de segundos - a partir del tiempo actual, pero en este caso el número de segundos no debe - exceder 2592000 (30 días). - - - - - - - - &reftitle.returnvalues; - - &return.success; - Devuelve &false; si la clave ya existe. Para el resto, el comportamiento de - Memcache::add es el mismo que - Memcache::set. - - - - - &reftitle.examples; - - Ejemplo con <function>Memcache::add</function> - -add('var_key', 'test variable', false, 30); - -?> -]]> - - - - - - &reftitle.seealso; - - Memcache::set - Memcache::replace - - - - - diff --git a/reference/memcache/memcache/addserver.xml b/reference/memcache/memcache/addserver.xml deleted file mode 100644 index 72b258371f..0000000000 --- a/reference/memcache/memcache/addserver.xml +++ /dev/null @@ -1,258 +0,0 @@ - - - - - - Memcache::addServer - memcache_add_server - Añade un servidor memcache a la lista de conexión - - - - &reftitle.description; - - boolMemcache::addServer - stringhost - intport11211 - boolpersistent - intweight - inttimeout - intretry_interval - boolstatus - callablefailure_callback - inttimeoutms - - - boolmemcache_add_server - Memcachememcache - stringhost - intport11211 - boolpersistent - intweight - inttimeout - intretry_interval - boolstatus - callablefailure_callback - inttimeoutms - - - - Memcache::addServer añade un servidor a la lista de - conexión. - - - - Al utilizar este método (a diferencia de los métodos - Memcache::connect y Memcache::pconnect), - la conexión a la red no se establece hasta que sea necesaria. Además, - no hay inconveniente en añadir muchos servidores a la lista, incluso si no - todos serán utilizados. - - - - El fallo puede producirse en cualquier momento con cualquier - método siempre que otros servidores estén disponibles, la petición - no emitirá error. Cualquier interfaz de conexión o nivel de errores de servidor Memcache (a excepción de la falta de memoria) puede - lanzar el fallo. Errores normales de cliente como añadir una - clave existente no lanzará un fallo. - - - - - Esta función fue añadida en la versión 2.0.0 de Memcache. - - - - - - - &reftitle.parameters; - - - host - - - Apunta al host donde memcache escucha para conexiones. Este parámetro puede especificar también otros transportes como unix:///path/to/memcached.sock - para usar sockets Unix, y en este caso, port debe definirse también a 0. - - - - - port - - - Apunta al puerto donde memcache escucha para conexiones. - Defínase este parámetro a 0 al usar sockets Unix. - - - Nota: Por omisión, el parámetro port - toma el valor de la opción de configuración - memcache.default_port - cuando no se especifica. Por esta razón, es recomendable - especificar explícitamente el puerto al llamar a este método. - - - - - persistent - - - Controla el uso de una conexión persistente. El valor por - omisión es &true;. - - - - - weight - - - Número de entradas a crear para este servidor que a su vez controla su - probabilidad de ser elegido. La probabilidad es relativa al peso total - de todos los servidores. - - - - - timeout - - - Valor en segundos que será utilizado para conectarse al demonio. - Piénsese dos veces antes de cambiar el valor por omisión de un segundo - - podría perderse todos los beneficios de usar la caché si la conexión es demasiado lenta. - - - - - retry_interval - - - Controla cuántas veces se intentará un servidor que falla, el valor - por omisión es de 15 segundos. Si este parámetro vale -1, no se realizará - ningún nuevo intento. Ni este parámetro, ni el parámetro - persistent tienen efecto cuando esta extensión - se carga dinámicamente mediante la función dl. - - - Cada estructura de conexión fallida tiene su propio tiempo límite - y antes de que este expire, será saltada durante la selección del - proceso para servir una petición. Una vez expirado, la conexión será - correctamente reconectada o marcada como fallida por otro - intervalo de retry_interval segundos. El efecto - típico es que cada hijo de servidor web intentará la conexión - cada retry_interval segundos al servir una página. - - - - - status - - - Controla si el servidor debe ser indicado como en línea. - Cuando este parámetro vale &false; y el parámetro retry_interval - vale -1, permite mantener un servidor fallido en la lista - y no afectará al algoritmo de distribución de claves. Las peticiones - para este servidor fallarán inmediatamente según la configuración del - parámetro memcache.allow_failover. - Por omisión, este parámetro vale &true;, significando que el servidor debe ser - considerado como en línea. - - - - - failure_callback - - - Permite al usuario especificar una función de retorno para manejar un error. La función de retorno se ejecuta antes de alcanzar el límite de intentos. La función toma dos parámetros; el nombre del host y el puerto - del servidor que falló. - - - - - timeoutms - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>Memcache::addServer</function> - -addServer('memcache_host', 11211); -$memcache->addServer('memcache_host2', 11211); - -/* API procedimental */ - -$memcache_obj = memcache_connect('memcache_host', 11211); -memcache_add_server($memcache_obj, 'memcache_host2', 11211); - -?> -]]> - - - - - - &reftitle.notes; - - - Cuando el parámetro port no se especifica, este método - tomará el valor de la directiva de configuración INI - memcache.default_port. - Si este valor ha sido modificado en otro lugar de su aplicación, - esto puede llevar a resultados inesperados: por esta razón, es recomendable - siempre especificar el puerto explícitamente al llamar al método. - - - - - - &reftitle.seealso; - - Memcache::connect - Memcache::pconnect - Memcache::close - Memcache::setServerParams - Memcache::getServerStatus - - - - - diff --git a/reference/memcache/memcache/close.xml b/reference/memcache/memcache/close.xml deleted file mode 100644 index ac8cf1a4ff..0000000000 --- a/reference/memcache/memcache/close.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - Memcache::close - memcache_close - Cierra la conexión con el servidor Memcache - - - - &reftitle.description; - - boolMemcache::close - - - - boolmemcache_close - Memcachememcache - - - - Memcache::close cierra la conexión al servidor - Memcache. Esta función no cierra las conexiones - persistentes que serán cerradas únicamente durante el reinicio del servidor web. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>Memcache::close</function> - -connect('memcache_host', 11211); -/* -haga algo aquí ... -*/ -$memcache_obj->close(); - -?> -]]> - - - - - - &reftitle.seealso; - - Memcache::connect - Memcache::pconnect - - - - - diff --git a/reference/memcache/memcache/connect.xml b/reference/memcache/memcache/connect.xml deleted file mode 100644 index 152eb702c2..0000000000 --- a/reference/memcache/memcache/connect.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - - Memcache::connect - memcache_connect - Establece una conexión con el servidor Memcache - - - - &reftitle.description; - - boolMemcache::connect - stringhost - intport - inttimeout - - - Memcachememcache_connect - stringhost - intport - inttimeout - - - - Memcache::connect establece una conexión con el servidor - de caché Memcache. - La conexión, que ha sido abierta utilizando la función - Memcache::connect se cerrará automáticamente - al final del script. No obstante, puede cerrarse manualmente utilizando la - función Memcache::close. - - - - - - &reftitle.parameters; - - - host - - - Especifica el host donde memcache escucha para conexiones. Este parámetro puede también - especificar otros transportes como unix:///path/to/memcached.sock - para utilizar sockets Unix, y en este caso, port debe también - ser definido a 0. - - - - - port - - - Especifica el puerto donde memcache escucha para conexiones. Defina este parámetro a - 0 al utilizar sockets Unix. - - - Nota: Por omisión, el parámetro port toma el valor - de la opción de configuración memcache.default_port - si no es especificado. Por esta razón, es recomendable especificar explícitamente - el puerto al llamar a este método. - - - - - timeout - - - Valor en segundos que será utilizado para conectarse al demonio. - Considérelo dos veces antes de cambiar el valor por omisión de un segundo - - podría perderse todos los beneficios de utilizar la caché si la conexión es demasiado lenta. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>Memcache::connect</function> - -connect('memcache_host', 11211); - -?> -]]> - - - - - - &reftitle.notes; - - - Cuando el parámetro port no es especificado, este método - tomará el valor de la directiva de configuración INI - memcache.default_port. - Si este valor ha sido modificado en otro lugar de la aplicación, - esto puede conducir a resultados inesperados: por esta razón, es recomendable - siempre especificar el puerto explícitamente al llamar al método. - - - - - - &reftitle.seealso; - - Memcache::pconnect - Memcache::close - - - - - diff --git a/reference/memcache/memcache/decrement.xml b/reference/memcache/memcache/decrement.xml deleted file mode 100644 index a018d7211b..0000000000 --- a/reference/memcache/memcache/decrement.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - Memcache::decrement - Disminuye el valor de un elemento - - - - &reftitle.description; - - intfalseMemcache::decrement - stringkey - intvalue1 - - - intfalsememcache_decrement - Memcachememcache - stringkey - intvalue1 - - - - Memcache::decrement disminuye el valor del - elemento por value. De manera similar - a la función memcache::increment, el valor actual - del elemento se convierte primero en numérico y luego - se resta el valor value. - - - El nuevo valor del elemento no puede ser inferior a cero. - - - - - No se debe utilizar la función Memcache::decrement con elementos - almacenados comprimidos. En este caso, la llamada a la función - Memcache::get fallará. - - - Memcache::decrement no crea - un elemento si no existe. - - - - - - &reftitle.parameters; - - - key - - - Clave del elemento a disminuir. - - - - - value - - - Disminuye el elemento por value. - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor del nuevo elemento en caso de éxito&return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo con <function>Memcache::decrement</function> - -connect('memcache_host', 11211); -/* disminución del elemento por 3 */ -$new_value = $memcache_obj->decrement('test_item', 3); -?> -]]> - - - - - - &reftitle.seealso; - - Memcache::increment - Memcache::replace - - - - - diff --git a/reference/memcache/memcache/delete.xml b/reference/memcache/memcache/delete.xml deleted file mode 100644 index 47af9c727d..0000000000 --- a/reference/memcache/memcache/delete.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - Memcache::delete - memcache_delete - Elimina un elemento del servidor de caché - - - - &reftitle.description; - - boolMemcache::delete - stringkey - intexptime0 - - - boolmemcache_delete - Memcachememcache - stringkey - intexptime0 - - - - Memcache::delete elimina el elemento identificado por la clave - key. - - - - - - &reftitle.parameters; - - - key - - - La clave asociada al elemento a eliminar. - - - - - exptime - - - Este argumento obsoleto no es soportado, y su valor por omisión es - 0 segundos. No se debe utilizar este argumento. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL memcache 3.0.5 - - El argumento exptime está deprecado y no debería ser proporcionado. - Valores distintos de 0 pueden provocar errores inesperados. - - - - - - - - - &reftitle.examples; - - Ejemplo con <function>Memcache::delete</function> - -connect('memcache_host', 11211); - -$memcache_obj->delete('key_to_delete'); - -?> -]]> - - - - - - &reftitle.seealso; - - Memcache::set - Memcache::replace - - - - - diff --git a/reference/memcache/memcache/flush.xml b/reference/memcache/memcache/flush.xml deleted file mode 100644 index dd23839209..0000000000 --- a/reference/memcache/memcache/flush.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Memcache::flush - Elimina todos los elementos existentes en el servidor de caché - - - - &reftitle.description; - - boolMemcache::flush - - - - boolmemcache_flush - Memcachememcache - - - - Memcache::flush invalida inmediatamente todos los - elementos existentes en el servidor de caché. Memcache::flush - no libera ningún recurso actualmente, solo marca todos los - elementos como expirados, por lo que la memoria ocupada será - reutilizada con nuevos elementos. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>Memcache::flush</function> - -connect('memcache_host', 11211); - -$memcache_obj->flush(); - -?> -]]> - - - - - - diff --git a/reference/memcache/memcache/get.xml b/reference/memcache/memcache/get.xml deleted file mode 100644 index fd85fef7a4..0000000000 --- a/reference/memcache/memcache/get.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - Memcache::get - memcache_get - Recupera un elemento del servidor de caché - - - - &reftitle.description; - - stringMemcache::get - stringkey - intflags - - - arrayMemcache::get - arraykeys - arrayflags - - - stringmemcache_get - Memcachememcache - stringkey - intflags - - - arraymemcache_get - Memcachememcache - arraykeys - arrayflags - - - - Memcache::get devuelve los datos previamente almacenados - en el elemento identificado por la clave key si existe en - el servidor en el momento de la llamada. - - - - Se puede pasar un array de claves a la función - Memcache::get para obtener un array de valores. El - array resultante contendrá solo las parejas clave-valor encontradas. - - - - - - &reftitle.parameters; - - - key - - - La clave o el array de claves a recuperar. - - - - - flags - - - Si este argumento está presente, representará los flags de los valores - a recuperar. Estos flags son los mismos que los dados en el ejemplo de - la función Memcache::set. El byte menos significativo - del valor está reservado para un uso interno de pecl/memcache - (por ejemplo, para indicar el estado de compresión y serialización). - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor asociado con el argumento key - o un array que contiene las parejas clave/valor encontradas cuando el argumento - key es un &array;. Devuelve &false; si ocurre un error, - si el argumento key no es encontrado, - o si el argumento key es un &array; vacío. - - - - - &reftitle.examples; - - Ejemplo con <function>Memcache::get</function> - -connect('memcache_host', 11211); -$var = $memcache_obj->get('some_key'); - -/* -También se puede utilizar un array de claves como argumento. -Si un elemento de este tipo no es encontrado en el servidor, el array -resultado simplemente no incluirá dicha clave. -*/ - -/* API procedimental */ -$memcache_obj = memcache_connect('memcache_host', 11211); -$var = memcache_get($memcache_obj, Array('some_key', 'another_key')); - -/* API Orientada a Objetos */ -$memcache_obj = new Memcache; -$memcache_obj->connect('memcache_host', 11211); -$var = $memcache_obj->get(Array('some_key', 'second_key')); - -?> -]]> - - - - - - diff --git a/reference/memcache/memcache/getextendedstats.xml b/reference/memcache/memcache/getextendedstats.xml deleted file mode 100644 index 2d11fb3db1..0000000000 --- a/reference/memcache/memcache/getextendedstats.xml +++ /dev/null @@ -1,175 +0,0 @@ - - - - - - Memcache::getExtendedStats - memcache_get_extended_stats - Recupera estadísticas de todos los servidores en la lista - - - - &reftitle.description; - - arrayMemcache::getExtendedStats - stringtype - intslabid - intlimit100 - - - arraymemcache_get_extended_stats - Memcachememcache - stringtype - intslabid - intlimit100 - - - - Memcache::getExtendedStats devuelve un array - asociativo de dos dimensiones con estadísticas de servidores. Las claves - de los arrays corresponden a host:puerto de los servidores y los valores - contienen estadísticas del servidor individual. Un servidor en fallo - tendrá sus entradas correspondientes fijadas a &false;. - - - - - Esta función fue añadida en la versión 2.0.0 de Memcache. - - - - - - - &reftitle.parameters; - - - - type - - - El tipo de estadísticas a recuperar. Los valores válidos son: "reset", - "malloc", "maps", "cachedump", - "slabs", "items", "sizes". - Según las especificaciones del protocolo memcached, estos argumentos opcionales - pueden ser modificados según las necesidades de los desarrolladores de memcache. - - - - - slabid - - - Utilizado con el parámetro type definido como cachedump - para identificar el slab a recuperar. El comando cachedump - sobrecarga el servidor y solo debe ser utilizado con fines de depuración. - - - - - limit - - - Utilizado con el parámetro type definido como - cachedump para limitar el número de entradas a recuperar. - - - - - - - El tipo de estadística cachedump ha sido eliminado del proceso - memcached por razones de seguridad. - - - - - - - &reftitle.returnvalues; - - Devuelve un array asociativo con estadísticas de los servidores o - &false; en caso de error. - - - - - &reftitle.examples; - - Ejemplo con <function>Memcache::getExtendedStats</function> - -addServer('memcache_host', 11211); - $memcache_obj->addServer('failed_host', 11211); - - $stats = $memcache_obj->getExtendedStats(); - print_r($stats); -?> -]]> - - &example.outputs; - - Array - ( - [pid] => 3756 - [uptime] => 603011 - [time] => 1133810435 - [version] => 1.1.12 - [rusage_user] => 0.451931 - [rusage_system] => 0.634903 - [curr_items] => 2483 - [total_items] => 3079 - [bytes] => 2718136 - [curr_connections] => 2 - [total_connections] => 807 - [connection_structures] => 13 - [cmd_get] => 9748 - [cmd_set] => 3096 - [get_hits] => 5976 - [get_misses] => 3772 - [bytes_read] => 3448968 - [bytes_written] => 2318883 - [limit_maxbytes] => 33554432 - ) - - [failed_host:11211] => false -) -]]> - - - - - - &reftitle.seealso; - - Memcache::getVersion - Memcache::getStats - - - - - diff --git a/reference/memcache/memcache/getserverstatus.xml b/reference/memcache/memcache/getserverstatus.xml deleted file mode 100644 index 9089b00c4c..0000000000 --- a/reference/memcache/memcache/getserverstatus.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - Memcache::getServerStatus - memcache_get_server_status - Retorna el estado del servidor - - - - &reftitle.description; - - intMemcache::getServerStatus - stringhost - intport11211 - - - intmemcache_get_server_status - Memcachememcache - stringhost - intport11211 - - - - Memcache::getServerStatus retorna el estado - en línea/fuera de línea del servidor. - - - - - Esta función fue añadida en la versión 2.1.0 de Memcache. - - - - - - - &reftitle.parameters; - - - host - - - Apunta al host donde memcache escucha conexiones. - - - - - port - - - Apunta al puerto donde memcache escucha conexiones. - - - - - - - - &reftitle.returnvalues; - - Retorna el estado del servidor. 0 si el servidor falla, un valor - diferente de cero en caso contrario. - - - - - &reftitle.examples; - - Ejemplo con <function>Memcache::getServerStatus</function> - -addServer('memcache_host', 11211); -echo $memcache->getServerStatus('memcache_host', 11211); - -/* API procedimental */ -$memcache = memcache_connect('memcache_host', 11211); -echo memcache_get_server_status($memcache, 'memcache_host', 11211); - -?> -]]> - - - - - - &reftitle.seealso; - - Memcache::addServer - Memcache::setServerParams - - - - - diff --git a/reference/memcache/memcache/getstats.xml b/reference/memcache/memcache/getstats.xml deleted file mode 100644 index 2a28617a00..0000000000 --- a/reference/memcache/memcache/getstats.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - Memcache::getStats - memcache_get_stats - Lee las estadísticas del servidor - - - - &reftitle.description; - - arrayfalseMemcache::getStats - stringtype - intslabid - intlimit100 - - - arrayfalsememcache_get_stats - Memcachememcache - stringtype - intslabid - intlimit100 - - - - Memcache::getStats devuelve un array asociativo - con las estadísticas del servidor. Los índices del array corresponden - a los parámetros de estadísticas, y el valor asociado es el valor de - dichas estadísticas. - - - - - - &reftitle.parameters; - - - type - - - El tipo de estadísticas a recuperar. Los valores válidos son {"reset", - "malloc", "maps", "cachedump", - "slabs", "items", "sizes". - Según las especificaciones del protocolo memcached, estos argumentos opcionales son susceptibles - de ser modificados según las necesidades de los desarrolladores de memcache. - - - - - slabid - - - Utilizado con el parámetro type definido como cachedump - para identificar el slab a recuperar. El comando cachedump - sobrecarga el servidor y no debe ser utilizado excepto para depuración. - - - - - limit - - - Utilizado con el parámetro type definido como - cachedump para limitar el número de entradas a recuperar. - - - - - - - - &reftitle.returnvalues; - - Devuelve un array asociativo de las estadísticas de un servidor&return.falseforfailure;. - - - - - &reftitle.seealso; - - Memcache::getVersion - Memcache::getExtendedStats - - - - - diff --git a/reference/memcache/memcache/getversion.xml b/reference/memcache/memcache/getversion.xml deleted file mode 100644 index 27332fb0f4..0000000000 --- a/reference/memcache/memcache/getversion.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Memcache::getVersion - memcache_get_version - Devuelve el número de versión del servidor - - - - &reftitle.description; - - stringfalseMemcache::getVersion - - - - stringfalsememcache_get_version - Memcachememcache - - - - Memcache::getVersion devuelve una cadena con - el número de versión del servidor. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un &string; con el número de versión del servidor&return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo con <function>Memcache::getVersion</function> - -connect('memcache_host', 11211); -echo $memcache->getVersion(); - -/* API procedimental */ -$memcache = memcache_connect('memcache_host', 11211); -echo memcache_get_version($memcache); - -?> -]]> - - - - - - &reftitle.seealso; - - Memcache::getExtendedStats - Memcache::getStats - - - - - diff --git a/reference/memcache/memcache/increment.xml b/reference/memcache/memcache/increment.xml deleted file mode 100644 index fab1a87572..0000000000 --- a/reference/memcache/memcache/increment.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - Memcache::increment - memcache_increment - Incrementa el valor de un elemento - - - - &reftitle.description; - - intfalseMemcache::increment - stringkey - intvalue1 - - - intfalsememcache_increment - Memcachememcache - stringkey - intvalue1 - - - - Memcache::increment incrementa el valor de un elemento - identificado por la clave key por el valor - value. Si el elemento identificado por la clave - key no es de tipo numérico y no puede - ser convertido a número, el valor de este elemento será definido a - value. - Memcache::increment no crea - un elemento si no existe. - - - No se debe utilizar memcache::increment con elementos - almacenados comprimidos. En este caso, la llamada a la función - Memcache::get fallará. - - - - - - - - &reftitle.parameters; - - - key - - - Clave del elemento a incrementar. - - - - - value - - - Incrementa el elemento por value. - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor del nuevo elemento en caso de éxito &return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo con <function>Memcache::increment</function> - -connect('memcache_host', 11211); -/* incrementación del contador en 3 */ -$current_value = $memcache_obj->increment('counter', 3); - -?> -]]> - - - - - - &reftitle.seealso; - - Memcache::decrement - Memcache::replace - - - - - diff --git a/reference/memcache/memcache/pconnect.xml b/reference/memcache/memcache/pconnect.xml deleted file mode 100644 index 82fb11e12d..0000000000 --- a/reference/memcache/memcache/pconnect.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - Memcache::pconnect - memcache_pconnect - Establece una conexión persistente a un servidor de caché - - - - &reftitle.description; - - boolMemcache::pconnect - stringhost - intport - inttimeout - - - MemcacheMemcache::pconnect - stringhost - intport - inttimeout - - - - Memcache::pconnect es similar a la función - Memcache::connect con la diferencia de que la conexión - será persistente. - Este tipo de conexión no se cierra al finalizar el script ni por la función - Memcache::close. - - - - - - &reftitle.parameters; - - - host - - - Especifica el host donde memcache escucha conexiones. Este parámetro - puede también especificar otros transportes como - unix:///path/to/memcached.sock - para utilizar sockets Unix, y, en este caso, - port debe también definirse - a 0. - - - - - port - - - Especifica el puerto donde memcache escucha conexiones. Defínase este parámetro - a 0 al utilizar sockets Unix. - - - - - timeout - - - Valor en segundos que será utilizado para conectarse al demonio. - Piénsese dos veces antes de cambiar el valor por omisión de un segundo - - podría perderse todos los beneficios de utilizar la caché - si la conexión es demasiado lenta. - - - - - - - - &reftitle.returnvalues; - - Retorna un objeto Memcache&return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo con <function>Memcache::pconnect</function> - -pconnect('memcache_host', 11211); - -?> -]]> - - - - - - &reftitle.seealso; - - Memcache::connect - - - - - diff --git a/reference/memcache/memcache/replace.xml b/reference/memcache/memcache/replace.xml deleted file mode 100644 index b9203fc64b..0000000000 --- a/reference/memcache/memcache/replace.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - Memcache::replace - memcache_replace - Remplaza el valor de un elemento existente - - - - &reftitle.description; - - boolMemcache::replace - stringkey - mixedvar - intflag - intexpire - - - boolmemcache_replace - Memcachememcache - stringkey - mixedvar - intflag - intexpire - - - - Memcache::replace se utiliza para reemplazar el valor - de un elemento identificado por la clave key. En el caso de - que el elemento identificado por la clave key no exista, - la función Memcache::replace devolverá &false;. - Por lo demás, la función Memcache::replace funciona - de la misma manera que la función Memcache::set. - - - - - - &reftitle.parameters; - - - key - - - La clave que se asociará con el elemento. - - - - - var - - - La variable a almacenar. Los strings y los integers se almacenan como tales, - los demás tipos se almacenan de manera serializada. - - - - - flag - - - Utilice MEMCACHE_COMPRESSED para almacenar - el elemento comprimido (utiliza zlib). - - - - - expire - - - Tiempo de expiración para el elemento. Si es igual a 0, el elemento - no expirará nunca. También puede utilizarse un timestamp Unix o un número de - segundos a partir de la fecha actual, pero en este último caso, el número de - segundos no debe exceder 2592000 (30 días). - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>Memcache::replace</function> - -replace("test_key", "some variable", false, 30); - -?> -]]> - - - - - - &reftitle.seealso; - - Memcache::set - Memcache::add - - - - - diff --git a/reference/memcache/memcache/set.xml b/reference/memcache/memcache/set.xml deleted file mode 100644 index 3543936dfa..0000000000 --- a/reference/memcache/memcache/set.xml +++ /dev/null @@ -1,180 +0,0 @@ - - - - - - Memcache::set - memcache_set - Almacena datos en el servidor de caché - - - - &reftitle.description; - - boolMemcache::set - stringkey - mixedvar - intflag - intexpire - - - boolmemcache_set - Memcachememcache - stringkey - mixedvar - intflag - intexpire - - - - Memcache::set almacena el elemento var - con la clave key en el servidor de caché. - El parámetro expire representa el tiempo de expiración en segundos - del elemento. Si vale 0, el elemento no expirará nunca (aunque el servidor - de caché no garantiza que este elemento siempre estará almacenado, puede ser - eliminado de la caché para hacer espacio para otros elementos). - Puede utilizarse la constante MEMCACHE_COMPRESSED - como valor del parámetro flag - si se desea utilizar la compresión en tiempo real (utilizando la biblioteca zlib). - - - Tenga en cuenta que los recursos (es decir, identificadores de archivos o conexiones) - no pueden almacenarse en la caché, ya que no pueden ser representados linealmente. - - - - - - - - &reftitle.parameters; - - - key - - - La clave que se asociará con el elemento. - - - - - var - - - La variable a registrar. Los strings y los integers se registran como tales, - los demás tipos se registran de manera serializada. - - - - - flag - - - Utilice MEMCACHE_COMPRESSED para registrar - el elemento comprimido (utiliza zlib). - - - - - expire - - - Tiempo de expiración para el elemento. Si es igual a 0, el elemento no expirará. - También puede utilizarse un timestamp Unix o un número de segundos a partir de la fecha actual, - pero en este último caso, el número de segundos no debe exceder 2592000 (30 días). - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Ejemplo con <function>Memcache::set</function> - - -]]> - - - - Ejemplo con <function>Memcache::set</function> - -connect('memcache_host', 11211); - -/* -define el valor del elemento identificado por la clave 'var_key' ; -utilización de la compresión en tiempo real ; -el tiempo de expiración es de 50 segundos -*/ -$memcache_obj->set('var_key', 'algunas variables grandes', MEMCACHE_COMPRESSED, 50); - -echo $memcache_obj->get('var_key'); - -?> -]]> - - - - - - - &reftitle.seealso; - - Memcache::add - Memcache::replace - - - - diff --git a/reference/memcache/memcache/setcompressthreshold.xml b/reference/memcache/memcache/setcompressthreshold.xml deleted file mode 100644 index 144dfd5255..0000000000 --- a/reference/memcache/memcache/setcompressthreshold.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - Memcache::setCompressThreshold - Activa la compresión automática de los valores grandes - - - - &reftitle.description; - - boolMemcache::setCompressThreshold - intthreshold - floatmin_savings - - - boolmemcache_set_compress_threshold - Memcachememcache - intthreshold - floatmin_savings - - - - Memcache::setCompressThreshold activa la compresión - automática de los valores grandes. - - - - - Esta función fue añadida en la versión 2.0.0 de Memcache. - - - - - - - &reftitle.parameters; - - - threshold - - - Controla el tamaño mínimo de valor antes de intentar comprimir - automáticamente. - - - - - min_saving - - - Especifica el número mínimo de ahorro para guardar los valores - comprimidos. El valor proporcionado debe estar entre 0 y 1. El valor - por omisión es 0.2, lo que da un mínimo de 20% de ahorro de compresión. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>Memcache::setCompressThreshold</function> - -addServer('memcache_host', 11211); -$memcache_obj->setCompressThreshold(20000, 0.2); - -/* API procedimental */ - -$memcache_obj = memcache_connect('memcache_host', 11211); -memcache_set_compress_threshold($memcache_obj, 20000, 0.2); - -?> -]]> - - - - - - diff --git a/reference/memcache/memcache/setserverparams.xml b/reference/memcache/memcache/setserverparams.xml deleted file mode 100644 index cef6719a8a..0000000000 --- a/reference/memcache/memcache/setserverparams.xml +++ /dev/null @@ -1,183 +0,0 @@ - - - - - - Memcache::setServerParams - memcache_set_server_params - Modifica los parámetros y los estados del servidor durante la ejecución - - - - &reftitle.description; - - boolMemcache::setServerParams - stringhost - intport11211 - inttimeout - intretry_interval&false; - boolstatus - callablefailure_callback - - - boolmemcache_set_server_params - Memcachememcache - stringhost - intport11211 - inttimeout - intretry_interval&false; - boolstatus - callablefailure_callback - - - - Memcache::setServerParams modifica los parámetros del - servidor durante la ejecución. - - - - Esta función fue añadida en la versión 2.1.0 de Memcache. - - - - - - - &reftitle.parameters; - - - host - - - Host donde memcache escucha para conexiones. - - - - - port - - - Puerto donde memcache escucha para conexiones. - - - - - timeout - - - Valor en segundos que será utilizado para conectarse al demonio. - Piénselo dos veces antes de cambiar el valor por omisión de un segundo - - podría perderse todos los beneficios del uso de la caché si la conexión es demasiado lenta. - - - - - retry_interval - - - Controla cuántas veces se intentará conectar a un servidor que falla: - el valor por omisión es de 15 segundos. Si este parámetro vale -1, no se realizará - ningún nuevo intento. Ni este parámetro, ni el parámetro - persistent tienen efecto cuando esta extensión - es cargada dinámicamente mediante la función dl. - - - - - status - - - Controla si el servidor debe ser indicado como en línea. - Cuando este parámetro vale &false; y el parámetro retry_interval - vale -1, permite mantener un servidor fallido en la lista - y no afectará al algoritmo de distribución de claves. Las peticiones - para este servidor fallarán inmediatamente según la configuración del - parámetro memcache.allow_failover. - Por omisión, este parámetro vale &true;, significando que el servidor debe ser - considerado como en línea. - - - - - failure_callback - - - Permite al usuario especificar una función de devolución de llamada para - manejar un error. La función es ejecutada antes de alcanzar el límite de intentos. - La función toma dos argumentos; el nombre del host y el puerto - del servidor que falló. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>Memcache::setServerParams</function> - -addServer('memcache_host', 11211, false, 1, 1, -1, false); - -// Reemplaza el servidor en línea -$memcache->setServerParams('memcache_host', 11211, 1, 15, true, '_callback_memcache_failure'); - -/* API procedimental */ - -$memcache_obj = memcache_connect('memcache_host', 11211); -memcache_set_server_params($memcache_obj, 'memcache_host', 11211, 1, 15, true, '_callback_memcache_failure'); - -?> -]]> - - - - - - &reftitle.seealso; - - Memcache::addServer - Memcache::getServerStatus - - - - - diff --git a/reference/memcache/reference.xml b/reference/memcache/reference.xml deleted file mode 100644 index 8d6d8b71cf..0000000000 --- a/reference/memcache/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - &Functions; de Memcache - &reference.memcache.entities.functions; - - - - - diff --git a/reference/memcache/setup.xml b/reference/memcache/setup.xml deleted file mode 100644 index 1b3c01656e..0000000000 --- a/reference/memcache/setup.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - Este módulo utiliza las funciones de la biblioteca zlib - para soportar la compresión de datos a la volée. Zlib es por lo tanto requerido para instalar - este módulo. - -
    - - - - &reference.memcache.configure; - - - - &reference.memcache.ini; - - - -
    - &reftitle.resources; - - Existe una única recurso utilizado por el módulo Memcache: - es el enlace identificador que representa la conexión del servidor de caché. - -
    - - -
    - diff --git a/reference/memcached/book.xml b/reference/memcached/book.xml deleted file mode 100644 index 1e066ae89b..0000000000 --- a/reference/memcached/book.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - Memcached - Memcached - - - &reftitle.intro; - - memcached es un sistema de alto rendimiento, distribuido y en memoria, de caché de objetos, genérico por naturaleza, pero principalmente destinado al uso con sitios web dinámicos, para aliviar las bases de datos. - - - Esta extensión utiliza la biblioteca libmemcached para - asegurar las comunicaciones con los servidores memcached. También - proporciona un gestor de - sesiones, llamado - memcached. - - - Información sobre libmemcached está disponible en - &url.libmemcached;. - - - - &reference.memcached.setup; - &reference.memcached.constants; - &reference.memcached.expiration; - &reference.memcached.callbacks; - &reference.memcached.sessions; - &reference.memcached.memcached; - &reference.memcached.memcachedexception; - - - - diff --git a/reference/memcached/callbacks.xml b/reference/memcached/callbacks.xml deleted file mode 100644 index c0938a7b9f..0000000000 --- a/reference/memcached/callbacks.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - Funciones de retorno - -
    - Funciones de retorno de resultados - - Las funciones de retorno de resultados (tipo callable) - son invocadas por las funciones - Memcached::getDelayed o - Memcached::getDelayedBykey, para cada - elemento del conjunto de resultados. Las funciones de retorno reciben un objeto - Memcached y un array con la información sobre el elemento. La función de retorno - no necesita devolver nada. - - - Ejemplo de función de retorno de resultados - -addServer('localhost', 11211); -$items = array( - 'key1' => 'value1', - 'key2' => 'value2', - 'key3' => 'value3' -); -$m->setMulti($items); -$m->getDelayed(array('key1', 'key3'), true, 'result_cb'); - -function result_cb($memc, $item) -{ - var_dump($item); -} -?> -]]> - - &example.outputs.similar; - - - string(4) "key1" - ["value"]=> - string(6) "value1" - ["cas"]=> - float(49) -} -array(3) { - ["key"]=> - string(4) "key3" - ["value"]=> - string(6) "value3" - ["cas"]=> - float(50) -} -]]> - - -
    - -
    - Funciones de retorno para claves ausentes - - Las funciones de retorno para claves ausentes son invocadas cuando un elemento no puede - ser leído en el servidor. La función de retorno recibe un objeto Memcached, - la clave solicitada, y un valor de variable por referencia. La función de retorno - es entonces responsable de asignar el valor, y luego devolver - &true; o &false;. Si la función de retorno devuelve &true; - Memcached almacenará el valor así creado en el servidor, y lo devolverá - a la función invocante. Solo Memcached::get y - Memcached::getByKey soportan estas funciones, - ya que el protocolo memcache no proporciona ninguna información sobre la ausencia de - clave en una petición multiclave. - - - Funciones de retorno para claves ausentes - -addServer('localhost', 11211); - -$profile_info = $m->get('user:'.$user_id, 'user_info_cb'); - -function user_info_cb($memc, $key, &$value) -{ - $user_id = substr($key, 5); - /* Lee un perfil en una base de datos */ - /* ... */ - $value = $profile_info; - return true; -} -?> -]]> - - -
    - -
    - - diff --git a/reference/memcached/configure.xml b/reference/memcached/configure.xml deleted file mode 100644 index 2e4c49cec9..0000000000 --- a/reference/memcached/configure.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;memcached. - - - Si libmemcached está instalada en una ubicación no estándar, use la opción , siendo DIR el prefijo - de instalación de libmemcached. Este directorio debe contener el fichero - include/libmemcached/memcached.h. - - - Se requiere Zlib para el soporte de compresión. Para especificar una instalación - no estándar de Zlib, use la opción siendo DIR el prefijo de instalación - de Zlib. - - - El soporte para el controlador de sesiones está activado de manera predeterminada. Para - desactivarlo, use la opción . - - - El soporte para la autenticación SASL está deshabilitado de forma predeterminada. Para habilitarlo, - use la opción . Esto - requiere que haya sido instalada libsasl2 y que libmemcached haya sido - construida con el soporte para SASL habilitado. - -
    - - - diff --git a/reference/memcached/constants.xml b/reference/memcached/constants.xml deleted file mode 100644 index fb5d5286bd..0000000000 --- a/reference/memcached/constants.xml +++ /dev/null @@ -1,1027 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - - - Memcached::OPT_COMPRESSION - - - Activa o desactiva la compresión del contenido. Si está - activada, los elementos que excedan un tamaño (actualmente - 200 bytes), serán comprimidos durante el almacenamiento, y - descomprimidos al recuperar, de manera transparente. El umbral puede ser configurado - mediante el parámetro ini memcached.compression_threshold. - - Tipo: bool, por omisión: &true;. - - - - - Memcached::OPT_COMPRESSION_TYPE - - - Especifica el algoritmo de compresión a utilizar, si la compresión está activada. - Los algoritmos válidos son Memcached::COMPRESSION_FASTLZ, - Memcached::COMPRESSION_ZLIB y - Memcached::COMPRESSION_ZSTD. - - Tipo: int, por omisión: Memcached::COMPRESSION_FASTLZ. - - - - - Memcached::COMPRESSION_FASTLZ - - - El algoritmo de compresión FASTLZ. - - - - - - Memcached::COMPRESSION_ZLIB - - El algoritmo de compresión ZLIB. - - - - - Memcached::COMPRESSION_ZSTD - - - El algoritmo de compresión ZSTD. - - - Disponible a partir de Memcached 3.3.0. - - - - - - Memcached::OPT_COMPRESSION_LEVEL - - - Especifica el nivel de compresión a utilizar, si la compresión está activada. - - - Memcached::COMPRESSION_FASTLZ no soporta niveles de compresión. - Memcached::COMPRESSION_ZSTD: el nivel mínimo es -22 y el nivel máximo es 22. - Memcached::COMPRESSION_ZLIB: el nivel mínimo es 0 y el nivel máximo es 9. - - Tipo: int, por omisión: 3. - - - - - Memcached::OPT_SERIALIZER - - - Especifica la función de serialización a utilizar para los valores no - escalares. Las funciones válidas son - Memcached::SERIALIZER_PHP, - Memcached::SERIALIZER_IGBINARY, - Memcached::SERIALIZER_JSON, - Memcached::SERIALIZER_JSON_ARRAY y - Memcached::SERIALIZER_MSGPACK. - - - Tipo: int, por omisión: Memcached::SERIALIZER_IGBINARY si está disponible, - luego Memcached::SERIALIZER_MSGPACK si está disponible, - luego Memcached::SERIALIZER_PHP. - - - - - - Memcached::SERIALIZER_PHP - - - La función de serialización por defecto de PHP. - - - - - - Memcached::SERIALIZER_IGBINARY - - - El serializador igbinary. - En lugar de una representación textual, esta función almacena las - estructuras PHP en un formato compacto y binario, con un ahorro - de tiempo y espacio. - - - Este serializador solo es soportado si memcached está configurado con - la opción y si la extensión - igbinary está cargada. - - - - - - Memcached::SERIALIZER_JSON - - El serializador JSON. Este serializador deserializa el JSON en un objeto. - - - - - Memcached::SERIALIZER_JSON_ARRAY - - - El serializador JSON en array. - Este serializador deserializa el JSON en un array asociativo. - - - - - - Memcached::SERIALIZER_MSGPACK - - - El serializador MessagePack. - - - Este serializador solo es soportado si memcached está configurado con - la opción y si la extensión - msgpack está cargada. - - - - - - Memcached::OPT_PREFIX_KEY - - - Esta opción puede ser utilizada para crear un "dominio" para las claves. - El valor especificado aquí será prefijado a cada clave. No puede ser - más largo que 128 caracteres, y reducirá en consecuencia - el tamaño máximo de clave disponible. El prefijo solo se aplica - a las claves de elemento, y no a las claves de servidor. - - Tipo: string, por omisión: "". - - - - - Memcached::OPT_HASH - - - Especifica el algoritmo de hash utilizado para las claves. Los valores válidos - son proporcionados con las constantes Memcached::HASH_*. - Cada algoritmo de hash tiene sus ventajas y desventajas. Utilice - el que se proporciona por omisión, si no comprende, o si no le importa. - - Tipo: int, por omisión: Memcached::HASH_DEFAULT - - - - - Memcached::HASH_DEFAULT - - - El algoritmo por omisión (Jenkins one-at-a-time) - de hash. - - - - - - Memcached::HASH_MD5 - - - El algoritmo de hash por MD5 - - - - - - Memcached::HASH_CRC - - - El algoritmo de hash por CRC - - - - - - Memcached::HASH_FNV1_64 - - - El algoritmo de hash por FNV1_64 - - - - - - Memcached::HASH_FNV1A_64 - - - El algoritmo de hash por FNV1_64A - - - - - - Memcached::HASH_FNV1_32 - - - El algoritmo de hash por FNV1_32 - - - - - - Memcached::HASH_FNV1A_32 - - - El algoritmo de hash por FNV1_32A - - - - - - Memcached::HASH_HSIEH - - - El algoritmo de hash por Hsieh - - - - - - Memcached::HASH_MURMUR - - - El algoritmo de hash por Murmur - - - - - - Memcached::OPT_DISTRIBUTION - - - Especifica el método de distribución de claves en los servidores. - Actualmente, esta opción soporta el módulo y el hash consistente. - El hash consistente proporciona la mejor distribución, y permite - añadir servidores al grupo con un mínimo de pérdidas de caché. - - Tipo: int, por omisión: Memcached::DISTRIBUTION_MODULA. - - - - - Memcached::DISTRIBUTION_MODULA - - - El algoritmo de distribución por módulo - - - - - - Memcached::DISTRIBUTION_CONSISTENT - - - El algoritmo de distribución por hash consistente - - - - - - Memcached::DISTRIBUTION_VIRTUAL_BUCKET - - - Algoritmo de distribución de clave de hash Virtual Bucket (también llamado vbucket). - - - - - - Memcached::OPT_LIBKETAMA_COMPATIBLE - - - Activa o no la compatibilidad con el comportamiento tipo libketama. - Cuando esta opción está activada, el algoritmo de hash es MD5, - y la distribución es el hash consistente. Esto es práctico porque - otros clientes que utilizan libketama (Python, Ruby, etc.) con - la misma configuración de servidor serán capaces de utilizar las mismas - claves, de manera transparente. - - - - Esta opción es altamente recomendada, si se quiere utilizar - el hash consistente, y es probable que esté activada por omisión en futuras versiones. - - - Tipo: bool, por omisión: &false;. - - - - - Memcached::OPT_LIBKETAMA_HASH - - - Especifica el algoritmo de hash para el mapeo del host. - - Tipo: int. - - - - - Memcached::OPT_TCP_KEEPALIVE - - - Activa el mantenimiento de la conexión TCP (keep-alive). - - Tipo: bool, por omisión: &false;. - - - - - Memcached::OPT_BUFFER_WRITES - - - Activa o no la bufferización de entrada/salida. La bufferización - hace que los comandos de almacenamiento se buffericen, en lugar de - enviarse. Cualquier acción que lea datos hace que el buffer de escritura sea enviado al servidor remoto. El cierre de la - conexión o su parada también forzarán el envío de los datos del buffer. - - Tipo: bool, por omisión: &false;. - - - - - Memcached::OPT_BINARY_PROTOCOL - - - Active esta opción para utilizar el protocolo binario. - Tenga en cuenta que no puede cambiar esta opción para - una conexión ya abierta. - - Tipo: bool, por omisión: &false;. - - - - - Memcached::OPT_NO_BLOCK - - - Activa o no los transferencias asíncronas. Este es el modo de transferencia - más rápido, para las funciones de almacenamiento. - - Tipo: bool, por omisión: &false;. - - - - - Memcached::OPT_NOREPLY - - - Activa o desactiva la ignoración del resultado de los comandos de almacenamiento - (set, add, replace, append, prepend, delete, increment, decrement, etc.). - Los comandos de almacenamiento serán enviados sin pasar tiempo esperando - una respuesta (no habría respuesta). - Los comandos de recuperación como Memcached::get - no son afectados por esta configuración. - - Tipo: bool, por omisión: &false;. - - - - - Memcached::OPT_TCP_NODELAY - - - Activa o no las conexiones sin retraso de los sockets (esto puede ser - un aumento de rendimiento en algunos entornos. - - Tipo: bool, por omisión: &false;. - - - - - Memcached::OPT_SOCKET_SEND_SIZE - - - El tamaño máximo del buffer de envío por socket, en bytes. - - - Tipo: int, por omisión: varía según la configuración de la plataforma/núcleo. - - - - - - Memcached::OPT_SOCKET_RECV_SIZE - - - El tamaño máximo del buffer de recepción por socket, en bytes. - - - Tipo: int, por omisión: varía según la configuración de la plataforma/núcleo. - - - - - - Memcached::OPT_CONNECT_TIMEOUT - - - En modo no bloqueante, esta opción configura el tiempo de espera - durante la conexión del socket, en milisegundos. - - Tipo: int, por omisión: 1000. - - - - - Memcached::OPT_RETRY_TIMEOUT - - - La duración, en segundos, de espera antes de intentar nuevamente una - conexión que ha fallado. - - Tipo: int, por omisión: 2. - - - - Memcached::OPT_DEAD_TIMEOUT - - - La duración, en segundos, de espera antes de reintentar con los servidores muertos. - 0 significa ningún reintento. - - Tipo: int, por omisión: 0. - - - - - Memcached::OPT_SEND_TIMEOUT - - - Tiempo de espera de envío para el socket, en microsegundos. En los casos - donde se utiliza un socket no bloqueante, esto permitirá tener - tiempos de espera en el envío de datos, de todos modos. - - Tipo: int, por omisión: 0. - - - - - Memcached::OPT_RECV_TIMEOUT - - - Tiempo de espera de recepción para el socket, en microsegundos. En los casos - donde se utiliza un socket no bloqueante, esto permitirá tener - tiempos de espera en la recepción de datos, de todos modos. - - Tipo: &integer;, por omisión: 0. - - - - - Memcached::OPT_POLL_TIMEOUT - - - Tiempo de espera para la consulta de conexiones, en milisegundos. - - Tipo: &integer;, por omisión: 1000. - - - - - Memcached::OPT_CACHE_LOOKUPS - - - Activa o no el caché de DNS. - - Tipo: &boolean;, por omisión: &false;. - - - - - Memcached::OPT_SERVER_FAILURE_LIMIT - - - Especifica el límite del número de fallos de conexión. El servidor será - retirado de la lista después de tantos fallos de conexión consecutivos. - - Tipo: &integer;, por omisión: 5. - - - - Memcached::OPT_SERVER_TIMEOUT_LIMIT - - - Especifica el límite de tiempo de espera para los intentos de conexión al servidor. - El servidor será eliminado después de este número de tiempos de espera continuos de conexión. - - Tipo: int, por omisión: 0. - - - - - Memcached::OPT_AUTO_EJECT_HOSTS - - - Elimina los servidores desactivados de la lista. Para utilizar con - Memcached::OPT_SERVER_FAILURE_LIMIT y - Memcached::OPT_SERVER_TIMEOUT_LIMIT. - - - - Esta opción es reemplazada por - Memcached::OPT_REMOVE_FAILED_SERVERS. - - - Tipo: bool, por omisión: &false;. - - - - - Memcached::OPT_VERIFY_KEY - - - Activa la verificación de claves por memcached. - - Tipo: bool, por omisión: &false;. - - - - - Memcached::OPT_USE_UDP - - - Utiliza UDP en lugar de TCP. - - Tipo: bool, por omisión: &false;. - - - - - Memcached::OPT_NUMBER_OF_REPLICAS - - - Almacena este número de réplicas de cada elemento en diferentes servidores. - - Tipo: int, por omisión: 0. - - - - - Memcached::OPT_RANDOMIZE_REPLICA_READS - - - Randomiza el servidor de lectura de réplica. - - Tipo: bool, por omisión: &false;. - - - - - Memcached::OPT_REMOVE_FAILED_SERVERS - - - Elimina los servidores desactivados de la lista. Para utilizar con - Memcached::OPT_SERVER_FAILURE_LIMIT y - Memcached::OPT_SERVER_TIMEOUT_LIMIT. - - Tipo: bool, por omisión: &false;. - - - - - Memcached::HAVE_IGBINARY - - - Indica si el soporte de la función de serialización - igbinary está activado. - - Tipo: bool. - - - - - Memcached::HAVE_JSON - - - Indica si la función de serialización JSON - está disponible. - - Tipo: bool. - - - - - Memcached::HAVE_MSGPACK - - Indica si el soporte del serializador msgpack está disponible. - Tipo: bool. - Disponible a partir de Memcached 3.0.0. - - - - - Memcached::HAVE_ZSTD - - Indica si la soporte de la compresión ZSTD está disponible. - Tipo: bool. - Disponible a partir de Memcached 3.3.0. - - - - - Memcached::HAVE_ENCODING - - - Indica si el cifrado de datos mediante - Memcached::setEncodingKey está soportado. - - Tipo: bool. - Disponible a partir de Memcached 3.1.0. - - - - - Memcached::HAVE_SESSION - - Tipo: bool. - Disponible a partir de Memcached 3.0.0. - - - - - Memcached::HAVE_SASL - - Tipo: bool. - Disponible a partir de Memcached 3.0.0. - - - - - Memcached::GET_EXTENDED - - - Una bandera para Memcached::get, - Memcached::getMulti y - Memcached::getMultiByKey para asegurar - que los valores del token CAS también sean devueltos. - - Disponible a partir de Memcached 3.0.0. - - - - - Memcached::GET_PRESERVE_ORDER - - Una opción para Memcached::getMulti y - Memcached::getMultiByKey para asegurar que las - claves sean devueltas en el mismo orden que su orden de solicitud. - Las claves inexistentes toman entonces el valor &null;. - - - - - - Memcached::RES_SUCCESS - - - La operación ha tenido éxito. - - - - - - Memcached::RES_FAILURE - - - La operación ha fallado, de una manera u otra. - - - - - - Memcached::RES_HOST_LOOKUP_FAILURE - - - La búsqueda DNS ha fallado. - - - - - - Memcached::RES_UNKNOWN_READ_FAILURE - - - Fallo de lectura en la red. - - - - - - Memcached::RES_PROTOCOL_ERROR - - - Comando incorrecto en el protocolo memcached. - - - - - - Memcached::RES_CLIENT_ERROR - - - Error del lado del cliente. - - - - - - Memcached::RES_SERVER_ERROR - - - Error del lado del servidor. - - - - - - Memcached::RES_WRITE_FAILURE - - - Fallo de escritura en la red. - - - - - - Memcached::RES_DATA_EXISTS - - - Fallo de comparación y intercambio: el elemento que se intenta - almacenar ha sido modificado desde la última lectura. - - - - - - Memcached::RES_NOTSTORED - - - El elemento no ha sido almacenado, pero no debido a un error. Esto es - normal, y significa que una condición para un añadido "add" o - un reemplazo "replace" no ha sido satisfecha, o - que un elemento ha sido puesto en una cola de borrado. - - - - - - Memcached::RES_NOTFOUND - - - El elemento con esta clave no ha sido encontrado (con una operación - "get" o "cas"). - - - - - - Memcached::RES_PARTIAL_READ - - - Error de lectura parcial en la red. - - - - - - Memcached::RES_SOME_ERRORS - - - Han ocurrido errores durante una lectura múltiple. - - - - - - Memcached::RES_NO_SERVERS - - - Lista de servidores vacía. - - - - - - Memcached::RES_END - - - Fin del conjunto de resultados. - - - - - - Memcached::RES_ERRNO - - - Error del sistema. - - - - - - Memcached::RES_BUFFERED - - - La operación ha sido bufferizada. - - - - - - Memcached::RES_TIMEOUT - - - El tiempo de ejecución de la operación ha expirado. - - - - - - Memcached::RES_BAD_KEY_PROVIDED - - - Clave incorrecta. - - - - - - Memcached::RES_STORED - - Elemento almacenado. - - - - - Memcached::RES_DELETED - - Elemento eliminado. - - - - - Memcached::RES_STAT - - Estadísticas. - - - - - Memcached::RES_ITEM - - Elemento. - - - - - Memcached::RES_NOT_SUPPORTED - - No soportado. - - - - - Memcached::RES_FETCH_NOTFINISHED - - Recuperación no terminada. - - - - - Memcached::RES_SERVER_MARKED_DEAD - - Servidor marcado como muerto. - - - - - Memcached::RES_UNKNOWN_STAT_KEY - - Clave de estadística desconocida. - - - - - Memcached::RES_INVALID_HOST_PROTOCOL - - Protocolo de host inválido. - - - - - Memcached::RES_MEMORY_ALLOCATION_FAILURE - - Fallo de asignación de memoria. - - - - - Memcached::RES_CONNECTION_SOCKET_CREATE_FAILURE - - No se puede crear un socket. - - - - - Memcached::RES_PAYLOAD_FAILURE - - - Fallo de procesamiento: no se puede comprimir, - descomprimir o serializar el valor. - - - - - - Memcached::RES_AUTH_PROBLEM - - Disponible a partir de Memcached 3.0.0. - - - - - Memcached::RES_AUTH_FAILURE - - Disponible a partir de Memcached 3.0.0. - - - - - Memcached::RES_AUTH_CONTINUE - - Disponible a partir de Memcached 3.0.0. - - - - - Memcached::RES_E2BIG - - Disponible a partir de Memcached 3.0.0. - - - - - Memcached::RES_KEY_TOO_BIG - - Disponible a partir de Memcached 3.0.0. - - - - - Memcached::RES_SERVER_TEMPORARILY_DISABLED - - Disponible a partir de Memcached 3.0.0. - - - - - Memcached::RES_SERVER_MEMORY_ALLOCATION_FAILURE - - Disponible a partir de Memcached 3.0.0. - - - - - - - diff --git a/reference/memcached/expiration.xml b/reference/memcached/expiration.xml deleted file mode 100644 index 27c4e87848..0000000000 --- a/reference/memcached/expiration.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - - - Tiempos de expiración - - Algunos comandos de almacenamiento implican el envío de un valor de expiración (relativo a un - ítem o a una operación solicitada por el cliente) al servidor. En todos los - casos, el valor real enviado podría ser en tiempo Unix (un valor de tipo integer con el - número de segundos transcurridos desde el 1 de enero de 1970), o el número de segundos comenzando - desde el instante actual. En este caso, el número no debe exceder - de 60*60*24*30 (que corresponde al número de segundos en 30 días); si se excede el valor - del tiempo de expiración, el servidor lo considerará como tiempo Unix en lugar del - número de segundos desde el instante actual. - - - Si el valor de la expiración es 0 (el predeterminado), el ítem - nunca caducará (aunque puede ser eliminado del servidor para hacer sitio - a otros ítems). - - - - - diff --git a/reference/memcached/ini.xml b/reference/memcached/ini.xml deleted file mode 100644 index c5d626c6d5..0000000000 --- a/reference/memcached/ini.xml +++ /dev/null @@ -1,681 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - - &ConfigureOptions; Memcached - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - memcached.sess_locking - On - INI_ALL - Disponible a partir de memcached 0.1.0. - - - memcached.sess_consistent_hash - On - INI_ALL - Disponible a partir de memcached 2.1.0. El valor por omisión es Activo a partir de memcached 3.0.0. - - - memcached.sess_binary - Off - INI_ALL - Disponible a partir de memcached 2.0.0. Reemplazado por memcached.sess_binary_protocol a partir de memcached 3.0.0. - - - memcached.sess_lock_wait - 150000 - INI_ALL - Disponible a partir de memcached 0.1.0. Eliminado a partir de memcached 3.0.0. - - - memcached.sess_prefix - memc.sess.key. - INI_ALL - Disponible a partir de memcached 0.1.0. - - - memcached.sess_number_of_replicas - 0 - INI_ALL - Disponible a partir de memcached 2.1.0. - - - memcached.sess_randomize_replica_read - Off - INI_ALL - Disponible a partir de memcached 2.1.0. - - - memcached.sess_remove_failed - On - INI_ALL - Disponible a partir de memcached 2.1.0. Reemplazado por memcached.sess_remove_failed_servers a partir de memcached 3.0.0. - - - memcached.compression_type - fastlz - INI_ALL - Disponible a partir de memcached 0.1.0. - - - memcached.compression_factor - 1.3 - INI_ALL - Disponible a partir de memcached 0.1.0. - - - memcached.compression_threshold - 2000 - INI_ALL - Disponible a partir de memcached 0.1.0. - - - memcached.serializer - igbinary - INI_ALL - Disponible a partir de memcached 0.1.0. - - - memcached.use_sasl - Off - INI_ALL - Disponible a partir de memcached 2.2.0. Eliminado a partir de memcached 3.0.0. - - - memcached.default_binary_protocol - Off - INI_ALL - Disponible a partir de memcached 3.0.0. - - - memcached.default_connect_timeout - 0 - INI_ALL - Disponible a partir de memcached 3.0.0. - - - memcached.default_consistent_hash - Off - INI_ALL - Disponible a partir de memcached 3.0.0. - - - memcached.sess_binary_protocol - On - INI_ALL - Disponible a partir de memcached 3.0.0. Reemplaza memcached.sess_binary. - - - memcached.sess_connect_timeout - 1000 - INI_ALL - Disponible a partir de memcached 2.2.0. - - - memcached.sess_consistent_hash_type - ketama - INI_ALL - Disponible a partir de memcached 3.1.0. - - - memcached.sess_lock_expire - 0 - INI_ALL - Disponible a partir de memcached 2.2.0. - - - memcached.sess_lock_retries - 5 - INI_ALL - Disponible a partir de memcached 3.0.0. - - - memcached.sess_lock_wait_max - 150 - INI_ALL - Disponible a partir de memcached 3.0.0. Por omisión a 150 a partir de memcached 3.1.0 (antes 2000). - - - memcached.sess_lock_wait_min - 150 - INI_ALL - Disponible a partir de memcached 3.0.0. Por omisión a 150 a partir de memcached 3.1.0 (antes 1000). - - - memcached.sess_persistent - Off - INI_ALL - Disponible a partir de memcached 3.0.0. - - - memcached.sess_remove_failed_servers - Off - INI_ALL - Disponible a partir de memcached 3.0.0. Reemplaza memcached.sess_remove_failed. - - - memcached.sess_server_failure_limit - 0 - INI_ALL - Disponible a partir de memcached 3.0.0. - - - memcached.sess_sasl_password - null - INI_ALL - Disponible a partir de memcached 2.2.0. - - - memcached.sess_sasl_username - null - INI_ALL - Disponible a partir de memcached 2.2.0. - - - memcached.store_retry_count - 0 - INI_ALL - - Disponible a partir de memcached 2.2.0. - Por omisión a 0 a partir de memcached 3.2.0 - (antes 2). - - - - -
    -
    - - &ini.descriptions.title; - - - - - - memcached.sess_locking - bool - - - - Utiliza los cerrojos de sesión. Los valores válidos son On y Off, el valor por omisión es On. - - - - - - memcached.sess_consistent_hash - bool - - - - Si se define como On, utiliza el hachado consistente (libketama) para la gestión de sesiones. - Cuando se utiliza el hachado consistente, se pueden añadir o eliminar nodos de caché sin perturbar las claves existentes. - El valor por omisión es On. - - - - - - memcached.sess_binary - bool - - - - Utiliza el modo binario para las sesiones memcached. Las réplicas de libmemcached solo funcionan - si el modo binario está activado. El valor por omisión es Off. - - - - - - memcached.sess_lock_wait - int - - - - La duración de espera del cerrojo de sesión en microsegundos. Tenga cuidado al definir este valor. - Los valores válidos son enteros, donde 0 se interpreta como el valor por omisión. - Los valores negativos reducen el bloqueo a un bloqueo de prueba. - El valor por omisión es 150000. - - - - - - memcached.sess_prefix - string - - - - El prefijo de clave de sesión Memcached. Los valores válidos son strings de menos de 219 bytes. - El valor por omisión es memc.sess.key. - - - - - - memcached.sess_number_of_replicas - int - - - - Escribe los datos en un cierto número de servidores Memcached adicionales. Esto es lo que libmemcached llama "pobre hombre HA". - Si este valor es positivo y sess_remove_failed_servers está activado, - cuando un servidor Memcached falle, la sesión continuará estando disponible a partir de una réplica. - Sin embargo, si el servidor Memcached en fallo vuelve a estar disponible, la sesión se leerá desde allí, - lo que podría tener datos obsoletos o ninguna información en absoluto. - El valor por omisión es 0. - - - - - - memcached.sess_randomize_replica_read - bool - - - - La sesión Memcached lee la replicación aleatoria. - - - - - - memcached.sess_remove_failed - int - - - - Permite que el servidor Memcached en fallo sea eliminado automáticamente. - - - - - - memcached.compression_type - string - - - - Define el tipo de compresión, los valores válidos son: fastlz, zlib. - El valor por omisión es fastlz. - - - - - - memcached.compression_factor - float - - - - El factor de compresión. Almacene el valor comprimido solo si el factor de compresión - (ahorro) supera el límite definido. Almacene comprimido si: - plain_len > comp_len * factor. El valor por omisión es - 1.3 (23% de ahorro de espacio). - - - - - - memcached.compression_threshold - int - - - - El umbral de compresión. No comprima los valores serializados por debajo de este umbral. - El valor por omisión es 2000 bytes. - - - - - - memcached.serializer - string - - - - Define el serializador por omisión para los nuevos objetos Memcached. Los valores válidos son: - php, igbinary, json, - json_array, msgpack. - - - - json - - - La serialización JSON estándar de PHP. Este serializador es rápido y compacto pero - solo funciona con datos codificados en UTF-8 y no implementa completamente - la serialización. Ver la extensión JSON. Disponible a partir de memcached 0.2.0. - - - - - json_array - - - Como json, pero decodifica en arrays. Disponible a partir de memcached 2.0.0. - - - - - php - - - El serializador estándar de PHP. - - - - - igbinary - - - Un serializador binario. Disponible a partir de memcached 0.1.4. - - - - - msgpack - - - Un serializador binario multi-lenguaje. Disponible a partir de memcached 2.2.0. - - - - - - El valor por omisión es igbinary si está disponible, luego msgpack si está disponible, - luego de lo contrario php. - - - - - - memcached.use_sasl - bool - - - - Utilizar la autenticación SASL para las conexiones. Los valores válidos son On y Off. - El valor por omisión es Off. - - - - - - memcached.default_binary_protocol - bool - - - - Define el protocolo memcached por omisión para las nuevas conexiones. (Para configurar el protocolo memcached para - las conexiones utilizadas por las sesiones, utilice memcached.sess_binary_protocol en su lugar.) - - Si se define como On, el protocolo binario memcached se utiliza por omisión. - Si se define como Off, el protocolo de texto memcached se utiliza. - El valor por omisión es Off. - - - - - - memcached.default_connect_timeout - int - - - - Define el tiempo de espera de conexión memcached por omisión para las nuevas conexiones. - (Para configurar el tiempo de espera de conexión memcached para las sesiones, utilice memcached.sess_connect_timeout en su lugar.) - - En modo no bloqueante, esto cambia el valor del tiempo de espera. - Durante la conexión del socket en milisegundos. - Especificar -1 significa un tiempo de espera infinito. - Especificar 0 significa utilizar el tiempo de espera de conexión por omisión de la biblioteca memcached. - El valor por omisión es 0. - - - - - - memcached.default_consistent_hash - bool - - - - Define el hachado consistente por omisión para las nuevas conexiones. - (Para configurar el hachado consistente para las conexiones utilizadas por las sesiones, - utilice memcached.sess_consistent_hash en su lugar.) - - Si se define como On, el hachado consistente (libketama) se utiliza para la - gestión de sesiones. Cuando se utiliza el hachado consistente, se pueden añadir o eliminar nodos de caché - sin perturbar las claves existentes. El valor por omisión es Off. - - - - - - memcached.sess_binary_protocol - bool - - - - Utilizar el protocolo binario memcached para las sesiones memcached en lugar del protocolo de texto. - Las réplicas de libmemcached solo funcionan si el modo binario está activado. - Sin embargo, algunos proxies (como twemproxy) solo funcionarán si el protocolo binario está desactivado. - El valor por omisión es On desde libmemcached 1.0.18. - Antes de libmemcached 1.0.18, el valor por omisión era Off. - - - - En versiones anteriores de php-memcached, este parámetro se llamaba - memcached.sess_binary. - - - - - - - memcached.sess_connect_timeout - int - - - - El valor del tiempo de espera de conexión memcached. - En modo no bloqueante, esto cambia el valor del tiempo de espera durante - la conexión del socket en milisegundos. - Especificar -1 significa un tiempo de espera infinito. - - - - - - memcached.sess_consistent_hash_type - string - - - - Tipo de hachado consistente de sesión Memcached. - Si se define como ketama, el hachado consistente (libketama) - se utiliza para la gestión de sesiones. - Si se define como ketama_weighted, el hachado consistente ponderado (libketama) - se utiliza para la gestión de sesiones. - El valor por omisión es ketama. - Antes de php-memcached 3.0, el valor por omisión era ketama_weighted. - - - - - - memcached.sess_lock_expire - int - - - - El tiempo, en segundos, antes de que un cerrojo se libere. - Definir como 0 da el comportamiento por omisión, - que es utilizar max_execution_time de PHP. - El valor por omisión es 0. - - - - - - memcached.sess_lock_retries - int - - - - El número de intentos de cerrojo de sesión, sin contar el primer intento. - El valor por omisión es 5. - - - - - - memcached.sess_lock_wait_max - int - - - - El tiempo máximo, en milisegundos, de espera entre los intentos de cerrojo de sesión. - El valor por omisión es 150. - - - - - - memcached.sess_lock_wait_min - int - - - - El tiempo mínimo, en milisegundos, de espera entre los intentos de cerrojo de sesión. - Este valor se duplica en cada nuevo intento de cerrojo hasta que - memcached.sess_lock_wait_max se alcance, después de lo cual cualquier nuevo intento tomará - memcached.sess_lock_wait_max segundos. - El valor por omisión es 150. - - - - - - memcached.sess_persistent - bool - - - - Si las conexiones memcached coinciden con el/los valor(es) de - session.save_path deben ser reutilizadas después de la ejecución del script. No utilizar - si algunos parámetros (por ejemplo, los parámetros SASL, sess_binary_protocol) serían sobrescritos entre las peticiones. - El valor por omisión es Off. - - - - - - memcached.sess_remove_failed_servers - bool - - - - Permite que el servidor Memcached en fallo sea eliminado automáticamente. - El valor por omisión es Off. - - - - En versiones anteriores de php-memcached, este parámetro se llamaba - memcached.sess_remove_failed. - - - - - - - memcached.sess_server_failure_limit - int - - - - Definir este valor para permitir la eliminación automática - del servidor después de un cierto número de intentos de conexión fallidos. - El valor por omisión es 0. - - - - - - memcached.sess_sasl_password - string - - - - La contraseña SASL de sesión. - El nombre de usuario y la contraseña deben ser definidos para activar SASL. - - - - - - memcached.sess_sasl_username - string - - - - El nombre de usuario SASL de sesión. - El nombre de usuario y la contraseña deben ser definidos para activar SASL. - - - - - - memcached.store_retry_count - int - - - - La cantidad de intentos para los comandos de almacenamiento fallidos. - Este mecanismo permite un fallo transparente hacia los servidores secundarios cuando - las operaciones set/increment/decrement/setMulti fallan en - el servidor deseado en un entorno multi-servidor. - El valor por omisión es 2. - - - - - -
    - - diff --git a/reference/memcached/memcached.xml b/reference/memcached/memcached.xml deleted file mode 100644 index 210e636922..0000000000 --- a/reference/memcached/memcached.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - La clase Memcached - Memcached - - - - -
    - &reftitle.intro; - - Representa una conexión con un servidor memcache. - -
    - - -
    - &reftitle.classsynopsis; - - - - - Memcached - - - - - Memcached - - - - &Methods; - - - - - - - - - -
    - -
    - - &reference.memcached.entities.memcached; - -
    - - diff --git a/reference/memcached/memcached/add.xml b/reference/memcached/memcached/add.xml deleted file mode 100644 index 290d3df7c2..0000000000 --- a/reference/memcached/memcached/add.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - Memcached::add - Añade un nuevo elemento bajo una nueva clave - - - - &reftitle.description; - - public boolMemcached::add - stringkey - mixedvalue - intexpiration0 - - - Memcached::add es similar a - Memcached::set, pero la operación falla si - la clave key ya existe. - - - - - &reftitle.parameters; - - - - key - - - &memcached.parameter.key; - - - - - value - - - &memcached.parameter.value; - - - - - expiration - - - &memcached.parameter.expiration; - - - - - - - - - &reftitle.returnvalues; - - &return.success; - El método Memcached::getResultCode devuelve la constante - Memcached::RES_NOTSTORED si la clave ya existe. - - - - - &reftitle.seealso; - - - Memcached::addByKey - Memcached::set - Memcached::replace - - - - - - - diff --git a/reference/memcached/memcached/addbykey.xml b/reference/memcached/memcached/addbykey.xml deleted file mode 100644 index 1456520ac0..0000000000 --- a/reference/memcached/memcached/addbykey.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - Memcached::addByKey - Añade un elemento en un servidor designado - - - - &reftitle.description; - - public boolMemcached::addByKey - stringserver_key - stringkey - mixedvalue - intexpiration0 - - - Memcached::addByKey es funcionalmente equivalente - a Memcached::add, pero la variable libre - server_key puede ser utilizada para dirigir - la clave key a un servidor específico. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - key - - - &memcached.parameter.key; - - - - - value - - - &memcached.parameter.value; - - - - - expiration - - - &memcached.parameter.expiration; - - - - - - - - - &reftitle.returnvalues; - - &return.success; - El método Memcached::getResultCode va devolver - la constante Memcached::RES_NOTSTORED si la clave ya existe. - - - - - &reftitle.seealso; - - - Memcached::add - Memcached::set - Memcached::replace - - - - - - - diff --git a/reference/memcached/memcached/addserver.xml b/reference/memcached/memcached/addserver.xml deleted file mode 100644 index 41202ef9bc..0000000000 --- a/reference/memcached/memcached/addserver.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - - Memcached::addServer - Añade un servidor al grupo - - - - &reftitle.description; - - public boolMemcached::addServer - stringhost - intport - intweight0 - - - Memcached::addServer añade el servidor indicado - al grupo de servidores. No se establece ninguna conexión en ese momento, pero - si se utiliza la clave de distribución por hash consistente (a través - de Memcached::DISTRIBUTION_CONSISTENT o - Memcached::OPT_LIBKETAMA_COMPATIBLE), ciertas estructuras - internas van a ser actualizadas. Por lo tanto, si es necesario añadir varios - servidores, se recomienda utilizar Memcached::addServers - para que la actualización ocurra una sola vez. - - - El mismo servidor puede aparecer varias veces en el grupo, ya que no se realiza - ninguna búsqueda de duplicados. Esto no es recomendado: en su lugar, utilice el - argumento weight para aumentar el peso de un servidor - en la selección. - - - - - &reftitle.parameters; - - - - host - - - El nombre de host del servidor memcache. Si el nombre de host no es válido, - las operaciones sobre los datos van a definir el código de resultado - Memcached::RES_HOST_LOOKUP_FAILURE. Desde - la versión 2.0.0b1, este argumento también puede especificar la ruta - hacia un socket Unix, por ejemplo; /ruta/hacia/memcached.sock - para utilizar el socket de dominio Unix, y en este caso, - el argumento port también debe ser definido a - 0. - - - - - port - - - El puerto en el que memcache funciona. Generalmente, es - 11211. Desde la versión 2.0.0b1, defina - este argumento a 0 cuando se utilicen sockets - de dominio Unix. - - - - - weight - - - El peso del servidor relativamente al peso total de todos los servidores. Esto - controla la probabilidad de que un servidor sea seleccionado durante las operaciones. - Esta opción solo se utiliza con la distribución consistente, y generalmente, - esto corresponde al total de memoria disponible en este servidor. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Ejemplo con <function>Memcached::addServer</function> - -addServer('mem1.domain.com', 11211, 33); -$m->addServer('mem2.domain.com', 11211, 67); -?> -]]> - - - - - - - &reftitle.seealso; - - - Memcached::addServers - Memcached::resetServerList - - - - - - - diff --git a/reference/memcached/memcached/addservers.xml b/reference/memcached/memcached/addservers.xml deleted file mode 100644 index 4172d5fb31..0000000000 --- a/reference/memcached/memcached/addservers.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - Memcached::addServers - Añade múltiples servidores al grupo - - - - &reftitle.description; - - public boolMemcached::addServers - arrayservers - - - Memcached::addServers añade los servidores - servers al grupo de servidores. Cada entrada - en servers debe ser un array, conteniendo - el nombre de host, y opcionalmente su peso. No se establece ninguna conexión - con el servidor en este momento. - - - El mismo servidor puede aparecer múltiples veces en el grupo, ya que - no se realiza ninguna verificación de duplicación. Esto no es recomendado. - En su lugar, es preferible utilizar el argumento - weight para aumentar el peso del servidor. - - - - - &reftitle.parameters; - - - - array - - - Un array de servidores a añadir. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Ejemplo con <function>Memcached::addServers</function> - -addServers($servers); -?> -]]> - - - - - - - &reftitle.seealso; - - - Memcached::addServer - Memcached::resetServerList - - - - - - - diff --git a/reference/memcached/memcached/append.xml b/reference/memcached/memcached/append.xml deleted file mode 100644 index 5c115ea4c9..0000000000 --- a/reference/memcached/memcached/append.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - - Memcached::append - Añade datos a un elemento - - - - &reftitle.description; - - public boolnullMemcached::append - stringkey - stringvalue - - - Memcached::append añade los datos de - value al final de un elemento existente. La razón por la que - value debe ser una cadena es que los otros tipos no soportan esta operación. - - - - Si la constante Memcached::OPT_COMPRESSION está activada, - la operación fallará, y se emitirá una advertencia, ya que no es posible prever - datos comprimidos. - - - - - - &reftitle.parameters; - - - - key - - - La clave del elemento a sobrescribir. - - - - - value - - - La cadena a añadir. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - Devuelve &null; si la compresión está activada. - - - - - &reftitle.errors; - - Devuelve &null; y genera un E_WARNING - si la compresión está activada. - - - - - &reftitle.examples; - - - Ejemplo con <function>Memcached::append</function> - -addServer('localhost', 11211); -$m->setOption(Memcached::OPT_COMPRESSION, false); - -$m->set('foo', 'abc'); -$m->append('foo', 'def'); -var_dump($m->get('foo')); -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - Memcached::appendByKey - Memcached::prepend - - - - - - - diff --git a/reference/memcached/memcached/appendbykey.xml b/reference/memcached/memcached/appendbykey.xml deleted file mode 100644 index ec5b63a240..0000000000 --- a/reference/memcached/memcached/appendbykey.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - Memcached::appendByKey - Añade datos a un elemento - - - - &reftitle.description; - - public boolnullMemcached::appendByKey - stringserver_key - stringkey - stringvalue - - - Memcached::appendByKey es funcionalmente equivalente - a Memcached::append, pero la variable libre - server_key puede ser utilizada para dirigir - la clave key a un servidor específico. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - key - - - La clave del elemento al que se añaden datos. - - - - - value - - - La cadena a añadir. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - Devuelve &null; si la compresión está activada. - - - - - &reftitle.errors; - - Devuelve &null; y genera un E_WARNING - si la compresión está activada. - - - - - &reftitle.seealso; - - - Memcached::append - Memcached::prepend - - - - - - - diff --git a/reference/memcached/memcached/cas.xml b/reference/memcached/memcached/cas.xml deleted file mode 100644 index 26a540264b..0000000000 --- a/reference/memcached/memcached/cas.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - Memcached::cas - Comparar y cambiar un elemento - - - - &reftitle.description; - - public boolMemcached::cas - stringintfloatcas_token - stringkey - mixedvalue - intexpiration0 - - - Memcached::cas realiza una operación de - "check and set" (literalmente, verificar y asignar), - de manera que el elemento solo se almacena si ningún otro cliente - lo ha actualizado desde que fue leído por el cliente actual. La verificación - se realiza mediante el argumento cas_token que es un - valor único de 64 bits, asignado al elemento por memcached. Consulte la documentación - de Memcached::get* para saber cómo obtener este valor. Tenga en cuenta que este valor se representa como un número flotante, debido a limitaciones en el espacio de enteros de PHP. - - - - - &reftitle.parameters; - - - - cas_token - - - Valor único asociado a un elemento existente. Generado por memcached. - - - - - key - - - &memcached.parameter.key; - - - - - value - - - &memcached.parameter.value; - - - - - expiration - - - &memcached.parameter.expiration; - - - - - - - - - &reftitle.returnvalues; - - &return.success; - El método Memcached::getResultCode va devolver - la constante Memcached::RES_DATA_EXISTS si el elemento que - se intenta almacenar ha sido modificado desde la última lectura. - - - - - &reftitle.examples; - - - Ejemplo con <function>Memcached::cas</function> - -addServer('localhost', 11211); - -do { - /* Lee una IP y su CAS */ - $ips = $m->get('ip_block', null, $cas); - /* Si la IP no existe aún, se crea y se realiza - un añadido atómico que fallará si la IP ya ha sido añadida */ - if ($m->getResultCode() == Memcached::RES_NOTFOUND) { - $ips = array($_SERVER['REMOTE_ADDR']); - $m->add('ip_block', $ips); - /* De lo contrario, se añade la IP a la lista, y se almacena con la operación - compare-and-swap y el token, que fallará si la lista ha sido actualizada */ - } else { - $ips[] = $_SERVER['REMOTE_ADDR']; - $m->cas($cas, 'ip_block', $ips); - } -} while ($m->getResultCode() != Memcached::RES_SUCCESS); - -?> -]]> - - - - - - - &reftitle.seealso; - - - Memcached::casByKey - - - - - - - diff --git a/reference/memcached/memcached/casbykey.xml b/reference/memcached/memcached/casbykey.xml deleted file mode 100644 index 934b95d422..0000000000 --- a/reference/memcached/memcached/casbykey.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - Memcached::casByKey - Comparar y cambiar un elemento en un servidor - - - - &reftitle.description; - - public boolMemcached::casByKey - stringintfloatcas_token - stringserver_key - stringkey - mixedvalue - intexpiration0 - - - Memcached::casByKey es funcionalmente equivalente - a Memcached::cas, pero la variable - server_key puede ser utilizada para dirigir - la clave key a un servidor específico. - - - - - &reftitle.parameters; - - - - cas_token - - - Valor único, asociado a un elemento existente. Generado por memcache. - - - - - server_key - - - &memcached.parameter.server_key; - - - - - key - - - &memcached.parameter.key; - - - - - value - - - &memcached.parameter.value; - - - - - expiration - - - &memcached.parameter.expiration; - - - - - - - - - &reftitle.returnvalues; - - &return.success; - El método Memcached::getResultCode va devolver - Memcached::RES_DATA_EXISTS si el elemento que se intenta - almacenar ha sido modificado desde la última lectura. - - - - - &reftitle.seealso; - - - Memcached::cas - - - - - - - diff --git a/reference/memcached/memcached/construct.xml b/reference/memcached/memcached/construct.xml deleted file mode 100644 index cefa4b905b..0000000000 --- a/reference/memcached/memcached/construct.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - Memcached::__construct - Crea un objeto Memcached - - - - &reftitle.description; - - public Memcached::__construct - stringnullpersistent_id&null; - callablenullcallback&null; - stringnullconnection_str&null; - - - Crea un objeto Memcached que representa la conexión al servidor memcache. - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - persistent_id - - - Por omisión, las instancias Memcached son destruidas al final de la - petición. Para crear un objeto que persiste entre las peticiones, utilice - el argumento persistent_id para especificar un identificador - único para la instancia. Todos los objetos creados con el mismo - identificador persistent_id compartirán la misma conexión. - - - - - callback - - - voidcallback - Memcachedmemcached - stringnullpersistent_id - - - El parámetro callback es llamado cuando se - establece la conexión. Debe ser un callable PHP válido - que reciba el objeto Memcached como su primer - parámetro, y persistent_id como el segundo. - - - - - connection_str - - - Este parámetro se utiliza para pasar opciones de conexión adicionales - a los servidores memcache, como el peso de un servidor en un clúster. - - - - - - - - - &reftitle.examples; - - - Creación de un objeto Memcached - - -]]> - - - - - - - diff --git a/reference/memcached/memcached/decrement.xml b/reference/memcached/memcached/decrement.xml deleted file mode 100644 index 42f9210d8d..0000000000 --- a/reference/memcached/memcached/decrement.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - - Memcached::decrement - Disminuye un valor numérico - - - - &reftitle.description; - - public intfalseMemcached::decrement - stringkey - intoffset1 - intinitial_value0 - intexpiry0 - - - Memcached::decrement disminuye el valor numérico - de offset unidades. Si el elemento no es numérico, - se emitirá un error. Si la operación intenta disminuir por debajo de 0, - el nuevo valor será 0. Memcached::decrement - establecerá el elemento al valor del parámetro initial_value - si la clave no existe. - - - - - &reftitle.parameters; - - - - key - - - La clave del elemento a disminuir. - - - - - offset - - - La cantidad con la que disminuir el elemento. - - - - - initial_value - - - El valor a utilizar para definir el elemento si no existe. - - - - - expiry - - - El tiempo de expiración en la definición del elemento. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el nuevo valor del elemento en caso de éxito&return.falseforfailure;. - - - - - &reftitle.examples; - - - Ejemplo con <function>Memcached::decrement</function> - -addServer('localhost', 11211); - -$m->set('counter', 5); -$n = $m->decrement('counter'); -var_dump($n); - -$n = $m->decrement('counter', 10); -var_dump($n); - -var_dump($m->get('counter')); - -$m->set('counter', 'abc'); -$n = $m->increment('counter'); -// ^ fallará debido a que el valor del elemento no es numérico -var_dump($n); -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - Memcached::increment - Memcached::incrementByKey - Memcached::decrementByKey - - - - - - - diff --git a/reference/memcached/memcached/decrementbykey.xml b/reference/memcached/memcached/decrementbykey.xml deleted file mode 100644 index 50dca6ecb7..0000000000 --- a/reference/memcached/memcached/decrementbykey.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - Memcached::decrementByKey - Disminuye un valor numérico de un elemento almacenado en un servidor específico - - - - &reftitle.description; - - public intfalseMemcached::decrementByKey - stringserver_key - stringkey - intoffset1 - intinitial_value0 - intexpiry0 - - - Memcached::decrementByKey disminuye un valor numérico - de un elemento especificando el decremento mediante el argumento offset. - Si el valor del elemento no es numérico, se generará un error. - Si la operación disminuye el valor por debajo de 0, el nuevo valor será 0. - Memcached::decrementByKey establecerá el elemento al valor - del argumento initial_value si la clave no existe. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - key - - - La clave del elemento a disminuir. - - - - - offset - - - El decremento a aplicar al valor del elemento. - - - - - initial_value - - - El valor a establecer si el elemento no existe. - - - - - expiry - - - El tiempo de expiración para la definición del elemento. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el nuevo valor del elemento en caso de éxito&return.falseforfailure;. - - - - - &reftitle.seealso; - - - Memcached::decrement - Memcached::increment - Memcached::incrementByKey - - - - - - - diff --git a/reference/memcached/memcached/delete.xml b/reference/memcached/memcached/delete.xml deleted file mode 100644 index f6c9b6b7f5..0000000000 --- a/reference/memcached/memcached/delete.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - Memcached::delete - Elimina un elemento - - - - &reftitle.description; - - public boolMemcached::delete - stringkey - inttime0 - - - Elimina el elemento representado por la clave key del servidor. - - - - - &reftitle.parameters; - - - - key - - - La clave a eliminar. - - - - - time - - - La duración de eliminación en el servidor. - - &memcached.note.delete-time; - - - - - - - - &reftitle.returnvalues; - - &return.success; - El método Memcached::getResultCode devuelve - Memcached::RES_NOTFOUND si la clave no existe. - - - - - &reftitle.examples; - - - Ejemplo con <function>Memcached::delete</function> - -addServer('localhost', 11211); - -$m->delete('key1'); -?> -]]> - - - - - - - &reftitle.seealso; - - - Memcached::deleteByKey - Memcached::deleteMulti - - - - - - - diff --git a/reference/memcached/memcached/deletebykey.xml b/reference/memcached/memcached/deletebykey.xml deleted file mode 100644 index 50526ec086..0000000000 --- a/reference/memcached/memcached/deletebykey.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - Memcached::deleteByKey - Elimina un elemento de un servidor específico - - - - &reftitle.description; - - public boolMemcached::deleteByKey - stringserver_key - stringkey - inttime0 - - - Memcached::deleteByKey es funcionalmente equivalente a - Memcached::delete, excepto por la variable libre - server_key que puede ser utilizada para dirigir la variable - key a un servidor específico. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - key - - - La clave a eliminar. - - - - - time - - - La duración de espera para la eliminación. - - &memcached.note.delete-time; - - - - - - - - &reftitle.returnvalues; - - &return.success; - El método Memcached::getResultCode devuelve - Memcached::RES_NOTFOUND si la clave no existe. - - - - - &reftitle.seealso; - - - Memcached::delete - Memcached::deleteMulti - Memcached::deleteMultiByKey - - - - - - - diff --git a/reference/memcached/memcached/deletemulti.xml b/reference/memcached/memcached/deletemulti.xml deleted file mode 100644 index 687beb6bde..0000000000 --- a/reference/memcached/memcached/deletemulti.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - Memcached::deleteMulti - Elimina varios elementos - - - - &reftitle.description; - - public arrayMemcached::deleteMulti - arraykeys - inttime0 - - - Elimina el array de claves keys del servidor. - - - - - &reftitle.parameters; - - - - keys - - - Las claves a eliminar. - - - - - time - - - El tiempo de espera del servidor para eliminar los elementos. - - &memcached.note.delete-time; - - - - - - - - &reftitle.returnvalues; - &memcached.result.delete-multi; - - - - &reftitle.seealso; - - - Memcached::delete - Memcached::deleteByKey - Memcached::deleteMultiByKey - - - - - - - diff --git a/reference/memcached/memcached/deletemultibykey.xml b/reference/memcached/memcached/deletemultibykey.xml deleted file mode 100644 index 0a4a5906cf..0000000000 --- a/reference/memcached/memcached/deletemultibykey.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - Memcached::deleteMultiByKey - Elimina varios elementos de un servidor específico - - - - &reftitle.description; - - public arrayMemcached::deleteMultiByKey - stringserver_key - arraykeys - inttime0 - - - Memcached::deleteMultiByKey es funcionalmente idéntica - al método Memcached::deleteMulti, excepto que - el argumento server_key puede ser utilizado para asociar - las claves keys con un servidor específico. - - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - keys - - - Las claves a eliminar. - - - - - time - - - El tiempo de espera del servidor antes de eliminar los elementos. - - &memcached.note.delete-time; - - - - - - - - &reftitle.returnvalues; - &memcached.result.delete-multi; - - - - &reftitle.seealso; - - - Memcached::delete - Memcached::deleteByKey - Memcached::deleteMulti - - - - - - - diff --git a/reference/memcached/memcached/fetch.xml b/reference/memcached/memcached/fetch.xml deleted file mode 100644 index 5e45d87faf..0000000000 --- a/reference/memcached/memcached/fetch.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - Memcached::fetch - Lee el siguiente resultado - - - - &reftitle.description; - - public arrayfalseMemcached::fetch - - - - Memcached::fetch lee el siguiente resultado de la última - petición. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el siguiente resultado, o bien &false; en caso contrario. - El método Memcached::getResultCode va devolver - Memcached::RES_END si el conjunto de resultados ha finalizado. - - - - - &reftitle.examples; - - - Ejemplo con <function>Memcached::fetch</function> - -addServer('localhost', 11211); - -$m->set('int', 99); -$m->set('string', 'a simple string'); -$m->set('array', array(11, 12)); - -$m->getDelayed(array('int', 'array'), true); -while ($result = $m->fetch()) { - var_dump($result); -} -?> -]]> - - &example.outputs.similar; - - - string(3) "int" - ["value"]=> - int(99) - ["cas"]=> - float(2363) -} -array(3) { - ["key"]=> - string(5) "array" - ["value"]=> - array(2) { - [0]=> - int(11) - [1]=> - int(12) - } - ["cas"]=> - float(2365) -} -]]> - - - - - - - &reftitle.seealso; - - - Memcached::fetchAll - Memcached::getDelayed - - - - - - - diff --git a/reference/memcached/memcached/fetchall.xml b/reference/memcached/memcached/fetchall.xml deleted file mode 100644 index 575e61b519..0000000000 --- a/reference/memcached/memcached/fetchall.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - - Memcached::fetchAll - Lee todos los demás elementos - - - - &reftitle.description; - - public arrayfalseMemcached::fetchAll - - - - Memcached::fetchAll lee todos los elementos de la - última petición. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve los resultados&return.falseforfailure;. - Utilice Memcached::getResultCode si es necesario. - - - - - &reftitle.examples; - - - Ejemplo con <function>Memcached::fetchAll</function> - -addServer('localhost', 11211); - -$m->set('int', 99); -$m->set('string', 'a simple string'); -$m->set('array', array(11, 12)); - -$m->getDelayed(array('int', 'array'), true); -var_dump($m->fetchAll()); -?> -]]> - - &example.outputs; - - - array(3) { - ["key"]=> - string(3) "int" - ["value"]=> - int(99) - ["cas"]=> - float(2363) - } - [1]=> - array(3) { - ["key"]=> - string(5) "array" - ["value"]=> - array(2) { - [0]=> - int(11) - [1]=> - int(12) - } - ["cas"]=> - float(2365) - } -} -]]> - - - - - - - &reftitle.seealso; - - - Memcached::fetch - Memcached::getDelayed - - - - - - - diff --git a/reference/memcached/memcached/flush.xml b/reference/memcached/memcached/flush.xml deleted file mode 100644 index 2e0999071a..0000000000 --- a/reference/memcached/memcached/flush.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - Memcached::flush - Invalida todos los elementos del caché - - - - &reftitle.description; - - public boolMemcached::flush - intdelay0 - - - Memcached::flush invalida todos los elementos del caché, - inmediatamente (por omisión), o después de un retraso de delay - segundos. Tras una invalidación, ningún elemento será devuelto en respuesta - a una orden de lectura (a menos que se almacene nuevamente bajo la misma clave, - después de la operación de Memcached::flush). - Esta operación no libera la memoria ocupada por los elementos - existentes: esto se realizará gradualmente, con el almacenamiento de los nuevos - elementos. - - - - - &reftitle.parameters; - - - - delay - - - El número de segundos de espera antes de la invalidación. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - &memcached.result.getresultcode; - - - - - &reftitle.examples; - - - Ejemplo con <function>Memcached::flush</function> - -addServer('localhost', 11211); - -/* invalida todos los elementos en 10 segundos */ -$m->flush(10); -?> -]]> - - - - - - - - diff --git a/reference/memcached/memcached/get.xml b/reference/memcached/memcached/get.xml deleted file mode 100644 index 2fa25f8d87..0000000000 --- a/reference/memcached/memcached/get.xml +++ /dev/null @@ -1,181 +0,0 @@ - - - - - - - Memcached::get - Lee un elemento - - - - &reftitle.description; - - public mixedMemcached::get - stringkey - callablenullcache_cb&null; - intget_flags0 - - - Memcached::get lee un elemento que ha sido almacenado previamente - con la clave key. Si el elemento es encontrado, y que - get_flags es proporcionado Memcached::GET_EXTENDED, - el valor del token CAS del elemento también será retornado. - Ver Memcached::cas para saber cómo utilizar los - tokens CAS. Una función de retrollamada en caso de ausencia puede ser - especificada con el parámetro cache_cb. - - - - - - - &reftitle.parameters; - - - - key - - - La clave del elemento a leer. - - - - - cache_cb - - - Una función de retrollamada en caso de ausencia o &null;. - - - - - get_flags - - - Bandera para controlar el resultado retornado. - Cuando Memcached::GET_EXTENDED - es proporcionada, la función retornará también el token CAS. - - - - - - - - - &reftitle.returnvalues; - - Retorna el valor almacenado en la caché, o bien &false; en caso contrario. - Si get_flags es definido a - Memcached::GET_EXTENDED, un &array; conteniendo - el valor y el token CAS es retornado en lugar de solo el valor. - El método Memcached::getResultCode retorna - Memcached::RES_NOTFOUND si la clave no existe. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL memcached 3.0.0 - - El parámetro cas_tokens ha sido eliminado. - Memcached::GET_EXTENDED ha sido añadida y cuando es pasada - como bandera asegura que los tokens CAS sean recuperados. - - - - - - - - - &reftitle.examples; - - - Ejemplo con <function>Memcached::get</function> 1 - -addServer('localhost', 11211); - -$m->set('foo', 100); -var_dump($m->get('foo')); -?> -]]> - - &example.outputs; - - - - - - Ejemplo con <function>Memcached::get</function> 2 - -addServer('localhost', 11211); - -if (!($ip = $m->get('ip_block'))) { - if ($m->getResultCode() == Memcached::RES_NOTFOUND) { - $ip = array(); - $m->set('ip_block', $ip); - } else { - /* log error */ - /* ... */ - } -} -?> -]]> - - - - - - - &reftitle.seealso; - - - Memcached::getByKey - Memcached::getMulti - Memcached::getDelayed - - - - - - - diff --git a/reference/memcached/memcached/getallkeys.xml b/reference/memcached/memcached/getallkeys.xml deleted file mode 100644 index 8232fcf531..0000000000 --- a/reference/memcached/memcached/getallkeys.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - Memcached::getAllKeys - Recupera todas las claves almacenadas en todos los servidores - - - - &reftitle.description; - - public arrayfalseMemcached::getAllKeys - - - - Memcached::getAllKeys consulta cada servidor memcache - y recupera un array que contiene todas las claves almacenadas en cada uno de ellos. - No se trata de una operación atómica, por lo que no proporciona una imagen - realmente consistente de las claves en el instante dado. Dado que memcache - no garantiza devolver todas las claves, no puede asegurarse de que todas las claves - hayan sido devueltas. - - - - Este método está destinado a fines de depuración y no debe utilizarse a gran escala. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve las claves almacenadas en todos los servidores en caso - de éxito&return.falseforfailure;. - - - - - - diff --git a/reference/memcached/memcached/getbykey.xml b/reference/memcached/memcached/getbykey.xml deleted file mode 100644 index fba56df95d..0000000000 --- a/reference/memcached/memcached/getbykey.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - - Memcached::getByKey - Lee un elemento en un servidor específico - - - - &reftitle.description; - - public mixedMemcached::getByKey - stringserver_key - stringkey - callablenullcache_cb&null; - intget_flags0 - - - Memcached::getByKey es funcionalmente equivalente a - Memcached::get, excepto que la variable libre - server_key puede ser utilizada para dirigir la clave - key a un servidor específico. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - key - - - La clave del elemento a leer. - - - - - cache_cb - - - Función de retrollamada en caso de ausencia, o &null; - - - - - get_flags - - - Bandera para controlar el resultado devuelto. - Cuando Memcached::GET_EXTENDED - es proporcionada, la función devolverá también el token CAS. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor almacenado en la caché, o &false; en caso contrario. - El método Memcached::getResultCode devuelve - Memcached::RES_NOTFOUND si la clave no existe. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL memcached 3.0.0 - - El parámetro cas_tokens ha sido eliminado. - Memcached::GET_EXTENDED ha sido añadida y cuando se pasa - como bandera asegura que los tokens CAS sean recuperados. - - - - - - - - - &reftitle.seealso; - - - Memcached::get - Memcached::getMulti - Memcached::getDelayed - - - - - - - diff --git a/reference/memcached/memcached/getdelayed.xml b/reference/memcached/memcached/getdelayed.xml deleted file mode 100644 index 1536639ce9..0000000000 --- a/reference/memcached/memcached/getdelayed.xml +++ /dev/null @@ -1,160 +0,0 @@ - - - - - - - Memcached::getDelayed - Lee varios elementos - - - - &reftitle.description; - - public boolMemcached::getDelayed - arraykeys - boolwith_cas&false; - callablenullvalue_cb&null; - - - Memcached::getDelayed envía una orden a memcache para - leer varias claves que se especifican en el array keys. - El método no espera la respuesta y devuelve inmediatamente. Cuando se esté - listo para leer los elementos, se llaman los métodos Memcached::fetch o - Memcached::fetchAll. Si with_cas - es &true; también se leerá el CAS. - - - En lugar de leer los resultados explícitamente, se puede especificar una - función de devolución de llamada de resultados mediante - el argumento value_cb. - - - - - &reftitle.parameters; - - - - keys - - - Un array de claves a leer. - - - - - with_cas - - - Si se deben leer los CAS. - - - - - value_cb - - - Una función de devolución de llamada de resultados, o &null;. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - &memcached.result.getresultcode; - - - - - &reftitle.examples; - - - Ejemplo con <function>Memcached::getDelayed</function> - -addServer('localhost', 11211); - -$m->set('int', 99); -$m->set('string', 'a simple string'); -$m->set('array', array(11, 12)); - -$m->getDelayed(array('int', 'array'), true); -var_dump($m->fetchAll()); -?> -]]> - - &example.outputs; - - - array(3) { - ["key"]=> - string(3) "int" - ["value"]=> - int(99) - ["cas"]=> - float(2363) - } - [1]=> - array(3) { - ["key"]=> - string(5) "array" - ["value"]=> - array(2) { - [0]=> - int(11) - [1]=> - int(12) - } - ["cas"]=> - float(2365) - } -} -]]> - - - - - - - &reftitle.seealso; - - - Memcached::getDelayedByKey - Memcached::fetch - Memcached::fetchAll - - - - - - - diff --git a/reference/memcached/memcached/getdelayedbykey.xml b/reference/memcached/memcached/getdelayedbykey.xml deleted file mode 100644 index 1a6c1118ed..0000000000 --- a/reference/memcached/memcached/getdelayedbykey.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - Memcached::getDelayedByKey - Lee varios elementos en un servidor - - - - &reftitle.description; - - public boolMemcached::getDelayedByKey - stringserver_key - arraykeys - boolwith_cas&false; - callablenullvalue_cb&null; - - - Memcached::getDelayedByKey es funcionalmente equivalente - a Memcached::getDelayed, pero la variable libre - server_key puede ser utilizada para dirigir - la clave key a un servidor específico. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - keys - - - Un array de claves a leer. - - - - - with_cas - - - Si también se deben leer los CAS. - - - - - value_cb - - - Una función de retrollamada de resultados, o &null;. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - &memcached.result.getresultcode; - - - - - &reftitle.seealso; - - - Memcached::getDelayed - Memcached::fetch - Memcached::fetchAll - - - - - - - diff --git a/reference/memcached/memcached/getmulti.xml b/reference/memcached/memcached/getmulti.xml deleted file mode 100644 index bdfa2adb2d..0000000000 --- a/reference/memcached/memcached/getmulti.xml +++ /dev/null @@ -1,304 +0,0 @@ - - - - - - - Memcached::getMulti - Lee varios elementos - - - - &reftitle.description; - - public arrayfalseMemcached::getMulti - arraykeys - intget_flags0 - - - Memcached::getMulti es similar al método - Memcached::get, pero en lugar de un solo elemento, - puede leer varios elementos especificados por el array - keys. - - - Antes de la v3.0, un segundo argumento - cas_tokens era utilizado. - Era rellenado con los valores de los tokens CAS para los elementos encontrados. - El parámetro cas_tokens fue eliminado - en la v3.0 de la extensión. - Fue reemplazado por un nuevo flag Memcached::GET_EXTENDED - que debe ser utilizado como valor para get_flags. - - - - - El parámetro get_flags sirve para especificar opciones - adicionales para Memcached::getMulti. - Memcached::GET_PRESERVE_ORDER garantiza que las - claves son devueltas en el mismo orden que el de su solicitud. - Memcached::GET_EXTENDED garantiza que los - tokens CAS serán también recuperados. - - - - - &reftitle.parameters; - - - - keys - - - Un array de claves a leer. - - - - - get_flags - - - Las opciones para esta operación. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un array de elementos leídos&return.falseforfailure;. - &memcached.result.getresultcode; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL memcached 3.0.0 - - El parámetro cas_tokens fue eliminado. - Memcached::GET_EXTENDED fue añadido y cuando se pasa - como flag asegura que los tokens CAS son recuperados. - - - - - - - - - &reftitle.examples; - - - Ejemplo de <function>Memcached::getMulti</function> para Memcached v3 - -addServer('localhost', 11211); - -$items = array( - 'key1' => 'value1', - 'key2' => 'value2', - 'key3' => 'value3' -); -$m->setMulti($items); -$result = $m->getMulti(array('key1', 'key3', 'badkey')); -var_dump($result); -?> -]]> - - &example.outputs.similar; - - - string(6) "value1" - ["key3"]=> - string(6) "value3" -} -]]> - - - - - - - Ejemplo de <function>Memcached::getMulti</function> para Memcached v1 y v2 - -addServer('localhost', 11211); - -$items = array( - 'key1' => 'value1', - 'key2' => 'value2', - 'key3' => 'value3' -); -$m->setMulti($items); -$result = $m->getMulti(array('key1', 'key3', 'badkey'), $cas); -var_dump($result, $cas); -?> -]]> - - &example.outputs.similar; - - - string(6) "value1" - ["key3"]=> - string(6) "value3" -} -array(2) { - ["key1"]=> - float(2360) - ["key3"]=> - float(2362) -} -]]> - - - - - - Ejemplo de <constant>Memcached::GET_PRESERVE_ORDER</constant> para Memcached v3 - -addServer('localhost', 11211); - -$data = array( - 'foo' => 'foo-data', - 'bar' => 'bar-data', - 'baz' => 'baz-data', - 'lol' => 'lol-data', - 'kek' => 'kek-data', -); - -$m->setMulti($data, 3600); - -$keys = array_keys($data); -$keys[] = 'zoo'; -$got = $m->getMulti($keys, Memcached::GET_PRESERVE_ORDER); - -foreach ($got as $k => $v) { - echo "$k $v\n"; -} -?> -]]> - - &example.outputs.similar; - - - - - - - - - Ejemplo de <constant>Memcached::GET_PRESERVE_ORDER</constant> para Memcached v1 y v2 - -addServer('localhost', 11211); - -$data = array( - 'foo' => 'foo-data', - 'bar' => 'bar-data', - 'baz' => 'baz-data', - 'lol' => 'lol-data', - 'kek' => 'kek-data', -); - -$m->setMulti($data, 3600); - -$null = null; -$keys = array_keys($data); -$keys[] = 'zoo'; -$got = $m->getMulti($keys, $null, Memcached::GET_PRESERVE_ORDER); - -foreach ($got as $k => $v) { - echo "$k $v\n"; -} -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Memcached::getMultiByKey - Memcached::get - Memcached::getDelayed - - - - - - - diff --git a/reference/memcached/memcached/getmultibykey.xml b/reference/memcached/memcached/getmultibykey.xml deleted file mode 100644 index 1d0c593429..0000000000 --- a/reference/memcached/memcached/getmultibykey.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - - Memcached::getMultiByKey - Lee varios elementos de un servidor específico - - - - &reftitle.description; - - public arrayfalseMemcached::getMultiByKey - stringserver_key - arraykeys - intget_flags0 - - - Memcached::getMultiByKey es funcionalmente equivalente - a Memcached::getMulti, pero la variable libre - server_key puede ser utilizada para dirigir - la clave key a un servidor específico. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - keys - - - Un array de claves a leer. - - - - - get_flags - - - Las opciones de la operación. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el array de elementos encontrados&return.falseforfailure;. - &memcached.result.getresultcode; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL memcached 3.0.0 - - El parámetro cas_tokens ha sido eliminado. - Memcached::GET_EXTENDED ha sido añadida y cuando se pasa - como flag asegura que los tokens CAS sean recuperados. - - - - - - - - - &reftitle.seealso; - - - Memcached::getMulti - Memcached::get - Memcached::getDelayed - - - - - - - diff --git a/reference/memcached/memcached/getoption.xml b/reference/memcached/memcached/getoption.xml deleted file mode 100644 index 4772433119..0000000000 --- a/reference/memcached/memcached/getoption.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - Memcached::getOption - Lee una opción Memcached - - - - &reftitle.description; - - public mixedMemcached::getOption - intoption - - - Devuelve el valor de la opción Memcached - option. Estas opciones están definidas por - libmemcached, y otras son específicas de esta extensión. - Véase constantes Memcached - para más información. - - - - - &reftitle.parameters; - - - - option - - - Una de las constantes Memcached::OPT_*. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor de la opción solicitada, o - bien &false; si ocurre un error. - - - - - &reftitle.examples; - - - Lectura de opciones Memcached - -getOption(Memcached::OPT_COMPRESSION)); -var_dump($m->getOption(Memcached::OPT_POLL_TIMEOUT)); -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Memcached::getOption - Memcached::setOption - Constantes Memcached - - - - - - - diff --git a/reference/memcached/memcached/getresultcode.xml b/reference/memcached/memcached/getresultcode.xml deleted file mode 100644 index d9dc33abec..0000000000 --- a/reference/memcached/memcached/getresultcode.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - Memcached::getResultCode - Devuelve el código de resultado de la última operación - - - - &reftitle.description; - - public intMemcached::getResultCode - - - - Memcached::getResultCode devuelve una de las constantes - Memcached::RES_* que indica el estado del resultado - de la última operación. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El código de resultado de la última operación Memcached. - - - - - &reftitle.examples; - - - Ejemplo con <function>Memcached::getResultCode</function> - -addServer('localhost', 11211); - -$m->add('foo', 'bar'); -if ($m->getResultCode() == Memcached::RES_NOTSTORED) { - /* ... */ -} -?> -]]> - - - - - - - - diff --git a/reference/memcached/memcached/getresultmessage.xml b/reference/memcached/memcached/getresultmessage.xml deleted file mode 100644 index 6d75dc4eb6..0000000000 --- a/reference/memcached/memcached/getresultmessage.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - Memcached::getResultMessage - Devuelve un mensaje que describe el resultado de la última operación - - - - &reftitle.description; - - public stringMemcached::getResultMessage - - - - Memcached::getResultMessage devuelve un string que - describe el código de resultado de la última operación Memcached ejecutada. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Mensaje que describe el resultado de la última operación Memcached. - - - - - &reftitle.examples; - - - Ejemplo con <function>Memcached::getResultMessage</function> - -addServer('localhost', 11211); - -$m->add('foo', 'bar'); // Éxito la primera vez -$m->add('foo', 'bar'); -echo $m->getResultMessage(),"\n"; -?> -]]> - - &example.outputs; - - - - - - - - - - diff --git a/reference/memcached/memcached/getserverbykey.xml b/reference/memcached/memcached/getserverbykey.xml deleted file mode 100644 index 3eb6b6c47b..0000000000 --- a/reference/memcached/memcached/getserverbykey.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - - Memcached::getServerByKey - Dirige una clave a un servidor - - - - &reftitle.description; - - public arrayfalseMemcached::getServerByKey - stringserver_key - - - Memcached::getServerByKey devuelve el servidor que debería - ser seleccionado por una clave server_key en las - operaciones de tipo Memcached::*ByKey. - - - - - &reftitle.parameters; - - - - server_key - - - La clave de identificación del servidor. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un array que contiene 3 claves: host, - port, y weight en caso de éxito - &return.falseforfailure;. - &memcached.result.getresultcode; - - - - - &reftitle.examples; - - - Ejemplo con <function>Memcached::getServerByKey</function> - -addServers(array( - array('mem1.domain.com', 11211, 40), - array('mem2.domain.com', 11211, 40), - array('mem3.domain.com', 11211, 20), -)); - -$m->setOption(Memcached::OPT_LIBKETAMA_COMPATIBLE, true); - -var_dump($m->getServerByKey('user')); -var_dump($m->getServerByKey('log')); -var_dump($m->getServerByKey('ip')); -?> -]]> - - &example.outputs.similar; - - - string(15) "mem3.domain.com" - ["port"]=> - int(11211) - ["weight"]=> - int(20) -} -array(3) { - ["host"]=> - string(15) "mem2.domain.com" - ["port"]=> - int(11211) - ["weight"]=> - int(40) -} -array(3) { - ["host"]=> - string(15) "mem2.domain.com" - ["port"]=> - int(11211) - ["weight"]=> - int(40) -} -]]> - - - - - - - - diff --git a/reference/memcached/memcached/getserverlist.xml b/reference/memcached/memcached/getserverlist.xml deleted file mode 100644 index 3a36bcbbc0..0000000000 --- a/reference/memcached/memcached/getserverlist.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - Memcached::getServerList - Lista los servidores del pool memcached - - - - &reftitle.description; - - public arrayMemcached::getServerList - - - - Memcached::getServerList devuelve la lista de todos los servidores - que están en su lista. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La lista de todos los servidores del pool. - - - - - &reftitle.examples; - - - Ejemplo con <function>Memcached::getServerList</function> - -addServers(array( - array('mem1.domain.com', 11211, 20), - array('mem2.domain.com', 11311, 80), -)); -var_dump($m->getServerList()); -?> -]]> - - &example.outputs; - - - array(3) { - ["host"]=> - string(15) "mem1.domain.com" - ["port"]=> - int(11211) - ["weight"]=> - int(20) - } - [1]=> - array(3) { - ["host"]=> - string(15) "mem2.domain.com" - ["port"]=> - int(11311) - ["weight"]=> - int(80) - } -} -]]> - - - - - - - - diff --git a/reference/memcached/memcached/getstats.xml b/reference/memcached/memcached/getstats.xml deleted file mode 100644 index 131271aeed..0000000000 --- a/reference/memcached/memcached/getstats.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - - Memcached::getStats - Lee estadísticas del grupo de servidores - - - - &reftitle.description; - - public arrayfalseMemcached::getStats - stringnulltype&null; - - - Memcached::getStats devuelve un array que contiene - el estado de todas las máquinas en funcionamiento. Consúltese el - protocolo memcached para - más detalles sobre estas estadísticas. - - - - - &reftitle.parameters; - - - - type - - - El tipo de estadísticas a recuperar. - - - - - - - - - &reftitle.returnvalues; - - Un array de estadísticas de servidores, una entrada por servidor, &return.falseforfailure;. - - - - - &reftitle.examples; - - - Ejemplo con <function>Memcached::getStats</function> - -addServer('localhost', 11211); - -print_r($m->getStats()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [pid] => 4933 - [uptime] => 786123 - [threads] => 1 - [time] => 1233868010 - [pointer_size] => 32 - [rusage_user_seconds] => 0 - [rusage_user_microseconds] => 140000 - [rusage_system_seconds] => 23 - [rusage_system_microseconds] => 210000 - [curr_items] => 145 - [total_items] => 2374 - [limit_maxbytes] => 67108864 - [curr_connections] => 2 - [total_connections] => 151 - [connection_structures] => 3 - [bytes] => 20345 - [cmd_get] => 213343 - [cmd_set] => 2381 - [get_hits] => 204223 - [get_misses] => 9120 - [evictions] => 0 - [bytes_read] => 9092476 - [bytes_written] => 15420512 - [version] => 1.2.6 - ) - -) -]]> - - - - - - - - diff --git a/reference/memcached/memcached/getversion.xml b/reference/memcached/memcached/getversion.xml deleted file mode 100644 index 7534c6d2f9..0000000000 --- a/reference/memcached/memcached/getversion.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - Memcached::getVersion - Lee las informaciones de versión del pool de servidores - - - - &reftitle.description; - - public arrayfalseMemcached::getVersion - - - - Memcached::getVersion devuelve un array que contiene - las informaciones de versión disponibles de todos los servidores memcache. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Array de versiones de servidores, una por servidor. - - - - - &reftitle.examples; - - - Ejemplo con <function>Memcached::getVersion</function> - -addServer('localhost', 11211); - -print_r($m->getVersion()); -?> -]]> - - &example.outputs.similar; - - 1.2.6 -) -]]> - - - - - - - - diff --git a/reference/memcached/memcached/increment.xml b/reference/memcached/memcached/increment.xml deleted file mode 100644 index 58c1471e21..0000000000 --- a/reference/memcached/memcached/increment.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - - Memcached::increment - Incrementa numéricamente un elemento - - - - &reftitle.description; - - public intfalseMemcached::increment - stringkey - intoffset1 - intinitial_value0 - intexpiry0 - - - Memcached::increment incrementa el valor numérico - de offset unidades. Si el elemento no es numérico, - se generará un error. Memcached::increment establecerá - el elemento al valor del argumento initial_value si la - clave no existe. - - - - - &reftitle.parameters; - - - - key - - - La clave del elemento a incrementar. - - - - - offset - - - La cantidad con la que aumentar el elemento. - - - - - initial_value - - - El valor a utilizar para definir el elemento si no existe. - - - - - expiry - - - El tiempo de expiración para definir el elemento. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el nuevo valor del elemento, en caso de éxito&return.falseforfailure;. - - - - - &reftitle.examples; - - - Ejemplo con <function>Memcached::increment</function> - -addServer('localhost', 11211); - -$m->set('counter', 0); -$m->increment('counter'); -$n = $m->increment('counter', 10); -var_dump($n); - -$m->set('counter', 'abc'); -$n = $m->increment('counter'); -// ^ fallará debido a que el valor del elemento no es numérico -var_dump($n); -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - Memcached::decrement - Memcached::decrementByKey - Memcached::incrementByKey - - - - - - - diff --git a/reference/memcached/memcached/incrementbykey.xml b/reference/memcached/memcached/incrementbykey.xml deleted file mode 100644 index 6c88737180..0000000000 --- a/reference/memcached/memcached/incrementbykey.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - Memcached::incrementByKey - Incrementa un valor numérico de un elemento almacenado en un servidor específico - - - - &reftitle.description; - - public intfalseMemcached::incrementByKey - stringserver_key - stringkey - intoffset1 - intinitial_value0 - intexpiry0 - - - Memcached::incrementByKey incrementa un valor numérico - de un elemento especificando el incremento mediante el argumento offset. - Si el valor del elemento no es numérico, se emitirá un error. - Memcached::incrementByKey establecerá el elemento al valor - del argumento initial_value si la clave no existe. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - key - - - La clave del elemento a incrementar. - - - - - offset - - - El incremento a utilizar sobre el valor del elemento. - - - - - initial_value - - - El valor a establecer si el elemento no existe. - - - - - expiry - - - El tiempo de expiración para la definición del elemento. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el nuevo valor del elemento en caso de éxito&return.falseforfailure;. - - - - - &reftitle.seealso; - - - Memcached::decrement - Memcached::decrementByKey - Memcached::increment - - - - - - - diff --git a/reference/memcached/memcached/ispersistent.xml b/reference/memcached/memcached/ispersistent.xml deleted file mode 100644 index d9bacefe3d..0000000000 --- a/reference/memcached/memcached/ispersistent.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - Memcached::isPersistent - Verifica si una conexión persistente hacia memcache está en uso - - - - &reftitle.description; - - public boolMemcached::isPersistent - - - - Memcached::isPersistent verifica si las conexiones - a los servidores memcache son conexiones persistentes. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si la instancia Memcache utiliza una conexión persistente, - &false; en caso contrario. - - - - - &reftitle.seealso; - - - Memcached::isPristine - - - - - - - diff --git a/reference/memcached/memcached/ispristine.xml b/reference/memcached/memcached/ispristine.xml deleted file mode 100644 index 3caa025e59..0000000000 --- a/reference/memcached/memcached/ispristine.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Memcached::isPristine - Verifica si la instancia ha sido creada recientemente - - - - &reftitle.description; - - public boolMemcached::isPristine - - - - Memcached::isPristine verifica si la instancia Memcache - ha sido creada recientemente. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si la instancia ha sido creada recientemente, &false; en caso contrario. - - - - - &reftitle.seealso; - - - Memcached::isPersistent - - - - - - - diff --git a/reference/memcached/memcached/prepend.xml b/reference/memcached/memcached/prepend.xml deleted file mode 100644 index e7c2191cea..0000000000 --- a/reference/memcached/memcached/prepend.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - - Memcached::prepend - Prefijo de datos a un elemento existente - - - - &reftitle.description; - - public boolnullMemcached::prepend - stringkey - stringvalue - - - Memcached::prepend añade los datos de - value al principio de un elemento existente. La razón por la que - value debe ser un string es que los otros tipos no soportan esta operación. - - - - Si la constante Memcached::OPT_COMPRESSION está activada, - la operación fallará y se emitirá una advertencia, ya que no es posible prependear datos comprimidos. - - - - - - &reftitle.parameters; - - - - key - - - La clave del elemento a prependear. - - - - - value - - - El string a prependear. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - Devuelve &null; si la compresión está activada. - - - - - &reftitle.errors; - - Devuelve &null; y genera un E_WARNING - si la compresión está activada. - - - - - &reftitle.examples; - - - Ejemplo con <function>Memcached::prepend</function> - -addServer('localhost', 11211); -$m->setOption(Memcached::OPT_COMPRESSION, false); - -$m->set('foo', 'abc'); -$m->prepend('foo', 'def'); -var_dump($m->get('foo')); -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - Memcached::prependByKey - Memcached::append - - - - - - - diff --git a/reference/memcached/memcached/prependbykey.xml b/reference/memcached/memcached/prependbykey.xml deleted file mode 100644 index 0b63302d65..0000000000 --- a/reference/memcached/memcached/prependbykey.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - Memcached::prependByKey - Prefija un elemento existente - - - - &reftitle.description; - - public boolnullMemcached::prependByKey - stringserver_key - stringkey - stringvalue - - - Memcached::prependByKey es funcionalmente equivalente - a Memcached::prepend, pero la variable libre - server_key puede ser utilizada para dirigir - la clave key a un servidor específico. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - key - - - La clave del elemento a prefijar. - - - - - value - - - La cadena a prefijar. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - Devuelve &null; si la compresión está activada. - - - - - &reftitle.errors; - - Devuelve &null; y lanza un E_WARNING - si la compresión está activada. - - - - - &reftitle.seealso; - - - Memcached::prepend - Memcached::append - - - - - - - diff --git a/reference/memcached/memcached/quit.xml b/reference/memcached/memcached/quit.xml deleted file mode 100644 index a8a4929e8c..0000000000 --- a/reference/memcached/memcached/quit.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - Memcached::quit - Cierra todas las conexiones abiertas - - - - &reftitle.description; - - public boolMemcached::quit - - - - Memcached::quit cierra todas las conexiones - abiertas con los servidores memcache. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/memcached/memcached/replace.xml b/reference/memcached/memcached/replace.xml deleted file mode 100644 index 6097ecece9..0000000000 --- a/reference/memcached/memcached/replace.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - Memcached::replace - Remplaza un elemento bajo una clave - - - - &reftitle.description; - - public boolMemcached::replace - stringkey - mixedvalue - intexpiration0 - - - Memcached::replace es similar a - Memcached::set, pero la operación fallará - si la clave key no existe en el servidor. - - - - - &reftitle.parameters; - - - - key - - - &memcached.parameter.key; - - - - - value - - - &memcached.parameter.value; - - - - - expiration - - - &memcached.parameter.expiration; - - - - - - - - - &reftitle.returnvalues; - - &return.success; - El método Memcached::getResultCode devuelve - Memcached::RES_NOTFOUND si la clave no existe. - - - - - &reftitle.seealso; - - - Memcached::replaceByKey - Memcached::set - Memcached::add - - - - - - - diff --git a/reference/memcached/memcached/replacebykey.xml b/reference/memcached/memcached/replacebykey.xml deleted file mode 100644 index c9939454d6..0000000000 --- a/reference/memcached/memcached/replacebykey.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - Memcached::replaceByKey - Remplaza un elemento específico en un servidor designado - - - - &reftitle.description; - - public boolMemcached::replaceByKey - stringserver_key - stringkey - mixedvalue - intexpiration0 - - - Memcached::replaceByKey es funcionalmente equivalente - a la función Memcached::replace, con la excepción de que - la variable libre server_key puede ser utilizada para dirigir la - clave key hacia un servidor específico. Esto es útil si se desea - mantener un grupo de variables agrupadas en un servidor. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - key - - - &memcached.parameter.key; - - - - - value - - - &memcached.parameter.value; - - - - - expiration - - - &memcached.parameter.expiration; - - - - - - - - - &reftitle.returnvalues; - - &return.success; - El método Memcached::getResultCode va devolver - Memcached::RES_NOTSTORED si la clave no existe. - - - - - &reftitle.seealso; - - - Memcached::replace - Memcached::set - Memcached::add - - - - - - - diff --git a/reference/memcached/memcached/resetserverlist.xml b/reference/memcached/memcached/resetserverlist.xml deleted file mode 100644 index 39251d3813..0000000000 --- a/reference/memcached/memcached/resetserverlist.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - Memcached::resetServerList - Elimina todos los servidores de la lista de servidores - - - - &reftitle.description; - - public boolMemcached::resetServerList - - - - Memcached::resetserverlist elimina todos los servidores - de la lista de servidores conocidos, dejándola vacía. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - Memcached::addServer - Memcached::addServers - - - - - - - diff --git a/reference/memcached/memcached/set.xml b/reference/memcached/memcached/set.xml deleted file mode 100644 index 734686485b..0000000000 --- a/reference/memcached/memcached/set.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - - Memcached::set - Almacena un elemento - - - - &reftitle.description; - - public boolMemcached::set - stringkey - mixedvalue - intexpiration0 - - - Memcached::set almacena el valor value - en un servidor memcache, con la clave de identificación key. - El argumento expiration permite controlar el tiempo de expiración - automática del valor. - - - El valor puede ser cualquier tipo de valor PHP, excepto una recurso, ya que estas - no pueden ser representadas en forma lineal. Si la opción - Memcached::OPT_COMPRESSION está activada, el valor serializado será - también comprimido antes del almacenamiento. - - - - - &reftitle.parameters; - - - - key - - - &memcached.parameter.key; - - - - - value - - - &memcached.parameter.value; - - - - - expiration - - - &memcached.parameter.expiration; - - - - - - - - - &reftitle.returnvalues; - - &return.success; - &memcached.result.getresultcode; - - - - - &reftitle.examples; - - - Ejemplo con <function>Memcached::set</function> - -addServer('localhost', 11211); - -$m->set('int', 99); -$m->set('string', 'a simple string'); -$m->set('array', array(11, 12)); -/* El 'object' será destruido en 5 minutos */ -$m->set('object', new stdClass, time() + 300); - -var_dump($m->get('int')); -var_dump($m->get('string')); -var_dump($m->get('array')); -var_dump($m->get('object')); -?> -]]> - - &example.outputs.similar; - - - int(11) - [1]=> - int(12) -} -object(stdClass)#1 (0) { -} -]]> - - - - - - - &reftitle.seealso; - - - Memcached::setByKey - Memcached::add - Memcached::replace - - - - - - - diff --git a/reference/memcached/memcached/setbykey.xml b/reference/memcached/memcached/setbykey.xml deleted file mode 100644 index 4ff1efd7ee..0000000000 --- a/reference/memcached/memcached/setbykey.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - - Memcached::setByKey - Almacena un elemento en un servidor específico - - - - &reftitle.description; - - public boolMemcached::setByKey - stringserver_key - stringkey - mixedvalue - intexpiration0 - - - Memcached::setByKey es funcionalmente equivalente a - Memcached::set, excepto que la variable libre - server_key puede ser utilizada para enviar la clave - key a un servidor específico. Esto es útil si se desea - agrupar ciertas claves en un servidor. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - key - - - &memcached.parameter.key; - - - - - value - - - &memcached.parameter.value; - - - - - expiration - - - &memcached.parameter.expiration; - - - - - - - - - &reftitle.returnvalues; - - &return.success; - &memcached.result.getresultcode; - - - - - &reftitle.examples; - - - Ejemplo con <function>Memcached::setByKey</function> - -addServer('localhost', 11211); - -/* Conserva los bloques de IP en un servidor */ -$m->setByKey('api-cache', 'block-ip:169.254.253.252', 1); -$m->setByKey('api-cache', 'block-ip:169.127.127.202', 1); -?> -]]> - - - - - - - &reftitle.seealso; - - - Memcached::set - - - - - - - diff --git a/reference/memcached/memcached/setencodingkey.xml b/reference/memcached/memcached/setencodingkey.xml deleted file mode 100644 index 30bb64ce3a..0000000000 --- a/reference/memcached/memcached/setencodingkey.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - Memcached::setEncodingKey - Establece la clave de cifrado AES para los datos en Memcached - - - - &reftitle.description; - - public boolMemcached::setEncodingKey - stringkey - - - Este método establece la clave de cifrado/descifrado AES para los datos escritos y leídos desde Memcached. - - - - - &reftitle.parameters; - - - key - - - La clave AES. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - Memcached::get - Memcached::add - Memcached::set - - - - - diff --git a/reference/memcached/memcached/setmulti.xml b/reference/memcached/memcached/setmulti.xml deleted file mode 100644 index cca17cf470..0000000000 --- a/reference/memcached/memcached/setmulti.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - Memcached::setMulti - Almacena varios elementos - - - - &reftitle.description; - - public boolMemcached::setMulti - arrayitems - intexpiration0 - - - Memcached::setMulti es similar a - Memcached::set, y en lugar de almacenar un solo par - clave / valor, opera sobre varios elementos mediante - items. El tiempo de expiración expiration - se aplica a todos los elementos en su conjunto. - - - - - &reftitle.parameters; - - - - items - - - &memcached.parameter.items; - - - - - expiration - - - &memcached.parameter.expiration; - - - - - - - - - &reftitle.returnvalues; - - &return.success; - &memcached.result.getresultcode; - - - - - &reftitle.examples; - - - Ejemplo con <function>Memcached::setMulti</function> - -addServer('localhost', 11211); - -$items = array( - 'key1' => 'value1', - 'key2' => 'value2', - 'key3' => 'value3' -); -$m->setMulti($items, time() + 300); -?> -]]> - - - - - - - &reftitle.seealso; - - - Memcached::setMultiByKey - Memcached::set - - - - - - - diff --git a/reference/memcached/memcached/setmultibykey.xml b/reference/memcached/memcached/setmultibykey.xml deleted file mode 100644 index 6489ab9b68..0000000000 --- a/reference/memcached/memcached/setmultibykey.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - Memcached::setMultiByKey - Almacena varios elementos en un servidor - - - - &reftitle.description; - - public boolMemcached::setMultiByKey - stringserver_key - arrayitems - intexpiration0 - - - Memcached::setMultiByKey es el equivalente funcional - de Memcached::setMulti, con la excepción de que - el argumento libre server_key puede ser utilizado para - dirigir las claves de items hacia un servidor específico. - Esto es útil si se desea mantener ciertas claves agrupadas en un solo servidor. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - items - - - &memcached.parameter.items; - - - - - expiration - - - &memcached.parameter.expiration; - - - - - - - - - &reftitle.returnvalues; - - &return.success; - &memcached.result.getresultcode; - - - - - &reftitle.seealso; - - - Memcached::setMulti - Memcached::set - - - - - - - diff --git a/reference/memcached/memcached/setoption.xml b/reference/memcached/memcached/setoption.xml deleted file mode 100644 index f2a9c3c167..0000000000 --- a/reference/memcached/memcached/setoption.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - - Memcached::setOption - Configura una opción Memcached - - - - &reftitle.description; - - public boolMemcached::setOption - intoption - mixedvalue - - - Este método configura un valor de la opción Memcached - option con el valor value. - Algunas opciones corresponden a las definidas en libmemcached, y otras - son específicas de la extensión. - - - - - &reftitle.parameters; - - - - option - - - Una de las constantes Memcached::OPT_*. - Ver Memcached Constants para más información. - - - - - value - - - El valor a definir. - - - - Las opciones a continuación requieren que los valores sean especificados mediante constantes. - - - Memcached::OPT_HASH requiere valores - Memcached::HASH_*. - - - Memcached::OPT_DISTRIBUTION requiere valores - Memcached::DISTRIBUTION_*. - - - Memcached::OPT_SERIALIZER requiere valores - Memcached::SERIALIZER_*. - - - Memcached::OPT_COMPRESSION_TYPE requiere valores - Memcached::COMPRESSION_*. - - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Configuración de una opción Memcached - -getOption(Memcached::OPT_HASH) == Memcached::HASH_DEFAULT); -$m->setOption(Memcached::OPT_HASH, Memcached::HASH_MURMUR); -$m->setOption(Memcached::OPT_PREFIX_KEY, "widgets"); -echo "El prefijo de la clave es ahora: ", $m->getOption(Memcached::OPT_PREFIX_KEY), "\n"; -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - Memcached::getOption - Memcached::setOptions - Las constantes Memcached - - - - - - - diff --git a/reference/memcached/memcached/setoptions.xml b/reference/memcached/memcached/setoptions.xml deleted file mode 100644 index a0f75863dc..0000000000 --- a/reference/memcached/memcached/setoptions.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - Memcached::setOptions - Define opciones Memcache - - - - &reftitle.description; - - public boolMemcached::setOptions - arrayoptions - - - Memcached::setOptions es una variante del método - Memcached::setOption que acepta un array de opciones - a definir. - - - - - &reftitle.parameters; - - - options - - - Un array asociativo de opciones donde las claves representan la opción - a definir, y los valores, el nuevo valor para la opción. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Definir opciones Memcache - -getOption(Memcached::OPT_HASH) == Memcached::HASH_DEFAULT); - -$m->setOptions(array(Memcached::OPT_HASH => Memcached::HASH_MURMUR, Memcached::OPT_PREFIX_KEY => "widgets")); - -var_dump($m->getOption(Memcached::OPT_HASH) == Memcached::HASH_DEFAULT); -echo "El prefijo de las claves es ahora: ", $m->getOption(Memcached::OPT_PREFIX_KEY), "\n"; -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - Memcached::getOption - Memcached::setOption - Las constantes Memcache - - - - - - - diff --git a/reference/memcached/memcached/setsaslauthdata.xml b/reference/memcached/memcached/setsaslauthdata.xml deleted file mode 100644 index a5274058e0..0000000000 --- a/reference/memcached/memcached/setsaslauthdata.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - Memcached::setSaslAuthData - Define las credenciales a utilizar para la autenticación - - - - &reftitle.description; - - public boolMemcached::setSaslAuthData - stringusername - stringpassword - - - Memcached::setSaslAuthData define el nombre de usuario - así como la contraseña a utilizar durante la autenticación - SASL con los servidores memcache. - - - - Este método solo está disponible cuando la extensión memcache - ha sido compilada con soporte SASL. - - Para más información, consulte la sección sobre la instalación de Memcache. - - - - - &reftitle.parameters; - - - - username - - - El nombre de usuario a utilizar para la autenticación. - - - - - password - - - La contraseña a utilizar para la autenticación. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/memcached/memcached/touch.xml b/reference/memcached/memcached/touch.xml deleted file mode 100644 index 033c877168..0000000000 --- a/reference/memcached/memcached/touch.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - Memcached::touch - Define una nueva expiración en un elemento - - - - &reftitle.description; - - public boolMemcached::touch - stringkey - intexpiration0 - - - Memcached::touch define un nuevo valor de expiración - para una clave dada. - - - - - &reftitle.parameters; - - - - key - - - &memcached.parameter.key; - - - - - expiration - - - &memcached.parameter.expiration; - - - - - - - - - &reftitle.returnvalues; - - &return.success; - &memcached.result.getresultcode; - - - - - &reftitle.seealso; - - - Memcached::touchByKey - - - - - - - diff --git a/reference/memcached/memcached/touchbykey.xml b/reference/memcached/memcached/touchbykey.xml deleted file mode 100644 index 15e7273271..0000000000 --- a/reference/memcached/memcached/touchbykey.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - Memcached::touchByKey - Define una nueva expiración en un elemento de un servidor específico - - - - &reftitle.description; - - public boolMemcached::touchByKey - stringserver_key - stringkey - intexpiration0 - - - Memcached::touchByKey es equivalente al método - Memcached::touch, excepto que el argumento - server_key puede ser utilizado para ligar la clave - key con un servidor específico. - - - - - &reftitle.parameters; - - - - server_key - - - &memcached.parameter.server_key; - - - - - key - - - &memcached.parameter.key; - - - - - expiration - - - &memcached.parameter.expiration; - - - - - - - - - &reftitle.returnvalues; - - &return.success; - &memcached.result.getresultcode; - - - - - &reftitle.seealso; - - - Memcached::touch - - - - - - - diff --git a/reference/memcached/memcachedexception.xml b/reference/memcached/memcachedexception.xml deleted file mode 100644 index c3e319c711..0000000000 --- a/reference/memcached/memcachedexception.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - La clase MemcachedException - MemcachedException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - MemcachedException - - - - - MemcachedException - - - - extends - RuntimeException - - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - - -
    - -
    - - diff --git a/reference/memcached/sessions.xml b/reference/memcached/sessions.xml deleted file mode 100644 index b20a535536..0000000000 --- a/reference/memcached/sessions.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - Soporte para sesiones - Memcached proporciona un controlador personalizado de sesiones que puede emplearse para almacenar - sesiones de usuario en memcache. Utiliza internamente una instancia diferente para este - propósito, por lo que se puede utilizar una agrupación de servidores diferente si fuera necesario. Las - claves de sesiones se almacenan bajo el prefijo - memc.sess.key., por lo que hay que considerar esto si se utiliza - la misma agrupación de servidores para caché de sesiones y caché genérica. - - - - - - session.save_handler - string - - - - Establecer a memcached para activar el soporte para sesiones. - - - - - - - session.save_path - string - - - - Define entradas nombre_host:puerto separadas por comas para - utilizarlas en agrupaciones de servidores de sesiones, por ejemplo - "sess1:11211, sess2:11211". - - - - - - - - - diff --git a/reference/memcached/setup.xml b/reference/memcached/setup.xml deleted file mode 100644 index 9080f1de2e..0000000000 --- a/reference/memcached/setup.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - - Esta extensión requiere la biblioteca cliente - libmemcached - (versión 1.0.0 o superior). Para un soporte de la autenticación SASL, - la biblioteca libmemcached debe haber sido compilada con la activación de SASL. - - - A partir de la versión 0.2.0, esta extensión requiere PHP versión 5.2.0 o superior. - -
    - - - &reference.memcached.configure; - - - - &reference.memcached.ini; - - -
    - - diff --git a/reference/misc/functions/hrtime.xml b/reference/misc/functions/hrtime.xml index a6ccdbf65e..c48c8ddcff 100644 --- a/reference/misc/functions/hrtime.xml +++ b/reference/misc/functions/hrtime.xml @@ -102,7 +102,7 @@ Array &reftitle.seealso; - La extensión de Gestión del tiempo de alta resolución + La extensión de Gestión del tiempo de alta resolución microtime time_nanosleep diff --git a/reference/mongodb/architecture.xml b/reference/mongodb/architecture.xml deleted file mode 100644 index 4db8476859..0000000000 --- a/reference/mongodb/architecture.xml +++ /dev/null @@ -1,974 +0,0 @@ - - - - - Arquitectura y funcionalidades especiales - Explicaciones de la arquitectura del controlador y de las funcionalidades especiales - -
    - Arquitectura - Visión general de la arquitectura - - - Este artículo explica cómo se integran todos los diferentes componentes del controlador PHP, desde las bibliotecas del sistema base, hasta la extensión, y las bibliotecas PHP en la parte superior. - - - - - - El diagrama de la arquitectura del controlador MongoDB PHP. El nivel más bajo del controlador son nuestras bibliotecas del sistema: libmongoc, libbson, y libmongocrypt. El nivel intermedio es la extensión PHP MongoDB. El nivel superior es el código del usuario PHP e incluye la biblioteca MongoDB PHP y paquetes de nivel superior como las integraciones de marcos de trabajo y las aplicaciones. - - - - - - - - - En la parte superior de esta pila se encuentra una - biblioteca PHP, - que distribuye un - paquete Composer. - Esta biblioteca proporciona una API coherente con otros - controladores - MongoDB e implementa diversas - especificaciones - cruzadas. Aunque la extensión puede ser utilizada directamente, la biblioteca - tiene un sobrecoste mínimo y debería ser una dependencia común para la mayoría - de las aplicaciones construidas con MongoDB. - - - - Debajo de esta biblioteca se encuentra una extensión PHP, que se distribuye a través de - PECL. - La extensión forma la cola entre PHP y nuestras bibliotecas del sistema - (libmongoc, - libbson, y - libmongocrypt). - Su API pública proporciona únicamente las funcionalidades más esenciales: - - Gestión de conexiones - Codificación y decodificación BSON - Serialización y deserialización de documentos (soporte de bibliotecas ODM) - Ejecución de comandos, consultas y operaciones de escritura - Gestión de cursores para los resultados de comandos y consultas - - - - - - Código fuente del controlador y proyectos JIRA - - - - Proyecto - GitHub - JIRA - - - - - Bibliotecas PHP - mongodb/mongo-php-library - PHPLIB - - - Extensiones PHP - mongodb/mongo-php-driver - PHPC - - - -
    -
    -
    - -
    - Conexiones - Gestión de la conexión y de la persistencia - - &mongodb.note.forking; - -
    - Conexiones y topología persistente (versión PHP desde 1.2.0) - - - Todas las versiones de la extensión desde 1.2.0 conservan el objeto cliente - libmongoc en el proceso - PHP, lo que le permite reutilizar las conexiones de base de datos, los - estados de autenticación, y la información de - topología a través de múltiples consultas. - - - - Cuando MongoDB\Driver\Manager::__construct es - invocado, se crea un hash a partir de sus argumentos (es decir, la - cadena URI y el array de opciones). La extensión intentará encontrar un objeto - cliente libmongoc persistido - previamente para este hash. Si no se puede encontrar un cliente existente para el hash, se creará un nuevo cliente y se persistirá para su uso futuro. Este comportamiento puede ser desactivado a través de la opción del controlador - "disableClientPersistence". - - - - Cada cliente contiene sus propias conexiones de base de datos y una vista - de la topología del servidor (por ejemplo, autónomo, conjunto de réplicas, - grupo de fragmentos). Al persistir el cliente entre las consultas PHP, - la extensión es capaz de reutilizar las conexiones de base de datos - establecidas y eliminar la necesidad de - descubrir la topología del servidor - en cada consulta. - - - - Considere el siguiente ejemplo: - - - - 'myReplicaSet']), -]; - -foreach ($managers as $manager) { - $manager->executeCommand('test', new MongoDB\Driver\Command(['ping' => 1])); -} - -?> -]]> - - - - Los dos primeros objetos Manager compartirán el mismo - cliente libmongoc ya que sus - argumentos de constructor son idénticos. Los tercer y cuarto objetos - utilizarán cada uno su propio cliente. En total, se crearán tres clientes y el proceso PHP ejecutando este script abrirá dos conexiones a - 127.0.0.1 y una conexión a cada uno de - rs1.example.com y rs2.example.com. - Si la extensión descubre miembros adicionales del conjunto de réplicas - después de emitir comandos hello, abrirá conexiones adicionales a estos servidores también. - - - - Si las mismas conexiones son reutilizadas por el mismo proceso PHP, los tres - clientes serán reutilizados y no se establecerá ninguna nueva conexión. En - función del tiempo transcurrido desde la última consulta servida, la extensión - puede necesitar emitir comandos hello adicionales para actualizar su vista de las topologías. - -
    - -
    - Persistencia de sockets (versiones PHP antes de 1.2.0) - - - Las versiones de la extensión antes de 1.2.0 utilizan la API de flujos PHP para - las conexiones de base de datos, utilizando una API en - libmongoc para designar gestores personalizados para la comunicación por socket; sin embargo, se crea un nuevo cliente libmongoc para cada - MongoDB\Driver\Manager. En consecuencia, la extensión persiste las conexiones de base de datos individuales pero no el estado - de autentificación o la información de topología. Esto significa que - la extensión debe emitir comandos al inicio de cada consulta para - autenticarse y - descubrir la topología del servidor. - - - - Las conexiones de base de datos son persistidas por un hash derivado del - host del servidor, del puerto y de la cadena URI utilizada para construir el - MongoDB\Driver\Manager. Las opciones del array del - constructor no están incluidas en este hash. - - - - - Las versiones de la extensión >= 1.1.8 y < 1.2.0 no persisten los - sockets para las conexiones SSL. Ver - PHPC-720 para más - información. - - - - - A pesar de sus carencias con las conexiones SSL persistentes y la información - de topología, esta versión de la extensión soporta todas las - opciones de contexto SSL ya que utiliza la API de flujos PHP. - -
    -
    - -
    - Persistir datos - Serialización y deserialización de variables PHP en MongoDB - - - Este documento explica cómo se convierten las estructuras compuestas (es decir, los - documentos, los arrays y los objetos) entre los valores BSON y PHP. - - -
    - Serialización en BSON - -
    - Arrays - - - Si un array es un array compacto — es decir, un - array vacío o las claves comienzan en 0 y son secuenciales sin huecos : - array BSON. - - - - Si el array no es compacto — es decir, que tiene claves - asociativas (cadenas), que las claves no comienzan en 0, o que hay - huecos : objeto BSON. - - - - Un documento de nivel superior (raíz), siempre - serializado como documento BSON. - - -
    - Ejemplos - - - Estos ejemplos se serializan como array BSON : - - - - [ 8, 5, 2, 3 ] -[ 0 => 4, 1 => 9 ] => [ 4, 9 ] -]]> - - - - Estos ejemplos se serializan como objeto BSON : - - - - 1, 2 => 8, 3 => 12 ] => { "0" : 1, "2" : 8, "3" : 12 } -[ "foo" => 42 ] => { "foo" : 42 } -[ 1 => 9, 0 => 10 ] => { "1" : 9, "0" : 10 } -]]> - - - - Es de notar que los cinco ejemplos son extractos - de un documento completo, y solo representan un valor - dentro de un documento. - - -
    -
    - -
    - Objetos - - - Si un objeto es de la clase stdClass, serializar - como documento BSON. - - - - Si un objeto es una clase soportada que implementa - MongoDB\BSON\Type, entonces utilizar la lógica - de serialización BSON para este tipo específico. - Las instancias de MongoDB\BSON\Type (a - excepción de MongoDB\BSON\Serializable) - solo pueden ser serializadas como valor de campo de documento. Intentar - serializar tal objeto como documento raíz lanzará una - MongoDB\Driver\Exception\UnexpectedValueException. - - - - Si un objeto es de una clase desconocida que implementa la interfaz - MongoDB\BSON\Type, entonces se lanza una - MongoDB\Driver\Exception\UnexpectedValueException. - - - - Si un objeto es de otra clase, sin implementar una interfaz especial, - serializar como documento BSON. Mantener solo - las propiedades públicas, e ignorar las propiedades - protegidas y privadas. - - - - Si un objeto es de una clase que implementa - MongoDB\BSON\Serializable, llamar - MongoDB\BSON\Serializable::bsonSerialize y - utilizar el array o stdClass devuelto para - serializar como documento BSON o array. El tipo BSON será - determinado por las siguientes reglas : - - - - - - - Los documentos raíz deben ser serializados como - documento BSON. - - - - - Los objetos MongoDB\BSON\Persistable deben - ser serializados como documento BSON. - - - - - Si MongoDB\BSON\Serializable::bsonSerialize - devuelve un array compacto, serializar como array BSON. - - - - - Si MongoDB\BSON\Serializable::bsonSerialize - devuelve un array no compacto o stdClass, serializar como objeto BSON. - - - - - Si MongoDB\BSON\Serializable::bsonSerialize - no devuelve un array o stdClass, lanzar una excepción - MongoDB\Driver\Exception\UnexpectedValueException. - - - - - - - Si un objeto es de una clase que implementa la interfaz - MongoDB\BSON\Persistable (lo que implica - MongoDB\BSON\Serializable), obtener las - propiedades de manera similar a los párrafos anteriores, pero - también añadir una propiedad - __pclass como valor binario, con un subtipo - 0x80 y datos que llevan el nombre de la clase - completamente calificado del objeto que se serializa. - - - - La propiedad __pclass se añade al array o al - objeto devuelto por - MongoDB\BSON\Serializable::bsonSerialize, lo que - significa que sobrescribirá cualquier clave/propiedad __pclass - en el valor de retorno de - MongoDB\BSON\Serializable::bsonSerialize. Si se - desea evitar este comportamiento y definir su propio valor - __pclass, - no se debe implementar - MongoDB\BSON\Persistable y se debería implementar - MongoDB\BSON\Serializable directamente. - - -
    - Ejemplos - - - {"foo": 42} - -class MyClass -{ - public $foo = 42; - protected $prot = 'wine'; - private $fpr = 'cheese'; -} // => {"foo": 42} - -class AnotherClass1 implements MongoDB\BSON\Serializable -{ - public $foo = 42; - protected $prot = 'wine'; - private $fpr = 'cheese'; - - public function bsonSerialize(): array - { - return ['foo' => $this->foo, 'prot' => $this->prot]; - } -} // => {"foo": 42, "prot": "wine"} - -class AnotherClass2 implements MongoDB\BSON\Serializable -{ - public $foo = 42; - - public function bsonSerialize(): self - { - return $this; - } -} // => MongoDB\Driver\Exception\UnexpectedValueException("bsonSerialize() did not return an array or stdClass") - -class AnotherClass3 implements MongoDB\BSON\Serializable -{ - private $elements = ['foo', 'bar']; - - public function bsonSerialize(): array - { - return $this->elements; - } -} // => {"0": "foo", "1": "bar"} - -/** - * Nesting Serializable classes - */ - -class AnotherClass4 implements MongoDB\BSON\Serializable -{ - private $elements = [0 => 'foo', 2 => 'bar']; - - public function bsonSerialize(): array - { - return $this->elements; - } -} // => {"0": "foo", "2": "bar"} - -class ContainerClass1 implements MongoDB\BSON\Serializable -{ - public $things; - - public function __construct() - { - $this->things = new AnotherClass4(); - } - - function bsonSerialize(): array - { - return ['things' => $this->things]; - } -} // => {"things": {"0": "foo", "2": "bar"}} - -class AnotherClass5 implements MongoDB\BSON\Serializable -{ - private $elements = [0 => 'foo', 2 => 'bar']; - - public function bsonSerialize(): array - { - return array_values($this->elements); - } -} // => {"0": "foo", "1": "bar"} como clase raíz - // ["foo", "bar"] como valor anidado - -class ContainerClass2 implements MongoDB\BSON\Serializable -{ - public $things; - - public function __construct() - { - $this->things = new AnotherClass5(); - } - - public function bsonSerialize(): array - { - return ['things' => $this->things]; - } -} // => {"things": ["foo", "bar"]} - -class AnotherClass6 implements MongoDB\BSON\Serializable -{ - private $elements = ['foo', 'bar']; - - function bsonSerialize(): object - { - return (object) $this->elements; - } -} // => {"0": "foo", "1": "bar"} - -class ContainerClass3 implements MongoDB\BSON\Serializable -{ - public $things; - - public function __construct() - { - $this->things = new AnotherClass6(); - } - - public function bsonSerialize(): array - { - return ['things' => $this->things]; - } -} // => {"things": {"0": "foo", "1": "bar"}} - -class UpperClass implements MongoDB\BSON\Persistable -{ - public $foo = 42; - protected $prot = 'wine'; - private $fpr = 'cheese'; - - private $data; - - public function bsonUnserialize(array $data): void - { - $this->data = $data; - } - - public function bsonSerialize(): array - { - return ['foo' => $this->foo, 'prot' => $this->prot]; - } -} // => {"foo": 42, "prot": "wine", "__pclass": {"$type": "80", "$binary": "VXBwZXJDbGFzcw=="}} - -?> -]]> - -
    -
    -
    - -
    - Deserialización desde BSON - - &mongodb.warning.duplicate-keys; - - - La extensión mongodb deserializa los documentos BSON - y los arrays BSON como arrays PHP. Aunque los arrays PHP son - prácticos de usar, este comportamiento era problemático ya que diferentes - tipos BSON podían ser deserializados en el mismo valor PHP (por ejemplo - {"0": "foo"} y ["foo"]) y hacía - imposible inferir el tipo BSON original. Por defecto, la extensión - mongodb aborda esta preocupación asegurándose de que los - arrays BSON y los documentos BSON se conviertan en arrays y objetos PHP, - respectivamente. - - - Para los tipos compuestos, existen tres tipos de datos : - - - - - - raíz - - - se refiere a un documento BSON de nivel superior solo - - - - - documento - - - se refiere a documentos BSON anidados solo - - - - - array - - - se refiere a un array BSON - - - - - - - - Además de los tres tipos colectivos, también es posible configurar campos específicos en su documento para mapear los tipos de datos - mencionados a continuación. Por ejemplo, el siguiente tipo de mapa le permite mapear cada documento incrustado en un array "addresses" a una clase Address y cada - campo "city" en estos documentos de dirección incrustados a una - clase City: - - - [ - 'addresses.$' => 'MyProject\Address', - 'addresses.$.city' => 'MyProject\City', - ], -] -]]> - - - - - Cada uno de estos tres tipos de datos, así como los mapeos específicos - de los campos, pueden ser mapeados contra diferentes tipos PHP. Los valores de - mapeo posibles son: - - - - - - no definido o NULL (por defecto) - - - - - - Un array BSON será deserializado en un array PHP. - - - - - Un documento BSON (raíz o anidado) sin propiedad - __pclass - - - Una propiedad __pclass solo se considera existente si - una propiedad con ese nombre existe, y es un valor - binario, y el subtipo del valor binario es 0x80. Si - alguna de estas tres condiciones no se cumple, la propiedad - __pclass no existe y debe ser tratada como cualquier otra - propiedad normal. - - - se convierte en un objeto stdClass, con cada clave de documento - BSON definida como una propiedad de stdClass - pública. - - - - - Un documento BSON (raíz o anidado) con una propiedad - __pclass se convierte en un objeto PHP de la clase - nombrada por la propiedad __pclass. - - - Si la clase nombrada implementa la interfaz - MongoDB\BSON\Persistable, entonces las - propiedades del documento BSON, incluyendo la propiedad - __pclass, se envían como array asociativo a la función - MongoDB\BSON\Unserializable::bsonUnserialize - para inicializar las propiedades del objeto. - - - Si la clase nombrada no existe o no implementa la interfaz - MongoDB\BSON\Persistable, - stdClass será - utilizado y cada clave de documento BSON (incluyendo __pclass) - será definida como una propiedad pública de stdClass. - - - La funcionalidad __pclass se basa en el hecho - de que la propiedad sea parte de un documento MongoDB recuperado. Si utiliza una - proyección - al buscar documentos, debe incluir el campo - __pclass en la proyección para que esta - funcionalidad funcione. - - - - - - - - - "array" - - - Transforma un array BSON en un array PHP. No habrá - tratamiento especial de una propiedad __pclass - pero puede ser definida como un elemento en el array devuelto - si estaba presente en el documento BSON. - - - - - - "object" o "stdClass" - - - Transforma un array BSON o un documento BSON en un objeto - stdClass. No habrá tratamiento especial de una - propiedad __pclass - pero puede ser definida como una propiedad pública en el objeto - devuelto si estaba presente en el documento BSON. - - - - - - "bson" - - - Transforma un array BSON en un MongoDB\BSON\PackedArray - y un documento BSON en un MongoDB\BSON\Document, - independientemente de si el documento BSON tiene una propiedad - __pclass . - - - - El valor bson solo está disponible para los tres - tipos raíz, y no en los mapeos específicos de los campos. - - - - - - - todas las otras cadenas de caracteres - - - Define el nombre de la clase a la que el documento BSON debe ser - deserializado. Para los documentos BSON que incluyen propiedades - __pclass, - esta clase tendrá prioridad. - - - - Si la clase nombrada no existe o no implementa la interfaz - MongoDB\BSON\Unserializable, - se lanza una excepción - MongoDB\Driver\Exception\InvalidArgumentException. - - - - Si el objeto BSON tiene una propiedad __pclass y - esta clase existe e implementa - MongoDB\BSON\Persistable, tendrá - prioridad sobre la clase proporcionada en el mapa de tipos. - - - - Las propiedades del documento BSON, incluyendo la propiedad - __pclass, - serán enviadas como array asociativo a la función - MongoDB\BSON\Unserializable::bsonUnserialize - para inicializar las propiedades del objeto. - - - - - - -
    - TypeMaps - - - Los TypeMaps pueden ser definidos a través del método - MongoDB\Driver\Cursor::setTypeMap en un objeto - MongoDB\Driver\Cursor, o el argumento - $typeMap de - MongoDB\BSON\toPHP, - MongoDB\BSON\Document::toPHP, y - MongoDB\BSON\PackedArray::toPHP. Cada una de las tres - clases (raíz, documento, y - array) puede ser definida individualmente, además de los - tipos específicos de los campos. - - - - Si el valor en el TypeMap es NULL, esto significa lo mismo que el valor por defecto para este elemento. - -
    - -
    - Ejemplos - - - Estos ejemplos utilizan las siguientes clases: - - - - - - MyClass - - - que no implementa ninguna interfaz - - - - - YourClass - - - que implementa - MongoDB\BSON\Unserializable - - - - - OurClass - - - que implementa - MongoDB\BSON\Persistable - - - - - TheirClass - - - que extiende OurClass - - - - - - - - El método MongoDB\BSON\Unserializable::bsonUnserialize - de YourClass, OurClass, TheirClass itera sobre el array y define las - propiedades sin modificaciones. También añade la - propiedad $unserialized a &true;: - - - $value ) - { - $this->$k = $value; - } - $this->unserialized = true; -} -]]> - - - - - - stdClass { $foo => 'yes', $bar => false } - -{ "foo": "no", "array" : [ 5, 6 ] } - -> stdClass { $foo => 'no', $array => [ 5, 6 ] } - -{ "foo": "no", "obj" : { "embedded" : 3.14 } } - -> stdClass { $foo => 'no', $obj => stdClass { $embedded => 3.14 } } - -{ "foo": "yes", "__pclass": "MyClass" } - -> stdClass { $foo => 'yes', $__pclass => 'MyClass' } - -{ "foo": "yes", "__pclass": { "$type" : "80", "$binary" : "MyClass" } } - -> stdClass { $foo => 'yes', $__pclass => Binary(0x80, 'MyClass') } - -{ "foo": "yes", "__pclass": { "$type" : "80", "$binary" : "YourClass") } - -> stdClass { $foo => 'yes', $__pclass => Binary(0x80, 'YourClass') } - -{ "foo": "yes", "__pclass": { "$type" : "80", "$binary" : "OurClass") } - -> OurClass { $foo => 'yes', $__pclass => Binary(0x80, 'OurClass'), $unserialized => true } - -{ "foo": "yes", "__pclass": { "$type" : "44", "$binary" : "YourClass") } - -> stdClass { $foo => 'yes', $__pclass => Binary(0x44, 'YourClass') } -]]> - - - - - - "MissingClass" ] */ -{ "foo": "yes" } - -> MongoDB\Driver\Exception\InvalidArgumentException("MissingClass does not exist") - -/* typemap: [ "root" => "MyClass" ] */ -{ "foo": "yes", "__pclass" : { "$type": "80", "$binary": "MyClass" } } - -> MongoDB\Driver\Exception\InvalidArgumentException("MyClass does not implement Unserializable interface") - -/* typemap: [ "root" => "MongoDB\BSON\Unserializable" ] */ -{ "foo": "yes" } - -> MongoDB\Driver\Exception\InvalidArgumentException("Unserializable is not a concrete class") - -/* typemap: [ "root" => "YourClass" ] */ -{ "foo": "yes", "__pclass" : { "$type": "80", "$binary": "MongoDB\BSON\Unserializable" } } - -> YourClass { $foo => "yes", $__pclass => Binary(0x80, "MongoDB\BSON\Unserializable"), $unserialized => true } - -/* typemap: [ "root" => "YourClass" ] */ -{ "foo": "yes", "__pclass" : { "$type": "80", "$binary": "MyClass" } } - -> YourClass { $foo => "yes", $__pclass => Binary(0x80, "MyClass"), $unserialized => true } - -/* typemap: [ "root" => "YourClass" ] */ -{ "foo": "yes", "__pclass" : { "$type": "80", "$binary": "OurClass" } } - -> OurClass { $foo => "yes", $__pclass => Binary(0x80, "OurClass"), $unserialized => true } - -/* typemap: [ "root" => "YourClass" ] */ -{ "foo": "yes", "__pclass" : { "$type": "80", "$binary": "TheirClass" } } - -> TheirClass { $foo => "yes", $__pclass => Binary(0x80, "TheirClass"), $unserialized => true } - -/* typemap: [ "root" => "OurClass" ] */ -{ foo: "yes", "__pclass" : { "$type": "80", "$binary": "TheirClass" } } - -> TheirClass { $foo => "yes", $__pclass => Binary(0x80, "TheirClass"), $unserialized => true } -]]> - - - - - - 'YourClass' ] */ -{ foo: "yes", "__pclass" : { "$type": "80", "$binary": "YourClass" } } - -> YourClass { $foo => 'yes', $__pclass => Binary(0x80, 'YourClass'), $unserialized => true } -]]> - - - - - - 'array', 'document' => 'array' ] */ -{ "foo": "yes", "bar" : false } - -> [ "foo" => "yes", "bar" => false ] - -{ "foo": "no", "array" : [ 5, 6 ] } - -> [ "foo" => "no", "array" => [ 5, 6 ] ] - -{ "foo": "no", "obj" : { "embedded" : 3.14 } } - -> [ "foo" => "no", "obj" => [ "embedded => 3.14 ] ] - -{ "foo": "yes", "__pclass": "MyClass" } - -> [ "foo" => "yes", "__pclass" => "MyClass" ] - -{ "foo": "yes", "__pclass" : { "$type": "80", "$binary": "MyClass" } } - -> [ "foo" => "yes", "__pclass" => Binary(0x80, "MyClass") ] - -{ "foo": "yes", "__pclass" : { "$type": "80", "$binary": "OurClass" } } - -> [ "foo" => "yes", "__pclass" => Binary(0x80, "OurClass") ] -]]> - - - - - - 'object', 'document' => 'object' ] */ -{ "foo": "yes", "__pclass": { "$type": "80", "$binary": "MyClass" } } - -> stdClass { $foo => "yes", "__pclass" => Binary(0x80, "MyClass") } -]]> - - - -
    -
    - -
    -
    - - diff --git a/reference/mongodb/book.xml b/reference/mongodb/book.xml deleted file mode 100644 index 298b0516b7..0000000000 --- a/reference/mongodb/book.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - La extensión MongoDB - MongoDB - - - - - Esta extensión se desarrolla sobre las bibliotecas - libmongoc y - libbson. - Proporciona una API mínima para las funcionalidades básicas del controlador: - comandos, - consultas, - escrituras, - gestión de conexión, - y serialización BSON. - - - Las bibliotecas PHP del lado del usuario que dependen de esta extensión - pueden proporcionar API de nivel más alto, tales como constructores - de consultas, métodos de ayuda para comandos individuales, y GridFS. Los desarrolladores de aplicaciones deberían considerar utilizar - esta extensión en conjunción con la - biblioteca MongoDB PHP, - que implementa las mismas API de nivel más alto que se encuentran en los - controladores MongoDB para otros lenguajes. Esta separación de preocupaciones - permite a la extensión concentrarse en las funcionalidades esenciales - para las cuales una implementación de extensión es primordial para el rendimiento. - - - - - &reference.mongodb.setup; - &reference.mongodb.constants; - &reference.mongodb.tutorial; - &reference.mongodb.architecture; - &reference.mongodb.security; - - &reference.mongodb.mongodb; - &reference.mongodb.bson; - &reference.mongodb.monitoring; - &reference.mongodb.exceptions; - - - diff --git a/reference/mongodb/bson.xml b/reference/mongodb/bson.xml deleted file mode 100644 index e399bf3512..0000000000 --- a/reference/mongodb/bson.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - - - Clases y funciones BSON de MongoDB - MongoDB\BSON - - - &Functions; - &reference.mongodb.functions.entities.bson; - - - &reference.mongodb.bson.document; - &reference.mongodb.bson.packedarray; - &reference.mongodb.bson.iterator; - - &reference.mongodb.bson.binary; - &reference.mongodb.bson.vectortype; - &reference.mongodb.bson.decimal128; - &reference.mongodb.bson.javascript; - &reference.mongodb.bson.maxkey; - &reference.mongodb.bson.minkey; - &reference.mongodb.bson.objectid; - &reference.mongodb.bson.regex; - &reference.mongodb.bson.timestamp; - &reference.mongodb.bson.utcdatetime; - - &reference.mongodb.bson.type; - &reference.mongodb.bson.persistable; - &reference.mongodb.bson.serializable; - &reference.mongodb.bson.unserializable; - - &reference.mongodb.bson.binaryinterface; - &reference.mongodb.bson.decimal128interface; - &reference.mongodb.bson.javascriptinterface; - &reference.mongodb.bson.maxkeyinterface; - &reference.mongodb.bson.minkeyinterface; - &reference.mongodb.bson.objectidinterface; - &reference.mongodb.bson.regexinterface; - &reference.mongodb.bson.timestampinterface; - &reference.mongodb.bson.utcdatetimeinterface; - - &reference.mongodb.bson.dbpointer; - &reference.mongodb.bson.int64; - &reference.mongodb.bson.symbol; - &reference.mongodb.bson.undefined; - diff --git a/reference/mongodb/bson/binary.xml b/reference/mongodb/bson/binary.xml deleted file mode 100644 index 9c140bcd8f..0000000000 --- a/reference/mongodb/bson/binary.xml +++ /dev/null @@ -1,318 +0,0 @@ - - - - - - - La clase MongoDB\BSON\Binary - MongoDB\BSON\Binary - - - - -
    - &reftitle.intro; - - Tipo BSON para datos binarios (i.e. array de bytes). Los valores binarios también tienen un subtipo, que se utiliza para indicar qué tipo de datos se encuentra en el array de bytes. Los subtipos de cero a 127 están predefinidos o reservados. Los subtipos de 128-255 son definidos por el usuario. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\Binary - - - - final - - MongoDB\BSON\Binary - - - - MongoDB\BSON\BinaryInterface - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - Stringable - - - - &Constants; - - const - int - MongoDB\BSON\Binary::TYPE_GENERIC - 0 - - - const - int - MongoDB\BSON\Binary::TYPE_FUNCTION - 1 - - - const - int - MongoDB\BSON\Binary::TYPE_OLD_BINARY - 2 - - - const - int - MongoDB\BSON\Binary::TYPE_OLD_UUID - 3 - - - const - int - MongoDB\BSON\Binary::TYPE_UUID - 4 - - - const - int - MongoDB\BSON\Binary::TYPE_MD5 - 5 - - - const - int - MongoDB\BSON\Binary::TYPE_ENCRYPTED - 6 - - - const - int - MongoDB\BSON\Binary::TYPE_COLUMN - 7 - - - const - int - MongoDB\BSON\Binary::TYPE_SENSITIVE - 8 - - - const - int - MongoDB\BSON\Binary::TYPE_VECTOR - 9 - - - const - int - MongoDB\BSON\Binary::TYPE_USER_DEFINED - 128 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - MongoDB\BSON\Binary::TYPE_GENERIC - - Datos binarios genéricos. - - - - - MongoDB\BSON\Binary::TYPE_FUNCTION - - Función. - - - - - MongoDB\BSON\Binary::TYPE_OLD_BINARY - - - Datos binarios genéricos (desaconsejados en favor de MongoDB\BSON\Binary::TYPE_GENERIC). - - - - - - MongoDB\BSON\Binary::TYPE_OLD_UUID - - - Identificador universalmente único (desaconsejado en favor de - MongoDB\BSON\Binary::TYPE_UUID). Al utilizar este tipo, los datos del binario deben tener una longitud de 16 bytes. - - - Históricamente, otros controladores codifican valores con este tipo según sus convenciones lingüísticas (por ejemplo, variable indianness), lo que lo hace no portable. El controlador PHP no aplica ninguna manipulación especial para codificar o decodificar datos con este tipo. - - - - - - MongoDB\BSON\Binary::TYPE_UUID - - Identificador universalmente único. Al utilizar este tipo, los datos del binario deben tener una longitud de 16 bytes y estar codificados según RFC 4122. - - - - - MongoDB\BSON\Binary::TYPE_MD5 - - - Hash MD5. Al utilizar este tipo, los datos del binario deben tener una longitud de 16 bytes. - - - - - - MongoDB\BSON\Binary::TYPE_ENCRYPTED - - Valor cifrado. Este subtipo se utiliza para el cifrado del lado del cliente. - - - - - MongoDB\BSON\Binary::TYPE_COLUMN - - Dato de columna. Este subtipo se utiliza para las colecciones de series temporales. - - - - - MongoDB\BSON\Binary::TYPE_SENSITIVE - - - Datos sensibles. Este subtipo se utiliza para los datos sensibles - que deberían ser excluidos de los registros de eventos del lado del servidor si es posible. - - - - - - MongoDB\BSON\Binary::TYPE_VECTOR - - - Datos de vector. Este subtipo se utiliza para almacenar eficientemente datos de - vector para su uso con la búsqueda de vectores de MongoDB. - - - - - - MongoDB\BSON\Binary::TYPE_USER_DEFINED - - - Tipo definido por el usuario. Mientras que los tipos entre 0 y 127 están predefinidos o reservados, los tipos entre 128 y 255 son definidos por el usuario y pueden ser utilizados para cualquier cosa. - - - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.2.0 - - Adición de MongoDB\BSON\Binary::TYPE_VECTOR, así como las funciones - MongoDB\BSON\Binary::fromVector, - MongoDB\BSON\Binary::getVectorType y - MongoDB\BSON\Binary::toArray. - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.17.0 - - Adición de MongoDB\BSON\Binary::TYPE_SENSITIVE. - - - - PECL mongodb 1.12.0 - - - Implementa Stringable para PHP 8.0+. - - - Adición de MongoDB\BSON\Binary::TYPE_COLUMN. - - - - - PECL mongodb 1.7.0 - - Adición de MongoDB\BSON\Binary::TYPE_ENCRYPTED. - - - - PECL mongodb 1.3.0 - - Implementa MongoDB\BSON\BinaryInterface. - - - - PECL mongodb 1.2.0 - - Implementa Serializable y - JsonSerializable. - - - - - -
    - -
    - - &reference.mongodb.bson.entities.binary; - -
    - - diff --git a/reference/mongodb/bson/binary/construct.xml b/reference/mongodb/bson/binary/construct.xml deleted file mode 100644 index da25dc69e6..0000000000 --- a/reference/mongodb/bson/binary/construct.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - - - MongoDB\BSON\Binary::__construct - Construye un nuevo binario - - - - &reftitle.description; - - final public MongoDB\BSON\Binary::__construct - stringdata - inttypeMongoDB\BSON\Binary::TYPE_GENERIC - - - - - &reftitle.parameters; - - - data (string) - - - Los datos binarios. - - - - - type (int) - - - Entero de 8 bits sin signo que indica el tipo de datos. Por omisión, - el valor es MongoDB\BSON\Binary::TYPE_GENERIC si no se especifica. - - - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lanza una excepción MongoDB\Driver\Exception\InvalidArgumentException si type no es un entero sin signo de 8 bits. - Lanza una excepción MongoDB\Driver\Exception\InvalidArgumentException si type es MongoDB\BSON\Binary::TYPE_UUID o MongoDB\BSON\Binary::TYPE_OLD_UUID y data no tiene exactamente 16 bytes de longitud. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.15.0 - - - El parámetro type es ahora opcional - y tiene el valor por omisión MongoDB\BSON\Binary::TYPE_GENERIC si no se especifica. - - - - - PECL mongodb 1.3.0 - - - MongoDB\Driver\Exception\InvalidArgumentException - se lanza si type es - MongoDB\BSON\Binary::TYPE_UUID o - MongoDB\BSON\Binary::TYPE_OLD_UUID y - data no tiene exactamente 16 bytes de longitud. - - - - - PECL mongodb 1.1.3 - - - MongoDB\Driver\Exception\InvalidArgumentException - se lanza si type no es un entero sin signo - de 8 bits. - - - - - - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\BSON\Binary::__construct</function> - - -]]> - - &example.outputs; - - - string(3) "foo" - ["type"]=> - int(0) -} -]]> - - - - - - &reftitle.seealso; - - Los tipos BSON - - - - - - diff --git a/reference/mongodb/bson/binary/fromvector.xml b/reference/mongodb/bson/binary/fromvector.xml deleted file mode 100644 index 2ae1e3f1c6..0000000000 --- a/reference/mongodb/bson/binary/fromvector.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - MongoDB\BSON\Binary::fromVector - Crea un nuevo binario con subtipo MongoDB\BSON\Binary::SUBTYPE_VECTOR a partir del array y tipo de vector dados - - - - &reftitle.description; - - final public static MongoDB\BSON\BinaryMongoDB\BSON\Binary::fromVector - arrayvector - MongoDB\BSON\VectorTypevectorType - - - - - &reftitle.parameters; - - - vector (array) - - - Un array de valores que representa los datos del vector. El tipo de cada valor debe coincidir con el tipo indicado por el parámetro vectorType: - - para MongoDB\BSON\VectorType::Float32, cada valor debe ser un float - para MongoDB\BSON\VectorType::Int8, cada valor debe ser un int de 8 bits, es decir, de -127 a 128 - para MongoDB\BSON\VectorType::PackedBit, cada valor debe ser un bool o un int de 1 bit, es decir, 0 o 1 - - - - - - vectorType (MongoDB\BSON\VectorType) - - - El tipo de datos del vector. - - - - - - - - &reftitle.returnvalues; - - Devuelve un nuevo Binary con subtipo MongoDB\BSON\Binary::SUBTYPE_VECTOR. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\BSON\Binary::toArray - MongoDB\BSON\Binary::getVectorType - MongoDB\BSON\VectorType - BSON Types - - - - - - diff --git a/reference/mongodb/bson/binary/getdata.xml b/reference/mongodb/bson/binary/getdata.xml deleted file mode 100644 index f5717b2fef..0000000000 --- a/reference/mongodb/bson/binary/getdata.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - - - MongoDB\BSON\Binary::getData - Devuelve los datos de Binary - - - - &reftitle.description; - - final public stringMongoDB\BSON\Binary::getData - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve los datos de Binary. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\BSON\Binary::getData</function> - -getData()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - Tipos BSON - - - - - - diff --git a/reference/mongodb/bson/binary/gettype.xml b/reference/mongodb/bson/binary/gettype.xml deleted file mode 100644 index 9feb307621..0000000000 --- a/reference/mongodb/bson/binary/gettype.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - - - MongoDB\BSON\Binary::getType - Devuelve el tipo de Binary - - - - &reftitle.description; - - final public intMongoDB\BSON\Binary::getType - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el tipo de Binary. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\BSON\Binary::getType</function> - -getType()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - Tipos BSON - - - - - - diff --git a/reference/mongodb/bson/binary/getvectortype.xml b/reference/mongodb/bson/binary/getvectortype.xml deleted file mode 100644 index fe752e3169..0000000000 --- a/reference/mongodb/bson/binary/getvectortype.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - MongoDB\BSON\Binary::getVectorType - Devuelve el tipo de datos para un Binary con el subtipo vector - - - - &reftitle.description; - - final public MongoDB\BSON\VectorTypeMongoDB\BSON\Binary::getVectorType - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el tipo de datos del vector Binary. - - - - - &reftitle.errors; - - Lanza MongoDB\Driver\Exception\LogicException si el subtipo no es MongoDB\BSON\Binary::SUBTYPE_VECTOR. - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - BSON Types - MongoDB\BSON\VectorType - - - - - - diff --git a/reference/mongodb/bson/binary/jsonserialize.xml b/reference/mongodb/bson/binary/jsonserialize.xml deleted file mode 100644 index a9ce9ca097..0000000000 --- a/reference/mongodb/bson/binary/jsonserialize.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - MongoDB\BSON\Binary::jsonSerialize - Devuelve una representación que puede ser convertida en JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\Binary::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve datos que pueden ser serializados por json_encode - para producir una representación JSON extendida de - MongoDB\BSON\Binary. - - &mongodb.note.extended-json; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB JSON Extendido - - - - - - diff --git a/reference/mongodb/bson/binary/toarray.xml b/reference/mongodb/bson/binary/toarray.xml deleted file mode 100644 index 82f976f2dc..0000000000 --- a/reference/mongodb/bson/binary/toarray.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - MongoDB\BSON\Binary::toArray - Devuelve el vector como un array para un Binary con subtipo MongoDB\BSON\Binary::SUBTYPE_VECTOR - - - - &reftitle.description; - - final public arrayMongoDB\BSON\Binary::toArray - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un array que contiene los datos del vector. - - - - - &reftitle.errors; - - Lanza MongoDB\Driver\Exception\LogicException si el subtipo no es MongoDB\BSON\Binary::SUBTYPE_VECTOR. - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\BSON\Binary::fromVector - BSON Types - - - - - - diff --git a/reference/mongodb/bson/binary/tostring.xml b/reference/mongodb/bson/binary/tostring.xml deleted file mode 100644 index 9d3c711e48..0000000000 --- a/reference/mongodb/bson/binary/tostring.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - - MongoDB\BSON\Binary::__toString - Devuelve los datos de Binary - - - - &reftitle.description; - - final public stringMongoDB\BSON\Binary::__toString - - - - &info.method.alias; MongoDB\BSON\Binary::getData. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve los datos de Binary. - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\BSON\Binary::__toString</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Binary::getData - Tipos BSON - - - - - - diff --git a/reference/mongodb/bson/binaryinterface.xml b/reference/mongodb/bson/binaryinterface.xml deleted file mode 100644 index 9da185ec22..0000000000 --- a/reference/mongodb/bson/binaryinterface.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - La interfaz MongoDB\BSON\BinaryInterface - MongoDB\BSON\BinaryInterface - - -
    - &reftitle.intro; - - Esta interfaz es implementada por MongoDB\BSON\Binary - para ser utilizada como tipo de argumento, de retorno o de propiedad en las clases de usuario. - -
    - -
    - &reftitle.classsynopsis; - - MongoDB\BSON\BinaryInterface - - - MongoDB\BSON\BinaryInterface - - - &Methods; - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - &mongodb.changelog.tentative-return-types; - - - -
    -
    - - &reference.mongodb.bson.entities.binaryinterface; - -
    - - diff --git a/reference/mongodb/bson/binaryinterface/getdata.xml b/reference/mongodb/bson/binaryinterface/getdata.xml deleted file mode 100644 index 1a05c34965..0000000000 --- a/reference/mongodb/bson/binaryinterface/getdata.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - MongoDB\BSON\BinaryInterface::getData - Devuelve los datos de BinaryInterface - - - - &reftitle.description; - - abstract public stringMongoDB\BSON\BinaryInterface::getData - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve los datos de BinaryInterface. - - - - - &reftitle.seealso; - - MongoDB\BSON\Binary::getData - - - - - - diff --git a/reference/mongodb/bson/binaryinterface/gettype.xml b/reference/mongodb/bson/binaryinterface/gettype.xml deleted file mode 100644 index 8d3397baca..0000000000 --- a/reference/mongodb/bson/binaryinterface/gettype.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - MongoDB\BSON\BinaryInterface::getType - Devuelve el tipo de BinaryInterface - - - - &reftitle.description; - - abstract public intMongoDB\BSON\BinaryInterface::getType - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el tipo de BinaryInterface. - - - - - &reftitle.seealso; - - MongoDB\BSON\Binary::getType - - - - - - diff --git a/reference/mongodb/bson/binaryinterface/tostring.xml b/reference/mongodb/bson/binaryinterface/tostring.xml deleted file mode 100644 index 9077f775ef..0000000000 --- a/reference/mongodb/bson/binaryinterface/tostring.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - MongoDB\BSON\BinaryInterface::__toString - Devuelve los datos de BinaryInterface - - - - &reftitle.description; - - abstract public stringMongoDB\BSON\BinaryInterface::__toString - - - - &info.method.alias; MongoDB\BSON\BinaryInterface::getData. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve los datos de BinaryInterface. - - - - - &reftitle.seealso; - - MongoDB\BSON\BinaryInterface::getData - MongoDB\BSON\Binary::__toString - - - - - - diff --git a/reference/mongodb/bson/dbpointer.xml b/reference/mongodb/bson/dbpointer.xml deleted file mode 100644 index 4e094b6e1e..0000000000 --- a/reference/mongodb/bson/dbpointer.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - La clase MongoDB\BSON\DBPointer - MongoDB\BSON\DBPointer - - - - -
    - &reftitle.intro; - - El tipo BSON para el tipo "DBPointer". Este tipo BSON está deprecado, y esta - clase no puede ser instanciada. Será creada a partir de un tipo BSON DBPointer - durante la conversión BSON a PHP, y puede también ser convertida en - BSON durante el almacenamiento de documentos en la base de datos. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\DBPointer - - - - final - - MongoDB\BSON\DBPointer - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - Stringable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.12.0 - - Implementa Stringable para PHP 8.0+. - - - - - -
    - -
    - - &reference.mongodb.bson.entities.dbpointer; - -
    - - diff --git a/reference/mongodb/bson/dbpointer/construct.xml b/reference/mongodb/bson/dbpointer/construct.xml deleted file mode 100644 index ae45511101..0000000000 --- a/reference/mongodb/bson/dbpointer/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - MongoDB\BSON\DBPointer::__construct - Construye un nuevo DBPointer (no utilizado) - - - - &reftitle.description; - - final private MongoDB\BSON\DBPointer::__construct - - - - Los objetos MongoDB\BSON\DBPointer son creados a través - de una conversión desde un tipo BSON obsoleto y no pueden ser construidos directamente. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.seealso; - - Tipos BSON - - - - - - diff --git a/reference/mongodb/bson/dbpointer/jsonserialize.xml b/reference/mongodb/bson/dbpointer/jsonserialize.xml deleted file mode 100644 index 6db00315fb..0000000000 --- a/reference/mongodb/bson/dbpointer/jsonserialize.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - MongoDB\BSON\DBPointer::jsonSerialize - Devuelve una representación que puede ser convertida en JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\DBPointer::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve datos que pueden ser serializados por json_encode - para producir una representación JSON extendida de - MongoDB\BSON\DBPointer. - - &mongodb.note.extended-json; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB JSON Extendido - - - - - - diff --git a/reference/mongodb/bson/dbpointer/tostring.xml b/reference/mongodb/bson/dbpointer/tostring.xml deleted file mode 100644 index 95a13841b7..0000000000 --- a/reference/mongodb/bson/dbpointer/tostring.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - MongoDB\BSON\DBPointer::__toString - Devuelve un string vacío - - - - &reftitle.description; - - final public stringMongoDB\BSON\DBPointer::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un string vacío. - - - - - &reftitle.seealso; - - Tipos BSON - - - - - - diff --git a/reference/mongodb/bson/decimal128.xml b/reference/mongodb/bson/decimal128.xml deleted file mode 100644 index c54ea64e49..0000000000 --- a/reference/mongodb/bson/decimal128.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - La clase MongoDB\BSON\Decimal128 - MongoDB\BSON\Decimal128 - - - - -
    - &reftitle.intro; - - Tipo BSON para el - formato de coma flotante Decimal128, - que soporta números con hasta 34 dígitos decimales (i.e. dígitos - significativos) y un rango de exponentes de −6143 a +6144. - - - A diferencia del tipo BSON double (i.e. float en PHP), que solo - almacena una aproximación de los valores decimales, el tipo de datos decimal almacena - el valor exacto. Por ejemplo, MongoDB\BSON\Decimal128('9.99') - tiene un valor preciso de 9.99 mientras que un double 9.99 tendría un valor - aproximado de 9.9900000000000002131628…. - - &mongodb.note.decimal128; -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\Decimal128 - - - - final - - MongoDB\BSON\Decimal128 - - - - MongoDB\BSON\Decimal128Interface - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - Stringable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.12.0 - - Implementa Stringable para PHP 8.0+. - - - - PECL mongodb 1.3.0 - - Implementa MongoDB\BSON\Decimal128Interface. - - - - PECL mongodb 1.2.0 - - Implementa Serializable y - JsonSerializable. - - - - - -
    - -
    - - &reference.mongodb.bson.entities.decimal128; - -
    - - diff --git a/reference/mongodb/bson/decimal128/construct.xml b/reference/mongodb/bson/decimal128/construct.xml deleted file mode 100644 index 012a383368..0000000000 --- a/reference/mongodb/bson/decimal128/construct.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - - MongoDB\BSON\Decimal128::__construct - Construye un nuevo Decimal128 - - - - &reftitle.description; - - final public MongoDB\BSON\Decimal128::__construct - stringvalue - - &mongodb.note.decimal128; - - - - &reftitle.parameters; - - - value (&string;) - - - Una cadena decimal - - - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lanza MongoDB\Driver\Exception\InvalidArgumentException si value no es una cadena decimal válida. - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\BSON\Decimal128::__construct</function> - - -]]> - - &example.outputs.similar; - - - string(9) "1234.5678" -} -object(MongoDB\BSON\Decimal128)#1 (1) { - ["dec"]=> - string(3) "NaN" -} -object(MongoDB\BSON\Decimal128)#1 (1) { - ["dec"]=> - string(8) "Infinity" -} - -]]> - - - - - - &reftitle.seealso; - - Formato de coma flotante Decimal128 - Tipos BSON - - - - - - diff --git a/reference/mongodb/bson/decimal128/jsonserialize.xml b/reference/mongodb/bson/decimal128/jsonserialize.xml deleted file mode 100644 index f0282716f3..0000000000 --- a/reference/mongodb/bson/decimal128/jsonserialize.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - MongoDB\BSON\Decimal128::jsonSerialize - Devuelve una representación que puede ser convertida en JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\Decimal128::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve datos que pueden ser serializados por json_encode - para producir una representación JSON extendida de - MongoDB\BSON\Decimal128. - - &mongodb.note.extended-json; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB JSON Extendido - - - - - - diff --git a/reference/mongodb/bson/decimal128/tostring.xml b/reference/mongodb/bson/decimal128/tostring.xml deleted file mode 100644 index 36a44c5ff6..0000000000 --- a/reference/mongodb/bson/decimal128/tostring.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - - MongoDB\BSON\Decimal128::__toString - Devuelve la representación en forma de string de Decimal128 - - - - &reftitle.description; - - final public stringMongoDB\BSON\Decimal128::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la representación en forma de string de Decimal128. - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\BSON\Decimal128::__toString</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Formato de coma flotante Decimal128 - Tipos BSON - - - - - - diff --git a/reference/mongodb/bson/decimal128interface.xml b/reference/mongodb/bson/decimal128interface.xml deleted file mode 100644 index 134958d1e8..0000000000 --- a/reference/mongodb/bson/decimal128interface.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - La interfaz MongoDB\BSON\Decimal128Interface - MongoDB\BSON\Decimal128Interface - - -
    - &reftitle.intro; - - Esta interfaz es implementada por - MongoDB\BSON\Decimal128 para ser utilizada como tipo de argumento, - de retorno o de propiedad en las clases de usuario. - -
    - -
    - &reftitle.classsynopsis; - - MongoDB\BSON\Decimal128Interface - - - MongoDB\BSON\Decimal128Interface - - - &Methods; - - -
    -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - &mongodb.changelog.tentative-return-types; - - - -
    -
    - - &reference.mongodb.bson.entities.decimal128interface; - -
    - - diff --git a/reference/mongodb/bson/decimal128interface/tostring.xml b/reference/mongodb/bson/decimal128interface/tostring.xml deleted file mode 100644 index cff3bcd2c9..0000000000 --- a/reference/mongodb/bson/decimal128interface/tostring.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - MongoDB\BSON\Decimal128Interface::__toString - Devuelve una representación en string de Decimal128Interface - - - - &reftitle.description; - - abstract public stringMongoDB\BSON\Decimal128Interface::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una representación en string de Decimal128Interface. - - - - - &reftitle.seealso; - - MongoDB\BSON\Decimal128::__toString - - - - - - diff --git a/reference/mongodb/bson/document.xml b/reference/mongodb/bson/document.xml deleted file mode 100644 index c755376d94..0000000000 --- a/reference/mongodb/bson/document.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - la clase MongoDB\BSON\Document - MongoDB\BSON\Document - - - - -
    - &reftitle.intro; - - Representa un documento BSON. Esta clase se utiliza al leer datos como BSON sin tratar - y no puede ser modificada. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\Document - - - - final - - MongoDB\BSON\Document - - - - MongoDB\BSON\Type - - - - ArrayAccess - - - - IteratorAggregate - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.17.0 - - Implementa MongoDB\BSON\Type. - - - - - -
    - -
    - - &reference.mongodb.bson.entities.document; - -
    - - diff --git a/reference/mongodb/bson/document/construct.xml b/reference/mongodb/bson/document/construct.xml deleted file mode 100644 index 9e871ea438..0000000000 --- a/reference/mongodb/bson/document/construct.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\BSON\Document::__construct - Construye un nuevo documento BSON (no utilizado) - - - - &reftitle.description; - - final private MongoDB\BSON\Document::__construct - - - - Los objetos MongoDB\BSON\Document son creados a través - de métodos de fábrica estáticos y no pueden ser instanciados directamente. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.seealso; - - MongoDB\BSON\Document::fromPHP - MongoDB\BSON\Document::fromBSON - MongoDB\BSON\Document::fromJSON - Tipos BSON - - - - - - diff --git a/reference/mongodb/bson/document/frombson.xml b/reference/mongodb/bson/document/frombson.xml deleted file mode 100644 index 4e2ad50c9c..0000000000 --- a/reference/mongodb/bson/document/frombson.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - MongoDB\BSON\Document::fromBSON - Construye una nueva instancia de documento a partir de un string BSON - - - - &reftitle.description; - - final static public MongoDB\BSON\DocumentMongoDB\BSON\Document::fromBSON - stringbson - - - - - &reftitle.parameters; - - - bson (string) - - - Un string que contiene un documento en formato BSON. - - - - - - - - &reftitle.returnvalues; - - Devuelve una nueva instancia de MongoDB\BSON\Document. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lanza una MongoDB\Driver\Exception\UnexpectedValueException si bson es un string inválido o contiene más de un documento - - - - - &reftitle.seealso; - - MongoDB\BSON\Document::fromPHP - MongoDB\BSON\Document::fromJSON - BSON Types - - - - - - diff --git a/reference/mongodb/bson/document/fromjson.xml b/reference/mongodb/bson/document/fromjson.xml deleted file mode 100644 index f220c3e7fc..0000000000 --- a/reference/mongodb/bson/document/fromjson.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - MongoDB\BSON\Document::fromJSON - Construye una nueva instancia de documento desde un string JSON - - - - &reftitle.description; - - final static public MongoDB\BSON\DocumentMongoDB\BSON\Document::fromJSON - stringjson - - - Convierte un string - JSON extendido - a su representación BSON. - - - - - &reftitle.parameters; - - - json (string) - - - El valor JSON a convertir. - - - - - - - - &reftitle.returnvalues; - - Retorna una nueva instancia de MongoDB\BSON\Document. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - Lanza - MongoDB\Driver\Exception\UnexpectedValueException si - el valor JSON no puede ser convertido a un documento BSON (por ejemplo, debido a un error - de sintaxis). - - - - - - &reftitle.seealso; - - MongoDB\BSON\Document::fromPHP - MongoDB\BSON\Document::fromBSON - MongoDB JSON extendido - Tipo BSON - - - - - - diff --git a/reference/mongodb/bson/document/fromphp.xml b/reference/mongodb/bson/document/fromphp.xml deleted file mode 100644 index fdbf71bfd2..0000000000 --- a/reference/mongodb/bson/document/fromphp.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - MongoDB\BSON\Document::fromPHP - Construye una nueva instancia de documento a partir de datos PHP - - - - &reftitle.description; - - final static public MongoDB\BSON\DocumentMongoDB\BSON\Document::fromPHP - objectarrayvalue - - - - - &reftitle.parameters; - - - value (objectarray) - - - Un objeto PHP o un array que contiene el documento. Cuando se pasa un array con claves numéricas, los valores numéricos se convierten en strings y se utilizan como claves del documento. - - - - - - - - &reftitle.returnvalues; - - Devuelve una nueva instancia de MongoDB\BSON\Document. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\BSON\Document::fromBSON - MongoDB\BSON\Document::fromJSON - Tipos BSON - - - - - - diff --git a/reference/mongodb/bson/document/get.xml b/reference/mongodb/bson/document/get.xml deleted file mode 100644 index d11b770145..0000000000 --- a/reference/mongodb/bson/document/get.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - MongoDB\BSON\Document::get - Devuelve el valor de una clave en un documento - - - - &reftitle.description; - - final public mixedMongoDB\BSON\Document::get - stringkey - - - - - &reftitle.parameters; - - - key (string) - - - La clave a recuperar en el documento. - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor asociado a la clave dada. Si la clave no está presente en - el documento, se lanza una excepción. - - - - Cuando se encuentra un valor codificado como un entero de 64 bits en el documento BSON, - el valor de retorno de este método será una - instancia de MongoDB\BSON\Int64. - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lanza una MongoDB\Driver\Exception\RuntimeException si la clave no está presente en el documento. - - - - - &reftitle.seealso; - - MongoDB\BSON\Document::has - Tipos BSON - - - - - - diff --git a/reference/mongodb/bson/document/getiterator.xml b/reference/mongodb/bson/document/getiterator.xml deleted file mode 100644 index 1e70c0ff48..0000000000 --- a/reference/mongodb/bson/document/getiterator.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - MongoDB\BSON\Document::getIterator - Devuelve un iterador para el documento BSON - - - - &reftitle.description; - - final public MongoDB\BSON\IteratorMongoDB\BSON\Document::getIterator - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una instancia de MongoDB\BSON\Iterator que puede ser - utilizada para iterar sobre todas las claves del documento. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lanza una MongoDB\Driver\Exception\UnexpectedValueException si el iterador BSON no puede ser inicializado. - - - - - &reftitle.seealso; - - Tipos BSON - - - - - - diff --git a/reference/mongodb/bson/document/has.xml b/reference/mongodb/bson/document/has.xml deleted file mode 100644 index b24dabecac..0000000000 --- a/reference/mongodb/bson/document/has.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - MongoDB\BSON\Document::has - Indica si una clave está presente en el documento - - - - &reftitle.description; - - final public boolMongoDB\BSON\Document::has - stringkey - - - - - &reftitle.parameters; - - - key (string) - - - La clave a buscar en el documento. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si la clave está presente en el documento, de lo contrario &false;. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\BSON\Document::get - Tipos BSON - - - - - - diff --git a/reference/mongodb/bson/document/offsetexists.xml b/reference/mongodb/bson/document/offsetexists.xml deleted file mode 100644 index 2c3370db35..0000000000 --- a/reference/mongodb/bson/document/offsetexists.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - MongoDB\BSON\Document::offsetExists - Indica si una clave está presente en el documento - - - &reftitle.description; - - final public boolMongoDB\BSON\Document::offsetExists - mixedkey - - - - - &reftitle.parameters; - - - - key - - - La clave a buscar en el documento. - - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si la clave está presente en el documento, de lo contrario &false;. - - - - - &reftitle.seealso; - - - ArrayAccess::offsetExists - MongoDB\BSON\Document::has - - - - - - diff --git a/reference/mongodb/bson/document/offsetget.xml b/reference/mongodb/bson/document/offsetget.xml deleted file mode 100644 index c1499ad71f..0000000000 --- a/reference/mongodb/bson/document/offsetget.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - MongoDB\BSON\Document::offsetGet - Devuelve el valor de una clave en un documento - - - &reftitle.description; - - final public mixedMongoDB\BSON\Document::offsetGet - mixedkey - - - - - &reftitle.parameters; - - - - key - - - La clave a recuperar en el documento. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor asociado a la clave dada. Si la clave no está presente en - el documento, se lanza una excepción. - - - - Cuando se encuentra un valor codificado como un entero de 64 bits en el documento BSON, - el valor de retorno de este método será una - instancia de MongoDB\BSON\Int64. - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lanza una MongoDB\Driver\Exception\RuntimeException si la clave no está presente en el documento. - - - - - &reftitle.seealso; - - - ArrayAccess::offsetGet - MongoDB\BSON\Document::get - - - - - - diff --git a/reference/mongodb/bson/document/offsetset.xml b/reference/mongodb/bson/document/offsetset.xml deleted file mode 100644 index 9f552e84de..0000000000 --- a/reference/mongodb/bson/document/offsetset.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - MongoDB\BSON\Document::offsetSet - Implementación de ArrayAccess - - - &reftitle.description; - - final public voidMongoDB\BSON\Document::offsetSet - mixedkey - mixedvalue - - - - Cambia el valor en la key especificada por value. - - - - - &reftitle.parameters; - - - - key - - - El índice a definir. - - - - - value - - - El nuevo valor para la key. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Siempre lanza una MongoDB\Driver\Exception\LogicException. - - - - - diff --git a/reference/mongodb/bson/document/offsetunset.xml b/reference/mongodb/bson/document/offsetunset.xml deleted file mode 100644 index f3fada8238..0000000000 --- a/reference/mongodb/bson/document/offsetunset.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - MongoDB\BSON\Document::offsetUnset - Implementación de ArrayAccess - - - &reftitle.description; - - final public voidMongoDB\BSON\Document::offsetUnset - mixedkey - - - Elimina el valor en el índice especificado. - - - - - &reftitle.parameters; - - - - key - - - El índice a eliminar. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Siempre lanza una MongoDB\Driver\Exception\LogicException. - - - - - diff --git a/reference/mongodb/bson/document/tocanonicalextendedjson.xml b/reference/mongodb/bson/document/tocanonicalextendedjson.xml deleted file mode 100644 index 3743ef3310..0000000000 --- a/reference/mongodb/bson/document/tocanonicalextendedjson.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - MongoDB\BSON\Document::toCanonicalExtendedJSON - Devuelve la representación Canónica Extendida JSON del documento BSON - - - - &reftitle.description; - - final public stringMongoDB\BSON\Document::toCanonicalExtendedJSON - - - - Convierte el documento BSON en su - representación Canónica Extendida JSON. - El formato canónico prefiere la fidelidad de los tipos a la salida concisa y es el más adecuado para producir una salida que puede ser convertida - en BSON sin pérdida de información de tipo (por ejemplo, los tipos numéricos - permanecerán diferenciados). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un string que contiene la - representación Canonical Extended JSON - del documento BSON. - - - - - &reftitle.examples; - - Ejemplo de <methodname>MongoDB\BSON\Document::toCanonicalExtendedJSON</methodname> - - null ], - [ 'boolean' => true ], - [ 'string' => 'foo' ], - [ 'int32' => 123 ], - [ 'int64' => 4294967295 ], - [ 'double' => 1.0 ], - [ 'nan' => NAN ], - [ 'pos_inf' => INF ], - [ 'neg_inf' => -INF ], - [ 'array' => [ 'foo', 'bar' ]], - [ 'document' => [ 'foo' => 'bar' ]], - [ 'oid' => new MongoDB\BSON\ObjectId('56315a7c6118fd1b920270b1') ], - [ 'dec128' => new MongoDB\BSON\Decimal128('1234.5678') ], - [ 'binary' => new MongoDB\BSON\Binary('foo', MongoDB\BSON\Binary::TYPE_GENERIC) ], - [ 'date' => new MongoDB\BSON\UTCDateTime(1445990400000) ], - [ 'timestamp' => new MongoDB\BSON\Timestamp(1234, 5678) ], - [ 'regex' => new MongoDB\BSON\Regex('pattern', 'i') ], - [ 'code' => new MongoDB\BSON\Javascript('function() { return 1; }') ], - [ 'code_ws' => new MongoDB\BSON\Javascript('function() { return a; }', ['a' => 1]) ], - [ 'minkey' => new MongoDB\BSON\MinKey ], - [ 'maxkey' => new MongoDB\BSON\MaxKey ], -]; - -foreach ($documents as $document) { - $bson = MongoDB\BSON\Document::fromPHP($document); - echo $bson->toCanonicalExtendedJSON(), "\n"; -} - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Document::fromJSON - MongoDB\BSON\Document::toRelaxedExtendedJSON - MongoDB\BSON\toCanonicalExtendedJSON - Canónica Extendida JSON - Tipos BSON - - - - - - diff --git a/reference/mongodb/bson/document/tophp.xml b/reference/mongodb/bson/document/tophp.xml deleted file mode 100644 index cb62b5f674..0000000000 --- a/reference/mongodb/bson/document/tophp.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - MongoDB\BSON\Document::toPHP - Devuelve la representación PHP del documento BSON - - - - &reftitle.description; - - final public arrayobjectMongoDB\BSON\Document::toPHP - arraynulltypeMap&null; - - - Deserializa el documento BSON en su representación PHP. El parámetro - typeMap puede ser utilizado para controlar los tipos PHP - utilizados para convertir los arrays y documentos BSON (raíz e integrados). - - &mongodb.warning.duplicate-keys; - - - - &reftitle.parameters; - - &mongodb.parameter.typeMap; - - - - - &reftitle.returnvalues; - - El valor decodificado PHP. - - - - Cuando se encuentra un valor codificado como un entero de 64 bits en el documento BSON, - el valor de retorno de este método será una - instancia de MongoDB\BSON\Int64. - - - - - - &reftitle.errors; - - - Lanza una - MongoDB\Driver\Exception\InvalidArgumentException si - un tipo en el mapa de tipos no puede ser instanciado o no implementa - MongoDB\BSON\Unserializable. - - - - - - &reftitle.seealso; - - MongoDB\BSON\toPHP - Tipos BSON - - - - - - diff --git a/reference/mongodb/bson/document/torelaxedextendedjson.xml b/reference/mongodb/bson/document/torelaxedextendedjson.xml deleted file mode 100644 index 68a10cfbfd..0000000000 --- a/reference/mongodb/bson/document/torelaxedextendedjson.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - MongoDB\BSON\Document::toRelaxedExtendedJSON - Devuelve la representación relajada extendida JSON del documento BSON - - - - &reftitle.description; - - final public stringMongoDB\BSON\Document::toRelaxedExtendedJSON - - - - Convierte el documento BSON en su representación - Relajada Extendida JSON. - El formato relajado prefiere el uso de las primitivas de tipo JSON en detrimento de la fidelidad de los tipos y es el más adecuado para producir una salida que puede ser - fácilmente consumida por las API web y los humanos. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un string que contiene la - representación Relaxed Extended JSON - del documento BSON. - - - - - &reftitle.examples; - - Ejemplo de <methodname>MongoDB\BSON\Document::toRelaxedExtendedJSON</methodname> - - null ], - [ 'boolean' => true ], - [ 'string' => 'foo' ], - [ 'int32' => 123 ], - [ 'int64' => 4294967295 ], - [ 'double' => 1.0 ], - [ 'nan' => NAN ], - [ 'pos_inf' => INF ], - [ 'neg_inf' => -INF ], - [ 'array' => [ 'foo', 'bar' ]], - [ 'document' => [ 'foo' => 'bar' ]], - [ 'oid' => new MongoDB\BSON\ObjectId('56315a7c6118fd1b920270b1') ], - [ 'dec128' => new MongoDB\BSON\Decimal128('1234.5678') ], - [ 'binary' => new MongoDB\BSON\Binary('foo', MongoDB\BSON\Binary::TYPE_GENERIC) ], - [ 'date' => new MongoDB\BSON\UTCDateTime(1445990400000) ], - [ 'timestamp' => new MongoDB\BSON\Timestamp(1234, 5678) ], - [ 'regex' => new MongoDB\BSON\Regex('pattern', 'i') ], - [ 'code' => new MongoDB\BSON\Javascript('function() { return 1; }') ], - [ 'code_ws' => new MongoDB\BSON\Javascript('function() { return a; }', ['a' => 1]) ], - [ 'minkey' => new MongoDB\BSON\MinKey ], - [ 'maxkey' => new MongoDB\BSON\MaxKey ], -]; - -foreach ($documents as $document) { - $bson = MongoDB\BSON\Document::fromPHP($document); - echo $bson->toRelaxedExtendedJSON(), "\n"; -} - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Document::fromJSON - MongoDB\BSON\Document::toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - Especificación JSON extendida - Tipos BSON - - - - - - diff --git a/reference/mongodb/bson/document/tostring.xml b/reference/mongodb/bson/document/tostring.xml deleted file mode 100644 index c536a93dd5..0000000000 --- a/reference/mongodb/bson/document/tostring.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\BSON\Document::__toString - Devuelve la representación en string de este documento BSON - - - - &reftitle.description; - - final public stringMongoDB\BSON\Document::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la representación en string de este documento BSON. - - - - - &reftitle.seealso; - - Tipos BSON - - - - - - diff --git a/reference/mongodb/bson/int64.xml b/reference/mongodb/bson/int64.xml deleted file mode 100644 index 05fc96776e..0000000000 --- a/reference/mongodb/bson/int64.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - La clase MongoDB\BSON\Int64 - MongoDB\BSON\Int64 - - - - -
    - &reftitle.intro; - - Tipo BSON para un entero de 64 bits. Al decodificar BSON en datos PHP, esta clase - se utiliza cuando un entero de 64 bits no puede ser representado como un entero PHP en - plataformas de 32 bits. Estos objetos soportan los operadores - aritméticos, - a nivel de bits, y - comparación sobrecargados. - - - Al trabajar con datos BSON sin tratar a través de las clases - MongoDB\BSON\Document, - MongoDB\BSON\PackedArray, y - MongoDB\BSON\Iterator, cualquier entero de 64 bits - será devuelto como una instancia de esta clase, independientemente de la plataforma y - de la posibilidad de representar el valor como un entero PHP. Esto garantiza que - los valores pueden ser recorridos sin cambiar el tipo. - - - Al codificar BSON, los objetos de esta clase serán convertidos en un tipo entero - 64 bits, incluso cuando el valor podría caber en un entero de 32 bits. Esto - permite almacenar explícitamente valores como enteros de 64 bits en BSON. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\Int64 - - - - final - - MongoDB\BSON\Int64 - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - Stringable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.16.0 - - Esta clase puede ahora ser instanciada en todas las plataformas. Se añade soporte para - los operadores aritméticos, a nivel de bits, y de comparación sobrecargados. - - - - PECL mongodb 1.12.0 - - Implementa Stringable para PHP 8.0+. - - - - - -
    - -
    - - &reference.mongodb.bson.entities.int64; - -
    - - diff --git a/reference/mongodb/bson/int64/construct.xml b/reference/mongodb/bson/int64/construct.xml deleted file mode 100644 index d1097bea63..0000000000 --- a/reference/mongodb/bson/int64/construct.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - - MongoDB\BSON\Int64::__construct - Construye un nuevo Int64 - - - - &reftitle.description; - - final public MongoDB\BSON\Int64::__construct - intstringvalue - - - Crea una nueva instancia de MongoDB\BSON\Int64 para el - valor entero dado. - - - - - &reftitle.parameters; - - - value (intstring) - - - El valor a asignar a la instancia de Int64. Este - valor puede ser proporcionado como int o string, - siendo este último requerido en plataformas de 32 bits para representar valores de 64 bits. - - - - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.16.0 - - - Este método se hizo público para soportar la creación de instancias Int64 durante la manipulación de BSON sin tratar. - - - - - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lanza una MongoDB\Driver\Exception\InvalidArgumentException si el string - value no puede ser analizado como un entero de 64 bits. - - - - - &reftitle.seealso; - - Tipos BSON - - - - - - diff --git a/reference/mongodb/bson/int64/jsonserialize.xml b/reference/mongodb/bson/int64/jsonserialize.xml deleted file mode 100644 index 18308ba859..0000000000 --- a/reference/mongodb/bson/int64/jsonserialize.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - MongoDB\BSON\Int64::jsonSerialize - Devuelve una representación que puede ser convertida a JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\Int64::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve datos que pueden ser serializados por json_encode - para producir una representación JSON extendida de - MongoDB\BSON\Int64. - - - - La salida es concordante con la función - MongoDB\BSON\toCanonicalExtendedJSON, que - utiliza el formato JSON extendido - canonical. - Esto difiere de otras clases BDON, que utilizan el formato - JSON extendido heredado del controlador específico - (MongoDB\BSON\toJSON), para asegurar que los - valores enteros de 64 bits sean correctamente representados en plataformas de 32 bits. - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB JSON Extendido - - - - - - diff --git a/reference/mongodb/bson/int64/tostring.xml b/reference/mongodb/bson/int64/tostring.xml deleted file mode 100644 index 55efed0c20..0000000000 --- a/reference/mongodb/bson/int64/tostring.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - MongoDB\BSON\Int64::__toString - Devuelve la representación en forma de string de Int64 - - - - &reftitle.description; - - final public stringMongoDB\BSON\Int64::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la representación en forma de string de Int64. - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\BSON\Int64::__toString</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Tipos BSON - - - - - - diff --git a/reference/mongodb/bson/iterator.xml b/reference/mongodb/bson/iterator.xml deleted file mode 100644 index 4e240a4280..0000000000 --- a/reference/mongodb/bson/iterator.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - La clase MongoDB\BSON\Iterator - MongoDB\BSON\Iterator - - - - -
    - &reftitle.intro; - - Iterador utilizado para recorrer un documento o un array BSON. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\Iterator - - - - final - - MongoDB\BSON\Iterator - - - - Iterator - - - - - &Methods; - - - - -
    - -
    - - &reference.mongodb.bson.entities.iterator; - -
    - - diff --git a/reference/mongodb/bson/iterator/construct.xml b/reference/mongodb/bson/iterator/construct.xml deleted file mode 100644 index 64c179e8e5..0000000000 --- a/reference/mongodb/bson/iterator/construct.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - MongoDB\BSON\Iterator::__construct - Construye un nuevo iterador BSON (no utilizado) - - - - &reftitle.description; - - final private MongoDB\BSON\Iterator::__construct - - - - Los objetos MongoDB\BSON\Iterator se crean llamando a - MongoDB\BSON\Document::getIterator o - MongoDB\BSON\PackedArray::getIterator y no pueden ser - instanciados directamente. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.seealso; - - MongoDB\BSON\Document::getIterator - MongoDB\BSON\PackedArray::getIterator - Tipos BSON - - - - - - diff --git a/reference/mongodb/bson/iterator/current.xml b/reference/mongodb/bson/iterator/current.xml deleted file mode 100644 index da392eaf59..0000000000 --- a/reference/mongodb/bson/iterator/current.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - MongoDB\BSON\Iterator::current - Devuelve el elemento actual/corriente - - - - &reftitle.description; - - public mixedMongoDB\BSON\Iterator::current - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el valor del elemento actual/corriente. - - - - Cuando un valor es codificado como un integer de 64 bits en la estructura BSON es encontrado, - el valor de retorno de este método será una instancia de - MongoDB\BSON\Int64. - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lanza una MongoDB\Driver\Exception\LogicException si el iterador no es válido. - - - - - &reftitle.seealso; - - Iterator::current - - - - diff --git a/reference/mongodb/bson/iterator/key.xml b/reference/mongodb/bson/iterator/key.xml deleted file mode 100644 index 1d4f75fcbc..0000000000 --- a/reference/mongodb/bson/iterator/key.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - MongoDB\BSON\Iterator::key - Devuelve la clave del elemento actual/corriente - - - - &reftitle.description; - - public stringintMongoDB\BSON\Iterator::key - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la clave del elemento actual/corriente. Durante la iteración de un documento BSON, la - clave será siempre una string. Durante la iteración de un array BSON, la - clave será un int. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lanza una MongoDB\Driver\Exception\LogicException si el iterador no es válido. - - - - - &reftitle.seealso; - - Iterator::key - - - - diff --git a/reference/mongodb/bson/iterator/next.xml b/reference/mongodb/bson/iterator/next.xml deleted file mode 100644 index 0643579be7..0000000000 --- a/reference/mongodb/bson/iterator/next.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - MongoDB\BSON\Iterator::next - Avance el iterador al siguiente elemento - - - - &reftitle.description; - - public voidMongoDB\BSON\Iterator::next - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.seealso; - - Iterator::next - - - - diff --git a/reference/mongodb/bson/iterator/rewind.xml b/reference/mongodb/bson/iterator/rewind.xml deleted file mode 100644 index ca0bacaf08..0000000000 --- a/reference/mongodb/bson/iterator/rewind.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - MongoDB\BSON\Iterator::rewind - Rebobina el iterador al elemento anterior - - - - &reftitle.description; - - public voidMongoDB\BSON\Iterator::rewind - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.seealso; - - Iterator::rewind - - - - diff --git a/reference/mongodb/bson/iterator/valid.xml b/reference/mongodb/bson/iterator/valid.xml deleted file mode 100644 index a7593e0faa..0000000000 --- a/reference/mongodb/bson/iterator/valid.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - MongoDB\BSON\Iterator::valid - Verifica si la posición actual es válida - - - - &reftitle.description; - - public boolMongoDB\BSON\Iterator::valid - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si la posición actual del iterador es válida, de lo contrario &false;. - - - - - &reftitle.seealso; - - Iterator::valid - - - - diff --git a/reference/mongodb/bson/javascript.xml b/reference/mongodb/bson/javascript.xml deleted file mode 100644 index 34ae499183..0000000000 --- a/reference/mongodb/bson/javascript.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - La clase MongoDB\BSON\Javascript - MongoDB\BSON\Javascript - - - - -
    - &reftitle.intro; - - Tipo BSON para el código JavaScript. Un documento de ámbito opcional puede - ser especificado que mapea los identificadores a los valores y define el ámbito - en el cual el código debe ser evaluado por el servidor. - - - - Este tipo BSON es principalmente utilizado durante la ejecución de comandos - de base de datos que toman una función JavaScript como argumento, tal como - mapReduce. - - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\Javascript - - - - final - - MongoDB\BSON\Javascript - - - - MongoDB\BSON\JavascriptInterface - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - Stringable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.12.0 - - Implementa Stringable para PHP 8.0+. - - - - PECL mongodb 1.3.0 - - Implementa MongoDB\BSON\JavascriptInterface. - - - - PECL mongodb 1.2.0 - - Implementa Serializable y - JsonSerializable. - - - - - -
    - -
    - - &reference.mongodb.bson.entities.javascript; - -
    - - diff --git a/reference/mongodb/bson/javascript/construct.xml b/reference/mongodb/bson/javascript/construct.xml deleted file mode 100644 index 39c1092a82..0000000000 --- a/reference/mongodb/bson/javascript/construct.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - - MongoDB\BSON\Javascript::__construct - Construye un nuevo objeto Javascript - - - - &reftitle.description; - - final public MongoDB\BSON\Javascript::__construct - stringcode - arrayobjectnullscope&null; - - - - - &reftitle.parameters; - - - code (string) - - - El código Javascript. - - - - - scope (arrayobject) - - - El ámbito del Javascript. - - - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lanza MongoDB\Driver\Exception\InvalidArgumentException si code contiene un byte nulo. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.2.0 - - - MongoDB\Driver\Exception\InvalidArgumentException - se lanza si code contiene un byte nulo. - Anteriormente, los valores eran truncados en el primer byte nulo. - - - - - - - - - - &reftitle.examples; - - <function>MongoDB\BSON\Javascript::__construct</function> example - - 'bar']); -var_dump($codews); - -?> -]]> - - &example.outputs; - - - string(24) "function() { return 1; }" - ["scope"]=> - object(stdClass)#2 (0) { - } -} -object(MongoDB\BSON\Javascript)#2 (2) { - ["javascript"]=> - string(26) "function() { return foo; }" - ["scope"]=> - object(stdClass)#1 (1) { - ["foo"]=> - string(3) "bar" - } -} -]]> - - - - - - &reftitle.seealso; - - Los tipos BSON - - - - - - diff --git a/reference/mongodb/bson/javascript/getcode.xml b/reference/mongodb/bson/javascript/getcode.xml deleted file mode 100644 index 827e524748..0000000000 --- a/reference/mongodb/bson/javascript/getcode.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - - - MongoDB\BSON\Javascript::getCode - Devuelve el código Javascript - - - - &reftitle.description; - - final public stringMongoDB\BSON\Javascript::getCode - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el código Javascript. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\BSON\Javascript::getCode</function> - -getCode()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - Tipos BSON - - - - - - diff --git a/reference/mongodb/bson/javascript/getscope.xml b/reference/mongodb/bson/javascript/getscope.xml deleted file mode 100644 index 69332550ca..0000000000 --- a/reference/mongodb/bson/javascript/getscope.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - - MongoDB\BSON\Javascript::getScope - Devuelve el documento de ámbito de Javascript - - - - &reftitle.description; - - final public objectnullMongoDB\BSON\Javascript::getScope - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el documento de ámbito de Javascript, o &null; si no tiene ámbito. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\BSON\Javascript::getScope</function> - -getScope()); - -$js = new MongoDB\BSON\Javascript('function foo() { return foo; }', ['foo' => 42]); -var_dump($js->getScope()); - -?> -]]> - - &example.outputs; - - - int(42) -} -]]> - - - - - - &reftitle.seealso; - - Tipos BSON - - - - - - diff --git a/reference/mongodb/bson/javascript/jsonserialize.xml b/reference/mongodb/bson/javascript/jsonserialize.xml deleted file mode 100644 index 21c2ad9dac..0000000000 --- a/reference/mongodb/bson/javascript/jsonserialize.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - MongoDB\BSON\Javascript::jsonSerialize - Devuelve una representación que puede ser convertida en JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\Javascript::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve datos que pueden ser serializados por json_encode - para producir una representación JSON extendida de - MongoDB\BSON\Javascript. - - &mongodb.note.extended-json; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB JSON Extendido - - - - - - diff --git a/reference/mongodb/bson/javascript/tostring.xml b/reference/mongodb/bson/javascript/tostring.xml deleted file mode 100644 index dfb5a3be9e..0000000000 --- a/reference/mongodb/bson/javascript/tostring.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - - MongoDB\BSON\Javascript::__toString - Devuelve el código Javascript - - - - &reftitle.description; - - final public stringMongoDB\BSON\Javascript::__toString - - - - &info.method.alias; MongoDB\BSON\Javascript::getCode. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el código Javascript. - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\BSON\Javascript::__toString</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Javascript::getCode - Tipos BSON - - - - - - diff --git a/reference/mongodb/bson/javascriptinterface.xml b/reference/mongodb/bson/javascriptinterface.xml deleted file mode 100644 index fab788e030..0000000000 --- a/reference/mongodb/bson/javascriptinterface.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - La interfaz MongoDB\BSON\JavascriptInterface - MongoDB\BSON\JavascriptInterface - - -
    - &reftitle.intro; - - Esta interfaz es implementada por - MongoDB\BSON\Javascript para ser utilizada como tipo de argumento, - de retorno o de propiedad en las clases de usuario. - -
    - -
    - &reftitle.classsynopsis; - - MongoDB\BSON\JavascriptInterface - - - MongoDB\BSON\JavascriptInterface - - - &Methods; - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - &mongodb.changelog.tentative-return-types; - - - -
    -
    - - &reference.mongodb.bson.entities.javascriptinterface; - -
    - - diff --git a/reference/mongodb/bson/javascriptinterface/getcode.xml b/reference/mongodb/bson/javascriptinterface/getcode.xml deleted file mode 100644 index b9de7977db..0000000000 --- a/reference/mongodb/bson/javascriptinterface/getcode.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - MongoDB\BSON\JavascriptInterface::getCode - Devuelve el código de JavascriptInterface - - - - &reftitle.description; - - abstract public stringMongoDB\BSON\JavascriptInterface::getCode - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el código de JavascriptInterface. - - - - - &reftitle.seealso; - - MongoDB\BSON\Javascript::getCode - - - - - - diff --git a/reference/mongodb/bson/javascriptinterface/getscope.xml b/reference/mongodb/bson/javascriptinterface/getscope.xml deleted file mode 100644 index b02b005650..0000000000 --- a/reference/mongodb/bson/javascriptinterface/getscope.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - MongoDB\BSON\JavascriptInterface::getScope - Devuelve el documento de ámbito de JavascriptInterface - - - - &reftitle.description; - - abstract public objectnullMongoDB\BSON\JavascriptInterface::getScope - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el documento de ámbito de JavascriptInterface. - - - - - &reftitle.seealso; - - MongoDB\BSON\Javascript::getScope - - - - - - diff --git a/reference/mongodb/bson/javascriptinterface/tostring.xml b/reference/mongodb/bson/javascriptinterface/tostring.xml deleted file mode 100644 index b5222f9672..0000000000 --- a/reference/mongodb/bson/javascriptinterface/tostring.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - MongoDB\BSON\JavascriptInterface::__toString - Devuelve el código de JavascriptInterface - - - - &reftitle.description; - - abstract public stringMongoDB\BSON\JavascriptInterface::__toString - - - - &info.method.alias; MongoDB\BSON\JavascriptInterface::getCode. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el código de JavascriptInterface. - - - - - &reftitle.seealso; - - MongoDB\BSON\JavascriptInterface::getCode - MongoDB\BSON\Javascript::__toString - - - - - - diff --git a/reference/mongodb/bson/maxkey.xml b/reference/mongodb/bson/maxkey.xml deleted file mode 100644 index a4cb2385f3..0000000000 --- a/reference/mongodb/bson/maxkey.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - La clase MongoDB\BSON\MaxKey - MongoDB\BSON\MaxKey - - - - -
    - &reftitle.intro; - - Tipo BSON especial que compara el valor más grande posible de todos los - otros valores de elementos BSON posibles. - - - - Se trata de un tipo interno de MongoDB utilizado para la indexación y la - desfragmentación. - - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\MaxKey - - - - final - - MongoDB\BSON\MaxKey - - - - MongoDB\BSON\MaxKeyInterface - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.3.0 - - Implementa MongoDB\BSON\MaxKeyInterface. - - - - PECL mongodb 1.2.0 - - Implementa Serializable y - JsonSerializable. - - - - - -
    - -
    - - &reference.mongodb.bson.entities.maxkey; - -
    - - diff --git a/reference/mongodb/bson/maxkey/construct.xml b/reference/mongodb/bson/maxkey/construct.xml deleted file mode 100644 index 3ab3364c9b..0000000000 --- a/reference/mongodb/bson/maxkey/construct.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - MongoDB\BSON\MaxKey::__construct - Construye un nuevo MaxKey - - - - &reftitle.description; - - final public MongoDB\BSON\MaxKey::__construct - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\BSON\MaxKey::__construct</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - Tipos BSON - - - - - - diff --git a/reference/mongodb/bson/maxkey/jsonserialize.xml b/reference/mongodb/bson/maxkey/jsonserialize.xml deleted file mode 100644 index 278a1fab18..0000000000 --- a/reference/mongodb/bson/maxkey/jsonserialize.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - MongoDB\BSON\MaxKey::jsonSerialize - Devuelve una representación que puede ser convertida en JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\MaxKey::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve datos que pueden ser serializados por json_encode - para producir una representación JSON extendida de - MongoDB\BSON\MaxKey. - - &mongodb.note.extended-json; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB JSON Extendido - - - - - - diff --git a/reference/mongodb/bson/maxkeyinterface.xml b/reference/mongodb/bson/maxkeyinterface.xml deleted file mode 100644 index 628bcfb914..0000000000 --- a/reference/mongodb/bson/maxkeyinterface.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - La interfaz MongoDB\BSON\MaxKeyInterface - MongoDB\BSON\MaxKeyInterface - - -
    - &reftitle.intro; - - Esta interfaz es implementada por MongoDB\BSON\MaxKey - para ser utilizada como tipo de argumento, de retorno o de propiedad en las clases de usuario. - -
    - -
    - &reftitle.classsynopsis; - - MongoDB\BSON\MaxKeyInterface - - - MongoDB\BSON\MaxKeyInterface - - - - - - Esta interfaz no contiene métodos. - -
    -
    - -
    - - diff --git a/reference/mongodb/bson/minkey.xml b/reference/mongodb/bson/minkey.xml deleted file mode 100644 index d82bf88271..0000000000 --- a/reference/mongodb/bson/minkey.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - La clase MongoDB\BSON\MinKey - MongoDB\BSON\MinKey - - - - -
    - &reftitle.intro; - - Tipo BSON especial que compara el valor más pequeño posible de todos los demás valores de elementos BSON posibles. - - - - Se trata de un tipo interno de MongoDB utilizado para la indexación y la desfragmentación. - - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\MinKey - - - - final - - MongoDB\BSON\MinKey - - - - MongoDB\BSON\MinKeyInterface - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.3.0 - - Implementa MongoDB\BSON\MinKeyInterface. - - - - PECL mongodb 1.2.0 - - Implementa Serializable y - JsonSerializable. - - - - - -
    - -
    - - &reference.mongodb.bson.entities.minkey; - -
    - - diff --git a/reference/mongodb/bson/minkey/construct.xml b/reference/mongodb/bson/minkey/construct.xml deleted file mode 100644 index d4ba803245..0000000000 --- a/reference/mongodb/bson/minkey/construct.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - MongoDB\BSON\MinKey::__construct - Construye un nuevo MinKey - - - - &reftitle.description; - - final public MongoDB\BSON\MinKey::__construct - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\BSON\MinKey::__construct</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - Tipos BSON - - - - - - diff --git a/reference/mongodb/bson/minkey/jsonserialize.xml b/reference/mongodb/bson/minkey/jsonserialize.xml deleted file mode 100644 index 6f4733e42a..0000000000 --- a/reference/mongodb/bson/minkey/jsonserialize.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - MongoDB\BSON\MinKey::jsonSerialize - Devuelve una representación que puede ser convertida en JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\MinKey::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve datos que pueden ser serializados por json_encode - para producir una representación JSON extendida de - MongoDB\BSON\MinKey. - - &mongodb.note.extended-json; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB JSON Extendido - - - - - - diff --git a/reference/mongodb/bson/minkeyinterface.xml b/reference/mongodb/bson/minkeyinterface.xml deleted file mode 100644 index b6fc231454..0000000000 --- a/reference/mongodb/bson/minkeyinterface.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - La interfaz MongoDB\BSON\MinKeyInterface - MongoDB\BSON\MinKeyInterface - - -
    - &reftitle.intro; - - Esta interfaz es implementada por MongoDB\BSON\MinKey - para ser utilizada como tipo de argumento, de retorno o de propiedad en las clases de usuario. - -
    - -
    - &reftitle.classsynopsis; - - MongoDB\BSON\MinKeyInterface - - - MongoDB\BSON\MinKeyInterface - - - - - - Esta interfaz no contiene métodos. - -
    -
    - -
    - - diff --git a/reference/mongodb/bson/objectid.xml b/reference/mongodb/bson/objectid.xml deleted file mode 100644 index 9ea36919af..0000000000 --- a/reference/mongodb/bson/objectid.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - La clase MongoDB\BSON\ObjectId - MongoDB\BSON\ObjectId - - - - -
    - &reftitle.intro; - - Tipo BSON para un - ObjectId. El - valor se compone de 12 bytes, donde los primeros cuatro bytes son un - timestamp que refleja la creación del ObjectId. Más precisamente, - el valor se compone de : - - - un valor de 4 bytes representando los segundos desde la época UNIX, - un número aleatorio de 5 bytes único a una máquina y un proceso, y - un contador de 3 bytes, comenzando por un valor aleatorio. - - - En MongoDB, cada documento almacenado en una colección requiere un campo - _id único que actúa como clave primaria. Si un documento - insertado omite el campo _id, la extensión genera - automáticamente un ObjectId para el campo _id. - - - El uso de ObjectId para el campo _id proporciona las - siguientes ventajas adicionales: - - - - La hora de creación del ObjectId puede ser accedida utilizando el método - MongoDB\BSON\ObjectId::getTimestamp. - - - La ordenación en un campo _id que almacena valores ObjectId - equivale aproximadamente a la ordenación por fecha de creación. - - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\ObjectId - - - - final - - MongoDB\BSON\ObjectId - - - - MongoDB\BSON\ObjectIdInterface - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - Stringable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.12.0 - - Implementa Stringable para PHP 8.0+. - - - - PECL mongodb 1.3.0 - - - Renombrado de MongoDB\BSON\ObjectID a - MongoDB\BSON\ObjectId. - - - Implementa MongoDB\BSON\ObjectIdInterface. - - - - - PECL mongodb 1.2.0 - - Implementa Serializable y - JsonSerializable. - - - - - -
    - -
    - - &reference.mongodb.bson.entities.objectid; - -
    - diff --git a/reference/mongodb/bson/objectid/construct.xml b/reference/mongodb/bson/objectid/construct.xml deleted file mode 100644 index d4b783219a..0000000000 --- a/reference/mongodb/bson/objectid/construct.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - - MongoDB\BSON\ObjectId::__construct - Construye un nuevo ObjectId - - - - &reftitle.description; - - final public MongoDB\BSON\ObjectId::__construct - stringnullid&null; - - - - - &reftitle.parameters; - - - id (string) - - - Una cadena hexadecimal de 24 caracteres. Si no se proporciona, la extensión generará un ObjectId. - - - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lanza una excepción MongoDB\Driver\Exception\InvalidArgumentException - si id no es una cadena hexadecimal de 24 caracteres. - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\BSON\ObjectId::__construct</function> - - -]]> - - &example.outputs.similar; - - - string(24) "56732d3dda14d81214634921" -} -object(MongoDB\BSON\ObjectId)#1 (1) { - ["oid"]=> - string(24) "000000000000000000000001" -} - -]]> - - - - - - &reftitle.seealso; - - La referencia ObjectId - El tipo BSON : ObjectId - - - - - - diff --git a/reference/mongodb/bson/objectid/gettimestamp.xml b/reference/mongodb/bson/objectid/gettimestamp.xml deleted file mode 100644 index fb22fb8ce9..0000000000 --- a/reference/mongodb/bson/objectid/gettimestamp.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - - MongoDB\BSON\ObjectId::getTimestamp - Devuelve el componente de timestamp de ObjectId - - - - &reftitle.description; - - final public intMongoDB\BSON\ObjectId::getTimestamp - - - - El componente de timestamp de un ObjectId son sus 32 bits más significativos, - que denotan el número de segundos desde el epoch Unix. Este valor se lee como - un entero de 32 bits sin signo con un orden de bytes big-endian. - - &mongodb.note.uint32; - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el componente de timestamp de ObjectId. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\BSON\ObjectId::getTimestamp</function> - -getTimestamp()); - -var_dump((new MongoDB\BSON\ObjectId('0000002a0000000000000000'))->getTimestamp()); - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Referencia ObjectId - Tipos BSON : ObjectId - - - - - - diff --git a/reference/mongodb/bson/objectid/jsonserialize.xml b/reference/mongodb/bson/objectid/jsonserialize.xml deleted file mode 100644 index bd22f76385..0000000000 --- a/reference/mongodb/bson/objectid/jsonserialize.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - MongoDB\BSON\ObjectId::jsonSerialize - Devuelve una representación que puede ser convertida en JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\ObjectId::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve datos que pueden ser serializados por json_encode - para producir una representación JSON extendida de - MongoDB\BSON\ObjectId. - - &mongodb.note.extended-json; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB JSON Extendido - - - - - - diff --git a/reference/mongodb/bson/objectid/tostring.xml b/reference/mongodb/bson/objectid/tostring.xml deleted file mode 100644 index e69756a9ec..0000000000 --- a/reference/mongodb/bson/objectid/tostring.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - MongoDB\BSON\ObjectId::__toString - Devuelve la representación hexadecimal de este ObjectId - - - - &reftitle.description; - - final public stringMongoDB\BSON\ObjectId::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la representación hexadecimal de este ObjectId. - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\BSON\ObjectId::__toString</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - La referencia ObjectId - El tipo BSON : ObjectId - - - - - - diff --git a/reference/mongodb/bson/objectidinterface.xml b/reference/mongodb/bson/objectidinterface.xml deleted file mode 100644 index 06c658ba7b..0000000000 --- a/reference/mongodb/bson/objectidinterface.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - La interfaz MongoDB\BSON\ObjectIdInterface - MongoDB\BSON\ObjectIdInterface - - -
    - &reftitle.intro; - - Esta interfaz es implementada por - MongoDB\BSON\ObjectId para ser utilizada como tipo de argumento, - de retorno o de propiedad en las clases de usuario. - -
    - -
    - &reftitle.classsynopsis; - - MongoDB\BSON\ObjectIdInterface - - - MongoDB\BSON\ObjectIdInterface - - - &Methods; - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - &mongodb.changelog.tentative-return-types; - - - -
    -
    - - &reference.mongodb.bson.entities.objectidinterface; - -
    - - diff --git a/reference/mongodb/bson/objectidinterface/gettimestamp.xml b/reference/mongodb/bson/objectidinterface/gettimestamp.xml deleted file mode 100644 index eda61508ac..0000000000 --- a/reference/mongodb/bson/objectidinterface/gettimestamp.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - MongoDB\BSON\ObjectIdInterface::getTimestamp - Devuelve el componente de timestamp de ObjectIdInterface - - - - &reftitle.description; - - abstract public intMongoDB\BSON\ObjectIdInterface::getTimestamp - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el componente de timestamp de ObjectIdInterface. - - - - - &reftitle.seealso; - - MongoDB\BSON\ObjectId::getTimestamp - - - - - - diff --git a/reference/mongodb/bson/objectidinterface/tostring.xml b/reference/mongodb/bson/objectidinterface/tostring.xml deleted file mode 100644 index 5f2337cb87..0000000000 --- a/reference/mongodb/bson/objectidinterface/tostring.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\BSON\ObjectIdInterface::__toString - Devuelve la representación hexadecimal de ObjectIdInterface - - - - &reftitle.description; - - abstract public stringMongoDB\BSON\ObjectIdInterface::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la representación hexadecimal de ObjectIdInterface. - - - - - &reftitle.seealso; - - MongoDB\BSON\ObjectId::__toString - - - - - - diff --git a/reference/mongodb/bson/packedarray.xml b/reference/mongodb/bson/packedarray.xml deleted file mode 100644 index 41a47dc4a0..0000000000 --- a/reference/mongodb/bson/packedarray.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - La clase MongoDB\BSON\PackedArray - MongoDB\BSON\PackedArray - - - - -
    - &reftitle.intro; - - Representa un array BSON. Esta clase se utiliza al leer datos como BSON sin tratar - y no puede ser modificada. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\PackedArray - - - - final - - MongoDB\BSON\PackedArray - - - - MongoDB\BSON\Type - - - - ArrayAccess - - - - IteratorAggregate - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.17.0 - - Implementa MongoDB\BSON\Type. - - - - PECL mongodb 1.17.0 - - MongoDB\BSON\PackedArray no puede ser serializado - en contextos donde se espera un documento BSON. En versiones anteriores, - el array BSON habría sido convertido en documento. - - - - - -
    - -
    - - &reference.mongodb.bson.entities.packedarray; - -
    - - diff --git a/reference/mongodb/bson/packedarray/construct.xml b/reference/mongodb/bson/packedarray/construct.xml deleted file mode 100644 index f58126b32e..0000000000 --- a/reference/mongodb/bson/packedarray/construct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - MongoDB\BSON\PackedArray::__construct - Construye un nuevo array BSON (no utilizado) - - - - &reftitle.description; - - final private MongoDB\BSON\PackedArray::__construct - - - - Los objetos MongoDB\BSON\PackedArray se crean con - métodos de fábrica estáticos y no pueden ser instanciados directamente. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.seealso; - - MongoDB\BSON\PackedArray::fromPHP - Tipos BSON - - - - - - diff --git a/reference/mongodb/bson/packedarray/fromjson.xml b/reference/mongodb/bson/packedarray/fromjson.xml deleted file mode 100644 index 70226d2a19..0000000000 --- a/reference/mongodb/bson/packedarray/fromjson.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - MongoDB\BSON\PackedArray::fromJSON - Construye una nueva instancia de array BSON a partir de un string JSON - - - - &reftitle.description; - - final static public MongoDB\BSON\PackedArrayMongoDB\BSON\PackedArray::fromJSON - stringjson - - - Convierte un string - JSON extendido - en su representación BSON. - - - - - &reftitle.parameters; - - - json (string) - - - El valor JSON a convertir. - - - - - - - - &reftitle.returnvalues; - - Devuelve una nueva instancia de MongoDB\BSON\PackedArray. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - Lanza una - MongoDB\Driver\Exception\UnexpectedValueException si - el valor JSON no puede ser convertido en un array BSON (por ejemplo, debido - a un error de sintaxis). - - - - - - &reftitle.examples; - - Ejemplo de <methodname>MongoDB\BSON\PackedArray::fromJSON</methodname> - - -]]> - - &example.outputs; - - - string(68) "MQAAAAIwAAQAAABmb28AEDEAewAAABIyAP////8AAAAABzMAVjFafGEY/RuSAnCxAA==" - ["value"]=> - array(4) { - [0]=> - string(3) "foo" - [1]=> - int(123) - [2]=> - int(4294967295) - [3]=> - object(MongoDB\BSON\ObjectId)#2 (1) { - ["oid"]=> - string(24) "56315a7c6118fd1b920270b1" - } - } -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\BSON\PackedArray::fromPHP - Json extendido de MongoDB - Tipos BSON - - - - - diff --git a/reference/mongodb/bson/packedarray/fromphp.xml b/reference/mongodb/bson/packedarray/fromphp.xml deleted file mode 100644 index 3bed857adb..0000000000 --- a/reference/mongodb/bson/packedarray/fromphp.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - MongoDB\BSON\PackedArray::fromPHP - Construye una nueva instancia de array BSON a partir de datos PHP - - - - &reftitle.description; - - final static public MongoDB\BSON\PackedArrayMongoDB\BSON\PackedArray::fromPHP - arrayvalue - - - - - &reftitle.parameters; - - - value (array) - - - El array PHP a convertir en array BSON. El array debe ser una lista - (es decir, tener claves numéricas secuenciales comenzando por 0). - - - - - - - - &reftitle.returnvalues; - - Devuelve una nueva instancia de MongoDB\BSON\PackedArray. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lanza una MongoDB\Driver\Exception\InvalidArgumentException si el array dado no es una lista (por ejemplo, tiene secuencias numéricas comenzando por 0). - - - - - &reftitle.seealso; - - Tipos BSON - - - - - - diff --git a/reference/mongodb/bson/packedarray/get.xml b/reference/mongodb/bson/packedarray/get.xml deleted file mode 100644 index 31286d8429..0000000000 --- a/reference/mongodb/bson/packedarray/get.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - MongoDB\BSON\PackedArray::get - Devuelve el valor de un índice del array - - - - &reftitle.description; - - final public mixedMongoDB\BSON\PackedArray::get - intkey - - - - - &reftitle.parameters; - - - key (int) - - - El índice a recuperar del array. - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor asociado al índice dado. Si el índice no está - presente en el array, se lanza una excepción. - - - - Cuando se encuentra un valor codificado como un entero de 64 bits en el array BSON, - el valor de retorno de este método será una instancia de - MongoDB\BSON\Int64. - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lanza una MongoDB\Driver\Exception\RuntimeException si el índice no está presente en el array. - - - - - &reftitle.seealso; - - MongoDB\BSON\PackedArray::has - Tipos BSON - - - - - - diff --git a/reference/mongodb/bson/packedarray/getiterator.xml b/reference/mongodb/bson/packedarray/getiterator.xml deleted file mode 100644 index 6fcacf18c5..0000000000 --- a/reference/mongodb/bson/packedarray/getiterator.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - MongoDB\BSON\PackedArray::getIterator - Devuelve el iterador para el array BSON - - - - &reftitle.description; - - final public MongoDB\BSON\IteratorMongoDB\BSON\PackedArray::getIterator - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una instancia de MongoDB\BSON\Iterator que puede ser - utilizada para iterar sobre todos los índices del array. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lanza una MongoDB\Driver\Exception\UnexpectedValueException si el iterador BSON no puede ser instanciado. - - - - - &reftitle.seealso; - - Tipos BSON - - - - - - diff --git a/reference/mongodb/bson/packedarray/has.xml b/reference/mongodb/bson/packedarray/has.xml deleted file mode 100644 index 716716849f..0000000000 --- a/reference/mongodb/bson/packedarray/has.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - MongoDB\BSON\PackedArray::has - Indica si un índice está presente en el array - - - - &reftitle.description; - - final public boolMongoDB\BSON\PackedArray::has - intindex - - - - - &reftitle.parameters; - - - index (int) - - - El índice a buscar en el array. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si el índice está presente en el array, de lo contrario &false;. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\BSON\PackedArray::get - Tipos BSON - - - - - - diff --git a/reference/mongodb/bson/packedarray/offsetexists.xml b/reference/mongodb/bson/packedarray/offsetexists.xml deleted file mode 100644 index 9013662cec..0000000000 --- a/reference/mongodb/bson/packedarray/offsetexists.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - MongoDB\BSON\PackedArray::offsetExists - Indica si un índice está presente en el array - - - &reftitle.description; - - final public boolMongoDB\BSON\PackedArray::offsetExists - mixedkey - - - - - &reftitle.parameters; - - - - key - - - El índice a buscar en el array. - - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si el índice está presente en el array, de lo contrario &false;. - - - - - &reftitle.seealso; - - - ArrayAccess::offsetExists - MongoDB\BSON\PackedArray::has - - - - - - diff --git a/reference/mongodb/bson/packedarray/offsetget.xml b/reference/mongodb/bson/packedarray/offsetget.xml deleted file mode 100644 index f2ee5279e7..0000000000 --- a/reference/mongodb/bson/packedarray/offsetget.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - MongoDB\BSON\PackedArray::offsetGet - Devuelve el valor de un índice del array - - - &reftitle.description; - - final public mixedMongoDB\BSON\PackedArray::offsetGet - mixedkey - - - - - &reftitle.parameters; - - - - key - - - El índice a recuperar del array. Solo int es soportado. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor asociado al índice dado. Si el índice no está - presente en el array, se lanza una excepción. - - - - Cuando se encuentra un valor codificado como un entero de 64 bits en el array BSON, - el valor de retorno de este método será una instancia de - MongoDB\BSON\Int64. - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lanza una MongoDB\Driver\Exception\RuntimeException si el índice no está presente en el array. - - - - - &reftitle.seealso; - - - ArrayAccess::offsetGet - MongoDB\BSON\PackedArray::get - - - - - - diff --git a/reference/mongodb/bson/packedarray/offsetset.xml b/reference/mongodb/bson/packedarray/offsetset.xml deleted file mode 100644 index 0ccaddbb52..0000000000 --- a/reference/mongodb/bson/packedarray/offsetset.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - MongoDB\BSON\PackedArray::offsetSet - Implementación de ArrayAccess - - - &reftitle.description; - - final public voidMongoDB\BSON\PackedArray::offsetSet - mixedkey - mixedvalue - - - - Cambia el valor de key a value. - - - - - &reftitle.parameters; - - - - key - - - El índice a modificar. - - - - - value - - - El nuevo valor de key. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Siempre lanza una MongoDB\Driver\Exception\LogicException. - - - - - diff --git a/reference/mongodb/bson/packedarray/offsetunset.xml b/reference/mongodb/bson/packedarray/offsetunset.xml deleted file mode 100644 index 4b30335f91..0000000000 --- a/reference/mongodb/bson/packedarray/offsetunset.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - MongoDB\BSON\PackedArray::offsetUnset - Implementación de ArrayAccess - - - &reftitle.description; - - final public voidMongoDB\BSON\PackedArray::offsetUnset - mixedkey - - - Elimina el valor en el índice dado. - - - - - &reftitle.parameters; - - - - key - - - El valor a eliminar. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Siempre lanza una MongoDB\Driver\Exception\LogicException. - - - - - diff --git a/reference/mongodb/bson/packedarray/tocanonicalextendedjson.xml b/reference/mongodb/bson/packedarray/tocanonicalextendedjson.xml deleted file mode 100644 index d1b96ffcb8..0000000000 --- a/reference/mongodb/bson/packedarray/tocanonicalextendedjson.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - MongoDB\BSON\PackedArray::toCanonicalExtendedJSON - Devuelve la representación JSON extendida canónica del array BSON - - - - &reftitle.description; - - final public stringMongoDB\BSON\PackedArray::toCanonicalExtendedJSON - - - - Convierte el array BSON en su representación - JSON extendida canónica. - El formato canónico privilegia la fidelidad de los tipos en detrimento de la - concisión de la salida y es el más adecuado para producir una salida que - puede ser convertida en BSON sin pérdida de información de tipo (por ejemplo, - los tipos numéricos permanecerán diferenciados). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un string que contiene la representación - JSON extendida canónica - del array BSON. - - - - - &reftitle.examples; - - Ejemplo de <methodname>MongoDB\BSON\PackedArray::toCanonicalExtendedJSON</methodname> - - toCanonicalExtendedJSON(), "\n"; - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\PackedArray::fromJSON - MongoDB\BSON\PackedArray::toRelaxedExtendedJSON - MongoDB\BSON\toCanonicalExtendedJSON - Especificación del JSON extendido - Tipos BSON - - - - - diff --git a/reference/mongodb/bson/packedarray/tophp.xml b/reference/mongodb/bson/packedarray/tophp.xml deleted file mode 100644 index 84b545cfa7..0000000000 --- a/reference/mongodb/bson/packedarray/tophp.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - MongoDB\BSON\PackedArray::toPHP - Devuelve la representación PHP del array BSON - - - - &reftitle.description; - - final public arrayobjectMongoDB\BSON\PackedArray::toPHP - arraynulltypeMap&null; - - - - - &reftitle.parameters; - - &mongodb.parameter.typeMap; - - - - - &reftitle.returnvalues; - - El valor decodificado en PHP. - - - - Cuando se encuentra un valor codificado como un entero de 64 bits en el array BSON, - el valor de retorno de este método será una instancia de - MongoDB\BSON\Int64. - - - - - - &reftitle.errors; - - - Lanza una - MongoDB\Driver\Exception\InvalidArgumentException si - una clase en el type map no puede ser instanciada o no implementa - MongoDB\BSON\Unserializable. - - - - - - &reftitle.seealso; - - MongoDB\BSON\toPHP - Tipos BSON - - - - - - diff --git a/reference/mongodb/bson/packedarray/torelaxedextendedjson.xml b/reference/mongodb/bson/packedarray/torelaxedextendedjson.xml deleted file mode 100644 index 0385b86b64..0000000000 --- a/reference/mongodb/bson/packedarray/torelaxedextendedjson.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - MongoDB\BSON\PackedArray::toRelaxedExtendedJSON - Devuelve la representación JSON extendida relajada del array BSON - - - - &reftitle.description; - - final public stringMongoDB\BSON\PackedArray::toRelaxedExtendedJSON - - - - Convierte el array BSON en su representación - JSON extendida relajada. - El formato relajado prefiere el uso de los tipos primitivos JSON en detrimento de la - fidelidad de los tipos y es el más adecuado para producir una salida que puede ser - fácilmente consumida por APIs web y humanos. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un string que contiene la representación - JSON extendida relajada - del array BSON. - - - - - &reftitle.examples; - - Ejemplo de <methodname>MongoDB\BSON\PackedArray::toRelaxedExtendedJSON</methodname> - - toRelaxedExtendedJSON(), "\n"; - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\PackedArray::fromJSON - MongoDB\BSON\PackedArray::toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - Especificación del JSON extendido - Tipos BSON - - - - - diff --git a/reference/mongodb/bson/packedarray/tostring.xml b/reference/mongodb/bson/packedarray/tostring.xml deleted file mode 100644 index b4e8954e3e..0000000000 --- a/reference/mongodb/bson/packedarray/tostring.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\BSON\PackedArray::__toString - Devuelve la representación en string para este array BSON - - - - &reftitle.description; - - final public stringMongoDB\BSON\PackedArray::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la representación en string de este array BSON. - - - - - &reftitle.seealso; - - Tipos BSON - - - - - - diff --git a/reference/mongodb/bson/persistable.xml b/reference/mongodb/bson/persistable.xml deleted file mode 100644 index e71ea161ed..0000000000 --- a/reference/mongodb/bson/persistable.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - - La clase MongoDB\BSON\Persistable - MongoDB\BSON\Persistable - - - - -
    - &reftitle.intro; - - Las clases pueden implementar esta interfaz para tener la posibilidad de utilizar los ODM automáticos (los objetos de mapeo de documentos) de esta extensión. Durante la serialización, la extensión inyectará una propiedad __pclass que contiene el nombre de la clase PHP en los datos devueltos por MongoDB\BSON\Serializable::bsonSerialize. Durante la deserialización, la misma propiedad __pclass se utilizará para solicitar a la clase PHP (independientemente de la configuración type map) que se construya antes de que se invoque MongoDB\BSON\Unserializable::bsonUnserialize. Ver para más información. - - - - Aunque MongoDB\BSON\Serializable::bsonSerialize quiera devolver un array secuencial, la inyección de la propiedad __pclass hará que el objeto se serialice como documento BSON. - - -
    - - -
    - &reftitle.interfacesynopsis; - - - - MongoDB\BSON\Persistable - - - - - MongoDB\BSON\Persistable - - - - MongoDB\BSON\Unserializable - - - - MongoDB\BSON\Serializable - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.mongodb.bson.entities.persistable; - -
    - - diff --git a/reference/mongodb/bson/persistable/bsonserialize.xml b/reference/mongodb/bson/persistable/bsonserialize.xml deleted file mode 100644 index 183018c979..0000000000 --- a/reference/mongodb/bson/persistable/bsonserialize.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - MongoDB\BSON\Persistable::bsonSerialize - Proporciona un array o un documento a serializar como BSON - - - - &reftitle.description; - - abstract public arraystdClassMongoDB\BSON\DocumentMongoDB\BSON\Persistable::bsonSerialize - - - - Se invoca durante la serialización del objeto en BSON. El método debe devolver un - array, stdClass, o - MongoDB\BSON\Document. - - - El valor devuelto será siempre serializado como documento BSON. El documento - serializado incluirá un campo que contiene el nombre de la clase del objeto. Por esta - razón, no es posible devolver una instancia de - MongoDB\BSON\PackedArray en este método. - - - Se recomienda incluir una propiedad _id (por ejemplo - un MongoDB\BSON\ObjectId inicializado en el constructor) al devolver - datos para un documento BSON raíz. En ausencia de una propiedad - _id, la extensión o el servidor generará un - MongoDB\BSON\ObjectId para las operaciones de inserción o upsert, - respectivamente. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un array, stdClass, o MongoDB\BSON\Document - a serializar como documento BSON. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - - PECL mongodb 1.17.0 - - - Este método puede ahora también devolver instancias de MongoDB\BSON\Document - además de array y stdClass. - - - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Serializable::bsonSerialize - MongoDB\BSON\Unserializable::bsonUnserialize - MongoDB\BSON\Persistable - - - - - - - diff --git a/reference/mongodb/bson/regex.xml b/reference/mongodb/bson/regex.xml deleted file mode 100644 index e81291e46a..0000000000 --- a/reference/mongodb/bson/regex.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - La clase MongoDB\BSON\Regex - MongoDB\BSON\Regex - - - - -
    - &reftitle.intro; - - Tipo BSON para un patrón de expresión regular y - flag opcional. - - - - Este tipo BSON se utiliza principalmente durante la consulta de la base - de datos. Alternativamente, el operador de consulta - $regex - puede ser utilizado. - - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\Regex - - - - final - - MongoDB\BSON\Regex - - - - MongoDB\BSON\RegexInterface - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - Stringable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.12.0 - - Implementa Stringable para PHP 8.0+. - - - - PECL mongodb 1.3.0 - - Implementa MongoDB\BSON\RegexInterface. - - - - PECL mongodb 1.2.0 - - Implementa Serializable y - JsonSerializable. - - - - - -
    - -
    - - &reference.mongodb.bson.entities.regex; - -
    - diff --git a/reference/mongodb/bson/regex/construct.xml b/reference/mongodb/bson/regex/construct.xml deleted file mode 100644 index 7f1ee5d527..0000000000 --- a/reference/mongodb/bson/regex/construct.xml +++ /dev/null @@ -1,147 +0,0 @@ - - - - - - - - MongoDB\BSON\Regex::__construct - Construye una nueva REGEX - - - - &reftitle.description; - - final public MongoDB\BSON\Regex::__construct - stringpattern - stringflags"" - - - - - &reftitle.parameters; - - - pattern (string) - - - La máscara de la expresión regular. - - - - La máscara no debe estar rodeada de caracteres delimitadores. - - - - - - flags (string) - - - Los - flags de la expresión regular. - - - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lanza una excepción MongoDB\Driver\Exception\InvalidArgumentException si pattern o flags contiene un byte nulo. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.2.0 - - - El argumento flags es opcional y el valor por omisión es una cadena vacía. - - - Los caracteres en el argumento flags serán ordenados alfabéticamente cuando se construya una Regex. Anteriormente, los caracteres se almacenaban en el orden proporcionado. - - - MongoDB\Driver\Exception\InvalidArgumentException - es lanzada si pattern o - flags contiene un byte nulo. Anteriormente, los valores eran truncados en el primer byte nulo. - - - - - - - - - - &reftitle.examples; - - <function>MongoDB\BSON\Regex::__construct</function> ejemplo - - -]]> - - &example.outputs; - - - string(4) "^foo" - ["flags"]=> - string(1) "i" -} -]]> - - - - - - &reftitle.seealso; - - Los tipos BSON - Los flags soportados - para las expresiones regulares - - - - - - diff --git a/reference/mongodb/bson/regex/getflags.xml b/reference/mongodb/bson/regex/getflags.xml deleted file mode 100644 index b827db8d73..0000000000 --- a/reference/mongodb/bson/regex/getflags.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - - MongoDB\BSON\Regex::getFlags - Devuelve los flags de la REGEX - - - - &reftitle.description; - - final public stringMongoDB\BSON\Regex::getFlags - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve los flags de la REGEX. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo con <function>BSON\Regex::getFlags</function> - -getFlags()); - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Los tipos BSON - Los flags soportados - de las expresiones regulares - - - - - - diff --git a/reference/mongodb/bson/regex/getpattern.xml b/reference/mongodb/bson/regex/getpattern.xml deleted file mode 100644 index 16df228df2..0000000000 --- a/reference/mongodb/bson/regex/getpattern.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - - - MongoDB\BSON\Regex::getPattern - Devuelve la máscara del REGEX - - - - &reftitle.description; - - final public stringMongoDB\BSON\Regex::getPattern - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la máscara del REGEX. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo con <function>BSON\Regex::getPattern</function> - -getPattern()); - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Los tipos BSON - - - - - - diff --git a/reference/mongodb/bson/regex/jsonserialize.xml b/reference/mongodb/bson/regex/jsonserialize.xml deleted file mode 100644 index 36f6bae441..0000000000 --- a/reference/mongodb/bson/regex/jsonserialize.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - MongoDB\BSON\Regex::jsonSerialize - Devuelve una representación que puede ser convertida en JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\Regex::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve datos que pueden ser serializados por json_encode - para producir una representación JSON extendida de - MongoDB\BSON\Regex. - - &mongodb.note.extended-json; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB JSON Extendido - - - - - - diff --git a/reference/mongodb/bson/regex/tostring.xml b/reference/mongodb/bson/regex/tostring.xml deleted file mode 100644 index ea72538efe..0000000000 --- a/reference/mongodb/bson/regex/tostring.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - MongoDB\BSON\Regex::__toString - Devuelve el string que representa esta REGEX - - - - &reftitle.description; - - final public stringMongoDB\BSON\Regex::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el string que representa esta REGEX. - - - - - &reftitle.examples; - - Ejemplo con <function>BSON\Regex::__toString</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Los tipos BSON - - - - - - diff --git a/reference/mongodb/bson/regexinterface.xml b/reference/mongodb/bson/regexinterface.xml deleted file mode 100644 index 68fc74d1fa..0000000000 --- a/reference/mongodb/bson/regexinterface.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - La interfaz MongoDB\BSON\RegexInterface - MongoDB\BSON\RegexInterface - - -
    - &reftitle.intro; - - Esta interfaz es implementada por MongoDB\BSON\Regex - para ser utilizada como tipo de argumento, de retorno o de propiedad en las clases de usuario. - -
    - -
    - &reftitle.classsynopsis; - - MongoDB\BSON\RegexInterface - - - MongoDB\BSON\RegexInterface - - - &Methods; - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - &mongodb.changelog.tentative-return-types; - - - -
    -
    - - &reference.mongodb.bson.entities.regexinterface; - -
    - - diff --git a/reference/mongodb/bson/regexinterface/getflags.xml b/reference/mongodb/bson/regexinterface/getflags.xml deleted file mode 100644 index c3672a5d19..0000000000 --- a/reference/mongodb/bson/regexinterface/getflags.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - MongoDB\BSON\RegexInterface::getFlags - Devuelve los flags de RegexInterface - - - - &reftitle.description; - - abstract public stringMongoDB\BSON\RegexInterface::getFlags - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve los flags de RegexInterface. - - - - - &reftitle.seealso; - - MongoDB\BSON\Regex::getFlags - - - - - - diff --git a/reference/mongodb/bson/regexinterface/getpattern.xml b/reference/mongodb/bson/regexinterface/getpattern.xml deleted file mode 100644 index 0ec96f7e0c..0000000000 --- a/reference/mongodb/bson/regexinterface/getpattern.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - MongoDB\BSON\RegexInterface::getPattern - Devuelve el patrón de RegexInterface - - - - &reftitle.description; - - abstract public stringMongoDB\BSON\RegexInterface::getPattern - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el patrón de RegexInterface. - - - - - &reftitle.seealso; - - MongoDB\BSON\Regex::getPattern - - - - - - diff --git a/reference/mongodb/bson/regexinterface/tostring.xml b/reference/mongodb/bson/regexinterface/tostring.xml deleted file mode 100644 index 34d625d5a5..0000000000 --- a/reference/mongodb/bson/regexinterface/tostring.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - MongoDB\BSON\RegexInterface::__toString - Devuelve la representación en forma de string de esta RegexInterface - - - - &reftitle.description; - - abstract public stringMongoDB\BSON\RegexInterface::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la representación en forma de string de esta RegexInterface. - - - - - &reftitle.seealso; - - MongoDB\BSON\Regex::__toString - - - - - - diff --git a/reference/mongodb/bson/serializable.xml b/reference/mongodb/bson/serializable.xml deleted file mode 100644 index 80afc32847..0000000000 --- a/reference/mongodb/bson/serializable.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - La interfaz MongoDB\BSON\Serializable - MongoDB\BSON\Serializable - - - - -
    - &reftitle.intro; - - Las clases que implementan esta interfaz pueden devolver datos para ser - serializados como un array BSON o un documento BSON en lugar de las - propiedades públicas del objeto. - -
    - - -
    - &reftitle.interfacesynopsis; - - - - MongoDB\BSON\Serializable - - - - - MongoDB\BSON\Serializable - - - - MongoDB\BSON\Type - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - &mongodb.changelog.tentative-return-types; - - - -
    -
    - - &reference.mongodb.bson.entities.serializable; - -
    - - diff --git a/reference/mongodb/bson/serializable/bsonserialize.xml b/reference/mongodb/bson/serializable/bsonserialize.xml deleted file mode 100644 index 97162f64a7..0000000000 --- a/reference/mongodb/bson/serializable/bsonserialize.xml +++ /dev/null @@ -1,246 +0,0 @@ - - - - - - MongoDB\BSON\Serializable::bsonSerialize - Proporciona un array o documento para serializar como BSON - - - - &reftitle.description; - - abstract public arraystdClassMongoDB\BSON\DocumentMongoDB\BSON\PackedArrayMongoDB\BSON\Serializable::bsonSerialize - - - - Se invoca durante la serialización del objeto a BSON. El método debe devolver un - array, stdClass, MongoDB\BSON\Document, - o MongoDB\BSON\PackedArray. - - - Los documentos raíz (por ejemplo, un - MongoDB\BSON\Serializable pasado a - MongoDB\BSON\Document::fromPHP) siempre se - serializarán como un documento BSON. Para los valores de campo, los arrays - asociativos y las instancias de stdClass se - serializarán como un documento BSON y los arrays secuenciales (es decir, - índices numéricos secuenciales que comienzan en 0) - se serializarán como un array BSON. - - - Se recomienda a los usuarios incluir una propiedad _id - (por ejemplo, un MongoDB\BSON\ObjectId inicializado en - el constructor) al devolver datos para un documento raíz BSON. En ausencia de - una propiedad _id, la extensión o el servidor generará un - MongoDB\BSON\ObjectId para operaciones de inserción o - actualización (upsert), respectivamente. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un array, stdClass, MongoDB\BSON\Document, - o MongoDB\BSON\PackedArray que se serializará como un - array o documento BSON. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - - PECL mongodb 1.17.0 - - - El tipo de retorno se cambió de arrayobject. - En lugar de object, el tipo de retorno ahora especifica - stdClass. Las clases que implementan esta - interfaz deben modificarse para dejar de declarar un tipo de retorno - object. Como el tipo de retorno es tentativo, se emite una - advertencia de obsolescencia en PHP 8.1 y versiones posteriores. - - - Además de los cambios anteriores, la extensión ahora también admite - devolver instancias de MongoDB\BSON\Document y - MongoDB\BSON\PackedArray. Tenga en cuenta que - cualquier instancia de MongoDB\BSON\PackedArray - devuelta se convierte silenciosamente en objetos cuando se almacenan como - documentos raíz. Se almacenan como arrays cuando se utilizan como valor - de campo incrustado. - - - - - - - - - - &reftitle.examples; - - <function>MongoDB\BSON\Serializable::bsonSerialize</function> que devuelve un array asociativo para documento raíz - -id = new MongoDB\BSON\ObjectId; - } - - function bsonSerialize(): array - { - return ['_id' => $this->id, 'foo' => 'bar']; - } -} - -echo MongoDB\BSON\Document::fromPHP(new MyDocument)->toRelaxedExtendedJSON(), "\n"; - -?> -]]> - - &example.outputs.similar; - - - - - - - <function>MongoDB\BSON\Serializable::bsonSerialize</function> que devuelve un array secuencial para documento raíz - -toRelaxedExtendedJSON(), "\n"; - -?> -]]> - - &example.outputs; - - - - - - - <function>MongoDB\BSON\Serializable::bsonSerialize</function> que devuelve un array asociativo para campo de documento - - 'bar']; - } -} - -$value = ['document' => new MyDocument]; - -echo MongoDB\BSON\Document::fromPHP($value)->toRelaxedExtendedJSON(), "\n"; - -?> -]]> - - &example.outputs; - - - - - - - <function>MongoDB\BSON\Serializable::bsonSerialize</function> que devuelve un array secuencial para campo de documento - - new MyArray]; - -echo MongoDB\BSON\Document::fromPHP($value)->toRelaxedExtendedJSON(), "\n"; - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Unserializable::bsonUnserialize - MongoDB\BSON\Persistable - - - - - - - diff --git a/reference/mongodb/bson/symbol.xml b/reference/mongodb/bson/symbol.xml deleted file mode 100644 index aa21b2175f..0000000000 --- a/reference/mongodb/bson/symbol.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - La clase MongoDB\BSON\Symbol - MongoDB\BSON\Symbol - - - - -
    - &reftitle.intro; - - Tipo BSON para el tipo "Symbol". Este tipo BSON está deprecado, y esta - clase no puede ser instanciada. Será creada a partir de un tipo BSON symbol - al convertir BSON a PHP, y también puede ser convertida de vuelta a BSON - al almacenar documentos en la base de datos. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\Symbol - - - - final - - MongoDB\BSON\Symbol - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - Stringable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.12.0 - - Implementa Stringable para PHP 8.0+. - - - - - -
    - -
    - - &reference.mongodb.bson.entities.symbol; - -
    - - diff --git a/reference/mongodb/bson/symbol/construct.xml b/reference/mongodb/bson/symbol/construct.xml deleted file mode 100644 index 749e0ae4c6..0000000000 --- a/reference/mongodb/bson/symbol/construct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - MongoDB\BSON\Symbol::__construct - Construir un nuevo Symbol (no utilizado) - - - - &reftitle.description; - - final private MongoDB\BSON\Symbol::__construct - - - - Los objetos de MongoDB\BSON\Symbol se crean mediante - conversión desde un tipo BSON obsoleto y no pueden construirse directamente. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.seealso; - - Tipos BSON - - - - - - diff --git a/reference/mongodb/bson/symbol/jsonserialize.xml b/reference/mongodb/bson/symbol/jsonserialize.xml deleted file mode 100644 index 28206ca161..0000000000 --- a/reference/mongodb/bson/symbol/jsonserialize.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\BSON\Symbol::jsonSerialize - Devuelve una representación que puede convertirse a JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\Symbol::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve datos que pueden ser serializados por json_encode para - producir una representación JSON extendida del - MongoDB\BSON\Symbol. - - &mongodb.note.extended-json; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB Extended JSON - - - - - - diff --git a/reference/mongodb/bson/symbol/tostring.xml b/reference/mongodb/bson/symbol/tostring.xml deleted file mode 100644 index 33c4a70fae..0000000000 --- a/reference/mongodb/bson/symbol/tostring.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\BSON\Symbol::__toString - Devuelve el Symbol como un string - - - - &reftitle.description; - - final public stringMongoDB\BSON\Symbol::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la representación en string de este Symbol. - - - - - &reftitle.seealso; - - Tipos BSON - - - - - - diff --git a/reference/mongodb/bson/timestamp.xml b/reference/mongodb/bson/timestamp.xml deleted file mode 100644 index 6a60ba53f4..0000000000 --- a/reference/mongodb/bson/timestamp.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - La clase MongoDB\BSON\Timestamp - MongoDB\BSON\Timestamp - - - - -
    - &reftitle.intro; - - Representa un - timestamp BSON. - El valor consiste en un timestamp de 4 bytes (es decir, segundos desde la - época) y un incremento de 4 bytes. - - - - Este es un tipo interno de MongoDB utilizado para replicación y - particionamiento. No está destinado al almacenamiento general de fechas - (debería usarse MongoDB\BSON\UTCDateTime en su - lugar). - - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\Timestamp - - - - final - - MongoDB\BSON\Timestamp - - - - MongoDB\BSON\TimestampInterface - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - Stringable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.12.0 - - Implementa Stringable para PHP 8.0+. - - - - PECL mongodb 1.3.0 - - Implementa MongoDB\BSON\TimestampInterface. - - - - PECL mongodb 1.2.0 - - Implementa Serializable y - JsonSerializable. - - - - - -
    - -
    - - &reference.mongodb.bson.entities.timestamp; - -
    - - diff --git a/reference/mongodb/bson/timestamp/construct.xml b/reference/mongodb/bson/timestamp/construct.xml deleted file mode 100644 index 9831f61608..0000000000 --- a/reference/mongodb/bson/timestamp/construct.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - MongoDB\BSON\Timestamp::__construct - Construye una nueva marca de tiempo (Timestamp) - - - - &reftitle.description; - - final public MongoDB\BSON\Timestamp::__construct - intincrement - inttimestamp - - - - - &reftitle.parameters; - - - increment (int) - - - Entero de 32 bits que denota el ordinal de incremento para operaciones - dentro de un mismo segundo. - - - - - timestamp (int) - - - Entero de 32 bits que denota los segundos transcurridos desde la época Unix. - - - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\BSON\Timestamp::__construct</function> - - -]]> - - &example.outputs; - - - int(1234) - ["timestamp"]=> - int(5678) -} -]]> - - - - - - &reftitle.seealso; - - Tipos BSON: Marcas de tiempo (Timestamps) - - - - - - diff --git a/reference/mongodb/bson/timestamp/getincrement.xml b/reference/mongodb/bson/timestamp/getincrement.xml deleted file mode 100644 index e7c36d7e35..0000000000 --- a/reference/mongodb/bson/timestamp/getincrement.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - MongoDB\BSON\Timestamp::getIncrement - Devuelve el componente de incremento de este Timestamp - - - - &reftitle.description; - - final public intMongoDB\BSON\Timestamp::getIncrement - - - - El componente de incremento de un Timestamp son sus 32 bits menos significativos, - que denotan el ordinal de incremento para operaciones dentro de un mismo segundo. - Este valor se lee como un entero sin signo de 32 bits con orden de bytes big-endian. - - &mongodb.note.uint32; - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el componente de incremento de este Timestamp. - - - - En sistemas de 32 bits este método puede devolver un número negativo. Aunque las partes - de incremento y marca de tiempo del tipo BSON timestamp consisten en dos valores sin signo - de 32 bits, PHP no puede representarlos en plataformas de 32 bits. - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - Tipos BSON: Marcas de tiempo - - - - - - diff --git a/reference/mongodb/bson/timestamp/gettimestamp.xml b/reference/mongodb/bson/timestamp/gettimestamp.xml deleted file mode 100644 index c6aa5bb779..0000000000 --- a/reference/mongodb/bson/timestamp/gettimestamp.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - MongoDB\BSON\Timestamp::getTimestamp - Devuelve el componente de marca temporal de este Timestamp - - - - &reftitle.description; - - final public intMongoDB\BSON\Timestamp::getTimestamp - - - - El componente de marca temporal de un Timestamp es sus 32 bits más significativos, que - denota el número de segundos transcurridos desde la época Unix. Este valor se lee como un - entero sin signo de 32 bits con orden de bytes big-endian. - - &mongodb.note.uint32; - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el componente de marca temporal de este Timestamp. - - - - En sistemas de 32 bits este método puede devolver un número negativo. Aunque las partes - de incremento y marca temporal del tipo de marca temporal BSON consisten en dos valores - enteros sin signo de 32 bits, PHP no puede representarlos en plataformas de 32 bits. - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - Tipos BSON: Marcas temporales - - - - - - diff --git a/reference/mongodb/bson/timestamp/jsonserialize.xml b/reference/mongodb/bson/timestamp/jsonserialize.xml deleted file mode 100644 index e1ae313a87..0000000000 --- a/reference/mongodb/bson/timestamp/jsonserialize.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\BSON\Timestamp::jsonSerialize - Devuelve una representación que puede convertirse a JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\Timestamp::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve datos que pueden ser serializados por json_encode para - producir una representación JSON extendida de la - MongoDB\BSON\Timestamp. - - &mongodb.note.extended-json; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB Extended JSON - - - - - - diff --git a/reference/mongodb/bson/timestamp/tostring.xml b/reference/mongodb/bson/timestamp/tostring.xml deleted file mode 100644 index bfe59ac87f..0000000000 --- a/reference/mongodb/bson/timestamp/tostring.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - MongoDB\BSON\Timestamp::__toString - Devuelve la representación en string de este Timestamp - - - - &reftitle.description; - - final public stringMongoDB\BSON\Timestamp::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la representación en string de este Timestamp. - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\BSON\Timestamp::__toString</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Tipos BSON: Timestamps - - - - - - diff --git a/reference/mongodb/bson/timestampinterface.xml b/reference/mongodb/bson/timestampinterface.xml deleted file mode 100644 index 0cf57ebae6..0000000000 --- a/reference/mongodb/bson/timestampinterface.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - La interfaz <literal>MongoDB\BSON\TimestampInterface</literal> - MongoDB\BSON\TimestampInterface - - -
    - &reftitle.intro; - - Esta interfaz es implementada por - MongoDB\BSON\Timestamp para ser utilizada como un - parámetro, retorno o tipo de propiedad en clases de usuario. - -
    - -
    - &reftitle.classsynopsis; - - MongoDB\BSON\TimestampInterface - - - MongoDB\BSON\TimestampInterface - - - &Methods; - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - &mongodb.changelog.tentative-return-types; - - - -
    -
    - - &reference.mongodb.bson.entities.timestampinterface; - -
    - - diff --git a/reference/mongodb/bson/timestampinterface/getincrement.xml b/reference/mongodb/bson/timestampinterface/getincrement.xml deleted file mode 100644 index b67a98a05c..0000000000 --- a/reference/mongodb/bson/timestampinterface/getincrement.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - MongoDB\BSON\TimestampInterface::getIncrement - Devuelve el componente de incremento de este TimestampInterface - - - - &reftitle.description; - - abstract public intMongoDB\BSON\TimestampInterface::getIncrement - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el componente de incremento de este TimestampInterface. - - - - En sistemas de 32 bits este método puede devolver un número negativo. Aunque las partes de incremento y marca de tiempo del tipo BSON timestamp consisten en dos valores de 32 bits sin signo, PHP no puede representar estos en plataformas de 32 bits. - - - - - - &reftitle.seealso; - - MongoDB\BSON\Timestamp::getIncrement - - - - - - diff --git a/reference/mongodb/bson/timestampinterface/gettimestamp.xml b/reference/mongodb/bson/timestampinterface/gettimestamp.xml deleted file mode 100644 index 50f2b52be0..0000000000 --- a/reference/mongodb/bson/timestampinterface/gettimestamp.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - MongoDB\BSON\TimestampInterface::getTimestamp - Devuelve el componente de marca de tiempo de este TimestampInterface - - - - &reftitle.description; - - abstract public intMongoDB\BSON\TimestampInterface::getTimestamp - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el componente de marca de tiempo de este TimestampInterface. - - - - En sistemas de 32 bits este método puede devolver un número negativo. Aunque las partes de incremento y marca de tiempo del tipo de marca de tiempo BSON consisten en dos valores de 32 bits sin signo, PHP no puede representarlos en plataformas de 32 bits. - - - - - - &reftitle.seealso; - - MongoDB\BSON\Timestamp::getTimestamp - - - - - - diff --git a/reference/mongodb/bson/timestampinterface/tostring.xml b/reference/mongodb/bson/timestampinterface/tostring.xml deleted file mode 100644 index a6943c57aa..0000000000 --- a/reference/mongodb/bson/timestampinterface/tostring.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\BSON\TimestampInterface::__toString - Devuelve la representación en string de este TimestampInterface - - - - &reftitle.description; - - abstract public stringMongoDB\BSON\TimestampInterface::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la representación en string de este TimestampInterface. - - - - - &reftitle.seealso; - - MongoDB\BSON\Timestamp::__toString - - - - - - diff --git a/reference/mongodb/bson/type.xml b/reference/mongodb/bson/type.xml deleted file mode 100644 index 6a81c89b19..0000000000 --- a/reference/mongodb/bson/type.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - La interfaz MongoDB\BSON\Type - MongoDB\BSON\Type - - - - -
    - &reftitle.intro; - - Interfaz base abstracta que no debe implementarse directamente. - -
    - - -
    - &reftitle.interfacesynopsis; - - - - MongoDB\BSON\Type - - - - - MongoDB\BSON\Type - - - - - - - - - Esta interfaz no tiene métodos. Su único propósito es ser la interfaz base - para todas las clases de tipos BSON. - - -
    - -
    - -
    - - diff --git a/reference/mongodb/bson/undefined.xml b/reference/mongodb/bson/undefined.xml deleted file mode 100644 index 764bb6f2c4..0000000000 --- a/reference/mongodb/bson/undefined.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - La clase MongoDB\BSON\Undefined - MongoDB\BSON\Undefined - - - - -
    - &reftitle.intro; - - Tipo BSON para el tipo "Undefined" (Indefinido). Este tipo BSON está - deprecado, y esta clase no puede ser instanciada. Será creada a partir de - un tipo BSON undefined al convertir BSON a PHP, y también puede ser - convertido de vuelta a BSON al almacenar documentos en la base de datos. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\Undefined - - - - final - - MongoDB\BSON\Undefined - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - Stringable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.12.0 - - Implementa Stringable para PHP 8.0+. - - - - - -
    - -
    - - &reference.mongodb.bson.entities.undefined; - -
    - - diff --git a/reference/mongodb/bson/undefined/construct.xml b/reference/mongodb/bson/undefined/construct.xml deleted file mode 100644 index 43fbaf626c..0000000000 --- a/reference/mongodb/bson/undefined/construct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - MongoDB\BSON\Undefined::__construct - Construye una nueva Undefined (no utilizada) - - - - &reftitle.description; - - final private MongoDB\BSON\Undefined::__construct - - - - Los objetos MongoDB\BSON\Undefined se crean mediante - conversión desde un tipo BSON obsoleto y no pueden construirse directamente. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.seealso; - - Tipos BSON - - - - - - diff --git a/reference/mongodb/bson/undefined/jsonserialize.xml b/reference/mongodb/bson/undefined/jsonserialize.xml deleted file mode 100644 index 87fcbae97d..0000000000 --- a/reference/mongodb/bson/undefined/jsonserialize.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\BSON\Undefined::jsonSerialize - Devuelve una representación que puede convertirse a JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\Undefined::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve datos que pueden ser serializados por json_encode para - producir una representación JSON extendida de la - MongoDB\BSON\Undefined. - - &mongodb.note.extended-json; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB Extended JSON - - - - - - diff --git a/reference/mongodb/bson/undefined/tostring.xml b/reference/mongodb/bson/undefined/tostring.xml deleted file mode 100644 index 7ef71b87fd..0000000000 --- a/reference/mongodb/bson/undefined/tostring.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\BSON\Undefined::__toString - Devuelve una cadena vacía - - - - &reftitle.description; - - final public stringMongoDB\BSON\Undefined::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una cadena vacía. - - - - - &reftitle.seealso; - - Tipos BSON - - - - - - diff --git a/reference/mongodb/bson/unserializable.xml b/reference/mongodb/bson/unserializable.xml deleted file mode 100644 index bdf7b93b93..0000000000 --- a/reference/mongodb/bson/unserializable.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - La interfaz MongoDB\BSON\Unserializable - MongoDB\BSON\Unserializable - - - - -
    - &reftitle.intro; - - Las clases que implementan esta interfaz pueden especificarse en un - mapa de tipos para - deserializar arrays y documentos BSON (tanto raíz como incrustados). - -
    - - -
    - &reftitle.interfacesynopsis; - - - - MongoDB\BSON\Unserializable - - - - - MongoDB\BSON\Unserializable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - &mongodb.changelog.tentative-return-types; - - - -
    -
    - - &reference.mongodb.bson.entities.unserializable; - -
    - - diff --git a/reference/mongodb/bson/unserializable/bsonunserialize.xml b/reference/mongodb/bson/unserializable/bsonunserialize.xml deleted file mode 100644 index 7c683fc4aa..0000000000 --- a/reference/mongodb/bson/unserializable/bsonunserialize.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - MongoDB\BSON\Unserializable::bsonUnserialize - Construye el objeto a partir de un array o documento BSON - - - - &reftitle.description; - - abstract public voidMongoDB\BSON\Unserializable::bsonUnserialize - arraydata - - - Se invoca durante la deserialización del objeto desde BSON. Las propiedades del - array o documento BSON se pasarán a este método como un array. - - - Recuerde verificar la existencia de una propiedad _id al - procesar datos de un documento BSON. - - - - Este método actúa como el - constructor del - objeto. El método __construct() no - será llamado después de este método. - - - - - - &reftitle.parameters; - - - data (array) - - - Propiedades dentro del array o documento BSON. - - - - - - - - &reftitle.returnvalues; - - El valor de retorno de este método se ignora. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - - - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\BSON\Unserializable::bsonUnserialize</function> - -data = $data; - } -} - -$bson = MongoDB\BSON\Document::fromJSON('{ "foo": "bar" }'); - -var_dump($bson->toPHP(['root' => 'MyDocument'])); - -?> -]]> - - &example.outputs; - - - array(1) { - ["foo"]=> - string(3) "bar" - } -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\BSON\Serializable::bsonSerialize - MongoDB\BSON\Persistable - - - - - - - diff --git a/reference/mongodb/bson/utcdatetime.xml b/reference/mongodb/bson/utcdatetime.xml deleted file mode 100644 index 58aaa319a2..0000000000 --- a/reference/mongodb/bson/utcdatetime.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - La clase MongoDB\BSON\UTCDateTime - MongoDB\BSON\UTCDateTime - - - - -
    - &reftitle.intro; - - Representa una - fecha BSON. El valor - es un entero de 64 bits que representa el número de milisegundos transcurridos - desde la época Unix (1 de enero de 1970). Los valores negativos representan - fechas anteriores a 1970. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\BSON\UTCDateTime - - - - final - - MongoDB\BSON\UTCDateTime - - - - MongoDB\BSON\UTCDateTimeInterface - - - - MongoDB\BSON\Type - - - - JsonSerializable - - - - Stringable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.serializable-interface-removed; - - PECL mongodb 1.12.0 - - Implementa Stringable para PHP 8.0+. - - - - PECL mongodb 1.3.0 - - Implementa MongoDB\BSON\UTCDateTimeInterface. - - - - PECL mongodb 1.2.0 - - Implementa Serializable y - JsonSerializable. - - - - - -
    - -
    - - &reference.mongodb.bson.entities.utcdatetime; - -
    - - diff --git a/reference/mongodb/bson/utcdatetime/construct.xml b/reference/mongodb/bson/utcdatetime/construct.xml deleted file mode 100644 index bef2dfe0b9..0000000000 --- a/reference/mongodb/bson/utcdatetime/construct.xml +++ /dev/null @@ -1,164 +0,0 @@ - - - - - - MongoDB\BSON\UTCDateTime::__construct - Construye un nuevo objeto UTCDateTime - - - - &reftitle.description; - - final public MongoDB\BSON\UTCDateTime::__construct - intMongoDB\BSON\Int64DateTimeInterfacenullmilliseconds&null; - - - - - &reftitle.parameters; - - - milliseconds (intMongoDB\BSON\Int64DateTimeInterfacenull) - - - Número de milisegundos transcurridos desde la época Unix (1 de enero de 1970). - Los valores negativos representan fechas anteriores a 1970. Este valor puede - proporcionarse como un int de 64 bits. Para compatibilidad en - sistemas de 32 bits, este parámetro también puede proporcionarse como un - MongoDB\BSON\Int64. - - - Si el argumento es un DateTimeInterface, el número de - milisegundos transcurridos desde la época Unix se derivará de ese valor. - - - Si este argumento es &null;, por omisión se utilizará la hora actual. - - - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.0.0 - - - El parámetro milliseconds ya no acepta un argumento - de tipo string o float. - - - - - PECL mongodb 1.20.0 - - - El argumento milliseconds ahora acepta un objeto - MongoDB\BSON\Int64 (para compatibilidad en plataformas - de 32 bits). Especificar un string o float está - obsoleto. - - - - - PECL mongodb 1.2.0 - - - El argumento milliseconds es opcional y por omisión - es &null; (es decir, hora actual). El argumento también acepta un - DateTimeInterface, que puede usarse para derivar el - número de milisegundos transcurridos desde la época Unix. Anteriormente, - solo se aceptaban tipos int, float y - string. - - - - - - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\BSON\UTCDateTime::__construct</function> - - -]]> - - &example.outputs.similar; - - - string(13) "1484852905560" -} -object(MongoDB\BSON\UTCDateTime)#1 (1) { - ["milliseconds"]=> - string(13) "1484852905560" -} -object(MongoDB\BSON\UTCDateTime)#1 (1) { - ["milliseconds"]=> - string(13) "1416445411987" -} -]]> - - - - - - &reftitle.seealso; - - Tipos BSON: Fecha - - - - - - diff --git a/reference/mongodb/bson/utcdatetime/jsonserialize.xml b/reference/mongodb/bson/utcdatetime/jsonserialize.xml deleted file mode 100644 index d8e17d8b26..0000000000 --- a/reference/mongodb/bson/utcdatetime/jsonserialize.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\BSON\UTCDateTime::jsonSerialize - Devuelve una representación que puede convertirse a JSON - - - - &reftitle.description; - - final public mixedMongoDB\BSON\UTCDateTime::jsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve datos que pueden ser serializados por json_encode para - producir una representación JSON extendida de la - MongoDB\BSON\UTCDateTime. - - &mongodb.note.extended-json; - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - JsonSerializable::jsonSerialize - json_encode - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - MongoDB Extended JSON - - - - - - diff --git a/reference/mongodb/bson/utcdatetime/todatetime.xml b/reference/mongodb/bson/utcdatetime/todatetime.xml deleted file mode 100644 index 34bdf8daa9..0000000000 --- a/reference/mongodb/bson/utcdatetime/todatetime.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - MongoDB\BSON\UTCDateTime::toDateTime - Devuelve la representación DateTime de este UTCDateTime - - - - &reftitle.description; - - final public DateTimeMongoDB\BSON\UTCDateTime::toDateTime - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la representación DateTime de este - UTCDateTime. El DateTime devuelto utilizará la zona - horaria UTC. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\BSON\UTCDatetime::toDateTime</function> - -toDateTime(); -var_dump($datetime->format('r')); -var_dump($datetime->format('U.u')); -var_dump($datetime->getTimezone()); - -?> -]]> - - &example.outputs.similar; - - - int(1) - ["timezone"]=> - string(6) "+00:00" -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\BSON\UTCDateTime::toDateTimeImmutable - Tipos BSON: Fecha - - - - - - diff --git a/reference/mongodb/bson/utcdatetime/todatetimeimmutable.xml b/reference/mongodb/bson/utcdatetime/todatetimeimmutable.xml deleted file mode 100644 index 998fc07a8e..0000000000 --- a/reference/mongodb/bson/utcdatetime/todatetimeimmutable.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - MongoDB\BSON\UTCDateTime::toDateTimeImmutable - Devuelve la representación DateTimeImmutable de este UTCDateTime - - - - &reftitle.description; - - final public DateTimeImmutableMongoDB\BSON\UTCDateTime::toDateTimeImmutable - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la representación DateTimeImmutable de este - UTCDateTime. El DateTimeImmutable devuelto utilizará la zona - horaria UTC. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\BSON\UTCDatetime::toDateTimeImmutable</function> - -toDateTimeImmutable(); -var_dump($datetime->format('r')); -var_dump($datetime->format('U.u')); -var_dump($datetime->getTimezone()); - -?> -]]> - - &example.outputs.similar; - - - int(1) - ["timezone"]=> - string(6) "+00:00" -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\BSON\UTCDateTime::toDateTime - Tipos BSON: Fecha - - - - - - diff --git a/reference/mongodb/bson/utcdatetime/tostring.xml b/reference/mongodb/bson/utcdatetime/tostring.xml deleted file mode 100644 index 303ab135cf..0000000000 --- a/reference/mongodb/bson/utcdatetime/tostring.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - MongoDB\BSON\UTCDateTime::__toString - Devuelve la representación en forma de string de este UTCDateTime - - - - &reftitle.description; - - final public stringMongoDB\BSON\UTCDateTime::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la representación en forma de string de este UTCDateTime. - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\BSON\UTCDateTime::__toString</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - Tipos BSON: Fecha - - - - - - diff --git a/reference/mongodb/bson/utcdatetimeinterface.xml b/reference/mongodb/bson/utcdatetimeinterface.xml deleted file mode 100644 index cafe809de6..0000000000 --- a/reference/mongodb/bson/utcdatetimeinterface.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - La interfaz MongoDB\BSON\UTCDateTimeInterface - MongoDB\BSON\UTCDateTimeInterface - - -
    - &reftitle.intro; - - Esta interfaz es implementada por - MongoDB\BSON\UTCDateTime para ser utilizada como un - parámetro, retorno, o tipo de propiedad en clases de usuario. - -
    - -
    - &reftitle.classsynopsis; - - MongoDB\BSON\UTCDateTimeInterface - - - MongoDB\BSON\UTCDateTimeInterface - - - &Methods; - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - &mongodb.changelog.tentative-return-types; - - - -
    -
    - - &reference.mongodb.bson.entities.utcdatetimeinterface; - -
    - - diff --git a/reference/mongodb/bson/utcdatetimeinterface/todatetime.xml b/reference/mongodb/bson/utcdatetimeinterface/todatetime.xml deleted file mode 100644 index a4fb011d1e..0000000000 --- a/reference/mongodb/bson/utcdatetimeinterface/todatetime.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - MongoDB\BSON\UTCDateTimeInterface::toDateTime - Devuelve la representación DateTime de esta UTCDateTimeInterface - - - - &reftitle.description; - - abstract public DateTimeMongoDB\BSON\UTCDateTimeInterface::toDateTime - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la representación DateTime de esta - UTCDateTimeInterface. El DateTime devuelto debe usar - la zona horaria UTC. - - - - - &reftitle.seealso; - - MongoDB\BSON\UTCDateTime::toDateTime - - - - - - diff --git a/reference/mongodb/bson/utcdatetimeinterface/todatetimeimmutable.xml b/reference/mongodb/bson/utcdatetimeinterface/todatetimeimmutable.xml deleted file mode 100644 index bed7ccc784..0000000000 --- a/reference/mongodb/bson/utcdatetimeinterface/todatetimeimmutable.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - MongoDB\BSON\UTCDateTimeInterface::toDateTimeImmutable - Devuelve la representación DateTimeImmutable de esta interfaz UTCDateTimeInterface - - - - &reftitle.description; - - abstract public DateTimeImmutableMongoDB\BSON\UTCDateTimeInterface::toDateTimeImmutable - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la representación DateTimeImmutable de esta - interfaz UTCDateTimeInterface. El DateTimeImmutable devuelto utilizará la zona horaria UTC. - - - - - &reftitle.seealso; - - MongoDB\BSON\UTCDateTime::toDateTimeImmutable - - - - - - diff --git a/reference/mongodb/bson/utcdatetimeinterface/tostring.xml b/reference/mongodb/bson/utcdatetimeinterface/tostring.xml deleted file mode 100644 index fa77a8679b..0000000000 --- a/reference/mongodb/bson/utcdatetimeinterface/tostring.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\BSON\UTCDateTimeInterface::__toString - Devuelve la representación en string de esta UTCDateTimeInterface - - - - &reftitle.description; - - abstract public stringMongoDB\BSON\UTCDateTimeInterface::__toString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la representación en string de esta UTCDateTimeInterface. - - - - - &reftitle.seealso; - - MongoDB\BSON\UTCDateTime::__toString - - - - - - diff --git a/reference/mongodb/bson/vectortype.xml b/reference/mongodb/bson/vectortype.xml deleted file mode 100644 index 80b66b6c7a..0000000000 --- a/reference/mongodb/bson/vectortype.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - La enumeración MongoDB\BSON\VectorType - MongoDB\BSON\VectorType - - -
    - &reftitle.intro; - - La enumeración MongoDB\BSON\VectorType se utiliza para especificar el tipo de - datos vectoriales almacenados en un MongoDB\BSON\Binary con - subtipo MongoDB\BSON\Binary::TYPE_VECTOR. - -
    - -
    - &reftitle.enumsynopsis; - - - MongoDB\BSON\VectorType - - - Float32 - - Cada elemento en el vector es un valor de punto flotante de 32 bits. - - - - - Int8 - - Cada elemento en el vector es un valor entero de 8 bits. - - - - - PackedBit - - Cada elemento en el vector es un valor de 1 bit. Al crear vectores de este - tipo, puede pasar valores bool o valores int de 1 bit, es decir, 0 o 1. - - - -
    -
    -
    - - diff --git a/reference/mongodb/configure.xml b/reference/mongodb/configure.xml deleted file mode 100644 index 3bb9ffe305..0000000000 --- a/reference/mongodb/configure.xml +++ /dev/null @@ -1,324 +0,0 @@ - - -
    - &reftitle.install; - -
    - Instalación de la extensión MongoDB PHP con PIE - - &pecl.moving.to.pie; - - - Para instalar la extensión MongoDB usando PIE, ejecute el siguiente comando: - - - - - -
    - -
    - Instalación de la extensión MongoDB PHP con PECL - - - &pecl.info; - &url.pecl.package;mongodb - - - - Los usuarios de Linux, Unix y macOS pueden ejecutar el siguiente comando para instalar la - extensión: - - - - - - - En sistemas con múltiples versiones de PHP instaladas (por ejemplo, la versión predeterminada de macOS, - Homebrew), cada versión de PHP - tendrá su propio comando pecl - y archivo(s) &php.ini;. Además, cada entorno de PHP (por ejemplo, - CLI, web) puede usar archivos &php.ini; separados. - - - - A partir de la versión 1.17.0 de la extensión, PECL solicitará varias - opciones de configure. Para instalar la extensión con las - opciones predeterminadas en un script no interactivo, se puede enviar una entrada de cadena vacía - a pecl install usando el comando yes: - - - - - - - Se puede encontrar una lista completa de las opciones de configure admitidas - en el archivo package.xml incluido en el paquete PECL. - Para instalar la extensión con opciones específicas de configure en un script - no interactivo, se puede usar la opción --configureoptions para - pecl install: - - - - - - - Por omisión, instalar la extensión mediante PECL usará versiones integradas de - libbson, - libmongoc y - libmongocrypt e intentará - configurarlas automáticamente. - - - - - Si el proceso de compilación no logra encontrar una biblioteca SSL, verifique que los paquetes - de desarrollo (por ejemplo, libssl-dev) y - pkg-config estén ambos - instalados. Si esto no resuelve el problema, considere usar el - proceso de instalación manual. - - - - - Finalmente, agregue la siguiente línea al archivo &php.ini; para cada entorno - que necesite usar la extensión: - - - - -
    - -
    - Instalación de la extensión MongoDB PHP en macOS con Homebrew - - - Homebrew 1.5.0 - dejó de dar soporte al Homebrew/php tap - y eliminó las fórmulas para extensiones individuales de PHP. A partir de ahora, los usuarios de macOS - deben instalar la fórmula - php - y seguir las instrucciones estándar de - instalación con PECL - usando el comando pecl proporcionado por la - instalación de PHP de Homebrew. - - - Alternativamente, el - repositorio shivammathur/extensions - proporciona fórmulas para extensiones individuales de PHP. Por ejemplo, para instalar - la extensión para PHP 8.4, ejecute: - - - - Tenga en cuenta que solo está disponible la versión más reciente de la extensión en brew. - - - Instalar las dependencias requeridas - - Para garantizar que el soporte SSL pueda configurarse correctamente, asegúrese de que las fórmulas - openssl y pkgconf estén - instaladas. Si falta alguno de estos paquetes, la extensión se compilará con Secure Transport, - lo que puede generar problemas de compatibilidad. - - -
    - -
    - Instalación de la extensión MongoDB PHP en Windows - - - Se adjuntan binarios precompilados a los - lanzamientos del proyecto en Github. - Se publican archivos para varias combinaciones de versión de PHP, seguridad de subprocesos - (TS o NTS) y arquitectura (x86 o x64). Determine el archivo correcto para el entorno de PHP y - extraiga el archivo php_mongodb.dll al directorio de extensiones - ("ext" por omisión). - - - - Agregue la siguiente línea al archivo &php.ini; para cada entorno que necesite - usar la extensión: - - - - - - - Si no selecciona el binario correcto, se producirá un error al intentar cargar la DLL de la extensión - en tiempo de ejecución: - - - - - - - Asegúrese de que la DLL descargada corresponda a las siguientes propiedades del entorno de ejecución de PHP: - - Versión de PHP (PHP_VERSION) - Seguridad de subprocesos (PHP_ZTS) - Arquitectura (PHP_INT_SIZE) - - - - - Además de las constantes mencionadas anteriormente, estas propiedades también pueden inferirse - desde la función phpinfo. Si un sistema tiene múltiples entornos de ejecución - de PHP instalados, verifique que la salida de phpinfo corresponda al entorno correcto. - - - - Dependencias adicionales de DLL para usuarios de Windows - - &ext.windows.path.dll; - libsasl.dll - - -
    - -
    - Compilación del controlador MongoDB PHP desde el código fuente - - - Para desarrolladores y usuarios interesados en las correcciones más recientes de errores, la extensión - puede compilarse desde el código fuente más reciente en - Github. Ejecute los siguientes - comandos para clonar y compilar el proyecto: - - - - - - - En sistemas con múltiples versiones de PHP instaladas (por ejemplo, la versión predeterminada de macOS, - Homebrew), cada versión de PHP - tendrá su propio comando phpize - y archivo(s) &php.ini;. Además, cada entorno de PHP (por ejemplo, - CLI, web) puede usar archivos &php.ini; separados. - - - - Por omisión, la extensión usará versiones integradas de - libbson, - libmongoc y - libmongocrypt e intentará - configurarlas automáticamente. Si estas bibliotecas ya están instaladas como bibliotecas del sistema, - la extensión puede utilizarlas especificando --with-mongodb-system-libs=yes como - opción para configure. - - - - Para obtener una lista completa de las opciones de configure, ejecute - configure --help. - - - - Al usar versiones integradas de libmongoc y libmongocrypt, la extensión también intentará - seleccionar una biblioteca SSL según la opción --with-mongodb-ssl de - configure. A partir de la versión 1.17.0 de la extensión, OpenSSL siempre - se prefiere por omisión. Anteriormente, Secure Transport era la opción predeterminada en macOS - y OpenSSL era la opción predeterminada en todas las demás plataformas. - - - - - Si el proceso de compilación no logra encontrar una biblioteca SSL, verifique que los paquetes - de desarrollo (por ejemplo, libssl-dev) y - pkg-config estén ambos - instalados. - - - - Al usar Homebrew en macOS, es común que un sistema tenga instaladas múltiples - versiones de OpenSSL. Para garantizar que se seleccione la versión deseada de OpenSSL, - se puede usar la variable de entorno PKG_CONFIG_PATH para controlar - la ruta de búsqueda de pkg-config. - - - - - El paso final de compilación, make install, informará dónde - se ha instalado mongodb.so, similar a: - - - - - - - Asegúrese de que la opción extension_dir - en &php.ini; apunte al directorio donde se instaló mongodb.so. - La opción puede consultarse ejecutando: - - /usr/lib/php/extensions/debug-non-zts-20220829 => - /usr/lib/php/extensions/debug-non-zts-20220829 -]]> - - - - - Si los directorios difieren, cambie - extension_dir en &php.ini; o - mueva manualmente mongodb.so al directorio correcto. - - - - Finalmente, agregue la siguiente línea al archivo &php.ini; para cada entorno - que necesite usar la extensión: - - - - -
    - -
    - - diff --git a/reference/mongodb/constants.xml b/reference/mongodb/constants.xml deleted file mode 100644 index 9707294e61..0000000000 --- a/reference/mongodb/constants.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - - - - MONGODB_VERSION - (string) - - - - Número de versión estilo x.y.z de la extensión - - - - - - MONGODB_STABILITY - (string) - - - - Estabilidad actual (alpha/beta/stable) - - - - - - - - diff --git a/reference/mongodb/exceptions.xml b/reference/mongodb/exceptions.xml deleted file mode 100644 index df210a4bd9..0000000000 --- a/reference/mongodb/exceptions.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - MongoDB\Driver\Exception - Clases de excepciones - - &reference.mongodb.mongodb.driver.exception.authenticationexception; - &reference.mongodb.mongodb.driver.exception.bulkwriteexception; - &reference.mongodb.mongodb.driver.exception.bulkwritecommandexception; - &reference.mongodb.mongodb.driver.exception.commandexception; - &reference.mongodb.mongodb.driver.exception.connectionexception; - &reference.mongodb.mongodb.driver.exception.connectiontimeoutexception; - &reference.mongodb.mongodb.driver.exception.encryptionexception; - &reference.mongodb.mongodb.driver.exception.exception; - &reference.mongodb.mongodb.driver.exception.executiontimeoutexception; - &reference.mongodb.mongodb.driver.exception.invalidargumentexception; - &reference.mongodb.mongodb.driver.exception.logicexception; - &reference.mongodb.mongodb.driver.exception.runtimeexception; - &reference.mongodb.mongodb.driver.exception.serverexception; - &reference.mongodb.mongodb.driver.exception.sslconnectionexception; - &reference.mongodb.mongodb.driver.exception.unexpectedvalueexception; - &reference.mongodb.mongodb.driver.exception.writeexception; - -
    - Jerarquía de clases - Jerarquía de clases de excepciones de MongoDB - - - La jerarquía de clases para las excepciones de MongoDB está modelada siguiendo la de las - excepciones SPL. Las clases base extienden su contraparte de SPL y todas las clases de excepciones en la extensión implementan - la interfaz MongoDB\Driver\Exception\Exception. - - - - MongoDB\Driver\Exception\LogicException (extiende LogicException) - MongoDB\Driver\Exception\InvalidArgumentException (extiende InvalidArgumentException) - MongoDB\Driver\Exception\UnexpectedValueException (extiende UnexpectedValueException) - - MongoDB\Driver\Exception\RuntimeException (extiende RuntimeException) - - - MongoDB\Driver\Exception\ConnectionException - - MongoDB\Driver\Exception\AuthenticationException - MongoDB\Driver\Exception\ConnectionTimeoutException - MongoDB\Driver\Exception\SSLConnectionException (obsoleto) - - - MongoDB\Driver\Exception\EncryptionException - - MongoDB\Driver\Exception\ServerException - - MongoDB\Driver\Exception\BulkWriteCommandException - MongoDB\Driver\Exception\CommandException - MongoDB\Driver\Exception\ExecutionTimeoutException - - MongoDB\Driver\Exception\WriteException (obsoleto) - - MongoDB\Driver\Exception\BulkWriteException - - - - - - - -
    - -
    diff --git a/reference/mongodb/functions/bson/fromjson.xml b/reference/mongodb/functions/bson/fromjson.xml deleted file mode 100644 index caebf814d4..0000000000 --- a/reference/mongodb/functions/bson/fromjson.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - MongoDB\BSON\fromJSON - Devuelve la representación BSON de un valor JSON - - - - - - Esta función ha sido DEPRECADA a partir de la versión - 1.20.0 de la extensión y fue eliminada en la versión 2.0. Las aplicaciones - deben usar MongoDB\BSON\Document::fromJSON en su lugar. - - - - - - &reftitle.description; - - stringMongoDB\BSON\fromJSON - stringjson - - - Convierte una cadena de - JSON extendido - a su representación BSON. - - - - - &reftitle.parameters; - - - json (string) - - - Valor JSON que se desea convertir. - - - - - - - - &reftitle.returnvalues; - - El documento BSON serializado como una cadena binaria. - - - - - &reftitle.errors; - - - Lanza - MongoDB\Driver\Exception\UnexpectedValueException si - el valor JSON no puede convertirse a BSON (por ejemplo, debido a un error de sintaxis). - - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.function-removed; - - - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\BSON\fromJSON</function> - - -]]> - - &example.outputs; - - - object(MongoDB\BSON\ObjectId)#1 (1) { - ["oid"]=> - string(24) "563143b280d2387c91807965" - } -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\BSON\Document::fromJSON - MongoDB\BSON\toJSON - JSON Extendido de MongoDB - BSON de MongoDB - - - - - - diff --git a/reference/mongodb/functions/bson/fromphp.xml b/reference/mongodb/functions/bson/fromphp.xml deleted file mode 100644 index 6021f265d9..0000000000 --- a/reference/mongodb/functions/bson/fromphp.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - MongoDB\BSON\fromPHP - Devuelve la representación BSON de un valor PHP - - - - - - Esta función ha sido DEPRECADA a partir de la versión 1.20.0 - de la extensión y fue eliminada en la versión 2.0. Las aplicaciones deben usar - MongoDB\BSON\Document::fromPHP en su lugar. - - - - - - &reftitle.description; - - stringMongoDB\BSON\fromPHP - arrayobjectvalor - - - Serializa un array o objeto PHP (por ejemplo, un documento) a su - representación BSON. La - cadena binaria devuelta describirá un documento BSON. - - - - - &reftitle.parameters; - - - valor (arrayobject) - - - Valor PHP que se serializará. - - - - - - - - &reftitle.returnvalues; - - El documento BSON serializado como una cadena binaria. - - - - - &reftitle.errors; - - - Lanza - MongoDB\Driver\Exception\UnexpectedValueException si - el valor PHP no puede convertirse a BSON. Las razones posibles incluyen, entre - otras, encontrar una instancia inesperada de - MongoDB\BSON\Type o que - MongoDB\BSON\Serializable::bsonSerialize no devuelva un - array o un stdClass. - - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.function-removed; - - - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\BSON\fromPHP</function> - - 1]); -echo bin2hex($bson), "\n"; - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Document::fromPHP - MongoDB\BSON\toPHP - MongoDB BSON - - - - - - - diff --git a/reference/mongodb/functions/bson/tocanonicalextendedjson.xml b/reference/mongodb/functions/bson/tocanonicalextendedjson.xml deleted file mode 100644 index 7e9f766d22..0000000000 --- a/reference/mongodb/functions/bson/tocanonicalextendedjson.xml +++ /dev/null @@ -1,182 +0,0 @@ - - - - - - MongoDB\BSON\toCanonicalExtendedJSON - Devuelve la representación en Canonical Extended JSON de un valor BSON - - - - - - Esta función ha sido DEPRECADA a partir de la versión 1.20.0 de la extensión - y fue eliminada en la versión 2.0. Las aplicaciones deben usar en su lugar - MongoDB\BSON\Document::toCanonicalExtendedJSON. - - - - - - &reftitle.description; - - stringMongoDB\BSON\toCanonicalExtendedJSON - stringbson - - - Convierte una cadena BSON a su representación en - Canonical Extended JSON. - El formato canónico prioriza la fidelidad de tipos a costa de una salida menos concisa y es más adecuado - para producir salidas que puedan convertirse de vuelta a BSON sin pérdida de información de tipos - (por ejemplo, los tipos numéricos permanecerán diferenciados). - - - - - &reftitle.parameters; - - - bson (string) - - - Valor BSON que se convertirá. - - - - - - - - &reftitle.returnvalues; - - El valor JSON convertido. - - - - - &reftitle.errors; - - &mongodb.throws.bson.unexpected; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.function-removed; - - - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\BSON\toCanonicalExtendedJSON</function> - - null ], - [ 'boolean' => true ], - [ 'string' => 'foo' ], - [ 'int32' => 123 ], - [ 'int64' => 4294967295 ], - [ 'double' => 1.0, ], - [ 'nan' => NAN ], - [ 'pos_inf' => INF ], - [ 'neg_inf' => -INF ], - [ 'array' => [ 'foo', 'bar' ]], - [ 'document' => [ 'foo' => 'bar' ]], - [ 'oid' => new MongoDB\BSON\ObjectId('56315a7c6118fd1b920270b1') ], - [ 'dec128' => new MongoDB\BSON\Decimal128('1234.5678') ], - [ 'binary' => new MongoDB\BSON\Binary('foo', MongoDB\BSON\Binary::TYPE_GENERIC) ], - [ 'date' => new MongoDB\BSON\UTCDateTime(1445990400000) ], - [ 'timestamp' => new MongoDB\BSON\Timestamp(1234, 5678) ], - [ 'regex' => new MongoDB\BSON\Regex('pattern', 'i') ], - [ 'code' => new MongoDB\BSON\Javascript('function() { return 1; }') ], - [ 'code_ws' => new MongoDB\BSON\Javascript('function() { return a; }', ['a' => 1]) ], - [ 'minkey' => new MongoDB\BSON\MinKey ], - [ 'maxkey' => new MongoDB\BSON\MaxKey ], -]; - -foreach ($documents as $document) { - $bson = MongoDB\BSON\fromPHP($document); - echo MongoDB\BSON\toCanonicalExtendedJSON($bson), "\n"; -} - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Document::fromJSON - MongoDB\BSON\Document::toCanonicalExtendedJSON - MongoDB\BSON\fromJSON - MongoDB\BSON\toRelaxedExtendedJSON - Especificación de JSON Extendido - MongoDB BSON - - - - - - diff --git a/reference/mongodb/functions/bson/tojson.xml b/reference/mongodb/functions/bson/tojson.xml deleted file mode 100644 index 0f8efa42ee..0000000000 --- a/reference/mongodb/functions/bson/tojson.xml +++ /dev/null @@ -1,207 +0,0 @@ - - - - - - MongoDB\BSON\toJSON - Devuelve la representación en JSON Extendido Legado de un valor BSON - - - - - - Esta función ha sido DEPRECADA a partir de la versión - 1.20.0 de la extensión y fue eliminada en la versión 2.0. Las aplicaciones - deben usar en su lugar - MongoDB\BSON\Document::toCanonicalExtendedJSON o - MongoDB\BSON\Document::toRelaxedExtendedJSON. - - - - - - &reftitle.description; - - stringMongoDB\BSON\toJSON - stringbson - - - Convierte una cadena BSON a su representación en - JSON Extendido Legado. - - - - Existen varios formatos JSON para representar BSON. Esta función - implementa el "modo estricto" definido en - JSON Extendido de MongoDB, - que ha sido reemplazado por los formatos canónico y relajado definidos en - la - Especificación de JSON Extendido - e implementados por MongoDB\BSON\toCanonicalExtendedJSON - y MongoDB\BSON\toRelaxedExtendedJSON, respectivamente. - - - - - JSON no admite - NAN ni - INF, y el - formato de JSON Extendido Legado de MongoDB no define una representación - alternativa para estos valores - (libbson generará - literales nan e inf, que pueden no - ser analizados como JSON válido). Si está trabajando con BSON que puede - contener números no finitos, utilice - MongoDB\BSON\toCanonicalExtendedJSON o - MongoDB\BSON\toRelaxedExtendedJSON. - - - - - - &reftitle.parameters; - - - bson (string) - - - Valor BSON a convertir. - - - - - - - - &reftitle.returnvalues; - - El valor JSON convertido. - - - - - &reftitle.errors; - - &mongodb.throws.bson.unexpected; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.function-removed; - - - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\BSON\toJSON</function> - - null ], - [ 'boolean' => true ], - [ 'string' => 'foo' ], - [ 'int32' => 123 ], - [ 'int64' => 4294967295 ], - [ 'double' => 1.0, ], - [ 'nan' => NAN ], - [ 'pos_inf' => INF ], - [ 'neg_inf' => -INF ], - [ 'array' => [ 'foo', 'bar' ]], - [ 'document' => [ 'foo' => 'bar' ]], - [ 'oid' => new MongoDB\BSON\ObjectId('56315a7c6118fd1b920270b1') ], - [ 'dec128' => new MongoDB\BSON\Decimal128('1234.5678') ], - [ 'binary' => new MongoDB\BSON\Binary('foo', MongoDB\BSON\Binary::TYPE_GENERIC) ], - [ 'date' => new MongoDB\BSON\UTCDateTime(1445990400000) ], - [ 'timestamp' => new MongoDB\BSON\Timestamp(1234, 5678) ], - [ 'regex' => new MongoDB\BSON\Regex('pattern', 'i') ], - [ 'code' => new MongoDB\BSON\Javascript('function() { return 1; }') ], - [ 'code_ws' => new MongoDB\BSON\Javascript('function() { return a; }', ['a' => 1]) ], - [ 'minkey' => new MongoDB\BSON\MinKey ], - [ 'maxkey' => new MongoDB\BSON\MaxKey ], -]; - -foreach ($documents as $document) { - $bson = MongoDB\BSON\fromPHP($document); - echo MongoDB\BSON\toJSON($bson), "\n"; -} - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\fromJSON - MongoDB\BSON\toCanonicalExtendedJSON - MongoDB\BSON\toRelaxedExtendedJSON - JSON Extendido de MongoDB - BSON de MongoDB - - - - - - diff --git a/reference/mongodb/functions/bson/tophp.xml b/reference/mongodb/functions/bson/tophp.xml deleted file mode 100644 index 13f62b3fda..0000000000 --- a/reference/mongodb/functions/bson/tophp.xml +++ /dev/null @@ -1,177 +0,0 @@ - - - - - MongoDB\BSON\toPHP - Devuelve la representación en PHP de un valor BSON - - - - - - Esta función ha sido DEPRECADA a partir de la versión - 1.20.0 de la extensión y fue eliminada en la versión 2.0. Las aplicaciones - deben usar MongoDB\BSON\Document::toPHP en su lugar. - - - - - - &reftitle.description; - - arrayobjectMongoDB\BSON\toPHP - stringbson - arraytypeMaparray() - - - Deserializa un documento BSON (es decir, una cadena binaria) a su - representación en PHP. El parámetro typeMap puede usarse - para controlar los tipos de PHP utilizados para convertir matrices y - documentos BSON (tanto raíz como incrustados). - - &mongodb.warning.duplicate-keys; - - - - &reftitle.parameters; - - - bson (string) - - - Valor BSON a deserializar. - - - - &mongodb.parameter.typeMap; - - - - - &reftitle.returnvalues; - - El valor en PHP deserializado. - - - - - &reftitle.errors; - - - Lanza - MongoDB\Driver\Exception\InvalidArgumentException si - una clase en el mapa de tipos no puede ser instanciada o no implementa - MongoDB\BSON\Unserializable. - - &mongodb.throws.bson.unexpected; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.function-removed; - - PECL mongodb 1.4.0 - - - Si la entrada contiene un tipo BSON obsoleto no admitido, la extensión - ya no registrará una advertencia en el registro de depuración, sino que - creará un objeto que represente este tipo. - - - - - PECL mongodb 1.3.2 - - - Ya no se lanza MongoDB\Driver\Exception\UnexpectedValueException - si la entrada contiene un tipo BSON obsoleto no admitido. Tales tipos - serán ignorados (como lo eran en versiones anteriores a 1.3.0), - aunque la extensión registrará ahora una advertencia en el registro de - depuración (ver: mongodb.debug). - - - - - PECL mongodb 1.3.0 - - - Se lanza MongoDB\Driver\Exception\UnexpectedValueException - si la entrada contiene un tipo BSON obsoleto no admitido. Anteriormente, - tales tipos eran ignorados. - - - - - - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\BSON\toPHP</function> - - -]]> - - &example.outputs; - - - int(1) -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\BSON\Document::toPHP - MongoDB\BSON\fromPHP - MongoDB BSON - - - - - - - diff --git a/reference/mongodb/functions/bson/torelaxedextendedjson.xml b/reference/mongodb/functions/bson/torelaxedextendedjson.xml deleted file mode 100644 index f1b5b82243..0000000000 --- a/reference/mongodb/functions/bson/torelaxedextendedjson.xml +++ /dev/null @@ -1,181 +0,0 @@ - - - - - - MongoDB\BSON\toRelaxedExtendedJSON - Devuelve la representación en Relaxed Extended JSON de un valor BSON - - - - - - Esta función ha sido DEPRECADA a partir de la versión 1.20.0 de la extensión - y fue eliminada en la versión 2.0. Las aplicaciones deben usar - MongoDB\BSON\Document::toRelaxedExtendedJSON - en su lugar. - - - - - - &reftitle.description; - - stringMongoDB\BSON\toRelaxedExtendedJSON - stringbson - - - Convierte una cadena BSON a su representación en - Relaxed Extended JSON. - El formato relajado prefiere el uso de primitivas de tipo JSON a costa de la fidelidad de tipos y es más adecuado para producir salidas que puedan ser consumidas fácilmente por APIs web y humanos. - - - - - &reftitle.parameters; - - - bson (string) - - - Valor BSON que se convertirá. - - - - - - - - &reftitle.returnvalues; - - El valor JSON convertido. - - - - - &reftitle.errors; - - &mongodb.throws.bson.unexpected; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.function-removed; - - - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\BSON\toRelaxedExtendedJSON</function> - - null ], - [ 'boolean' => true ], - [ 'string' => 'foo' ], - [ 'int32' => 123 ], - [ 'int64' => 4294967295 ], - [ 'double' => 1.0, ], - [ 'nan' => NAN ], - [ 'pos_inf' => INF ], - [ 'neg_inf' => -INF ], - [ 'array' => [ 'foo', 'bar' ]], - [ 'document' => [ 'foo' => 'bar' ]], - [ 'oid' => new MongoDB\BSON\ObjectId('56315a7c6118fd1b920270b1') ], - [ 'dec128' => new MongoDB\BSON\Decimal128('1234.5678') ], - [ 'binary' => new MongoDB\BSON\Binary('foo', MongoDB\BSON\Binary::TYPE_GENERIC) ], - [ 'date' => new MongoDB\BSON\UTCDateTime(1445990400000) ], - [ 'timestamp' => new MongoDB\BSON\Timestamp(1234, 5678) ], - [ 'regex' => new MongoDB\BSON\Regex('pattern', 'i') ], - [ 'code' => new MongoDB\BSON\Javascript('function() { return 1; }') ], - [ 'code_ws' => new MongoDB\BSON\Javascript('function() { return a; }', ['a' => 1]) ], - [ 'minkey' => new MongoDB\BSON\MinKey ], - [ 'maxkey' => new MongoDB\BSON\MaxKey ], -]; - -foreach ($documents as $document) { - $bson = MongoDB\BSON\fromPHP($document); - echo MongoDB\BSON\toRelaxedExtendedJSON($bson), "\n"; -} - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\BSON\Document::fromJSON - MongoDB\BSON\Document::toRelaxedExtendedJSON - MongoDB\BSON\fromJSON - MongoDB\BSON\toCanonicalExtendedJSON - JSON Extendido - MongoDB BSON - - - - - - diff --git a/reference/mongodb/functions/driver/monitoring/addsubscriber.xml b/reference/mongodb/functions/driver/monitoring/addsubscriber.xml deleted file mode 100644 index 1b101b3552..0000000000 --- a/reference/mongodb/functions/driver/monitoring/addsubscriber.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\addSubscriber - Registra un suscriptor de eventos de monitorización de forma global - - - - &reftitle.description; - - voidMongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Monitoring\Subscribersubscriber - - - Registra un suscriptor de eventos de monitorización de forma global. El suscriptor - será notificado de todos los eventos en la extensión para cualquier Manager. - - - - Si el subscriber ya está registrado de forma global, esta - función no realiza ninguna acción. Si el subscriber también está - registrado con uno o más Managers, solo será notificado una vez de cada evento - para cada Manager. - - - - - - &reftitle.parameters; - - - subscriber (MongoDB\Driver\Monitoring\Subscriber) - - - Un suscriptor de eventos de monitorización para registrar de forma global. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\removeSubscriber - MongoDB\Driver\Monitoring\Subscriber - MongoDB\Driver\Monitoring\CommandSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - - diff --git a/reference/mongodb/functions/driver/monitoring/removesubscriber.xml b/reference/mongodb/functions/driver/monitoring/removesubscriber.xml deleted file mode 100644 index 0eba446964..0000000000 --- a/reference/mongodb/functions/driver/monitoring/removesubscriber.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\removeSubscriber - Deregistra un suscriptor de eventos de supervisión globalmente - - - - &reftitle.description; - - voidMongoDB\Driver\Monitoring\removeSubscriber - MongoDB\Driver\Monitoring\Subscribersubscriber - - - Deregistra un suscriptor de eventos de supervisión globalmente. - - - - Si el subscriber no está registrado globalmente, - esta función no realiza ninguna acción. - - - - - - &reftitle.parameters; - - - subscriber (MongoDB\Driver\Monitoring\Subscriber) - - - Un suscriptor de eventos de supervisión que se desregistrará globalmente. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Monitoring\Subscriber - MongoDB\Driver\Monitoring\CommandSubscriber - MongoDB\Driver\Manager::removeSubscriber - - - - - - - diff --git a/reference/mongodb/ini.xml b/reference/mongodb/ini.xml deleted file mode 100644 index d5e1b1e2e2..0000000000 --- a/reference/mongodb/ini.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - - mongodb &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - mongodb.debug - "" - INI_ALL - - - - -
    -
    - - &ini.descriptions.title; - - - - - - mongodb.debug - string - - - - Esta opción puede usarse para activar o desactivar el registro de - depuración a nivel de traza en la extensión (y en libmongoc). - - - Especifique una cadena vacía, "0", - "off", "no" o - "false" para desactivar el registro. - - - Especifique "stderr" o "stdout" para - registrar en stderr o stdout, - respectivamente. - - - Especifique "1", "on", - "yes" o "true" para registrar en un - nuevo fichero temporal dentro del directorio temporal del sistema por - omisión (es decir, sys_get_temp_dir). - - - Especifique cualquier otra cadena para registrar en un nuevo fichero - temporal dentro de ese directorio. Si el directorio no puede usarse, se - usará el directorio temporal del sistema por omisión. - - - - Tenga en cuenta que el registro de depuración puede contener información - sensible, como credenciales del servidor MongoDB y documentos completos - escritos o leídos del servidor. Revise cualquier registro de depuración - antes de compartirlos con otras personas. - - - - - - -
    - - diff --git a/reference/mongodb/mongodb.xml b/reference/mongodb/mongodb.xml deleted file mode 100644 index 31882f9a41..0000000000 --- a/reference/mongodb/mongodb.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - - - - Clases de la extensión MongoDB - MongoDB\Driver - - &reference.mongodb.mongodb.driver.manager; - &reference.mongodb.mongodb.driver.command; - &reference.mongodb.mongodb.driver.query; - &reference.mongodb.mongodb.driver.bulkwrite; - &reference.mongodb.mongodb.driver.bulkwritecommand; - &reference.mongodb.mongodb.driver.session; - &reference.mongodb.mongodb.driver.clientencryption; - &reference.mongodb.mongodb.driver.serverapi; - - &reference.mongodb.mongodb.driver.writeconcern; - &reference.mongodb.mongodb.driver.readpreference; - &reference.mongodb.mongodb.driver.readconcern; - - &reference.mongodb.mongodb.driver.cursor; - &reference.mongodb.mongodb.driver.cursorid; - &reference.mongodb.mongodb.driver.cursorinterface; - - &reference.mongodb.mongodb.driver.server; - &reference.mongodb.mongodb.driver.serverdescription; - &reference.mongodb.mongodb.driver.topologydescription; - - &reference.mongodb.mongodb.driver.writeconcernerror; - &reference.mongodb.mongodb.driver.writeerror; - &reference.mongodb.mongodb.driver.writeresult; - &reference.mongodb.mongodb.driver.bulkwritecommandresult; - diff --git a/reference/mongodb/mongodb/driver/bulkwrite.xml b/reference/mongodb/mongodb/driver/bulkwrite.xml deleted file mode 100644 index 24823ca07e..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwrite.xml +++ /dev/null @@ -1,226 +0,0 @@ - - - - - La clase MongoDB\Driver\BulkWrite - MongoDB\Driver\BulkWrite - - - - -
    - &reftitle.intro; - - La clase MongoDB\Driver\BulkWrite recopila una o más - operaciones de escritura que deben enviarse al servidor. Tras añadir cualquier - número de operaciones de inserción, actualización y eliminación, la colección - puede ejecutarse mediante - MongoDB\Driver\Manager::executeBulkWrite. - - - Las operaciones de escritura pueden ser ordenadas (por omisión) o no ordenadas. - Las operaciones de escritura ordenadas se envían al servidor, en el orden - proporcionado, para su ejecución secuencial. Si una escritura falla, las - operaciones restantes se abortarán. Las operaciones no ordenadas se envían al - servidor en un orden arbitrario donde pueden ejecutarse en paralelo. Cualquier - error que ocurra se notificará después de que se hayan intentado todas las - operaciones. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\BulkWrite - - - - final - - MongoDB\Driver\BulkWrite - - - - Countable - - - - - &Methods; - - - - -
    - -
    - &reftitle.examples; - - - Las operaciones de escritura mixtas se agrupan por tipo - - Las operaciones de escritura mixtas (es decir, inserciones, actualizaciones y - eliminaciones) se ensamblarán en comandos de escritura tipificados para - enviarse secuencialmente al servidor. - - - true]); -$bulk->insert(['_id' => 1, 'x' => 1]); -$bulk->insert(['_id' => 2, 'x' => 2]); -$bulk->update(['x' => 2], ['$set' => ['x' => 1]]); -$bulk->insert(['_id' => 3, 'x' => 3]); -$bulk->delete(['x' => 1]); - -?> -]]> - - - Dará como resultado la ejecución de cuatro comandos de escritura (es decir, - viajes de ida y vuelta). Dado que las operaciones están ordenadas, la tercera - inserción no puede enviarse hasta que se ejecute la actualización precedente. - - - - Operaciones de escritura ordenadas que causan un error - - true]); -$bulk->delete([]); -$bulk->insert(['_id' => 1]); -$bulk->insert(['_id' => 2]); -$bulk->insert(['_id' => 3, 'hello' => 'world']); -$bulk->update(['_id' => 3], ['$set' => ['hello' => 'earth']]); -$bulk->insert(['_id' => 4, 'hello' => 'pluto']); -$bulk->update(['_id' => 4], ['$set' => ['hello' => 'moon']]); -$bulk->insert(['_id' => 3]); -$bulk->insert(['_id' => 4]); -$bulk->insert(['_id' => 5]); - -$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017'); -$writeConcern = new MongoDB\Driver\WriteConcern(MongoDB\Driver\WriteConcern::MAJORITY, 1000); - -try { - $result = $manager->executeBulkWrite('db.collection', $bulk, ['writeConcern' => $writeConcern]); -} catch (MongoDB\Driver\Exception\BulkWriteException $e) { - $result = $e->getWriteResult(); - - // Comprobar si la preocupación de escritura no pudo cumplirse - if ($writeConcernError = $result->getWriteConcernError()) { - printf("%s (%d): %s\n", - $writeConcernError->getMessage(), - $writeConcernError->getCode(), - var_export($writeConcernError->getInfo(), true) - ); - } - - // Comprobar si alguna operación de escritura no se completó en absoluto - foreach ($result->getWriteErrors() as $writeError) { - printf("Operación#%d: %s (%d)\n", - $writeError->getIndex(), - $writeError->getMessage(), - $writeError->getCode() - ); - } -} catch (MongoDB\Driver\Exception\Exception $e) { - printf("Otro error: %s\n", $e->getMessage()); - exit; -} - -printf("Insertados %d documento(s)\n", $result->getInsertedCount()); -printf("Actualizados %d documento(s)\n", $result->getModifiedCount()); - -?> -]]> - - - &example.outputs; - - - - - Si la preocupación de escritura no pudiera cumplirse, el ejemplo anterior - mostraría algo como: - - - true, -) -Operación#7: E11000 duplicate key error index: databaseName.collectionName.$_id_ dup key: { : 3 } (11000) -Insertados 4 documento(s) -Actualizados 2 documento(s) -]]> - - - Si ejecutamos el ejemplo anterior, pero permitimos escrituras no ordenadas: - - - false]); -/* ... */ - -?> -]]> - - &example.outputs; - - - -
    - -
    - &reftitle.seealso; - - MongoDB\Driver\Manager::executeBulkWrite - MongoDB\Driver\WriteResult - MongoDB\Driver\WriteConcern - MongoDB\Driver\WriteConcernError - MongoDB\Driver\WriteError - -
    - -
    - - &reference.mongodb.mongodb.driver.entities.bulkwrite; - -
    - - diff --git a/reference/mongodb/mongodb/driver/bulkwrite/construct.xml b/reference/mongodb/mongodb/driver/bulkwrite/construct.xml deleted file mode 100644 index cac3e720ce..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwrite/construct.xml +++ /dev/null @@ -1,232 +0,0 @@ - - - - - - MongoDB\Driver\BulkWrite::__construct - Crea un nuevo BulkWrite - - - - &reftitle.description; - - public MongoDB\Driver\BulkWrite::__construct - arraynulloptions&null; - - - Construye un nuevo MongoDB\Driver\BulkWrite, que es un - objeto mutable al cual se pueden añadir una o más operaciones de escritura. Las - escritura(s) pueden entonces ser ejecutadas con - MongoDB\Driver\Manager::executeBulkWrite. - - - - - &reftitle.parameters; - - - options (array) - - - - options - - - - Opción - Tipo - Descripción - Valor por omisión - - - - - bypassDocumentValidation - bool - - - Si es &true;, permite que las operaciones de inserción y actualización - eviten la validación a nivel de documento. - - - Esta opción está disponible en MongoDB 3.2+ y es ignorada en versiones - anteriores del servidor, que no soportan validación a nivel de documento. - - - &false; - - - comment - mixed - - - Un comentario arbitrario para ayudar a rastrear la operación a través - del perfilador de la base de datos, la salida currentOp y los registros. - - - Esta opción está disponible en MongoDB 4.4+ y generará una excepción - en tiempo de ejecución si se especifica para una versión anterior del - servidor. - - - - &mongodb.option.let; - - ordered - bool - - Las operaciones ordenadas (&true;) se ejecutan de forma serial en el - servidor de MongoDB, mientras que las operaciones no ordenadas - (&false;) son enviadas al servidor en un orden arbitrario y pueden - ser ejecutadas en paralelo. - - &true; - - - -
    -
    -
    -
    -
    -
    - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.14.0 - - Se añadieron las opciones "comment" y "let". - - - - PECL mongodb 1.1.0 - - Se añadió la opción "bypassDocumentValidation". - - - - - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\BulkWrite::__construct</function> - - true]); -$bulk->delete([]); -$bulk->insert(['_id' => 1, 'x' => 1]); -$bulk->insert(['_id' => 2, 'x' => 2]); -$bulk->update( - ['x' => 2], - ['$set' => ['x' => 1]], - ['limit' => 1, 'upsert' => false] -); -$bulk->delete(['x' => 1], ['limit' => 1]); -$bulk->update( - ['_id' => 3], - ['$set' => ['x' => 3]], - ['limit' => 1, 'upsert' => true] -); - -$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017'); -$writeConcern = new MongoDB\Driver\WriteConcern(1); - -try { - $result = $manager->executeBulkWrite('db.collection', $bulk, ['writeConcern' => $writeConcern]); -} catch (MongoDB\Driver\Exception\BulkWriteException $e) { - $result = $e->getWriteResult(); - - // Comprobar si la preocupación de escritura no pudo ser cumplida - if ($writeConcernError = $result->getWriteConcernError()) { - printf("%s (%d): %s\n", - $writeConcernError->getMessage(), - $writeConcernError->getCode(), - var_export($writeConcernError->getInfo(), true) - ); - } - - // Comprobar si alguna operación de escritura no se completó en absoluto - foreach ($result->getWriteErrors() as $writeError) { - printf("Operación#%d: %s (%d)\n", - $writeError->getIndex(), - $writeError->getMessage(), - $writeError->getCode() - ); - } -} catch (MongoDB\Driver\Exception\Exception $e) { - printf("Otro error: %s\n", $e->getMessage()); - exit; -} - -printf("Insertados %d documento(s)\n", $result->getInsertedCount()); -printf("Actualizados %d documento(s)\n", $result->getModifiedCount()); -printf("Incluidos %d documento(s)\n", $result->getUpsertedCount()); -printf("Eliminados %d documento(s)\n", $result->getDeletedCount()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeBulkWrite - MongoDB\Driver\WriteResult - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/bulkwrite/count.xml b/reference/mongodb/mongodb/driver/bulkwrite/count.xml deleted file mode 100644 index 00ecf82e1c..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwrite/count.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - MongoDB\Driver\BulkWrite::count - Cuenta el número de operaciones de escritura en la operación masiva - - - - &reftitle.description; - - public intMongoDB\Driver\BulkWrite::count - - - - Devuelve el número de operaciones de escritura añadidas al objeto - MongoDB\Driver\BulkWrite. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el número de operaciones de escritura añadidas al objeto - MongoDB\Driver\BulkWrite. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.2.0 - - Devuelve el número de operaciones de escritura añadidas al objeto - MongoDB\Driver\BulkWrite. Las versiones anteriores - devolvían el número esperado de viajes de ida y vuelta del cliente al servidor - necesarios para ejecutar todas las operaciones de escritura. - - - - - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\BulkWrite::count</function> - -insert(['_id' => 1, 'x' => 1]); -$bulk->insert(['_id' => 2, 'x' => 2]); -$bulk->update(['x' => 2], ['$set' => ['x' => 1]]); -$bulk->delete(['x' => 1]); - -var_dump(count($bulk)); - -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwrite/delete.xml b/reference/mongodb/mongodb/driver/bulkwrite/delete.xml deleted file mode 100644 index c1a5fccbbd..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwrite/delete.xml +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - MongoDB\Driver\BulkWrite::delete - Añade una operación de eliminación al lote masivo - - - - &reftitle.description; - - public voidMongoDB\Driver\BulkWrite::delete - arrayobjectfilter - arraynulldeleteOptions&null; - - - Añade una operación de eliminación al - MongoDB\Driver\BulkWrite. - - - - - - &reftitle.parameters; - - &mongodb.parameter.filter; - - deleteOptions - - - - deleteOptions - - - - Opción - Tipo - Descripción - Valor por omisión - - - - &mongodb.option.collation; - - hint - stringarrayobject - - - Especificación del índice. Especifique ya sea el nombre del índice como un string o - el patrón de clave del índice. Si se especifica, entonces el sistema de consultas solo - considerará planes que utilicen el índice indicado. - - - Esta opción está disponible en MongoDB 4.4+ y generará una - excepción en tiempo de ejecución si se especifica para una versión anterior del servidor. - - - - - limit - bool - Eliminar todos los documentos coincidentes (&false;), o solo el primer documento coincidente (&true;) - &false; - - - -
    -
    -
    -
    -
    -
    - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.8.0 - - Se añadió la opción "hint". - - - - PECL mongodb 1.2.0 - - Se añadió la opción "collation". - - - - - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\BulkWrite::delete</function> - -delete(['x' => 1], ['limit' => 1]); -$bulk->delete(['x' => 2], ['limit' => 0]); - -$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017'); -$result = $manager->executeBulkWrite('db.collection', $bulk); - -?> -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeBulkWrite - MongoDB\Driver\WriteResult - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/bulkwrite/insert.xml b/reference/mongodb/mongodb/driver/bulkwrite/insert.xml deleted file mode 100644 index b302c8560f..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwrite/insert.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - - MongoDB\Driver\BulkWrite::insert - Añade una operación de inserción al lote masivo - - - - &reftitle.description; - - public mixedMongoDB\Driver\BulkWrite::insert - arrayobjectdocumento - - - Añade una operación de inserción a la - MongoDB\Driver\BulkWrite. - - - - - - &reftitle.parameters; - - - documento (arrayobject) - - - Un documento a insertar. - - - - - - - - &reftitle.returnvalues; - - Devuelve el _id del documento insertado. Si el - documento no tenía un _id, se devolverá el - MongoDB\BSON\ObjectId generado para la inserción. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.3.0 - - Siempre se devuelve el _id del documento insertado. - Anteriormente, el método solo devolvía un valor si se generaba un - MongoDB\BSON\ObjectId. - - - - - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\BulkWrite::insert</function> - - 1]; -$doc2 = ['_id' => 'id-personalizado', 'x' => 2]; -$doc3 = ['_id' => new MongoDB\BSON\ObjectId('0123456789abcdef01234567'), 'x' => 3]; - -$id1 = $bulk->insert($doc1); -$id2 = $bulk->insert($doc2); -$id3 = $bulk->insert($doc3); - -var_dump($id1, $id2, $id3); - -$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017'); -$result = $manager->executeBulkWrite('db.collection', $bulk); - -?> -]]> - - &example.outputs.similar; - - - string(24) "67f58058d1a0aa2fd80d55d0" -} -string(18) "id-personalizado" -object(MongoDB\BSON\ObjectId)#4 (1) { - ["oid"]=> - string(24) "0123456789abcdef01234567" -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeBulkWrite - MongoDB\Driver\WriteResult - MongoDB\BSON\ObjectId - MongoDB\BSON\Persistable - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwrite/update.xml b/reference/mongodb/mongodb/driver/bulkwrite/update.xml deleted file mode 100644 index 2566de1c21..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwrite/update.xml +++ /dev/null @@ -1,266 +0,0 @@ - - - - - - MongoDB\Driver\BulkWrite::update - Añade una operación de actualización al lote - - - - &reftitle.description; - - public voidMongoDB\Driver\BulkWrite::update - arrayobjectfilter - arrayobjectnewObj - arraynullupdateOptions&null; - - - Añade una operación de actualización al - MongoDB\Driver\BulkWrite. - - - - - - &reftitle.parameters; - - &mongodb.parameter.filter; - - newObj (arrayobject) - - - Un documento que contiene operadores de actualización (por ejemplo, - $set), un documento de reemplazo (es decir, - únicamente expresiones campo:valor), o - una tubería de agregación. - - - - - updateOptions - - - - updateOptions - - - - Opción - Tipo - Descripción - Valor por omisión - - - - - arrayFilters - array - - - Un array de documentos de filtro que determina qué elementos de array - modificar para una operación de actualización en un campo de array. Consulte - Especificar arrayFilters para operaciones de actualización de arrays - en el manual de MongoDB para más información. - - - Esta opción está disponible en MongoDB 3.6+ y generará una - excepción en tiempo de ejecución si se especifica para una versión - anterior del servidor. - - - - &mongodb.option.collation; - - hint - stringarrayobject - - - Especificación de índice. Especifique ya sea el nombre del índice como - string o el patrón de clave de índice. Si se especifica, entonces el - sistema de consultas solo considerará planes que usen el índice - indicado. - - - Esta opción está disponible en MongoDB 4.2+ y generará una - excepción en tiempo de ejecución si se especifica para una versión - anterior del servidor. - - - - - multi - bool - - Actualizar solo el primer documento coincidente si &false;, o todos - los documentos coincidentes &true;. Esta opción no puede ser &true; si - newObj es un documento de reemplazo. - - &false; - - - sort - arrayobject - - - Especifica qué documento actualizará la operación si la consulta - coincide con múltiples documentos. Se actualizará el primer documento - coincidente según el orden de clasificación. - - - Esta opción no puede usarse si "multi" es &true;. - - - Esta opción está disponible en MongoDB 8.0+ y generará una - excepción en tiempo de ejecución si se especifica para una versión - anterior del servidor. - - - - - upsert - bool - - Si filter no coincide con un documento existente, - inserta un único documento. El documento se - creará a partir de newObj si es un documento de - reemplazo (es decir, sin operadores de actualización); de lo contrario, - los operadores en newObj se aplicarán a - filter para crear el nuevo documento. - - &false; - - - -
    -
    -
    -
    -
    -
    - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.21.0 - - Se añadió la opción "sort". - - - - PECL mongodb 1.7.0 - - Se añadió la opción "hint". - - - - PECL mongodb 1.6.0 - - El parámetro newObj ahora acepta una tubería de - agregación. Esta característica requiere MongoDB 4.2+ y generará una - excepción en tiempo de ejecución si se especifica para una versión - anterior del servidor. - - - - PECL mongodb 1.5.0 - - Usar la opción "arrayFilters" generará una excepción - en tiempo de ejecución si el servidor no la soporta. Anteriormente, no - se generaba ninguna excepción y la opción podía ignorarse. - - - - PECL mongodb 1.4.0 - - Se añadió la opción "arrayFilters". - - - - PECL mongodb 1.2.0 - - Se añadió la opción "collation". - - - - - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\BulkWrite::update</function> - -update( - ['x' => 2], - ['$set' => ['y' => 3]], - ['multi' => false, 'upsert' => false] -); - -$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017'); -$result = $manager->executeBulkWrite('db.collection', $bulk); - -?> -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeBulkWrite - MongoDB\Driver\WriteResult - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommand.xml b/reference/mongodb/mongodb/driver/bulkwritecommand.xml deleted file mode 100644 index a71343b3ed..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommand.xml +++ /dev/null @@ -1,200 +0,0 @@ - - - - - - La clase MongoDB\Driver\BulkWriteCommand - MongoDB\Driver\BulkWriteCommand - - - - -
    - &reftitle.intro; - - La clase MongoDB\Driver\BulkWriteCommand recopila una o más - operaciones de escritura que deben enviarse al servidor usando el - comando bulkWrite - introducido en MongoDB 8.0. Tras añadir cualquier número de operaciones de inserción, - actualización y eliminación, el comando puede ejecutarse mediante - MongoDB\Driver\Manager::executeBulkWriteCommand. - - - A diferencia de MongoDB\Driver\BulkWrite, donde todas las operaciones de escritura - deben dirigirse a la misma colección, cada operación de escritura dentro de - MongoDB\Driver\BulkWriteCommand puede dirigirse a una - colección diferente. - - - Las operaciones de escritura pueden ser ordenadas (por omisión) o no ordenadas. Las operaciones de escritura ordenadas se envían al servidor, en el orden proporcionado, para su - ejecución serial. Si una escritura falla, las operaciones restantes se abortarán. - Las operaciones no ordenadas se envían al servidor en un orden arbitrario - donde pueden ejecutarse en paralelo. Cualquier error que ocurra se reporta - después de que se hayan intentado todas las operaciones. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\BulkWriteCommand - - - - final - - MongoDB\Driver\BulkWriteCommand - - - - Countable - - - - - &Methods; - - - - -
    - -
    - &reftitle.examples; - - - Operaciones de escritura mixtas - - Las operaciones de escritura mixtas (es decir, inserciones, actualizaciones y eliminaciones) se enviarán - al servidor usando un único - comando bulkWrite. - - -deleteMany('db.coll_one', []); -$bulk->deleteMany('db.coll_two', []); - -// Insertar documentos en dos colecciones -$bulk->insertOne('db.coll_one', ['_id' => 1]); -$bulk->insertOne('db.coll_two', ['_id' => 2]); -$bulk->insertOne('db.coll_two', ['_id' => 3]); - -// Actualizar un documento en "coll_one" -$bulk->updateOne('db.coll_one', ['_id' => 1], ['$set' => ['x' => 1]]); - -$result = $manager->executeBulkWriteCommand($bulk); - -printf("Insertados %d documento(s)\n", $result->getInsertedCount()); -printf("Actualizados %d documento(s)\n", $result->getModifiedCount()); - -?> -]]> - - &example.outputs; - - - - - - Operaciones de escritura ordenadas que causan un error - -deleteMany('db.coll', []); -$bulk->insertOne('db.coll', ['_id' => 1]); -$bulk->insertOne('db.coll', ['_id' => 2]); -$bulk->insertOne('db.coll', ['_id' => 1]); -$bulk->insertOne('db.coll', ['_id' => 3]); - -try { - $result = $manager->executeBulkWriteCommand($bulk); -} catch (MongoDB\Driver\Exception\BulkWriteCommandException $e) { - $result = $e->getPartialResult(); - - var_dump($e->getWriteErrors()); -} - -printf("Insertados %d documento(s)\n", $result->getInsertedCount()); - -?> -]]> - - &example.outputs.similar; - - - object(MongoDB\Driver\WriteError)#5 (4) { - ["message"]=> - string(78) "E11000 duplicate key error collection: db.coll index: _id_ dup key: { _id: 1 }" - ["code"]=> - int(11000) - ["index"]=> - int(3) - ["info"]=> - object(stdClass)#6 (0) { - } - } -} -Insertados 2 documento(s) -]]> - - -
    - -
    - &reftitle.seealso; - - MongoDB\Driver\Manager::executeBulkWriteCommand - MongoDB\Driver\BulkWriteCommandResult - MongoDB\Driver\Exception\BulkWriteCommandException - MongoDB\Driver\WriteConcern - MongoDB\Driver\WriteConcernError - MongoDB\Driver\WriteError - -
    - -
    - - &reference.mongodb.mongodb.driver.entities.bulkwritecommand; - -
    - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommand/construct.xml b/reference/mongodb/mongodb/driver/bulkwritecommand/construct.xml deleted file mode 100644 index 498c1c6a8e..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommand/construct.xml +++ /dev/null @@ -1,185 +0,0 @@ - - - - - - MongoDB\Driver\BulkWriteCommand::__construct - Crea un nuevo BulkWriteCommand - - - - &reftitle.description; - - public MongoDB\Driver\BulkWriteCommand::__construct - arraynulloptions&null; - - - Construye un nuevo MongoDB\Driver\BulkWriteCommand, - que puede usarse para realizar muchas operaciones de inserción, actualización y - eliminación en múltiples colecciones en una sola petición usando el - comando bulkWrite - introducido en MongoDB 8.0. Esto difiere de - MongoDB\Driver\BulkWrite, que es compatible con todas - las versiones del servidor pero limitado a una sola colección. - - - Después de añadir todas las operaciones de escritura, este objeto puede - ejecutarse con MongoDB\Driver\Manager::executeBulkWriteCommand. - - - - - &reftitle.parameters; - - - options (array) - - - - options - - - - Opción - Tipo - Descripción - Valor por omisión - - - - - bypassDocumentValidation - bool - - - Si es &true;, permite que las operaciones de inserción y actualización - eviten la validación a nivel de documento. - - - &false; - - - comment - mixed - - - Un comentario arbitrario para ayudar a rastrear la operación a través - del perfilador de la base de datos, la salida de currentOp y los - registros. - - - - &mongodb.option.let; - - ordered - bool - - - Si las operaciones en esta escritura masiva deben ejecutarse en el - orden en que fueron especificadas. Si es &false;, las escrituras - continuarán ejecutándose si una escritura individual falla. Si es - &true;, las escrituras se detendrán si una escritura individual falla. - - - &true; - - - verboseResults - bool - - - Si los resultados detallados de cada operación exitosa deben incluirse - en el MongoDB\Driver\BulkWriteCommandResult - devuelto. - - - &false; - - - -
    -
    -
    -
    -
    -
    - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\BulkWriteCommand::__construct</function> - -deleteMany('db.coll_one', []); -$bulk->deleteMany('db.coll_two', []); - -// Insertar documentos en dos colecciones -$bulk->insertOne('db.coll_one', ['_id' => 1]); -$bulk->insertOne('db.coll_two', ['_id' => 2]); -$bulk->insertOne('db.coll_two', ['_id' => 3]); - -// Actualizar un documento en "coll_one" -$bulk->updateOne('db.coll_one', ['_id' => 1], ['$set' => ['x' => 1]]); - -$result = $manager->executeBulkWriteCommand($bulk); - -printf("Insertados %d documento(s)\n", $result->getInsertedCount()); -printf("Actualizados %d documento(s)\n", $result->getModifiedCount()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeBulkWriteCommand - MongoDB\Driver\BulkWriteCommandResult - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommand/count.xml b/reference/mongodb/mongodb/driver/bulkwritecommand/count.xml deleted file mode 100644 index 8c6895842a..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommand/count.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - MongoDB\Driver\BulkWriteCommand::count - Cuenta el número de operaciones de escritura en el BulkWriteCommand - - - - &reftitle.description; - - public intMongoDB\Driver\BulkWriteCommand::count - - - - Devuelve el número de operaciones de escritura añadidas al objeto - MongoDB\Driver\BulkWriteCommand. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el número de operaciones de escritura añadidas al objeto - MongoDB\Driver\BulkWriteCommand. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\BulkWriteCommand::count</function> - -insertOne('db.coll', ['_id' => 1, 'x' => 1]); -$bulk->insertOne('db.coll', ['_id' => 2, 'x' => 2]); -$bulk->updateOne('db.coll', ['x' => 2], ['$set' => ['x' => 1]]); -$bulk->deleteMany('db.coll', ['x' => 1]); - -var_dump(count($bulk)); - -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommand/deletemany.xml b/reference/mongodb/mongodb/driver/bulkwritecommand/deletemany.xml deleted file mode 100644 index 8d9ffd7d5e..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommand/deletemany.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - MongoDB\Driver\BulkWriteCommand::deleteMany - Añade una operación deleteMany - - - - &reftitle.description; - - public voidMongoDB\Driver\BulkWriteCommand::deleteMany - stringnamespace - arrayobjectfilter - arraynulloptions&null; - - - Añade una operación deleteMany a la - MongoDB\Driver\BulkWriteCommand. Todos los documentos - que coincidan con filter en la colección identificada por - namespace serán eliminados. - - - - - &reftitle.parameters; - - &mongodb.parameter.namespace; - &mongodb.parameter.filter; - - options - - - - options - - - - Opción - Tipo - Descripción - Valor por omisión - - - - &mongodb.option.collation; - - hint - stringarrayobject - - - Especificación de índice. Especifique ya sea el nombre del índice como - string o el patrón de clave de índice. Si se especifica, entonces el - sistema de consultas solo considerará planes que usen el índice indicado. - - - - - -
    -
    -
    -
    -
    -
    - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\BulkWriteCommand::deleteMany</function> - -deleteMany('db.coll', ['x' => ['$gt' => 1]]); - -$result = $manager->executeBulkWriteCommand($bulk); - -?> -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommand::deleteOne - MongoDB\Driver\Manager::executeBulkWriteCommand - MongoDB\Driver\BulkWriteCommandResult - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommand/deleteone.xml b/reference/mongodb/mongodb/driver/bulkwritecommand/deleteone.xml deleted file mode 100644 index 66fb889287..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommand/deleteone.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - MongoDB\Driver\BulkWriteCommand::deleteOne - Añade una operación deleteOne - - - - &reftitle.description; - - public voidMongoDB\Driver\BulkWriteCommand::deleteOne - stringnamespace - arrayobjectfilter - arraynulloptions&null; - - - Añade una operación deleteOne a la - MongoDB\Driver\BulkWriteCommand. El primer documento - que coincida con filter en la colección identificada por - namespace será eliminado. - - - - - &reftitle.parameters; - - &mongodb.parameter.namespace; - &mongodb.parameter.filter; - - options - - - - options - - - - Opción - Tipo - Descripción - Valor por omisión - - - - &mongodb.option.collation; - - hint - stringarrayobject - - - Especificación de índice. Especifique ya sea el nombre del índice como - string o el patrón de clave del índice. Si se especifica, entonces el - sistema de consultas solo considerará planes que usen el índice - indicado. - - - - - -
    -
    -
    -
    -
    -
    - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\BulkWriteCommand::deleteOne</function> - -deleteOne('db.coll', ['x' => 1]); - -$result = $manager->executeBulkWriteCommand($bulk); - -?> -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommand::deleteMany - MongoDB\Driver\Manager::executeBulkWriteCommand - MongoDB\Driver\BulkWriteCommandResult - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommand/insertone.xml b/reference/mongodb/mongodb/driver/bulkwritecommand/insertone.xml deleted file mode 100644 index 6d907200f7..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommand/insertone.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - MongoDB\Driver\BulkWriteCommand::insertOne - Añade una operación insertOne - - - - &reftitle.description; - - public mixedMongoDB\Driver\BulkWriteCommand::insertOne - stringnamespace - arrayobjectdocument - - - Añade una operación insertOne al - MongoDB\Driver\BulkWriteCommand. El documento se - insertará en la colección identificada por - namespace. - - - - - &reftitle.parameters; - - &mongodb.parameter.namespace; - - document (arrayobject) - - - Un documento a insertar. - - - - - - - - &reftitle.returnvalues; - - Devuelve el _id del documento insertado. Si el - document no tenía un _id, se - devolverá el MongoDB\BSON\ObjectId generado para la - inserción. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\BulkWriteCommand::insertOne</function> - - 1]; -$doc2 = ['_id' => 'custom-id', 'x' => 2]; -$doc3 = ['_id' => new MongoDB\BSON\ObjectId('0123456789abcdef01234567'), 'x' => 3]; - -$id1 = $bulk->insertOne('db.coll', $doc1); -$id2 = $bulk->insertOne('db.coll', $doc2); -$id3 = $bulk->insertOne('db.coll', $doc3); - -var_dump($id1, $id2, $id3); - -$result = $manager->executeBulkWriteCommand($bulk); - -?> -]]> - - &example.outputs.similar; - - - string(24) "67f58058d1a0aa2fd80d55d0" -} -string(9) "custom-id" -object(MongoDB\BSON\ObjectId)#4 (1) { - ["oid"]=> - string(24) "0123456789abcdef01234567" -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeBulkWriteCommand - MongoDB\Driver\BulkWriteCommandResult - MongoDB\BSON\ObjectId - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommand/replaceone.xml b/reference/mongodb/mongodb/driver/bulkwritecommand/replaceone.xml deleted file mode 100644 index 6aa34b9558..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommand/replaceone.xml +++ /dev/null @@ -1,166 +0,0 @@ - - - - - - MongoDB\Driver\BulkWriteCommand::replaceOne - Añade una operación replaceOne - - - - &reftitle.description; - - public voidMongoDB\Driver\BulkWriteCommand::replaceOne - stringnamespace - arrayobjectfilter - arrayobjectreplacement - arraynulloptions&null; - - - Añade una operación replaceOne al - MongoDB\Driver\BulkWriteCommand. El primer documento - que coincida con filter en la colección identificada por - namespace será reemplazado. - - - - - - &reftitle.parameters; - - &mongodb.parameter.namespace; - &mongodb.parameter.filter; - - replacement (arrayobject) - - - Un documento de reemplazo. - - - - - options - - - - options - - - - Opción - Tipo - Descripción - Valor por omisión - - - - &mongodb.option.collation; - - hint - stringarrayobject - - - Especificación de índice. Especifique ya sea el nombre del índice como - string o el patrón de clave del índice. Si se especifica, entonces el - sistema de consultas solo considerará planes que usen el índice - indicado. - - - - - sort - arrayobject - - - Especifique qué documento reemplaza la operación si la consulta - coincide con múltiples documentos. El primer documento coincidente - según el orden de clasificación será reemplazado. - - - - - upsert - bool - - Si filter no coincide con un documento existente, - inserta un único documento. El documento será - creado a partir de replacement. - - &false; - - - -
    -
    -
    -
    -
    -
    - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\BulkWriteCommand::replaceOne</function> - -replaceOne('db.coll', ['x' => 1], ['x' => 1, 'y' => 2]); - -$result = $manager->executeBulkWriteCommand($bulk); - -?> -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommand::updateOne - MongoDB\Driver\BulkWriteCommand::updateMany - MongoDB\Driver\Manager::executeBulkWriteCommand - MongoDB\Driver\BulkWriteCommandResult - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommand/updatemany.xml b/reference/mongodb/mongodb/driver/bulkwritecommand/updatemany.xml deleted file mode 100644 index 62c57fa22d..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommand/updatemany.xml +++ /dev/null @@ -1,171 +0,0 @@ - - - - - - MongoDB\Driver\BulkWriteCommand::updateMany - Añade una operación updateMany - - - - &reftitle.description; - - public voidMongoDB\Driver\BulkWriteCommand::updateMany - stringnamespace - arrayobjectfilter - arrayobjectupdate - arraynulloptions&null; - - - Añade una operación updateMany a la - MongoDB\Driver\BulkWriteCommand. Todos los documentos - que coincidan con filter en la colección identificada por - namespace serán actualizados. - - - - - - &reftitle.parameters; - - &mongodb.parameter.namespace; - &mongodb.parameter.filter; - - update (arrayobject) - - - Un documento que contiene ya sea operadores de actualización (por ejemplo - $set) o un - pipeline de agregación. - - - - - options - - - - options - - - - Opción - Tipo - Descripción - Valor por omisión - - - - - arrayFilters - array - - - Un array de documentos de filtro que determina qué elementos de array - modificar para una operación de actualización en un campo de array. - Consulte - Especificar arrayFilters para operaciones de actualización de arrays - en el manual de MongoDB para más información. - - - - &mongodb.option.collation; - - hint - stringarrayobject - - - Especificación de índice. Especifique ya sea el nombre del índice como - string o el patrón de clave de índice. Si se especifica, entonces el - sistema de consultas solo considerará planes que usen el índice - indicado. - - - - - upsert - bool - - Si filter no coincide con un documento existente, - inserta un único documento. El documento se - creará aplicando los operadores en update a - cualquier valor de campo en filter. - - &false; - - - -
    -
    -
    -
    -
    -
    - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\BulkWriteCommand::updateMany</function> - -updateMany('db.coll', ['x' => ['$gt' => 1]], ['$set' => ['y' => 2]]); - -$result = $manager->executeBulkWriteCommand($bulk); - -?> -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommand::replaceOne - MongoDB\Driver\BulkWriteCommand::updateMany - MongoDB\Driver\Manager::executeBulkWriteCommand - MongoDB\Driver\BulkWriteCommandResult - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommand/updateone.xml b/reference/mongodb/mongodb/driver/bulkwritecommand/updateone.xml deleted file mode 100644 index 3ce5964d94..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommand/updateone.xml +++ /dev/null @@ -1,182 +0,0 @@ - - - - - - MongoDB\Driver\BulkWriteCommand::updateOne - Añadir una operación updateOne - - - - &reftitle.description; - - public voidMongoDB\Driver\BulkWriteCommand::updateOne - stringnamespace - arrayobjectfilter - arrayobjectupdate - arraynulloptions&null; - - - Añade una operación updateOne al - MongoDB\Driver\BulkWriteCommand. El primer documento - que coincida con filter en la colección identificada por - namespace será actualizado. - - - - - - &reftitle.parameters; - - &mongodb.parameter.namespace; - &mongodb.parameter.filter; - - update (arrayobject) - - - Un documento que contiene ya sea operadores de actualización (por ejemplo - $set) o un - pipeline de agregación. - - - - - options - - - - options - - - - Opción - Tipo - Descripción - Valor por omisión - - - - - arrayFilters - array - - - Un array de documentos de filtro que determina qué elementos de array - modificar para una operación de actualización en un campo de array. - Consulte - Especificar arrayFilters para operaciones de actualización de arrays - en el manual de MongoDB para más información. - - - - &mongodb.option.collation; - - hint - stringarrayobject - - - Especificación de índice. Especifique ya sea el nombre del índice como - string o el patrón de clave de índice. Si se especifica, entonces el - sistema de consultas solo considerará planes que usen el índice - indicado. - - - - - sort - arrayobject - - - Especifica qué documento actualizará la operación si la consulta - coincide con múltiples documentos. El primer documento coincidente - según el orden de ordenación será actualizado. - - - - - upsert - bool - - Si filter no coincide con un documento existente, - inserta un único documento. El documento será - creado aplicando operadores en update a cualquier - valor de campo en filter. - - &false; - - - -
    -
    -
    -
    -
    -
    - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\BulkWriteCommand::updateOne</function> - -updateOne('db.coll', ['x' => 1], ['$set' => ['y' => 2]]); - -$result = $manager->executeBulkWriteCommand($bulk); - -?> -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommand::replaceOne - MongoDB\Driver\BulkWriteCommand::updateMany - MongoDB\Driver\Manager::executeBulkWriteCommand - MongoDB\Driver\BulkWriteCommandResult - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommandresult.xml b/reference/mongodb/mongodb/driver/bulkwritecommandresult.xml deleted file mode 100644 index 4468d60baf..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommandresult.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - La clase MongoDB\Driver\BulkWriteCommandResult - MongoDB\Driver\BulkWriteCommandResult - - - - -
    - &reftitle.intro; - - La clase MongoDB\Driver\BulkWriteCommandResult - encapsula información sobre un - MongoDB\Driver\BulkWriteCommand ejecutado y es - devuelta por - MongoDB\Driver\Manager::executeBulkWriteCommand. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\BulkWriteCommandResult - - - - final - - MongoDB\Driver\BulkWriteCommandResult - - - - - &Methods; - - - - -
    - -
    - - &reference.mongodb.mongodb.driver.entities.bulkwritecommandresult; - -
    - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getdeletedcount.xml b/reference/mongodb/mongodb/driver/bulkwritecommandresult/getdeletedcount.xml deleted file mode 100644 index 6993a9d128..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getdeletedcount.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - MongoDB\Driver\BulkWriteCommandResult::getDeletedCount - Devuelve el número de documentos eliminados - - - - &reftitle.description; - - final public intMongoDB\Driver\BulkWriteCommandResult::getDeletedCount - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el número total de documentos eliminados por todas las operaciones. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - &mongodb.throws.unacknowledged; - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\BulkWriteCommandResult::getDeletedCount</function> - -insertOne('db.coll', ['x' => 1]); -$bulk->updateOne('db.coll', ['x' => 1], ['$set' => ['y' => 3]]); -$bulk->updateOne('db.coll', ['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->updateOne('db.coll', ['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->deleteMany('db.coll', []); - -$result = $manager->executeBulkWriteCommand($bulk); - -var_dump($result->getDeletedCount()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommandResult::getDeleteResults - MongoDB\Driver\BulkWriteCommandResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getdeleteresults.xml b/reference/mongodb/mongodb/driver/bulkwritecommandresult/getdeleteresults.xml deleted file mode 100644 index 7cfb3f18d5..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getdeleteresults.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - MongoDB\Driver\BulkWriteCommandResult::getDeleteResults - Devuelve resultados detallados para eliminaciones exitosas - - - - &reftitle.description; - - final public MongoDB\BSON\DocumentnullMongoDB\Driver\BulkWriteCommandResult::getDeleteResults - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un documento que contiene el resultado de cada operación de - eliminación exitosa, o &null; si no se solicitaron resultados detallados. Las - claves del documento corresponderán al índice de la operación de escritura - desde MongoDB\Driver\BulkWriteCommand. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - &mongodb.throws.unacknowledged; - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\BulkWriteCommandResult::getDeleteResults</function> - - true]); -$bulk->insertOne('db.coll', ['x' => 1]); -$bulk->updateOne('db.coll', ['x' => 1], ['$set' => ['y' => 3]]); -$bulk->updateOne('db.coll', ['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->updateOne('db.coll', ['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->deleteMany('db.coll', []); - -$result = $manager->executeBulkWriteCommand($bulk); - -var_dump($result->getDeleteResults()->toPHP()); - -?> -]]> - - &example.outputs.similar; - - - object(stdClass)#6 (1) { - ["deletedCount"]=> - object(MongoDB\BSON\Int64)#5 (1) { - ["integer"]=> - string(1) "3" - } - } -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommandResult::getDeletedCount - MongoDB\Driver\BulkWriteCommandResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getinsertedcount.xml b/reference/mongodb/mongodb/driver/bulkwritecommandresult/getinsertedcount.xml deleted file mode 100644 index 47e71f0e78..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getinsertedcount.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - MongoDB\Driver\BulkWriteCommandResult::getInsertedCount - Devuelve el número de documentos insertados - - - - &reftitle.description; - - final public intMongoDB\Driver\BulkWriteCommandResult::getInsertedCount - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el número total de documentos insertados (excluyendo los upserts) por - todas las operaciones. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - &mongodb.throws.unacknowledged; - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\BulkWriteCommandResult::getInsertedCount</function> - -insertOne('db.coll', ['x' => 1]); -$bulk->updateOne('db.coll', ['x' => 1], ['$set' => ['y' => 3]]); -$bulk->updateOne('db.coll', ['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->updateOne('db.coll', ['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->deleteMany('db.coll', []); - -$result = $manager->executeBulkWriteCommand($bulk); - -var_dump($result->getInsertedCount()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommandResult::getInsertResults - MongoDB\Driver\BulkWriteCommandResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getinsertresults.xml b/reference/mongodb/mongodb/driver/bulkwritecommandresult/getinsertresults.xml deleted file mode 100644 index b3ccf6073c..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getinsertresults.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - MongoDB\Driver\BulkWriteCommandResult::getInsertResults - Devuelve resultados detallados para las inserciones exitosas - - - - &reftitle.description; - - final public MongoDB\BSON\DocumentnullMongoDB\Driver\BulkWriteCommandResult::getInsertResults - - - - Dado que los campos _id para los documentos insertados son - generados por la extensión cuando no se proporcionan explícitamente, el valor de - insertedId en cada resultado coincidirá con el valor de retorno de - MongoDB\Driver\BulkWriteCommand::insertOne para - la operación de inserción correspondiente. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un documento que contiene el resultado de cada operación de inserción - exitosa, o &null; si no se solicitaron resultados detallados. Las claves del - documento corresponderán al índice de la operación de escritura de - MongoDB\Driver\BulkWriteCommand. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - &mongodb.throws.unacknowledged; - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\BulkWriteCommandResult::getInsertResults</function> - - true]); - -$generatedId = $bulk->insertOne('db.coll', ['x' => 1]); - -$bulk->updateOne('db.coll', ['x' => 1], ['$set' => ['y' => 3]]); -$bulk->updateOne('db.coll', ['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->updateOne('db.coll', ['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->deleteMany('db.coll', []); - -$result = $manager->executeBulkWriteCommand($bulk); - -var_dump($generatedId); - -var_dump($result->getInsertResults()->toPHP()); - -?> -]]> - - &example.outputs.similar; - - - string(24) "67f7ee69783dcce702097b41" -} -object(stdClass)#8 (1) { - ["0"]=> - object(stdClass)#7 (1) { - ["insertedId"]=> - object(MongoDB\BSON\ObjectId)#6 (1) { - ["oid"]=> - string(24) "67f7ee69783dcce702097b41" - } - } -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommandResult::getInsertedCount - MongoDB\Driver\BulkWriteCommandResult::isAcknowledged - MongoDB\Driver\BulkWriteCommand::insertOne - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getmatchedcount.xml b/reference/mongodb/mongodb/driver/bulkwritecommandresult/getmatchedcount.xml deleted file mode 100644 index f83c7060f0..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getmatchedcount.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - MongoDB\Driver\BulkWriteCommandResult::getMatchedCount - Devuelve el número de documentos seleccionados para actualización - - - - &reftitle.description; - - final public intMongoDB\Driver\BulkWriteCommandResult::getMatchedCount - - - - Si la operación de actualización no produce cambios en el documento (por ejemplo, - establecer el valor de un campo a su valor actual), el conteo de coincidencias puede ser - mayor que el valor devuelto por - MongoDB\Driver\BulkWriteCommandResult::getModifiedCount. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el número total de documentos seleccionados para actualización por todas las operaciones. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - &mongodb.throws.unacknowledged; - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\BulkWriteCommandResult::getMatchedCount</function> - -insertOne('db.coll', ['x' => 1]); -$bulk->updateOne('db.coll', ['x' => 1], ['$set' => ['y' => 3]]); -$bulk->updateOne('db.coll', ['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->updateOne('db.coll', ['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->deleteMany('db.coll', []); - -$result = $manager->executeBulkWriteCommand($bulk); - -var_dump($result->getMatchedCount()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommandResult::getModifiedCount - MongoDB\Driver\BulkWriteCommandResult::getUpdateResults - MongoDB\Driver\BulkWriteCommandResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getmodifiedcount.xml b/reference/mongodb/mongodb/driver/bulkwritecommandresult/getmodifiedcount.xml deleted file mode 100644 index 3c012dba0f..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getmodifiedcount.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - MongoDB\Driver\BulkWriteCommandResult::getModifiedCount - Devuelve el número de documentos existentes que se actualizaron - - - - &reftitle.description; - - final public intMongoDB\Driver\BulkWriteCommandResult::getModifiedCount - - - - Si la operación de actualización no produce cambios en el documento (por ejemplo, - establecer el valor de un campo a su valor actual), el recuento de documentos - modificados puede ser menor que el valor devuelto por - MongoDB\Driver\BulkWriteCommandResult::getMatchedCount. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el número total de documentos existentes que fueron actualizados por - todas las operaciones. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - &mongodb.throws.unacknowledged; - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\BulkWriteCommandResult::getModifiedCount</function> - -insertOne('db.coll', ['x' => 1]); -$bulk->updateOne('db.coll', ['x' => 1], ['$set' => ['y' => 3]]); -$bulk->updateOne('db.coll', ['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->updateOne('db.coll', ['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->deleteMany('db.coll', []); - -$result = $manager->executeBulkWriteCommand($bulk); - -var_dump($result->getModifiedCount()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommandResult::getMatchedCount - MongoDB\Driver\BulkWriteCommandResult::getUpdateResults - MongoDB\Driver\BulkWriteCommandResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getupdateresults.xml b/reference/mongodb/mongodb/driver/bulkwritecommandresult/getupdateresults.xml deleted file mode 100644 index b622954fe7..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getupdateresults.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - MongoDB\Driver\BulkWriteCommandResult::getUpdateResults - Devuelve resultados detallados para las actualizaciones exitosas - - - - &reftitle.description; - - final public MongoDB\BSON\DocumentnullMongoDB\Driver\BulkWriteCommandResult::getUpdateResults - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un documento que contiene el resultado de cada operación de actualización - exitosa, o &null; si no se solicitaron resultados detallados. Las claves del documento - corresponderán al índice de la operación de escritura de - MongoDB\Driver\BulkWriteCommand. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - &mongodb.throws.unacknowledged; - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\BulkWriteCommandResult::getUpdateResults</function> - - true]); -$bulk->insertOne('db.coll', ['x' => 1]); -$bulk->updateOne('db.coll', ['x' => 1], ['$set' => ['y' => 3]]); -$bulk->updateOne('db.coll', ['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->updateOne('db.coll', ['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->deleteMany('db.coll', []); - -$result = $manager->executeBulkWriteCommand($bulk); - -var_dump($result->getUpdateResults()->toPHP()); - -?> -]]> - - &example.outputs.similar; - - - object(stdClass)#7 (2) { - ["matchedCount"]=> - object(MongoDB\BSON\Int64)#5 (1) { - ["integer"]=> - string(1) "1" - } - ["modifiedCount"]=> - object(MongoDB\BSON\Int64)#6 (1) { - ["integer"]=> - string(1) "1" - } - } - ["2"]=> - object(stdClass)#11 (3) { - ["matchedCount"]=> - object(MongoDB\BSON\Int64)#8 (1) { - ["integer"]=> - string(1) "1" - } - ["modifiedCount"]=> - object(MongoDB\BSON\Int64)#9 (1) { - ["integer"]=> - string(1) "0" - } - ["upsertedId"]=> - object(MongoDB\BSON\ObjectId)#10 (1) { - ["oid"]=> - string(24) "67f7eb9b1f198bbcb880d575" - } - } - ["3"]=> - object(stdClass)#15 (3) { - ["matchedCount"]=> - object(MongoDB\BSON\Int64)#12 (1) { - ["integer"]=> - string(1) "1" - } - ["modifiedCount"]=> - object(MongoDB\BSON\Int64)#13 (1) { - ["integer"]=> - string(1) "0" - } - ["upsertedId"]=> - object(MongoDB\BSON\Int64)#14 (1) { - ["oid"]=> - string(24) "67f7eb9b1f198bbcb880d576" - } - } -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommandResult::getMatchedCount - MongoDB\Driver\BulkWriteCommandResult::getModifiedCount - MongoDB\Driver\BulkWriteCommandResult::getUpsertedCount - MongoDB\Driver\BulkWriteCommandResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getupsertedcount.xml b/reference/mongodb/mongodb/driver/bulkwritecommandresult/getupsertedcount.xml deleted file mode 100644 index 4c116f1f8e..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommandresult/getupsertedcount.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - MongoDB\Driver\BulkWriteCommandResult::getUpsertedCount - Devuelve el número de documentos insertados o actualizados (upserted) - - - - &reftitle.description; - - final public intMongoDB\Driver\BulkWriteCommandResult::getUpsertedCount - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el número total de documentos insertados o actualizados (upserted) por todas las operaciones. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - &mongodb.throws.unacknowledged; - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\BulkWriteCommandResult::getUpsertedCount</function> - -insertOne('db.coll', ['x' => 1]); -$bulk->updateOne('db.coll', ['x' => 1], ['$set' => ['y' => 3]]); -$bulk->updateOne('db.coll', ['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->updateOne('db.coll', ['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->deleteMany('db.coll', []); - -$result = $manager->executeBulkWriteCommand($bulk); - -var_dump($result->getUpsertedCount()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommandResult::getUpdateResults - MongoDB\Driver\BulkWriteCommandResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/bulkwritecommandresult/isacknowledged.xml b/reference/mongodb/mongodb/driver/bulkwritecommandresult/isacknowledged.xml deleted file mode 100644 index ea12ebf985..0000000000 --- a/reference/mongodb/mongodb/driver/bulkwritecommandresult/isacknowledged.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - MongoDB\Driver\BulkWriteCommandResult::isAcknowledged - Devuelve si la escritura fue reconocida - - - - &reftitle.description; - - final public boolMongoDB\Driver\BulkWriteCommandResult::isAcknowledged - - - - Si la escritura es reconocida, otros campos estarán disponibles en el - objeto MongoDB\Driver\BulkWriteCommandResult. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si la escritura fue reconocida, y &false; en caso contrario. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - <function>MongoDB\Driver\BulkWriteCommandResult::isAcknowledged</function> con preocupación de escritura reconocida - -insertOne('db.coll', ['x' => 1]); - -$result = $manager->executeBulkWriteCommand($bulk); - -var_dump($result->isAcknowledged()); - -?> -]]> - - &example.outputs; - - - - - - <function>MongoDB\Driver\BulkWriteCommandResult::isAcknowledged</function> con preocupación de escritura no reconocida - - false]); -$bulk->insertOne('db.coll', ['x' => 1]); - -$writeConcern = new MongoDB\Driver\WriteConcern(0); - -$result = $manager->executeBulkWriteCommand($bulk, ['writeConcern' => $writeConcern]); - -var_dump($result->isAcknowledged()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteConcern - Referencia de preocupación de escritura - - - - - - diff --git a/reference/mongodb/mongodb/driver/clientencryption.xml b/reference/mongodb/mongodb/driver/clientencryption.xml deleted file mode 100644 index bbdaf026b4..0000000000 --- a/reference/mongodb/mongodb/driver/clientencryption.xml +++ /dev/null @@ -1,254 +0,0 @@ - - - - - - La clase MongoDB\Driver\ClientEncryption - MongoDB\Driver\ClientEncryption - - - - -
    - &reftitle.intro; - - La clase MongoDB\Driver\ClientEncryption gestiona - la creación de claves de datos para la cifrado lado-cliente, así como el - cifrado y descifrado manual de valores. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\ClientEncryption - - - - final - - MongoDB\Driver\ClientEncryption - - - - - - &Constants; - - const - string - MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTIC - AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic - - - const - string - MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_RANDOM - AEAD_AES_256_CBC_HMAC_SHA_512-Random - - - const - string - MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED - Indexed - - - const - string - MongoDB\Driver\ClientEncryption::ALGORITHM_UNINDEXED - Unindexed - - - const - string - MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE - Range - - - const - string - MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITY - equality - - - const - string - MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE - range - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTIC - - Especifica un algoritmo para el cifrado determinista, que es adecuado para consultas. - - - - - MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_RANDOM - - Especifica un algoritmo para el cifrado aleatorio - - - - - MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED - - Especifica un algoritmo para un contenido cifrado indexado, que puede usarse con cifrado consultable. - Para insertar o consultar con un contenido cifrado indexado, el MongoDB\Driver\Manager debe configurarse con la opción de controlador "autoEncryption". La opción de auto-cifrado "bypassQueryAnalysis" puede ser &true;. La opción de auto-cifrado "bypassAutoEncryption" debe ser &false;. - - - - - MongoDB\Driver\ClientEncryption::ALGORITHM_UNINDEXED - - Especifica un algoritmo para un contenido cifrado no indexado. - - - - - MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE - - - Especifica un algoritmo para un contenido cifrado de rango, que puede usarse - con cifrado consultable. - - - Para consultar con un contenido cifrado de rango, el - MongoDB\Driver\Manager debe configurarse con la - opción de controlador "autoEncryption". La opción de - auto-cifrado "bypassQueryAnalysis" puede ser &true;. - La opción de auto-cifrado "bypassAutoEncryption" debe - ser &false;. - - - La extensión aún no admite consultas de rango para tipos de campo BSON Decimal128. - - - - - - MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITY - - - Especifica un tipo de consulta de igualdad, que se usa en conjunto con - MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED. - - - - - - MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE - - - Especifica un tipo de consulta de rango, que se usa en conjunto con - MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE. - - - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.0.0 - - - Se eliminó MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW - y MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE_PREVIEW. - - - - - PECL mongodb 1.20.0 - - - Se añadió MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE - y MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE. - - - Se declaró obsoleto MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW - y MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE_PREVIEW. - - - - - PECL mongodb 1.16.0 - - Se añadió MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW - y MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE_PREVIEW. - - - - PECL mongodb 1.14.0 - - Se añadió MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED, - MongoDB\Driver\ClientEncryption::ALGORITHM_UNINDEXED, - y MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITY. - - - - - -
    - -
    - &reftitle.seealso; - - MongoDB\Driver\Manager::createClientEncryption - -
    - -
    - - &reference.mongodb.mongodb.driver.entities.clientencryption; - -
    - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/addkeyaltname.xml b/reference/mongodb/mongodb/driver/clientencryption/addkeyaltname.xml deleted file mode 100644 index 3565128411..0000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/addkeyaltname.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::addKeyAltName - Añade un nombre alternativo a un documento de clave - - - - &reftitle.description; - - final public objectnullMongoDB\Driver\ClientEncryption::addKeyAltName - MongoDB\BSON\BinarykeyId - stringkeyAltName - - - Añade keyAltName al conjunto de nombres alternativos para el - documento de clave con el UUID dado keyId. - - - - - &reftitle.parameters; - - - keyId - - - Una instancia de MongoDB\BSON\Binary con subtipo 4 - (UUID) que identifica el documento de clave. - - - - - - keyAltName - - - Nombre alternativo que se añadirá al documento de clave. - - - - - - - - &reftitle.returnvalues; - - Devuelve la versión anterior del documento de clave, o &null; si no se encontró - ningún documento coincidente. - - - - - &reftitle.errors; - - &mongodb.throws.std; - Lanza MongoDB\Driver\Exception\RuntimeException en caso de otros errores. - - - - - &reftitle.seealso; - - MongoDB\Driver\ClientEncryption::getKeyByAltName - MongoDB\Driver\ClientEncryption::removeKeyAltName - - - - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/construct.xml b/reference/mongodb/mongodb/driver/clientencryption/construct.xml deleted file mode 100644 index 1e0c69c271..0000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/construct.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::__construct - Crea un nuevo objeto ClientEncryption - - - - &reftitle.description; - - final public MongoDB\Driver\ClientEncryption::__construct - arrayoptions - - - Construye un nuevo objeto MongoDB\Driver\ClientEncryption con las opciones especificadas. - - - - - &reftitle.parameters; - - - options - - - - options - - - - Opción - Tipo - Descripción - - - - - keyVaultClient - MongoDB\Driver\Manager - El gestor utilizado para enrutar las consultas de claves de datos. Esta opción es obligatoria (a diferencia de MongoDB\Driver\Manager::createClientEncryption). - - &mongodb.option.encryption.keyVaultNamespace; - &mongodb.option.encryption.kmsProviders; - &mongodb.option.encryption.tlsOptions; - - -
    -
    -
    -
    -
    -
    - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lanza MongoDB\Driver\Exception\RuntimeException si la extensión fue compilada sin soporte para libmongocrypt - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.16.0 - - - El proveedor de KMS de AWS para la cifrado lado-cliente ahora acepta una - opción "sessionToken", que puede usarse para - autenticarse con credenciales temporales de AWS. - - - Se añadió "tlsDisableOCSPEndpointCheck" a la - opción "tlsOptions". - - - Si se especifica un documento vacío para el proveedor de KMS de - "azure" o "gcp", el controlador - intentará configurar el proveedor usando - Credenciales Automáticas. - - - - - PECL mongodb 1.15.0 - - - Si se especifica un documento vacío para el proveedor de KMS de - "aws", el controlador intentará configurar el proveedor - usando - Credenciales Automáticas. - - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::createClientEncryption - Cifrado Explícito (Manual) de Nivel de Campo del Lado del Cliente en el manual de MongoDB - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/createdatakey.xml b/reference/mongodb/mongodb/driver/clientencryption/createdatakey.xml deleted file mode 100644 index 6b971cfcd8..0000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/createdatakey.xml +++ /dev/null @@ -1,166 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::createDataKey - Crea un documento de clave - - - - &reftitle.description; - - final public MongoDB\BSON\BinaryMongoDB\Driver\ClientEncryption::createDataKey - stringkmsProvider - arraynulloptions&null; - - - Crea un nuevo documento de clave e inserta en la colección de almacén de claves. - - - - - &reftitle.parameters; - - - kmsProvider - - - El proveedor KMS (por ejemplo "local", - "aws") que se utilizará para cifrar la nueva clave de datos. - - - - - - options - - - - Opciones de clave de datos - - - - Opción - Tipo - Descripción - - - - - masterKey - array - - - El documento masterKey identifica una clave específica del KMS utilizada para cifrar - la nueva clave de datos. Esta opción es obligatoria a menos que - kmsProvider sea "local". - - &mongodb.option.encryption.masterKey-options-by-provider; - - - - keyAltNames - array - - - Una lista opcional de nombres alternativos de tipo string utilizados para referenciar una clave. - Si se crea una clave con nombres alternativos, entonces el cifrado puede referirse a la clave - mediante el nombre alternativo único en lugar de por _id. - - - - - keyMaterial - MongoDB\BSON\Binary - - - Un valor opcional de 96 bytes para usar como material de clave personalizado para la clave de datos - que se está creando. Si se proporciona keyMaterial, el material de clave personalizado se utiliza - para cifrar y descifrar datos. De lo contrario, el material de la nueva clave de datos se genera - a partir de un dispositivo criptográficamente seguro aleatorio. - - - - - -
    -
    -
    -
    -
    -
    - - - &reftitle.returnvalues; - - Devuelve el identificador de la nueva clave como un objeto - MongoDB\BSON\Binary con subtipo 4 (UUID). - - - - - &reftitle.errors; - - &mongodb.throws.std; - Lanza MongoDB\Driver\Exception\RuntimeException en caso de otros errores. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.20.0 - - Añadido "delegated" a las opciones de masterKey del proveedor KMIP. - - - - PECL mongodb 1.15.0 - - Añadida la opción "keyMaterial". - - - - PECL mongodb 1.10.0 - - Azure y GCP ahora son compatibles como proveedores KMS para cifrado - lado-cliente. - - - - - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/decrypt.xml b/reference/mongodb/mongodb/driver/clientencryption/decrypt.xml deleted file mode 100644 index a17a600019..0000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/decrypt.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::decrypt - Descifra un valor - - - - &reftitle.description; - - final public mixedMongoDB\Driver\ClientEncryption::decrypt - MongoDB\BSON\Binaryvalue - - - Descifra el valor. - - - - - &reftitle.parameters; - - - value - - - Una instancia de MongoDB\BSON\Binary con subtipo 6 - que contiene el valor cifrado. - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor descifrado tal como fue pasado a - MongoDB\Driver\ClientEncryption::encrypt. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lanza MongoDB\Driver\Exception\EncryptionException si ocurre un error durante el descifrado del valor - - - - - &reftitle.seealso; - - MongoDB\Driver\ClientEncryption::encrypt - - - - - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/deletekey.xml b/reference/mongodb/mongodb/driver/clientencryption/deletekey.xml deleted file mode 100644 index 5432dd5ded..0000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/deletekey.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::deleteKey - Elimina un documento de clave - - - - &reftitle.description; - - final public objectMongoDB\Driver\ClientEncryption::deleteKey - MongoDB\BSON\BinarykeyId - - - Elimina el documento de clave con el UUID keyId dado - de la colección de almacén de claves. - - - - - &reftitle.parameters; - - - keyId - - - Una instancia de MongoDB\BSON\Binary con subtipo 4 - (UUID) que identifica el documento de clave. - - - - - - - - &reftitle.returnvalues; - - Devuelve el resultado de la operación interna deleteOne en - la colección de almacén de claves. - - - - - &reftitle.errors; - - &mongodb.throws.std; - Lanza MongoDB\Driver\Exception\RuntimeException en caso de otros errores. - - - - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/encrypt.xml b/reference/mongodb/mongodb/driver/clientencryption/encrypt.xml deleted file mode 100644 index ee9334b161..0000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/encrypt.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::encrypt - Cifra un valor - - - - &reftitle.description; - - final public MongoDB\BSON\BinaryMongoDB\Driver\ClientEncryption::encrypt - mixedvalue - arraynulloptions&null; - - - Cifra el valor. - - - - - &reftitle.parameters; - - - value - - - El valor a cifrar. Cualquier valor que pueda insertarse en MongoDB puede - cifrarse utilizando este método. - - - - &mongodb.parameter.encryptOpts; - - - - - &reftitle.returnvalues; - - Devuelve el valor cifrado como objeto - MongoDB\BSON\Binary con subtipo 6. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lanza MongoDB\Driver\Exception\EncryptionException si ocurre un error durante el cifrado del valor - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.20.0 - - Se añadió la opción de rango "trimFactor". La - opción de rango "sparsity" ahora es opcional. - - - - PECL mongodb 1.16.0 - - Se añadió la opción "rangeOpts". - - - - PECL mongodb 1.14.0 - - Se añadieron las opciones "contentionFactor" y - "queryType". - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\ClientEncryption::decrypt - MongoDB\Driver\ClientEncryption::encryptExpression - - - - - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/encryptexpression.xml b/reference/mongodb/mongodb/driver/clientencryption/encryptexpression.xml deleted file mode 100644 index 0e5b121428..0000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/encryptexpression.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::encryptExpression - Cifra una expresión de coincidencia o agregación - - - - &reftitle.description; - - final public objectMongoDB\Driver\ClientEncryption::encryptExpression - arrayobjectexpr - arraynulloptions&null; - - - Cifra una expresión de coincidencia o agregación para consultar un índice de rango. - - Para consultar con una carga cifrada de rango, el MongoDB\Driver\Manager debe estar configurado con la opción del controlador "autoEncryption". La opción de auto-cifrado "bypassQueryAnalysis" puede ser &true;. La opción de auto-cifrado "bypassAutoEncryption" debe ser &false;. - - La extensión aún no admite consultas de rango para tipos de campo BSON Decimal128. - - - - - &reftitle.parameters; - - - expr - - - La expresión de coincidencia o agregación a cifrar. Las expresiones deben usar al - menos uno de los operadores $gt, $gte, - $lt o $lte. Se requiere un operador - $and de nivel superior, incluso si solo se usa un único - operador de comparación. - - - A continuación se muestra un ejemplo de una expresión de coincidencia admitida (se aplica a consultas y a la - etapa de agregación $match): - - - [ - [ '' => [ '$gt' => '' ] ], - [ '' => [ '$lte' => '' ] ], - ], -] -]]> - - - A continuación se muestra un ejemplo de una expresión de agregación admitida: - - - [ - [ '$gte' => [ '', '' ] ], - [ '$lt' => [ '', '' ] ], - ], -] -]]> - - - - &mongodb.parameter.encryptOpts; - - - - - &reftitle.returnvalues; - - Devuelve la expresión cifrada como un objeto. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lanza MongoDB\Driver\Exception\EncryptionException si ocurre un error al cifrar la expresión - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.20.0 - - Se añadió la opción de rango "trimFactor". La - opción de rango "sparsity" ahora es opcional. - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::__construct - MongoDB\Driver\ClientEncryption::encrypt - - - - - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/getkey.xml b/reference/mongodb/mongodb/driver/clientencryption/getkey.xml deleted file mode 100644 index 5a5a26cd57..0000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/getkey.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::getKey - Obtiene un documento de clave - - - - &reftitle.description; - - final public objectnullMongoDB\Driver\ClientEncryption::getKey - MongoDB\BSON\BinarykeyId - - - Busca un único documento de clave en la colección de almacén de claves con el UUID - keyId proporcionado. - - - - - &reftitle.parameters; - - - keyId - - - Una instancia de MongoDB\BSON\Binary con subtipo 4 - (UUID) que identifica el documento de clave. - - - - - - - - &reftitle.returnvalues; - - Devuelve el documento de clave, o &null; si no se encontró ningún documento. - - - - - &reftitle.errors; - - &mongodb.throws.std; - Lanza MongoDB\Driver\Exception\RuntimeException en caso de otros errores. - - - - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/getkeybyaltname.xml b/reference/mongodb/mongodb/driver/clientencryption/getkeybyaltname.xml deleted file mode 100644 index c4b7d61047..0000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/getkeybyaltname.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::getKeyByAltName - Obtiene un documento de clave por un nombre alternativo - - - - &reftitle.description; - - final public objectnullMongoDB\Driver\ClientEncryption::getKeyByAltName - stringkeyAltName - - - Busca un único documento de clave en la colección de almacén de claves con el - nombre alternativo keyAltName proporcionado. - - - - - &reftitle.parameters; - - - keyAltName - - - Nombre alternativo para el documento de clave. - - - - - - - - &reftitle.returnvalues; - - Devuelve el documento de clave, o &null; si no se encontró ningún documento. - - - - - &reftitle.errors; - - &mongodb.throws.std; - Lanza MongoDB\Driver\Exception\RuntimeException en caso de otros errores. - - - - - &reftitle.seealso; - - MongoDB\Driver\ClientEncryption::addKeyAltName - MongoDB\Driver\ClientEncryption::removeKeyAltName - - - - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/getkeys.xml b/reference/mongodb/mongodb/driver/clientencryption/getkeys.xml deleted file mode 100644 index f2cdd6f045..0000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/getkeys.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::getKeys - Obtiene todos los documentos de claves - - - - &reftitle.description; - - final public MongoDB\Driver\CursorMongoDB\Driver\ClientEncryption::getKeys - - - - Busca todos los documentos de claves en la colección de almacén de claves. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - &mongodb.returns.cursor; - - - - &reftitle.errors; - - &mongodb.throws.std; - Lanza MongoDB\Driver\Exception\RuntimeException en caso de otros errores. - - - - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/removekeyaltname.xml b/reference/mongodb/mongodb/driver/clientencryption/removekeyaltname.xml deleted file mode 100644 index 70b918cfd0..0000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/removekeyaltname.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::removeKeyAltName - Elimina un nombre alternativo de un documento de clave - - - - &reftitle.description; - - final public objectnullMongoDB\Driver\ClientEncryption::removeKeyAltName - MongoDB\BSON\BinarykeyId - stringkeyAltName - - - Elimina keyAltName del conjunto de nombres alternativos para - el documento de clave con el UUID especificado mediante keyId. - - - - - &reftitle.parameters; - - - keyId - - - Una instancia de MongoDB\BSON\Binary con subtipo 4 - (UUID) que identifica el documento de clave. - - - - - - keyAltName - - - Nombre alternativo que se eliminará del documento de clave. - - - - - - - - &reftitle.returnvalues; - - Devuelve la versión anterior del documento de clave, o &null; si no se - encontró ningún documento coincidente. - - - - - &reftitle.errors; - - &mongodb.throws.std; - Lanza MongoDB\Driver\Exception\RuntimeException en caso de otros errores. - - - - - &reftitle.seealso; - - MongoDB\Driver\ClientEncryption::addKeyAltName - MongoDB\Driver\ClientEncryption::getKeyByAltName - - - - - diff --git a/reference/mongodb/mongodb/driver/clientencryption/rewrapmanydatakey.xml b/reference/mongodb/mongodb/driver/clientencryption/rewrapmanydatakey.xml deleted file mode 100644 index c171ee07c8..0000000000 --- a/reference/mongodb/mongodb/driver/clientencryption/rewrapmanydatakey.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - MongoDB\Driver\ClientEncryption::rewrapManyDataKey - Reenvuelve claves de datos - - - - &reftitle.description; - - final public objectMongoDB\Driver\ClientEncryption::rewrapManyDataKey - arrayobjectfilter - arraynulloptions&null; - - - Reenvuelve (es decir, descifra y vuelve a cifrar) cero o más claves de datos - en la colección de claves maestras que coincidan con el filter - proporcionado. - - - Si no se especifica la opción "provider", las claves de datos - coincidentes se reenvuelven con su proveedor KMS actual. De lo contrario, las - claves de datos coincidentes se volverán a cifrar según las opciones - "provider" y "masterKey" especificadas. - - - - - &reftitle.parameters; - - &mongodb.parameter.filter; - - options - - - - Opciones de RewrapManyDataKey - - - - Opción - Tipo - Descripción - - - - - provider - string - - - El proveedor KMS (por ejemplo, "local", - "aws") que se utilizará para volver a cifrar las - claves de datos coincidentes. - - - Si no se especifica un proveedor KMS, las claves de datos - coincidentes se volverán a cifrar con su proveedor KMS actual. - - - - - masterKey - array - - - La clave maestra identifica una clave específica del KMS utilizada - para cifrar la nueva clave de datos. Esta opción no debe - especificarse sin la opción "provider". Esta - opción es obligatoria si se especifica "provider" - y no es "local". - - &mongodb.option.encryption.masterKey-options-by-provider; - - - - -
    -
    -
    -
    -
    -
    - - - &reftitle.returnvalues; - - Devuelve un objeto que tendrá una propiedad opcional - bulkWriteResult que contiene el resultado de la - operación interna bulkWrite como un objeto. Si ninguna - clave de datos coincidió con el filtro o la escritura no fue - reconocida, la propiedad bulkWriteResult será &null;. - - - - - &reftitle.errors; - - &mongodb.throws.std; - Lanza MongoDB\Driver\Exception\EncryptionException si ocurre un error al descifrar o volver a cifrar una clave de datos. - Lanza MongoDB\Driver\Exception\RuntimeException en otros errores. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.20.0 - - Se añadió "delegated" a las opciones de clave maestra del proveedor KMIP. - - - - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/command.xml b/reference/mongodb/mongodb/driver/command.xml deleted file mode 100644 index 54eaa1ea47..0000000000 --- a/reference/mongodb/mongodb/driver/command.xml +++ /dev/null @@ -1,197 +0,0 @@ - - - - - - La clase MongoDB\Driver\Command - MongoDB\Driver\Command - - - - -
    - &reftitle.intro; - - La clase MongoDB\Driver\Command es un objeto valor - que representa un comando de base de datos. - - - Para proporcionar asistentes de comandos el objeto - MongoDB\Driver\Command debe estar compuesto. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Command - - - - final - - MongoDB\Driver\Command - - - - - &Methods; - - - - -
    - -
    - &reftitle.examples; - - - Composición de <classname>MongoDB\Driver\Command</classname> para proporcionar un asistente para crear colecciones - -cmd["create"] = (string) $collectionName; - } - function setCappedCollection($maxBytes, $maxDocuments = false) { - $this->cmd["capped"] = true; - $this->cmd["size"] = (int) $maxBytes; - - if ($maxDocuments) { - $this->cmd["max"] = (int) $maxDocuments; - } - } - function usePowerOf2Sizes($bool) { - if ($bool) { - $this->cmd["flags"] = 1; - } else { - $this->cmd["flags"] = 0; - } - } - function setFlags($flags) { - $this->cmd["flags"] = (int) $flags; - } - function getCommand() { - return new MongoDB\Driver\Command($this->cmd); - } - function getCollectionName() { - return $this->cmd["create"]; - } -} - - -$manager = new MongoDB\Driver\Manager("mongodb://localhost:27017"); - -$createCollection = new CreateCollection("cappedCollection"); -$createCollection->setCappedCollection(64 * 1024); - -try { - $command = $createCollection->getCommand(); - $cursor = $manager->executeCommand("databaseName", $command); - $response = $cursor->toArray()[0]; - var_dump($response); - - $collstats = ["collstats" => $createCollection->getCollectionName()]; - $cursor = $manager->executeCommand("databaseName", new MongoDB\Driver\Command($collstats)); - $response = $cursor->toArray()[0]; - var_dump($response); -} catch(MongoDB\Driver\Exception $e) { - echo $e->getMessage(), "\n"; - exit; -} - -?> -]]> - - - &example.outputs; - - - array(3) { - ["create"]=> - string(16) "cappedCollection" - ["capped"]=> - bool(true) - ["size"]=> - int(65536) - } -} -array(1) { - ["ok"]=> - float(1) -} -array(16) { - ["ns"]=> - string(29) "databaseName.cappedCollection" - ["count"]=> - int(0) - ["size"]=> - int(0) - ["numExtents"]=> - int(1) - ["storageSize"]=> - int(65536) - ["nindexes"]=> - int(1) - ["lastExtentSize"]=> - float(65536) - ["paddingFactor"]=> - float(1) - ["paddingFactorNote"]=> - string(101) "paddingFactor is unused and unmaintained in 2.8. It remains hard coded to 1.0 for compatibility only." - ["userFlags"]=> - int(0) - ["capped"]=> - bool(true) - ["max"]=> - int(9223372036854775807) - ["maxSize"]=> - int(65536) - ["totalIndexSize"]=> - int(8176) - ["indexSizes"]=> - object(stdClass)#4 (1) { - ["_id_"]=> - int(8176) - } - ["ok"]=> - float(1) -} -]]> - -
    - -
    - - &reference.mongodb.mongodb.driver.entities.command; - -
    - - diff --git a/reference/mongodb/mongodb/driver/command/construct.xml b/reference/mongodb/mongodb/driver/command/construct.xml deleted file mode 100644 index fc56c949c4..0000000000 --- a/reference/mongodb/mongodb/driver/command/construct.xml +++ /dev/null @@ -1,259 +0,0 @@ - - - - - - MongoDB\Driver\Command::__construct - Crea un nuevo Command - - - - &reftitle.description; - - final public MongoDB\Driver\Command::__construct - arrayobjectdocumento - arraynullopcionesComando&null; - - - Construye un nuevo MongoDB\Driver\Command, que es un - objeto de valor inmutable que representa un comando de base de datos. El comando - puede entonces ser ejecutado con - MongoDB\Driver\Manager::executeCommand. - - - El documento de comando completo, que incluye el nombre del comando y sus - opciones, debe ser expresado en el parámetro documento. - El parámetro opcionesComando solo se utiliza para especificar - opciones relacionadas con la ejecución del comando y el MongoDB\Driver\Cursor - resultante. - - - - - &reftitle.parameters; - - - documento - - - El documento de comando completo, que será enviado al servidor. - - - - - - opcionesComando - - - - No utilice este parámetro para especificar opciones descritas en la referencia - del comando en el manual de MongoDB. Este parámetro solo debe ser utilizado - para las opciones listadas explícitamente a continuación. - - - - - opcionesComando - - - - Opción - Tipo - Descripción - - - - - maxAwaitTimeMS - int - - - Entero positivo que denota el límite de tiempo en milisegundos para que - el servidor bloquee una operación getMore si no hay datos disponibles. - Esta opción solo debe ser utilizada en conjunto con comandos que - devuelven un cursor rastreable (p. ej. Streams de Cambios). - - - - - -
    -
    -
    -
    -
    -
    - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.4.0 - - - Se añadió un segundo argumento opcionesComando, que - soporta la opción "maxAwaitTimeMS". - - - - - - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\Command::__construct</function> - - 1)); - -try { - $cursor = $manager->executeCommand("admin", $command); - $response = $cursor->toArray()[0]; -} catch(MongoDB\Driver\Exception $e) { - echo $e->getMessage(), "\n"; - exit; -} -var_dump($response); - -?> -]]> - - &example.outputs.similar; - - - string(14) "2.8.0-rc2-pre-" - ["gitVersion"]=> - string(62) "b743d7158f7642f4da6b7eac8320374b3b88dc2e modules: subscription" - ["OpenSSLVersion"]=> - string(25) "OpenSSL 1.0.1f 6 Jan 2014" - ["sysInfo"]=> - string(104) "Linux infant 3.16.0-24-generic #32-Ubuntu SMP Tue Oct 28 13:07:32 UTC 2014 x86_64 BOOST_LIB_VERSION=1_49" - ["loaderFlags"]=> - string(91) "-fPIC -pthread -Wl,-z,now -rdynamic -Wl,-Bsymbolic-functions -Wl,-z,relro -Wl,-z,now -Wl,-E" - ["compilerFlags"]=> - string(301) "-Wnon-virtual-dtor -Woverloaded-virtual -std=c++11 -fPIC -fno-strict-aliasing -ggdb -pthread -Wall -Wsign-compare -Wno-unknown-pragmas -Winvalid-pch -pipe -Werror -O3 -Wno-unused-local-typedefs -Wno-unused-function -Wno-deprecated-declarations -Wno-unused-but-set-variable -fno-builtin-memcmp -std=c99" - ["allocator"]=> - string(8) "tcmalloc" - ["versionArray"]=> - array(4) { - [0]=> - int(2) - [1]=> - int(8) - [2]=> - int(0) - [3]=> - int(-8) - } - ["javascriptEngine"]=> - string(2) "V8" - ["bits"]=> - int(64) - ["debug"]=> - bool(false) - ["maxBsonObjectSize"]=> - int(16777216) - ["ok"]=> - float(1) -} - -]]> - - - - - Ejemplo de <function>MongoDB\Driver\Command::__construct</function> - - Los comandos pueden aceptar opciones también, como parte de la estructura - normal que se crea para enviar al servidor. Por ejemplo, la opción - maxTimeMS puede ser pasada con la mayoría de comandos - para restringir la cantidad de tiempo que un comando específico puede ejecutarse - en el servidor. - - - "beer", - "key" => "beer_name", - "maxTimeMS" => 10, - ) -); - -try { - $cursor = $manager->executeCommand("beerdb", $command); - $response = $cursor->toArray()[0]; -} catch(MongoDB\Driver\Exception\Exception $e) { - echo $e->getMessage(), "\n"; - exit; -} -var_dump($response); - -?> -]]> - - &example.outputs.similar; - - la operación excedió el límite de tiempo - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeCommand - MongoDB\Driver\Cursor - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/cursor.xml b/reference/mongodb/mongodb/driver/cursor.xml deleted file mode 100644 index de2114de89..0000000000 --- a/reference/mongodb/mongodb/driver/cursor.xml +++ /dev/null @@ -1,314 +0,0 @@ - - - - - - La clase MongoDB\Driver\Cursor - MongoDB\Driver\Cursor - - - - -
    - &reftitle.intro; - - La clase MongoDB\Driver\Cursor encapsula - los resultados de un comando o consulta de MongoDB y puede ser devuelta por - MongoDB\Driver\Manager::executeCommand o - MongoDB\Driver\Manager::executeQuery, respectivamente. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Cursor - - - - final - - MongoDB\Driver\Cursor - - - - MongoDB\Driver\CursorInterface - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.9.0 - - Implementa Iterator. - - - - PECL mongodb 1.6.0 - - Implementa MongoDB\Driver\CursorInterface, - que extiende Traversable. - - - - - -
    - -
    - &reftitle.examples; - - - Lectura de un conjunto de resultados - - MongoDB\Driver\Manager::executeCommand y - MongoDB\Driver\Manager::executeQuery devuelven - sus resultados como un objeto MongoDB\Driver\Cursor. - Este objeto puede usarse para iterar sobre el conjunto de resultados del - comando o consulta. - - - Dado que MongoDB\Driver\Cursor implementa la - interfaz Traversable, puede simplemente - iterar sobre el conjunto de resultados con - foreach. - - -insert(['name' => 'Ceres', 'size' => 946, 'distance' => 2.766]); -$bulkWrite->insert(['name' => 'Vesta', 'size' => 525, 'distance' => 2.362]); -$manager->executeBulkWrite("test.asteroids", $bulkWrite); - -/* Consultar todos los elementos de la colección */ -$query = new MongoDB\Driver\Query( [] ); - -/* Consultar la colección "asteroids" de la base de datos "test" */ -$cursor = $manager->executeQuery("test.asteroids", $query); - -/* $cursor ahora contiene un objeto que envuelve el conjunto de resultados. Usar - * foreach() para iterar sobre todos los resultados */ -foreach($cursor as $document) { - print_r($document); -} - -?> -]]> - - &example.outputs.similar; - - MongoDB\BSON\ObjectId Object - ( - [oid] => 5a4cff2f122d3321565d8cc2 - ) - - [name] => Ceres - [size] => 946 - [distance] => 2.766 -) -stdClass Object -( - [_id] => MongoDB\BSON\ObjectId Object - ( - [oid] => 5a4cff2f122d3321565d8cc3 - ) - - [name] => Vesta - [size] => 525 - [distance] => 2.362 -) -]]> - - - - - Lectura de un conjunto de resultados para un cursor rastreable - - Los cursores rastreables - son un tipo especial de cursor de MongoDB que permite al cliente leer algunos - resultados y luego esperar hasta que haya más documentos disponibles. Estos - cursores se usan principalmente con - colecciones limitadas - y flujos de cambios. - - - Mientras que los cursores normales pueden iterarse una vez con - foreach, ese enfoque no funcionará con cursores rastreables. - Cuando se usa foreach con un cursor rastreable, el bucle - terminará al llegar al final del conjunto de resultados inicial. Intentar - continuar la iteración en el cursor con un segundo - foreach lanzaría una excepción, ya que PHP intenta - retroceder el cursor. Al igual que los objetos de resultado en otros controladores - de bases de datos, los cursores en MongoDB solo admiten la iteración hacia - adelante, lo que significa que no pueden retrocederse. - - - Para leer de forma continua desde un cursor rastreable, el objeto Cursor - debe envolverse con un IteratorIterator. Esto permite - que la aplicación controle directamente la iteración del cursor, evite - retroceder el cursor sin querer y decida cuándo esperar nuevos resultados - o detener completamente la iteración. - - - Para demostrar un cursor rastreable en acción, se usarán dos scripts: un - "productor" y un "consumidor". El script productor creará una nueva colección - limitada usando el comando - create e insertará - un nuevo documento en esa colección cada segundo. - - -executeCommand('test', new MongoDB\Driver\Command([ - 'create' => 'asteroids', - 'capped' => true, - 'size' => 1048576, -])); - -while (true) { - $bulkWrite = new MongoDB\Driver\BulkWrite; - $bulkWrite->insert(['createdAt' => new MongoDB\BSON\UTCDateTime]); - $manager->executeBulkWrite('test.asteroids', $bulkWrite); - - sleep(1); -} - -?> -]]> - - - Con el script productor aún en ejecución, puede ejecutarse un segundo script - consumidor para leer los documentos insertados usando un cursor rastreable, - indicado por las opciones tailable y - awaitData en MongoDB\Driver\Query::__construct. - - - true, - 'awaitData' => true, -]); - -$cursor = $manager->executeQuery('test.asteroids', $query); - -$iterator = new IteratorIterator($cursor); - -$iterator->rewind(); - -while (true) { - if ($iterator->valid()) { - $document = $iterator->current(); - printf("Documento consumido creado en: %s\n", $document->createdAt); - } - - $iterator->next(); -} - -?> -]]> - - - El script consumidor comenzará imprimiendo rápidamente todos los documentos - disponibles en la colección limitada (como si se hubiera usado - foreach); sin embargo, no terminará al llegar al final - del conjunto de resultados inicial. Dado que el cursor es rastreable, llamar - a IteratorIterator::next bloqueará y esperará - resultados adicionales. IteratorIterator::valid también - se usa para verificar si hay realmente datos disponibles para leer en cada - paso. - - - - Este ejemplo usa la opción de consulta awaitData para - instruir al servidor que bloquee durante un breve período (por ejemplo, - un segundo) al final del conjunto de resultados antes de devolver una - respuesta al controlador. Esto se usa para evitar que el controlador - consulte agresivamente al servidor cuando no hay resultados disponibles. - La opción maxAwaitTimeMS puede usarse junto con - tailable y awaitData para especificar - la cantidad de tiempo que el servidor debe bloquearse cuando llega al final - del conjunto de resultados. - - - -
    - -
    - &reftitle.errors; - - Al iterar sobre el objeto cursor, los datos BSON se convierten en variables - PHP. Esta iteración puede causar las siguientes Excepciones: - - - - Lanza - MongoDB\Driver\Exception\InvalidArgumentException si - una clase en el mapa de tipos no puede ser instanciada o no implementa - MongoDB\BSON\Unserializable. - - &mongodb.throws.bson.unexpected; - -
    - -
    - - &reference.mongodb.mongodb.driver.entities.cursor; - -
    - - diff --git a/reference/mongodb/mongodb/driver/cursor/construct.xml b/reference/mongodb/mongodb/driver/cursor/construct.xml deleted file mode 100644 index b13809458c..0000000000 --- a/reference/mongodb/mongodb/driver/cursor/construct.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Cursor::__construct - Crear un nuevo Cursor (no utilizado) - - - - &reftitle.description; - - final private MongoDB\Driver\Cursor::__construct - - - - Los objetos MongoDB\Driver\Cursor son devueltos como - resultado de un comando o consulta ejecutada y no pueden ser construidos directamente. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeCommand - MongoDB\Driver\Manager::executeQuery - MongoDB\Driver\Server::executeCommand - MongoDB\Driver\Server::executeQuery - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursor/current.xml b/reference/mongodb/mongodb/driver/cursor/current.xml deleted file mode 100644 index 0e5cc56c91..0000000000 --- a/reference/mongodb/mongodb/driver/cursor/current.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - MongoDB\Driver\Cursor::current - Devuelve el elemento actual - - - - &reftitle.description; - - public arrayobjectnullMongoDB\Driver\Cursor::current - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el documento de resultado actual como un array u objeto, dependiendo del - mapa de tipos del cursor. Si la iteración no ha comenzado o la posición actual - no es válida, se devolverá &null;. - - - - - &reftitle.seealso; - - Iterator::current - - - - diff --git a/reference/mongodb/mongodb/driver/cursor/getid.xml b/reference/mongodb/mongodb/driver/cursor/getid.xml deleted file mode 100644 index 72f4f047b3..0000000000 --- a/reference/mongodb/mongodb/driver/cursor/getid.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - MongoDB\Driver\Cursor::getId - Devuelve el ID del cursor - - - - &reftitle.description; - - final public MongoDB\BSON\Int64MongoDB\Driver\Cursor::getId - - - - Devuelve el ID de este cursor, que identifica de manera única al cursor en el - servidor. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el ID de este cursor. El ID se devolverá como un objeto - MongoDB\BSON\Int64. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.0.0 - - Se cambió el tipo de retorno a MongoDB\BSON\Int64. - Se eliminó el parámetro asInt64. - - - - PECL mongodb 1.20.0 - - Se desaconsejó devolver un MongoDB\Driver\CursorId. - Se añadió el argumento asInt64 para facilitar la - migración en versiones futuras. Si asInt64 es &true;, - el ID se devolverá como un MongoDB\BSON\Int64. - - - - - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\Cursor::getId</function> - - 2]); - -$bulk = new MongoDB\Driver\BulkWrite; -$bulk->insert(['x' => 1]); -$bulk->insert(['x' => 2]); -$bulk->insert(['x' => 3]); -$manager->executeBulkWrite('db.collection', $bulk); - -$cursor = $manager->executeQuery('db.collection', $query); -var_dump($cursor->getId(true)); - -?> -]]> - - &example.outputs.similar; - - - string(11) "94810124093" -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\BSON\Int64 - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursor/getserver.xml b/reference/mongodb/mongodb/driver/cursor/getserver.xml deleted file mode 100644 index 0f4a000f8a..0000000000 --- a/reference/mongodb/mongodb/driver/cursor/getserver.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - MongoDB\Driver\Cursor::getServer - Devuelve el servidor asociado con este cursor - - - - &reftitle.description; - - final public MongoDB\Driver\ServerMongoDB\Driver\Cursor::getServer - - - - Devuelve el MongoDB\Driver\Server asociado con este - cursor. Este es el servidor que ejecutó la - MongoDB\Driver\Query o la - MongoDB\Driver\Command. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el MongoDB\Driver\Server asociado con este - cursor. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\Cursor::getServer</function> - -insert(['x' => 1]); -$manager->executeBulkWrite('db.collection', $bulk); - -$cursor = $manager->executeQuery('db.collection', $query); -var_dump($cursor->getServer()); - -?> -]]> - - &example.outputs.similar; - - - string(9) "localhost" - ["port"]=> - int(27017) - ["type"]=> - int(1) - ["is_primary"]=> - bool(false) - ["is_secondary"]=> - bool(false) - ["is_arbiter"]=> - bool(false) - ["is_hidden"]=> - bool(false) - ["is_passive"]=> - bool(false) - ["last_hello_response"]=> - array(8) { - ["isWritablePrimary"]=> - bool(true) - ["maxBsonObjectSize"]=> - int(16777216) - ["maxMessageSizeBytes"]=> - int(48000000) - ["maxWriteBatchSize"]=> - int(1000) - ["localTime"]=> - object(MongoDB\BSON\UTCDateTime)#6 (1) { - ["milliseconds"]=> - int(1446505367907) - } - ["maxWireVersion"]=> - int(3) - ["minWireVersion"]=> - int(0) - ["ok"]=> - float(1) - } - ["round_trip_time"]=> - int(584) -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\Server - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursor/isdead.xml b/reference/mongodb/mongodb/driver/cursor/isdead.xml deleted file mode 100644 index cc83d4e7b7..0000000000 --- a/reference/mongodb/mongodb/driver/cursor/isdead.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - MongoDB\Driver\Cursor::isDead - Comprueba si el cursor está agotado o puede tener resultados adicionales - - - - &reftitle.description; - - final public boolMongoDB\Driver\Cursor::isDead - - - - Comprueba si no hay definitivamente más resultados disponibles en el cursor. - Este método es similar al método - cursor.isExhausted() - en el MongoDB shell y es principalmente útil al iterar - cursores persistentes. - - - Un cursor no tiene más resultados y se considera "agotado" cuando se cumple - una de las siguientes condiciones: - - - La actual serie de resultados se ha iterado completamente y el - identificador del cursor es cero (es decir, no se puede emitir un - getMore). - - Se encontró un error al iterar el cursor. - El cursor alcanzó su límite configurado. - - - - Por diseño, no siempre es posible determinar si un cursor tiene resultados - adicionales. Los casos en los que un cursor puede tener más datos - disponibles son los siguientes: - - - Hay documentos adicionales en la actual serie de resultados, que están - almacenados en el lado-cliente. Iterar obtendrá un documento del búfer - local. - - - No hay documentos adicionales en la actual serie de resultados (es decir, - búfer local), pero el identificador del cursor no es cero. Iterar - solicitará más documentos al servidor mediante una operación - getMore, - que puede o no devolver más resultados y/o indicar que el cursor ha sido - cerrado en el servidor al devolver cero para su identificador. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si no hay definitivamente más resultados disponibles en el - cursor, y &false; en caso contrario. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\Cursor::isDead</function> - -insert(['x' => 1]); -$bulk->insert(['x' => 2]); -$bulk->insert(['x' => 3]); -$manager->executeBulkWrite('db.collection', $bulk); - -$cursor = $manager->executeQuery('db.collection', $query); - -$iterator = new IteratorIterator($cursor); - -$iterator->rewind(); -var_dump($cursor->isDead()); - -$iterator->next(); -var_dump($cursor->isDead()); - -$iterator->next(); -var_dump($cursor->isDead()); - -$iterator->next(); -var_dump($cursor->isDead()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - Cursores persistentes en el manual de MongoDB - cursor.isExhausted() en el manual de MongoDB - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursor/key.xml b/reference/mongodb/mongodb/driver/cursor/key.xml deleted file mode 100644 index 09e2e6c3a4..0000000000 --- a/reference/mongodb/mongodb/driver/cursor/key.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - MongoDB\Driver\Cursor::key - Devuelve el índice del resultado actual dentro del cursor - - - - &reftitle.description; - - public intMongoDB\Driver\Cursor::key - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El índice numérico del resultado actual dentro del cursor. - - - - - &reftitle.seealso; - - Iterator::key - - - - diff --git a/reference/mongodb/mongodb/driver/cursor/next.xml b/reference/mongodb/mongodb/driver/cursor/next.xml deleted file mode 100644 index 7130722d7a..0000000000 --- a/reference/mongodb/mongodb/driver/cursor/next.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - MongoDB\Driver\Cursor::next - Avanza el cursor al siguiente resultado - - - - &reftitle.description; - - public voidMongoDB\Driver\Cursor::next - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Mueve la posición actual al siguiente elemento del cursor. - - - - - &reftitle.errors; - - &mongodb.throws.std; - - - - - &reftitle.seealso; - - Iterator::next - - - - diff --git a/reference/mongodb/mongodb/driver/cursor/rewind.xml b/reference/mongodb/mongodb/driver/cursor/rewind.xml deleted file mode 100644 index 4ce356df95..0000000000 --- a/reference/mongodb/mongodb/driver/cursor/rewind.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - MongoDB\Driver\Cursor::rewind - Rebobinar el cursor a la primera posición - - - - &reftitle.description; - - public voidMongoDB\Driver\Cursor::rewind - - - - Si el cursor ha avanzado más allá de su primera posición, ya no podrá - rebobinarse. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &null;. - - - - - &reftitle.errors; - - &mongodb.throws.std; - Lanza MongoDB\Driver\Exception\LogicException si este método se invoca después de que el cursor haya avanzado más allá de su primera posición. - - - - - &reftitle.seealso; - - Iterator::rewind - - - - diff --git a/reference/mongodb/mongodb/driver/cursor/settypemap.xml b/reference/mongodb/mongodb/driver/cursor/settypemap.xml deleted file mode 100644 index 2aea1f1926..0000000000 --- a/reference/mongodb/mongodb/driver/cursor/settypemap.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - MongoDB\Driver\Cursor::setTypeMap - Establece un mapa de tipos para usar en la deserialización BSON - - - - &reftitle.description; - - final public voidMongoDB\Driver\Cursor::setTypeMap - arraytypemap - - - Establece la configuración del mapa de tipos - que se usará al deserializar los resultados BSON en valores de PHP. - - - - - &reftitle.parameters; - - &mongodb.parameter.typeMap; - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - Al iterar sobre el cursor, también se pueden lanzar las siguientes excepciones - debido a una configuración incorrecta del mapa de tipos: - - - Lanza - MongoDB\Driver\Exception\InvalidArgumentException si - una clase en el mapa de tipos no puede ser instanciada o no implementa - MongoDB\BSON\Unserializable. - - - - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\Cursor::setTypeMap</function> - -insert(['x' => 1]); -$manager->executeBulkWrite('db.collection', $bulk); - -$query = new MongoDB\Driver\Query(['_id' => $id]); -$cursor = $manager->executeQuery('db.collection', $query); -$cursor->setTypeMap(['root' => 'array']); - -foreach ($cursor as $document) { - var_dump($document); -} - -?> -]]> - - &example.outputs.similar; - - - object(MongoDB\BSON\ObjectId)#6 (1) { - ["oid"]=> - string(24) "56424fb76118fd3267180741" - } - ["x"]=> - int(1) -} -]]> - - - - - - &reftitle.seealso; - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursor/toarray.xml b/reference/mongodb/mongodb/driver/cursor/toarray.xml deleted file mode 100644 index 3bda993a2e..0000000000 --- a/reference/mongodb/mongodb/driver/cursor/toarray.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - MongoDB\Driver\Cursor::toArray - Devuelve un array que contiene todos los resultados de este cursor - - - - &reftitle.description; - - final public arrayMongoDB\Driver\Cursor::toArray - - - - Itera el cursor y devuelve sus resultados en un array. - Se puede usar MongoDB\Driver\Cursor::setTypeMap para controlar - cómo se deserializan los documentos en valores de PHP. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un array que contiene todos los resultados de este cursor. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\Cursor::toArray</function> - -insert(['x' => 1]); -$bulk->insert(['x' => 2]); -$bulk->insert(['x' => 3]); -$manager->executeBulkWrite('db.collection', $bulk); - -$query = new MongoDB\Driver\Query([]); -$cursor = $manager->executeQuery('db.collection', $query); - -var_dump($cursor->toArray()); - -?> -]]> - - &example.outputs.similar; - - - object(stdClass)#6 (2) { - ["_id"]=> - object(MongoDB\BSON\ObjectId)#5 (1) { - ["oid"]=> - string(24) "564259a96118fd40b41bcf61" - } - ["x"]=> - int(1) - } - [1]=> - object(stdClass)#8 (2) { - ["_id"]=> - object(MongoDB\BSON\ObjectId)#7 (1) { - ["oid"]=> - string(24) "564259a96118fd40b41bcf62" - } - ["x"]=> - int(2) - } - [2]=> - object(stdClass)#10 (2) { - ["_id"]=> - object(MongoDB\BSON\ObjectId)#9 (1) { - ["oid"]=> - string(24) "564259a96118fd40b41bcf63" - } - ["x"]=> - int(3) - } -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\Cursor::setTypeMap - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursor/valid.xml b/reference/mongodb/mongodb/driver/cursor/valid.xml deleted file mode 100644 index 58cfcc9785..0000000000 --- a/reference/mongodb/mongodb/driver/cursor/valid.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - MongoDB\Driver\Cursor::valid - Comprueba si la posición actual en el cursor es válida - - - - &reftitle.description; - - public boolMongoDB\Driver\Cursor::valid - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; si la posición actual del cursor es válida, &false; en caso contrario. - - - - - &reftitle.seealso; - - Iterator::valid - - - - diff --git a/reference/mongodb/mongodb/driver/cursorid.xml b/reference/mongodb/mongodb/driver/cursorid.xml deleted file mode 100644 index 39901e6f2d..0000000000 --- a/reference/mongodb/mongodb/driver/cursorid.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - La clase MongoDB\Driver\CursorId - MongoDB\Driver\CursorId - - - - -
    - &reftitle.intro; - - La clase MongoDB\Driver\CursorID es un objeto de valor - que representa un identificador de cursor. Las instancias de esta clase son devueltas por - MongoDB\Driver\Cursor::getId. - - - - Esta clase ha sido DEPRECADA a partir de la versión 1.20.0 - de la extensión y fue eliminada en la versión 2.0. Las aplicaciones deben actualizar - su uso de MongoDB\Driver\Cursor::getId para devolver - MongoDB\BSON\Int64 en su lugar. - - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\CursorId - - - - final - - MongoDB\Driver\CursorId - - - - Serializable - - - - Stringable - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.class-removed; - - PECL mongodb 1.20.0 - - Esta clase ha sido deprecada y será eliminada en la versión 2.0. - - - - PECL mongodb 1.12.0 - - Implementa Stringable para PHP 8.0+. - - - - PECL mongodb 1.7.0 - - Implementa Serializable. - - - - - -
    - -
    - - &reference.mongodb.mongodb.driver.entities.cursorid; - -
    - - diff --git a/reference/mongodb/mongodb/driver/cursorid/construct.xml b/reference/mongodb/mongodb/driver/cursorid/construct.xml deleted file mode 100644 index d332c3104c..0000000000 --- a/reference/mongodb/mongodb/driver/cursorid/construct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - MongoDB\Driver\CursorId::__construct - Crear un nuevo CursorId (no utilizado) - - - - &reftitle.description; - - final private MongoDB\Driver\CursorId::__construct - - - - Los objetos MongoDB\Driver\CursorId son devueltos por - MongoDB\Driver\Cursor::getId y no pueden ser construidos - directamente. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.seealso; - - MongoDB\Driver\Cursor::getId - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursorid/tostring.xml b/reference/mongodb/mongodb/driver/cursorid/tostring.xml deleted file mode 100644 index ee9b38bb39..0000000000 --- a/reference/mongodb/mongodb/driver/cursorid/tostring.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - MongoDB\Driver\CursorId::__toString - Representación en forma de string del identificador del cursor - - - - &reftitle.description; - - final public stringMongoDB\Driver\CursorId::__toString - - - - Devuelve la representación en forma de string del identificador del cursor. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la representación en forma de string del identificador del cursor. - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\CursorId::__toString</function> - - 2]); - -$bulk = new MongoDB\Driver\BulkWrite; -$bulk->insert(['x' => 1]); -$bulk->insert(['x' => 2]); -$bulk->insert(['x' => 3]); -$manager->executeBulkWrite('db.collection', $bulk); - -$cursor = $manager->executeQuery('db.collection', $query); -var_dump((string) $cursor->getId()); - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Cursor::getId - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursorinterface.xml b/reference/mongodb/mongodb/driver/cursorinterface.xml deleted file mode 100644 index 12e9605d3a..0000000000 --- a/reference/mongodb/mongodb/driver/cursorinterface.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - La interfaz <literal>MongoDB\Driver\CursorInterface</literal> - MongoDB\Driver\CursorInterface - - - - -
    - &reftitle.intro; - - Esta interfaz es implementada por - MongoDB\Driver\Cursor para ser usada como - un parámetro, retorno, o tipo de propiedad en clases de usuario. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\CursorInterface - - - - - MongoDB\Driver\CursorInterface - - - - Iterator - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.0.0 - - - Esta interfaz ahora extiende Iterator. - - - Los tipos de retorno declarados previamente como provisionales ahora están obligados. - - - - &mongodb.changelog.tentative-return-types; - - - -
    - -
    - - &reference.mongodb.mongodb.driver.entities.cursorinterface; - -
    - - diff --git a/reference/mongodb/mongodb/driver/cursorinterface/getid.xml b/reference/mongodb/mongodb/driver/cursorinterface/getid.xml deleted file mode 100644 index b7a11391c9..0000000000 --- a/reference/mongodb/mongodb/driver/cursorinterface/getid.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - MongoDB\Driver\CursorInterface::getId - Devuelve el ID de este cursor - - - - &reftitle.description; - - abstract public MongoDB\BSON\Int64MongoDB\Driver\CursorInterface::getId - - - - Devuelve el ID de este cursor, que identifica de manera única el cursor en el - servidor. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el ID de este cursor. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.20.0 - - Se añadió MongoDB\BSON\Int64 al tipo de retorno - tentativo de este método. MongoDB\Driver\CursorId - será eliminado del tipo de retorno en la versión 2.0. - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Cursor::getId - MongoDB\Driver\CursorId - MongoDB\BSON\Int64 - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursorinterface/getserver.xml b/reference/mongodb/mongodb/driver/cursorinterface/getserver.xml deleted file mode 100644 index cc084ac223..0000000000 --- a/reference/mongodb/mongodb/driver/cursorinterface/getserver.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - MongoDB\Driver\CursorInterface::getServer - Devuelve el servidor asociado a este cursor - - - - &reftitle.description; - - abstract public MongoDB\Driver\ServerMongoDB\Driver\CursorInterface::getServer - - - - Devuelve el MongoDB\Driver\Server asociado a este - cursor. Este es el servidor que ejecutó la - MongoDB\Driver\Query o la - MongoDB\Driver\Command. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el MongoDB\Driver\Server asociado a este - cursor. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Cursor::getServer - MongoDB\Driver\Server - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursorinterface/isdead.xml b/reference/mongodb/mongodb/driver/cursorinterface/isdead.xml deleted file mode 100644 index 183afdfe10..0000000000 --- a/reference/mongodb/mongodb/driver/cursorinterface/isdead.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - MongoDB\Driver\CursorInterface::isDead - Comprueba si el cursor puede tener resultados adicionales - - - - &reftitle.description; - - abstract public boolMongoDB\Driver\CursorInterface::isDead - - - - Comprueba si el cursor puede tener resultados adicionales disponibles para leer. Un - cursor está inicialmente "activo" pero puede volverse "inactivo" por cualquiera de las - siguientes razones: - - Avanzar un cursor no orientable no devolvió un documento - El cursor encontró un error - El cursor leyó su último lote hasta completarse - El cursor alcanzó su límite configurado - - Esto es principalmente útil con cursores orientables. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si no hay resultados adicionales disponibles, y &false; - en caso contrario. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Cursor::isDead - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursorinterface/settypemap.xml b/reference/mongodb/mongodb/driver/cursorinterface/settypemap.xml deleted file mode 100644 index 5add069b56..0000000000 --- a/reference/mongodb/mongodb/driver/cursorinterface/settypemap.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - MongoDB\Driver\CursorInterface::setTypeMap - Establece un mapa de tipos para usar en la deserialización BSON - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\CursorInterface::setTypeMap - arraytypemap - - - Establece la configuración del mapa de tipos que se usará al deserializar los resultados BSON en valores PHP. - - - - - &reftitle.parameters; - - &mongodb.parameter.typeMap; - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Cursor::setTypeMap - - - - - - - diff --git a/reference/mongodb/mongodb/driver/cursorinterface/toarray.xml b/reference/mongodb/mongodb/driver/cursorinterface/toarray.xml deleted file mode 100644 index 3adaca792a..0000000000 --- a/reference/mongodb/mongodb/driver/cursorinterface/toarray.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - MongoDB\Driver\CursorInterface::toArray - Devuelve un array que contiene todos los resultados de este cursor - - - - &reftitle.description; - - abstract public arrayMongoDB\Driver\CursorInterface::toArray - - - - Itera el cursor y devuelve sus resultados en un array. - Se puede usar MongoDB\Driver\CursorInterface::setTypeMap para - controlar cómo los documentos son deserializados en valores de PHP. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un array que contiene todos los resultados de este cursor. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Cursor::toArray - MongoDB\Driver\CursorInterface::setTypeMap - - - - - - diff --git a/reference/mongodb/mongodb/driver/exception/authenticationexception.xml b/reference/mongodb/mongodb/driver/exception/authenticationexception.xml deleted file mode 100644 index 938fff3d45..0000000000 --- a/reference/mongodb/mongodb/driver/exception/authenticationexception.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - La clase MongoDB\Driver\Exception\AuthenticationException - MongoDB\Driver\Exception\AuthenticationException - - - - -
    - &reftitle.intro; - - Se lanza cuando el controlador no logra autenticarse con el servidor. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\AuthenticationException - - - - - MongoDB\Driver\Exception\AuthenticationException - - - - extends - MongoDB\Driver\Exception\ConnectionException - - - - MongoDB\Driver\Exception\Exception - - - - &InheritedProperties; - - - - - - &InheritedMethods; - - - - - - - - -
    - -
    - -
    - - diff --git a/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception.xml b/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception.xml deleted file mode 100644 index 5580ffcff4..0000000000 --- a/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception.xml +++ /dev/null @@ -1,166 +0,0 @@ - - - - - - La clase MongoDB\Driver\Exception\BulkWriteCommandException - MongoDB\Driver\Exception\BulkWriteCommandException - - - - -
    - &reftitle.intro; - - Excepción lanzada debido a la ejecución fallida de una - MongoDB\Driver\BulkWriteCommand. Los métodos de esta - clase proporcionan más detalles sobre el error que ocurrió, incluyendo la - respuesta de error y los resultados parciales de la escritura masiva. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\BulkWriteCommandException - - - - - MongoDB\Driver\Exception\BulkWriteCommandException - - - - extends - MongoDB\Driver\Exception\ServerException - - - - MongoDB\Driver\Exception\Exception - - - - &Properties; - - private - MongoDB\BSON\Documentnull - errorReply - - - private - MongoDB\Driver\BulkWriteCommandResultnull - partialResult - - - private - array - writeConcernErrors - - - private - array - writeErrors - - - &InheritedProperties; - - - - - - &Methods; - - - &InheritedMethods; - - - - - - - -
    - - -
    - &reftitle.properties; - - - errorReply - - - Cualquier error de nivel superior que ocurrió al intentar comunicarse con - el servidor o ejecutar la escritura masiva. Este valor puede ser &null; - si la excepción se lanzó debido a errores que ocurrieron en escrituras - individuales. - - - - - partialResult - - - Un MongoDB\Driver\BulkWriteCommandResult que - informa sobre el resultado de cualquier operación exitosa que se realizó - antes de que se encontrara el error. Este valor puede ser &null; si no - se puede determinar que al menos una escritura se realizó con éxito (y - fue confirmada). - - - - - writeConcernErrors - - - Un array de cualquier MongoDB\Driver\WriteConcernError - que ocurrió al ejecutar la escritura masiva. Esta lista puede tener - múltiples elementos si se requirieron más de un comando de servidor para - ejecutar la escritura masiva. - - - - - writeErrors - - - Un array de cualquier MongoDB\Driver\WriteError - que ocurrió durante la ejecución de operaciones de escritura individuales. - Las claves del array corresponderán al índice de la operación de escritura - de MongoDB\Driver\BulkWriteCommand. Este mapa - contendrá como máximo una entrada si la escritura masiva estaba ordenada. - - - - -
    - - -
    - - &reference.mongodb.mongodb.driver.exception.entities.bulkwritecommandexception; - -
    - - diff --git a/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/geterrorreply.xml b/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/geterrorreply.xml deleted file mode 100644 index 60f76b73b2..0000000000 --- a/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/geterrorreply.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - - MongoDB\Driver\Exception\BulkWriteCommandException::getErrorReply - Devuelve un error de comando de nivel superior - - - - &reftitle.description; - - final public MongoDB\BSON\DocumentnullMongoDB\Driver\Exception\BulkWriteCommandException::getErrorReply - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un error de comando de nivel superior que ocurrió al intentar comunicarse - con el servidor o al ejecutar la escritura masiva. Este valor puede ser &null; si la excepción - fue lanzada debido a errores que ocurrieron en escrituras individuales. - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\Exception\BulkWriteCommandException::getErrorReply</function> - -executeCommand('admin', new MongoDB\Driver\Command([ - 'configureFailPoint' => 'failCommand', - 'mode' => ['times' => 1], - 'data' => [ - 'failCommands' => ['bulkWrite'], - 'errorCode' => 8, /* UnknownError */ - ], -])); - -$bulk = new MongoDB\Driver\BulkWriteCommand; -$bulk->insertOne('db.coll', ['x' => 1]); - -try { - $result = $manager->executeBulkWriteCommand($bulk); -} catch (MongoDB\Driver\Exception\BulkWriteCommandException $e) { - var_dump($e->getErrorReply()?->toPHP()); -} - -?> -]]> - - &example.outputs.similar; - - - float(0) - ["errmsg"]=> - string(43) "Failing command via 'failCommand' failpoint" - ["code"]=> - int(8) - ["codeName"]=> - string(12) "UnknownError" - ["$clusterTime"]=> - object(stdClass)#10 (2) { - ["clusterTime"]=> - object(MongoDB\BSON\Timestamp)#6 (2) { - ["increment"]=> - string(1) "7" - ["timestamp"]=> - string(10) "1744319389" - } - ["signature"]=> - object(stdClass)#9 (2) { - ["hash"]=> - object(MongoDB\BSON\Binary)#7 (2) { - ["data"]=> - string(20) "" - ["type"]=> - int(0) - } - ["keyId"]=> - object(MongoDB\BSON\Int64)#8 (1) { - ["integer"]=> - string(1) "0" - } - } - } - ["operationTime"]=> - object(MongoDB\BSON\Timestamp)#11 (2) { - ["increment"]=> - string(1) "7" - ["timestamp"]=> - string(10) "1744319389" - } -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeBulkWriteCommand - - - - - - diff --git a/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/getpartialresult.xml b/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/getpartialresult.xml deleted file mode 100644 index 45e50aec44..0000000000 --- a/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/getpartialresult.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - - MongoDB\Driver\Exception\BulkWriteCommandException::getPartialResult - Devuelve el resultado de todas las operaciones de escritura exitosas - - - - &reftitle.description; - - final public MongoDB\Driver\BulkWriteCommandResultnullMongoDB\Driver\Exception\BulkWriteCommandException::getPartialResult - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un MongoDB\Driver\BulkWriteCommandResult - que proporciona los resultados de cada una de las operaciones exitosas que se realizaron antes - de que se encontrara el error. El valor devuelto será &null; si no se puede - determinar si al menos una escritura se realizó con éxito (y - fue reconocida). - - - - - &reftitle.examples; - - Resultado parcial si al menos una escritura es exitosa - -deleteMany('db.coll', []); -$bulk->insertOne('db.coll', ['_id' => 1]); -$bulk->insertOne('db.coll', ['_id' => 1]); - -try { - $result = $manager->executeBulkWriteCommand($bulk); -} catch (MongoDB\Driver\Exception\BulkWriteCommandException $e) { - $result = $e->getPartialResult(); -} - -var_dump($result?->getInsertedCount()); - -?> -]]> - - &example.outputs; - - - - - - Ningún resultado parcial si ninguna escritura es exitosa - -deleteMany('db.coll', []); -$bulk->insertOne('db.coll', ['_id' => 1]); -$manager->executeBulkWriteCommand($bulk); - -$bulk = new MongoDB\Driver\BulkWriteCommand; -$bulk->insertOne('db.coll', ['_id' => 1]); - -try { - $result = $manager->executeBulkWriteCommand($bulk); -} catch (MongoDB\Driver\Exception\BulkWriteCommandException $e) { - $result = $e->getPartialResult(); -} - -var_dump($result?->getInsertedCount()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommandResult - MongoDB\Driver\Manager::executeBulkWriteCommand - - - - - - diff --git a/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/getwriteconcernerrors.xml b/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/getwriteconcernerrors.xml deleted file mode 100644 index 816711d81c..0000000000 --- a/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/getwriteconcernerrors.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - - MongoDB\Driver\Exception\BulkWriteCommandException::getWriteConcernErrors - Devuelve los errores de preocupación de escritura - - - - &reftitle.description; - - final public arrayMongoDB\Driver\Exception\BulkWriteCommandException::getWriteConcernErrors - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un array de cada uno de los MongoDB\Driver\WriteConcernErrors - que se produjeron durante la ejecución de la escritura masiva. Esta lista puede tener - múltiples entradas si se necesitó más de un comando de servidor para ejecutar la - escritura masiva. - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\Exception\BulkWriteCommandException::getWriteConcernErrors</function> - -insertOne('db.coll', ['x' => 1]); - -$writeConcern = new MongoDB\Driver\WriteConcern(50); - -try { - $result = $manager->executeBulkWriteCommand($bulk, ['writeConcern' => $writeConcern]); -} catch (MongoDB\Driver\Exception\BulkWriteCommandException $e) { - var_dump($e->getWriteConcernErrors()); -} - -?> -]]> - - &example.outputs.similar; - - - object(MongoDB\Driver\WriteConcernError)#6 (3) { - ["message"]=> - string(29) "Not enough data-bearing nodes" - ["code"]=> - int(100) - ["info"]=> - object(stdClass)#8 (1) { - ["writeConcern"]=> - object(stdClass)#7 (3) { - ["w"]=> - int(50) - ["wtimeout"]=> - int(0) - ["provenance"]=> - string(14) "clientSupplied" - } - } - } -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeBulkWriteCommand - MongoDB\Driver\WriteConcern - MongoDB\Driver\WriteConcernError - - - - - - diff --git a/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/getwriteerrors.xml b/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/getwriteerrors.xml deleted file mode 100644 index 7317b4f3a0..0000000000 --- a/reference/mongodb/mongodb/driver/exception/bulkwritecommandexception/getwriteerrors.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - MongoDB\Driver\Exception\BulkWriteCommandException::getWriteErrors - Devuelve los errores de escritura - - - - &reftitle.description; - - final public arrayMongoDB\Driver\Exception\BulkWriteCommandException::getWriteErrors - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un array de MongoDB\Driver\WriteError que se - produjeron durante la ejecución de la escritura individual. Las claves del array - corresponden al índice de la operación de escritura en - MongoDB\Driver\BulkWriteCommand. Esta lista - contendrá como máximo una entrada si la escritura masiva estaba ordenada. - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\Exception\BulkWriteCommandException::getWriteErrors</function> - - false]); -$bulk->deleteMany('db.coll', []); -$bulk->insertOne('db.coll', ['_id' => 1]); -$bulk->insertOne('db.coll', ['_id' => 1]); -$bulk->insertOne('db.coll', ['_id' => 1]); - -try { - $result = $manager->executeBulkWriteCommand($bulk); -} catch (MongoDB\Driver\Exception\BulkWriteCommandException $e) { - var_dump($e->getWriteErrors()); -} - -?> -]]> - - &example.outputs.similar; - - - object(MongoDB\Driver\WriteError)#5 (4) { - ["message"]=> - string(78) "E11000 duplicate key error collection: db.coll index: _id_ dup key: { _id: 1 }" - ["code"]=> - int(11000) - ["index"]=> - int(2) - ["info"]=> - object(stdClass)#6 (0) { - } - } - [3]=> - object(MongoDB\Driver\WriteError)#7 (4) { - ["message"]=> - string(78) "E11000 duplicate key error collection: db.coll index: _id_ dup key: { _id: 1 }" - ["code"]=> - int(11000) - ["index"]=> - int(3) - ["info"]=> - object(stdClass)#8 (0) { - } - } -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeBulkWriteCommand - MongoDB\Driver\WriteError - - - - - - diff --git a/reference/mongodb/mongodb/driver/exception/bulkwriteexception.xml b/reference/mongodb/mongodb/driver/exception/bulkwriteexception.xml deleted file mode 100644 index 2a7fef2b29..0000000000 --- a/reference/mongodb/mongodb/driver/exception/bulkwriteexception.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - - La clase MongoDB\Driver\Exception\BulkWriteException - MongoDB\Driver\Exception\BulkWriteException - - - - -
    - &reftitle.intro; - - Se levanta cuando una operación de escritura en bloque falla. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\BulkWriteException - - - - final - - MongoDB\Driver\Exception\BulkWriteException - - - - extends - MongoDB\Driver\Exception\ServerException - - - - MongoDB\Driver\Exception\Exception - - - - &Properties; - - public - readonly - MongoDB\Driver\WriteResult - writeResult - - &InheritedProperties; - - - - - - &Methods; - - - &InheritedMethods; - - - - - - - - -
    - - -
    - &reftitle.properties; - - - writeResult - - - El MongoDB\Driver\WriteResult asociado a la operación de escritura - fallida. - - - - -
    - - -
    - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - La propiedad writeResult ahora es - public readonly. - - - - PECL mongodb 2.0.0 - - - Esta clase extiende ahora - MongoDB\Driver\Exception\ServerException - en lugar de - MongoDB\Driver\Exception\WriteException. - - - - - - - -
    - -
    - &reference.mongodb.mongodb.driver.exception.entities.bulkwriteexception; - -
    - - diff --git a/reference/mongodb/mongodb/driver/exception/bulkwriteexception/getwriteresult.xml b/reference/mongodb/mongodb/driver/exception/bulkwriteexception/getwriteresult.xml deleted file mode 100644 index b44f2a5795..0000000000 --- a/reference/mongodb/mongodb/driver/exception/bulkwriteexception/getwriteresult.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - MongoDB\Driver\Exception\BulkWriteException::getWriteResult - Devuelve el WriteResult para la operación de escritura fallida - - - - &reftitle.description; - - final public MongoDB\Driver\WriteResultMongoDB\Driver\Exception\BulkWriteException::getWriteResult - - - - Devuelve el MongoDB\Driver\WriteResult para la operación - de escritura fallida. Los métodos - MongoDB\Driver\WriteResult::getWriteErrors y - MongoDB\Driver\WriteResult::getWriteConcernError - pueden ser utilizados para obtener detalles adicionales sobre el error. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El MongoDB\Driver\WriteResult para la operación - de escritura fallida. - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\Exception\BulkWriteException::getWriteResult</function> - -insert(['_id' => 1]); -$bulk->insert(['_id' => 1]); - -try { - $manager->executeBulkWrite('db.collection', $bulk); -} catch (MongoDB\Driver\Exception\BulkWriteException $e) { - $writeResult = $e->getWriteResult(); - - if ($writeConcernError = $writeResult->getWriteConcernError()) { - var_dump($writeConcernError); - } - - if ($writeErrors = $writeResult->getWriteErrors()) { - var_dump($writeErrors); - } -} - -?> -]]> - - &example.outputs.similar; - - - object(MongoDB\Driver\WriteError)#5 (4) { - ["message"]=> - string(70) "E11000 duplicate key error index: db.collection.$_id_ dup key: { : 1 }" - ["code"]=> - int(11000) - ["index"]=> - int(1) - ["info"]=> - NULL - } -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteResult - MongoDB\Driver\Manager::executeBulkWrite - - - - - - diff --git a/reference/mongodb/mongodb/driver/exception/commandexception.xml b/reference/mongodb/mongodb/driver/exception/commandexception.xml deleted file mode 100644 index ae50f7e25d..0000000000 --- a/reference/mongodb/mongodb/driver/exception/commandexception.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - La clase MongoDB\Driver\Exception\CommandException - MongoDB\Driver\Exception\CommandException - - - - -
    - &reftitle.intro; - - Lanzada cuando una orden falla. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\CommandException - - - - - MongoDB\Driver\Exception\CommandException - - - - extends - MongoDB\Driver\Exception\ServerException - - - - MongoDB\Driver\Exception\Exception - - - - &Properties; - - public - readonly - object - resultDocument - - - &InheritedProperties; - - - - - - &Methods; - - - &InheritedMethods; - - - - - - - - -
    - - -
    - &reftitle.properties; - - - resultDocument - - - El resultado del documento asociado a la orden fallida. - - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - La propiedad resultDocument ahora es - public readonly. - - - - - -
    - -
    - - &reference.mongodb.mongodb.driver.exception.entities.commandexception; - -
    - - diff --git a/reference/mongodb/mongodb/driver/exception/commandexception/getresultdocument.xml b/reference/mongodb/mongodb/driver/exception/commandexception/getresultdocument.xml deleted file mode 100644 index 97a0bf6255..0000000000 --- a/reference/mongodb/mongodb/driver/exception/commandexception/getresultdocument.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - MongoDB\Driver\Exception\CommandException::getResultDocument - Devuelve el documento resultante para el comando fallido - - - - &reftitle.description; - - final public objectMongoDB\Driver\Exception\CommandException::getResultDocument - - - - Devuelve el documento resultante para el comando fallido. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El documento resultante para el comando fallido. - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeCommand - - - - - - diff --git a/reference/mongodb/mongodb/driver/exception/connectionexception.xml b/reference/mongodb/mongodb/driver/exception/connectionexception.xml deleted file mode 100644 index 3455704de4..0000000000 --- a/reference/mongodb/mongodb/driver/exception/connectionexception.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - La clase MongoDB\Driver\Exception\ConnectionException - MongoDB\Driver\Exception\ConnectionException - - - - -
    - &reftitle.intro; - - Clase base para las excepciones lanzadas cuando el controlador no logra - establecer una conexión con la base de datos. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\ConnectionException - - - - - MongoDB\Driver\Exception\ConnectionException - - - - extends - MongoDB\Driver\Exception\RuntimeException - - - - MongoDB\Driver\Exception\Exception - - - - &InheritedProperties; - - - - - &InheritedMethods; - - - - - - - -
    - -
    - -
    - - diff --git a/reference/mongodb/mongodb/driver/exception/connectiontimeoutexception.xml b/reference/mongodb/mongodb/driver/exception/connectiontimeoutexception.xml deleted file mode 100644 index 66570b6e25..0000000000 --- a/reference/mongodb/mongodb/driver/exception/connectiontimeoutexception.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - La clase MongoDB\Driver\Exception\ConnectionTimeoutException - MongoDB\Driver\Exception\ConnectionTimeoutException - - - - -
    - &reftitle.intro; - - Se lanza cuando el controlador no logra establecer una conexión con la base de - datos dentro del límite de tiempo especificado - (connectTimeoutMS) - o falla la selección del servidor - (serverSelectionTimeoutMS). - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\ConnectionTimeoutException - - - - final - - MongoDB\Driver\Exception\ConnectionTimeoutException - - - - extends - MongoDB\Driver\Exception\ConnectionException - - - - MongoDB\Driver\Exception\Exception - - - - &InheritedProperties; - - - - - - &InheritedMethods; - - - - - - - - -
    - -
    - -
    - - diff --git a/reference/mongodb/mongodb/driver/exception/encryptionexception.xml b/reference/mongodb/mongodb/driver/exception/encryptionexception.xml deleted file mode 100644 index de5452636e..0000000000 --- a/reference/mongodb/mongodb/driver/exception/encryptionexception.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - La clase MongoDB\Driver\Exception\EncryptionException - MongoDB\Driver\Exception\EncryptionException - - - - -
    - &reftitle.intro; - - Clase base para excepciones lanzadas durante la cifrado lado-cliente. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\EncryptionException - - - - - MongoDB\Driver\Exception\EncryptionException - - - - extends - MongoDB\Driver\Exception\RuntimeException - - - - MongoDB\Driver\Exception\Exception - - - - &InheritedProperties; - - - - - &InheritedMethods; - - - - - - - -
    - -
    - -
    - - diff --git a/reference/mongodb/mongodb/driver/exception/exception.xml b/reference/mongodb/mongodb/driver/exception/exception.xml deleted file mode 100644 index 52153b21f8..0000000000 --- a/reference/mongodb/mongodb/driver/exception/exception.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - La interfaz MongoDB\Driver\Exception\Exception - MongoDB\Driver\Exception\Exception - - - - -
    - &reftitle.intro; - - Interfaz común para todas las excepciones de la extensión. Esta interfaz también es - utilizada por la biblioteca y puede emplearse para identificar cualquier excepción - originada en el controlador PHP de MongoDB (es decir, la extensión y la biblioteca). - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\Exception - - - - - MongoDB\Driver\Exception\Exception - - - - - - - -
    - -
    - -
    - - diff --git a/reference/mongodb/mongodb/driver/exception/executiontimeoutexception.xml b/reference/mongodb/mongodb/driver/exception/executiontimeoutexception.xml deleted file mode 100644 index 08d6e9c61f..0000000000 --- a/reference/mongodb/mongodb/driver/exception/executiontimeoutexception.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - La clase MongoDB\Driver\Exception\ExecutionTimeoutException - MongoDB\Driver\Exception\ExecutionTimeoutException - - - - -
    - &reftitle.intro; - - Se lanza cuando una consulta o comando no logra completarse dentro del - tiempo límite especificado (por ejemplo, - maxTimeMS). - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\ExecutionTimeoutException - - - - final - - MongoDB\Driver\Exception\ExecutionTimeoutException - - - - extends - MongoDB\Driver\Exception\ServerException - - - - MongoDB\Driver\Exception\Exception - - - - &InheritedProperties; - - - - - - &InheritedMethods; - - - - - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.5.0 - - - Esta clase ahora extiende - MongoDB\Driver\Exception\ServerException - en lugar de - MongoDB\Driver\Exception\RuntimeException. - - - - - - -
    - -
    - -
    - - diff --git a/reference/mongodb/mongodb/driver/exception/invalidargumentexception.xml b/reference/mongodb/mongodb/driver/exception/invalidargumentexception.xml deleted file mode 100644 index cdecd1897d..0000000000 --- a/reference/mongodb/mongodb/driver/exception/invalidargumentexception.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - La clase MongoDB\Driver\Exception\InvalidArgumentException - MongoDB\Driver\Exception\InvalidArgumentException - - - - -
    - &reftitle.intro; - - Se lanza cuando un método del controlador recibe argumentos no válidos (por - ejemplo, tipos de opciones no válidos). - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\InvalidArgumentException - - - - - MongoDB\Driver\Exception\InvalidArgumentException - - - - extends - InvalidArgumentException - - - - MongoDB\Driver\Exception\Exception - - - - &InheritedProperties; - - - - &InheritedMethods; - - - - - - -
    - -
    - -
    - - diff --git a/reference/mongodb/mongodb/driver/exception/logicexception.xml b/reference/mongodb/mongodb/driver/exception/logicexception.xml deleted file mode 100644 index 622dddb4ee..0000000000 --- a/reference/mongodb/mongodb/driver/exception/logicexception.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - La clase MongoDB\Driver\Exception\LogicException - MongoDB\Driver\Exception\LogicException - - - - -
    - &reftitle.intro; - - Se lanza cuando el controlador se usa incorrectamente (p. ej. retrocediendo un cursor). - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\LogicException - - - - - MongoDB\Driver\Exception\LogicException - - - - extends - LogicException - - - - MongoDB\Driver\Exception\Exception - - - - &InheritedProperties; - - - - &InheritedMethods; - - - - - - -
    - -
    - -
    - - diff --git a/reference/mongodb/mongodb/driver/exception/runtimeexception.xml b/reference/mongodb/mongodb/driver/exception/runtimeexception.xml deleted file mode 100644 index 4428084bdd..0000000000 --- a/reference/mongodb/mongodb/driver/exception/runtimeexception.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - La clase MongoDB\Driver\Exception\RuntimeException - MongoDB\Driver\Exception\RuntimeException - - - - -
    - &reftitle.intro; - - Se lanza cuando el controlador encuentra un error en tiempo de ejecución (por ejemplo, error interno de - libmongoc). - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\RuntimeException - - - - - MongoDB\Driver\Exception\RuntimeException - - - - extends - RuntimeException - - - - MongoDB\Driver\Exception\Exception - - - - &Properties; - - protected - arraynull - errorLabels - - - &InheritedProperties; - - - - &Methods; - - - &InheritedMethods; - - - - - - -
    - - -
    - &reftitle.properties; - - - errorLabels - - - Contiene un array de etiquetas de error asociadas a una excepción. Por ejemplo, las etiquetas de error - pueden usarse para detectar si una transacción puede volver a intentarse de forma segura si está - presente la etiqueta TransientTransactionError. La existencia de una etiqueta de - error específica debe verificarse con el método - MongoDB\Driver\Exception\RuntimeException::hasErrorLabel, - en lugar de interpretar manualmente esta propiedad errorLabels. - - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.6.0 - - - Se han añadido el método - MongoDB\Driver\Exception\RuntimeException::hasErrorLabel - y la propiedad - MongoDB\Driver\Exception\RuntimeException::errorLabels. - - - - - - -
    - -
    - - &reference.mongodb.mongodb.driver.exception.entities.runtimeexception; - -
    - - diff --git a/reference/mongodb/mongodb/driver/exception/runtimeexception/haserrorlabel.xml b/reference/mongodb/mongodb/driver/exception/runtimeexception/haserrorlabel.xml deleted file mode 100644 index 8a8dd83f71..0000000000 --- a/reference/mongodb/mongodb/driver/exception/runtimeexception/haserrorlabel.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - MongoDB\Driver\Exception\RuntimeException::hasErrorLabel - Devuelve si un label de error está asociado con una excepción - - - - &reftitle.description; - - final public boolMongoDB\Driver\Exception\RuntimeException::hasErrorLabel - stringerrorLabel - - - Devuelve si el errorLabel ha sido definido para esta excepción. - Los labels de error son definidos por el servidor o por la extensión para - indicar situaciones específicas donde se desea decidir cómo manejar - una excepción específica. Una situación común sería determinar si se puede - relanzar una transacción que ha fallado debido a un error pasajero - (como un error de red o un conflicto de transacción) sin problemas. - Ejemplos de labels de error son TransientTransactionError - y UnknownTransactionCommitResult. - - - - - - &reftitle.parameters; - - - errorLabel - - El nombre del errorLabel a verificar. - - - - - - - &reftitle.returnvalues; - - Si el errorLabel proporcionado está asociado con esta - excepción. - - - - - &reftitle.seealso; - - MongoDB\Driver\Session::commitTransaction - Documentación de MongoDB sobre las transacciones - - - - - - diff --git a/reference/mongodb/mongodb/driver/exception/serverexception.xml b/reference/mongodb/mongodb/driver/exception/serverexception.xml deleted file mode 100644 index 3f97863ac4..0000000000 --- a/reference/mongodb/mongodb/driver/exception/serverexception.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - La clase MongoDB\Driver\Exception\ServerException - MongoDB\Driver\Exception\ServerException - - - - -
    - &reftitle.intro; - - Clase base para las excepciones lanzadas por el servidor. El código de esta excepción y sus subclases corresponderá al código de error original del servidor. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\ServerException - - - - - MongoDB\Driver\Exception\ServerException - - - - extends - MongoDB\Driver\Exception\RuntimeException - - - - MongoDB\Driver\Exception\Exception - - - - &InheritedProperties; - - - - - &InheritedMethods; - - - - - - - -
    - -
    - -
    - - diff --git a/reference/mongodb/mongodb/driver/exception/sslconnectionexception.xml b/reference/mongodb/mongodb/driver/exception/sslconnectionexception.xml deleted file mode 100644 index 47485c5ed7..0000000000 --- a/reference/mongodb/mongodb/driver/exception/sslconnectionexception.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - La clase MongoDB\Driver\Exception\SSLConnectionException - MongoDB\Driver\Exception\SSLConnectionException - - - - - - Esta clase de excepción está DEPRECADA a partir de la versión 1.5.0 - de la extensión y fue eliminada en la versión 2.0. Esta excepción nunca fue - lanzada por la extensión. Las aplicaciones deben usar - MongoDB\Driver\Exception\ConnectionException en su lugar. - - - - -
    - &reftitle.intro; - - Se lanza cuando el controlador no puede establecer una conexión SSL con el servidor. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\SSLConnectionException - - - - final - - MongoDB\Driver\Exception\SSLConnectionException - - - - extends - MongoDB\Driver\Exception\ConnectionException - - - - MongoDB\Driver\Exception\Exception - - - - &InheritedProperties; - - - - - - &InheritedMethods; - - - - - - - - -
    - -
    - -
    - - diff --git a/reference/mongodb/mongodb/driver/exception/unexpectedvalueexception.xml b/reference/mongodb/mongodb/driver/exception/unexpectedvalueexception.xml deleted file mode 100644 index c51630eb39..0000000000 --- a/reference/mongodb/mongodb/driver/exception/unexpectedvalueexception.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - La clase MongoDB\Driver\Exception\UnexpectedValueException - MongoDB\Driver\Exception\UnexpectedValueException - - - - -
    - &reftitle.intro; - - Lanzada cuando el controlador encuentra un valor inesperado (por ejemplo, durante la serialización - o deserialización BSON). - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\UnexpectedValueException - - - - - MongoDB\Driver\Exception\UnexpectedValueException - - - - extends - UnexpectedValueException - - - - MongoDB\Driver\Exception\Exception - - - - &InheritedProperties; - - - - &InheritedMethods; - - - - - - -
    - -
    - -
    - - diff --git a/reference/mongodb/mongodb/driver/exception/writeexception.xml b/reference/mongodb/mongodb/driver/exception/writeexception.xml deleted file mode 100644 index 8786285f23..0000000000 --- a/reference/mongodb/mongodb/driver/exception/writeexception.xml +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - - La clase MongoDB\Driver\Exception\WriteException - MongoDB\Driver\Exception\WriteException - - - - - - Esta clase de excepción está DEPRECADA desde la versión 1.20.0 de la extensión - y ha sido eliminada en la versión 2.0. - Esta excepción nunca fue lanzada directamente por la extensión. - Las aplicaciones deberían utilizar MongoDB\Driver\Exception\BulkWriteException - en su lugar. - - - - -
    - &reftitle.intro; - - Clase base para las excepciones lanzadas por una operación de escritura - fallida. La excepción encapsula un objeto MongoDB\Driver\WriteResult. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Exception\WriteException - - - - - abstract - MongoDB\Driver\Exception\WriteException - - - - extends - MongoDB\Driver\Exception\ServerException - - - - MongoDB\Driver\Exception\Exception - - - - &Properties; - - protected - MongoDB\Driver\WriteResult - writeResult - - - &InheritedProperties; - - - - - - &Methods; - - - &InheritedMethods; - - - - - - - - -
    - - -
    - &reftitle.properties; - - - writeResult - - - MongoDB\Driver\WriteResult asociado a la operación - de escritura fallida. - - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.class-removed; - - PECL mongodb 1.20.0 - - Esta clase ha sido deprecada y será eliminada en la versión 2.0. - - - - PECL mongodb 1.5.0 - - - Esta clase ahora extiende - MongoDB\Driver\Exception\ServerException - en lugar de - MongoDB\Driver\Exception\RuntimeException. - - - - - - -
    - -
    - - &reference.mongodb.mongodb.driver.exception.entities.writeexception; - -
    - - diff --git a/reference/mongodb/mongodb/driver/exception/writeexception/getwriteresult.xml b/reference/mongodb/mongodb/driver/exception/writeexception/getwriteresult.xml deleted file mode 100644 index 126c9095bd..0000000000 --- a/reference/mongodb/mongodb/driver/exception/writeexception/getwriteresult.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - - - MongoDB\Driver\Exception\WriteException::getWriteResult - Devuelve el WriteResult para la operación de escritura que falló - - - - &reftitle.description; - - final public MongoDB\Driver\WriteResultMongoDB\Driver\Exception\WriteException::getWriteResult - - - - Devuelve el MongoDB\Driver\WriteResult para la operación de escritura - que falló. Los métodos - MongoDB\Driver\WriteResult::getWriteErrors y - MongoDB\Driver\WriteResult::getWriteConcernError - pueden ser utilizados para recuperar más detalles sobre el fallo. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El MongoDB\Driver\WriteResult para la operación de escritura - que falló. - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\Driver\Exception\WriteException::getWriteResult</function> - -insert(['_id' => 1]); -$bulk->insert(['_id' => 1]); - -try { - $manager->executeBulkWrite('db.collection', $bulk); -} catch (MongoDB\Driver\Exception\WriteException $e) { - $writeResult = $e->getWriteResult(); - - if ($writeConcernError = $writeResult->getWriteConcernError()) { - var_dump($writeConcernError); - } - - if ($writeErrors = $writeResult->getWriteErrors()) { - var_dump($writeErrors); - } -} - -?> -]]> - - &example.outputs.similar; - - - object(MongoDB\Driver\WriteError)#5 (4) { - ["message"]=> - string(70) "E11000 duplicate key error index: db.collection.$_id_ dup key: { : 1 }" - ["code"]=> - int(11000) - ["index"]=> - int(1) - ["info"]=> - NULL - } -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteResult - MongoDB\Driver\Manager::executeBulkWrite - - - - - - diff --git a/reference/mongodb/mongodb/driver/manager.xml b/reference/mongodb/mongodb/driver/manager.xml deleted file mode 100644 index 0b2bb943bb..0000000000 --- a/reference/mongodb/mongodb/driver/manager.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - La clase MongoDB\Driver\Manager - MongoDB\Driver\Manager - - - - -
    - &reftitle.intro; - - La clase MongoDB\Driver\Manager es el punto de entrada - principal a la extensión. Es responsable de mantener las conexiones a MongoDB - (ya sea un servidor independiente, un conjunto de réplicas o un clúster particionado). - - - No se realiza ninguna conexión a MongoDB al instanciar el Manager. - Esto significa que el MongoDB\Driver\Manager siempre puede - ser construido, incluso si uno o más servidores de MongoDB están caídos. - - - Cualquier escritura o consulta puede lanzar excepciones de conexión ya que las conexiones - se crean de forma perezosa. Un servidor de MongoDB también puede volverse no disponible - durante la ejecución del script. Por lo tanto, es importante envolver todas las acciones - sobre el Manager en sentencias try/catch. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Manager - - - - final - - MongoDB\Driver\Manager - - - - - &Methods; - - - - -
    - -
    - &reftitle.examples; - - - Ejemplo básico de <function>MongoDB\Driver\Manager::__construct</function> - - Realizar un var_dump de un - MongoDB\Driver\Manager mostrará varios detalles - sobre el gestor que normalmente no están expuestos. Esto puede ser útil - para depurar cómo el controlador visualiza su configuración de MongoDB y - qué opciones se están utilizando. - - - -]]> - - &example.outputs.similar; - - - string(26) "mongodb://127.0.0.1:27017/" - ["cluster"]=> - array(0) { - } -} -]]> - - -
    -
    - - &reference.mongodb.mongodb.driver.entities.manager; - -
    - - diff --git a/reference/mongodb/mongodb/driver/manager/addsubscriber.xml b/reference/mongodb/mongodb/driver/manager/addsubscriber.xml deleted file mode 100644 index b5ae4513d9..0000000000 --- a/reference/mongodb/mongodb/driver/manager/addsubscriber.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - MongoDB\Driver\Manager::addSubscriber - Registra un observador de eventos de monitoreo con este manager - - - - &reftitle.description; - - final public voidMongoDB\Driver\Manager::addSubscriber - MongoDB\Driver\Monitoring\Subscribersubscriber - - - Registra un observador de eventos de monitoreo con este Manager. El observador - será notificado de todos los eventos para este Manager. - - - - Si subscriber ya está registrado con este manager, esta - función no hace nada. Si subscriber también está - registrado globalmente, solo será notificado una vez de cada evento para este manager. - - - - - - &reftitle.parameters; - - - subscriber (MongoDB\Driver\Monitoring\Subscriber) - - - Un observador de eventos de monitoreo a registrar con este Manager. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - Lanza una - MongoDB\Driver\Exception\InvalidArgumentException si - subscriber es un - MongoDB\Driver\Monitoring\LogSubscriber, ya que los - observadores solo pueden ser registrados globalmente. - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::removeSubscriber - MongoDB\Driver\Monitoring\Subscriber - MongoDB\Driver\Monitoring\CommandSubscriber - MongoDB\Driver\Monitoring\addSubscriber - - - - - - - diff --git a/reference/mongodb/mongodb/driver/manager/construct.xml b/reference/mongodb/mongodb/driver/manager/construct.xml deleted file mode 100644 index fc423429c3..0000000000 --- a/reference/mongodb/mongodb/driver/manager/construct.xml +++ /dev/null @@ -1,1290 +0,0 @@ - - - - - - MongoDB\Driver\Manager::__construct - Crea un nuevo Manager MongoDB - - - - &reftitle.description; - - final public MongoDB\Driver\Manager::__construct - stringnulluri&null; - arraynulluriOptions&null; - arraynulldriverOptions&null; - - - Construye un nuevo objeto MongoDB\Driver\Manager con las opciones especificadas. - - - - Con la Especificación de descubrimiento y supervisión del servidor, - este constructor no realiza E/S. Las conexiones se inicializarán bajo demanda, - durante la ejecución de la primera operación. - - - - - Cuando se especifican opciones de URI SSL o TLS a través de la cadena de conexión o el - parámetro uriOptions, la extensión activará implícitamente TLS para sus conexiones. - Para evitar esto, desactive explícitamente la opción - tls o no especifique ninguna opción TLS. - - - &mongodb.note.forking; - - - - &reftitle.parameters; - - - uri - - - Una URI de conexión mongodb://: - - - - - - Para los detalles sobre las opciones de URI admitidas, ver - Opciones de cadena de conexión - en el manual MongoDB. - Opciones de pool de conexiones - no son admitidas, ya que la extensión no implementa pools de conexiones. - - - Por omisión, "mongodb://127.0.0.1:27017" si no se especifica. - - - El uri es una URL, por lo que todos los caracteres especiales en - sus componentes deben estar codificados en URL según la - RFC 3986. Esto es particularmente - relevante para el nombre de usuario y la contraseña, que pueden incluir caracteres especiales tales como - @, : o %. - Al conectarse a través de un socket de dominio Unix, la ruta del socket - puede contener caracteres especiales como barras diagonales y debe estar codificada. - La función rawurlencode puede ser utilizada para codificar - las partes constitutivas de la URI. - - - El componente defaultAuthDb puede ser utilizado para especificar la - base de datos asociada a las credenciales del usuario; sin embargo, la opción de URI - authSource tendrá prioridad si se especifica. - Si ni defaultAuthDb ni authSource se especifican, la base de datos - admin será utilizada por omisión. El componente defaultAuthDb - no tiene ningún efecto en ausencia de credenciales de usuario. - - - - - uriOptions - - - Opciones adicionales - de cadena de conexión, - que sobrescribirán cualquier opción con el mismo nombre en el parámetro - uri. - - - - uriOptions - - - - Opción - Tipo - Descripción - - - - - appname - string - - - MongoDB 3.4+ tiene la capacidad de anotar las conexiones con metadatos - proporcionados por el cliente conectado. Estos metadatos se incluyen en los - registros del servidor al establecer una conexión y también se registran en - los registros de consultas lentas cuando el perfilado de la base de datos está activado. - - - Esta opción puede ser utilizada para especificar un nombre de aplicación, que será - incluido en los metadatos. El valor no puede exceder 128 caracteres de longitud. - - - - - authMechanism - string - - - El mecanismo de autenticación que MongoDB utilizará para autenticar - la conexión. Para más detalles y una lista de los valores admitidos, ver - Opciones de autenticación - en el manual MongoDB. - - - - - authMechanismProperties - array - - - Las propiedades específicas del mecanismo de autenticación seleccionado. Para más - detalles y una lista de las propiedades admitidas, ver la - Especificación de autenticación del controlador. - - - - Cuando no se especifica en la cadena de URI, esta opción se expresa como - un array de pares clave/valor. Las claves y valores de este array - deben ser strings. - - - - - - authSource - string - - - El nombre de la base de datos asociada a las credenciales del usuario. Por omisión - al componente de la base de datos de la URI de conexión, o a la base de datos - admin si ambos no se especifican. - - - Para los mecanismos de autenticación que no admiten la noción de base de datos - (por ejemplo, GSSAPI), esto debería ser - "$external". - - - - - compressors - string - - - Una lista priorizada y delimitada por comas de compresores que el cliente - desea utilizar. Los mensajes solo se comprimen si el cliente y el servidor - comparten compresores en común, y el compresor utilizado en cada - dirección dependerá de la configuración individual del servidor - o del controlador. Ver la - Especificación de compresión del controlador - para más información. - - - - - connectTimeoutMS - int - - - El tiempo en milisegundos para intentar una conexión antes de expirar. - Por omisión, 10 000 milisegundos. - - - - - directConnection - bool - - - Esta opción puede ser utilizada para controlar el comportamiento de descubrimiento del conjunto de réplicas - cuando solo se proporciona un host en la cadena de conexión. - Por omisión, proporcionar un solo miembro en la cadena de conexión - establecerá una conexión directa o descubrirá miembros adicionales - según si la opción de URI "replicaSet" está omitida o presente, - respectivamente. Especifique &false; para forzar el descubrimiento a que ocurra - (si "replicaSet" está omitido) - o especifique &true; para forzar una conexión directa (si - "replicaSet" está presente). - - - - - enableOverloadRetargeting - bool - - - Cuando se establece a &true;, fuerza la selección del servidor tras un - SystemOverloadedError. Por omisión, &false;. - - - - - heartbeatFrequencyMS - int - - - Especifica el intervalo en milisegundos entre las verificaciones de la topología MongoDB, - contado desde el final de la verificación previa hasta el inicio de la siguiente. - Por omisión, 60 000 milisegundos. - - - Para la - Especificación de descubrimiento y supervisión del servidor, - este valor no puede ser inferior a 500 milisegundos. - - - - - journal - bool - - - Corresponde a la opción journal del write concern por omisión. - Si &true;, las escrituras requerirán un acuse de recibo de MongoDB indicando que la operación ha sido - escrita en el diario. Para más detalles, ver - MongoDB\Driver\WriteConcern. - - - - - loadBalanced - bool - - - Especifica si el controlador se conecta a un clúster MongoDB a través - de un equilibrador de carga. Si &true;, el controlador solo puede conectarse a - un solo host (especificado por la cadena de conexión o la búsqueda SRV), - la opción de URI "directConnection" no puede - ser &true;, y la opción de URI "replicaSet" - debe ser omitida. Por omisión, &false;. - - - - - localThresholdMS - int - - - El tamaño en milisegundos de la ventana de latencia para la selección entre - múltiples instancias MongoDB apropiadas al resolver una preferencia de lectura. - Por omisión, 15 milisegundos. - - - - - maxAdaptiveRetries - int - - - Esta opción puede ser utilizada para cambiar el número máximo de reintentos - cuando se produce un SystemOverloadedError. Debe ser un - entero positivo; por omisión, 2. - - - - - maxStalenessSeconds - int - - - Corresponde a la opción maxStalenessSeconds de la preferencia de lectura. - Especifica, en segundos, la duración máxima de validez de una instancia secundaria antes de que el cliente deje de usarla para las - operaciones de lectura. Por omisión, no hay una duración máxima de validez y - los clientes no tendrán en cuenta el retraso de una instancia secundaria al elegir la dirección de una operación de lectura. Para más detalles, ver - MongoDB\Driver\ReadPreference. - - - Si se especifica, la duración máxima de validez debe ser un entero de 32 bits firmado - superior o igual a - MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS - (por ejemplo, 90 segundos). - - - - - password - string - - La contraseña del usuario en proceso de autenticación. Esta opción es útil - si la contraseña contiene caracteres especiales, que de otro modo - deberían estar codificados en URL para la URI de conexión. - - - - readConcernLevel - string - - Corresponde a la opción level de la preferencia de lectura. - Especifica el nivel de aislamiento de lectura. Para más detalles, ver - MongoDB\Driver\ReadConcern. - - - - readPreference - string - - - Corresponde a la opción mode de la preferencia de lectura. - Por omisión, "primary". Para más detalles, ver - MongoDB\Driver\ReadPreference. - - - - - readPreferenceTags - array - - - Corresponde a la opción tagSets de la preferencia de lectura. - Los conjuntos de etiquetas permiten dirigir las operaciones de lectura a - miembros específicos de un conjunto de réplicas. Para más detalles, - ver MongoDB\Driver\ReadPreference. - - - - Cuando no se especifica en la cadena de URI, esta opción se expresa como - un array conforme al formato esperado por - MongoDB\Driver\ReadPreference::__construct. - - - - - - replicaSet - string - - - Especifica el nombre del conjunto de réplicas. - - - - - retryReads - bool - - - Especifica si el controlador debe reintentar automáticamente - ciertas operaciones de lectura que fallan debido a errores de red transitorios - o elecciones de conjunto de réplicas. Esta funcionalidad requiere MongoDB 3.6+. Por omisión, &true;. - - - Ver la - Especificación de lectura reintentable - para más información. - - - - - retryWrites - bool - - - Especifica si el controlador debe reintentar automáticamente - ciertas operaciones de escritura que fallan debido a errores de red transitorios - o elecciones de conjunto de réplicas. Esta funcionalidad requiere MongoDB 3.6+. Por omisión, &true;. - - - Ver - Escrituras reintentables - en el manual MongoDB para más información. - - - - - serverSelectionTimeoutMS - int - - - Especifica cuánto tiempo en milisegundos bloquear para la selección del servidor - antes de lanzar una excepción. Por omisión, 30 000 milisegundos. - - - - - serverSelectionTryOnce - bool - - - Cuando &true;, indica al controlador que escanee el despliegue MongoDB - exactamente una vez después de un fallo de selección del servidor, luego seleccione - un servidor o lance una excepción. Cuando &false;, el controlador bloquea y - busca un servidor hasta el valor de - "serverSelectionTimeoutMS". Por omisión, &true;. - - - - - socketCheckIntervalMS - int - - - Si un socket no ha sido utilizado recientemente, el controlador debe verificarlo a través - de un comando hello antes de usarlo para cualquier - operación. Por omisión, 5 000 milisegundos. - - - - - socketTimeoutMS - int - - - El tiempo en milisegundos para intentar un envío o recepción en un socket - antes de expirar. Por omisión, 300 000 milisegundos (es decir, cinco - minutos). - - - - - srvMaxHosts - int - - - El número máximo de resultados SRV a seleccionar aleatoriamente durante la - primera población de la lista de semillas o, durante la consulta SRV, la adición de nuevos hosts a - la topología. Por omisión, 0 (es decir, sin máximo). - - - - - srvServiceName - string - - - El nombre de servicio a utilizar para la búsqueda SRV en la lista de semillas inicial - y la consulta SRV. Por omisión, "mongodb". - - - - - tls - bool - - - Inicializa la conexión con TLS/SSL si &true;. Por omisión, &false;. - - - - - tlsAllowInvalidCertificates - bool - - - Especifica si el controlador debe generar un error cuando el certificado - TLS del servidor es inválido. Por omisión, &false;. - - - - Desactivar la validación del certificado crea una vulnerabilidad. - - - - - - tlsAllowInvalidHostnames - bool - - - Especifica si el controlador debe generar un error cuando hay un - desacuerdo entre el nombre de host del servidor y el nombre de host especificado por - el certificado TLS. Por omisión, &false;. - - - - Desactivar la validación del certificado crea una vulnerabilidad. Permitir - nombres de host inválidos puede exponer al controlador a una - ataque del hombre del medio. - - - - - - tlsCAFile - string - - - La ruta del archivo que contiene un solo certificado o un conjunto de certificados - de autoridades a considerar confiables al establecer una conexión TLS. - Se utilizará el almacén de certificados del sistema por omisión. - - - - - tlsCertificateKeyFile - string - - - La ruta del archivo de certificado del cliente o del archivo de clave privada del cliente; - en el caso de que ambos sean necesarios, los archivos deben estar - concatenados. - - - - - tlsCertificateKeyFilePassword - string - - - La contraseña para descifrar la clave privada del cliente (es decir, - la opción de URI "tlsCertificateKeyFile") a utilizar - para las conexiones TLS. - - - - - tlsDisableCertificateRevocationCheck - bool - - - Si &true;, el controlador no intentará verificar el estado de revocación del certificado - (por ejemplo, OCSP, CRL). Por omisión, &false;. - - - - - tlsDisableOCSPEndpointCheck - bool - - - Si &true;, el controlador no intentará contactar un punto de extremo de responso OCSP - si es necesario (es decir, una respuesta OCSP no está grapada). Por omisión, &false;. - - - - - tlsInsecure - bool - - - Relaja las restricciones TLS tanto como sea posible. Especificar &true; para - que esta opción tenga el mismo efecto que especificar &true; para las - opciones de URI "tlsAllowInvalidCertificates" y - "tlsAllowInvalidHostnames". Por omisión, &false;. - - - - Desactivar la validación del certificado crea una vulnerabilidad. Permitir - nombres de host inválidos puede exponer al controlador a una - ataque del hombre del medio. - - - - - - username - string - - El nombre de usuario del usuario en proceso de autenticación. Esta opción es útil - si el nombre de usuario contiene caracteres especiales, que de otro modo - deberían estar codificados en URL para la URI de conexión. - - - - w - intstring - - - Corresponde a la opción w del write concern por omisión. - Para más detalles, ver - MongoDB\Driver\WriteConcern. - - - - - wTimeoutMS - intstring - - - Corresponde a la opción wtimeout del write concern - por omisión. Especifica un límite de tiempo, - en milisegundos, para el write concern. Para más detalles, ver - MongoDB\Driver\WriteConcern. - - - Si se especifica, wTimeoutMS debe ser un entero de 32 bits firmado - superior o igual a cero. - - - - - zlibCompressionLevel - int - - - Especifica el nivel de compresión a utilizar para el compresor zlib. Esta - opción no tiene ningún efecto si zlib no está incluido en - la opción de URI "compressors". Ver la - Especificación de compresión del controlador - para más información. - - - - - -
    -
    -
    -
    - - driverOptions - - - - driverOptions - - - - Opción - Tipo - Descripción - - - - - autoEncryption - array - - - Proporciona opciones para activar el cifrado automático a nivel de campo. - La lista de opciones se describe en la - tabla de abajo. - - - - El cifrado automático es una funcionalidad empresarial - que solo se aplica a las operaciones sobre una colección. El cifrado automático no es - admitido para las operaciones sobre una base de datos o una vista, y las operaciones que no - son sorteadas resultarán en un error (ver - libmongocrypt: La lista de autorización de cifrado automático). Para sortear el cifrado automático - para todas las operaciones, establezca bypassAutoEncryption a - &true;. - - - El cifrado automático requiere que el usuario autenticado tenga el - privilegio de acción - listCollections. - - - El cifrado explícito y automático es una funcionalidad de la comunidad. - El controlador siempre puede descifrar automáticamente cuando - bypassAutoEncryption es &true;. - - - - - - ca_dir - string - - - La ruta del directorio de certificados correctamente hashados. Se utilizará el almacén de certificados del sistema - por omisión. - - - - - crl_file - string - La ruta del archivo de lista de revocación de certificados. - - - disableClientPersistence - bool - - - Si &true;, este Manager utilizará un nuevo cliente libmongoc, que no será - persistido ni compartido con otros objetos Manager. Cuando este - objeto Manager es liberado, su cliente será destruido y todas - las conexiones serán cerradas. Por omisión, &false;. - - - - Desactivar la persistencia del cliente no es generalmente recomendado. - - - - - - driver - array - - - Permite a un nivel superior de biblioteca añadir sus propias metadatos - al apretón de manos del servidor. Por omisión, la extensión envía su propio nombre, - versión y plataforma (es decir, versión PHP) en el apretón de manos. Las cadenas - pueden ser especificadas para las claves "name", - "version" y "platform" de este array, y serán - añadidas al campo respectivo(s) - del apretón de manos del servidor. - - - - Las informaciones del apretón de manos están limitadas a 512 bytes. La extensión - truncará los datos del apretón de manos para adaptarse a esta cadena de 512 bytes. Las - bibliotecas de nivel superior están animadas a mantener sus propias metadatos concisas. - - - - - - serverApi - MongoDB\Driver\ServerApi - - - Esta opción se utiliza para declarar una versión de API de servidor para el Manager. - Si se omite, no se declara ninguna versión de API. - - - - - -
    -
    - - Las siguientes opciones son admitidas: - - - Opciones para el cifrado automático - - - - Opción - Tipo - Descripción - - - - &mongodb.option.encryption.keyVaultClient; - &mongodb.option.encryption.keyVaultNamespace; - &mongodb.option.encryption.kmsProviders; - &mongodb.option.encryption.tlsOptions; - - schemaMap - arrayobject - - - Mapea los espacios de nombres de colección a un esquema JSON local. Esto se - utiliza para configurar el cifrado automático. Ver - Reglas de cifrado automático - en el manual MongoDB para más información. Es un error - especificar una colección tanto en schemaMap como - en encryptedFieldsMap. - - - - Proporcionar un schemaMap proporciona más - seguridad que confiar en los esquemas JSON obtenidos del - servidor. Esto protege contra un servidor malintencionado anunciando un falso - esquema JSON, que podría engañar al cliente para enviar - datos no cifrados que deberían estar cifrados. - - - - - Los esquemas proporcionados en el schemaMap solo se aplican - a la configuración del cifrado automático para el cifrado del lado del cliente. - Otras reglas de validación en el esquema JSON no serán - aplicadas por el controlador y resultarán en un error. - - - - - - bypassAutoEncryption - bool - - Si &true;, mongocryptd no será lanzado - automáticamente. Esto se utiliza para desactivar el cifrado automático. - Por omisión, &false;. - - - - bypassQueryAnalysis - bool - - - Si &true;, el análisis automático de las comandos salientes será desactivado y - mongocryptd no será lanzado automáticamente. Esto permite - el caso de uso del cifrado explícito para consultar campos indexados sin requerir - la biblioteca crypt_shared bajo licencia empresarial o - el proceso mongocryptd. Por omisión, &false;. - - - - - encryptedFieldsMap - arrayobject - - - Mapea los espacios de nombres de colección a un documento - encryptedFields. Esto se utiliza para - configurar el cifrado consultable. Ver - Cifrado de campo y consultabilidad - en el manual MongoDB para más información. Es un error - especificar una colección tanto en - encryptedFieldsMap como - en schemaMap. - - - - Proporcionar un encryptedFieldsMap proporciona más - seguridad que confiar en los - encryptedFields obtenidos del servidor. - Esto protege contra un servidor malintencionado anunciando un falso - encryptedFields. - - - - - - extraOptions - array - - - El extraOptions se refieren al - proceso mongocryptd. Las siguientes - opciones son admitidas: - - - mongocryptdURI (string): URI para conectarse a un proceso mongocryptd existente. Por omisión, "mongodb://localhost:27020". - mongocryptdBypassSpawn (bool): Si &true;, impide que el controlador lance mongocryptd. Por omisión, &false;. - mongocryptdSpawnPath (string): Ruta absoluta para buscar el binario mongocryptd. Por omisión, una cadena vacía y consulta las rutas del sistema. - mongocryptdSpawnArgs (array): Array de argumentos de cadena a pasar a mongocryptd al lanzarlo. Por omisión, ["--idleShutdownTimeoutSecs=60"]. - cryptSharedLibPath (string): Ruta absoluta hacia la biblioteca compartida crypt_shared. Por omisión, una cadena vacía y consulta las rutas del sistema. - cryptSharedLibRequired (bool): Si &true;, exige que el controlador cargue crypt_shared. Por omisión, &false;. - - - Ver la Especificación de cifrado del lado del cliente para más información. - - - - - -
    -
    - - - - El cifrado automático es una funcionalidad empresarial que - solo se aplica a las operaciones sobre una colección. El cifrado automático no es - admitido para las operaciones sobre una base de datos o una vista, y las operaciones que - no son sorteadas resultarán en un error. Para sortear el cifrado automático - para todas las operaciones, establezca bypassAutoEncryption=true - en autoEncryption. Para más información sobre las operaciones admitidas, - ver la Especificación de cifrado del lado del cliente. - - -
    -
    -
    -
    - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lanza una excepción MongoDB\Driver\Exception\InvalidArgumentException si un parámetro es de tipo incorrecto - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 2.0.0 - - - La opción de URI "authMechanismProperties" ha sido eliminada. - Utilizar la propiedad "CANONICALIZE_HOST_NAME" de la opción de URI - "authMechanismProperties" en su lugar. - - - La opción de URI "authMechanism" ha sido eliminada. - Utilizar la propiedad "SERVICE_NAME" de la opción de URI - "authMechanismProperties" en su lugar. - - - La opción de URI "authSource" ha sido eliminada. - Utilizar las opciones de URI "w" y "wTimeoutMS" - en su lugar. - - - La opción de URI "ssl" ha sido eliminada. Utilizar la opción - de URI "tls" en su lugar. - - - La opción de controlador "allow_invalid_hostname" ha - sido eliminada. Utilizar la opción de URI - "tlsAllowInvalidHostnames" en su lugar. - - - La opción de controlador "ca_file" ha - sido eliminada. Utilizar la opción de URI - "tlsCAFile" en su lugar. - - - La opción de controlador "context" ha sido eliminada. Todas las - opciones de contexto han sido deprecadas en favor de las diversas opciones - de URI relacionadas con TLS. - - - La opción de controlador "pem_file" ha sido eliminada. Utilizar - la opción de URI "tlsCertificateKeyFile" en su lugar. - - - La opción de controlador "pem_pwd" ha sido eliminada. Utilizar - la opción de URI "tlsCertificateKeyFilePassword" en su lugar. - - - La opción de controlador "weak_cert_validation" ha sido eliminada. - Utilizar la opción de URI "tlsAllowInvalidCertificates" - en su lugar. - - - - - PECL mongodb 1.16.0 - - - El proveedor AWS KMS para el cifrado del lado del cliente ahora acepta una - opción "sessionToken", que puede ser utilizada para - autenticarse con credenciales AWS temporales. - - - Añadido "tlsDisableOCSPEndpointCheck" al - campo "tlsOptions" de la opción de controlador - "autoEncryption". - - - Si se especifica un documento vacío para el proveedor KMS "azure" o - "gcp", el controlador intentará configurar el proveedor utilizando - las credenciales automáticas. - - - - - PECL mongodb 1.15.0 - - - Si se especifica un documento vacío para el proveedor KMS "aws", el controlador - intentará configurar el proveedor utilizando - las credenciales automáticas. - - - - - PECL mongodb 1.14.0 - - - Añadidas las opciones de cifrado del lado del cliente "bypassQueryAnalysis" y - "encryptedFieldsMap". Opciones adicionales relacionadas con crypt_shared son - ahora admitidas en la opción de cifrado del lado del cliente - "extraOptions". - - - - - PECL mongodb 1.13.0 - - - Añadidas las opciones de URI "srvMaxHosts" y - "srvServiceName". - - - - - PECL mongodb 1.12.0 - - - KMIP es ahora admitido como proveedor KMS para el cifrado del lado del cliente y - puede ser configurado en el campo "kmsProviders" de la opción de controlador - "autoEncryption". Además, las opciones TLS - para los proveedores KMS pueden ahora ser configuradas en el - campo "tlsOptions" de la opción de controlador - "autoEncryption". - - - - - PECL mongodb 1.11.0 - - - Añadida la opción de URI "loadBalanced". - - - - - PECL mongodb 1.10.0 - - - Añadida la opción de controlador "disableClientPersistence". - - - Azure y GCP son ahora admitidos como proveedores KMS para - el cifrado del lado del cliente y pueden ser configurados en el campo - "kmsProviders" de la opción de controlador - "autoEncryption". Las cadenas codificadas en base64 son ahora aceptadas - como alternativa a MongoDB\BSON\Binary para las opciones en - "kmsProviders". - - - - - PECL mongodb 1.8.0 - - - Añadidas las opciones de URI "directConnection", - "tlsDisableCertificateRevocationCheck" y - "tlsDisableOCSPEndpointCheck". - - - Añadida la opción de controlador "driver". - - - - - PECL mongodb 1.7.0 - - - Añadida la opción de controlador "autoEncryption". - - - Especificar cualquier opción SSL o TLS a través del parámetro - driverOptions activará ahora implícitamente TLS, como - ocurre con las opciones de URI correspondientes. - - - - - PECL mongodb 1.6.0 - - - Añadidas las opciones de URI "retryReads", "tls", - "tlsAllowInvalidCertificates", - "tlsAllowInvalidHostnames", - "tlsCAFile", - "tlsCertificateKeyFile", - "tlsCertificateKeyFilePassword", y - "tlsInsecure". - - - La opción de URI "retryWrites" está ahora a &true; por omisión. - - - Especificar una opción de URI SSL o TLS a través de la cadena de conexión o - el parámetro uriOptions activará ahora - implícitamente TLS a menos que ssl o tls sea &false;. - TLS no es implícitamente activado para las opciones en - el parámetro driverOptions, lo que es inalterado - con respecto a las versiones anteriores. - - - - - PECL mongodb 1.5.0 - - - "wtimeoutMS" es ahora siempre validado y aplicado al write concern. Anteriormente, la opción era ignorada si - "w" era <= 1, ya que el tiempo de espera solo se aplica a - la replicación. - - - - - PECL mongodb 1.4.0 - - - Añadidas las opciones de URI "compressors", - "retryWrites", y - "zlibCompressionLevel". - - - - - PECL mongodb 1.3.0 - - - El argumento uriOptions ahora acepta - las opciones "authMechanism" y - "authMechanismProperties". Anteriormente, estas - opciones solo eran admitidas en el argumento - uri. - - - - - PECL mongodb 1.2.0 - - - El argumento uri es ahora opcional y - por omisión "mongodb://. El puerto por omisión sigue siendo - 27017. - - - Añadida la opción de URI "appname". - - - Añadidas las opciones de controlador "allow_invalid_hostname", - "ca_file", "ca_dir", - "clr_file", "pem_file", - "pem_pwd", y - "weak_cert_validation". - - - La API de flujos PHP ya no se utiliza para la comunicación por socket. La opción - "connectTimeoutMS" de la URI es ahora por omisión 10 - segundos en lugar de - default_socket_timeout - en versiones anteriores. Además, la extensión ya no admite todas las opciones de contexto SSL a través - de la opción de controlador "context". - - - - - PECL mongodb 1.1.0 - - - El argumento uri es ahora opcional y por omisión a - "mongodb://localhost:27017/". - - - - - - - - - - - &reftitle.examples; - - Ejemplos básicos <function>MongoDB\Driver\Manager::__construct</function> - Conexión a un nodo MongoDB autónomo: - - -]]> - - - Conexión a un nodo MongoDB autónomo a través de un socket de dominio Unix. La ruta del - socket puede incluir caracteres especiales como barras diagonales y debe ser codificada - con rawurlencode. - - - -]]> - - Conexión a un conjunto de réplicas: - - -]]> - - Conexión a un clúster fragmentado (es decir, una o más instancias mongos): - - -]]> - - Conexión a MongoDB con credenciales de autenticación para un usuario y una base de datos específicos: - - -]]> - - - - Conexión a MongoDB con credenciales de autenticación para un usuario - y una base de datos específicos, donde el nombre de usuario o la contraseña incluye - caracteres especiales (por ejemplo @, :, - %). En el ejemplo siguiente, la cadena de contraseña - myp@ss:w%rd ha sido manualmente escapada; sin embargo, - rawurlencode también puede ser utilizada para escapar - los componentes de la URI que pueden contener caracteres especiales. - - - -]]> - - - Conexión a MongoDB con autenticación X509: - - "/path/to/client.pem", - ] -); -?> -]]> - - - - - - &reftitle.seealso; - - Manejo de la conexión y persistencia - Formato de cadena de conexión MongoDB - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/manager/createclientencryption.xml b/reference/mongodb/mongodb/driver/manager/createclientencryption.xml deleted file mode 100644 index cdb5b5dca4..0000000000 --- a/reference/mongodb/mongodb/driver/manager/createclientencryption.xml +++ /dev/null @@ -1,168 +0,0 @@ - - - - - MongoDB\Driver\Manager::createClientEncryption - Crear un nuevo objeto ClientEncryption - - - - &reftitle.description; - - final public MongoDB\Driver\ClientEncryptionMongoDB\Driver\Manager::createClientEncryption - arrayoptions - - - Construye un nuevo objeto MongoDB\Driver\ClientEncryption con las opciones especificadas. - - - - - &reftitle.parameters; - - - options - - - - options - - - - Opción - Tipo - Descripción - - - - &mongodb.option.encryption.keyVaultClient; - &mongodb.option.encryption.keyVaultNamespace; - &mongodb.option.encryption.kmsProviders; - &mongodb.option.encryption.tlsOptions; - - -
    -
    -
    -
    -
    -
    - - - &reftitle.returnvalues; - - Devuelve una nueva instancia de MongoDB\Driver\ClientEncryption. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lanza una excepción MongoDB\Driver\Exception\RuntimeException si la extensión ha sido compilada sin el soporte de libmongocrypt - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.16.0 - - - El proveedor AWS KMS para el cifrado del lado del cliente acepta - ahora una opción "sessionToken", que puede ser utilizada - para autenticarse con credenciales AWS temporales. - - - Añadido "tlsDisableOCSPEndpointCheck" a la opción - "tlsOptions". - - - Si se especifica un documento vacío para el proveedor KMS "azure" o - "gcp", el controlador intentará - configurar el proveedor utilizando - Las credenciales automáticas. - - - - - PECL mongodb 1.15.0 - - - Si se especifica un documento vacío para el proveedor KMS "aws", - el controlador intentará configurar el proveedor utilizando - Las credenciales automáticas. - - - - - PECL mongodb 1.12.0 - - - KMIP es ahora soportado como proveedor KMS para el cifrado - del lado del cliente y puede ser configurado en la opción "kmsProviders". - - - Añadida la opción "tlsOptions". - - - - - PECL mongodb 1.10.0 - - - Azure y GCP son ahora soportados como proveedores KMS para el cifrado - del lado del cliente y pueden ser configurados en la opción - "kmsProviders". - Las cadenas codificadas en base64 son ahora aceptadas como alternativa a - MongoDB\BSON\Binary - para las opciones en "kmsProviders". - - - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\ClientEncryption::__construct - Cifrado del lado del cliente explícito (manual) en el manual de MongoDB - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/manager/executebulkwrite.xml b/reference/mongodb/mongodb/driver/manager/executebulkwrite.xml deleted file mode 100644 index 5e3cd6e3c3..0000000000 --- a/reference/mongodb/mongodb/driver/manager/executebulkwrite.xml +++ /dev/null @@ -1,235 +0,0 @@ - - - - - MongoDB\Driver\Manager::executeBulkWrite - Ejecuta una o varias operaciones de escritura - - - - &reftitle.description; - - final public MongoDB\Driver\WriteResultMongoDB\Driver\Manager::executeBulkWrite - stringnamespace - MongoDB\Driver\BulkWritebulk - arraynulloptions&null; - - - Ejecuta una o varias operaciones de escritura en el servidor primario. - - - Un MongoDB\Driver\BulkWrite puede ser construido con - una o varias operaciones de escritura de tipos variados (por ejemplo, actualizaciones, eliminaciones e inserciones). El controlador intentará enviar las - operaciones del mismo tipo al servidor en el menor número de solicitudes posible - para optimizar los intercambios. - - - El valor por omisión de la opción "writeConcern" será - deducido a partir de una transacción activa (indicada por la opción - "session"), seguida de la - URI de conexión. - - - - - &reftitle.parameters; - - &mongodb.parameter.namespace; - &mongodb.parameter.bulkwrite; - - options - - - - options - - - - Opción - Tipo - Descripción - - - - &mongodb.option.session; - &mongodb.option.writeConcern; - - -
    -
    -
    -
    -
    -
    - - - &reftitle.returnvalues; - &mongodb.returns.writeresult; - - - - &reftitle.errors; - - Lanza una MongoDB\Driver\Exception\InvalidArgumentException si bulk no contiene ninguna operación de escritura. - Lanza una MongoDB\Driver\Exception\InvalidArgumentException si bulk ya ha sido ejecutado. Los objetos MongoDB\Driver\BulkWrite no pueden ser ejecutados varias veces. - &mongodb.throws.session-unacknowledged; - &mongodb.throws.std; - &mongodb.throws.bulkwriteexception; - Lanza una MongoDB\Driver\Exception\RuntimeException en caso de otros errores. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 2.0.0 - - El parámetro options ya no acepta - una instancia de MongoDB\Driver\WriteConcern. - - - - PECL mongodb 1.21.0 - - Pasar un objeto MongoDB\Driver\WriteConcern como - options está obsoleto y será eliminado en la versión 2.0. - - - - PECL mongodb 1.4.4 - - Se lanzará una MongoDB\Driver\Exception\InvalidArgumentException - si la opción "session" se utiliza en combinación con un - "writeConcern" no-acknowledged. - - - - PECL mongodb 1.4.0 - - El tercer parámetro es ahora un array de options. - Por razones de compatibilidad ascendente, este parámetro siempre aceptará - un objeto MongoDB\Driver\WriteConcern. - - - - PECL mongodb 1.3.0 - - Se lanza una MongoDB\Driver\Exception\InvalidArgumentException - si bulk no contiene ninguna operación de escritura. Anteriormente, - se lanzaba una MongoDB\Driver\Exception\BulkWriteException. - - - - - - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\Manager::executeBulkWrite</function> - -insert(['_id' => 1, 'x' => 1]); -$bulk->insert(['_id' => 2, 'x' => 2]); - -$bulk->update(['x' => 2], ['$set' => ['x' => 1]], ['multi' => false, 'upsert' => false]); -$bulk->update(['x' => 3], ['$set' => ['x' => 3]], ['multi' => false, 'upsert' => true]); -$bulk->update(['_id' => 3], ['$set' => ['x' => 3]], ['multi' => false, 'upsert' => true]); - -$bulk->insert(['_id' => 4, 'x' => 2]); - -$bulk->delete(['x' => 1], ['limit' => 1]); - -$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017'); -$writeConcern = new MongoDB\Driver\WriteConcern(MongoDB\Driver\WriteConcern::MAJORITY, 100); -$result = $manager->executeBulkWrite('db.collection', $bulk, ['writeConcern' => $writeConcern]); - -printf("Inserted %d document(s)\n", $result->getInsertedCount()); -printf("Matched %d document(s)\n", $result->getMatchedCount()); -printf("Updated %d document(s)\n", $result->getModifiedCount()); -printf("Upserted %d document(s)\n", $result->getUpsertedCount()); -printf("Deleted %d document(s)\n", $result->getDeletedCount()); - -foreach ($result->getUpsertedIds() as $index => $id) { - printf('upsertedId[%d]: ', $index); - var_dump($id); -} - -/* Si el WriteConcern no ha podido ser satisfecho */ -if ($writeConcernError = $result->getWriteConcernError()) { - printf("%s (%d): %s\n", $writeConcernError->getMessage(), $writeConcernError->getCode(), var_export($writeConcernError->getInfo(), true)); -} - -/* Si una escritura no ha podido hacerse en absoluto */ -foreach ($result->getWriteErrors() as $writeError) { - printf("Operation#%d: %s (%d)\n", $writeError->getIndex(), $writeError->getMessage(), $writeError->getCode()); -} -?> -]]> - - &example.outputs.similar; - - - string(24) "54d3adc3ce7a792f4d703756" -} -upsertedId[4]: int(3) -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWrite - MongoDB\Driver\WriteResult - MongoDB\Driver\WriteConcern - MongoDB\Driver\Server::executeBulkWrite - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/manager/executebulkwritecommand.xml b/reference/mongodb/mongodb/driver/manager/executebulkwritecommand.xml deleted file mode 100644 index 439fd9c2ba..0000000000 --- a/reference/mongodb/mongodb/driver/manager/executebulkwritecommand.xml +++ /dev/null @@ -1,212 +0,0 @@ - - - - - - - MongoDB\Driver\Manager::executeBulkWriteCommand - Ejecuta operaciones de escritura utilizando el comando bulkWrite - - - - &reftitle.description; - - final public MongoDB\Driver\BulkWriteCommandResultMongoDB\Driver\Manager::executeBulkWriteCommand - MongoDB\Driver\BulkWriteCommandbulk - arraynulloptions&null; - - - Ejecuta una o varias operaciones de escritura en el servidor primario utilizando el - comando bulkWrite - introducido en MongoDB 8.0. - - - Una MongoDB\Driver\BulkWriteCommand puede ser construida - con una o varias operaciones de escritura de tipos variados (por ejemplo, inserciones, - actualizaciones y eliminaciones). Cada operación de escritura puede apuntar a una colección diferente. - - - El valor por omisión para la opción "writeConcern" será - deducido de una transacción activa (indicada por la opción - "session"), seguida por - la URI de conexión. - - - - - &reftitle.parameters; - - &mongodb.parameter.bulkwritecommand; - - options - - - - options - - - - Opción - Tipo - Descripción - - - - &mongodb.option.session; - &mongodb.option.writeConcern; - - -
    -
    -
    -
    -
    -
    - - - &reftitle.returnvalues; - &mongodb.returns.bulkwritecommandresult; - - - - &reftitle.errors; - - Lanza una MongoDB\Driver\Exception\InvalidArgumentException si bulk no contiene operaciones de escritura válidas. - Lanza una MongoDB\Driver\Exception\InvalidArgumentException si bulk ya ha sido ejecutada. Los objetos MongoDB\Driver\BulkWriteCommand no pueden ser ejecutados múltiples veces. - &mongodb.throws.session-unacknowledged; - &mongodb.throws.std; - &mongodb.throws.bulkwritecommandexception; - Lanza MongoDB\Driver\Exception\RuntimeException en caso de otro error. - - - - - &reftitle.examples; - - Operaciones de escritura mixtas - - Las operaciones de escritura mixtas (por ejemplo, inserción, actualización y eliminación) serán enviadas - al servidor utilizando una sola - comando - bulkWrite - - -deleteMany('db.coll_one', []); -$bulk->deleteMany('db.coll_two', []); - -// Añade documentos a dos colecciones -$bulk->insertOne('db.coll_one', ['_id' => 1]); -$bulk->insertOne('db.coll_two', ['_id' => 2]); -$bulk->insertOne('db.coll_two', ['_id' => 3]); - -// Actualiza un documento en "coll_one" -$bulk->updateOne('db.coll_one', ['_id' => 1], ['$set' => ['x' => 1]]); - -$result = $manager->executeBulkWriteCommand($bulk); - -printf("Insertados %d documento(s)\n", $result->getInsertedCount()); -printf("Actualizados %d documento(s)\n", $result->getModifiedCount()); - -?> -]]> - - &example.outputs; - - - - - - Operación de escritura ordenada que provoca un error - -deleteMany('db.coll', []); -$bulk->insertOne('db.coll', ['_id' => 1]); -$bulk->insertOne('db.coll', ['_id' => 2]); -$bulk->insertOne('db.coll', ['_id' => 1]); -$bulk->insertOne('db.coll', ['_id' => 3]); - -try { - $result = $manager->executeBulkWriteCommand($bulk); -} catch (MongoDB\Driver\Exception\BulkWriteCommandException $e) { - $result = $e->getPartialResult(); - - var_dump($e->getWriteErrors()); -} - -printf("Insertados %d documento(s)\n", $result->getInsertedCount()); - -?> -]]> - - &example.outputs.similar; - - - object(MongoDB\Driver\WriteError)#5 (4) { - ["message"]=> - string(78) "E11000 duplicate key error collection: db.coll index: _id_ dup key: { _id: 1 }" - ["code"]=> - int(11000) - ["index"]=> - int(3) - ["info"]=> - object(stdClass)#6 (0) { - } - } -} -Insertados 2 documento(s) -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommand - MongoDB\Driver\BulkWriteCommandResult - MongoDB\Driver\WriteConcern - MongoDB\Driver\Server::executeBulkWriteCommand - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/manager/executecommand.xml b/reference/mongodb/mongodb/driver/manager/executecommand.xml deleted file mode 100644 index be826285fd..0000000000 --- a/reference/mongodb/mongodb/driver/manager/executecommand.xml +++ /dev/null @@ -1,310 +0,0 @@ - - - - - MongoDB\Driver\Manager::executeCommand - Ejecuta un comando de base de datos - - - - &reftitle.description; - - final public MongoDB\Driver\CursorMongoDB\Driver\Manager::executeCommand - stringdb - MongoDB\Driver\Commandcommand - arraynulloptions&null; - - - Selecciona un servidor en función de la opción "readPreference" - y ejecuta el comando en ese servidor. - - - Este método no aplica ninguna lógica especial al comando. Los valores - por defecto de las opciones "readPreference", - "readConcern" y "writeConcern" serán - deducidos a partir de una transacción activa (indicada por la opción - "session"). Si no hay una transacción activa, se utilizará - una preferencia de lectura primaria para la selección del servidor. - - - Los valores por defecto no serán no deducidos a partir de - la URI de conexión. - Por lo tanto, se recomienda a los usuarios utilizar métodos de comando de lectura - y/o escritura específicos si es posible. - - - - - &reftitle.parameters; - - &mongodb.parameter.db; - &mongodb.parameter.command; - - options - - - - options - - - - Opción - Tipo - Descripción - - - - &mongodb.option.readConcern; - &mongodb.option.readPreference; - &mongodb.option.session; - &mongodb.option.writeConcern; - - -
    -
    - &mongodb.option.transactionReadWriteConcern; -
    -
    -
    -
    - - - &reftitle.returnvalues; - &mongodb.returns.cursor; - - - - &reftitle.errors; - - &mongodb.throws.session-readwriteconcern; - &mongodb.throws.session-unacknowledged; - &mongodb.throws.std; - Lanza una MongoDB\Driver\Exception\RuntimeException en otros errores (por ejemplo: comando inválido, entrega de un comando de escritura a un secundario). - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 2.0.0 - - El parámetro options ya no acepta - una instancia de MongoDB\Driver\ReadPreference. - - - - PECL mongodb 1.21.0 - - Pasar un objeto MongoDB\Driver\ReadPreference como - options está obsoleto y será eliminado en la 2.0. - - - - PECL mongodb 1.4.4 - - Se lanzará una MongoDB\Driver\Exception\InvalidArgumentException - si la opción "session" se utiliza en combinación con una - preferencia de escritura no reconocida. - - - - PECL mongodb 1.4.0 - - Este tercer parámetro es ahora un array de options. - Por razones de compatibilidad ascendente, este parámetro siempre aceptará - un objeto MongoDB\Driver\ReadPreference. - - - - - - - - - - &reftitle.examples; - - <function>MongoDB\Driver\Manager::executeCommand</function> con un comando que devuelve un solo documento de resultado - - 1]); - -try { - $cursor = $manager->executeCommand('admin', $command); -} catch(MongoDB\Driver\Exception $e) { - echo $e->getMessage(), "\n"; - exit; -} - -/* El comando ping devuelve un solo documento de resultado, por lo que - * se debe acceder al primer resultado en el cursor. */ -$response = $cursor->toArray()[0]; - -var_dump($response); - -?> -]]> - - &example.outputs; - - - float(1) -} -]]> - - - - <function>MongoDB\Driver\Manager::executeCommand</function> con un comando que devuelve un cursor - -insert(['x' => 1, 'y' => 'foo']); -$bulk->insert(['x' => 2, 'y' => 'bar']); -$bulk->insert(['x' => 3, 'y' => 'bar']); -$manager->executeBulkWrite('db.collection', $bulk); - -$command = new MongoDB\Driver\Command([ - 'aggregate' => 'collection', - 'pipeline' => [ - ['$group' => ['_id' => '$y', 'sum' => ['$sum' => '$x']]], - ], - 'cursor' => new stdClass, -]); -$cursor = $manager->executeCommand('db', $command); - -/* El comando de agregación puede eventualmente devolver sus resultados en - * un cursor en lugar de un solo documento de resultado. En este caso, se puede - * iterar directamente sobre el cursor para acceder a estos resultados. */ -foreach ($cursor as $document) { - var_dump($document); -} - -?> -]]> - - &example.outputs; - - - string(3) "bar" - ["sum"]=> - int(10) -} -object(stdClass)#7 (2) { - ["_id"]=> - string(3) "foo" - ["sum"]=> - int(2) -} -]]> - - - - - Limitar el tiempo de ejecución de un comando - - El tiempo de ejecución de un comando puede ser limitado especificando un valor para - "maxTimeMS" en el documento MongoDB\Driver\Command. - Tenga en cuenta que este límite de tiempo se aplica en el lado del servidor y no tiene en cuenta - la latencia de la red. Ver Terminar las operaciones en curso - en el manual de MongoDB para más información. - - - 'collection', - 'query' => ['x' => ['$gt' => 1]], - 'maxTimeMS' => 1000, -]); - -$cursor = $manager->executeCommand('db', $command); - -var_dump($cursor->toArray()[0]); - -?> -]]> - - - Si el comando no logra completarse después de un segundo de ejecución en el servidor, - se lanzará una MongoDB\Driver\Exception\ExecutionTimeoutException. - - - - - - &reftitle.notes; - - - Si se utiliza una segunda readPreference, es responsabilidad del llamante - asegurarse de que el comando pueda ser ejecutado en un secundario. No se realiza - ninguna validación por parte del controlador. - - - - - Este método no utiliza por defecto la preferencia de lectura de la - URI de conexión MongoDB. - Las aplicaciones que lo necesiten deberían considerar el uso de - MongoDB\Driver\Manager::executeReadCommand. - - - - - - &reftitle.seealso; - - MongoDB\Driver\Command - MongoDB\Driver\Cursor - MongoDB\Driver\Manager::executeReadCommand - MongoDB\Driver\Manager::executeReadWriteCommand - MongoDB\Driver\Manager::executeWriteCommand - MongoDB\Driver\Server::executeCommand - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/manager/executequery.xml b/reference/mongodb/mongodb/driver/manager/executequery.xml deleted file mode 100644 index 6ed6cac42b..0000000000 --- a/reference/mongodb/mongodb/driver/manager/executequery.xml +++ /dev/null @@ -1,231 +0,0 @@ - - - - - MongoDB\Driver\Manager::executeQuery - Ejecuta una consulta de base de datos - - - - &reftitle.description; - - final public MongoDB\Driver\CursorMongoDB\Driver\Manager::executeQuery - stringnamespace - MongoDB\Driver\Queryquery - arraynulloptions&null; - - - Selecciona un servidor en función de la opción "readPreference" - y ejecuta la consulta en ese servidor. - - - Los valores por omisión de la opción "readPreference" y de - la opción "readConcern" de la consulta serán deducidos a - partir de una transacción activa (indicada por la opción "session"), - seguida de la URI de conexión. - - - - - &reftitle.parameters; - - &mongodb.parameter.namespace; - &mongodb.parameter.query; - - options - - - - options - - - - Opción - Tipo - Descripción - - - - &mongodb.option.readPreference; - &mongodb.option.session; - - -
    -
    -
    -
    -
    -
    - - - &reftitle.returnvalues; - &mongodb.returns.cursor; - - - - &reftitle.errors; - - &mongodb.throws.std; - Lanza una MongoDB\Driver\Exception\RuntimeException en caso de otro error (por ejemplo: operadores de consulta inválidos). - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 2.0.0 - - El parámetro options ya no acepta - una instancia de MongoDB\Driver\ReadPreference. - - - - PECL mongodb 1.21.0 - - Pasar un objeto MongoDB\Driver\ReadPreference como - options está obsoleto y será eliminado en la 2.0. - - - - PECL mongodb 1.4.0 - - El tercer parámetro es ahora un array options. - Por razones de compatibilidad ascendente, este parámetro siempre aceptará un - objeto MongoDB\Driver\ReadPreference. - - - - - - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\Manager::executeQuery</function> - -insert(['x' => 1]); -$bulk->insert(['x' => 2]); -$bulk->insert(['x' => 3]); -$manager->executeBulkWrite('db.collection', $bulk); - -$filter = ['x' => ['$gt' => 1]]; -$options = [ - 'projection' => ['_id' => 0], - 'sort' => ['x' => -1], -]; - -$query = new MongoDB\Driver\Query($filter, $options); -$cursor = $manager->executeQuery('db.collection', $query); - -foreach ($cursor as $document) { - var_dump($document); -} - -?> -]]> - - &example.outputs; - - - int(3) -} -object(stdClass)#7 (1) { - ["x"]=> - int(2) -} -]]> - - - - - Limitar el tiempo de ejecución de una consulta - - La opción "maxTimeMS" de la clase - MongoDB\Driver\Query puede ser utilizada para limitar - el tiempo de ejecución de una consulta. Tenga en cuenta que este límite de tiempo es - aplicado en el lado del servidor y no tiene en cuenta la latencia de la red. Ver - Terminar las operaciones en curso - en el manual de MongoDB para más información. - - - ['$gt' => 1]]; -$options = [ - 'maxTimeMS' => 1000, -]; - -$query = new MongoDB\Driver\Query($filter, $options); -$cursor = $manager->executeQuery('db.collection', $query); - -foreach ($cursor as $document) { - var_dump($document); -} - -?> -]]> - - - Si la consulta no logra terminar después de un segundo de ejecución - en el servidor, una - MongoDB\Driver\Exception\ExecutionTimeoutException - será lanzada. - - - - - - &reftitle.seealso; - - MongoDB\Driver\Cursor - MongoDB\Driver\Query - MongoDB\Driver\ReadPreference - MongoDB\Driver\Server::executeQuery - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/manager/executereadcommand.xml b/reference/mongodb/mongodb/driver/manager/executereadcommand.xml deleted file mode 100644 index a0e0381d5b..0000000000 --- a/reference/mongodb/mongodb/driver/manager/executereadcommand.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - MongoDB\Driver\Manager::executeReadCommand - Ejecuta un comando de base de datos que lee - - - - &reftitle.description; - - final public MongoDB\Driver\CursorMongoDB\Driver\Manager::executeReadCommand - stringdb - MongoDB\Driver\Commandcommand - arraynulloptions&null; - - - Selecciona un servidor en función de la opción "readPreference" - y ejecuta el comando en este servidor. - - - Este método aplicará una lógica específica a los comandos que leen (por ejemplo - distinct). - Los valores por omisión de las opciones "readPreference" y - "readConcern" serán deducidos a partir de una transacción activa - (indicada por la opción "session"), seguida de la - URI de conexión. - - - - - &reftitle.parameters; - - &mongodb.parameter.db; - &mongodb.parameter.command; - - options - - - - options - - - - Opción - Tipo - Descripción - - - - &mongodb.option.readConcern; - &mongodb.option.readPreference; - &mongodb.option.session; - - -
    -
    - &mongodb.option.transactionReadWriteConcern; -
    -
    -
    -
    - - - &reftitle.returnvalues; - &mongodb.returns.cursor; - - - - &reftitle.errors; - - &mongodb.throws.session-readwriteconcern; - &mongodb.throws.std; - Lanza una MongoDB\Driver\Exception\RuntimeException en caso de otros errores (por ejemplo: comando inválido). - - - - - &reftitle.seealso; - - MongoDB\Driver\Command - MongoDB\Driver\Cursor - MongoDB\Driver\Manager::executeCommand - MongoDB\Driver\Manager::executeReadWriteCommand - MongoDB\Driver\Manager::executeWriteCommand - MongoDB\Driver\Server::executeReadCommand - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/manager/executereadwritecommand.xml b/reference/mongodb/mongodb/driver/manager/executereadwritecommand.xml deleted file mode 100644 index 06f4549f35..0000000000 --- a/reference/mongodb/mongodb/driver/manager/executereadwritecommand.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - MongoDB\Driver\Manager::executeReadWriteCommand - Ejecuta un comando de base de datos que lee y escribe - - - - &reftitle.description; - - final public MongoDB\Driver\CursorMongoDB\Driver\Manager::executeReadWriteCommand - stringdb - MongoDB\Driver\Commandcommand - arraynulloptions&null; - - - Ejecuta un comando en el servidor primario. - - - Este método aplicará una lógica específica a los comandos que leen y escriben - (por ejemplo aggregate). - Los valores por omisión de las opciones "readConcern" y - "writeConcern" serán deducidos a partir de una transacción activa - (indicada por la opción "session"), seguida de la - URI de conexión. - - - - - &reftitle.parameters; - - &mongodb.parameter.db; - &mongodb.parameter.command; - - options - - - - options - - - - Opción - Tipo - Descripción - - - - &mongodb.option.readConcern; - &mongodb.option.session; - &mongodb.option.writeConcern; - - -
    -
    - &mongodb.option.transactionReadWriteConcern; -
    -
    -
    -
    - - - &reftitle.returnvalues; - &mongodb.returns.cursor; - - - - &reftitle.errors; - - &mongodb.throws.session-readwriteconcern; - &mongodb.throws.session-unacknowledged; - &mongodb.throws.std; - Lanza una MongoDB\Driver\Exception\RuntimeException en caso de otros errores (por ejemplo: comando inválido). - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.4.4 - - Una MongoDB\Driver\Exception\InvalidArgumentException - será lanzada si la opción "session" es utilizada en - combinación con un criterio de lectura o escritura no reconocido. - - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Command - MongoDB\Driver\Cursor - MongoDB\Driver\Manager::executeCommand - MongoDB\Driver\Manager::executeReadCommand - MongoDB\Driver\Manager::executeWriteCommand - MongoDB\Driver\Server::executeReadWriteCommand - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/manager/executewritecommand.xml b/reference/mongodb/mongodb/driver/manager/executewritecommand.xml deleted file mode 100644 index ee52d51ad6..0000000000 --- a/reference/mongodb/mongodb/driver/manager/executewritecommand.xml +++ /dev/null @@ -1,147 +0,0 @@ - - - - - - MongoDB\Driver\Manager::executeWriteCommand - Ejecuta un comando de base de datos que escribe - - - - &reftitle.description; - - final public MongoDB\Driver\CursorMongoDB\Driver\Manager::executeWriteCommand - stringdb - MongoDB\Driver\Commandcommand - arraynulloptions&null; - - - Ejecuta el comando en el servidor primario. - - - Este método aplicará una lógica específica a los comandos que escriben (por ejemplo - drop). - Los valores por omisión de la opción "writeConcern" serán deducidos a - partir de una transacción activa (indicada por la opción "session"), seguida de - la URI de conexión. - - - - Este método no está destinado a ser utilizado para ejecutar - insert, - update, - o delete. - Se recomienda a los usuarios utilizar - MongoDB\Driver\Manager::executeBulkWrite para estas - operaciones. - - - - - - &reftitle.parameters; - - &mongodb.parameter.db; - &mongodb.parameter.command; - - options - - - - options - - - - Opción - Tipo - Descripción - - - - &mongodb.option.session; - &mongodb.option.writeConcern; - - -
    -
    - &mongodb.option.transactionReadWriteConcern; -
    -
    -
    -
    - - - &reftitle.returnvalues; - &mongodb.returns.cursor; - - - - &reftitle.errors; - - &mongodb.throws.session-readwriteconcern; - &mongodb.throws.session-unacknowledged; - &mongodb.throws.std; - Lanza una MongoDB\Driver\Exception\RuntimeException en caso de otros errores (por ejemplo: comando inválido). - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.4.4 - - Una MongoDB\Driver\Exception\InvalidArgumentException - será lanzada si la opción "session" es utilizada en - combinación con un "writeConcern" no reconocido. - - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Command - MongoDB\Driver\Cursor - MongoDB\Driver\Manager::executeCommand - MongoDB\Driver\Manager::executeReadCommand - MongoDB\Driver\Manager::executeReadWriteCommand - MongoDB\Driver\Server::executeWriteCommand - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/manager/getencryptedfieldsmap.xml b/reference/mongodb/mongodb/driver/manager/getencryptedfieldsmap.xml deleted file mode 100644 index 606d75d49a..0000000000 --- a/reference/mongodb/mongodb/driver/manager/getencryptedfieldsmap.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - MongoDB\Driver\Manager::getEncryptedFieldsMap - Devuelve la opción de cifrado automático encryptedFieldsMap para el Manager - - - - &reftitle.description; - - final public arrayobjectnullMongoDB\Driver\Manager::getEncryptedFieldsMap - - - - Devuelve la opción de cifrado automático encryptedFieldsMap - para el Manager, si se ha especificado. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La opción de cifrado automático encryptedFieldsMap para el - Manager, o &null; si no se ha especificado. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::__construct - - - - - - diff --git a/reference/mongodb/mongodb/driver/manager/getreadconcern.xml b/reference/mongodb/mongodb/driver/manager/getreadconcern.xml deleted file mode 100644 index 754c08ef9c..0000000000 --- a/reference/mongodb/mongodb/driver/manager/getreadconcern.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - MongoDB\Driver\Manager::getReadConcern - Devuelve el ReadConcern para el Manager - - - - &reftitle.description; - - final public MongoDB\Driver\ReadConcernMongoDB\Driver\Manager::getReadConcern - - - - Devuelve el MongoDB\Driver\ReadConcern para el - Manager, que se deriva de sus opciones URI. Es el ReadConcern por omisión - para las peticiones y comandos ejecutados en el Manager. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El MongoDB\Driver\ReadConcern para el Manager. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo <function>MongoDB\Driver\Manager::getReadConcern</function> - -getReadConcern()); - -$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017/?readConcernLevel=local'); -var_dump($manager->getReadConcern()); - -?> -]]> - - &example.outputs.similar; - - - string(5) "local" -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\ReadConcern - MongoDB\Driver\Manager::__construct - - - - - - diff --git a/reference/mongodb/mongodb/driver/manager/getreadpreference.xml b/reference/mongodb/mongodb/driver/manager/getreadpreference.xml deleted file mode 100644 index 5c9e785ebb..0000000000 --- a/reference/mongodb/mongodb/driver/manager/getreadpreference.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - MongoDB\Driver\Manager::getReadPreference - Devuelve el ReadPreference para el Manager - - - - &reftitle.description; - - final public MongoDB\Driver\ReadPreferenceMongoDB\Driver\Manager::getReadPreference - - - - Devuelve el MongoDB\Driver\ReadPreference para el - Manager, que se deriva de sus opciones URI. Es el ReadPreference por omisión - para las peticiones y comandos ejecutados en el Manager. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El MongoDB\Driver\ReadPreference para el Manager. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\Manager::getReadPreference</function> - -getReadPreference()); - -$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017/?readPreference=secondaryPreferred&readPreferenceTags=dc:ny,rack:1&readPreferenceTags=dc:ny&readPreferenceTags='); -var_dump($manager->getReadPreference()); - -?> -]]> - - &example.outputs.similar; - - - string(7) "primary" -} -object(MongoDB\Driver\ReadPreference)#1 (2) { - ["mode"]=> - string(18) "secondaryPreferred" - ["tags"]=> - array(3) { - [0]=> - object(stdClass)#3 (2) { - ["dc"]=> - string(2) "ny" - ["rack"]=> - string(1) "1" - } - [1]=> - object(stdClass)#4 (1) { - ["dc"]=> - string(2) "ny" - } - [2]=> - object(stdClass)#5 (0) { - } - } -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\ReadPreference - MongoDB\Driver\Manager::__construct - - - - - - diff --git a/reference/mongodb/mongodb/driver/manager/getservers.xml b/reference/mongodb/mongodb/driver/manager/getservers.xml deleted file mode 100644 index e10d9d9ae9..0000000000 --- a/reference/mongodb/mongodb/driver/manager/getservers.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - - MongoDB\Driver\Manager::getServers - Devolver los servidores a los que está conectado este gestor - - - - &reftitle.description; - - final public arrayMongoDB\Driver\Manager::getServers - - - - Devuelve un &array; de instancias MongoDB\Driver\Server a las que está conectado este gestor. - - - - Dado que el controlador se conecta perezosamente a la base de datos, este método puede devolver un &array; vacío si se llama antes de ejecutar una operación en el MongoDB\Driver\Manager. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un &array; de instancias MongoDB\Driver\Server a las que está conectado este gestor. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\Driver\Manager::getServers</function> - -getServers()); - -$command = new MongoDB\Driver\Command(['ping' => 1]); -$manager->executeCommand('db', $command); - -var_dump($manager->getServers()); - -?> -]]> - - &example.outputs.similar; - - - object(MongoDB\Driver\Server)#3 (10) { - ["host"]=> - string(9) "localhost" - ["port"]=> - int(27017) - ["type"]=> - int(1) - ["is_primary"]=> - bool(false) - ["is_secondary"]=> - bool(false) - ["is_arbiter"]=> - bool(false) - ["is_hidden"]=> - bool(false) - ["is_passive"]=> - bool(false) - ["last_hello_response"]=> - array(8) { - ["isWritablePrimary"]=> - bool(true) - ["maxBsonObjectSize"]=> - int(16777216) - ["maxMessageSizeBytes"]=> - int(48000000) - ["maxWriteBatchSize"]=> - int(1000) - ["localTime"]=> - object(MongoDB\BSON\UTCDateTime)#4 (1) { - ["milliseconds"]=> - int(1447267964517) - } - ["maxWireVersion"]=> - int(3) - ["minWireVersion"]=> - int(0) - ["ok"]=> - float(1) - } - ["round_trip_time"]=> - int(554) - } -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\Server - MongoDB\Driver\Manager::selectServer - - - - - - diff --git a/reference/mongodb/mongodb/driver/manager/getwriteconcern.xml b/reference/mongodb/mongodb/driver/manager/getwriteconcern.xml deleted file mode 100644 index 46fe0b0341..0000000000 --- a/reference/mongodb/mongodb/driver/manager/getwriteconcern.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - MongoDB\Driver\Manager::getWriteConcern - Devuelve el WriteConcern para el Manager - - - - &reftitle.description; - - final public MongoDB\Driver\WriteConcernMongoDB\Driver\Manager::getWriteConcern - - - - Devuelve el MongoDB\Driver\WriteConcern para el - Manager, que se deriva de sus opciones URI. Es el WriteConcern por omisión - para las escrituras y comandos ejecutados en el Manager. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El MongoDB\Driver\WriteConcern para el Manager. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\Manager::getWriteConcern</function> - -getWriteConcern()); - -$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017/?w=majority&wtimeoutMS=2000'); -var_dump($manager->getWriteConcern()); - -?> -]]> - - &example.outputs.similar; - - - string(8) "majority" - ["wtimeout"]=> - int(2000) -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteConcern - MongoDB\Driver\Manager::__construct - - - - - - diff --git a/reference/mongodb/mongodb/driver/manager/removesubscriber.xml b/reference/mongodb/mongodb/driver/manager/removesubscriber.xml deleted file mode 100644 index abcd919879..0000000000 --- a/reference/mongodb/mongodb/driver/manager/removesubscriber.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - MongoDB\Driver\Manager::removeSubscriber - Elimina un observador de eventos de supervisión de este Manager - - - - &reftitle.description; - - final public voidMongoDB\Driver\Manager::removeSubscriber - MongoDB\Driver\Monitoring\Subscribersubscriber - - - Elimina un observador de eventos de supervisión de este Manager. - - - - Si subscriber no está ya registrado con este - Manager, esta función no hace nada. - - - - - - &reftitle.parameters; - - - subscriber (MongoDB\Driver\Monitoring\Subscriber) - - - Un observador de eventos de supervisión a eliminar de este Manager. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::addSubscriber - MongoDB\Driver\Monitoring\Subscriber - MongoDB\Driver\Monitoring\CommandSubscriber - MongoDB\Driver\Monitoring\removeSubscriber - - - - - - - diff --git a/reference/mongodb/mongodb/driver/manager/selectserver.xml b/reference/mongodb/mongodb/driver/manager/selectserver.xml deleted file mode 100644 index 2e8331a60e..0000000000 --- a/reference/mongodb/mongodb/driver/manager/selectserver.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - MongoDB\Driver\Manager::selectServer - Selecciona un servidor correspondiente a una preferencia de lectura - - - - &reftitle.description; - - final public MongoDB\Driver\ServerMongoDB\Driver\Manager::selectServer - MongoDB\Driver\ReadPreferencenullreadPreference&null; - - - Selecciona un MongoDB\Driver\Server correspondiente a - readPreference. Si readPreference - es &null; o se omite, el servidor primario será seleccionado por omisión. Esto puede - ser utilizado para preseleccionar un servidor a fin de realizar una verificación - de versión antes de ejecutar una operación. - - - - A diferencia de MongoDB\Driver\Manager::getServers, este - método inicializará las conexiones de base de datos y realizará el descubrimiento de servidores si es necesario. Ver la - Especificación de selección de servidor - para más información. - - - - - - &reftitle.parameters; - - - readPreference (MongoDB\Driver\ReadPreference) - - - Las preferencias de lectura a utilizar para seleccionar un servidor. Si - &null; o se omite, el servidor primario será seleccionado por omisión. - - - - - - - - &reftitle.returnvalues; - - Devuelve un MongoDB\Driver\Server correspondiente a la - preferencia de lectura. - - - - - &reftitle.errors; - - &mongodb.throws.std; - Lanza una MongoDB\Driver\Exception\RuntimeException si un servidor correspondiente a la preferencia de lectura no ha podido ser encontrado. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.11.0 - - El readPreference es ahora opcional. Si &null; o - se omite, el servidor primario será seleccionado por omisión. - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Server - MongoDB\Driver\Manager::getServers - Especificación de selección de servidor - - - - - - diff --git a/reference/mongodb/mongodb/driver/manager/startsession.xml b/reference/mongodb/mongodb/driver/manager/startsession.xml deleted file mode 100644 index 718bf30b7a..0000000000 --- a/reference/mongodb/mongodb/driver/manager/startsession.xml +++ /dev/null @@ -1,224 +0,0 @@ - - - - - - MongoDB\Driver\Manager::startSession - Inicia una nueva sesión de cliente para ser utilizada con este cliente - - - - &reftitle.description; - - final public MongoDB\Driver\SessionMongoDB\Driver\Manager::startSession - arraynulloptions&null; - - - Crear una MongoDB\Driver\Session para las opciones dadas. - La sesión puede luego ser especificada durante la ejecución de comandos, consultas - y operaciones de escritura. - - - - Una MongoDB\Driver\Session solo puede ser utilizada con el - MongoDB\Driver\Manager desde el cual fue creada. - - - - - - &reftitle.parameters; - - - options - - - - options - - - - Opción - Tipo - Descripción - Por defecto - - - - - causalConsistency - bool - - - Configura la coherencia causal en una sesión. Si &true;, cada operación - en la sesión será ordenada de manera causal después de la operación de lectura - o escritura previa. Definir a &false; para desactivar la coherencia causal. - - - Ver - Consistencia causal - en el manual de MongoDB para más información. - - - &true; - - - defaultTransactionOptions - array - - - Las opciones por defecto a aplicar a las transacciones recién creadas. Estas - opciones se utilizan a menos que sean reemplazadas cuando una transacción es - iniciada con un valor diferente para cada opción. - - -
    - options - - - - Opción - Tipo - Descripción - - - - &mongodb.option.maxCommitTimeMS; - &mongodb.option.readConcern; - &mongodb.option.readPreference; - &mongodb.option.writeConcern; - - -
    -
    - - Esta opción está disponible en MongoDB 4.0+. - - - [] - - - snapshot - bool - - - Configura las lecturas instantáneas en una sesión. Si &true;, un timestamp será - obtenido de la primera operación de lectura soportada en la sesión - (es decir, find, aggregate, o - distinct no fragmentado). Las operaciones de lectura posteriores - en la sesión utilizarán luego un nivel de coherencia de lectura "snapshot" - para leer datos mayoritariamente comprometidos desde ese timestamp. Definir - a &false; para desactivar las lecturas instantáneas. - - - Las lecturas instantáneas requieren MongoDB 5.0+ y no pueden ser utilizadas - con la coherencia causal, transacciones o operaciones de escritura. Si - "snapshot" es &true;, - "causalConsistency" será por defecto &false;. - - - Ver - Read Concern "instantáneas" - en el manual de MongoDB para más información. - - - &false; - - - - - -
    -
    -
    -
    - - - &reftitle.returnvalues; - - Devuelve una MongoDB\Driver\Session. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lanza una MongoDB\Driver\Exception\InvalidArgumentException si las opciones "causalConsistency" y "snapshot" son ambas &true;. - Lanza una MongoDB\Driver\Exception\RuntimeException si la sesión no puede ser creada (por ejemplo, libmongoc no soporta el cifrado). - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.11.0 - - - La opción "snapshot" fue añadida. - - - - - PECL mongodb 1.6.0 - - - La opción "maxCommitTimeMS" fue añadida a - "defaultTransactionOptions". - - - - - PECL mongodb 1.5.0 - - - La opción "defaultTransactionOptions" fue añadida. - - - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Session - Consistencia causal en el manual de MongoDB - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent.xml deleted file mode 100644 index 7cd88b799a..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent.xml +++ /dev/null @@ -1,257 +0,0 @@ - - - - - - - - La clase MongoDB\Driver\Monitoring\CommandFailedEvent - MongoDB\Driver\Monitoring\CommandFailedEvent - - - - -
    - &reftitle.intro; - - La clase MongoDB\Driver\Monitoring\CommandFailedEvent - contiene la información sobre una comando que ha fallado. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\CommandFailedEvent - - - - final - - MongoDB\Driver\Monitoring\CommandFailedEvent - - - - - &Properties; - - public - readonly - string - host - - - public - readonly - int - port - - - public - readonly - string - commandName - - - public - readonly - string - databaseName - - - public - readonly - int - duration - - - public - readonly - Exception - error - - - public - readonly - object - reply - - - public - readonly - string - operationId - - - public - readonly - string - requestId - - - public - readonly - MongoDB\BSON\ObjectIdnull - serviceId - - - public - readonly - intnull - serverConnectionId - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - host - - El nombre del host del servidor que ejecutó el comando. - - - - port - - El puerto del servidor que ejecutó el comando. - - - - commandName - - El nombre del comando. - - - - databaseName - - El nombre de la base de datos. - - - - duration - - - La duración del comando en microsegundos. La duración es un - valor calculado que incluye el tiempo necesario para enviar el - mensaje y recibir la respuesta del servidor. - - - - - error - - La excepción lanzada cuando el comando falló. - - - - reply - - El documento de respuesta de error devuelto por el servidor. - - - - operationId - - - El identificador de operación. Puede usarse para vincular eventos - entre sí, como en escrituras en bloque, que pueden despachar - varios comandos. - - - - - requestId - - - El identificador de la petición. Puede usarse para asociar este - MongoDB\Driver\Monitoring\CommandFailedEvent - con un - MongoDB\Driver\Monitoring\CommandStartedEvent - correspondiente. - - - - - serviceId - - - El identificador de servicio, o &null; si el servidor no lo - soporta (es decir, cuando no se utiliza el modo de balanceo de carga). - - - - - serverConnectionId - - - El identificador de la conexión al servidor, o &null; si no está - disponible. - - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Se añadieron propiedades públicas readonly. La - propiedad duration reemplaza al método - getDurationMicros. - - - - - -
    - -
    - - &reference.mongodb.mongodb.driver.monitoring.entities.commandfailedevent; - -
    - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getcommandname.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getcommandname.xml deleted file mode 100644 index 45c66e0ea4..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getcommandname.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getCommandName - Devuelve el nombre de la orden - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandFailedEvent::getCommandName - - - - Devuelve el nombre de la orden (por ejemplo "find", - "aggregate"). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el nombre de la orden. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getdatabasename.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getdatabasename.xml deleted file mode 100644 index b8a22cc91c..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getdatabasename.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getDatabaseName - Devuelve el nombre de la base de datos sobre la cual se ejecutó el comando - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandFailedEvent::getDatabaseName - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la base de datos sobre la cual se ejecutó el comando. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getdurationmicros.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getdurationmicros.xml deleted file mode 100644 index e379bfb5a3..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getdurationmicros.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getDurationMicros - Devuelve la duración de la orden en microsegundos - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\CommandFailedEvent::getDurationMicros - - - - La duración de la orden es un valor calculado que incluye el tiempo para enviar - el mensaje y recibir la respuesta del servidor. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la duración de la orden en microsegundos. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/geterror.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/geterror.xml deleted file mode 100644 index dd9cb4cc2a..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/geterror.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getError - Devuelve la excepción asociada al comando fallido - - - - &reftitle.description; - - final public ExceptionMongoDB\Driver\Monitoring\CommandFailedEvent::getError - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la Exception asociada al comando fallido. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/gethost.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/gethost.xml deleted file mode 100644 index 0b30a7173a..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/gethost.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getHost - Devuelve el nombre de host del servidor para la orden - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandFailedEvent::getHost - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el nombre de host del servidor en el que se ejecutó la orden. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getoperationid.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getoperationid.xml deleted file mode 100644 index 50c5f3e4ef..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getoperationid.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getOperationId - Devuelve el identificador de la operación de la orden - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandFailedEvent::getOperationId - - - - El ID de la operación es generado por la extensión y puede ser utilizado para ligar eventos - juntos, como operaciones de escritura masiva, que pueden haber sido divididas en varias - órdenes a nivel de protocolo. - - - - Dado que varias órdenes pueden compartir el mismo ID de operación, no es fiable - utilizar este valor para asociar objetos de evento entre sí. El ID de petición - devuelto por - MongoDB\Driver\Monitoring\CommandFailedEvent::getRequestId - debería ser utilizado en su lugar. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el identificador de la operación de la orden. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandStartedEvent::getOperationId - MongoDB\Driver\Monitoring\CommandFailedEvent::getRequestId - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getport.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getport.xml deleted file mode 100644 index a2603a916f..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getport.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getPort - Devuelve el puerto del servidor para la orden - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\CommandFailedEvent::getPort - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el puerto del servidor en el cual la orden fue ejecutada. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getreply.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getreply.xml deleted file mode 100644 index 1dee606d19..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getreply.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getReply - Devuelve el documento de respuesta del comando - - - - &reftitle.description; - - final public objectMongoDB\Driver\Monitoring\CommandFailedEvent::getReply - - - - El documento de respuesta será convertido de BSON a PHP utilizando las reglas de - deserialización - por omisión (por ejemplo, los documentos BSON serán convertidos en stdClass). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el documento de respuesta del comando en forma de un - objeto stdClass. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getrequestid.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getrequestid.xml deleted file mode 100644 index aa01a3edcf..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getrequestid.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getRequestId - Devuelve el identificador de la petición de la orden - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandFailedEvent::getRequestId - - - - El identificador de la petición es generado por la extensión y puede ser utilizado para asociar - este MongoDB\Driver\Monitoring\CommandFailedEvent con un - MongoDB\Driver\Monitoring\CommandStartedEvent anterior. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el identificador de la petición de la orden. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandStartedEvent::getRequestId - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getserver.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getserver.xml deleted file mode 100644 index 335eb4d9d0..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getserver.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getServer - Devuelve el servidor en el cual se ejecutó el comando - - - - - - Este método ha sido DEPRECADO a partir de la versión - 1.20.0 de la extensión y ha sido eliminado en la versión 2.0. Las aplicaciones deben utilizar - MongoDB\Driver\Monitoring\CommandFailedEvent::getHost - y - MongoDB\Driver\Monitoring\CommandFailedEvent::getPort - en su lugar. - - - - - - &reftitle.description; - - final public MongoDB\Driver\ServerMongoDB\Driver\Monitoring\CommandFailedEvent::getServer - - - - Devuelve el MongoDB\Driver\Server en el cual se ejecutó el comando. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el MongoDB\Driver\Server en el cual se ejecutó el comando. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.method-removed; - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandStartedEvent::getServer - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getserverconnectionid.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getserverconnectionid.xml deleted file mode 100644 index 90a20ab6ab..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getserverconnectionid.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getServerConnectionId - Devuelve el identificador de conexión del servidor para la orden - - - - &reftitle.description; - - final public intnullMongoDB\Driver\Monitoring\CommandFailedEvent::getServerConnectionId - - - - Devuelve el identificador de conexión del servidor para la orden. El identificador de conexión del servidor es - distinto del servidor (es decir, - MongoDB\Driver\Monitoring\CommandFailedEvent::getServer) - y es devuelto en el campo "connectionId" de una respuesta de orden hello - MongoDB 4.2+. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el identificador de conexión del servidor, o &null; si no está disponible. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getserviceid.xml b/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getserviceid.xml deleted file mode 100644 index 5833d96c6e..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandfailedevent/getserviceid.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandFailedEvent::getServiceId - Devuelve el identificador del servicio del equilibrador de carga para la comanda - - - - &reftitle.description; - - final public MongoDB\BSON\ObjectIdnullMongoDB\Driver\Monitoring\CommandFailedEvent::getServiceId - - - - Cuando el controlador está conectado a un clúster MongoDB a través de un equilibrador de carga, - el identificador del servicio corresponde al campo serviceId en la - respuesta de la comanda hello. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el identificador del servicio del equilibrador de carga, o &null; si el controlador no está - conectado a un equilibrador de carga. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent.xml b/reference/mongodb/mongodb/driver/monitoring/commandstartedevent.xml deleted file mode 100644 index e424875dfe..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent.xml +++ /dev/null @@ -1,226 +0,0 @@ - - - - - - - - La clase MongoDB\Driver\Monitoring\CommandStartedEvent - MongoDB\Driver\Monitoring\CommandStartedEvent - - - - -
    - &reftitle.intro; - - La clase MongoDB\Driver\Monitoring\CommandStartedEvent - contiene la información sobre una orden que ha comenzado. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\CommandStartedEvent - - - - final - - MongoDB\Driver\Monitoring\CommandStartedEvent - - - - - &Properties; - - public - readonly - string - host - - - public - readonly - int - port - - - public - readonly - string - commandName - - - public - readonly - string - databaseName - - - public - readonly - object - command - - - public - readonly - string - operationId - - - public - readonly - string - requestId - - - public - readonly - MongoDB\BSON\ObjectIdnull - serviceId - - - public - readonly - intnull - serverConnectionId - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - host - - El nombre del host del servidor que ejecutó el comando. - - - - port - - El puerto del servidor que ejecutó el comando. - - - - commandName - - El nombre del comando. - - - - databaseName - - El nombre de la base de datos. - - - - command - - El documento del comando. - - - - operationId - - - El identificador de operación. Puede usarse para vincular eventos - entre sí, como en escrituras en bloque, que pueden despachar - varios comandos. - - - - - requestId - - - El identificador de la petición. Puede usarse para asociar este - MongoDB\Driver\Monitoring\CommandStartedEvent - con un - MongoDB\Driver\Monitoring\CommandSucceededEvent - o - MongoDB\Driver\Monitoring\CommandFailedEvent - correspondiente. - - - - - serviceId - - - El identificador de servicio, o &null; si el servidor no lo - soporta (es decir, cuando no se utiliza el modo de balanceo de carga). - - - - - serverConnectionId - - El identificador de la conexión al servidor, o &null; si no está disponible. - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Se añadieron propiedades públicas readonly. - - - - - -
    - -
    - - &reference.mongodb.mongodb.driver.monitoring.entities.commandstartedevent; - -
    - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getcommand.xml b/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getcommand.xml deleted file mode 100644 index 8db2054a02..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getcommand.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandStartedEvent::getCommand - Devuelve el documento de comando - - - - &reftitle.description; - - final public objectMongoDB\Driver\Monitoring\CommandStartedEvent::getCommand - - - - El documento devuelto será convertido de BSON a PHP utilizando las reglas de - deserialización - por omisión (por ejemplo, los documentos BSON serán convertidos en stdClass). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el documento de comando en forma de objeto stdClass. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getcommandname.xml b/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getcommandname.xml deleted file mode 100644 index 2bfa24a3c0..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getcommandname.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandStartedEvent::getCommandName - Devuelve el nombre del comando - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandStartedEvent::getCommandName - - - - Devuelve el nombre del comando (por ejemplo, "find", - "aggregate"). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el nombre del comando. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getdatabasename.xml b/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getdatabasename.xml deleted file mode 100644 index 49f2c76f81..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getdatabasename.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandStartedEvent::getDatabaseName - Devuelve la base de datos sobre la cual se ejecutó el comando - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandStartedEvent::getDatabaseName - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la base de datos sobre la cual se ejecutó el comando. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/gethost.xml b/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/gethost.xml deleted file mode 100644 index 73223f6d41..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/gethost.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandStartedEvent::getHost - Devuelve el nombre del host del servidor para el comando - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandStartedEvent::getHost - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el nombre del host del servidor en el que se ejecutó el comando. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getoperationid.xml b/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getoperationid.xml deleted file mode 100644 index 3a84ed8069..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getoperationid.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandStartedEvent::getOperationId - Devuelve el identificador de la operación de la orden - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandStartedEvent::getOperationId - - - - El identificador de la operación es generado por la extensión y puede ser utilizado - para vincular eventos juntos, tales como operaciones de escritura en masa, que pueden haber sido divididas en varias órdenes a nivel del - protocolo. - - - - Dado que varias órdenes pueden compartir el mismo identificador de operación, no es fiable utilizar este valor para asociar objetos de evento entre sí. El identificador de la petición devuelto por - MongoDB\Driver\Monitoring\CommandStartedEvent::getRequestId - debería ser utilizado en su lugar. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el identificador de la operación de la orden. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandFailedEvent::getOperationId - MongoDB\Driver\Monitoring\CommandSucceededEvent::getOperationId - MongoDB\Driver\Monitoring\CommandStartedEvent::getRequestId - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getport.xml b/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getport.xml deleted file mode 100644 index bb2174d0f0..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getport.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandStartedEvent::getPort - Devuelve el puerto del servidor para la orden - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\CommandStartedEvent::getPort - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el puerto del servidor en el que se ejecutó la orden. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getrequestid.xml b/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getrequestid.xml deleted file mode 100644 index 1d87d9ab5a..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getrequestid.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandStartedEvent::getRequestId - Devuelve el identificador de la solicitud de la orden - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandStartedEvent::getRequestId - - - - El identificador de la solicitud es generado por la extensión y puede ser utilizado - para asociar este evento - MongoDB\Driver\Monitoring\CommandStartedEvent - con un - MongoDB\Driver\Monitoring\CommandFailedEvent o - MongoDB\Driver\Monitoring\CommandSucceededEvent posterior. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el identificador de la solicitud de la orden. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandFailedEvent::getRequestId - MongoDB\Driver\Monitoring\CommandSucceededEvent::getRequestId - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getserver.xml b/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getserver.xml deleted file mode 100644 index 1b5554ba87..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getserver.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandStartedEvent::getServer - Devuelve el servidor en el que se ejecutó el comando - - - - - - Este método ha sido DEPRECADO a partir de la versión - 1.20.0 de la extensión y ha sido eliminado en la versión 2.0. Las aplicaciones deben utilizar - MongoDB\Driver\Monitoring\CommandStartedEvent::getHost - y - MongoDB\Driver\Monitoring\CommandStartedEvent::getPort - en su lugar. - - - - - - &reftitle.description; - - final public MongoDB\Driver\ServerMongoDB\Driver\Monitoring\CommandStartedEvent::getServer - - - - Devuelve el MongoDB\Driver\Server en el que se ejecutó el comando. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el MongoDB\Driver\Server en el que se ejecutó el comando. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.method-removed; - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandFailedEvent::getServer - MongoDB\Driver\Monitoring\CommandSucceededEvent::getServer - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getserverconnectionid.xml b/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getserverconnectionid.xml deleted file mode 100644 index 6421d0f103..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getserverconnectionid.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandStartedEvent::getServerConnectionId - Devuelve el identificador de conexión del servidor para la orden - - - - &reftitle.description; - - final public intnullMongoDB\Driver\Monitoring\CommandStartedEvent::getServerConnectionId - - - - Devuelve el identificador de conexión del servidor para la orden. El identificador de conexión del servidor es - distinto del servidor (es decir, - MongoDB\Driver\Monitoring\CommandFailedEvent::getServer) - y es devuelto en el campo "connectionId" de una respuesta de orden hello - MongoDB 4.2+. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el identificador de conexión del servidor, o &null; si no está disponible. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getserviceid.xml b/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getserviceid.xml deleted file mode 100644 index 3b3f98f18a..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandstartedevent/getserviceid.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandStartedEvent::getServiceId - Devuelve el identificador del servicio del equilibrador de carga para la orden - - - - &reftitle.description; - - final public MongoDB\BSON\ObjectIdnullMongoDB\Driver\Monitoring\CommandStartedEvent::getServiceId - - - - Cuando el controlador está conectado a un clúster MongoDB a través de un equilibrador de carga, - el identificador del servicio corresponde al campo serviceId en la - respuesta de la orden hello. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el identificador del servicio del equilibrador de carga, o &null; si el controlador no está - conectado a un equilibrador de carga. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsubscriber.xml b/reference/mongodb/mongodb/driver/monitoring/commandsubscriber.xml deleted file mode 100644 index f519152d54..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsubscriber.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - La interfaz MongoDB\Driver\Monitoring\CommandSubscriber - MongoDB\Driver\Monitoring\CommandSubscriber - - - - -
    - &reftitle.intro; - - Las clases pueden implementar esta interfaz para registrar un observador - de eventos que es notificado para cada evento de comando iniciado, - para más información. - -
    - - -
    - &reftitle.interfacesynopsis; - - - - MongoDB\Driver\Monitoring\CommandSubscriber - - - - - MongoDB\Driver\Monitoring\CommandSubscriber - - - - MongoDB\Driver\Monitoring\Subscriber - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - &mongodb.changelog.tentative-return-types; - - - -
    -
    - - &reference.mongodb.mongodb.driver.monitoring.entities.commandsubscriber; - -
    - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsubscriber/commandfailed.xml b/reference/mongodb/mongodb/driver/monitoring/commandsubscriber/commandfailed.xml deleted file mode 100644 index 299873b03e..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsubscriber/commandfailed.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSubscriber::commandFailed - Método de notificación para una orden fallida - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\CommandSubscriber::commandFailed - MongoDB\Driver\Monitoring\CommandFailedEventevent - - - Si el observador está registrado, este método es llamado cuando una orden falla. - - - - - &reftitle.parameters; - - - event (MongoDB\Driver\Monitoring\CommandFailedEvent) - - - Un objeto de evento que encapsula información sobre la orden fallida. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandFailedEvent - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsubscriber/commandstarted.xml b/reference/mongodb/mongodb/driver/monitoring/commandsubscriber/commandstarted.xml deleted file mode 100644 index f740bad801..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsubscriber/commandstarted.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSubscriber::commandStarted - Método de notificación para una orden iniciada - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\CommandSubscriber::commandStarted - MongoDB\Driver\Monitoring\CommandStartedEventevent - - - Si el observador está registrado, este método es llamado cuando una orden es enviada - al servidor. - - - - - &reftitle.parameters; - - - event (MongoDB\Driver\Monitoring\CommandStartedEvent) - - - Un objeto de evento que encapsula información sobre la orden iniciada. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandStartedEvent - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsubscriber/commandsucceeded.xml b/reference/mongodb/mongodb/driver/monitoring/commandsubscriber/commandsucceeded.xml deleted file mode 100644 index f361b56b29..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsubscriber/commandsucceeded.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSubscriber::commandSucceeded - Método de notificación para un comando exitoso - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\CommandSubscriber::commandSucceeded - MongoDB\Driver\Monitoring\CommandSucceededEventevent - - - Si el observador está registrado, este método es llamado cuando un - comando tiene éxito. - - - - - &reftitle.parameters; - - - event (MongoDB\Driver\Monitoring\CommandSucceededEvent) - - - Un objeto de evento que encapsula información sobre el comando exitoso. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandSucceededEvent - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent.xml deleted file mode 100644 index 951bafa287..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent.xml +++ /dev/null @@ -1,239 +0,0 @@ - - - - - La clase MongoDB\Driver\Monitoring\CommandSucceededEvent - MongoDB\Driver\Monitoring\CommandSucceededEvent - - - - -
    - &reftitle.intro; - - La clase MongoDB\Driver\Monitoring\CommandSucceededEvent - encapsula información sobre un comando exitoso. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent - - - - final - - MongoDB\Driver\Monitoring\CommandSucceededEvent - - - - - &Properties; - - public - readonly - string - host - - - public - readonly - int - port - - - public - readonly - string - commandName - - - public - readonly - string - databaseName - - - public - readonly - int - duration - - - public - readonly - object - reply - - - public - readonly - string - operationId - - - public - readonly - string - requestId - - - public - readonly - MongoDB\BSON\ObjectIdnull - serviceId - - - public - readonly - intnull - serverConnectionId - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - host - - El nombre del host del servidor que ejecutó el comando. - - - - port - - El puerto del servidor que ejecutó el comando. - - - - commandName - - El nombre del comando. - - - - databaseName - - El nombre de la base de datos. - - - - duration - - - La duración del comando en microsegundos. La duración es un - valor calculado que incluye el tiempo necesario para enviar el - mensaje y recibir la respuesta del servidor. - - - - - reply - - El documento de respuesta devuelto por el servidor. - - - - operationId - - - El identificador de operación. Puede usarse para vincular eventos - entre sí, como en escrituras en bloque, que pueden despachar - varios comandos. - - - - - requestId - - - El identificador de la petición. Puede usarse para asociar este - MongoDB\Driver\Monitoring\CommandSucceededEvent - con un - MongoDB\Driver\Monitoring\CommandStartedEvent - correspondiente. - - - - - serviceId - - - El identificador de servicio, o &null; si el servidor no lo - soporta (es decir, cuando no se utiliza el modo de balanceo de carga). - - - - - serverConnectionId - - El identificador de la conexión al servidor, o &null; si no está disponible. - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Se añadieron propiedades públicas readonly. La - propiedad duration reemplaza al método - getDurationMicros. - - - - - -
    - -
    - - &reference.mongodb.mongodb.driver.monitoring.entities.commandsucceededevent; - -
    - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getcommandname.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getcommandname.xml deleted file mode 100644 index 66618ba69d..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getcommandname.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent::getCommandName - Devuelve el nombre del comando - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandSucceededEvent::getCommandName - - - - Devuelve el nombre del comando (por ejemplo "find", - "aggregate"). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el nombre del comando. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getdatabasename.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getdatabasename.xml deleted file mode 100644 index 36787f1211..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getdatabasename.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent::getDatabaseName - Devuelve el nombre de la base de datos sobre la cual se ejecutó el comando - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandSucceededEvent::getDatabaseName - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el nombre de la base de datos sobre la cual se ejecutó el comando. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getdurationmicros.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getdurationmicros.xml deleted file mode 100644 index fb11e276ba..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getdurationmicros.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent::getDurationMicros - Devuelve la duración del comando en microsegundos - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\CommandSucceededEvent::getDurationMicros - - - - La duración del comando es un valor calculado que incluye el tiempo para enviar - el mensaje y recibir la respuesta del servidor. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la duración del comando en microsegundos. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/gethost.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/gethost.xml deleted file mode 100644 index 8b2bf828ce..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/gethost.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent::getHost - Devuelve el nombre de host del servidor para el comando - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandSucceededEvent::getHost - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el nombre de host del servidor en el que se ejecutó el comando. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getoperationid.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getoperationid.xml deleted file mode 100644 index 87b8f1063f..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getoperationid.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent::getOperationId - Devuelve el identificador de la operación de la orden - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandSucceededEvent::getOperationId - - - - El identificador de la operación es generado por la extensión y puede ser utilizado para vincular eventos - juntos tales como operaciones de escritura en masa, que pueden haber sido divididas - en varias órdenes a nivel del protocolo. - - - - Dado que varias órdenes pueden compartir el mismo identificador de operación, no es fiable - utilizar este valor para asociar objetos de evento entre sí. El identificador de la petición - devuelto por - MongoDB\Driver\Monitoring\CommandSucceededEvent::getRequestId - debería ser utilizado en su lugar. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el identificador de la operación de la orden. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandStartedEvent::getOperationId - MongoDB\Driver\Monitoring\CommandSucceededEvent::getRequestId - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getport.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getport.xml deleted file mode 100644 index ab66e2f1e9..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getport.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent::getPort - Devuelve el puerto del servidor para la orden - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\CommandSucceededEvent::getPort - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el puerto del servidor en el cual la orden fue ejecutada. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getreply.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getreply.xml deleted file mode 100644 index 6691bc78ed..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getreply.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent::getReply - Devuelve el documento de respuesta de la orden - - - - &reftitle.description; - - final public objectMongoDB\Driver\Monitoring\CommandSucceededEvent::getReply - - - - El documento de respuesta será convertido de BSON a PHP utilizando las reglas de - deserialización - por omisión (por ejemplo, los documentos BSON serán convertidos en stdClass). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el documento de respuesta de la orden en forma de un objeto - stdClass. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getrequestid.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getrequestid.xml deleted file mode 100644 index cbc7863f5e..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getrequestid.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent::getRequestId - Devuelve el identificador de la solicitud de la orden - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\CommandSucceededEvent::getRequestId - - - - El identificador de la solicitud es generado por la extensión y puede ser utilizado para asociar - este MongoDB\Driver\Monitoring\CommandSucceededEvent con un - MongoDB\Driver\Monitoring\CommandStartedEvent anterior. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el identificador de la solicitud de la orden. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandStartedEvent::getRequestId - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getserver.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getserver.xml deleted file mode 100644 index e5c9a0390f..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getserver.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent::getServer - Devuelve el servidor en el cual el comando fue ejecutado - - - - - - Este método ha sido DEPRECADO a partir de la versión - 1.20.0 de la extensión y ha sido eliminado en la versión 2.0. Las aplicaciones deben utilizar - MongoDB\Driver\Monitoring\CommandSucceededEvent::getHost - y - MongoDB\Driver\Monitoring\CommandSucceededEvent::getPort - en su lugar. - - - - - - &reftitle.description; - - final public MongoDB\Driver\ServerMongoDB\Driver\Monitoring\CommandSucceededEvent::getServer - - - - Devuelve el MongoDB\Driver\Server en el cual el comando - fue ejecutado. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el MongoDB\Driver\Server en el cual el comando - fue ejecutado. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.method-removed; - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\CommandStartedEvent::getServer - MongoDB\Driver\Cursor::getServer - MongoDB\Driver\WriteResult::getServer - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getserverconnectionid.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getserverconnectionid.xml deleted file mode 100644 index 0f8c6412d1..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getserverconnectionid.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent::getServerConnectionId - Devuelve el identificador de conexión del servidor para la orden - - - - &reftitle.description; - - final public intnullMongoDB\Driver\Monitoring\CommandSucceededEvent::getServerConnectionId - - - - Devuelve el identificador de conexión del servidor para la orden. El identificador de conexión del servidor es - distinto del servidor (es decir, - MongoDB\Driver\Monitoring\CommandSucceededEvent::getServer) - y es devuelto en el campo "connectionId" de una respuesta de orden hello - MongoDB 4.2+. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el identificador de conexión del servidor, o &null; si no está disponible. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getserviceid.xml b/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getserviceid.xml deleted file mode 100644 index fd0da3dac0..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/commandsucceededevent/getserviceid.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\CommandSucceededEvent::getServiceId - Devuelve el identificador del servicio del balanceador de carga para la orden - - - - &reftitle.description; - - final public MongoDB\BSON\ObjectIdnullMongoDB\Driver\Monitoring\CommandSucceededEvent::getServiceId - - - - Cuando el controlador está conectado a un clúster MongoDB a través de un balanceador de carga, - el identificador del servicio corresponde al campo serviceId en la - respuesta de la orden hello. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el identificador del servicio del balanceador de carga, o &null; si el controlador no está - conectado a un balanceador de carga. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/logsubscriber.xml b/reference/mongodb/mongodb/driver/monitoring/logsubscriber.xml deleted file mode 100644 index 3541966ba5..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/logsubscriber.xml +++ /dev/null @@ -1,171 +0,0 @@ - - - - - La interfaz MongoDB\Driver\Monitoring\LogSubscriber - MongoDB\Driver\Monitoring\LogSubscriber - - - - -
    - &reftitle.intro; - - Las clases que implementan esta interfaz pueden ser registradas como observadores y recibir mensajes de registro de la extensión. Esto es similar al registro de depuración basado en flujos (es decir, mongodb.debug) excepto que los mensajes de registro de nivel trace no son recibidos. - - - Al igual que con el registro basado en flujos, solo es posible registrar un registrador globalmente utilizando MongoDB\Driver\Monitoring\addSubscriber. La extensión no es capaz de distinguir los mensajes de registro para objetos MongoDB\Driver\Manager individuales. - -
    - - -
    - &reftitle.interfacesynopsis; - - - - MongoDB\Driver\Monitoring\LogSubscriber - - - - - MongoDB\Driver\Monitoring\LogSubscriber - - - - MongoDB\Driver\Monitoring\Subscriber - - - - - &Constants; - - const - int - MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_ERROR - 0 - - - const - int - MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_CRITICAL - 1 - - - const - int - MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_WARNING - 2 - - - const - int - MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_MESSAGE - 3 - - - const - int - MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_INFO - 4 - - - const - int - MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_DEBUG - 5 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_ERROR - - - El nivel de registro de error. Una condición de error que la extensión no es capaz de reportar a través de su API. Es el nivel de registro más severo de la extensión. - - - - - - MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_CRITICAL - - - El nivel de registro crítico. Una condición de error con una severidad ligeramente inferior. Esta constante existe para la coherencia con libmongoc; sin embargo, la extensión es poco susceptible de utilizarla en la práctica. - - - - - - MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_WARNING - - - El nivel de registro de advertencia. Indica una situación donde un comportamiento indeseable de la aplicación puede ocurrir. - - - - - - MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_MESSAGE - - - El nivel de registro de mensaje o notificación. Indica un evento inusual pero no problemático. - - - - - - MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_INFO - - - El nivel de registro de información. Información de alto nivel sobre el comportamiento normal del controlador. - - - - - - MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_DEBUG - - - El nivel de registro de depuración. Información detallada que puede ser útil durante la depuración de una aplicación. - - - - -
    - -
    - - &reference.mongodb.mongodb.driver.monitoring.entities.logsubscriber; - -
    - - diff --git a/reference/mongodb/mongodb/driver/monitoring/logsubscriber/log.xml b/reference/mongodb/mongodb/driver/monitoring/logsubscriber/log.xml deleted file mode 100644 index 368cd64c12..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/logsubscriber/log.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\LogSubscriber::log - Método de notificación para un mensaje de registro - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\LogSubscriber::log - intlevel - stringdomain - stringmessage - - - Si el observador está registrado, este método es llamado para cada mensaje - de registro registrado. - - - - - &reftitle.parameters; - - - level - - - El nivel de gravedad. Será uno de los - constantes de interfaz. - - - - - domain - - - El nombre del componente del controlador que emitió el mensaje de registro. - - - - - message - - - El mensaje de registro. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\addSubscriber - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber.xml b/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber.xml deleted file mode 100644 index cd028fb56c..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - La interfaz MongoDB\Driver\Monitoring\SDAMSubscriber - MongoDB\Driver\Monitoring\SDAMSubscriber - - - - -
    - &reftitle.intro; - - Las clases pueden implementar esta interfaz para registrar un observador - de eventos que es notificado para diversos eventos SDAM. Ver las - especificaciones Descubrimiento y supervisión de server - y Supervisión de SDAM - para más información. - -
    - - -
    - &reftitle.interfacesynopsis; - - - - MongoDB\Driver\Monitoring\SDAMSubscriber - - - - - MongoDB\Driver\Monitoring\SDAMSubscriber - - - - MongoDB\Driver\Monitoring\Subscriber - - - - - &Methods; - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.tentative-return-types-enforced; - &mongodb.changelog.tentative-return-types; - - - -
    -
    - - &reference.mongodb.mongodb.driver.monitoring.entities.sdamsubscriber; - -
    - - diff --git a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverchanged.xml b/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverchanged.xml deleted file mode 100644 index d64167629f..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverchanged.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\SDAMSubscriber::serverChanged - Método de notificación para un cambio de descripción de servidor - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\SDAMSubscriber::serverChanged - MongoDB\Driver\Monitoring\ServerChangedEventevent - - - Si un observador está registrado, este método es llamado cuando una - descripción de servidor cambia. Por ejemplo, el tipo de un servidor pasando de secundario a - primario resultaría en un cambio de la descripción de ese servidor. - - - - - &reftitle.parameters; - - - event (MongoDB\Driver\Monitoring\ServerChangedEvent) - - - Un objeto de evento que encapsula información sobre la descripción de - servidor modificada. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\ServerChangedEvent - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverclosed.xml b/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverclosed.xml deleted file mode 100644 index 32813bafda..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverclosed.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\SDAMSubscriber::serverClosed - Método de notificación para el cierre de un servidor - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\SDAMSubscriber::serverClosed - MongoDB\Driver\Monitoring\ServerClosedEventevent - - - Si un observador está registrado, este método es llamado cuando un servidor existente - es retirado de la topología. - - - - - &reftitle.parameters; - - - event (MongoDB\Driver\Monitoring\ServerClosedEvent) - - - Un objeto de evento que encapsula información sobre el servidor cerrado. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\ServerClosedEvent - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverheartbeatfailed.xml b/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverheartbeatfailed.xml deleted file mode 100644 index 9de109d6ab..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverheartbeatfailed.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\SDAMSubscriber::serverHeartbeatFailed - Método de notificación para un fallo de latido de servidor - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\SDAMSubscriber::serverHeartbeatFailed - MongoDB\Driver\Monitoring\ServerHeartbeatFailedEventevent - - - Si un observador está registrado, este método es llamado cuando un latido de servidor (es decir, un comando - hello - emitido mediante - monitoreo de servidor) falla. - - - - - &reftitle.parameters; - - - event (MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent) - - - Un objeto de evento que encapsula información sobre el fallo de latido de servidor. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverheartbeatstarted.xml b/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverheartbeatstarted.xml deleted file mode 100644 index 80189de8d0..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverheartbeatstarted.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\SDAMSubscriber::serverHeartbeatStarted - Método de notificación para un latido de servidor iniciado - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\SDAMSubscriber::serverHeartbeatStarted - MongoDB\Driver\Monitoring\ServerHeartbeatStartedEventevent - - - Si un observador está registrado, este método es llamado cuando un latido de servidor (es decir, un comando - hello - emitido a través de - monitoreo de servidor) es enviado - al servidor. - - - - - &reftitle.parameters; - - - event (MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent) - - - Un objeto de evento que encapsula información sobre el latido de servidor iniciado. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverheartbeatsucceeded.xml b/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverheartbeatsucceeded.xml deleted file mode 100644 index 5b79eed77b..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serverheartbeatsucceeded.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\SDAMSubscriber::serverHeartbeatSucceeded - Método de notificación para un latido de servidor exitoso - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\SDAMSubscriber::serverHeartbeatSucceeded - MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEventevent - - - Si un observador está registrado, este método es llamado cuando un latido de servidor (es decir, una comando - hello - emitido a través de - monitoreo de servidor) tiene éxito. - - - - - &reftitle.parameters; - - - event (MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent) - - - Un objeto de evento que encapsula información sobre el latido de servidor exitoso. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serveropening.xml b/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serveropening.xml deleted file mode 100644 index e6836eede2..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/serveropening.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\SDAMSubscriber::serverOpening - Método de notificación para la apertura de un servidor - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\SDAMSubscriber::serverOpening - MongoDB\Driver\Monitoring\ServerOpeningEventevent - - - Si un observador está registrado, este método es llamado cuando un servidor existente - es retirado de la topología. - - - - - &reftitle.parameters; - - - event (MongoDB\Driver\Monitoring\ServerOpeningEvent) - - - Un objeto de evento que encapsula información sobre el servidor abierto. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\ServerOpeningEvent - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/topologychanged.xml b/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/topologychanged.xml deleted file mode 100644 index 286c4c174a..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/topologychanged.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\SDAMSubscriber::topologyChanged - Método de notificación para un cambio de descripción de topología - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\SDAMSubscriber::topologyChanged - MongoDB\Driver\Monitoring\TopologyChangedEventevent - - - Si un observador está registrado, este método es llamado cuando una - descripción de topología cambia. Por ejemplo, el descubrimiento de un nuevo primario en un conjunto de réplicas - resultaría en un cambio de la descripción de la topología. - - - - - &reftitle.parameters; - - - event (MongoDB\Driver\Monitoring\TopologyChangedEvent) - - - Un objeto de evento que encapsula información sobre la descripción de - topología modificada. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\TopologyChangedEvent - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/topologyclosed.xml b/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/topologyclosed.xml deleted file mode 100644 index 4280c1b7ea..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/topologyclosed.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\SDAMSubscriber::topologyClosed - Método de notificación para el cierre de topología - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\SDAMSubscriber::topologyClosed - MongoDB\Driver\Monitoring\TopologyClosedEventevent - - - Si un observador está registrado, este método es llamado cuando una - topología es cerrada. - - - - Debido al comportamiento del controlador - de gestión y persistencia de conexiones, - este evento solo puede ser observado cuando un - MongoDB\Driver\Manager es creado con la opción del controlador - "disableClientPersistence" y liberado antes del cierre de la solicitud (RSHUTDOWN). - - - - - - &reftitle.parameters; - - - event (MongoDB\Driver\Monitoring\TopologyClosedEvent) - - - Un objeto de evento que encapsula información sobre la topología cerrada. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\TopologyClosedEvent - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/topologyopening.xml b/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/topologyopening.xml deleted file mode 100644 index 695a69a1e2..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/sdamsubscriber/topologyopening.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\SDAMSubscriber::topologyOpening - Método de notificación para la apertura de topología - - - - &reftitle.description; - - abstract public voidMongoDB\Driver\Monitoring\SDAMSubscriber::topologyOpening - MongoDB\Driver\Monitoring\TopologyOpeningEventevent - - - Si un observador está registrado, este método es llamado cuando una - topología es abierta. - - - - Debido al comportamiento del controlador - de gestión y persistencia de conexiones, - este evento puede no ser observado si un - MongoDB\Driver\Manager utiliza un cliente - libmongoc previamente persistente. - - - - - - &reftitle.parameters; - - - event (MongoDB\Driver\Monitoring\TopologyOpeningEvent) - - - Un objeto de evento que encapsula información sobre la topología abierta. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Monitoring\TopologyOpeningEvent - MongoDB\Driver\Monitoring\addSubscriber - MongoDB\Driver\Manager::addSubscriber - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent.xml b/reference/mongodb/mongodb/driver/monitoring/serverchangedevent.xml deleted file mode 100644 index d81da68db2..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - La clase MongoDB\Driver\Monitoring\ServerChangedEvent - MongoDB\Driver\Monitoring\ServerChangedEvent - - - - -
    - &reftitle.intro; - - La clase MongoDB\Driver\Monitoring\ServerChangedEvent - encapsula información sobre una descripción de servidor modificada. Por - ejemplo, el tipo de un servidor pasando de secundario a primario entraînerait - un cambio en la descripción de este servidor. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\ServerChangedEvent - - - - final - - MongoDB\Driver\Monitoring\ServerChangedEvent - - - - - &Properties; - - public - readonly - string - host - - - public - readonly - int - port - - - public - readonly - MongoDB\BSON\ObjectId - topologyId - - - public - readonly - MongoDB\Driver\ServerDescription - newDescription - - - public - readonly - MongoDB\Driver\ServerDescription - previousDescription - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - host - - El nombre de host del servidor. - - - - port - - El puerto del servidor. - - - - topologyId - - El identificador de la topología. - - - - newDescription - - La nueva descripción del servidor. - - - - previousDescription - - La descripción previa del servidor. - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Se añadieron propiedades públicas readonly. - - - - - -
    - -
    - - &reference.mongodb.mongodb.driver.monitoring.entities.serverchangedevent; - -
    - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/gethost.xml b/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/gethost.xml deleted file mode 100644 index d4ff520f53..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/gethost.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerChangedEvent::getHost - Devuelve el nombre del host del servidor - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\ServerChangedEvent::getHost - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el nombre del host del servidor. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/getnewdescription.xml b/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/getnewdescription.xml deleted file mode 100644 index b19cf2c580..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/getnewdescription.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerChangedEvent::getNewDescription - Devuelve la nueva descripción del servidor - - - - &reftitle.description; - - final public MongoDB\Driver\ServerDescriptionMongoDB\Driver\Monitoring\ServerChangedEvent::getNewDescription - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la nueva MongoDB\Driver\ServerDescription - del servidor. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/getport.xml b/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/getport.xml deleted file mode 100644 index bc3cfca06b..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/getport.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerChangedEvent::getPort - Devuelve el puerto en el que este servidor está escuchando - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\ServerChangedEvent::getPort - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el puerto en el que este servidor está escuchando. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/getpreviousdescription.xml b/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/getpreviousdescription.xml deleted file mode 100644 index d506d62db5..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/getpreviousdescription.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerChangedEvent::getPreviousDescription - Devuelve la descripción anterior del servidor - - - - &reftitle.description; - - final public MongoDB\Driver\ServerDescriptionMongoDB\Driver\Monitoring\ServerChangedEvent::getPreviousDescription - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la MongoDB\Driver\ServerDescription anterior - del servidor. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/gettopologyid.xml b/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/gettopologyid.xml deleted file mode 100644 index c4b680e480..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverchangedevent/gettopologyid.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerChangedEvent::getTopologyId - Devuelve el ID de topología asociado a este servidor - - - - &reftitle.description; - - final public MongoDB\BSON\ObjectIdMongoDB\Driver\Monitoring\ServerChangedEvent::getTopologyId - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el ID de topología. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverclosedevent.xml b/reference/mongodb/mongodb/driver/monitoring/serverclosedevent.xml deleted file mode 100644 index 953e845872..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverclosedevent.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - La clase MongoDB\Driver\Monitoring\ServerClosedEvent - MongoDB\Driver\Monitoring\ServerClosedEvent - - - - -
    - &reftitle.intro; - - La clase MongoDB\Driver\Monitoring\ServerClosedEvent - encapsula información sobre un servidor cerrado. Esto corresponde a un - servidor existente que ha sido retirado de la topología. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\ServerClosedEvent - - - - final - - MongoDB\Driver\Monitoring\ServerClosedEvent - - - - - &Properties; - - public - readonly - string - host - - - public - readonly - int - port - - - public - readonly - MongoDB\BSON\ObjectId - topologyId - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - host - - El nombre de host del servidor. - - - - port - - El puerto del servidor. - - - - topologyId - - El identificador de la topología. - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Se añadieron propiedades públicas readonly. - - - - - -
    - -
    - - &reference.mongodb.mongodb.driver.monitoring.entities.serverclosedevent; - -
    - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverclosedevent/gethost.xml b/reference/mongodb/mongodb/driver/monitoring/serverclosedevent/gethost.xml deleted file mode 100644 index f59700e177..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverclosedevent/gethost.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerClosedEvent::getHost - Devuelve el nombre de host del servidor - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\ServerClosedEvent::getHost - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el nombre de host del servidor. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverclosedevent/getport.xml b/reference/mongodb/mongodb/driver/monitoring/serverclosedevent/getport.xml deleted file mode 100644 index 2398210e06..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverclosedevent/getport.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerClosedEvent::getPort - Devuelve el puerto en el que este servidor escucha - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\ServerClosedEvent::getPort - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el puerto en el que este servidor escucha. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverclosedevent/gettopologyid.xml b/reference/mongodb/mongodb/driver/monitoring/serverclosedevent/gettopologyid.xml deleted file mode 100644 index b71cb3b911..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverclosedevent/gettopologyid.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerClosedEvent::getTopologyId - Devuelve el ID de topología asociado a este servidor - - - - &reftitle.description; - - final public MongoDB\BSON\ObjectIdMongoDB\Driver\Monitoring\ServerClosedEvent::getTopologyId - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el ID de topología. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent.xml deleted file mode 100644 index 6301a07b36..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent.xml +++ /dev/null @@ -1,173 +0,0 @@ - - - - - La clase MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent - MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent - - - - -
    - &reftitle.intro; - - La clase MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent - encapsula información sobre un fallo de latido de servidor (es decir, - hello - comando emitido por - monitoreo del servidor). - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent - - - - final - - MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent - - - - - &Properties; - - public - readonly - string - host - - - public - readonly - int - port - - - public - readonly - bool - awaited - - - public - readonly - int - duration - - - public - readonly - Exception - error - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - host - - El nombre de host del servidor. - - - - port - - El puerto del servidor. - - - - awaited - - - Indica si el latido utilizó un protocolo de streaming. La extensión no - utiliza el protocolo de streaming para la monitorización, por lo que - este método siempre devolverá &false;. - - - - - duration - - - La duración del latido en microsegundos. La duración es un valor - calculado que incluye el tiempo de envío del mensaje y de recepción - de la respuesta del servidor. - - - - - error - - La excepción lanzada cuando el latido falló. - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Se añadieron propiedades públicas readonly. La - propiedad duration reemplaza al método - getDurationMicros. - - - - - -
    - -
    - - &reference.mongodb.mongodb.driver.monitoring.entities.serverheartbeatfailedevent; - -
    - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/getdurationmicros.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/getdurationmicros.xml deleted file mode 100644 index 1e7b1b2883..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/getdurationmicros.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::getDurationMicros - Devuelve la duración del latido en microsegundos - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::getDurationMicros - - - - La duración del latido es un valor calculado que incluye el tiempo - para enviar el mensaje y recibir la respuesta del servidor. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la duración del latido en microsegundos. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/geterror.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/geterror.xml deleted file mode 100644 index 709eb0d05f..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/geterror.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::getError - Devuelve la excepción asociada al fallo del latido periódico - - - - &reftitle.description; - - final public ExceptionMongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::getError - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la Exception asociada al fallo del latido periódico. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/gethost.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/gethost.xml deleted file mode 100644 index 7da30a067a..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/gethost.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::getHost - Devuelve el nombre de host del servidor - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::getHost - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el nombre de host del servidor. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/getport.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/getport.xml deleted file mode 100644 index 2c8d2e43a4..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/getport.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::getPort - Devuelve el puerto en el que este servidor escucha - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::getPort - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el puerto en el que este servidor escucha. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/isawaited.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/isawaited.xml deleted file mode 100644 index 65938245be..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatfailedevent/isawaited.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::isAwaited - Indica si el latido periódico ha utilizado un protocolo de difusión de flujo - - - - &reftitle.description; - - final public boolMongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::isAwaited - - - - Indica si el latido periódico ha utilizado un protocolo de difusión de flujo. - La extensión no utiliza el protocolo de difusión de flujo para la supervisión, por lo tanto, este método siempre devolverá - &false;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &false;. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent.xml deleted file mode 100644 index 6900823395..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - La clase MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent - MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent - - - - -
    - &reftitle.intro; - - La clase MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent - encapsula información sobre un latido de servidor iniciado (es decir, - comando hello - emitido a través de - la supervisión del servidor). - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent - - - - final - - MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent - - - - - &Properties; - - public - readonly - string - host - - - public - readonly - int - port - - - public - readonly - bool - awaited - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - host - - El host del servidor. - - - - port - - El puerto del servidor. - - - - awaited - - - Indica si el latido utilizó un protocolo de transmisión continua. La extensión no - utiliza el protocolo de transmisión continua para la supervisión, por lo que este método siempre - devolverá &false;. - - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Se añadieron propiedades públicas readonly. - - - - - -
    - -
    - - &reference.mongodb.mongodb.driver.monitoring.entities.serverheartbeatstartedevent; - -
    - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent/gethost.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent/gethost.xml deleted file mode 100644 index 07598dab11..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent/gethost.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent::getHost - Devuelve el nombre del host del servidor - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent::getHost - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el nombre del host del servidor. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent/getport.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent/getport.xml deleted file mode 100644 index b87b496a74..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent/getport.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent::getPort - Devuelve el puerto en el que este servidor está escuchando - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent::getPort - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el puerto en el que este servidor está escuchando. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent/isawaited.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent/isawaited.xml deleted file mode 100644 index 3962044de2..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent/isawaited.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent::isAwaited - Indica si el latido periódico ha utilizado un protocolo de difusión de flujo - - - - &reftitle.description; - - final public boolMongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent::isAwaited - - - - Indica si el latido periódico ha utilizado un protocolo de difusión de flujo. - La extensión no utiliza el protocolo de difusión de flujo para la monitorización, por lo que este método siempre devolverá - &false;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &false;. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent.xml deleted file mode 100644 index b850dee4c3..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent.xml +++ /dev/null @@ -1,173 +0,0 @@ - - - - - La clase MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent - MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent - - - - -
    - &reftitle.intro; - - La clase MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent - encapsula información sobre un latido de servidor exitoso (es decir, - comando hello - emitido a través de - la supervisión del servidor). - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent - - - - final - - MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent - - - - - &Properties; - - public - readonly - string - host - - - public - readonly - int - port - - - public - readonly - bool - awaited - - - public - readonly - int - duration - - - public - readonly - object - reply - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - host - - El host del servidor. - - - - port - - El puerto del servidor. - - - - awaited - - - Indica si el latido utilizó un protocolo de transmisión continua. La extensión no - utiliza el protocolo de transmisión continua para la supervisión, por lo que este método siempre - devolverá &false;. - - - - - duration - - - La duración del latido en microsegundos. La duración es un - valor calculado que incluye el tiempo necesario para enviar el mensaje y - recibir la respuesta del servidor. - - - - - reply - - El documento de respuesta devuelto por el servidor. - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Se añadieron propiedades públicas readonly. La - propiedad duration reemplaza al método - getDurationMicros. - - - - - -
    - -
    - - &reference.mongodb.mongodb.driver.monitoring.entities.serverheartbeatsucceededevent; - -
    - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/getdurationmicros.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/getdurationmicros.xml deleted file mode 100644 index 2c56a1e215..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/getdurationmicros.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent::getDurationMicros - Devuelve la duración del latido en microsegundos - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent::getDurationMicros - - - - La duración del latido es un valor calculado que incluye el tiempo - para enviar el mensaje y recibir la respuesta del servidor. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la duración del latido en microsegundos. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/gethost.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/gethost.xml deleted file mode 100644 index 02f4e4c49f..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/gethost.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent::getHost - Devuelve el nombre de host del servidor - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent::getHost - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el nombre de host del servidor. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/getport.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/getport.xml deleted file mode 100644 index fb0a950cd5..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/getport.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent::getPort - Devuelve el puerto en el que este servidor escucha - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent::getPort - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el puerto en el que este servidor escucha. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/getreply.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/getreply.xml deleted file mode 100644 index 7207f60637..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/getreply.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent::getReply - Devuelve el documento de respuesta del heartbeat - - - - &reftitle.description; - - final public objectMongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent::getReply - - - - El documento de respuesta será convertido de BSON a PHP utilizando las reglas de - deserialización - por omisión (por ejemplo, los documentos BSON serán convertidos en stdClass). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el documento de respuesta del heartbeat en forma de un objeto - stdClass. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/isawaited.xml b/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/isawaited.xml deleted file mode 100644 index c20586b877..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serverheartbeatsucceededevent/isawaited.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent::isAwaited - Indica si el latido periódico ha utilizado un protocolo de difusión de flujo - - - - &reftitle.description; - - final public boolMongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent::isAwaited - - - - Indica si el latido periódico ha utilizado un protocolo de difusión de flujo. - La extensión no utiliza el protocolo de difusión de flujo para la supervisión, por lo que este método siempre devolverá - &false;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &false;. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serveropeningevent.xml b/reference/mongodb/mongodb/driver/monitoring/serveropeningevent.xml deleted file mode 100644 index c278f22eb6..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serveropeningevent.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - La clase MongoDB\Driver\Monitoring\ServerOpeningEvent - MongoDB\Driver\Monitoring\ServerOpeningEvent - - - - -
    - &reftitle.intro; - - La clase MongoDB\Driver\Monitoring\ServerOpeningEvent - encapsula información sobre un servidor abierto. Esto corresponde a un - nuevo servidor que se añade a la topología. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\ServerOpeningEvent - - - - final - - MongoDB\Driver\Monitoring\ServerOpeningEvent - - - - - &Properties; - - public - readonly - string - host - - - public - readonly - int - port - - - public - readonly - MongoDB\BSON\ObjectId - topologyId - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - host - - El host del servidor. - - - - port - - El puerto del servidor. - - - - topologyId - - El identificador de la topología. - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Se añadieron propiedades públicas readonly. - - - - - -
    - -
    - - &reference.mongodb.mongodb.driver.monitoring.entities.serveropeningevent; - -
    - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serveropeningevent/gethost.xml b/reference/mongodb/mongodb/driver/monitoring/serveropeningevent/gethost.xml deleted file mode 100644 index 625a69325a..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serveropeningevent/gethost.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerOpeningEvent::getHost - Devuelve el nombre de host del servidor - - - - &reftitle.description; - - final public stringMongoDB\Driver\Monitoring\ServerOpeningEvent::getHost - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el nombre de host del servidor. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serveropeningevent/getport.xml b/reference/mongodb/mongodb/driver/monitoring/serveropeningevent/getport.xml deleted file mode 100644 index c5f09d7f8c..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serveropeningevent/getport.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerOpeningEvent::getPort - Devuelve el puerto en el que este servidor está escuchando - - - - &reftitle.description; - - final public intMongoDB\Driver\Monitoring\ServerOpeningEvent::getPort - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el puerto en el que este servidor está escuchando. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/serveropeningevent/gettopologyid.xml b/reference/mongodb/mongodb/driver/monitoring/serveropeningevent/gettopologyid.xml deleted file mode 100644 index 0c0d21c019..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/serveropeningevent/gettopologyid.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\ServerOpeningEvent::getTopologyId - Devuelve el ID de topología asociado a este servidor - - - - &reftitle.description; - - final public MongoDB\BSON\ObjectIdMongoDB\Driver\Monitoring\ServerOpeningEvent::getTopologyId - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el ID de topología. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/subscriber.xml b/reference/mongodb/mongodb/driver/monitoring/subscriber.xml deleted file mode 100644 index 7cf901fcda..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/subscriber.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - La interfaz MongoDB\Driver\Monitoring\Subscriber - MongoDB\Driver\Monitoring\Subscriber - - - - -
    - &reftitle.intro; - - La interfaz base para los observadores de eventos. Es utilizada como tipo de argumento en las funciones - MongoDB\Driver\Monitoring\addSubscriber y - MongoDB\Driver\Monitoring\removeSubscriber y no debe - ser implementada directamente. - -
    - - -
    - &reftitle.interfacesynopsis; - - - - MongoDB\Driver\Monitoring\Subscriber - - - - - MongoDB\Driver\Monitoring\Subscriber - - - - - - - - - Esta interfaz no tiene métodos. Su único propósito es ser la interfaz base - para todos los observadores de eventos. - - -
    - -
    - -
    - - diff --git a/reference/mongodb/mongodb/driver/monitoring/topologychangedevent.xml b/reference/mongodb/mongodb/driver/monitoring/topologychangedevent.xml deleted file mode 100644 index e279f870f4..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/topologychangedevent.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - La clase MongoDB\Driver\Monitoring\TopologyChangedEvent - MongoDB\Driver\Monitoring\TopologyChangedEvent - - - - -
    - &reftitle.intro; - - La clase MongoDB\Driver\Monitoring\TopologyChangedEvent - encapsula información sobre una descripción de topología modificada. Por - ejemplo, el descubrimiento de un nuevo primario en un conjunto de réplicas - resultaría en un cambio en la descripción de la topología. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\TopologyChangedEvent - - - - final - - MongoDB\Driver\Monitoring\TopologyChangedEvent - - - - - &Properties; - - public - readonly - MongoDB\BSON\ObjectId - topologyId - - - public - readonly - MongoDB\Driver\TopologyDescription - newDescription - - - public - readonly - MongoDB\Driver\TopologyDescription - previousDescription - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - topologyId - - El identificador de la topología. - - - - newDescription - - La nueva descripción de la topología. - - - - previousDescription - - La descripción previa de la topología. - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Se añadieron propiedades públicas readonly. - - - - - -
    - -
    - - &reference.mongodb.mongodb.driver.monitoring.entities.topologychangedevent; - -
    - - diff --git a/reference/mongodb/mongodb/driver/monitoring/topologychangedevent/getnewdescription.xml b/reference/mongodb/mongodb/driver/monitoring/topologychangedevent/getnewdescription.xml deleted file mode 100644 index 5a7c168192..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/topologychangedevent/getnewdescription.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\TopologyChangedEvent::getNewDescription - Devuelve la nueva descripción de la topología - - - - &reftitle.description; - - final public MongoDB\Driver\TopologyDescriptionMongoDB\Driver\Monitoring\TopologyChangedEvent::getNewDescription - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la nueva MongoDB\Driver\TopologyDescription - para la topología. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/topologychangedevent/getpreviousdescription.xml b/reference/mongodb/mongodb/driver/monitoring/topologychangedevent/getpreviousdescription.xml deleted file mode 100644 index d8ba30a7d8..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/topologychangedevent/getpreviousdescription.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\TopologyChangedEvent::getPreviousDescription - Devuelve la descripción anterior de la topología - - - - &reftitle.description; - - final public MongoDB\Driver\TopologyDescriptionMongoDB\Driver\Monitoring\TopologyChangedEvent::getPreviousDescription - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la descripción anterior MongoDB\Driver\TopologyDescription - para la topología. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/topologychangedevent/gettopologyid.xml b/reference/mongodb/mongodb/driver/monitoring/topologychangedevent/gettopologyid.xml deleted file mode 100644 index 3e372b4639..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/topologychangedevent/gettopologyid.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\TopologyChangedEvent::getTopologyId - Devuelve el identificador de la topología - - - - &reftitle.description; - - final public MongoDB\BSON\ObjectIdMongoDB\Driver\Monitoring\TopologyChangedEvent::getTopologyId - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el identificador de la topología. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/topologyclosedevent.xml b/reference/mongodb/mongodb/driver/monitoring/topologyclosedevent.xml deleted file mode 100644 index 4c8911d5b7..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/topologyclosedevent.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - La clase MongoDB\Driver\Monitoring\TopologyClosedEvent - MongoDB\Driver\Monitoring\TopologyClosedEvent - - - - -
    - &reftitle.intro; - - La clase MongoDB\Driver\Monitoring\TopologyClosedEvent - encapsula información sobre una topología cerrada. - - - - Debido al comportamiento - de gestión y persistencia de las conexiones - del controlador, este evento solo puede ser observado cuando un - MongoDB\Driver\Manager es creado con la opción del controlador - "disableClientPersistence" y liberado antes del cierre de la solicitud (RSHUTDOWN). - - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\TopologyClosedEvent - - - - final - - MongoDB\Driver\Monitoring\TopologyClosedEvent - - - - - &Properties; - - public - readonly - MongoDB\BSON\ObjectId - topologyId - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - topologyId - - El identificador de la topología. - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Se añadieron propiedades públicas readonly. - - - - - -
    - -
    - - &reference.mongodb.mongodb.driver.monitoring.entities.topologyclosedevent; - -
    - - diff --git a/reference/mongodb/mongodb/driver/monitoring/topologyclosedevent/gettopologyid.xml b/reference/mongodb/mongodb/driver/monitoring/topologyclosedevent/gettopologyid.xml deleted file mode 100644 index 9a0254c358..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/topologyclosedevent/gettopologyid.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\TopologyClosedEvent::getTopologyId - Devuelve el identificador de la topología - - - - &reftitle.description; - - final public MongoDB\BSON\ObjectIdMongoDB\Driver\Monitoring\TopologyClosedEvent::getTopologyId - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el identificador de la topología. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/monitoring/topologyopeningevent.xml b/reference/mongodb/mongodb/driver/monitoring/topologyopeningevent.xml deleted file mode 100644 index e3dbc54b4d..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/topologyopeningevent.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - La clase MongoDB\Driver\Monitoring\TopologyOpeningEvent - MongoDB\Driver\Monitoring\TopologyOpeningEvent - - - - -
    - &reftitle.intro; - - La clase MongoDB\Driver\Monitoring\TopologyOpeningEvent - encapsula información sobre una topología abierta. - - - - Debido al comportamiento - de gestión y persistencia de las conexiones - del controlador, este evento puede no ser observado si un - MongoDB\Driver\Manager utiliza un cliente - libmongoc previamente persistente. - - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Monitoring\TopologyOpeningEvent - - - - final - - MongoDB\Driver\Monitoring\TopologyOpeningEvent - - - - - &Properties; - - public - readonly - MongoDB\BSON\ObjectId - topologyId - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - topologyId - - El identificador de la topología. - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Se añadieron propiedades públicas readonly. - - - - - -
    - -
    - - &reference.mongodb.mongodb.driver.monitoring.entities.topologyopeningevent; - -
    - - diff --git a/reference/mongodb/mongodb/driver/monitoring/topologyopeningevent/gettopologyid.xml b/reference/mongodb/mongodb/driver/monitoring/topologyopeningevent/gettopologyid.xml deleted file mode 100644 index 9e6107fd80..0000000000 --- a/reference/mongodb/mongodb/driver/monitoring/topologyopeningevent/gettopologyid.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - MongoDB\Driver\Monitoring\TopologyOpeningEvent::getTopologyId - Devuelve el identificador de la topología - - - - &reftitle.description; - - final public MongoDB\BSON\ObjectIdMongoDB\Driver\Monitoring\TopologyOpeningEvent::getTopologyId - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el identificador de la topología. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/query.xml b/reference/mongodb/mongodb/driver/query.xml deleted file mode 100644 index bd04bfb4d4..0000000000 --- a/reference/mongodb/mongodb/driver/query.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - La clase MongoDB\Driver\Query - MongoDB\Driver\Query - - - - -
    - &reftitle.intro; - - La clase MongoDB\Driver\Query es un objeto de valor que - representa una consulta a la base de datos. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Query - - - - final - - MongoDB\Driver\Query - - - - - &Methods; - - - - -
    - -
    - - &reference.mongodb.mongodb.driver.entities.query; - -
    - - diff --git a/reference/mongodb/mongodb/driver/query/construct.xml b/reference/mongodb/mongodb/driver/query/construct.xml deleted file mode 100644 index f690f223d0..0000000000 --- a/reference/mongodb/mongodb/driver/query/construct.xml +++ /dev/null @@ -1,541 +0,0 @@ - - - - - - MongoDB\Driver\Query::__construct - Crear una nueva consulta - - - - &reftitle.description; - - final public MongoDB\Driver\Query::__construct - arrayobjectfilter - arraynullqueryOptions&null; - - - Construye un nuevo objeto MongoDB\Driver\Query, que es un objeto - de valor inmutable que representa una consulta de base de datos. La consulta puede - luego ser ejecutada con - MongoDB\Driver\Manager::executeQuery. - - - - - &reftitle.parameters; - - &mongodb.parameter.filter; - - queryOptions - - - - queryOptions - - - - Opción - Tipo - Descripción - - - - - allowDiskUse - bool - - - Autoriza a MongoDB a utilizar ficheros temporales en el disco - para almacenar datos que excedan el límite de memoria del sistema - de 100 megabytes al procesar una operación de clasificación bloqueante. - - - - - allowPartialResults - bool - - - Para las consultas en una colección fragmentada, devuelve resultados parciales del mongos si algunos fragmentos no están - disponibles en lugar de generar un error. - - - Retoma la opción deprecada "partial" si no - se especifica. - - - - - awaitData - bool - - Utilizar en conjunción con la opción "tailable" para - bloquear temporalmente una operación getMore en el cursor si al final - de los datos en lugar de no devolver datos. Después de un período - de espera, la consulta termina normalmente. - - - - batchSize - int - - - El número de documentos a devolver en el primer lote. Por omisión a - 101. Un tamaño de lote de 0 significa que el cursor será establecido, pero - ningún documento será devuelto en el primer lote. - - - En las versiones de MongoDB anteriores a 3.2, donde las consultas - utilizan el protocolo de filaire heredado OP_QUERY, un tamaño de lote - de 1 cerrará el cursor independientemente del número de documentos. - - - - &mongodb.option.collation; - - comment - mixed - - - Un comentario arbitrario para ayudar a rastrear la operación a través - del perfil de la base de datos, la salida currentOp y los registros. - - - El comentario puede ser cualquier tipo BSON válido para MongoDB - 4.4+. Las versiones de servidor anteriores solo admiten - valores de cadena. - - - Retoma la opción deprecada "$comment" si no - se especifica. - - - - - exhaust - bool - - - El flujo de datos aguas abajo a plena potencia en varios paquetes - "more", asumiendo que el cliente leerá completamente todos los datos - consultados. Más rápido cuando se extraen muchos datos y - se sabe que se quiere extraer todo. Nota: el cliente no está autorizado - a no leer todos los datos a menos que cierre la conexión. - - - Esta opción no es admitida por el comando find en MongoDB - 3.2+ y forzará al controlador a utilizar la versión del protocolo de filaire - heredado (es decir, OP_QUERY). - - - - - explain - bool - - - Si &true; el cursor MongoDB\Driver\Cursor devuelto - contendrá un solo documento que describe el proceso y los índices utilizados - para devolver la consulta. - - - Retoma la opción deprecada "$explain" si no - se especifica. - - - Esta opción no es admitida por el comando find en MongoDB - 3.2+ y solo será respetada al utilizar la versión del protocolo de filaire - heredado (es decir, OP_QUERY). El comando - explain - debe ser utilizado en MongoDB 3.0+. - - - - - hint - stringarrayobject - - - Especificación del índice. Especifique el nombre del índice como - cadena, o el patrón de clave de índice. Si se especifica, el sistema de consulta - solo considerará los planes que utilicen el índice sugerido. - - - Retoma la opción deprecada "hint" si no se especifica. - - - - &mongodb.option.let; - - limit - int - - - El número máximo de documentos a devolver. Si no se especifica, entonces - por omisión a ningún límite. Un límite de 0 es equivalente a no establecer - un límite. - - - - - max - arrayobject - - - El límite superior exclusivo para un índice específico. - - - Retoma la opción deprecada "$max" si no - se especifica. - - - - - maxAwaitTimeMS - int - - - Entero positivo que indica el límite de tiempo en milisegundos para que el - servidor bloquee una operación getMore si no hay datos disponibles. Esta opción solo debe - ser utilizada en conjunción con las opciones "tailable" y - "awaitData". - - - - - maxTimeMS - int - - - El límite de tiempo acumulativo en milisegundos para el procesamiento de - las operaciones en el cursor. MongoDB detiene la operación en el primer punto - de interrupción más cercano. - - - Retoma la opción deprecada "$maxTimeMS" si no - se especifica. - - - - - min - arrayobject - - - El límite inferior inclusivo para un índice específico. - - - Retoma la opción deprecada "$min" si no - se especifica. - - - - - noCursorTimeout - bool - - Evita que el servidor finalice los cursores inactivos después de un período - de inactividad (10 minutos). - - - - projection - arrayobject - - - Las especificaciones de proyección - para determinar qué campos incluir en los documentos devueltos. - - - Si se utiliza la - funcionalidad ODM - para deserializar los documentos como su clase PHP original, - asegúrese de incluir el campo __pclass en la - proyección. Esto es necesario para que la deserialización funcione - y sin ello, la extensión devolverá (por omisión) un objeto - stdClass en su lugar. - - - - - readConcern - MongoDB\Driver\ReadConcern - - - Un read concern a aplicar a la operación. Por omisión, el read concern - de la URI - de conexión MongoDB - será utilizado. - - - Esta opción está disponible en MongoDB 3.2+ y provocará una - excepción en el momento de la ejecución si se especifica para una - versión de servidor más antigua. - - - - - returnKey - bool - - - Si &true;, solo devuelve las claves de índice en los documentos - resultantes. El valor por omisión es &false;. Si &true; y la - comando find no utiliza un índice, los documentos devueltos estarán vacíos. - - - Retoma la opción deprecada "$returnKey" si no - se especifica. - - - - - showRecordId - bool - - - Determina si el identificador de registro debe ser devuelto para - cada documento. Si &true;, añade un campo "$recordId" - de primer nivel a los documentos devueltos. - - - Retoma la opción deprecada "$showDiskLoc" si no - se especifica. - - - - - singleBatch - bool - - Determina si el cursor debe ser cerrado después del primer lote. - Por omisión a &false;. - - - - skip - int - Número de documentos a saltar. Por omisión a 0. - - - sort - arrayobject - - La especificación de clasificación para el ordenamiento de los resultados. - - Retoma la opción deprecada "$orderby" si no - se especifica. - - - - - tailable - bool - Devuelve un cursor tailable para una colección acotada. - - - -
    -
    -
    -
    -
    -
    - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 2.0.0 - - - La opción "partial" ha sido eliminada. Utilice - "allowPartialResults" en su lugar. - - - La opción "maxScan" ha sido eliminada. El soporte - para esta opción ha sido eliminado en MongoDB 4.2. - - - La opción "modifiers" ha sido eliminada. Esta opción era - utilizada para los modificadores de consulta antigua, que están todos deprecados. - - - La opción "oplogReplay" ha sido eliminada. Esto es ignorado - en MongoDB 4.4 y versiones más recientes. - - - La opción "snapshot" ha sido eliminada. Su soporte ha sido - eliminado en MongoDB 4.0. - - - Un valor negativo para la opción "limit" ya no implica &true; para la opción - "singleBatch". Para recibir solo un lote de resultados, combine un valor positivo - "limit" con la opción - "singleBatch". - - - - - PECL mongodb 1.14.0 - - - Añadida la opción "let". La opción - "comment" ahora acepta cualquier tipo. - - - - - PECL mongodb 1.8.0 - - - Añadida la opción "allowDiskUse". - - - La opción "oplogReplay" está deprecada. - - - - - PECL mongodb 1.5.0 - - - Las opciones "maxScan" y "snapshot" - están deprecadas. - - - - - PECL mongodb 1.3.0 - - - Añadida la opción "maxAwaitTimeMS" - - - - - PECL mongodb 1.2.0 - - - Añadidas las opciones "allowPartialResults", - "collation", "comment", - "hint", "max", - "maxScan", "maxTimeMS", - "min", "returnKey", - "showRecordId", y "snapshot". - - - Renombrada la opción "partial" a - "allowPartialResults". Por compatibilidad ascendente, - "partial" será siempre leído si - "allowPartialResults" no está especificado. - - - Eliminada la opción "secondaryOk" obsoleta. Para las - consultas que utilizan el protocolo de filaire heredado OP_QUERY, el controlador - establecerá el bit secondaryOk según sea necesario - conforme a la - Especificación de selección del servidor. - - - - - PECL mongodb 1.1.0 - Añadida la opción "readConcern". - - - - - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\Query::__construct</function> - - 'bjori', - 'views' => [ - '$gte' => 100, - ], -]; - -$options = [ - /* Devuelve solo los siguientes campos en los documentos correspondientes */ - 'projection' => [ - 'title' => 1, - 'article' => 1, - ], - /* Devuelve los documentos en orden descendente de vistas */ - 'sort' => [ - 'views' => -1 - ], -]; - -$query = new MongoDB\Driver\Query($filter, $options); - -$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017'); -$readPreference = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::PRIMARY); -$cursor = $manager->executeQuery('databaseName.collectionName', $query, ['readPreference' => $readPreference]); - -foreach($cursor as $document) { - var_dump($document); -} - -?> -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::executeQuery - MongoDB\Driver\Cursor - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/readconcern.xml b/reference/mongodb/mongodb/driver/readconcern.xml deleted file mode 100644 index 153d1c0b08..0000000000 --- a/reference/mongodb/mongodb/driver/readconcern.xml +++ /dev/null @@ -1,341 +0,0 @@ - - - - - La clase MongoDB\Driver\ReadConcern - MongoDB\Driver\ReadConcern - - - - -
    - &reftitle.intro; - - MongoDB\Driver\ReadConcern controla el nivel - de aislamiento para las operaciones de lectura para los conjuntos de réplicas y las réplicas de réplicas. Esta - opción requiere MongoDB 3.2 o posterior. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\ReadConcern - - - - final - - MongoDB\Driver\ReadConcern - - - - MongoDB\BSON\Serializable - - - - Serializable - - - - &Properties; - - public - readonly - stringnull - level - - - &Constants; - - const - string - MongoDB\Driver\ReadConcern::AVAILABLE - "available" - - - const - string - MongoDB\Driver\ReadConcern::LINEARIZABLE - "linearizable" - - - const - string - MongoDB\Driver\ReadConcern::LOCAL - "local" - - - const - string - MongoDB\Driver\ReadConcern::MAJORITY - "majority" - - - const - string - MongoDB\Driver\ReadConcern::SNAPSHOT - "snapshot" - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - level - - - El nivel del read concern. &null; si no se especificó ningún nivel. - - - - -
    - - - -
    - &reftitle.constants; - - - - MongoDB\Driver\ReadConcern::AVAILABLE - - - Por omisión para las lecturas en los secundarios cuando - afterClusterTime y level no están - especificados. - - - La consulta devuelve los datos más recientes de la instancia. No garantiza - que los datos hayan sido escritos en la mayoría de los miembros del conjunto de réplicas - (es decir, que puedan ser anulados). - - - Para las colecciones no fragmentadas (incluyendo las colecciones en un - despliegue autónomo o un despliegue de réplicas), las lecturas - "local" y "available" se comportan de manera idéntica. - - - Para un clúster compartido, la lectura "available" proporciona - una mayor tolerancia a las particiones ya que no espera para - garantizar garantías de coherencia. Sin embargo, una consulta con - una lectura "available" puede devolver documentos huérfanos - si el fragmento está en proceso de migración de piezas ya que la lectura - "available", a diferencia de la lectura - "local", no contacta al - primario del fragmento ni a los servidores de configuración para obtener metadatos actualizados. - - - - - - MongoDB\Driver\ReadConcern::LINEARIZABLE - - - La consulta devuelve los datos que reflejan todas las escrituras exitosas emitidas con un - nivel de escritura de "majority" y - reconocido antes del inicio de la operación de lectura. Para los conjuntos de réplicas - que funcionan con writeConcernMajorityJournalDefault definido - en &true;, la lectura linealizable devuelve datos que nunca serán - anulados. - - - Con writeConcernMajorityJournalDefault definido en - &false;, MongoDB no esperará que las escrituras w: "majority" - sean durables antes de acusar recibo de las escrituras. En consecuencia, - las operaciones de escritura "majority" podrían eventualmente ser anuladas - en caso de pérdida de un miembro del conjunto de réplicas. - - - Se puede especificar un nivel de lectura linealizable para las operaciones de lectura en el - primario únicamente. - - - La lectura linealizable garantiza que las operaciones - de lectura especifiquen un filtro de consulta que identifique de manera única un solo - documento. - - - - Siempre utilizar maxTimeMS con una lectura linealizable - en caso de no disponibilidad de la mayoría de los miembros portadores de datos. - maxTimeMS garantiza que la operación no bloquee - indefinidamente y garantiza que la operación devuelva un error si - el nivel de lectura no puede ser satisfecho. - - - - La lectura linealizable requiere MongoDB 3.4. - - - - - - MongoDB\Driver\ReadConcern::LOCAL - - - Por omisión para las lecturas en el primario si level no está - especificado y para las lecturas en los secundarios si level - no está especificado pero afterClusterTime está especificado. - - - La consulta devuelve los datos más recientes de la instancia. No garantiza - que los datos hayan sido escritos en la mayoría de los miembros del conjunto de réplicas - (es decir, que puedan ser anulados). - - - - - - MongoDB\Driver\ReadConcern::MAJORITY - - - La consulta devuelve los datos más recientes reconocidos como haber sido - escritos en la mayoría de los miembros del conjunto de réplicas. - - - Para utilizar el nivel de lectura "majority", los conjuntos de réplicas - deben utilizar el motor de almacenamiento WiredTiger y el protocolo de elección versión 1. - - - - - - MongoDB\Driver\ReadConcern::SNAPSHOT - - - La lectura "snapshot" está disponible para las transacciones - multi-documentos, y a partir de MongoDB 5.0, para ciertas operaciones de lectura - fuera de las transacciones multi-documentos. - - - Si la transacción no forma parte de una sesión coherente, al validar la transacción con un nivel de escritura "majority", las - operaciones de transacción están garantizadas de haber leído desde una instantánea de datos - mayoritariamente comprometidos. - - - Si la transacción forma parte de una sesión coherente, al validar la transacción con un nivel de escritura "majority", las - operaciones de transacción están garantizadas de haber leído desde una instantánea de datos - mayoritariamente comprometidos que aseguran la coherencia causal con la operación inmediatamente - anterior al inicio de la transacción. - - - Fuera de las transacciones multi-documentos, el nivel de lectura - "snapshot" está disponible en los primarios y los secundarios - para las siguientes operaciones de lectura: find, - aggregate y distinct (en - colecciones no fragmentadas). Todas las demás órdenes de lectura prohíben - "snapshot". - - - - - -
    - - -
    - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Se añadieron las propiedades públicas readonly. - - - - PECL mongodb 1.11.0 - - - Adición de la constante - MongoDB\Driver\ReadConcern::SNAPSHOT. - - - - - PECL mongodb 1.7.0 - - Implementa Serializable. - - - - PECL mongodb 1.4.0 - - - Adición de la constante - MongoDB\Driver\ReadConcern::MAJORITY. - - - - - PECL mongodb 1.2.0 - - - Adición de la constante - MongoDB\Driver\ReadConcern::LINEARIZABLE - - - Implementa MongoDB\BSON\Serializable. - - - - - - - -
    - -
    - &reftitle.seealso; - - Referencia de lectura - -
    - -
    - - &reference.mongodb.mongodb.driver.entities.readconcern; - -
    - - diff --git a/reference/mongodb/mongodb/driver/readconcern/bsonserialize.xml b/reference/mongodb/mongodb/driver/readconcern/bsonserialize.xml deleted file mode 100644 index d256789f49..0000000000 --- a/reference/mongodb/mongodb/driver/readconcern/bsonserialize.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - MongoDB\Driver\ReadConcern::bsonSerialize - Devuelve un objeto para la serialización BSON - - - - &reftitle.description; - - final public stdClassMongoDB\Driver\ReadConcern::bsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un objeto para la serialización del ReadConcern en BSON. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - <function>MongoDB\Driver\ReadConcern::bsonSerialize</function> con un read concern vacío - -bsonSerialize()); - -echo "\n", MongoDB\BSON\Document::fromPHP($rc)->toRelaxedExtendedJSON(); - -?> -]]> - - &example.outputs.similar; - - - - - <function>MongoDB\Driver\ReadConcern::bsonSerialize</function> con un read concern local - -bsonSerialize()); - -echo "\n", MongoDB\BSON\Document::fromPHP($rc)->toRelaxedExtendedJSON(); - -?> -]]> - - &example.outputs.similar; - - - string(5) "local" -} - -{ "level" : "local" } -]]> - - - - - - &reftitle.seealso; - - MongoDB\BSON\Serializable::bsonSerialize - Referencia de Read Concern - - - - - - diff --git a/reference/mongodb/mongodb/driver/readconcern/construct.xml b/reference/mongodb/mongodb/driver/readconcern/construct.xml deleted file mode 100644 index a41b7027f6..0000000000 --- a/reference/mongodb/mongodb/driver/readconcern/construct.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - MongoDB\Driver\ReadConcern::__construct - Crear un nuevo ReadConcern - - - - &reftitle.description; - - final public MongoDB\Driver\ReadConcern::__construct - stringnulllevel&null; - - - Construye un nuevo MongoDB\Driver\ReadConcern, que es - un objeto de valor inmutable. - - - - - &reftitle.parameters; - - - level - - - El nivel del read concern. - Se puede utilizar, pero no se limita a, una de las - constantes de clase. - - - - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\ReadConcern::__construct</function> - - -]]> - - - - - - &reftitle.seealso; - - Referencia de Read Concern - - - - - - diff --git a/reference/mongodb/mongodb/driver/readconcern/getlevel.xml b/reference/mongodb/mongodb/driver/readconcern/getlevel.xml deleted file mode 100644 index 361e7919f1..0000000000 --- a/reference/mongodb/mongodb/driver/readconcern/getlevel.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - MongoDB\Driver\ReadConcern::getLevel - Devuelve la opción "level" del ReadConcern - - - - &reftitle.description; - - final public stringnullMongoDB\Driver\ReadConcern::getLevel - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la opción "level" del ReadConcern. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\ReadConcern::getLevel</function> - -getLevel()); - -$rc = new MongoDB\Driver\ReadConcern(MongoDB\Driver\ReadConcern::LOCAL); -var_dump($rc->getLevel()); - -$rc = new MongoDB\Driver\ReadConcern(MongoDB\Driver\ReadConcern::MAJORITY); -var_dump($rc->getLevel()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - Referencia de Read Concern - - - - - - diff --git a/reference/mongodb/mongodb/driver/readconcern/isdefault.xml b/reference/mongodb/mongodb/driver/readconcern/isdefault.xml deleted file mode 100644 index 814566aae6..0000000000 --- a/reference/mongodb/mongodb/driver/readconcern/isdefault.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - MongoDB\Driver\ReadConcern::isDefault - Verifica si es el read concern por omisión - - - - &reftitle.description; - - final public boolMongoDB\Driver\ReadConcern::isDefault - - - - Devuelve si es el read concern por omisión (es decir, sin opciones especificadas). Este método está principalmente destinado a ser utilizado en conjunción con - MongoDB\Driver\Manager::getReadConcern para determinar si el Manager ha sido construido sin ninguna opción de read concern. - - - El controlador no incluirá un read concern por omisión en sus operaciones de lectura (por ejemplo MongoDB\Driver\Manager::executeQuery) para permitir que el servidor aplique su propio valor por omisión. Las bibliotecas que acceden al read concern del Manager para incluirlo en sus propios comandos de lectura deberían utilizar este método para asegurarse de que los read concerns por omisión se dejan sin definir. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si es el read concern por omisión y &false; en caso contrario. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\ReadConcern::isDefault</function> - -isDefault()); - -$rc = new MongoDB\Driver\ReadConcern(MongoDB\Driver\ReadConcern::MAJORITY); -var_dump($rc->isDefault()); - -$manager = new MongoDB\Driver\Manager('mongodb://127.0.0.1/?readConcernLevel=majority'); -$rc = $manager->getReadConcern(); -var_dump($rc->isDefault()); - -$manager = new MongoDB\Driver\Manager('mongodb://127.0.0.1/'); -$rc = $manager->getReadConcern(); -var_dump($rc->isDefault()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::getReadConcern - Referencia de Read Concern - - - - - - diff --git a/reference/mongodb/mongodb/driver/readpreference.xml b/reference/mongodb/mongodb/driver/readpreference.xml deleted file mode 100644 index 2da58ee5c0..0000000000 --- a/reference/mongodb/mongodb/driver/readpreference.xml +++ /dev/null @@ -1,350 +0,0 @@ - - - - - - - La clase MongoDB\Driver\ReadPreference - MongoDB\Driver\ReadPreference - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\ReadPreference - - - - final - - MongoDB\Driver\ReadPreference - - - - MongoDB\BSON\Serializable - - - - Serializable - - - - &Properties; - - public - readonly - string - mode - - - public - readonly - arraynull - tags - - - public - readonly - int - maxStalenessSeconds - - - public - readonly - objectnull - hedge - - - &Constants; - - const - string - MongoDB\Driver\ReadPreference::PRIMARY - primary - - - const - string - MongoDB\Driver\ReadPreference::PRIMARY_PREFERRED - primaryPreferred - - - const - string - MongoDB\Driver\ReadPreference::SECONDARY - secondary - - - const - string - MongoDB\Driver\ReadPreference::SECONDARY_PREFERRED - secondaryPreferred - - - const - string - MongoDB\Driver\ReadPreference::NEAREST - nearest - - - const - int - MongoDB\Driver\ReadPreference::NO_MAX_STALENESS - -1 - - - const - int - MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS - 90 - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - mode - - - El modo de preferencia de lectura como cadena (por ejemplo - "primary", "secondary"). - - - - - tags - - - La lista de conjuntos de tags utilizada por la preferencia de lectura, o &null; si no - se especificó ningún conjunto de tags. - - - - - maxStalenessSeconds - - - La duración máxima de obsolescencia en segundos para las lecturas, o - MongoDB\Driver\ReadPreference::NO_MAX_STALENESS - si no se especificó ninguna duración máxima de obsolescencia. - - - - - hedge - - - Un documento que especifica las opciones de hedge para la preferencia de lectura, o - &null; si no se especificó ninguna opción de hedge. - - - - Esta propiedad está obsoleta ya que las lecturas con hedge están obsoletas en - MongoDB 8.0. - - - - - -
    - - - -
    - &reftitle.constants; - - - - MongoDB\Driver\ReadPreference::PRIMARY - - - Todas las operaciones se leen desde el primario actual del conjunto de réplicas. - Esta es la preferencia de lectura por omisión para MongoDB. - - - - - - MongoDB\Driver\ReadPreference::PRIMARY_PREFERRED - - - En la mayoría de las situaciones, las operaciones se leen desde el - primario, pero si no está disponible, las operaciones se leen desde - los miembros secundarios. - - - - - - MongoDB\Driver\ReadPreference::SECONDARY - - - Todas las operaciones se leen desde los miembros secundarios del conjunto de réplicas. - - - - - - MongoDB\Driver\ReadPreference::SECONDARY_PREFERRED - - - En la mayoría de los casos, las operaciones se leen desde los miembros - secundarios, pero si ningún miembro secundario está disponible, las - operaciones se leen desde el primario. - - - - - - MongoDB\Driver\ReadPreference::NEAREST - - - Las operaciones se leen desde el miembro del conjunto de réplicas con la - menor latencia de red, independientemente del tipo de miembro. - - - - - - MongoDB\Driver\ReadPreference::NO_MAX_STALENESS - - - El valor por omisión de la opción "maxStalenessSeconds" - es no especificar ningún límite sobre la obsolescencia máxima, lo que - significa que el controlador no tendrá en cuenta el desfase de un - secundario al elegir dónde dirigir una operación de lectura. - - - - - - MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS - - - El valor mínimo de la opción "maxStalenessSeconds" - es de 90 segundos. El controlador estima la obsolescencia de los segundos verificando - periódicamente la última fecha de escritura de cada miembro del conjunto de réplicas. Como - estos controles son poco frecuentes, la estimación de la obsolescencia es aproximada. Por - lo tanto, el controlador no puede aplicar un valor de obsolescencia máxima inferior a 90 segundos. - - - - - -
    - - -
    - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Se añadieron las propiedades públicas readonly. - - - - PECL mongodb 2.0.0 - - - Eliminar las constantes - MongoDB\Driver\ReadPreference::RP_PRIMARY, - MongoDB\Driver\ReadPreference::RP_PRIMARY_PREFERRED, - MongoDB\Driver\ReadPreference::RP_SECONDARY, - MongoDB\Driver\ReadPreference::RP_SECONDARY_PREFERRED, - y MongoDB\Driver\ReadPreference::RP_NEAREST. - El método getMode también fue eliminado. - - - - - PECL mongodb 1.7.0 - - - Añadir las constantes - MongoDB\Driver\ReadPreference::PRIMARY, - MongoDB\Driver\ReadPreference::PRIMARY_PREFERRED, - MongoDB\Driver\ReadPreference::SECONDARY, - MongoDB\Driver\ReadPreference::SECONDARY_PREFERRED, - MongoDB\Driver\ReadPreference::NEAREST. - - - Implementa Serializable. - - - - - PECL mongodb 1.2.0 - - - Añadir las constantes - MongoDB\Driver\ReadPreference::NO_MAX_STALENESS - y - MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS. - - - Implementa MongoDB\BSON\Serializable. - - - - - - - -
    - -
    - - &reference.mongodb.mongodb.driver.entities.readpreference; - -
    - - diff --git a/reference/mongodb/mongodb/driver/readpreference/bsonserialize.xml b/reference/mongodb/mongodb/driver/readpreference/bsonserialize.xml deleted file mode 100644 index 1c9c78f08c..0000000000 --- a/reference/mongodb/mongodb/driver/readpreference/bsonserialize.xml +++ /dev/null @@ -1,179 +0,0 @@ - - - - - - MongoDB\Driver\ReadPreference::bsonSerialize - Devuelve un objeto para la serialización BSON - - - - &reftitle.description; - - final public stdClassMongoDB\Driver\ReadPreference::bsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un objeto para la serialización de la ReadPreference en BSON. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - <function>MongoDB\Driver\ReadPreference::bsonSerialize</function> con una preferencia de lectura primaria - -bsonSerialize()); - -echo "\n", MongoDB\BSON\Document::fromPHP($rp)->toRelaxedExtendedJSON(); - -?> -]]> - - &example.outputs.similar; - - - string(7) "primary" -} - -{ "mode" : "primary" } -]]> - - - - <function>MongoDB\Driver\ReadPreference::bsonSerialize</function> con una preferencia de lectura secundaria - - 'ny'], - ['dc' => 'sf', 'use' => 'reporting'], - [] - ] -); -var_dump($rp->bsonSerialize()); - -echo "\n", MongoDB\BSON\toJSON(MongoDB\BSON\fromPHP($rp)); - -?> -]]> - - &example.outputs.similar; - - - string(9) "secondary" - ["tags"]=> - array(3) { - [0]=> - object(stdClass)#1 (1) { - ["dc"]=> - string(2) "ny" - } - [1]=> - object(stdClass)#5 (2) { - ["dc"]=> - string(2) "sf" - ["use"]=> - string(9) "reporting" - } - [2]=> - object(stdClass)#4 (0) { - } - } -} - -{ "mode" : "secondary", "tags" : [ { "dc" : "ny" }, { "dc" : "sf", "use" : "reporting" }, { } ] } -]]> - - - - <function>MongoDB\Driver\ReadPreference::bsonSerialize</function> con una preferencia de lectura secundaria y un tiempo máximo de retraso - - 120] -); -var_dump($rp->bsonSerialize()); - -echo "\n", MongoDB\BSON\Document::fromPHP($rp)->toRelaxedExtendedJSON(); - -?> -]]> - - &example.outputs.similar; - - - string(9) "secondary" - ["maxStalenessSeconds"]=> - int(120) -} - -{ "mode" : "secondary", "maxStalenessSeconds" : 120 } -]]> - - - - - - &reftitle.seealso; - - MongoDB\BSON\Serializable::bsonSerialize - Referencia de Read Preference - - - - - - diff --git a/reference/mongodb/mongodb/driver/readpreference/construct.xml b/reference/mongodb/mongodb/driver/readpreference/construct.xml deleted file mode 100644 index e4a0d269ad..0000000000 --- a/reference/mongodb/mongodb/driver/readpreference/construct.xml +++ /dev/null @@ -1,304 +0,0 @@ - - - - - - - MongoDB\Driver\ReadPreference::__construct - Crear una nueva ReadPreference - - - - &reftitle.description; - - final public MongoDB\Driver\ReadPreference::__construct - stringmode - arraynulltagSets&null; - arraynulloptions&null; - - - Construye un nuevo MongoDB\Driver\ReadPreference, que es un objeto de valor inmutable. - - - - - - &reftitle.parameters; - - - mode - - - - Modo de preferencia de lectura - - - - Valor - Descripción - - - - - "primary" - - - Todas las operaciones leídas desde el conjunto de réplicas actual primario. - Este es el modo de preferencia de lectura por omisión para MongoDB. - - - - - "primaryPreferred" - - - En la mayoría de las situaciones, las operaciones son leídas desde el - primario, pero si no está disponible, las operaciones son leídas desde un miembro secundario. - - - - - "secondary" - - - Todas las operaciones son leídas desde los miembros secundarios del conjunto de réplicas. - - - - - "secondaryPreferred" - - - En la mayoría de los casos, las operaciones son leídas por miembros secundarios, pero si ningún miembro secundario está disponible, las operaciones son leídas desde el primario. - - - - - "nearest" - - - Operaciones leídas desde el miembro del conjunto de réplicas con la latencia de red más baja, independientemente del tipo de miembro. - - - - - -
    -
    -
    -
    - - tagSets - - - Los conjuntos de etiquetas permiten dirigir las operaciones de lectura a miembros específicos de un conjunto de réplicas. Este parámetro debe ser un array de arrays asociativos, que contienen cada uno cero o más pares clave/valor. Al seleccionar un servidor para una operación de lectura, el controlador intenta seleccionar un nodo que contenga todas las etiquetas de un conjunto (es decir, el array asociativo de pares clave/valor). Si la selección falla, el controlador intentará con los siguientes conjuntos. Un conjunto de etiquetas vacío (array()) corresponde a cualquier nodo y puede ser utilizado como respaldo. - - - Las etiquetas no son compatibles con el modo "primary" y, en general, solo se aplican cuando se selecciona un miembro secundario de un conjunto para una operación de lectura. Sin embargo, el modo "nearest", cuando se combina con un conjunto de etiquetas, selecciona el miembro correspondiente con la latencia de red más baja. Este miembro puede ser primario o secundario. - - - - - options - - - - options - - - - Opción - Tipo - Descripción - - - - - hedge - objectarray - - Especifica si se debe utilizar o no las lecturas cruzadas, que son soportadas desde MongoDB 4.4+ para las consultas compartidas. - - El servidor de lecturas cruzadas está disponible para todas las lecturas de referencias no primarias, y está activado por omisión al utilizar el modo "nearest". Esta opción permite activar explícitamente el servidor de lecturas cruzadas para las lecturas de referencias no primarias especificando ['enabled' => true], o desactivar explícitamente el servidor de lecturas cruzadas para las lecturas de referencias "nearest" especificando ['enabled' => false]. - - - - - maxStalenessSeconds - &integer; - - - Especifica un desfase de replicación máximo, o "obsolescencia", para las lecturas de los secundarios. Cuando la obsolescencia estimada de un secundario supera este valor, el controlador deja de utilizarlo para las operaciones de lectura. - - - Si se especifica, la obsolescencia máxima debe ser un entero signado de 32 bits mayor o igual a MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS. - - - Por omisión, MongoDB\Driver\ReadPreference::NO_MAX_STALENESS, lo que significa que el controlador no tendrá en cuenta el desfase de un secundario al elegir dónde dirigir una operación de lectura. - - - Esta opción no es compatible con el modo "primary". La especificación de una obsolescencia máxima requiere asimismo que todas las instancias de MongoDB del despliegue utilicen MongoDB 3.4+. Se lanzará una excepción en tiempo de ejecución si todas las instancias de MongoDB en el despliegue son de una versión de servidor más antigua. - - - - - -
    -
    -
    -
    -
    -
    - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lanza una excepción MongoDB\Driver\Exception\InvalidArgumentException si mode es incorrecto. - Lanza una excepción MongoDB\Driver\Exception\InvalidArgumentException si tagSets es proporcionado para una preferencia de lectura primaria o es incorrecto (es decir, no es un array de cero o más documentos). - Lanza una excepción MongoDB\Driver\Exception\InvalidArgumentException si la opción "maxStalenessSeconds" es proporcionada para una preferencia de lectura primaria o está fuera de rango. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 2.0.0 - - Pasar un int para el argumento mode ya no es soportado. - - - - PECL mongodb 1.20.0 - - Pasar un int para el argumento mode está DEPRECADO. - - - - PECL mongodb 1.8.0 - - Añadida la opción "hedge". - - - - PECL mongodb 1.3.0 - - - El argumento mode acepta ahora un valor de string, que es compatible con la opción URI "readPreference" para MongoDB\Driver\Manager::__construct - - - - - PECL mongodb 1.2.0 - - - Añadido un tercer argumento de options, que soporta la opción "maxStalenessSeconds". - - - - - - - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\Driver\ReadPreference::__construct</function> - - 'ny']])); - -/* Requiere un nodo secundario cuyo desfase de replicación se encuentre dentro de los dos minutos */ -var_dump(new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::SECONDARY, null, ['maxStalenessSeconds' => 120])); - -/* Activa explícitamente el servidor de lecturas cruzadas */ -var_dump(new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::SECONDARY, null, ['hedge' => ['enabled' => true]])); -?> -]]> - - &example.outputs.similar; - - - string(18) "secondaryPreferred" -} -object(MongoDB\Driver\ReadPreference)#1 (2) { - ["mode"]=> - string(7) "nearest" - ["tags"]=> - array(1) { - [0]=> - object(stdClass)#2 (1) { - ["dc"]=> - string(2) "ny" - } - } -} -object(MongoDB\Driver\ReadPreference)#1 (2) { - ["mode"]=> - string(9) "secondary" - ["maxStalenessSeconds"]=> - int(120) -} -object(MongoDB\Driver\ReadPreference)#1 (2) { - ["mode"]=> - string(9) "secondary" - ["hedge"]=> - object(stdClass)#1 (1) { - ["enabled"]=> - bool(true) - } -} -]]> - - - - - - &reftitle.seealso; - - Read Preference reference - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/readpreference/gethedge.xml b/reference/mongodb/mongodb/driver/readpreference/gethedge.xml deleted file mode 100644 index 877eab3844..0000000000 --- a/reference/mongodb/mongodb/driver/readpreference/gethedge.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - MongoDB\Driver\ReadPreference::getHedge - Devuelve la opción "hedge" del ReadPreference - - - - &reftitle.description; - - final public objectnullMongoDB\Driver\ReadPreference::getHedge - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la opción "hedge" del ReadPreference. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - Referencia de Read Preference - - - - - - diff --git a/reference/mongodb/mongodb/driver/readpreference/getmaxstalenessseconds.xml b/reference/mongodb/mongodb/driver/readpreference/getmaxstalenessseconds.xml deleted file mode 100644 index 629f8053f0..0000000000 --- a/reference/mongodb/mongodb/driver/readpreference/getmaxstalenessseconds.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - MongoDB\Driver\ReadPreference::getMaxStalenessSeconds - Devuelve la opción "maxStalenessSeconds" del ReadPreference - - - - &reftitle.description; - - final public intMongoDB\Driver\ReadPreference::getMaxStalenessSeconds - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la opción "maxStalenessSeconds" del ReadPreference. Si no se ha especificado ningún tiempo máximo, - MongoDB\Driver\ReadPreference::NO_MAX_STALENESS será - devuelto. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\ReadPreference::getMaxStalenessSeconds</function> - -getMaxStalenessSeconds()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::SECONDARY, null, [ - 'maxStalenessSeconds' => MongoDB\Driver\ReadPreference::NO_MAX_STALENESS, -]); -var_dump($rp->getMaxStalenessSeconds()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::SECONDARY, null, [ - 'maxStalenessSeconds' => MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS, -]); -var_dump($rp->getMaxStalenessSeconds()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::SECONDARY, null, [ - 'maxStalenessSeconds' => 1000, -]); -var_dump($rp->getMaxStalenessSeconds()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - Referencia de Read Preference - - - - - - diff --git a/reference/mongodb/mongodb/driver/readpreference/getmode.xml b/reference/mongodb/mongodb/driver/readpreference/getmode.xml deleted file mode 100644 index 1617edd278..0000000000 --- a/reference/mongodb/mongodb/driver/readpreference/getmode.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - MongoDB\Driver\ReadPreference::getMode - Devuelve la opción "mode" del ReadPreference - - - - - - Esta función ha sido DEPRECADA desde la versión 1.20.0 de la extensión - y ha sido eliminada en la versión 2.0. Las aplicaciones deberían utilizar - MongoDB\Driver\ReadPreference::getModeString en su lugar. - - - - - - &reftitle.description; - - final public intMongoDB\Driver\ReadPreference::getMode - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la opción "mode" del ReadPreference. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.method-removed; - - - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\ReadPreference::getMode</function> - -getMode()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::PRIMARY_PREFERRED); -var_dump($rp->getMode()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::SECONDARY); -var_dump($rp->getMode()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::SECONDARY_PREFERRED); -var_dump($rp->getMode()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::NEAREST); -var_dump($rp->getMode()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\ReadPreference::getModeString - Referencia de Read Preference - - - - - - diff --git a/reference/mongodb/mongodb/driver/readpreference/getmodestring.xml b/reference/mongodb/mongodb/driver/readpreference/getmodestring.xml deleted file mode 100644 index 6651f5facc..0000000000 --- a/reference/mongodb/mongodb/driver/readpreference/getmodestring.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - MongoDB\Driver\ReadPreference::getModeString - Devuelve la opción "mode" del ReadPreference - - - - &reftitle.description; - - final public stringMongoDB\Driver\ReadPreference::getModeString - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la opción "mode" del ReadPreference como string. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\ReadPreference::getModeString</function> - -getModeString()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::PRIMARY_PREFERRED); -var_dump($rp->getModeString()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::SECONDARY); -var_dump($rp->getModeString()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::SECONDARY_PREFERRED); -var_dump($rp->getModeString()); - -$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::NEAREST); -var_dump($rp->getModeString()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\ReadPreference::getMode - Referencia de Read Preference - - - - - - diff --git a/reference/mongodb/mongodb/driver/readpreference/gettagsets.xml b/reference/mongodb/mongodb/driver/readpreference/gettagsets.xml deleted file mode 100644 index 442fd589f6..0000000000 --- a/reference/mongodb/mongodb/driver/readpreference/gettagsets.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - MongoDB\Driver\ReadPreference::getTagSets - Devuelve la opción "tagSets" de ReadPreference - - - - &reftitle.description; - - final public arrayMongoDB\Driver\ReadPreference::getTagSets - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la opción "tagSets" de ReadPreference. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\ReadPreference::getTagSets</function> - -getTagSets()); - -$rp = new MongoDB\Driver\ReadPreference($mode, []); -var_dump($rp->getTagSets()); - -/* Preferir un nodo en Nueva York, pero volver a cualquier nodo disponible. */ -$rp = new MongoDB\Driver\ReadPreference($mode, [['dc' => 'ny']]); -var_dump($rp->getTagSets()); - -/* Preferir un nodo en Nueva York, seguido de un nodo en San Francisco - etiquetado para el reporting, y finalmente volver a cualquier nodo disponible. */ -$rp = new MongoDB\Driver\ReadPreference($mode, [ - ['dc' => 'ny'], - ['dc' => 'sf', 'use' => 'reporting'], - [], -]); -var_dump($rp->getTagSets()); - -?> -]]> - - &example.outputs; - - - array(1) { - ["dc"]=> - string(2) "ny" - } - [1]=> - array(0) { - } -} -array(3) { - [0]=> - array(1) { - ["dc"]=> - string(2) "ny" - } - [1]=> - array(2) { - ["dc"]=> - string(2) "sf" - ["use"]=> - string(9) "reporting" - } - [2]=> - array(0) { - } -} -]]> - - - - - - &reftitle.seealso; - - Referencia de Read Preference - - - - - - diff --git a/reference/mongodb/mongodb/driver/server.xml b/reference/mongodb/mongodb/driver/server.xml deleted file mode 100644 index dc41f627b1..0000000000 --- a/reference/mongodb/mongodb/driver/server.xml +++ /dev/null @@ -1,236 +0,0 @@ - - - - - - La clase MongoDB\Driver\Server - MongoDB\Driver\Server - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Server - - - - final - - MongoDB\Driver\Server - - - - &Constants; - - const - int - MongoDB\Driver\Server::TYPE_UNKNOWN - 0 - - - const - int - MongoDB\Driver\Server::TYPE_STANDALONE - 1 - - - const - int - MongoDB\Driver\Server::TYPE_MONGOS - 2 - - - const - int - MongoDB\Driver\Server::TYPE_POSSIBLE_PRIMARY - 3 - - - const - int - MongoDB\Driver\Server::TYPE_RS_PRIMARY - 4 - - - const - int - MongoDB\Driver\Server::TYPE_RS_SECONDARY - 5 - - - const - int - MongoDB\Driver\Server::TYPE_RS_ARBITER - 6 - - - const - int - MongoDB\Driver\Server::TYPE_RS_OTHER - 7 - - - const - int - MongoDB\Driver\Server::TYPE_RS_GHOST - 8 - - - const - int - MongoDB\Driver\Server::TYPE_LOAD_BALANCER - 9 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - MongoDB\Driver\Server::TYPE_UNKNOWN - - Tipo de servidor desconocido, devuelto por MongoDB\Driver\Server::getType. - - - - - MongoDB\Driver\Server::TYPE_STANDALONE - - Tipo de servidor independiente, devuelto por MongoDB\Driver\Server::getType. - - - - - MongoDB\Driver\Server::TYPE_MONGOS - - Tipo de servidor Mongos, devuelto por MongoDB\Driver\Server::getType. - - - - - MongoDB\Driver\Server::TYPE_POSSIBLE_PRIMARY - - Tipo de servidor posible primario de conjunto de réplicas, devuelto por MongoDB\Driver\Server::getType. - Un servidor puede identificarse como posible primario si aún no ha sido verificado pero otro miembro del conjunto de réplicas cree que es el primario. - - - - - MongoDB\Driver\Server::TYPE_RS_PRIMARY - - Tipo de servidor primario de conjunto de réplicas, devuelto por MongoDB\Driver\Server::getType. - - - - - MongoDB\Driver\Server::TYPE_RS_SECONDARY - - Tipo de servidor secundario de conjunto de réplicas, devuelto por MongoDB\Driver\Server::getType. - - - - - MongoDB\Driver\Server::TYPE_RS_ARBITER - - Tipo de servidor árbitro de conjunto de réplicas, devuelto por MongoDB\Driver\Server::getType. - - - - - MongoDB\Driver\Server::TYPE_RS_OTHER - - Tipo de servidor de conjunto de réplicas de otro tipo, devuelto por MongoDB\Driver\Server::getType. - Estos servidores pueden estar ocultos, iniciándose o recuperándose. No pueden ser consultados, pero sus listas de hosts son útiles para descubrir la configuración actual del conjunto de réplicas. - - - - - MongoDB\Driver\Server::TYPE_RS_GHOST - - Tipo de servidor fantasma de conjunto de réplicas, devuelto por MongoDB\Driver\Server::getType. - Los servidores pueden identificarse como tales en al menos tres situaciones: brevemente durante el inicio del servidor; en un conjunto de réplicas no inicializado; o cuando el servidor es rechazado (es decir, eliminado de la configuración del conjunto de réplicas). No pueden ser consultados, ni se puede usar su lista de hosts para descubrir la configuración actual del conjunto de réplicas; sin embargo, el cliente puede monitorear este servidor con la esperanza de que pase a un estado más útil. - - - - - MongoDB\Driver\Server::TYPE_LOAD_BALANCER - - Tipo de servidor equilibrador de carga, devuelto por MongoDB\Driver\Server::getType. - - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.11.0 - - - Se añadió la constante - MongoDB\Driver\Server::TYPE_LOAD_BALANCER. - - - - - - -
    - -
    - - &reference.mongodb.mongodb.driver.entities.server; - -
    - - diff --git a/reference/mongodb/mongodb/driver/server/construct.xml b/reference/mongodb/mongodb/driver/server/construct.xml deleted file mode 100644 index b94ce6043d..0000000000 --- a/reference/mongodb/mongodb/driver/server/construct.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - - MongoDB\Driver\Server::__construct - Crear un nuevo servidor (no utilizado) - - - - &reftitle.description; - - final private MongoDB\Driver\Server::__construct - - - - Los objetos MongoDB\Driver\Server son creados internamente - por MongoDB\Driver\Manager cuando se establece una conexión de base de - datos y pueden ser devueltos por - MongoDB\Driver\Manager::getServers y - MongoDB\Driver\Manager::selectServer. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::getServers - MongoDB\Driver\Manager::selectServer - - - - - - diff --git a/reference/mongodb/mongodb/driver/server/executebulkwrite.xml b/reference/mongodb/mongodb/driver/server/executebulkwrite.xml deleted file mode 100644 index ac14be7ba5..0000000000 --- a/reference/mongodb/mongodb/driver/server/executebulkwrite.xml +++ /dev/null @@ -1,177 +0,0 @@ - - - - - - MongoDB\Driver\Server::executeBulkWrite - Ejecuta una o varias operaciones de escritura en este servidor - - - - &reftitle.description; - - final public MongoDB\Driver\WriteResultMongoDB\Driver\Server::executeBulkWrite - stringnamespace - MongoDB\Driver\BulkWritebulk - arraynulloptions&null; - - - Ejecuta una o varias operaciones de escritura en este servidor. - - - Un objeto MongoDB\Driver\BulkWrite puede ser construido con - una o varias operaciones de diferentes tipos (i.e. actualización, eliminación, - e inserción). El driver intentará enviar las operaciones del mismo tipo al - servidor en un mínimo de solicitudes posibles para optimizar los viajes de ida y vuelta. - - - El valor por omisión para la opción "writeConcern" será - deducido de una transacción activa (indicada por la opción - "session"), luego por el - URI de conexión. - - - - - &reftitle.parameters; - - &mongodb.parameter.namespace; - &mongodb.parameter.bulkwrite; - - options - - - - options - - - - Opción - Tipo - Descripción - - - - &mongodb.option.session; - &mongodb.option.writeConcern; - - -
    -
    -
    -
    -
    -
    - - - &reftitle.returnvalues; - &mongodb.returns.writeresult; - - - - &reftitle.errors; - - Lanza una excepción MongoDB\Driver\Exception\InvalidArgumentException si bulk no contiene ninguna operación de escritura. - Lanza una excepción MongoDB\Driver\Exception\InvalidArgumentException si bulk ya ha sido ejecutado. Los objetos MongoDB\Driver\BulkWrite no pueden ser ejecutados varias veces. - &mongodb.throws.session-unacknowledged; - &mongodb.throws.std; - &mongodb.throws.bulkwriteexception; - Lanza una excepción MongoDB\Driver\Exception\RuntimeException - si ocurre un error. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 2.0.0 - - El parámetro options ya no acepta - instancias MongoDB\Driver\WriteConcern. - - - - PECL mongodb 1.21.0 - - Pasar un objeto MongoDB\Driver\WriteConcern como - options está obsoleto y será eliminado en la 2.0. - - - - PECL mongodb 1.4.4 - - MongoDB\Driver\Exception\InvalidArgumentException - será lanzado si la opción "session" es utilizada - conjuntamente con una preocupación de escritura no reconocida. - - - - PECL mongodb 1.4.0 - - El tercer parámetro es ahora un array - de options. Para la compatibilidad ascendente, - este parámetro siempre aceptará un objeto MongoDB\Driver\WriteConcern. - - - - PECL mongodb 1.3.0 - - MongoDBDriverExceptionInvalidArgumentException es - ahora lanzado si Bulk no contiene - operaciones de escritura. Anteriormente, una - MongoDB\Driver\Exception\BulkWriteException era lanzada. - - - - - - - - - - &reftitle.notes; - &mongodb.note.server.write; - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWrite - MongoDB\Driver\WriteResult - MongoDB\Driver\WriteConcern - MongoDB\Driver\Manager::executeBulkWrite - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/server/executebulkwritecommand.xml b/reference/mongodb/mongodb/driver/server/executebulkwritecommand.xml deleted file mode 100644 index e6c95fe79c..0000000000 --- a/reference/mongodb/mongodb/driver/server/executebulkwritecommand.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - MongoDB\Driver\Server::executeBulkWriteCommand - Ejecuta operaciones de escritura en este servidor utilizando el comando bulkWrite - - - - &reftitle.description; - - final public MongoDB\Driver\BulkWriteCommandResultMongoDB\Driver\Server::executeBulkWriteCommand - MongoDB\Driver\BulkWriteCommandbulk - arraynulloptions&null; - - - Ejecuta una o varias operaciones de escritura en el servidor primario utilizando el - comando bulkWrite - introducido en MongoDB 8.0. - - - Una MongoDB\Driver\BulkWriteCommand puede ser construida - con una o varias operaciones de escritura de tipos variados (por ejemplo, inserciones, actualizaciones - y eliminaciones). Cada operación de escritura puede apuntar a una colección diferente. - - - El valor por omisión para la opción "writeConcern" será - deducido de una transacción activa (indicada por la opción - "session"), seguida de - la URI de conexión. - - - - - &reftitle.parameters; - - &mongodb.parameter.bulkwritecommand; - - options - - - - options - - - - Opción - Tipo - Descripción - - - - &mongodb.option.session; - &mongodb.option.writeConcern; - - -
    -
    -
    -
    -
    -
    - - - &reftitle.returnvalues; - &mongodb.returns.bulkwritecommandresult; - - - - &reftitle.errors; - - Lanza una MongoDB\Driver\Exception\InvalidArgumentException si bulk no contiene operaciones de escritura válidas. - Lanza una MongoDB\Driver\Exception\InvalidArgumentException si bulk ya ha sido ejecutada. Los objetos MongoDB\Driver\BulkWriteCommand no pueden ser ejecutados múltiples veces. - &mongodb.throws.session-unacknowledged; - &mongodb.throws.std; - &mongodb.throws.bulkwritecommandexception; - Lanza MongoDB\Driver\Exception\RuntimeException en caso de otro error. - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWriteCommand - MongoDB\Driver\BulkWriteCommandResult - MongoDB\Driver\WriteConcern - MongoDB\Driver\Manager::executeBulkWriteCommand - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/server/executecommand.xml b/reference/mongodb/mongodb/driver/server/executecommand.xml deleted file mode 100644 index be8e257a39..0000000000 --- a/reference/mongodb/mongodb/driver/server/executecommand.xml +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - MongoDB\Driver\Server::executeCommand - Ejecuta un comando de base de datos en este servidor - - - - &reftitle.description; - - final public MongoDB\Driver\CursorMongoDB\Driver\Server::executeCommand - stringdb - MongoDB\Driver\Commandcommand - arraynulloptions&null; - - - Ejecuta un comando en este servidor. - - - Este método no aplica ninguna lógica especial al comando. Los valores por omisión para las opciones "readPreference", "readConcern" y "writeConcern" serán deducidos de una transacción activa (indicada por la opción "session"). Si no hay una transacción activa, se utilizará una preferencia de lectura primaria para la selección del servidor. - - - Los valores por omisión no serán deducidos de la URI de conexión. Por lo tanto, se recomienda a los usuarios utilizar métodos de comando de lectura y/o escritura específicos si es posible. - - &mongodb.note.server.readpreference; - - - - &reftitle.parameters; - - &mongodb.parameter.db; - &mongodb.parameter.command; - - options - - - - options - - - - Opción - Tipo - Descripción - - - - &mongodb.option.readConcern; - &mongodb.option.readPreference; - &mongodb.option.session; - &mongodb.option.writeConcern; - - -
    -
    - &mongodb.option.transactionReadWriteConcern; -
    -
    -
    -
    - - - &reftitle.returnvalues; - &mongodb.returns.cursor; - - - - &reftitle.errors; - - &mongodb.throws.session-readwriteconcern; - &mongodb.throws.session-unacknowledged; - &mongodb.throws.std; - Lanza una excepción MongoDB\Driver\Exception\RuntimeException si ocurre un error (i.e. comando inválido, envío de un comando de escritura a un secundario). - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 2.0.0 - - El parámetro options ya no acepta instancias de MongoDB\Driver\WriteConcern. - - - - PECL mongodb 1.21.0 - - Pasar un objeto MongoDB\Driver\ReadPreference como options está obsoleto y será eliminado en la versión 2.0. - - - - PECL mongodb 1.4.4 - - Se lanzará MongoDB\Driver\Exception\InvalidArgumentException si la opción "session" se utiliza conjuntamente con una preocupación de escritura no reconocida. - - - - PECL mongodb 1.4.0 - - El tercer parámetro es ahora un array de options. Para la compatibilidad ascendente, este parámetro siempre aceptará un objeto MongoDB\Driver\ReadPreference. - - - - - - - - - - &reftitle.notes; - &mongodb.note.server.write; - - - - &reftitle.seealso; - - MongoDB\Driver\Command - MongoDB\Driver\Cursor - MongoDB\Driver\Server::executeReadCommand - MongoDB\Driver\Server::executeReadWriteCommand - MongoDB\Driver\Server::executeWriteCommand - MongoDB\Driver\Manager::executeCommand - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/server/executequery.xml b/reference/mongodb/mongodb/driver/server/executequery.xml deleted file mode 100644 index 6963816dbb..0000000000 --- a/reference/mongodb/mongodb/driver/server/executequery.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - MongoDB\Driver\Server::executeQuery - Ejecuta una consulta de base de datos en este servidor - - - - &reftitle.description; - - final public MongoDB\Driver\CursorMongoDB\Driver\Server::executeQuery - stringnamespace - MongoDB\Driver\Queryquery - arraynulloptions&null; - - - Ejecuta la consulta en este servidor. - - - Los valores por omisión para la opción "readPreference" y - la opción "readConcern" de la consulta se deducirán de una transacción activa - (indicada por la opción "session"), luego por la URI de conexión. - - &mongodb.note.server.readpreference; - - - - &reftitle.parameters; - - &mongodb.parameter.namespace; - &mongodb.parameter.query; - - options - - - - options - - - - Opción - Tipo - Descripción - - - - &mongodb.option.readPreference; - &mongodb.option.session; - - -
    -
    -
    -
    -
    -
    - - - &reftitle.returnvalues; - &mongodb.returns.cursor; - - - - &reftitle.errors; - - &mongodb.throws.std; - Lanza una excepción MongoDB\Driver\Exception\RuntimeException - si ocurre un error (i.e. operadores de consulta inválidos). - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 2.0.0 - - El parámetro options ya no acepta - una instancia MongoDB\Driver\WriteConcern. - - - - PECL mongodb 1.21.0 - - Pasar un objeto MongoDB\Driver\ReadPreference como - options está obsoleto y será eliminado en la 2.0. - - - - PECL mongodb 1.4.0 - - El tercer parámetro es ahora un array - de options. Para la compatibilidad ascendente, - este parámetro siempre aceptará un objeto MongoDB\Driver\ReadPreference. - - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Cursor - MongoDB\Driver\Query - MongoDB\Driver\ReadPreference - MongoDB\Driver\Manager::executeQuery - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/server/executereadcommand.xml b/reference/mongodb/mongodb/driver/server/executereadcommand.xml deleted file mode 100644 index 21a393fd33..0000000000 --- a/reference/mongodb/mongodb/driver/server/executereadcommand.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - MongoDB\Driver\Server::executeReadCommand - Ejecuta un comando de base de datos que lee en este servidor - - - - &reftitle.description; - - final public MongoDB\Driver\CursorMongoDB\Driver\Server::executeReadCommand - stringdb - MongoDB\Driver\Commandcommand - arraynulloptions&null; - - - Ejecuta el comando en este servidor, independientemente de la opción - "readPreference". - - - Este método aplicará una lógica específica a los comandos de lectura (por ejemplo - distinct). - Los valores por omisión para las opciones "readPreference" y - "readConcern" serán deducidos de una transacción activa (indicada por - la opción "session"), seguida de la - URI de conexión. - - &mongodb.note.server.readpreference; - - - - &reftitle.parameters; - - &mongodb.parameter.db; - &mongodb.parameter.command; - - options - - - - options - - - - Opción - Tipo - Descripción - - - - &mongodb.option.readConcern; - &mongodb.option.readPreference; - &mongodb.option.session; - - -
    -
    - &mongodb.option.transactionReadWriteConcern; -
    -
    -
    -
    - - - &reftitle.returnvalues; - &mongodb.returns.cursor; - - - - &reftitle.errors; - - &mongodb.throws.session-readwriteconcern; - &mongodb.throws.std; - Lanza una MongoDB\Driver\Exception\RuntimeException en caso de otros errores (por ejemplo: comando inválido). - - - - - &reftitle.seealso; - - MongoDB\Driver\Command - MongoDB\Driver\Cursor - MongoDB\Driver\Server::executeCommand - MongoDB\Driver\Server::executeReadWriteCommand - MongoDB\Driver\Server::executeWriteCommand - MongoDB\Driver\Manager::executeReadCommand - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/server/executereadwritecommand.xml b/reference/mongodb/mongodb/driver/server/executereadwritecommand.xml deleted file mode 100644 index f59f53cfb9..0000000000 --- a/reference/mongodb/mongodb/driver/server/executereadwritecommand.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - MongoDB\Driver\Server::executeReadWriteCommand - Ejecuta un comando de base de datos que lee y escribe en este servidor - - - - &reftitle.description; - - final public MongoDB\Driver\CursorMongoDB\Driver\Server::executeReadWriteCommand - stringdb - MongoDB\Driver\Commandcommand - arraynulloptions&null; - - - Ejecuta el comando en este servidor. - - - Este método aplicará una lógica específica a los comandos de lectura y escritura - (por ejemplo aggregate). - Los valores por omisión para las opciones "readConcern" y - "writeConcern" serán deducidos de una transacción activa (indicada por - la opción "session"), seguida de la - URI de conexión. - - - - - &reftitle.parameters; - - &mongodb.parameter.db; - &mongodb.parameter.command; - - options - - - - options - - - - Opción - Tipo - Descripción - - - - &mongodb.option.readConcern; - &mongodb.option.session; - &mongodb.option.writeConcern; - - -
    -
    - &mongodb.option.transactionReadWriteConcern; -
    -
    -
    -
    - - - &reftitle.returnvalues; - &mongodb.returns.cursor; - - - - &reftitle.errors; - - &mongodb.throws.session-readwriteconcern; - &mongodb.throws.session-unacknowledged; - &mongodb.throws.std; - Lanza una MongoDB\Driver\Exception\RuntimeException en caso de otros errores (por ejemplo: comando inválido). - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.4.4 - - Una MongoDB\Driver\Exception\InvalidArgumentException - será lanzada si la opción "session" es utilizada en - combinación con un writeConcern no reconocido. - - - - - - - - - - &reftitle.notes; - &mongodb.note.server.write; - - - - &reftitle.seealso; - - MongoDB\Driver\Command - MongoDB\Driver\Cursor - MongoDB\Driver\Server::executeCommand - MongoDB\Driver\Server::executeReadCommand - MongoDB\Driver\Server::executeWriteCommand - MongoDB\Driver\Manager::executeReadWriteCommand - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/server/executewritecommand.xml b/reference/mongodb/mongodb/driver/server/executewritecommand.xml deleted file mode 100644 index c4852cab0c..0000000000 --- a/reference/mongodb/mongodb/driver/server/executewritecommand.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - MongoDB\Driver\Server::executeWriteCommand - Ejecuta un comando de base de datos que escribe en este servidor - - - - &reftitle.description; - - final public MongoDB\Driver\CursorMongoDB\Driver\Server::executeWriteCommand - stringdb - MongoDB\Driver\Commandcommand - arraynulloptions&null; - - - Ejecuta el comando en este servidor. - - - Este método aplicará una lógica específica a los comandos que escriben (por ejemplo - drop). - El valor por omisión para la opción "writeConcern" será deducido de una transacción activa (indicada por - la opción "session"), seguida de la - URI de conexión. - - - - Este método no está destinado a ser utilizado para ejecutar - insert, - update, - o delete - comandos. Se recomienda a los usuarios utilizar - MongoDB\Driver\Server::executeBulkWrite para estas - operaciones. - - - - - - &reftitle.parameters; - - &mongodb.parameter.db; - &mongodb.parameter.command; - - options - - - - options - - - - Opción - Tipo - Descripción - - - - &mongodb.option.session; - &mongodb.option.writeConcern; - - -
    -
    - &mongodb.option.transactionReadWriteConcern; -
    -
    -
    -
    - - - &reftitle.returnvalues; - &mongodb.returns.cursor; - - - - &reftitle.errors; - - &mongodb.throws.session-readwriteconcern; - &mongodb.throws.session-unacknowledged; - &mongodb.throws.std; - Lanza una MongoDB\Driver\Exception\RuntimeException en caso de otros errores (por ejemplo: comando inválido). - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.4.4 - - Una MongoDB\Driver\Exception\InvalidArgumentException - será lanzada si la opción "session" es utilizada en - combinación con un writeConcern no reconocido. - - - - - - - - - - &reftitle.notes; - &mongodb.note.server.write; - - - - &reftitle.seealso; - - MongoDB\Driver\Command - MongoDB\Driver\Cursor - MongoDB\Driver\Server::executeCommand - MongoDB\Driver\Server::executeReadCommand - MongoDB\Driver\Server::executeReadWriteCommand - MongoDB\Driver\Manager::executeWriteCommand - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/server/gethost.xml b/reference/mongodb/mongodb/driver/server/gethost.xml deleted file mode 100644 index 4683e7850c..0000000000 --- a/reference/mongodb/mongodb/driver/server/gethost.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - MongoDB\Driver\Server::getHost - Devuelve el nombre del host del servidor - - - - &reftitle.description; - - final public stringMongoDB\Driver\Server::getHost - - - - Devuelve el nombre del host del servidor. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el nombre del host del servidor. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\Driver\Server::getHost</function> - -selectServer(); - -var_dump($server->getHost()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getInfo - MongoDB\Driver\ServerDescription::getHost - - - - - diff --git a/reference/mongodb/mongodb/driver/server/getinfo.xml b/reference/mongodb/mongodb/driver/server/getinfo.xml deleted file mode 100644 index dfeac2532d..0000000000 --- a/reference/mongodb/mongodb/driver/server/getinfo.xml +++ /dev/null @@ -1,255 +0,0 @@ - - - - - - MongoDB\Driver\Server::getInfo - Devuelve un array de información que describe este servidor - - - - &reftitle.description; - - final public arrayMongoDB\Driver\Server::getInfo - - - - Devuelve un array de información que describe el servidor. Este array se deriva - de la respuesta más reciente a la comando hello - obtenida por la supervisión del servidor. - - - - Cuando el controlador está conectado a un balanceador de carga, este método devuelve - la respuesta al comando hello - del servidor de respaldo durante el apretón de manos inicial de la conexión. - Esto contrasta con otros métodos (por ejemplo, MongoDB\Driver\Server::getType), - que devolverán información sobre el balanceador de carga mismo. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un array de información que describe este servidor. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\Driver\Server::getInfo</function> - -selectServer($rp); - -var_dump($server->getInfo()); - -?> -]]> - - &example.outputs.similar; - - - bool(true) - ["topologyVersion"]=> - array(2) { - ["processId"]=> - object(MongoDB\BSON\ObjectId)#4 (1) { - ["oid"]=> - string(24) "617b6d696a3a89d2f77e6df0" - } - ["counter"]=> - int(6) - } - ["hosts"]=> - array(1) { - [0]=> - string(15) "localhost:27017" - } - ["setName"]=> - string(3) "rs0" - ["setVersion"]=> - int(1) - ["ismaster"]=> - bool(true) - ["secondary"]=> - bool(false) - ["primary"]=> - string(15) "localhost:27017" - ["me"]=> - string(15) "localhost:27017" - ["electionId"]=> - object(MongoDB\BSON\ObjectId)#5 (1) { - ["oid"]=> - string(24) "7fffffff0000000000000001" - } - ["lastWrite"]=> - array(4) { - ["opTime"]=> - array(2) { - ["ts"]=> - object(MongoDB\BSON\Timestamp)#6 (2) { - ["increment"]=> - string(1) "1" - ["timestamp"]=> - string(10) "1635478989" - } - ["t"]=> - int(1) - } - ["lastWriteDate"]=> - object(MongoDB\BSON\UTCDateTime)#7 (1) { - ["milliseconds"]=> - string(13) "1635478989000" - } - ["majorityOpTime"]=> - array(2) { - ["ts"]=> - object(MongoDB\BSON\Timestamp)#8 (2) { - ["increment"]=> - string(1) "1" - ["timestamp"]=> - string(10) "1635478989" - } - ["t"]=> - int(1) - } - ["majorityWriteDate"]=> - object(MongoDB\BSON\UTCDateTime)#9 (1) { - ["milliseconds"]=> - string(13) "1635478989000" - } - } - ["maxBsonObjectSize"]=> - int(16777216) - ["maxMessageSizeBytes"]=> - int(48000000) - ["maxWriteBatchSize"]=> - int(100000) - ["localTime"]=> - object(MongoDB\BSON\UTCDateTime)#10 (1) { - ["milliseconds"]=> - string(13) "1635478992136" - } - ["logicalSessionTimeoutMinutes"]=> - int(30) - ["connectionId"]=> - int(3) - ["minWireVersion"]=> - int(0) - ["maxWireVersion"]=> - int(13) - ["readOnly"]=> - bool(false) - ["ok"]=> - float(1) - ["$clusterTime"]=> - array(2) { - ["clusterTime"]=> - object(MongoDB\BSON\Timestamp)#11 (2) { - ["increment"]=> - string(1) "1" - ["timestamp"]=> - string(10) "1635478989" - } - ["signature"]=> - array(2) { - ["hash"]=> - object(MongoDB\BSON\Binary)#12 (2) { - ["data"]=> - string(20) "" - ["type"]=> - int(0) - } - ["keyId"]=> - int(0) - } - } - ["operationTime"]=> - object(MongoDB\BSON\Timestamp)#13 (2) { - ["increment"]=> - string(1) "1" - ["timestamp"]=> - string(10) "1635478989" - } -} -]]> - - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.11.0 - - Cuando el controlador está conectado a un balanceador de carga, - este método devuelve la respuesta al comando hello del servidor - de respaldo a partir del apretón de manos de conexión inicial. - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\ServerDescription::getHelloResponse - Comando hello en el manual de MongoDB - Especificación de la detección y supervisión de servidores - - - - - diff --git a/reference/mongodb/mongodb/driver/server/getlatency.xml b/reference/mongodb/mongodb/driver/server/getlatency.xml deleted file mode 100644 index 781e1b5cd6..0000000000 --- a/reference/mongodb/mongodb/driver/server/getlatency.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - MongoDB\Driver\Server::getLatency - Devuelve la latencia de este servidor en milisegundos - - - - &reftitle.description; - - final public integernullMongoDB\Driver\Server::getLatency - - - - Devuelve la latencia de este servidor en milisegundos. Es la medida del cliente del tiempo de - ida y vuelta - de un comando hello. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la latencia del servidor en milisegundos, - o &null; si no se ha medido ninguna latencia (por ejemplo, el cliente está conectado a un balanceador de carga). - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.11.0 - - Este método devolverá &null; si no se ha medido ninguna latencia. - En versiones anteriores, siempre se devolvía un número entero - y un valor no definido podía ser señalado como -1. - - - - - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\Driver\Server::getLatency</function> - -selectServer(); - -var_dump($server->getLatency()); - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getInfo - MongoDB\Driver\ServerDescription::getRoundTripTime - La especificación sobre el descubrimiento y la supervisión de un servidor - - - - - diff --git a/reference/mongodb/mongodb/driver/server/getport.xml b/reference/mongodb/mongodb/driver/server/getport.xml deleted file mode 100644 index 0019e9a72a..0000000000 --- a/reference/mongodb/mongodb/driver/server/getport.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - MongoDB\Driver\Server::getPort - Devuelve el puerto en el que el servidor está escuchando - - - - &reftitle.description; - - final public intMongoDB\Driver\Server::getPort - - - - Devuelve el puerto en el que el servidor está escuchando. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el puerto en el que el servidor está escuchando. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\Driver\Server::getPort</function> - -selectServer(); - -var_dump($server->getPort()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getInfo - MongoDB\Driver\ServerDescription::getPort - - - - - diff --git a/reference/mongodb/mongodb/driver/server/getserverdescription.xml b/reference/mongodb/mongodb/driver/server/getserverdescription.xml deleted file mode 100644 index a7ec4543ae..0000000000 --- a/reference/mongodb/mongodb/driver/server/getserverdescription.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - MongoDB\Driver\Server::getServerDescription - Devuelve una ServerDescription para este servidor - - - - &reftitle.description; - - final public MongoDB\Driver\ServerDescriptionMongoDB\Driver\Server::getServerDescription - - - - Devuelve una MongoDB\Driver\ServerDescription para este - servidor. Es un objeto de valor inmutable que describirá el servidor en el momento - en que se llame a este método. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una MongoDB\Driver\ServerDescription para este - servidor. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/server/gettags.xml b/reference/mongodb/mongodb/driver/server/gettags.xml deleted file mode 100644 index d2a1efce69..0000000000 --- a/reference/mongodb/mongodb/driver/server/gettags.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\Driver\Server::getTags - Devuelve un array de tags que describen este servidor en un conjunto de réplicas - - - - &reftitle.description; - - final public arrayMongoDB\Driver\Server::getTags - - - - Devuelve un array de - tags utilizados para - describir este servidor en un conjunto de réplicas. El array contendrá cero o más - pares clave y valor de tipo string. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un array de tags utilizados para describir este servidor en un - conjunto de réplicas. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getInfo - - - - - - diff --git a/reference/mongodb/mongodb/driver/server/gettype.xml b/reference/mongodb/mongodb/driver/server/gettype.xml deleted file mode 100644 index 61ed5cdb95..0000000000 --- a/reference/mongodb/mongodb/driver/server/gettype.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - MongoDB\Driver\Server::getType - Devuelve un integer que representa el tipo del servidor - - - - &reftitle.description; - - final public intMongoDB\Driver\Server::getType - - - - Devuelve un &integer; que representa el tipo del servidor. El valor - corresponderá a una constante MongoDB\Driver\Server. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un &integer; que representa el tipo del servidor. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getInfo - MongoDB\Driver\ServerDescription::getType - - - - - diff --git a/reference/mongodb/mongodb/driver/server/isarbiter.xml b/reference/mongodb/mongodb/driver/server/isarbiter.xml deleted file mode 100644 index 6a302f5ffc..0000000000 --- a/reference/mongodb/mongodb/driver/server/isarbiter.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\Driver\Server::isArbiter - Verifica si este servidor es un miembro árbitro de un conjunto de réplicas - - - - &reftitle.description; - - final public boolMongoDB\Driver\Server::isArbiter - - - - Devuelve si este servidor es un - miembro árbitro - de un conjunto de réplicas. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si este servidor es un miembro árbitro de un conjunto de réplicas, y - &false; en caso contrario. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getInfo - - - - - - diff --git a/reference/mongodb/mongodb/driver/server/ishidden.xml b/reference/mongodb/mongodb/driver/server/ishidden.xml deleted file mode 100644 index e871736434..0000000000 --- a/reference/mongodb/mongodb/driver/server/ishidden.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\Driver\Server::isHidden - Indica si este servidor es un miembro oculto de un conjunto de réplicas - - - - &reftitle.description; - - final public boolMongoDB\Driver\Server::isHidden - - - - Indica si este servidor es un - miembro oculto - de un conjunto de réplicas. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si este servidor es un miembro oculto de un conjunto de réplicas, y - &false; en caso contrario. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getInfo - - - - - - diff --git a/reference/mongodb/mongodb/driver/server/ispassive.xml b/reference/mongodb/mongodb/driver/server/ispassive.xml deleted file mode 100644 index 4987994ba5..0000000000 --- a/reference/mongodb/mongodb/driver/server/ispassive.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - MongoDB\Driver\Server::isPassive - Verifica si el servidor es un miembro pasivo del conjunto de réplicas - - - - &reftitle.description; - - final public boolMongoDB\Driver\Server::isPassive - - - - Devuelve si el servidor es un - miembro pasivo - de un conjunto de réplicas (i.e. su prioridad es 0). - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si el servidor es un miembro pasivo de un conjunto de réplicas, - y &false; en caso contrario. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getInfo - - - - - - diff --git a/reference/mongodb/mongodb/driver/server/isprimary.xml b/reference/mongodb/mongodb/driver/server/isprimary.xml deleted file mode 100644 index 72b8e74f70..0000000000 --- a/reference/mongodb/mongodb/driver/server/isprimary.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\Driver\Server::isPrimary - Verifica si este servidor es un miembro principal de un conjunto de réplicas - - - - &reftitle.description; - - final public boolMongoDB\Driver\Server::isPrimary - - - - Devuelve si este servidor es un - miembro principal - de un conjunto de réplicas. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si este servidor es un miembro principal de un conjunto de réplicas, y - &false; en caso contrario. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getInfo - - - - - - diff --git a/reference/mongodb/mongodb/driver/server/issecondary.xml b/reference/mongodb/mongodb/driver/server/issecondary.xml deleted file mode 100644 index b4ad87bd6a..0000000000 --- a/reference/mongodb/mongodb/driver/server/issecondary.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\Driver\Server::isSecondary - Verifica si este servidor es un miembro secundario de un conjunto de réplicas - - - - &reftitle.description; - - final public boolMongoDB\Driver\Server::isSecondary - - - - Devuelve si este servidor es un - miembro secundario - de un conjunto de réplicas. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si este servidor es un miembro secundario de un conjunto de réplicas, y - &false; en caso contrario. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getInfo - - - - - - diff --git a/reference/mongodb/mongodb/driver/serverapi.xml b/reference/mongodb/mongodb/driver/serverapi.xml deleted file mode 100644 index 038d15884a..0000000000 --- a/reference/mongodb/mongodb/driver/serverapi.xml +++ /dev/null @@ -1,186 +0,0 @@ - - - - - - La clase MongoDB\Driver\ServerApi - MongoDB\Driver\ServerApi - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\ServerApi - - - - final - - MongoDB\Driver\ServerApi - - - MongoDB\BSON\Serializable - - - - Serializable - - - - &Constants; - - const - string - MongoDB\Driver\ServerAPI::V1 - "1" - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - MongoDB\Driver\ServerApi::V1 - - Versión 1 de la API del servidor. - - - - -
    - - -
    - &reftitle.examples; - - - Declarar una versión de API en un gestor - - $v1]); - -$command = new MongoDB\Driver\Command(['buildInfo' => 1]); - -try { - $cursor = $manager->executeCommand('admin', $command); -} catch(MongoDB\Driver\Exception $e) { - echo $e->getMessage(), "\n"; - exit; -} - -/* El comando buildInfo devuelve un único documento de resultado, por lo que - * necesitamos acceder al primer resultado en el cursor. */ -$buildInfo = $cursor->toArray()[0]; - -echo $buildInfo->version, "\n"; - -?> -]]> - - - &example.outputs; - - - - - - - Declarar una versión estricta de API en un gestor - - El siguiente ejemplo establece la strict flag, que - indica al servidor que rechace cualquier comando que no forme parte de la - versión de API declarada. Esto genera un error al ejecutar el comando - buildInfo. - - - $v1]); - -$command = new MongoDB\Driver\Command(['buildInfo' => 1]); - -try { - $cursor = $manager->executeCommand('admin', $command); -} catch(MongoDB\Driver\Exception $e) { - echo $e->getMessage(), "\n"; - exit; -} - -/* El comando buildInfo devuelve un único documento de resultado, por lo que - * necesitamos acceder al primer resultado en el cursor. */ -$buildInfo = $cursor->toArray()[0]; - -echo $buildInfo->version, "\n"; - -?> -]]> - - - &example.outputs; - - - - -
    - -
    - - &reference.mongodb.mongodb.driver.entities.serverapi; - -
    - - diff --git a/reference/mongodb/mongodb/driver/serverapi/bsonserialize.xml b/reference/mongodb/mongodb/driver/serverapi/bsonserialize.xml deleted file mode 100644 index d862887c81..0000000000 --- a/reference/mongodb/mongodb/driver/serverapi/bsonserialize.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - MongoDB\Driver\ServerApi::bsonSerialize - Devuelve un objeto para la serialización BSON - - - - &reftitle.description; - - final public stdClassMongoDB\Driver\ServerApi::bsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un objeto para la serialización del ServerApi en BSON. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\BSON\Serializable::bsonSerialize - - - - - - diff --git a/reference/mongodb/mongodb/driver/serverapi/construct.xml b/reference/mongodb/mongodb/driver/serverapi/construct.xml deleted file mode 100644 index 74fc88ad3f..0000000000 --- a/reference/mongodb/mongodb/driver/serverapi/construct.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - MongoDB\Driver\ServerApi::__construct - Crear una nueva instancia de ServerApi - - - - &reftitle.description; - - final public MongoDB\Driver\ServerApi::__construct - stringversion - boolnullstrict&null; - boolnulldeprecationErrors&null; - - - - Crear una nueva instancia de MongoDB\Driver\ServerApi utilizada para - declarar una versión de API al crear un - MongoDB\Driver\Manager. - - - - - &reftitle.parameters; - - - version - - - Una versión de API de servidor. - - - Las versiones de API admitidas se proporcionan como constantes - en MongoDB\Driver\ServerApi. La única versión de API - admitida es MongoDB\Driver\ServerApi::V1. - - - - - strict - - - Si el parámetro strict se establece en &true;, el - servidor devolverá un error para cualquier comando que no forme parte de la - versión de API especificada. Si no se proporciona ningún valor, se utiliza el valor predeterminado del servidor - (&false;). - - - - - deprecationErrors - - - Si el parámetro deprecationErrors se establece en &true;, - el servidor devolverá un error al utilizar un comando que está obsoleto en - la versión de API especificada. Si no se proporciona ningún valor, se utiliza el valor predeterminado del servidor - (&false;). - - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/serverdescription.xml b/reference/mongodb/mongodb/driver/serverdescription.xml deleted file mode 100644 index 6a6c703c46..0000000000 --- a/reference/mongodb/mongodb/driver/serverdescription.xml +++ /dev/null @@ -1,215 +0,0 @@ - - - - - - La clase MongoDB\Driver\ServerDescription - MongoDB\Driver\ServerDescription - - - - -
    - &reftitle.intro; - - La clase MongoDB\Driver\ServerDescription es un objeto - valor que representa un servidor al que el controlador está conectado. Las - instancias de esta clase son devueltas por los métodos - MongoDB\Driver\Server::getServerDescription y - MongoDB\Driver\Monitoring\ServerChangedEvent. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\ServerDescription - - - - final - - MongoDB\Driver\ServerDescription - - - - &Constants; - - const - string - MongoDB\Driver\ServerDescription::TYPE_UNKNOWN - "Unknown" - - - const - string - MongoDB\Driver\ServerDescription::TYPE_STANDALONE - "Standalone" - - - const - string - MongoDB\Driver\ServerDescription::TYPE_MONGOS - "Mongos" - - - const - string - MongoDB\Driver\ServerDescription::TYPE_POSSIBLE_PRIMARY - "PossiblePrimary" - - - const - string - MongoDB\Driver\ServerDescription::TYPE_RS_PRIMARY - "RSPrimary" - - - const - string - MongoDB\Driver\ServerDescription::TYPE_RS_SECONDARY - "RSSecondary" - - - const - string - MongoDB\Driver\ServerDescription::TYPE_RS_ARBITER - "RSArbiter" - - - const - string - MongoDB\Driver\ServerDescription::TYPE_RS_OTHER - "RSOther" - - - const - string - MongoDB\Driver\ServerDescription::TYPE_RS_GHOST - "RSGhost" - - - const - string - MongoDB\Driver\ServerDescription::TYPE_LOAD_BALANCER - "LoadBalancer" - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - MongoDB\Driver\ServerDescription::TYPE_UNKNOWN - - Tipo de servidor desconocido, devuelto por MongoDB\Driver\ServerDescription::getType. - - - - - MongoDB\Driver\ServerDescription::TYPE_STANDALONE - - Tipo de servidor independiente, devuelto por MongoDB\Driver\ServerDescription::getType. - - - - - MongoDB\Driver\ServerDescription::TYPE_MONGOS - - Tipo de servidor Mongos, devuelto por MongoDB\Driver\ServerDescription::getType. - - - - - MongoDB\Driver\ServerDescription::TYPE_POSSIBLE_PRIMARY - - Tipo de servidor posible primario de conjunto de réplicas, devuelto por MongoDB\Driver\ServerDescription::getType. - Un servidor puede ser identificado como posible primario si aún no ha sido verificado pero otro miembro del conjunto de réplicas considera que es el primario. - - - - - MongoDB\Driver\ServerDescription::TYPE_RS_PRIMARY - - Tipo de servidor primario de conjunto de réplicas, devuelto por MongoDB\Driver\ServerDescription::getType. - - - - - MongoDB\Driver\ServerDescription::TYPE_RS_SECONDARY - - Tipo de servidor secundario de conjunto de réplicas, devuelto por MongoDB\Driver\ServerDescription::getType. - - - - - MongoDB\Driver\ServerDescription::TYPE_RS_ARBITER - - Tipo de servidor árbitro de conjunto de réplicas, devuelto por MongoDB\Driver\ServerDescription::getType. - - - - - MongoDB\Driver\ServerDescription::ServerDescription::TYPE_RS_OTHER - - Tipo de servidor de conjunto de réplicas de otro tipo, devuelto por MongoDB\Driver\ServerDescription::getType. - Estos servidores pueden estar ocultos, iniciándose o en recuperación. No pueden ser consultados, pero sus listas de hosts son útiles para descubrir la configuración actual del conjunto de réplicas. - - - - - MongoDB\Driver\ServerDescription::TYPE_RS_GHOST - - Tipo de servidor fantasma de conjunto de réplicas, devuelto por MongoDB\Driver\ServerDescription::getType. - Los servidores pueden ser identificados como tales en al menos tres situaciones: brevemente durante el inicio del servidor; en un conjunto de réplicas no inicializado; o cuando el servidor es excluido (es decir, eliminado de la configuración del conjunto de réplicas). No pueden ser consultados, ni su lista de hosts puede usarse para descubrir la configuración actual del conjunto de réplicas; sin embargo, el cliente puede monitorear este servidor con la esperanza de que pase a un estado más útil. - - - - - MongoDB\Driver\ServerDescription::TYPE_LOAD_BALANCER - - Tipo de servidor equilibrador de carga, devuelto por MongoDB\Driver\ServerDescription::getType. - - - - -
    - - -
    - - &reference.mongodb.mongodb.driver.entities.serverdescription; - -
    - - diff --git a/reference/mongodb/mongodb/driver/serverdescription/gethelloresponse.xml b/reference/mongodb/mongodb/driver/serverdescription/gethelloresponse.xml deleted file mode 100644 index d0d9285c72..0000000000 --- a/reference/mongodb/mongodb/driver/serverdescription/gethelloresponse.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - MongoDB\Driver\ServerDescription::getHelloResponse - Devuelve la respuesta "hello" más reciente del servidor - - - - &reftitle.description; - - final public arrayMongoDB\Driver\ServerDescription::getHelloResponse - - - - Devuelve un array de información que describe el servidor. Este array se deriva de la respuesta - hello - más reciente (en el momento en que la - MongoDB\Driver\ServerDescription fue construida) obtenida a través de - la supervisión del servidor. - - - - Cuando el controlador está conectado a un balanceador de carga, este método devolverá - un array vacío porque los balanceadores de carga no son supervisados. Esto contrasta con - MongoDB\Driver\Server::getInfo, que devolvería la respuesta del - hello - de la comando de apretón de manos de conexión inicial del servidor base. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un array de información que describe este servidor. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getInfo - hello comando en el manual de MongoDB - Descubrimiento y supervisión de servidores - - - - - - diff --git a/reference/mongodb/mongodb/driver/serverdescription/gethost.xml b/reference/mongodb/mongodb/driver/serverdescription/gethost.xml deleted file mode 100644 index 2442a05ced..0000000000 --- a/reference/mongodb/mongodb/driver/serverdescription/gethost.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - MongoDB\Driver\ServerDescription::getHost - Devuelve el nombre de host de este servidor - - - - &reftitle.description; - - final public stringMongoDB\Driver\ServerDescription::getHost - - - - Devuelve el nombre de host de este servidor. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el nombre de host de este servidor. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getHost - - - - - - diff --git a/reference/mongodb/mongodb/driver/serverdescription/getlastupdatetime.xml b/reference/mongodb/mongodb/driver/serverdescription/getlastupdatetime.xml deleted file mode 100644 index 917578444f..0000000000 --- a/reference/mongodb/mongodb/driver/serverdescription/getlastupdatetime.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - MongoDB\Driver\ServerDescription::getLastUpdateTime - Devuelve la hora de la última actualización del servidor en microsegundos - - - - &reftitle.description; - - final public intMongoDB\Driver\ServerDescription::getLastUpdateTime - - - - Devuelve la hora de la última actualización del servidor en microsegundos. - - - - El valor devuelto es un timestamp monotónico, que comienza en un punto arbitrario. - Por lo tanto, es únicamente adecuado para ser comparado con otros valores de retorno de - MongoDB\Driver\ServerDescription::getLastUpdateTime. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la hora de la última actualización del servidor en microsegundos. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/serverdescription/getport.xml b/reference/mongodb/mongodb/driver/serverdescription/getport.xml deleted file mode 100644 index 2a6a1068b7..0000000000 --- a/reference/mongodb/mongodb/driver/serverdescription/getport.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - MongoDB\Driver\ServerDescription::getPort - Devuelve el puerto en el que este servidor escucha - - - - &reftitle.description; - - final public intMongoDB\Driver\ServerDescription::getPort - - - - Devuelve el puerto en el que este servidor escucha. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el puerto en el que este servidor escucha. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getPort - - - - - - diff --git a/reference/mongodb/mongodb/driver/serverdescription/getroundtriptime.xml b/reference/mongodb/mongodb/driver/serverdescription/getroundtriptime.xml deleted file mode 100644 index 1b73a95f1b..0000000000 --- a/reference/mongodb/mongodb/driver/serverdescription/getroundtriptime.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - MongoDB\Driver\ServerDescription::getRoundTripTime - Devuelve el tiempo de ida y vuelta del servidor en milisegundos - - - - &reftitle.description; - - final public intnullMongoDB\Driver\ServerDescription::getRoundTripTime - - - - Devuelve el tiempo de ida y vuelta del servidor en milisegundos. Se trata de - la medida del cliente de la duración de una - comando - hello. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el tiempo de ida y vuelta del servidor en milisegundos. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getLatency - - - - - - diff --git a/reference/mongodb/mongodb/driver/serverdescription/gettype.xml b/reference/mongodb/mongodb/driver/serverdescription/gettype.xml deleted file mode 100644 index 6c11f09d23..0000000000 --- a/reference/mongodb/mongodb/driver/serverdescription/gettype.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - MongoDB\Driver\ServerDescription::getType - Devuelve un string que indica el tipo de este servidor - - - - &reftitle.description; - - final public stringMongoDB\Driver\ServerDescription::getType - - - - Devuelve un string que indica el tipo de este servidor. El valor - estará correlacionado con una constante - MongoDB\Driver\ServerDescription. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un string que indica el tipo de este servidor. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Server::getType - - - - - - diff --git a/reference/mongodb/mongodb/driver/session.xml b/reference/mongodb/mongodb/driver/session.xml deleted file mode 100644 index 08a59603cc..0000000000 --- a/reference/mongodb/mongodb/driver/session.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - La clase MongoDB\Driver\Session - MongoDB\Driver\Session - - - - -
    - &reftitle.intro; - - La clase MongoDB\Driver\Session representa una - sesión de cliente y es devuelta por - MongoDB\Driver\Manager::startSession. Los comandos, - consultas y operaciones de escritura pueden entonces asociarse a la sesión. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\Session - - - - final - - MongoDB\Driver\Session - - - - - &Constants; - - const - string - MongoDB\Driver\Session::TRANSACTION_NONE - none - - - const - string - MongoDB\Driver\Session::TRANSACTION_STARTING - starting - - - const - string - MongoDB\Driver\Session::TRANSACTION_IN_PROGRESS - in_progress - - - const - string - MongoDB\Driver\Session::TRANSACTION_COMMITTED - committed - - - const - string - MongoDB\Driver\Session::TRANSACTION_ABORTED - aborted - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - MongoDB\Driver\Session::TRANSACTION_NONE - - - No hay ninguna transacción en curso. - - - - - - MongoDB\Driver\Session::TRANSACTION_STARTING - - - Se ha iniciado una transacción, pero no se ha enviado ninguna operación al servidor. - - - - - - MongoDB\Driver\Session::TRANSACTION_IN_PROGRESS - - - Hay una transacción en curso. - - - - - - MongoDB\Driver\Session::TRANSACTION_COMMITTED - - - La transacción se ha confirmado. - - - - - - MongoDB\Driver\Session::TRANSACTION_ABORTED - - - La transacción se ha abortado. - - - - - -
    - - -
    - - &reference.mongodb.mongodb.driver.entities.session; - -
    - - diff --git a/reference/mongodb/mongodb/driver/session/aborttransaction.xml b/reference/mongodb/mongodb/driver/session/aborttransaction.xml deleted file mode 100644 index 52371a5b09..0000000000 --- a/reference/mongodb/mongodb/driver/session/aborttransaction.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - MongoDB\Driver\Session::abortTransaction - Anula una transacción - - - - &reftitle.description; - - final public voidMongoDB\Driver\Session::abortTransaction - - - - Termina la transacción multi-documento y anula todas las modificaciones de datos - realizadas por las operaciones en la transacción. Es decir, la transacción se termina - sin guardar ninguna de las modificaciones realizadas por las operaciones en la transacción. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lanza una MongoDB\Driver\Exception\RuntimeException si la transacción no puede ser anulada (por ejemplo, una transacción no ha sido iniciada). - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::startSession - MongoDB\Driver\Session::commitTransaction - MongoDB\Driver\Session::startTransaction - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/advanceclustertime.xml b/reference/mongodb/mongodb/driver/session/advanceclustertime.xml deleted file mode 100644 index bd497292dd..0000000000 --- a/reference/mongodb/mongodb/driver/session/advanceclustertime.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - MongoDB\Driver\Session::advanceClusterTime - Avance el tiempo del cluster para esta sesión - - - - &reftitle.description; - - final public voidMongoDB\Driver\Session::advanceClusterTime - arrayobjectclusterTime - - - Avance el tiempo del cluster para esta sesión. Si el tiempo del cluster es inferior o igual - al tiempo del cluster actual de la sesión, esta función no hace nada. - - - Al utilizar este método en conjunción con - MongoDB\Driver\Session::advanceOperationTime para copiar - los tiempos del cluster y de las operaciones de otra sesión - se puede asegurar que las operaciones en esta sesión sean coherentes - con la última operación en la otra sesión. - - - - - &reftitle.parameters; - - - clusterTime - - - El tiempo del cluster es un documento que contiene un horodatage lógico y una firma de servidor. - Típicamente, este valor se obtendrá llamando a - MongoDB\Driver\Session::getClusterTime en otro - objeto de sesión. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Session::advanceOperationTime - MongoDB\Driver\Session::getClusterTime - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/advanceoperationtime.xml b/reference/mongodb/mongodb/driver/session/advanceoperationtime.xml deleted file mode 100644 index caa3939624..0000000000 --- a/reference/mongodb/mongodb/driver/session/advanceoperationtime.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - MongoDB\Driver\Session::advanceOperationTime - Avance el tiempo de operación para esta sesión - - - - &reftitle.description; - - final public voidMongoDB\Driver\Session::advanceOperationTime - MongoDB\BSON\TimestampInterfaceoperationTime - - - Avance el tiempo de operación para esta sesión. Si el tiempo de operación es inferior o igual - al tiempo de operación actual de la sesión, esta función no hace nada. - - - Al utilizar este método en conjunción con - MongoDB\Driver\Session::advanceClusterTime para copiar - los tiempos de operación y de cluster de otra sesión - se puede asegurar que las operaciones en esta sesión sean coherentes - con la última operación en la otra sesión. - - - - - &reftitle.parameters; - - - operationTime - - - La operación es un timestamp lógico. Típicamente, este valor - será obtenido llamando a - MongoDB\Driver\Session::getOperationTime en - otro objeto de sesión. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Session::advanceClusterTime - MongoDB\Driver\Session::getClusterTime - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/committransaction.xml b/reference/mongodb/mongodb/driver/session/committransaction.xml deleted file mode 100644 index 30a3d9a688..0000000000 --- a/reference/mongodb/mongodb/driver/session/committransaction.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - MongoDB\Driver\Session::commitTransaction - Valida la transacción - - - - &reftitle.description; - - final public voidMongoDB\Driver\Session::commitTransaction - - - - Guarda los cambios realizados por las operaciones en la transacción - multi-documento y finaliza la transacción. Hasta la validación, ninguno de - los cambios de datos realizados por las operaciones en la transacción - es visible fuera de la transacción. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lanza una - MongoDB\Driver\Exception\CommandException si el - servidor no puede validar la transacción (por ejemplo, debido a conflictos, - problemas de red). Si la excepción contiene un elemento - "errorLabels" y este array contiene un valor - "TransientTransactionError" o - "UnknownTransactionCommitResult", es seguro reintentar - la totalidad de la transacción. En versiones más - recientes de la extensión, - MongoDB\Driver\Exception\RuntimeException::hasErrorLabel - debería ser utilizado para probar esta situación en su lugar. - Lanza una - MongoDB\Driver\Exception\RuntimeException si la - transacción no puede ser validada (por ejemplo, una transacción no ha sido - iniciada). - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::startSession - MongoDB\Driver\Session::abortTransaction - MongoDB\Driver\Session::startTransaction - MongoDB\Driver\Exception\RuntimeException::hasErrorLabel - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/construct.xml b/reference/mongodb/mongodb/driver/session/construct.xml deleted file mode 100644 index d6b3f57a66..0000000000 --- a/reference/mongodb/mongodb/driver/session/construct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - MongoDB\Driver\Session::__construct - Crear una nueva sesión (sin usar) - - - - &reftitle.description; - - final private MongoDB\Driver\Session::__construct - - - - Los objetos MongoDB\Driver\Session son devueltos por - MongoDB\Driver\Manager::startSession y no pueden ser - construidos directamente. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::startSession - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/endsession.xml b/reference/mongodb/mongodb/driver/session/endsession.xml deleted file mode 100644 index 71a075f20d..0000000000 --- a/reference/mongodb/mongodb/driver/session/endsession.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - MongoDB\Driver\Session::endSession - Termina una sesión - - - - &reftitle.description; - - final public voidMongoDB\Driver\Session::endSession - - - - Este método cierra una sesión existente. Si una transacción estaba asociada - a esta sesión, la transacción será anulada. Después de llamar a este - método, las aplicaciones no deben invocar otros métodos en la sesión. - - - - Las sesiones también se cierran durante la recolección de basura. No debería ser - necesario llamar a este método en circunstancias normales. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::startSession - MongoDB\Driver\Session::abortTransaction - MongoDB\Driver\Session::commitTransaction - MongoDB\Driver\Session::startTransaction - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/getclustertime.xml b/reference/mongodb/mongodb/driver/session/getclustertime.xml deleted file mode 100644 index 882a69f77a..0000000000 --- a/reference/mongodb/mongodb/driver/session/getclustertime.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\Driver\Session::getClusterTime - Devuelve el tiempo del cluster para esta sesión - - - - &reftitle.description; - - final public objectnullMongoDB\Driver\Session::getClusterTime - - - - Devuelve el tiempo del cluster para esta sesión. Si la sesión no ha sido utilizada - para una operación y - MongoDB\Driver\Session::advanceClusterTime no ha - sido llamado, el tiempo del cluster será &null;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el tiempo del cluster para esta sesión, o &null; si la sesión no tiene - tiempo del cluster. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Session::advanceClusterTime - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/getlogicalsessionid.xml b/reference/mongodb/mongodb/driver/session/getlogicalsessionid.xml deleted file mode 100644 index e2379c9fd6..0000000000 --- a/reference/mongodb/mongodb/driver/session/getlogicalsessionid.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - MongoDB\Driver\Session::getLogicalSessionId - Devuelve el identificador de sesión lógica para esta sesión - - - - &reftitle.description; - - final public objectMongoDB\Driver\Session::getLogicalSessionId - - - - Devuelve el identificador de sesión lógica para esta sesión, que puede ser utilizado para - identificar las operaciones de esta sesión en el servidor. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el identificador de sesión lógica para esta sesión. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/getoperationtime.xml b/reference/mongodb/mongodb/driver/session/getoperationtime.xml deleted file mode 100644 index d8a796e9e5..0000000000 --- a/reference/mongodb/mongodb/driver/session/getoperationtime.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - MongoDB\Driver\Session::getOperationTime - Devuelve el tiempo de operación para esta sesión - - - - &reftitle.description; - - final public MongoDB\BSON\TimestampnullMongoDB\Driver\Session::getOperationTime - - - - Devuelve el tiempo de operación para esta sesión. Si la sesión no ha sido utilizada - para una operación y - MongoDB\Driver\Session::advanceOperationTime no ha - sido llamado, el tiempo de operación será &null;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el tiempo de operación para esta sesión, o &null; si la sesión no tiene - tiempo de operación. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Session::advanceOperationTime - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/getserver.xml b/reference/mongodb/mongodb/driver/session/getserver.xml deleted file mode 100644 index 312f8a95b7..0000000000 --- a/reference/mongodb/mongodb/driver/session/getserver.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - MongoDB\Driver\Session::getServer - Devuelve el servidor al que esta sesión está fijada - - - - &reftitle.description; - - final public MongoDB\Driver\ServernullMongoDB\Driver\Session::getServer - - - - Devuelve el MongoDB\Driver\Server al que esta sesión - está fijada. Si la sesión no está fijada a un servidor, &null; - será devuelto. - - - La fijación de la sesión se utiliza principalmente para las transacciones - distribuidas, ya que todas las órdenes en una transacción distribuida deben - ser enviadas a la misma instancia mongos. Este método está destinado a ser - utilizado por bibliotecas construidas sobre la extensión para permitir el uso - de un servidor fijado en lugar de invocar la selección del servidor. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el MongoDB\Driver\Server al que esta sesión - está fijada, o &null; si la sesión no está fijada a un servidor. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/gettransactionoptions.xml b/reference/mongodb/mongodb/driver/session/gettransactionoptions.xml deleted file mode 100644 index 74dcdf8574..0000000000 --- a/reference/mongodb/mongodb/driver/session/gettransactionoptions.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - MongoDB\Driver\Session::getTransactionOptions - Devuelve las opciones para la transacción en curso - - - - &reftitle.description; - - final public arraynullMongoDB\Driver\Session::getTransactionOptions - - - - Devuelve las opciones para la transacción en curso. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un array que contiene las opciones de transacción actuales, o - &null; si no hay ninguna transacción en curso. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Session::getTransactionState - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/gettransactionstate.xml b/reference/mongodb/mongodb/driver/session/gettransactionstate.xml deleted file mode 100644 index ae4ecd70aa..0000000000 --- a/reference/mongodb/mongodb/driver/session/gettransactionstate.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - MongoDB\Driver\Session::getTransactionState - Devuelve el estado de la transacción actual para esta sesión - - - - &reftitle.description; - - final public stringMongoDB\Driver\Session::getTransactionState - - - - Devuelve el estado de la transacción para esta sesión. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el estado de la transacción actual para esta sesión. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Session::isInTransaction - MongoDB\Driver\Session::getTransactionOptions - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/isdirty.xml b/reference/mongodb/mongodb/driver/session/isdirty.xml deleted file mode 100644 index 9ade117a5c..0000000000 --- a/reference/mongodb/mongodb/driver/session/isdirty.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - MongoDB\Driver\Session::isDirty - Indica si la sesión ha sido marcada como sucia - - - - &reftitle.description; - - final public boolMongoDB\Driver\Session::isDirty - - - - Indica si la sesión ha sido marcada como sucia (es decir, que ha sido utilizada - con un comando que ha encontrado un error de red). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Indica si la sesión ha sido marcada como sucia. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/isintransaction.xml b/reference/mongodb/mongodb/driver/session/isintransaction.xml deleted file mode 100644 index 2b07c3ea6b..0000000000 --- a/reference/mongodb/mongodb/driver/session/isintransaction.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - MongoDB\Driver\Session::isInTransaction - Indica si una transacción multi-documento está en curso - - - - &reftitle.description; - - final public boolMongoDB\Driver\Session::isInTransaction - - - - Indica si una transacción multi-documento está actualmente en curso para - esta sesión. Una transacción se considera "en curso" si ha sido - iniciada pero no ha sido confirmada o anulada. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si una transacción está actualmente en curso para esta sesión, - y &false; en caso contrario. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.seealso; - - MongoDB\Driver\Session::getTransactionState - - - - - - diff --git a/reference/mongodb/mongodb/driver/session/starttransaction.xml b/reference/mongodb/mongodb/driver/session/starttransaction.xml deleted file mode 100644 index 3cd8aa321d..0000000000 --- a/reference/mongodb/mongodb/driver/session/starttransaction.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - MongoDB\Driver\Session::startTransaction - Inicia una transacción - - - - &reftitle.description; - - final public voidMongoDB\Driver\Session::startTransaction - arraynulloptions&null; - - - Inicia una transacción multi-documento asociada a la sesión. En un momento dado, - solo se puede tener una transacción abierta para una sesión. Después de iniciar una transacción, el objeto de sesión debe ser pasado a cada operación a través - de la opción "session" (por ejemplo - MongoDB\Driver\Manager::executeBulkWrite) para asociar - esta operación a la transacción. - - - Las transacciones pueden ser confirmadas a través de - MongoDB\Driver\Session::commitTransaction, y - anuladas con - MongoDB\Driver\Session::abortTransaction. - Las transacciones también se anulan automáticamente cuando la sesión se cierra por la recolección de basura o al llamar explícitamente a - MongoDB\Driver\Session::endSession. - - - - - &reftitle.parameters; - - - options - - - Las opciones pueden ser pasadas como argumento a este método. Cada elemento de este - array de opciones reemplaza la opción correspondiente de la opción - "defaultTransactionOptions", si se define al - iniciar la sesión con - MongoDB\Driver\Manager::startSession. - - - - options - - - - Opción - Tipo - Descripción - - - - &mongodb.option.maxCommitTimeMS; - &mongodb.option.readConcern; - &mongodb.option.readPreference; - &mongodb.option.writeConcern; - - -
    -
    -
    -
    -
    -
    - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lanza una MongoDB\Driver\Exception\CommandException si la transacción no pudo ser iniciada debido a un problema en el lado del servidor (por ejemplo, un bloqueo no pudo ser obtenido). - Lanza una MongoDB\Driver\Exception\RuntimeException si la transacción no pudo ser iniciada (por ejemplo, una transacción ya estaba en curso). - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.6.0 - - - La opción "maxCommitTimeMS" fue añadida. - - - - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::startSession - MongoDB\Driver\Session::commitTransaction - MongoDB\Driver\Session::abortTransaction - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/topologydescription.xml b/reference/mongodb/mongodb/driver/topologydescription.xml deleted file mode 100644 index 21cfc33ca5..0000000000 --- a/reference/mongodb/mongodb/driver/topologydescription.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - La clase MongoDB\Driver\TopologyDescription - MongoDB\Driver\TopologyDescription - - - - -
    - &reftitle.intro; - - La clase MongoDB\Driver\TopologyDescription es un - objeto valor que representa una topología a la que el controlador está conectado. - Las instancias de esta clase son devueltas por los métodos de - MongoDB\Driver\Monitoring\TopologyChangedEvent. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\TopologyDescription - - - - final - - MongoDB\Driver\TopologyDescription - - - - &Constants; - - const - string - MongoDB\Driver\TopologyDescription::TYPE_UNKNOWN - "Unknown" - - - const - string - MongoDB\Driver\TopologyDescription::TYPE_SINGLE - "Single" - - - const - string - MongoDB\Driver\TopologyDescription::TYPE_SHARDED - "Sharded" - - - const - string - MongoDB\Driver\TopologyDescription::TYPE_REPLICA_SET_NO_PRIMARY - "ReplicaSetNoPrimary" - - - const - string - MongoDB\Driver\TopologyDescription::TYPE_REPLICA_SET_WITH_PRIMARY - "ReplicaSetWithPrimary" - - - const - string - MongoDB\Driver\TopologyDescription::TYPE_LOAD_BALANCED - "LoadBalanced" - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - MongoDB\Driver\TopologyDescription::TYPE_UNKNOWN - - Tipo de topología desconocido, devuelto por MongoDB\Driver\TopologyDescription::getType. - - - - - MongoDB\Driver\TopologyDescription::TYPE_SINGLE - - Servidor único (es decir, conexión directa), devuelto por MongoDB\Driver\TopologyDescription::getType. - - - - - MongoDB\Driver\TopologyDescription::TYPE_SHARDED - - Agrupación particionada, devuelto por MongoDB\Driver\TopologyDescription::getType. - - - - - MongoDB\Driver\TopologyDescription::TYPE_REPLICA_SET_NO_PRIMARY - - Conjunto de réplicas sin servidor primario, devuelto por MongoDB\Driver\TopologyDescription::getType. - - - - - MongoDB\Driver\TopologyDescription::TYPE_REPLICA_SET_WITH_PRIMARY - - Conjunto de réplicas con un servidor primario, devuelto por MongoDB\Driver\TopologyDescription::getType. - - - - - MongoDB\Driver\TopologyDescription::TYPE_LOAD_BALANCED - - Topología con equilibrio de carga, devuelto por MongoDB\Driver\TopologyDescription::getType. - - - - -
    - - -
    - - &reference.mongodb.mongodb.driver.entities.topologydescription; - -
    - - diff --git a/reference/mongodb/mongodb/driver/topologydescription/getservers.xml b/reference/mongodb/mongodb/driver/topologydescription/getservers.xml deleted file mode 100644 index 9a99c81ef4..0000000000 --- a/reference/mongodb/mongodb/driver/topologydescription/getservers.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - MongoDB\Driver\TopologyDescription::getServers - Devuelve los servidores de la topología - - - - &reftitle.description; - - final public arrayMongoDB\Driver\TopologyDescription::getServers - - - - Devuelve un array de objetos MongoDB\Driver\ServerDescription - correspondiente a los servidores conocidos en la topología. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un array de objetos MongoDB\Driver\ServerDescription - correspondiente a los servidores conocidos en la topología. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/topologydescription/gettype.xml b/reference/mongodb/mongodb/driver/topologydescription/gettype.xml deleted file mode 100644 index 626b413b63..0000000000 --- a/reference/mongodb/mongodb/driver/topologydescription/gettype.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - MongoDB\Driver\TopologyDescription::getType - Devuelve un string que denota el tipo de esta topología - - - - &reftitle.description; - - final public stringMongoDB\Driver\TopologyDescription::getType - - - - Devuelve un string que denota el tipo de esta topología. El valor - estará correlacionado con una constante de - MongoDB\Driver\TopologyDescription. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un string que denota el tipo de esta topología. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/topologydescription/hasreadableserver.xml b/reference/mongodb/mongodb/driver/topologydescription/hasreadableserver.xml deleted file mode 100644 index f8b59cbdd2..0000000000 --- a/reference/mongodb/mongodb/driver/topologydescription/hasreadableserver.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - MongoDB\Driver\TopologyDescription::hasReadableServer - Indica si la topología tiene un servidor legible - - - - &reftitle.description; - - final public boolMongoDB\Driver\TopologyDescription::hasReadableServer - MongoDB\Driver\ReadPreferencenullreadPreference&null; - - - Indica si la topología tiene un servidor legible o, si - readPreference está especificado, un servidor que corresponde a - la preferencia de lectura especificada. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Indica si la topología tiene un servidor legible o, si - readPreference está especificado, un servidor que corresponde a - la preferencia de lectura especificada. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/topologydescription/haswritableserver.xml b/reference/mongodb/mongodb/driver/topologydescription/haswritableserver.xml deleted file mode 100644 index 64f8cc49ed..0000000000 --- a/reference/mongodb/mongodb/driver/topologydescription/haswritableserver.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - MongoDB\Driver\TopologyDescription::hasWritableServer - Indica si la topología dispone de un servidor en escritura - - - - &reftitle.description; - - final public boolMongoDB\Driver\TopologyDescription::hasWritableServer - - - - Indica si la topología dispone de un servidor en escritura. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Indica si la topología dispone de un servidor en escritura. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeconcern.xml b/reference/mongodb/mongodb/driver/writeconcern.xml deleted file mode 100644 index c14019b869..0000000000 --- a/reference/mongodb/mongodb/driver/writeconcern.xml +++ /dev/null @@ -1,202 +0,0 @@ - - - - - - - - La clase MongoDB\Driver\WriteConcern - MongoDB\Driver\WriteConcern - - - - -
    - &reftitle.intro; - - MongoDB\Driver\WriteConcern describe el nivel - de acuse de recibo solicitado por MongoDB para las operaciones de escritura - a un mongod autónomo o a conjuntos de réplicas - o a clusters fragmentados. En los clusters fragmentados, las instancias - de mongos transmiten el control de escritura a los - fragmentos. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\WriteConcern - - - - final - - MongoDB\Driver\WriteConcern - - - - MongoDB\BSON\Serializable - - - - Serializable - - - - &Constants; - - const - string - MongoDB\Driver\WriteConcern::MAJORITY - "majority" - - - &Properties; - - public - readonly - stringintnull - w - - - public - readonly - boolnull - j - - - public - readonly - int - wtimeout - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - w - - - El número de réplicas necesarias (entero correspondiente al número de nodos, la cadena - "majority", o el nombre de un tag de write concern personalizado), - o &null; si no está definido. - - - - - j - - - Indica si el journal es requerido, es decir, si las operaciones de escritura deben - ser confirmadas en el journal antes de ser reconocidas, o &null; si no se especificó. - - - - - wtimeout - - - El timeout de espera en milisegundos para el reconocimiento del write concern. - Un valor de 0 significa esperar indefinidamente. - - - - -
    - - - -
    - &reftitle.constants; - - - - MongoDB\Driver\WriteConcern::MAJORITY - - - La mayoría de todos los miembros del conjunto; árbitros, los mismos no votantes, - los miembros pasivos, los miembros ocultos y los miembros en espera están - todos incluidos en la definición de una preocupación de escritura de la mayoría. - - - - - -
    - - -
    - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Se añadieron las propiedades públicas readonly. - - - - PECL mongodb 1.7.0 - - Implementa Serializable. - - - - PECL mongodb 1.2.0 - - Implementa MongoDB\BSON\Serializable. - - - - - - -
    - -
    - - &reference.mongodb.mongodb.driver.entities.writeconcern; - -
    - - diff --git a/reference/mongodb/mongodb/driver/writeconcern/bsonserialize.xml b/reference/mongodb/mongodb/driver/writeconcern/bsonserialize.xml deleted file mode 100644 index 99d902f826..0000000000 --- a/reference/mongodb/mongodb/driver/writeconcern/bsonserialize.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - MongoDB\Driver\WriteConcern::bsonSerialize - Devuelve un objeto para la serialización BSON - - - - &reftitle.description; - - final public stdClassMongoDB\Driver\WriteConcern::bsonSerialize - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un objeto para la serialización del WriteConcern en BSON. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - <function>MongoDB\Driver\WriteConcern::bsonSerialize</function> con el write concern majority - -bsonSerialize()); - -echo "\n", MongoDB\BSON\Document::fromPHP($wc)->toRelaxedExtendedJSON(); - -?> -]]> - - &example.outputs.similar; - - - string(8) "majority" -} - -{ "w" : "majority" } -]]> - - - <function>MongoDB\Driver\WriteConcern::bsonSerialize</function> con el wtimeout y el journal - -bsonSerialize()); - -echo "\n", MongoDB\BSON\Document::fromPHP($wc)->toRelaxedExtendedJSON(); - -?> -]]> - - &example.outputs.similar; - - - int(2) - ["j"]=> - bool(true) - ["wtimeout"]=> - int(1000) -} - -{ "w" : 2, "j" : true, "wtimeout" : 1000 } -]]> - - - - - - &reftitle.seealso; - - MongoDB\BSON\Serializable::bsonSerialize - Referencia de Write Concern - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeconcern/construct.xml b/reference/mongodb/mongodb/driver/writeconcern/construct.xml deleted file mode 100644 index 1ad76983f3..0000000000 --- a/reference/mongodb/mongodb/driver/writeconcern/construct.xml +++ /dev/null @@ -1,230 +0,0 @@ - - - - - - - - MongoDB\Driver\WriteConcern::__construct - Construye un WriteConcern - - - - &reftitle.description; - - final public MongoDB\Driver\WriteConcern::__construct - stringintw - intnullwtimeout&null; - boolnulljournal&null; - - - Construye un nuevo MongoDB\Driver\WriteConcern, que es un objeto de valor inmutable. - - - - - &reftitle.parameters; - - - w - - - - Preocupación de escritura - - - - Valor - Descripción - - - - - 1 - - Solicita el acuse de recibo de que la operación de escritura se ha propagado - al mongod autónomo o al principal en un conjunto de - réplicas. Es la preocupación de escritura por omisión para MongoDB. - - - - 0 - - No solicita ningún acuse de recibo de la operación de escritura. - Sin embargo, puede devolver información sobre las excepciones de socket y los errores de red a la aplicación. - - - - <entero superior a 1> - - Los números superiores a 1 son válidos únicamente para los conjuntos de - réplicas para solicitar el acuse de recibo del número especificado de miembros, incluyendo el principal. - - - - MongoDB\Driver\WriteConcern::MAJORITY - - - Solicita el acuse de recibo de que las operaciones de escritura se han - propagado a la mayoría de los nodos votantes, incluyendo el principal, y - han sido escritas en el journal en disco para esos nodos. - - - Antes de MongoDB 3.0, es la mayoría de los miembros del conjunto de - réplicas (y no solo de los nodos votantes). - - - - - string - - Un valor de string es interpretado como un conjunto de etiquetas. Solicita - el acuse de recibo de que las operaciones de escritura se han propagado a - un miembro del conjunto de réplicas con la etiqueta especificada. - - - - -
    -
    -
    -
    - - wtimeout - - - Tiempo máximo de espera (en milisegundos) antes de que los secundarios - fallen. - - - wtimeout hará que las operaciones de escritura devuelvan - un error (WriteConcernError) después del - tiempo especificado. Cuando estas operaciones de escritura devuelvan, MongoDB - no cancelará los datos modificados antes de que las preocupaciones - de escritura alcancen el tiempo límite wtimeout. - - - Si se especifica, wtimeout debe ser un entero con signo de 64 bits - mayor o igual a cero. - - - - Tiempo máximo de espera de las preocupaciones de escritura - - - - Valor - Descripción - - - - - 0 - Bloquea indefinidamente. Es el comportamiento por omisión. - - - <entero superior a 0> - - Número de milisegundos a esperar antes de devolver. - - - - -
    -
    -
    -
    - - journal - - - Espera antes de que mongod aplique la escritura al journal. - - - -
    -
    - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - Lanza una excepción MongoDB\Driver\Exception\InvalidArgumentException si w es inválido o wtimeout es negativo o superior a los límites de un entero con signo de 32 bits. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL mongodb 1.7.0 - - El parámetro wTimeout acepta ahora valores de 64 bits. - - - - - - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\Driver\WriteConcern::__construct</function> - - -]]> - - - - - - &reftitle.seealso; - - Write Concern reference - - - -
    - - diff --git a/reference/mongodb/mongodb/driver/writeconcern/getjournal.xml b/reference/mongodb/mongodb/driver/writeconcern/getjournal.xml deleted file mode 100644 index 5c2b49ff50..0000000000 --- a/reference/mongodb/mongodb/driver/writeconcern/getjournal.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - MongoDB\Driver\WriteConcern::getJournal - Devuelve la opción "journal" del WriteConcern - - - - &reftitle.description; - - final public boolnullMongoDB\Driver\WriteConcern::getJournal - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la opción "journal" del WriteConcern. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\WriteConcern::getJournal</function> - -getJournal()); - -$wc = new MongoDB\Driver\WriteConcern(1, 0, true); -var_dump($wc->getJournal()); - -$wc = new MongoDB\Driver\WriteConcern(1, 0, false); -var_dump($wc->getJournal()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - Referencia de Write Concern - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeconcern/getw.xml b/reference/mongodb/mongodb/driver/writeconcern/getw.xml deleted file mode 100644 index fbcc04c0ae..0000000000 --- a/reference/mongodb/mongodb/driver/writeconcern/getw.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - MongoDB\Driver\WriteConcern::getW - Devuelve la opción "w" del WriteConcern - - - - &reftitle.description; - - final public stringintnullMongoDB\Driver\WriteConcern::getW - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la opción "w" del WriteConcern. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\WriteConcern::getW</function> - -getW()); - -$wc = new MongoDB\Driver\WriteConcern(MongoDB\Driver\WriteConcern::MAJORITY); -var_dump($wc->getW()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - Referencia de Write Concern - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeconcern/getwtimeout.xml b/reference/mongodb/mongodb/driver/writeconcern/getwtimeout.xml deleted file mode 100644 index d0a3279e61..0000000000 --- a/reference/mongodb/mongodb/driver/writeconcern/getwtimeout.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - MongoDB\Driver\WriteConcern::getWtimeout - Devuelve la opción "wtimeout" del WriteConcern - - - - &reftitle.description; - - final public intMongoDB\Driver\WriteConcern::getWtimeout - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la opción "wtimeout" del WriteConcern. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 1.7.0 - - En sistemas de 32 bits, este método siempre truncará el valor - wTimeout si excede el rango de 32 bits. En tal caso, se emitirá - una advertencia. - - - - - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\WriteConcern::getWtimeout</function> - -getWtimeout()); - -$wc = new MongoDB\Driver\WriteConcern(MongoDB\Driver\WriteConcern::MAJORITY, 3000); -var_dump($wc->getWtimeout()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - Referencia de Write Concern - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeconcern/isdefault.xml b/reference/mongodb/mongodb/driver/writeconcern/isdefault.xml deleted file mode 100644 index b3406e3ba6..0000000000 --- a/reference/mongodb/mongodb/driver/writeconcern/isdefault.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - MongoDB\Driver\WriteConcern::isDefault - Verifica si es el WriteConcern por omisión - - - - &reftitle.description; - - final public boolMongoDB\Driver\WriteConcern::isDefault - - - - Devuelve si es el WriteConcern por omisión (es decir, sin opciones especificadas). Este método está principalmente destinado a ser utilizado en conjunción con - MongoDB\Driver\Manager::getWriteConcern para determinar - si el Manager ha sido construido sin ninguna opción de WriteConcern. - - - El controlador no incluirá un WriteConcern por omisión en sus operaciones de escritura - (por ejemplo MongoDB\Driver\Manager::executeBulkWrite) para permitir que el servidor aplique su propio WriteConcern por omisión, que puede haber sido - modificado. - Las bibliotecas que acceden al WriteConcern del Manager para incluirlo en sus propios - comandos de escritura deberían utilizar este método para asegurarse de que los WriteConcern por omisión - no están definidos. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si es el WriteConcern por omisión y &false; en caso contrario. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo de <function>MongoDB\Driver\WriteConcern::isDefault</function> - -isDefault()); - -$manager = new MongoDB\Driver\Manager('mongodb://127.0.0.1/?w=majority'); -$wc = $manager->getWriteConcern(); -var_dump($wc->isDefault()); - -$manager = new MongoDB\Driver\Manager('mongodb://127.0.0.1/'); -$wc = $manager->getWriteConcern(); -var_dump($wc->isDefault()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Manager::getWriteConcern - Modificar el Write Concern por omisión en el manual de MongoDB - Referencia de Write Concern - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeconcernerror.xml b/reference/mongodb/mongodb/driver/writeconcernerror.xml deleted file mode 100644 index 14841b3d1b..0000000000 --- a/reference/mongodb/mongodb/driver/writeconcernerror.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - - - La clase MongoDB\Driver\WriteConcernError - MongoDB\Driver\WriteConcernError - - - - -
    - &reftitle.intro; - - La clase MongoDB\Driver\WriteConcernError - contiene información relativa a un error de escritura y puede ser devuelta por - MongoDB\Driver\WriteResult::getWriteConcernError. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\WriteConcernError - - - - final - - MongoDB\Driver\WriteConcernError - - - - - &Properties; - - public - readonly - string - message - - - public - readonly - int - code - - - public - readonly - objectnull - info - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - message - - El mensaje de error. - - - - code - - El código de error. - - - - info - - - El documento de información adicional sobre el error, o &null; si no está disponible. - - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Las propiedades public readonly han sido añadidas. - - - - - -
    - -
    - - &reference.mongodb.mongodb.driver.entities.writeconcernerror; - -
    - - diff --git a/reference/mongodb/mongodb/driver/writeconcernerror/getcode.xml b/reference/mongodb/mongodb/driver/writeconcernerror/getcode.xml deleted file mode 100644 index 71472f4c1e..0000000000 --- a/reference/mongodb/mongodb/driver/writeconcernerror/getcode.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - MongoDB\Driver\WriteConcernError::getCode - Devuelve el código de error de WriteConcernError - - - - &reftitle.description; - - final public intMongoDB\Driver\WriteConcernError::getCode - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el código de error de WriteConcernError - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\Driver\WriteConcernError::getCode</function> - -insert(['x' => 1]); - -$writeConcern = new MongoDB\Driver\WriteConcern(2, 1); - -try { - $manager->executeBulkWrite('db.collection', $bulk, ['writeConcern' => $writeConcern]); -} catch(MongoDB\Driver\Exception\BulkWriteException $e) { - var_dump($e->getWriteResult()->getWriteConcernError()->getCode()); -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Referencia Write Concern - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeconcernerror/getinfo.xml b/reference/mongodb/mongodb/driver/writeconcernerror/getinfo.xml deleted file mode 100644 index f5ec7a94af..0000000000 --- a/reference/mongodb/mongodb/driver/writeconcernerror/getinfo.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - MongoDB\Driver\WriteConcernError::getInfo - Devuelve el documento de metadatos para WriteConcernError - - - - &reftitle.description; - - final public objectnullMongoDB\Driver\WriteConcernError::getInfo - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el documento de metadatos para WriteConcernError, o &null; - si no hay metadatos disponibles. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\Driver\WriteConcernError::getInfo</function> - -insert(['x' => 1]); - -$writeConcern = new MongoDB\Driver\WriteConcern(2, 1); - -try { - $manager->executeBulkWrite('db.collection', $bulk, ['writeConcern' => $writeConcern]); -} catch(MongoDB\Driver\Exception\BulkWriteException $e) { - var_dump($e->getWriteResult()->getWriteConcernError()->getInfo()); -} - -?> -]]> - - &example.outputs.similar; - - - bool(true) -} -]]> - - - - - - &reftitle.seealso; - - Referencia Write Concern - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeconcernerror/getmessage.xml b/reference/mongodb/mongodb/driver/writeconcernerror/getmessage.xml deleted file mode 100644 index a9815ea842..0000000000 --- a/reference/mongodb/mongodb/driver/writeconcernerror/getmessage.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - MongoDB\Driver\WriteConcernError::getMessage - Devuelve el mensaje de error del WriteConcernError - - - - &reftitle.description; - - final public stringMongoDB\Driver\WriteConcernError::getMessage - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el mensaje de error del WriteConcernError - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\Driver\WriteConcernError::getMessage</function> - -insert(['x' => 1]); - -$writeConcern = new MongoDB\Driver\WriteConcern(2, 1); - -try { - $manager->executeBulkWrite('db.collection', $bulk, ['writeConcern' => $writeConcern]); -} catch(MongoDB\Driver\Exception\BulkWriteException $e) { - var_dump($e->getWriteResult()->getWriteConcernError()->getMessage()); -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Referencia Write Concern - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeerror.xml b/reference/mongodb/mongodb/driver/writeerror.xml deleted file mode 100644 index 0e1d60839f..0000000000 --- a/reference/mongodb/mongodb/driver/writeerror.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - - - La clase MongoDB\Driver\WriteError - MongoDB\Driver\WriteError - - - - -
    - &reftitle.intro; - - La clase MongoDB\Driver\WriteError contiene - información sobre un error de escritura y puede ser devuelta como - elemento de un array a partir de MongoDB\Driver\WriteResult::getWriteErrors. - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\WriteError - - - - final - - MongoDB\Driver\WriteError - - - - - &Properties; - - public - readonly - string - message - - - public - readonly - int - code - - - public - readonly - int - index - - - public - readonly - objectnull - info - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - message - - El mensaje de error. - - - - code - - El código de error. - - - - index - - - El índice de la operación de escritura dentro del - MongoDB\Driver\BulkWrite que ha provocado el error. - - - - - info - - - El documento de información adicional sobre el error, o &null; si no está disponible. - - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Las propiedades public readonly han sido añadidas. - - - - - -
    - -
    - - &reference.mongodb.mongodb.driver.entities.writeerror; - -
    - - diff --git a/reference/mongodb/mongodb/driver/writeerror/getcode.xml b/reference/mongodb/mongodb/driver/writeerror/getcode.xml deleted file mode 100644 index e4d4007085..0000000000 --- a/reference/mongodb/mongodb/driver/writeerror/getcode.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - - MongoDB\Driver\WriteError::getCode - Devuelve el código de error de WriteError - - - - &reftitle.description; - - final public intMongoDB\Driver\WriteError::getCode - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el código de error de WriteError - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\Driver\WriteError::getCode</function> - -insert(['_id' => 1]); -$bulk->insert(['_id' => 1]); - -try { - $manager->executeBulkWrite('db.collection', $bulk); -} catch(MongoDB\Driver\Exception\BulkWriteException $e) { - var_dump($e->getWriteResult()->getWriteErrors()[0]->getCode()); -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeerror/getindex.xml b/reference/mongodb/mongodb/driver/writeerror/getindex.xml deleted file mode 100644 index 6d173a6151..0000000000 --- a/reference/mongodb/mongodb/driver/writeerror/getindex.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - - MongoDB\Driver\WriteError::getIndex - Devuelve el índice de la operación de escritura correspondiente a este WriteError - - - - &reftitle.description; - - final public intMongoDB\Driver\WriteError::getIndex - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el índice de la operación de escritura (a partir de - MongoDBDriverBulkWrite) correspondiente a este WriteError. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\Driver\WriteError::getIndex</function> - -insert(['_id' => 1]); -$bulk->insert(['_id' => 1]); - -try { - $manager->executeBulkWrite('db.collection', $bulk); -} catch(MongoDB\Driver\Exception\BulkWriteException $e) { - var_dump($e->getWriteResult()->getWriteErrors()[0]->getIndex()); -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\BulkWrite - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeerror/getinfo.xml b/reference/mongodb/mongodb/driver/writeerror/getinfo.xml deleted file mode 100644 index 18ca2e0b01..0000000000 --- a/reference/mongodb/mongodb/driver/writeerror/getinfo.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - - MongoDB\Driver\WriteError::getInfo - Devuelve el documento de metadatos para WriteError - - - - &reftitle.description; - - final public objectnullMongoDB\Driver\WriteError::getInfo - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el documento de metadatos para WriteError, o &null; si - no hay metadatos disponibles. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeerror/getmessage.xml b/reference/mongodb/mongodb/driver/writeerror/getmessage.xml deleted file mode 100644 index 33687183a5..0000000000 --- a/reference/mongodb/mongodb/driver/writeerror/getmessage.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - - MongoDB\Driver\WriteError::getMessage - Devuelve el mensaje de error del WriteError - - - - &reftitle.description; - - final public stringMongoDB\Driver\WriteError::getMessage - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el mensaje de error del WriteError. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\Driver\WriteError::getMessage</function> - -insert(['_id' => 1]); -$bulk->insert(['_id' => 1]); - -try { - $manager->executeBulkWrite('db.collection', $bulk); -} catch(MongoDB\Driver\Exception\BulkWriteException $e) { - var_dump($e->getWriteResult()->getWriteErrors()[0]->getMessage()); -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeresult.xml b/reference/mongodb/mongodb/driver/writeresult.xml deleted file mode 100644 index 53c5f12159..0000000000 --- a/reference/mongodb/mongodb/driver/writeresult.xml +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - - - La clase MongoDB\Driver\WriteResult - MongoDB\Driver\WriteResult - - - - -
    - &reftitle.intro; - - La clase MongoDB\Driver\WriteResult contiene las - informaciones sobre una ejecución MongoDB\Driver\BulkWrite - y puede ser retornado por - MongoDB\Driver\Manager::executeBulkWrite. - - -
    - - -
    - &reftitle.classsynopsis; - - - - MongoDB\Driver\WriteResult - - - - final - - MongoDB\Driver\WriteResult - - - - - &Properties; - - public - readonly - intnull - insertedCount - - - public - readonly - intnull - matchedCount - - - public - readonly - intnull - modifiedCount - - - public - readonly - intnull - deletedCount - - - public - readonly - intnull - upsertedCount - - - public - readonly - MongoDB\Driver\Server - server - - - public - readonly - array - upsertedIds - - - public - readonly - array - writeErrors - - - public - readonly - MongoDB\Driver\WriteConcernErrornull - writeConcernError - - - public - readonly - MongoDB\Driver\WriteConcernnull - writeConcern - - - public - readonly - array - errorReplies - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - insertedCount - - - El número de documentos insertados (excluyendo los upserts), o &null; si - el write concern no ha solicitado acuse de recibo. - - - - - matchedCount - - - El número de documentos coincidentes con las operaciones de actualización y reemplazo, o - &null; si el write concern no ha solicitado acuse de recibo. - - - - - modifiedCount - - - El número de documentos modificados por las operaciones de actualización y reemplazo, o - &null; si el write concern no ha solicitado acuse de recibo o si el - servidor no ha proporcionado esta información. - - - - - deletedCount - - - El número de documentos eliminados, o &null; si el write concern - no ha solicitado acuse de recibo. - - - - - upsertedCount - - - El número de documentos upserted, o &null; si el write concern - no ha solicitado acuse de recibo. - - - - - server - - - El servidor que ha ejecutado el bulk write. - - - - - upsertedIds - - - Un array de valores _id para los documentos upserted. - Las claves del array corresponden al índice de la operación de escritura de - MongoDB\Driver\BulkWrite. - - - - - writeErrors - - - Un array de MongoDB\Driver\WriteError para - los errores de escritura producidos durante la ejecución. - - - - - writeConcernError - - - El MongoDB\Driver\WriteConcernError que - ha ocurrido, o &null; si no ha ocurrido ningún error de write concern. - - - - - writeConcern - - - El MongoDB\Driver\WriteConcern utilizado para - el bulk write, o &null; si no está disponible. - - - - - errorReplies - - - Un array de documentos de respuesta de error procedentes del servidor. - - - - -
    - - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL mongodb 2.3.0 - - Las propiedades public readonly han sido añadidas. - - - - - -
    - -
    - - &reference.mongodb.mongodb.driver.entities.writeresult; - -
    - - diff --git a/reference/mongodb/mongodb/driver/writeresult/getdeletedcount.xml b/reference/mongodb/mongodb/driver/writeresult/getdeletedcount.xml deleted file mode 100644 index fd12fdf92a..0000000000 --- a/reference/mongodb/mongodb/driver/writeresult/getdeletedcount.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - - MongoDB\Driver\WriteResult::getDeletedCount - Devuelve el número de documentos eliminados - - - - &reftitle.description; - - final public intMongoDB\Driver\WriteResult::getDeletedCount - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el número de documentos eliminados. - - - - - &reftitle.errors; - - &mongodb.throws.unacknowledged; - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.throw-unacknowledged-write; - - - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\Driver\WriteResult::getDeletedCount</function> - -insert(['x' => 1]); -$bulk->update(['x' => 1], ['$set' => ['y' => 3]]); -$bulk->update(['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->update(['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->delete(['x' => 1]); - -$result = $manager->executeBulkWrite('db.collection', $bulk); - -var_dump($result->getDeletedCount()); - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeresult/getinsertedcount.xml b/reference/mongodb/mongodb/driver/writeresult/getinsertedcount.xml deleted file mode 100644 index 719ad6af48..0000000000 --- a/reference/mongodb/mongodb/driver/writeresult/getinsertedcount.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - - MongoDB\Driver\WriteResult::getInsertedCount - Devuelve el número de documentos insertados (excepto Upserts) - - - - &reftitle.description; - - final public intMongoDB\Driver\WriteResult::getInsertedCount - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el número de documentos insertados (excepto Upserts permitidos). - - - - - &reftitle.errors; - - &mongodb.throws.unacknowledged; - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.throw-unacknowledged-write; - - - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\Driver\WriteResult::getInsertedCount</function> - -insert(['x' => 1]); -$bulk->update(['x' => 1], ['$set' => ['y' => 3]]); -$bulk->update(['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->update(['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->delete(['x' => 1]); - -$result = $manager->executeBulkWrite('db.collection', $bulk); - -var_dump($result->getInsertedCount()); - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeresult/getmatchedcount.xml b/reference/mongodb/mongodb/driver/writeresult/getmatchedcount.xml deleted file mode 100644 index 58873a289b..0000000000 --- a/reference/mongodb/mongodb/driver/writeresult/getmatchedcount.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - MongoDB\Driver\WriteResult::getMatchedCount - Devuelve el número de documentos seleccionados para la actualización - - - - &reftitle.description; - - final public intMongoDB\Driver\WriteResult::getMatchedCount - - - - Si la operación de actualización no resulta en ninguna modificación del documento - (por ejemplo, al establecer el valor de un campo en su valor actual), - el número correspondiente puede ser mayor que el valor devuelto por - MongoDB\Driver\WriteResult::getModifiedCount. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el número de documentos seleccionados para la actualización. - - - - - &reftitle.errors; - - &mongodb.throws.unacknowledged; - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.throw-unacknowledged-write; - - - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\Driver\WriteResult::getMatchedCount</function> - -insert(['x' => 1]); -$bulk->update(['x' => 1], ['$set' => ['y' => 3]]); -$bulk->update(['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->update(['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->delete(['x' => 1]); - -$result = $manager->executeBulkWrite('db.collection', $bulk); - -var_dump($result->getMatchedCount()); - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteResult::getModifiedCount - MongoDB\Driver\WriteResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeresult/getmodifiedcount.xml b/reference/mongodb/mongodb/driver/writeresult/getmodifiedcount.xml deleted file mode 100644 index cc36ee18a3..0000000000 --- a/reference/mongodb/mongodb/driver/writeresult/getmodifiedcount.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - MongoDB\Driver\WriteResult::getModifiedCount - Devuelve el número de documentos existentes actualizados - - - - &reftitle.description; - - final public intMongoDB\Driver\WriteResult::getModifiedCount - - - - Si la operación de actualización no resulta en ninguna modificación del documento - (por ejemplo, al establecer el valor de un campo en su valor actual), - el número modificado puede ser inferior al valor devuelto por - MongoDB\Driver\WriteResult::getMatchedCount. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el número de documentos existentes actualizados. - - - - - &reftitle.errors; - - &mongodb.throws.unacknowledged; - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.throw-unacknowledged-write; - - - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\Driver\WriteResult::getModifiedCount</function> - -insert(['x' => 1]); -$bulk->update(['x' => 1], ['$set' => ['y' => 3]]); -$bulk->update(['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->update(['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->delete(['x' => 1]); - -$result = $manager->executeBulkWrite('db.collection', $bulk); - -var_dump($result->getModifiedCount()); - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteResult::getMatchedCount - MongoDB\Driver\WriteResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeresult/getserver.xml b/reference/mongodb/mongodb/driver/writeresult/getserver.xml deleted file mode 100644 index ebbc32f7a3..0000000000 --- a/reference/mongodb/mongodb/driver/writeresult/getserver.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - - MongoDB\Driver\WriteResult::getServer - Devuelve el servidor asociado a este resultado de escritura - - - - &reftitle.description; - - final public MongoDB\Driver\ServerMongoDB\Driver\WriteResult::getServer - - - - Devuelve el MongoDB\Driver\Server asociado a este resultado de escritura. Se trata del servidor que ejecutó el MongoDB\Driver\BulkWrite. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el MongoDB\Driver\Server asociado a este resultado de escritura. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\Driver\WriteResult::getServer</function> - -selectServer(); - -$bulk = new MongoDB\Driver\BulkWrite; -$bulk->insert(['x' => 1]); - -$result = $server->executeBulkWrite('db.collection', $bulk); - -var_dump($result->getServer() == $server); - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\Server - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeresult/getupsertedcount.xml b/reference/mongodb/mongodb/driver/writeresult/getupsertedcount.xml deleted file mode 100644 index 0d38d0d4f0..0000000000 --- a/reference/mongodb/mongodb/driver/writeresult/getupsertedcount.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - - MongoDB\Driver\WriteResult::getUpsertedCount - Devuelve el número de documentos insertados por un upsert - - - - &reftitle.description; - - final public intMongoDB\Driver\WriteResult::getUpsertedCount - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el número de documentos insertados por un upsert. - - - - - &reftitle.errors; - - &mongodb.throws.unacknowledged; - &mongodb.throws.argumentparsing; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &mongodb.changelog.throw-unacknowledged-write; - - - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\Driver\WriteResult::getUpsertedCount</function> - -insert(['x' => 1]); -$bulk->update(['x' => 1], ['$set' => ['y' => 3]]); -$bulk->update(['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->update(['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->delete(['x' => 1]); - -$result = $manager->executeBulkWrite('db.collection', $bulk); - -var_dump($result->getUpsertedCount()); - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteResult::getUpsertedIds - MongoDB\Driver\WriteResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeresult/getupsertedids.xml b/reference/mongodb/mongodb/driver/writeresult/getupsertedids.xml deleted file mode 100644 index c925d3153d..0000000000 --- a/reference/mongodb/mongodb/driver/writeresult/getupsertedids.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - - MongoDB\Driver\WriteResult::getUpsertedIds - Devuelve un array de identificadores para los documentos upserted - - - - &reftitle.description; - - final public arrayMongoDB\Driver\WriteResult::getUpsertedIds - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un array de identificadores (por ejemplo, el valor del campo "_id") para los documentos upserted. Las claves del array corresponden al índice de la operación de escritura (desde MongoDBDriverBulkWrite) responsable del upsert. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\Driver\WriteResult::getUpsertedIds</function> - -insert(['x' => 1]); -$bulk->update(['x' => 1], ['$set' => ['y' => 3]]); -$bulk->update(['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]); -$bulk->update(['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]); -$bulk->delete(['x' => 1]); - -$result = $manager->executeBulkWrite('db.collection', $bulk); - -var_dump($result->getUpsertedIds()); - -?> -]]> - - &example.outputs.similar; - - - object(MongoDB\BSON\ObjectId)#4 (1) { - ["oid"]=> - string(24) "580e62a224f2302f191b880b" - } - [3]=> - object(MongoDB\BSON\ObjectId)#5 (1) { - ["oid"]=> - string(24) "580e62a224f2302f191b880c" - } -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteResult::getUpsertedCount - MongoDB\Driver\WriteResult::isAcknowledged - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeresult/getwriteconcernerror.xml b/reference/mongodb/mongodb/driver/writeresult/getwriteconcernerror.xml deleted file mode 100644 index 0d590fe277..0000000000 --- a/reference/mongodb/mongodb/driver/writeresult/getwriteconcernerror.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - MongoDB\Driver\WriteResult::getWriteConcernError - Devuelve cualquier error de WriteConcern que haya ocurrido - - - - &reftitle.description; - - final public MongoDB\Driver\WriteConcernErrornullMongoDB\Driver\WriteResult::getWriteConcernError - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un MongoDBDriverWriteConcernError si se encontró un error de preocupación de escritura durante la operación de escritura, y &null; en caso contrario. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - Ejemplo con <function>MongoDB\Driver\WriteResult::getWriteConcernError</function> - -insert(['x' => 1]); - -$writeConcern = new MongoDB\Driver\WriteConcern(2, 1); - -try { - $manager->executeBulkWrite('db.collection', $bulk, ['writeConcern' => $writeConcern]); -} catch(MongoDB\Driver\Exception\BulkWriteException $e) { - var_dump($e->getWriteResult()->getWriteConcernError()); -} - -?> -]]> - - &example.outputs.similar; - - - string(33) "waiting for replication timed out" - ["code"]=> - int(64) - ["info"]=> - object(stdClass)#7 (1) { - ["wtimeout"]=> - bool(true) - } -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteConcern - Referencia Write Concern - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeresult/getwriteerrors.xml b/reference/mongodb/mongodb/driver/writeresult/getwriteerrors.xml deleted file mode 100644 index 98c4570060..0000000000 --- a/reference/mongodb/mongodb/driver/writeresult/getwriteerrors.xml +++ /dev/null @@ -1,182 +0,0 @@ - - - - - - - - MongoDB\Driver\WriteResult::getWriteErrors - Devuelve todos los errores de escritura que se han producido - - - - &reftitle.description; - - final public arrayMongoDB\Driver\WriteResult::getWriteErrors - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un array de objetos MongoDBDriverWriteError - para todos los errores de escritura encontrados durante la operación - de escritura. El array estará vacío si no se ha producido ningún error de escritura. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - <function>MongoDB\Driver\WriteResult::getWriteErrors</function> con un solo error - -insert(['_id' => 1]); -$bulk->insert(['_id' => 2]); -$bulk->insert(['_id' => 2]); -$bulk->insert(['_id' => 3]); -$bulk->insert(['_id' => 4]); -$bulk->insert(['_id' => 4]); - -try { - $result = $manager->executeBulkWrite('db.collection', $bulk); -} catch (MongoDB\Driver\Exception\BulkWriteException $e) { - var_dump($e->getWriteResult()->getWriteErrors()); -} - -?> -]]> - - &example.outputs.similar; - - - object(MongoDB\Driver\WriteError)#5 (4) { - ["message"]=> - string(81) "E11000 duplicate key error collection: db.collection index: _id_ dup key: { : 2 }" - ["code"]=> - int(11000) - ["index"]=> - int(2) - ["info"]=> - NULL - } -} -]]> - - - - <function>MongoDB\Driver\WriteResult::getWriteErrors</function> con múltiples errores - - false]); -$bulk->insert(['_id' => 1]); -$bulk->insert(['_id' => 2]); -$bulk->insert(['_id' => 2]); -$bulk->insert(['_id' => 3]); -$bulk->insert(['_id' => 4]); -$bulk->insert(['_id' => 4]); - -try { - $result = $manager->executeBulkWrite('db.collection', $bulk); -} catch (MongoDB\Driver\Exception\BulkWriteException $e) { - var_dump($e->getWriteResult()->getWriteErrors()); -} - -?> -]]> - - &example.outputs.similar; - - - object(MongoDB\Driver\WriteError)#5 (4) { - ["message"]=> - string(81) "E11000 duplicate key error collection: db.collection index: _id_ dup key: { : 2 }" - ["code"]=> - int(11000) - ["index"]=> - int(2) - ["info"]=> - NULL - } - [1]=> - object(MongoDB\Driver\WriteError)#6 (4) { - ["message"]=> - string(81) "E11000 duplicate key error collection: db.collection index: _id_ dup key: { : 4 }" - ["code"]=> - int(11000) - ["index"]=> - int(5) - ["info"]=> - NULL - } -} -]]> - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteError - - - - - - diff --git a/reference/mongodb/mongodb/driver/writeresult/isacknowledged.xml b/reference/mongodb/mongodb/driver/writeresult/isacknowledged.xml deleted file mode 100644 index 977a4d126f..0000000000 --- a/reference/mongodb/mongodb/driver/writeresult/isacknowledged.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - - MongoDB\Driver\WriteResult::isAcknowledged - Indica si la escritura ha sido reconocida - - - - &reftitle.description; - - final public boolMongoDB\Driver\WriteResult::isAcknowledged - - - - Si la escritura ha sido reconocida, otros campos de conteo estarán disponibles - para el objeto MongoDB\Driver\WriteResult. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si la escritura ha sido reconocida, y &false; en caso contrario. - - - - - &reftitle.errors; - - &mongodb.throws.argumentparsing; - - - - - &reftitle.examples; - - <function>MongoDB\Driver\WriteResult::isAcknowledged</function> con la preocupación de escritura reconocida - -insert(['x' => 1]); - -$result = $manager->executeBulkWrite('db.collection', $bulk); - -var_dump($result->isAcknowledged()); - -?> -]]> - - &example.outputs; - - - - - - <function>MongoDB\Driver\WriteResult::isAcknowledged</function> con la preocupación de escritura no reconocida - -insert(['x' => 1]); - -$writeConcern = new MongoDB\Driver\WriteConcern(0); - -$result = $manager->executeBulkWrite('db.collection', $bulk, ['writeConcern' => $writeConcern]); - -var_dump($result->isAcknowledged()); - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - MongoDB\Driver\WriteConcern - Referencia sobre la Preocupación de Escritura - - - - - - diff --git a/reference/mongodb/monitoring.xml b/reference/mongodb/monitoring.xml deleted file mode 100644 index 6412f19a2e..0000000000 --- a/reference/mongodb/monitoring.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - Monitorización de clases y funciones de suscriptor - MongoDB\Driver\Monitoring - - - &Functions; - &reference.mongodb.functions.driver.entities.monitoring; - - - &reference.mongodb.mongodb.driver.monitoring.commandfailedevent; - &reference.mongodb.mongodb.driver.monitoring.commandstartedevent; - &reference.mongodb.mongodb.driver.monitoring.commandsucceededevent; - - &reference.mongodb.mongodb.driver.monitoring.serverchangedevent; - &reference.mongodb.mongodb.driver.monitoring.serverclosedevent; - &reference.mongodb.mongodb.driver.monitoring.serveropeningevent; - &reference.mongodb.mongodb.driver.monitoring.serverheartbeatfailedevent; - &reference.mongodb.mongodb.driver.monitoring.serverheartbeatstartedevent; - &reference.mongodb.mongodb.driver.monitoring.serverheartbeatsucceededevent; - &reference.mongodb.mongodb.driver.monitoring.topologychangedevent; - &reference.mongodb.mongodb.driver.monitoring.topologyclosedevent; - &reference.mongodb.mongodb.driver.monitoring.topologyopeningevent; - - &reference.mongodb.mongodb.driver.monitoring.commandsubscriber; - &reference.mongodb.mongodb.driver.monitoring.sdamsubscriber; - &reference.mongodb.mongodb.driver.monitoring.subscriber; - diff --git a/reference/mongodb/security.xml b/reference/mongodb/security.xml deleted file mode 100644 index b6a7786fd0..0000000000 --- a/reference/mongodb/security.xml +++ /dev/null @@ -1,181 +0,0 @@ - - - - Seguridad - -
    - Ataques por inyección de peticiones - - Si está pasando parámetros de $_GET (o $_POST) - a sus consultas, asegúrese de que primero se conviertan a strings. Los usuarios - pueden insertar arrays asociativos en peticiones GET y POST, lo que podría - convertirse en consultas no deseadas con operadores $-. - - - - Un ejemplo bastante inocuo: supongamos que está buscando la información de un - usuario con la petición http://www.example.com?username=bob. - Su aplicación crea la consulta - $q = new \MongoDB\Driver\Query( [ 'username' => $_GET['username'] ]). - - - - Alguien podría subvertir esto mediante - http://www.example.com?username[$ne]=foo, que PHP - convertirá mágicamente en un array asociativo, convirtiendo su consulta en - $q = new \MongoDB\Driver\Query( [ 'username' => [ '$ne' => 'foo' ] ] ), - lo que devolverá todos los usuarios que no se llamen "foo" (probablemente todos sus usuarios). - - - - Este es un ataque bastante fácil de defender: asegúrese de que los parámetros - de $_GET y $_POST sean del tipo que espera antes de enviarlos a la base de datos. - PHP tiene la función filter_var para ayudar con esto. - - - - Tenga en cuenta que este tipo de ataque puede usarse con cualquier interacción - con la base de datos que localice un documento, incluyendo actualizaciones, - upserts, eliminaciones y comandos findAndModify. - - - - Consulte la documentación principal - para obtener más información sobre problemas similares a la inyección SQL con MongoDB. - -
    - -
    - Ataques por inyección de scripts - - Si está usando JavaScript, asegúrese de que cualquier variable que cruce el - límite entre PHP y JavaScript se pase en el campo scope - de MongoDB\BSON\Javascript, no interpolada en la cadena - de JavaScript. Esto puede ocurrir al usar cláusulas $where - en consultas, comandos mapReduce y group, y cualquier otro momento en que pase - JavaScript a la base de datos. - - - Por ejemplo, supongamos que tenemos algo de JavaScript para saludar a un usuario - en los registros de la base de datos. Podríamos hacer: - - - "print('Hola, $username!');" -] ); - -$r = $m->executeCommand( 'dramio', $cmd ); -?> -]]> - - - Sin embargo, ¿qué pasaría si un usuario malicioso pasa algo de JavaScript? - - - "print('Hola, $username!');" -] ); - -$r = $m->executeCommand( 'dramio', $cmd ); -?> -]]> - - - Ahora MongoDB ejecuta la cadena de JavaScript - "print('Hola, '); db.users.drop(); print('!');". - Este ataque es fácil de evitar: use args para pasar - variables de PHP a JavaScript: - - - "function greet(username) { print('Hola, ' + username + '!'); }", - 'args' => $args, -] ); - -$r = $m->executeCommand( 'dramio', $cmd ); -?> -]]> - - - Esto añade un argumento al ámbito de JavaScript, que se usa como argumento - para la función greet. Ahora si alguien intenta enviar - código malicioso, MongoDB imprimirá inocuamente - Hola, '); db.dropDatabase(); print('!. - - - - Usar argumentos ayuda a prevenir que la entrada maliciosa se ejecute en la - base de datos. Sin embargo, debe asegurarse de que su código no vuelva a - ejecutar la entrada de todos modos. Lo mejor es evitar ejecutar - cualquier JavaScript en el servidor desde el principio. - - - - Se recomienda encarecidamente evitar el uso de la cláusula $where - en consultas, ya que afecta significativamente al rendimiento. Siempre que sea - posible, use operadores de consulta normales o el Marco de - Agregación. - - - - Como alternativa al MapReduce, que usa - JavaScript, considere usar el Marco de - Agregación. A diferencia de Map/Reduce, usa un lenguaje idiomático - para construir consultas, sin tener que escribir y usar el enfoque más lento - de JavaScript que requiere Map/Reduce. - - - - El comando eval ha sido - deprecado desde MongoDB 3.0 y también debe evitarse. - -
    -
    - - diff --git a/reference/mongodb/setup.xml b/reference/mongodb/setup.xml deleted file mode 100644 index 44241cb2b5..0000000000 --- a/reference/mongodb/setup.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - A partir de la versión 1.21.0, la extensión requiere PHP 8.1 o superior. Las - versiones anteriores de la extensión permiten la compatibilidad con versiones - más antiguas de PHP. - - - La extensión requiere - libbson y - libmongoc, y usará por - omisión las versiones incluidas de ambas bibliotecas. También se pueden usar - bibliotecas del sistema, como se explica en la documentación de - instalación manual. - - - La extensión, a través de libmongoc, depende opcionalmente de una biblioteca - TLS (por ejemplo, OpenSSL) y la usará si está disponible. Si el proceso de - compilación no logra encontrar una biblioteca TLS, los usuarios deben - verificar que el paquete de desarrollo apropiado (por ejemplo, - libssl-dev) y - pkg-config estén - instalados. El proceso para detectar y configurar bibliotecas TLS se explica - con más detalle en la documentación de - instalación manual. - - - Cyrus SASL es una dependencia opcional - para admitir la autenticación Kerberos y se usará si está disponible. - - - - Debido a posibles problemas para representar enteros de 64 bits en plataformas - de 32 bits, se recomienda a los usuarios emplear entornos de 64 bits. Al usar - una plataforma de 32 bits, tenga en cuenta que cualquier entero de 64 bits - leído desde la base de datos se devolverá como una instancia de - MongoDB\BSON\Int64 en lugar de un tipo entero de PHP. - - -
    - - &reference.mongodb.configure; - &reference.mongodb.ini; - - -
    - - diff --git a/reference/mongodb/tutorial.xml b/reference/mongodb/tutorial.xml deleted file mode 100644 index 651ce9fe14..0000000000 --- a/reference/mongodb/tutorial.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - Tutoriales - Tutoriales - - - - - En esta sección encontrará varios tutoriales sobre cómo utilizar el controlador - de MongoDB para PHP. - - - - - &reference.mongodb.tutorial.library; - &reference.mongodb.tutorial.apm; - - - diff --git a/reference/mongodb/tutorial/apm.xml b/reference/mongodb/tutorial/apm.xml deleted file mode 100644 index 7c37d3dce9..0000000000 --- a/reference/mongodb/tutorial/apm.xml +++ /dev/null @@ -1,208 +0,0 @@ - - - -
    - Monitoreo del rendimiento de la aplicación (Application Performance Monitoring - APM) - - - La extensión contiene una API de observaciones de eventos, que permite a las aplicaciones - monitorear las órdenes y las actividades internas relacionadas con la - Especificación de descubrimiento y monitoreo del servidor. - Este tutorial demostrará el monitoreo de las órdenes utilizando la interfaz - MongoDB\Driver\Monitoring\CommandSubscriber. - - - - La interfaz - MongoDB\Driver\Monitoring\CommandSubscriber - define tres métodos: commandStarted, - commandSucceeded, y commandFailed. - Cada uno de estos tres métodos acepta un solo argumento event - de una clase específica para el evento respectivo. Por ejemplo, el argumento - event de commandSucceeded - es un objeto MongoDB\Driver\Monitoring\CommandSucceededEvent. - - - - En este tutorial, se implementará un observador que crea una lista de todos - los perfiles de solicitud y el tiempo promedio que han tomado. - - -
    - Estructura de las clases de observaciones - - - Se comienza con el marco del observador: - - - - -]]> - -
    - -
    - Registro del observador - - - Una vez que un objeto observador es instanciado, debe ser registrado con el - sistema de monitoreo de la extensión. Esto se hace llamando a - MongoDB\Driver\Monitoring\addSubscriber o - MongoDB\Driver\Manager::addSubscriber para registrar - el observador globalmente o con un Manager específico, respectivamente. - - - - -]]> - -
    - -
    - Implementar la lógica - - - Con el objeto registrado, la única cosa que queda es implementar la lógica - en la clase observadora. Para correlacionar los dos eventos que componen una - orden ejecutada con éxito (commandStarted y commandSucceeded), cada - objeto de evento expone un campo requestId. - - - Para registrar el tiempo promedio por forma de solicitud, se comenzará verificando - una orden find en el evento commandStarted. Luego, se añadirá un elemento a la propiedad pendingCommands indexado por su - requestId y con su valor representando la forma de solicitud. - - - Si se recibe un evento commandSucceeded correspondiente con el mismo - requestId, se añade la duración del evento (desde - durationMicros) al tiempo total e incrementa el - contador de operaciones. - - - Si se encuentra un evento commandFailed correspondiente, simplemente se elimina - la entrada de la propiedad pendingCommands. - - - -getCommandName() ) - { - $queryShape = $this->createQueryShape( (array) $event->getCommand()->filter ); - $this->pendingCommands[$event->getRequestId()] = $queryShape; - } - } - - public function commandSucceeded( \MongoDB\Driver\Monitoring\CommandSucceededEvent $event ): void - { - $requestId = $event->getRequestId(); - if ( array_key_exists( $requestId, $this->pendingCommands ) ) - { - $this->queryShapeStats[$this->pendingCommands[$requestId]]['count']++; - $this->queryShapeStats[$this->pendingCommands[$requestId]]['duration'] += $event->getDurationMicros(); - unset( $this->pendingCommands[$requestId] ); - } - } - - public function commandFailed( \MongoDB\Driver\Monitoring\CommandFailedEvent $event ): void - { - if ( array_key_exists( $event->getRequestId(), $this->pendingCommands ) ) - { - unset( $this->pendingCommands[$event->getRequestId()] ); - } - } - - public function __destruct() - { - foreach( $this->queryShapeStats as $shape => $stats ) - { - echo "Shape: ", $shape, " (", $stats['count'], ")\n ", - $stats['duration'] / $stats['count'], "µs\n\n"; - } - } -} - -$m = new \MongoDB\Driver\Manager( 'mongodb://localhost:27016' ); - -/* Añadir el observador */ -\MongoDB\Driver\Monitoring\addSubscriber( new QueryTimeCollector() ); - -/* Realizar una serie de solicitudes */ -$query = new \MongoDB\Driver\Query( [ - 'region_slug' => 'scotland-highlands', 'age' => [ '$gte' => 20 ] -] ); -$cursor = $m->executeQuery( 'dramio.whisky', $query ); - -$query = new \MongoDB\Driver\Query( [ - 'region_slug' => 'scotland-lowlands', 'age' => [ '$gte' => 15 ] -] ); -$cursor = $m->executeQuery( 'dramio.whisky', $query ); - -$query = new \MongoDB\Driver\Query( [ 'region_slug' => 'scotland-lowlands' ] ); -$cursor = $m->executeQuery( 'dramio.whisky', $query ); - -?> -]]> - -
    - -
    - - diff --git a/reference/mongodb/tutorial/library.xml b/reference/mongodb/tutorial/library.xml deleted file mode 100644 index f0c8f32694..0000000000 --- a/reference/mongodb/tutorial/library.xml +++ /dev/null @@ -1,172 +0,0 @@ - - - -
    - Utilizar la biblioteca PHP para MongoDB (PHPLIB) - - - Después de la configuración inicial de la extensión, se continuará explicando cómo comenzar - con la biblioteca de usuario correspondiente para escribir nuestro primer proyecto. - - -
    - Instalar la biblioteca PHP con Composer - - - La última cosa que se debe instalar para comenzar la aplicación - en sí es la biblioteca PHP. - - - - La biblioteca debe ser instalada con - Composer, un gestor de - paquetes para PHP. Las instrucciones para instalar Composer en diferentes - plataformas pueden encontrarse en su sitio web. - - - - Instalar la biblioteca ejecutando: - - - - - - - Esto producirá una salida similar a: - - - - - - - - Composer creará varios ficheros: composer.json, - composer.lock, y un directorio vendor que - contendrá la biblioteca y todas las otras dependencias que su proyecto podría necesitar. - -
    - -
    - Utilizar la biblioteca PHP - - - Además de gestionar sus dependencias, Composer también le proporcionará un - autocargador (para las clases de estas dependencias). Asegúrese de que esté incluido al inicio de su script o en el código de arranque de - su aplicación: - - - - - - - Con esto hecho, ahora puede utilizar cualquier - funcionalidad como se describe en la - documentación de la biblioteca. - - - - Si ha utilizado controladores MongoDB en otros lenguajes, la API de la - biblioteca debería resultarle familiar. Contiene una clase - Client - para conectarse a MongoDB, una clase - Database - para las operaciones a nivel de la base de datos (por ejemplo, los comandos, la gestión de las colecciones), - y una clase - Collection - para las operaciones a nivel de la colección (por ejemplo, los métodos - CRUD, la gestión de los índices). - - - - Como ejemplo, aquí se muestra cómo insertar un documento en la colección - beers de la base de datos demo: - -demo->beers; - -$result = $collection->insertOne( [ 'name' => 'Hinterland', 'brewery' => 'BrewDog' ] ); - -echo "Inserted with Object ID '{$result->getInsertedId()}'"; -?> -]]> - - - - - Dado que el documento insertado no contenía un campo _id, la extensión - generará un MongoDB\BSON\ObjectId para que el servidor - lo utilice como _id. Este valor también está disponible para - el llamador a través del objeto de resultado devuelto por el método insertOne. - - - - Después de la inserción, se pueden consultar los datos que acaba de insertar. Para ello, se utiliza el método find, que devuelve un cursor - iterable: - -demo->beers; - -$result = $collection->find( [ 'name' => 'Hinterland', 'brewery' => 'BrewDog' ] ); - -foreach ($result as $entry) { - echo $entry['_id'], ': ', $entry['name'], "\n"; -} -?> -]]> - - - - - Aunque los ejemplos no lo muestran, los documentos BSON y los arrays - son deserializados como clases especiales en la biblioteca por defecto. Estas clases extienden ArrayObject para facilidad de uso - e implementan las interfaces MongoDB\BSON\Serializable - y MongoDB\BSON\Unserializable de la extensión para garantizar que los valores conserven su tipo cuando se serializan nuevamente en BSON. Esto evita un inconveniente de la antigua extensión mongo - donde los arrays podrían convertirse en documentos, y viceversa. Ver la - especificación para más información sobre - cómo se convierten los valores entre PHP y BSON. - -
    -
    - diff --git a/reference/mqseries/book.xml b/reference/mqseries/book.xml deleted file mode 100644 index 20c22f8214..0000000000 --- a/reference/mqseries/book.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - mqseries - - - - &reftitle.intro; - &warn.experimental; - - Esta extensión proporciona una interfaz de comunicación con los servidores de cola - de IBM WebSphere MQ. - - - La interfaz imita la API del cliente C de WebSphere MQ Series tanto como sea posible, - utilizando las mismas convenciones de nombres y funcionalidades. Para comprender - el funcionamiento de esta extensión, se requiere un conocimiento mínimo de la - interfaz C. - - - Para las opciones MQ, estructuras MQ, resultados MQ, etc., consulte la "Guía de - programación de aplicaciones WebSphere MQ" y la "Referencia de programación de - aplicaciones WebSphere MQ". - - - - - &reference.mqseries.setup; - &reference.mqseries.constants; - &reference.mqseries.reference; - - - diff --git a/reference/mqseries/configure.xml b/reference/mqseries/configure.xml deleted file mode 100644 index 0b14231f02..0000000000 --- a/reference/mqseries/configure.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; &url.pecl.package;mqseries. - - - - El nombre oficial de esta extensión es mqseries. - - - - Existen dos formas de conectarse al gestor de colas. Dependen de cómo se haya compilado la extensión. - - - - En primer lugar, y también por omisión, se encuentra la biblioteca mqic. Al compilar y enlazar la extensión con las bibliotecas IBM WebSphere MQSeries, es posible conectarse al gestor de colas mediante la interfaz cliente. Las conexiones remotas también son posibles de esta manera. - - - - - La otra forma es compilar y enlazar las bibliotecas mqm. Al utilizar estas bibliotecas, es posible emplear el gestor de transacciones del servidor de colas. - - - - - Actualmente, la selección de estas bibliotecas se realiza modificando el fichero config.m4. -
    - diff --git a/reference/mqseries/constants.xml b/reference/mqseries/constants.xml deleted file mode 100644 index f499eb0b9a..0000000000 --- a/reference/mqseries/constants.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - &reftitle.constants; - - Para cada constante WebSphere MQ, existe un equivalente en mqseries. - - Para las definiciones y el uso, consulte el - "WebSphere MQ Application Programming Guide" y "WebSphere MQ - Application Programming Reference red books". - - El nombre de las constantes mqseries se forma prefijando el nombre de la constante - WebSphere MQ con MQSERIES_, por ejemplo, las constantes - de CompletionCode son: - - - Constantes mqseries - - - - Constante PHP - Constante MQ - - - - - MQSERIES_MQCC_OK - MQCC_OK - - - MQSERIES_MQCC_WARNING - MQCC_WARNING - - - MQSERIES_MQCC_FAILED - MQCC_FAILED - - - MQSERIES_MQCC_UNKNOWN - MQCC_UNKNOWN - - - -
    - -
    - diff --git a/reference/mqseries/functions/mqseries-back.xml b/reference/mqseries/functions/mqseries-back.xml deleted file mode 100644 index 614f89384f..0000000000 --- a/reference/mqseries/functions/mqseries-back.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - - mqseries_back - MQSeries MQBACK - - - - &reftitle.description; - - voidmqseries_back - resourcehconn - resourcecompCode - resourcereason - - - mqseries_back indica al gestor de colas que - todos los mensajes leídos y escritos desde el último punto de sincronización - deben ser anulados. Los mensajes que forman parte de una unidad de trabajo - serán eliminados. Los mensajes leídos como unidad de trabajo serán reinsertados en - la cola. - - - El uso de - mqseries_back funciona asimismo en conjunción con - mqseries_begin y únicamente al conectarse - directamente al gestor de colas: no funciona a través de - la interfaz mqclient. - - - - - &reftitle.parameters; - - - - hConn - - - Gestor de conexión. - Este recurso representa la conexión al gestor de colas. - - - - - compCode - - - Código de finalización. - - - - - reason - - - La razón que califica el compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.examples; - - Ejemplo con <function>mqseries_back</function> - -\n", $comp_code, $reason, mqseries_strerror($reason)); - } -?> -]]> - - - - - - &reftitle.notes; - - - mqseries_back no funciona cuando un - cliente MQSeries Client se conecta al gestor de colas. - - - - - - &reftitle.seealso; - - mqseries_conn - mqseries_connx - mqseries_begin - - - - diff --git a/reference/mqseries/functions/mqseries-begin.xml b/reference/mqseries/functions/mqseries-begin.xml deleted file mode 100644 index a64b884a1b..0000000000 --- a/reference/mqseries/functions/mqseries-begin.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - - mqseries_begin - MQseries MQBEGIN - - - - &reftitle.description; - - voidmqseries_begin - resourcehconn - arraybeginOptions - resourcecompCode - resourcereason - - - mqseries_begin inicia una unidad de trabajo, coordinada - por el gestor de colas, e involucrando finalmente gestores de recursos externos. - - - Al utilizar - mqseries_begin se inicia una unidad de trabajo. - Finalmente, mqseries_back o mqseries_cmit - terminarán la unidad de trabajo. - - - - - &reftitle.parameters; - - - - hConn - - - Gestor de conexión. - Este recurso representa la conexión al gestor de colas. - - - - - compCode - - - Código de finalización. - - - - - reason - - - La razón que califica el compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.examples; - - Ejemplo con <function>mqseries_begin</function> - -\n", $comp_code, $reason, mqseries_strerror($reason)); - } - } -?> -]]> - - - - - - &reftitle.notes; - - - mqseries_begin no funciona cuando un - cliente MQSeries Client se conecta al gestor de colas. - - - - - - &reftitle.seealso; - - mqseries_conn - mqseries_connx - mqseries_back - mqseries_cmit - - - - diff --git a/reference/mqseries/functions/mqseries-close.xml b/reference/mqseries/functions/mqseries-close.xml deleted file mode 100644 index 8438a235f6..0000000000 --- a/reference/mqseries/functions/mqseries-close.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - mqseries_close - MQSeries MQCLOSE - - - - &reftitle.description; - - voidmqseries_close - resourcehconn - resourcehobj - intoptions - resourcecompCode - resourcereason - - - mqseries_close libera el acceso a un objeto y es la operación inversa - de la función mqseries_open. - - - - - &reftitle.parameters; - - - - hConn - - - Gestor de conexión. - Este recurso representa la conexión al gestor de colas. - - - - - hObj - - - Gestor de objeto. - Este recurso representa el objeto a utilizar. - - - - - options - - - - - - - - compCode - - - Código de finalización. - - - - - reason - - - La razón que califica el compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.examples; - - Ejemplo con <function>mqseries_close</function> - -\n", $comp_code, $reason, mqseries_strerror($reason)); - } -?> -]]> - - - - - - &reftitle.seealso; - - mqseries_open - mqseries_conn - mqseries_connx - - - - diff --git a/reference/mqseries/functions/mqseries-cmit.xml b/reference/mqseries/functions/mqseries-cmit.xml deleted file mode 100644 index f8cfd0b05d..0000000000 --- a/reference/mqseries/functions/mqseries-cmit.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - - mqseries_cmit - MQSeries MQCMIT - - - - &reftitle.description; - - voidmqseries_cmit - resourcehconn - resourcecompCode - resourcereason - - - mqseries_cmit indica al gestor de colas que la aplicación - ha alcanzado un punto de sincronización, y que todos los mensajes que han sido - leídos y escritos desde el último punto de sincronización han sido hechos permanentes. - Los mensajes colocados en la cola como unidad de trabajo son ahora - accesibles a otras aplicaciones. Los mensajes leídos como unidad de trabajo son - ahora destruidos. - - - - - &reftitle.parameters; - - - - hConn - - - Gestor de conexión. - Este recurso representa la conexión al gestor de colas. - - - - - compCode - - - Código de finalización. - - - - - reason - - - La razón que califica el compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.examples; - - Ejemplo con <function>mqseries_cmit</function> - -\n", $comp_code, $reason, mqseries_strerror($reason)); - } -?> -]]> - - - - - - &reftitle.notes; - - - mqseries_back no funciona cuando un - cliente MQSeries Client se conecta al gestor de colas. - - - - - - &reftitle.seealso; - - mqseries_begin - mqseries_back - mqseries_conn - mqseries_connx - - - - diff --git a/reference/mqseries/functions/mqseries-conn.xml b/reference/mqseries/functions/mqseries-conn.xml deleted file mode 100644 index 402d6b2e4e..0000000000 --- a/reference/mqseries/functions/mqseries-conn.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - mqseries_conn - MQSeries MQCONN - - - - &reftitle.description; - - voidmqseries_conn - stringqManagerName - resourcehconn - resourcecompCode - resourcereason - - - mqseries_conn establece la conexión con el gestor de colas. - Proporciona un recurso de conexión, que es utilizado por las demás funciones - de la extensión. - - - - - &reftitle.parameters; - - - - qManagerName - - - Nombre del gestor de colas. - Nombre del gestor de colas con el que la aplicación desea conectarse. - - - - - hConn - - - Gestor de conexión. - Este recurso representa la conexión al gestor de colas. - - - - - compCode - - - Código de finalización. - - - - - reason - - - La razón que califica el compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.examples; - - Ejemplo con <function>mqseries_conn</function> - -\n", $comp_code, $reason, mqseries_strerror($reason)); - exit; - } -?> -]]> - - - - - - &reftitle.seealso; - - mqseries_disc - - - - diff --git a/reference/mqseries/functions/mqseries-connx.xml b/reference/mqseries/functions/mqseries-connx.xml deleted file mode 100644 index 997d7445de..0000000000 --- a/reference/mqseries/functions/mqseries-connx.xml +++ /dev/null @@ -1,185 +0,0 @@ - - - - - - - mqseries_connx - MQSeries MQCONNX - - - - &reftitle.description; - - voidmqseries_connx - stringqManagerName - arrayconnOptions - resourcehconn - resourcecompCode - resourcereason - - - La llamada a - mqseries_connx - (MQCONNX) conecta un programa de aplicación a un gestor de colas. - Proporciona un descriptor de conexión del gestor de colas, - que es utilizado por la aplicación en llamadas MQ posteriores. - - - La llamada a mqseries_connx es como la llamada a - mqseries_conn (MQCONN), con la excepción de que MQCONNX - permite especificar opciones para controlar el funcionamiento de la llamada. - - - - - &reftitle.parameters; - - - - qManagerName - - - Nombre del gestor de colas. - Nombre del gestor de colas con el que la aplicación desea conectarse. - - - - - connOps - - - Opciones que controlan las acciones de la función - Véase también la estructura MQCNO. - - - - - - hConn - - - Gestor de conexión. - Este gestor representa la conexión al gestor de colas. - - - - - compCode - - - Código de finalización. - - - - - reason - - - La razón que califica el compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.examples; - - - - Ejemplo con <function>mqseries_connx</function> - - - MQSERIES_MQCNO_VERSION_2, - 'Options' => MQSERIES_MQCNO_STANDARD_BINDING, - 'MQCD' => array('ChannelName' => 'MQNX9420.CLIENT', - 'ConnectionName' => 'localhost', - 'TransportType' => MQSERIES_MQXPT_TCP) - ); - - mqseries_connx('MQNX9420', $mqcno, $conn, $comp_code,$reason); - if ($comp_code !== MQSERIES_MQCC_OK) { - printf("Connx CompCode:%d Reason:%d Text:%s
    \n", $comp_code, $reason, mqseries_strerror($reason)); - exit; - } - -?> -]]> -
    -
    - - - Ejemplo con <function>mqseries_connx</function> utilizando una - conexión SSL y una URL OCSP Responder - - - 4, //MQCNO_VERSION_4 - 'Options' => MQSERIES_MQCNO_STANDARD_BINDING, - 'MQCD' => array( - 'Version' => 7, //MQCD_VERSION_7 - 'ConnectionName' => 'localhost', - 'TransportType' => MQSERIES_MQXPT_TCP, - 'ChannelName' => 'CONNECTIONCHANNEL', - 'SSLCipherSpec' => 'NULL_SHA' - ), - 'MQSCO' => array( - 'KeyRepository' => '/var/mqm/qmgrs/QUEUEMGR/ssl/key', //Ruta local donde se puede encontrar la carpeta que contiene la clave SSL - 'MQAIR' => array( - 'Version' => 2, //MQAIR_VERSION_2 - 'AuthInfoType' => 2, //MQAIT_OCSP - 'OCSPResponderURL' => 'http://dummy.OCSP.responder' - ) - ) - ); - - mqseries_connx('QUEUEMGR', $mqcno, $conn, $comp_code,$reason); - if ($comp_code !== MQSERIES_MQCC_OK) { - printf("Connx CompCode:%d Reason:%d Text:%s
    \n", $comp_code, $reason, mqseries_strerror($reason)); - exit; - } - -?> -]]> -
    -
    -
    -
    - - - &reftitle.seealso; - - mqseries_disc - - -
    - diff --git a/reference/mqseries/functions/mqseries-disc.xml b/reference/mqseries/functions/mqseries-disc.xml deleted file mode 100644 index 07552cf01d..0000000000 --- a/reference/mqseries/functions/mqseries-disc.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - mqseries_disc - MQSeries MQDISC - - - - &reftitle.description; - - voidmqseries_disc - resourcehconn - resourcecompCode - resourcereason - - - mqseries_disc cierra la conexión entre el gestor de colas y la aplicación. Es lo opuesto a mqseries_conn y mqseries_connx. - - - - - &reftitle.parameters; - - - - hConn - - - Gestor de conexión. - Este recurso representa la conexión al gestor de colas. - - - - - compCode - - - Código de finalización. - - - - - reason - - - La razón que califica el compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.examples; - - Ejemplo con <function>mqseries_disc</function> - -\n", $comp_code, $reason, mqseries_strerror($reason)); - } -?> -]]> - - - - - - &reftitle.seealso; - - mqseries_conn - mqseries_connx - - - - diff --git a/reference/mqseries/functions/mqseries-get.xml b/reference/mqseries/functions/mqseries-get.xml deleted file mode 100644 index 16b2b76e10..0000000000 --- a/reference/mqseries/functions/mqseries-get.xml +++ /dev/null @@ -1,191 +0,0 @@ - - - - - - - mqseries_get - MQSeries MQGET - - - - &reftitle.description; - - voidmqseries_get - resourcehConn - resourcehObj - arraymd - arraygmo - intbufferLength - stringmsg - intdata_length - resourcecompCode - resourcereason - - - mqseries_get lee un mensaje de una cola local, - que ha sido abierta con la función mqseries_open. - - - - - &reftitle.parameters; - - - - hConn - - - Gestor de conexión. - Este recurso representa la conexión al gestor de colas. - - - - - hObj - - - Gestor de objeto. - Este recurso representa el objeto a utilizar. - - - - - md - - - Recurso de mensaje (MQMD). - - - - - gmo - - - Opciones de mensaje - - - - - bufferLength - - - Tamaño esperado del buffer de resultado - - - - - msg - - - - Buffer que contiene el mensaje leído desde el objeto. - - - - - - data_length - - - Tamaño real del buffer - - - - - compCode - - - Código de finalización. - - - - - reason - - - La razón que califica el compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.examples; - - Ejemplo con <function>mqseries_get</function> - - 'TESTQ'), - MQSERIES_MQOO_INPUT_AS_Q_DEF | MQSERIES_MQOO_FAIL_IF_QUIESCING | MQSERIES_MQOO_OUTPUT, - $obj, - $comp_code, - $reason); -// $obj contiene ahora la referencia al objeto (TESTQ) - -// Define un descriptor de mensaje vacío. - $mdg = array(); -// Define las opciones de recuperación de mensajes - $gmo = array('Options' => MQSERIES_MQGMO_FAIL_IF_QUIESCING | MQSERIES_MQGMO_WAIT, 'WaitInterval' => 3000); - -// Recupera los mensajes desde la cola - mqseries_get($conn, $obj, $mdg, $gmo, 255, $msg, $data_length, $comp_code, $reason); - if ($comp_code !== MQSERIES_MQCC_OK) { - printf("GET CompCode:%d Reason:%d Text:%s
    ", $comp_code, $reason, mqseries_strerror($reason)); - } - -// Cierra la referencia al objeto $obj - mqseries_close($conn, $obj, MQSERIES_MQCO_NONE, $comp_code, $reason); - -// Desconecta del gestor de colas - mqseries_disc($conn, $comp_code, $reason); - -?> -]]> -
    -
    -
    - - - &reftitle.seealso; - - mqseries_conn - mqseries_connx - mqseries_open - mqseries_put - - -
    - diff --git a/reference/mqseries/functions/mqseries-inq.xml b/reference/mqseries/functions/mqseries-inq.xml deleted file mode 100644 index 2430201db1..0000000000 --- a/reference/mqseries/functions/mqseries-inq.xml +++ /dev/null @@ -1,176 +0,0 @@ - - - - - - - mqseries_inq - MQSeries MQINQ - - - - &reftitle.description; - - voidmqseries_inq - resourcehconn - resourcehobj - intselectorCount - arrayselectors - intintAttrCount - resourceintAttr - intcharAttrLength - resourcecharAttr - resourcecompCode - resourcereason - - - mqseries_inq devuelve un array de enteros y un - conjunto de strings que representan un objeto. - - - - - &reftitle.parameters; - - - - hConn - - - Gestor de conexión. - Este recurso representa la conexión al gestor de colas. - - - - - hObj - - - Gestor de objeto. - Este recurso representa el objeto a utilizar. - - - - - selectorCount - - - Número de selectores. - - - - - selectors - - - Array de atributos de selectores. - - - - - intAttrLength - - - Número de atributos enteros. - - - - - intAttr - - - Array de atributos enteros. - - - - - charAttrLength - - - Tamaño del buffer de atributos de carácter. - - - - - charAttr - - - Atributo de carácter. - - - - - compCode - - - Código de finalización. - - - - - reason - - - La razón que califica el compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.examples; - - Ejemplo con <function>mqseries_inq</function> - -\n", $comp_code, $reason, mqseries_strerror($reason)); - } else { - echo "INQ QManager name result ".$char_attr."
    \n"; - } -?> -]]> -
    -
    -
    - - - &reftitle.seealso; - - mqseries_conn - mqseries_connx - mqseries_open - - -
    - diff --git a/reference/mqseries/functions/mqseries-open.xml b/reference/mqseries/functions/mqseries-open.xml deleted file mode 100644 index 4c516b9e10..0000000000 --- a/reference/mqseries/functions/mqseries-open.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - mqseries_open - MQSeries MQOPEN - - - - &reftitle.description; - - voidmqseries_open - resourcehconn - arrayobjDesc - intoption - resourcehobj - resourcecompCode - resourcereason - - - mqseries_open establece el acceso a un objeto. - - - - - &reftitle.parameters; - - - - hConn - - - Gestor de conexión. - Este recurso representa la conexión al gestor de colas. - - - - - objDesc - - - Recurso de objeto. - - - - - options - - - Opciones que controlan las acciones de la función. - - - - - hObj - - - Gestor de objeto. - Este recurso representa el objeto a utilizar. - - - - - compCode - - - Código de finalización. - - - - - reason - - - La razón que califica el compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.examples; - - Ejemplo con <function>mqseries_open</function> - - 'TESTQ'); - mqseries_open( - $conn, - $mqods, - MQSERIES_MQOO_INPUT_AS_Q_DEF | MQSERIES_MQOO_FAIL_IF_QUIESCING | MQSERIES_MQOO_OUTPUT, - $obj, - $comp_code, - $reason); - if ($comp_code !== MQSERIES_MQCC_OK) { - printf("open CompCode:%d Reason:%d Text:%s
    \n", $comp_code, $reason, mqseries_strerror($reason)); - exit; - } -?> -]]> -
    -
    -
    - - - &reftitle.seealso; - - mqseries_close - - -
    - diff --git a/reference/mqseries/functions/mqseries-put.xml b/reference/mqseries/functions/mqseries-put.xml deleted file mode 100644 index a354372b9e..0000000000 --- a/reference/mqseries/functions/mqseries-put.xml +++ /dev/null @@ -1,179 +0,0 @@ - - - - - - - mqseries_put - MQSeries MQPUT - - - - &reftitle.description; - - voidmqseries_put - resourcehConn - resourcehObj - arraymd - arraypmo - stringmessage - resourcecompCode - resourcereason - - - mqseries_put añade un mensaje a una cola o a una lista de distribución. La cola o la lista de distribución deben estar abiertas. - - - - - &reftitle.parameters; - - - - hConn - - - Gestor de conexión. - Esta referencia representa la conexión al gestor de colas. - - - - - hObj - - - Gestor de objeto. - Esta referencia representa el objeto a utilizar. - - - - - md - - - Recurso de mensaje (MQMD). - - - - - pmo - - - Opción de adición de mensaje. - - - - - message - - - El mensaje a colocar en la cola. - - - - - compCode - - - Código de finalización. - - - - - reason - - - La razón que califica el compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.examples; - - Ejemplo con <function>mqseries_put</function> - - 'TESTQ'), - MQSERIES_MQOO_INPUT_AS_Q_DEF | MQSERIES_MQOO_FAIL_IF_QUIESCING | MQSERIES_MQOO_OUTPUT, - $obj, - $comp_code, - $reason); -// $obj contiene ahora la referencia al objeto (TESTQ) - -// Define el array de descripción del mensaje. Verifica manualmente las referencias a MQSeries. - $md = array( - 'Version' => MQSERIES_MQMD_VERSION_1, - 'Expiry' => MQSERIES_MQEI_UNLIMITED, - 'Report' => MQSERIES_MQRO_NONE, - 'MsgType' => MQSERIES_MQMT_DATAGRAM, - 'Format' => MQSERIES_MQFMT_STRING, - 'Priority' => 1, - 'Persistence' => MQSERIES_MQPER_PERSISTENT); - -// Define las opciones de transmisión de mensajes. - $pmo = array('Options' => MQSERIES_MQPMO_NEW_MSG_ID|MQSERIES_MQPMO_SYNCPOINT); - -// Coloca el mensaje 'Ping' en la cola. - mqseries_put($conn, $obj, $md, $pmo, 'Ping', $comp_code, $reason); - - if ($comp_code !== MQSERIES_MQCC_OK) { - printf("put CompCode:%d Reason:%d Text:%s
    \n", $comp_code, $reason, mqseries_strerror($reason)); - } - -// Cierra la referencia al objeto $obj - mqseries_close($conn, $obj, MQSERIES_MQCO_NONE, $comp_code, $reason); - -// Desconecta el gestor de colas. - mqseries_disc($conn, $comp_code, $reason); - -?> -]]> -
    -
    -
    - - - &reftitle.seealso; - - mqseries_conn - mqseries_connx - mqseries_open - mqseries_get - - -
    - diff --git a/reference/mqseries/functions/mqseries-put1.xml b/reference/mqseries/functions/mqseries-put1.xml deleted file mode 100644 index b6cf3fb82b..0000000000 --- a/reference/mqseries/functions/mqseries-put1.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - - mqseries_put1 - MQSeries MQPUT1 - - - - &reftitle.description; - - voidmqseries_put1 - resourcehconn - resourceobjDesc - resourcemsgDesc - resourcepmo - stringbuffer - resourcecompCode - resourcereason - - - La llamada a mqseries_put1 - (MQPUT1) añade un mensaje a una cola. La cola no necesita estar abierta. - - - Se pueden utilizar tanto llamadas a mqseries_put - como a mqseries_put1 para añadir mensajes - a una cola; qué llamada utilizar depende de las circunstancias. - Utilizar la llamada a mqseries_put (MQPUT) para añadir varios - mensajes a la misma cola. - Utilizar la llamada a mqseries_put1 (MQPUT1) para añadir un - solo mensaje a una cola. - Esta llamada engloba las llamadas a MQOPEN, MQPUT y MQCLOSE en una sola llamada, - minimizando el número de llamadas a emitir. - - - - - &reftitle.parameters; - - - - hConn - - - Gestor de conexión. - Este gestor representa la conexión al gestor de colas. - - - - - objDesc - - - Descriptor del objeto (MQOD). - - Esta estructura identifica la cola en la que se añadirá el mensaje. - - - - - - msgDesc - - - Descriptor del mensaje (MQMD). - - - - - pmo - - - Opciones de adición del mensaje (MQPMO). - - - - - - compCode - - - Código de finalización. - - - - - reason - - - La razón que califica el compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.seealso; - - mqseries_conn - mqseries_connx - mqseries_open - mqseries_get - - - - diff --git a/reference/mqseries/functions/mqseries-set.xml b/reference/mqseries/functions/mqseries-set.xml deleted file mode 100644 index 408fd81f30..0000000000 --- a/reference/mqseries/functions/mqseries-set.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - - mqseries_set - MQSeries MQSET - - - - &reftitle.description; - - voidmqseries_set - resourcehConn - resourcehObj - intselectorCount - arrayselectors - intintAttrCount - arrayintAttrs - intcharAttrLength - arraycharAttrs - resourcecompCode - resourcereason - - - La llamada a mqseries_set - (MQSET) se utiliza para modificar los atributos de un objeto representado - por un manejador. El objeto debe ser una cola. - - - - - &reftitle.parameters; - - - - hConn - - - Manejador de conexión. - Este manejador representa la conexión al gestor de colas. - - - - - hObj - - - Manejador de objeto. - Este manejador representa el objeto a utilizar. - - - - - selectorCount - - - Conteo de selectores. - - - - - selectors - - - Array de atributos de los selectores. - - - - - intAttrCount - - - Conteo de atributos enteros. - - - - - intAttrs - - - Array de atributos enteros. - - - - - charAttrLength - - - Longitud del búfer de atributos de caracteres. - - - - - charAttrs - - - Atributos de caracteres. - - - - - compCode - - - Código de finalización. - - - - - reason - - - La razón que califica el compCode. - - - - - - - &reftitle.returnvalues; - &return.void; - - - - &reftitle.seealso; - - mqseries_inq - - - - diff --git a/reference/mqseries/functions/mqseries-strerror.xml b/reference/mqseries/functions/mqseries-strerror.xml deleted file mode 100644 index 4de3e998d2..0000000000 --- a/reference/mqseries/functions/mqseries-strerror.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - mqseries_strerror - Devuelve el mensaje de error correspondiente al código de resultado - - - - &reftitle.description; - - stringmqseries_strerror - intreason - - - mqseries_strerror - devuelve el mensaje de error correspondiente al código de resultado. - - - - - &reftitle.parameters; - - - - reason - - - La razón que califica el compCode. - - - - - - - &reftitle.returnvalues; - La cadena de representación de la razón del mensaje de error. - - - - &reftitle.examples; - - Ejemplo con <function>mqseries_strerror</function> - -\n", $comp_code, $reason, mqseries_strerror($reason)); - exit; - } -?> -]]> - - &example.outputs; - - - - - - - diff --git a/reference/mqseries/ini.xml b/reference/mqseries/ini.xml deleted file mode 100644 index 176a41ac85..0000000000 --- a/reference/mqseries/ini.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - -
    - &reftitle.runtime; - &extension.runtime; - &no.config; -
    - - diff --git a/reference/mqseries/reference.xml b/reference/mqseries/reference.xml deleted file mode 100644 index d446e4e8a0..0000000000 --- a/reference/mqseries/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - - - Funciones de mqseries - &reference.mqseries.entities.functions; - - - diff --git a/reference/mqseries/resources.xml b/reference/mqseries/resources.xml deleted file mode 100644 index 476db8816b..0000000000 --- a/reference/mqseries/resources.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - -
    - &reftitle.resources; - - Esta extensión define un recurso de conexión y de object_handle. - - - Las funciones mqseries_conn y mqseries_connx definen - recursos de conexión. - - - La función mqseries_open define un recurso de object_handle. - -
    - diff --git a/reference/mqseries/setup.xml b/reference/mqseries/setup.xml deleted file mode 100644 index 6c98bca251..0000000000 --- a/reference/mqseries/setup.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - Una instalación funcional de IBM WebSphere MQ. Para la compilación de la extensión, - el SDK de IBM WebSphere MQ también es necesario. - - - - Debe preverse que al funcionar con el cliente IBM WebSphere MQ, - ciertos métodos no están disponibles. Esto no es un problema con - la extensión, sino simplemente la forma de funcionar de - WebSphere MQ Client Interface. - - - -
    - - - - &reference.mqseries.configure; - - - - &reference.mqseries.ini; - - - - &reference.mqseries.resources; - - -
    - - diff --git a/reference/mysql/book.xml b/reference/mysql/book.xml deleted file mode 100644 index ad3908090c..0000000000 --- a/reference/mysql/book.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - API MySQL original - MySQL (Original) - - - - &reftitle.intro; - - Esta extensión está obsoleta desde PHP 5.5.0 y ha sido eliminada - desde PHP 7.0.0. En su lugar, se debe utilizar la extensión - mysqli o - PDO_MySQL. Consulte también la visión general de la API MySQL para obtener más ayuda en la elección de una API MySQL. - - - Estas funciones permiten acceder a las bases de datos - MySQL. El sitio oficial de esta base de datos es - &url.mysql;. - - - La documentación de MySQL está disponible en - &url.mysql.docs;. - - - - - &reference.mysql.setup; - &reference.mysql.changelog; - &reference.mysql.constants; - &reference.mysql.examples; - &reference.mysql.reference; - - - diff --git a/reference/mysql/changelog.xml b/reference/mysql/changelog.xml deleted file mode 100644 index ffa4e00d01..0000000000 --- a/reference/mysql/changelog.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - &ChangelogListingTitle; - &ChangelogListingDescription; - - - Histórico de cambios general para la extensión ext/mysql - - Este histórico de cambios hace referencia a la extensión ext/mysql. - - - - - Cambios globales en ext/mysql - - La siguiente lista presenta los cambios en toda la extensión ext/mysql. - - - - - - &Version; - &Description; - - - - - 7.0.0 - - - Esta extensión ha sido eliminada de PHP. Para más detalles, - ver . - - - - - - - - - - Cambios en las funciones existentes - - La siguiente lista es una compilación de los cambios realizados - en las funciones de la extensión ext/mysql. - - - - - - diff --git a/reference/mysql/configure.xml b/reference/mysql/configure.xml deleted file mode 100644 index 163a71ff81..0000000000 --- a/reference/mysql/configure.xml +++ /dev/null @@ -1,170 +0,0 @@ - - - - -
    - &reftitle.install; - - - &mysql.alternative.note; - - - - Para compilar, simplemente se debe utilizar la opción de configuración - - donde el parámetro opcional [DIR] apunta hacia - el directorio de instalación de MySQL. - - - Aunque esta extensión MySQL sea compatible con MySQL 4.1.0 y superior, - no soporta las funcionalidades adicionales que esta versión proporciona. - Para ello, se recomienda utilizar la extensión MySQLi. - - - Si se desea instalar la extensión mysqli al mismo tiempo que la extensión - mysql, se debe utilizar la misma biblioteca cliente para evitar conflictos. - - -
    - Instalación en sistemas Linux - - Nota: [DIR] es la ruta hacia la biblioteca cliente - MySQL (encabezados y bibliotecas), que puede ser - descargada desde el sitio de MySQL. - - - Matriz de soporte de ext/mysql - - - - PHP &Version; - &Default; - &ConfigureOptions;: mysqlnd - &ConfigureOptions;: libmysqlclient - &Changelog; - - - - - 4.x.x - libmysqlclient - &NotAvailable; - para desactivar - MySQL está activo por omisión, las bibliotecas cliente MySQL están incluidas internamente - - - 5.0.x, 5.1.x, 5.2.x - libmysqlclient - &NotAvailable; - - - MySQL no está activo por omisión, y las bibliotecas cliente MySQL - ya no están incluidas internamente - - - - 5.3.x - libmysqlclient - - - mysqlnd está ahora disponible - - - 5.4.x - mysqlnd - - - mysqlnd está ahora incluido por omisión - - - -
    -
    - -
    - Instalación en sistemas Windows -
    - PHP 5.0.x, 5.1.x, 5.2.x - - MySQL ya no está activado por omisión, por lo tanto, la biblioteca - php_mysql.dll debe ser activada en el &php.ini;. - Además, PHP debe tener acceso a la biblioteca cliente MySQL. - Un fichero llamado libmysql.dll está incluido en - la distribución de PHP para Windows y para que PHP pueda comunicarse - con MySQL, este fichero debe estar disponible en el PATH - del sistema Windows. Lea la FAQ titulada - "¿Dónde debo añadir mi directorio PHP a la variable - PATH en Windows?" para más información sobre - cómo realizar esto. No obstante, copiar el fichero - libmysql.dll en el directorio sistema de Windows funciona - (ya que el directorio sistema está por omisión en el PATH del sistema), - pero esto no es recomendado en absoluto. - - - Para activar cualquier extensión PHP (como - php_mysql.dll), la directiva PHP - extension_dir debe estar definida - y debe apuntar hacia el directorio donde están almacenadas las extensiones PHP. - Lea también el - manual de instalación en Windows. - Por ejemplo, aquí hay un valor posible para la directiva - extension_dir en PHP 5: - c:\php\ext - - - - Si al iniciar el servidor web aparece un error similar a este: - "Unable to load dynamic library './php_mysql.dll'", - es porque php_mysql.dll y/o - libmysql.dll no pudieron ser encontrados por el sistema. - - -
    -
    - PHP 5.3.0+ - - El driver MySQL nativo está activado por omisión. - Incluya php_mysql.dll, pero libmysql.dll - ya no es necesario, ni utilizado. - -
    -
    - -
    - Notas sobre la instalación de MySQL - - - Pueden encontrarse fallos y problemas de inicio de PHP cuando - se carga esta función al mismo tiempo que la extensión recode. Consulte la extensión - recode para más detalles. - - - - - Si se necesitan otros juegos de caracteres que el predeterminado - (latino), se debe instalar la biblioteca externa - libmysqlclient (no proporcionada), compilada con este juego de caracteres. - - -
    -
    - diff --git a/reference/mysql/constants.xml b/reference/mysql/constants.xml deleted file mode 100644 index 7e762199bb..0000000000 --- a/reference/mysql/constants.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - Es posible especificar opciones de cliente adicionales para las funciones - mysql_connect y mysql_pconnect. - Estas constantes son las siguientes: - - Constantes de cliente MySQL - - - - Constante - Descripción - - - - - MYSQL_CLIENT_COMPRESS - Utiliza el protocolo con compresión - - - MYSQL_CLIENT_IGNORE_SPACE - Permite espacios después de los nombres de función - - - MYSQL_CLIENT_INTERACTIVE - Permite segundos de inactividad - en la conexión (en lugar de ). - - - MYSQL_CLIENT_SSL - Utilización de cifrado SSL. Esta constante solo está disponible a partir - de la versión 4.x y posteriores de la biblioteca cliente MySQL. La versión 3.23.x - se proporciona con PHP 4 así como con los binarios para Windows de PHP 5. - - - -
    -
    - - - La función mysql_fetch_array utiliza una constante para especificar - los diferentes tipos de formatos de respuesta. Las constantes siguientes son utilizadas: - - Constantes de <function>mysql_fetch_array</function> - - - - Constante - Descripción - - - - - MYSQL_ASSOC - - Las columnas son devueltas en un array cuyos índices son los nombres de columnas. - - - - MYSQL_BOTH - - Las columnas son devueltas en un array con indexación numérica y un sistema de índices - correspondiente al nombre de las columnas. - - - - MYSQL_NUM - - Las columnas son devueltas en un array con un índice numérico. Las columnas están - numeradas en su orden de aparición. El índice comienza en cero. - - - - -
    -
    -
    - - diff --git a/reference/mysql/examples.xml b/reference/mysql/examples.xml deleted file mode 100644 index bb78b098d4..0000000000 --- a/reference/mysql/examples.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - &reftitle.examples; -
    - Ejemplo con la extensión MySQL - - Este ejemplo simple muestra cómo conectarse, ejecutar una - consulta, leer la información obtenida y desconectarse de una - base de datos MySQL. - - Ejemplo de presentación de la extensión MySQL - -\n"; -while ($line = mysql_fetch_array($result, MYSQL_ASSOC)) { - echo "\t\n"; - foreach ($line as $col_value) { - echo "\t\t$col_value\n"; - } - echo "\t\n"; -} -echo "\n"; - -// Liberación de los resultados -mysql_free_result($result); - -// Cierre de la conexión -mysql_close($link); -?> -]]> - - - -
    -
    - - diff --git a/reference/mysql/functions/mysql-affected-rows.xml b/reference/mysql/functions/mysql-affected-rows.xml deleted file mode 100644 index 28be1ea0a9..0000000000 --- a/reference/mysql/functions/mysql-affected-rows.xml +++ /dev/null @@ -1,182 +0,0 @@ - - - - - - - mysql_affected_rows - Obtiene el número de filas afectadas en la anterior operación de MySQL - - - - - &mysql.alternative.note; - - mysqli_affected_rows - PDOStatement::rowCount - - - - - - &reftitle.description; - - intmysql_affected_rows - resourcelink_identifierNULL - - - Obtiene el número de filas afectadas por la última consulta INSERT, UPDATE, REPLACE - o DELETE asociada con link_identifier. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Devuelve el número de filas afectadas en caso de éxito, y -1 si la última consulta - falló. - - - Si la consulta anterior fue DELETE con ninguna cláusula WHERE, todos - los registros habrán sido borrados de la tabla, aunque ésta función - devolverá cero con una versión anterior a MySQL 4.1.2. - - - Al utilizar UPDATE, MySQL no actualiza las columnas donde el nuevo valor es el - mismo que el anterior. Esto crea la posibilidad de que - mysql_affected_rows no pueda equivaler en realidad al número - de filas encontradas, solamente el número de filas que estuvieron literalmente afectadas por - la consulta. - - - La sentencia REPLACE primero borra el registro con la misma clave primaria - y luego inserta el nuevo registro. Esta función devuelve el número de - registros borrados más el número de registros insertados. - - - En el caso de consultas "INSERT ... ON DUPLICATE KEY UPDATE", el - valor devuelto será 1 si se realizó una inserción, - o 2 para una actualización de una fila existente. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_affected_rows</function> - - -]]> - - &example.outputs.similar; - - - - - - Ejemplo de <function>mysql_affected_rows</function> al utilizar transacciones - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.notes; - - Transacciones - - Si se usan transacciones, es necesario llamar a - mysql_affected_rows después de una consulta INSERT, UPDATE, o - DELETE, no después del COMMIT. - - - - Sentencias SELECT - - Para conocer el número de filas devueltas por un SELECT, es posible - usar mysql_num_rows. - - - - Claves Foráneas en Cascada - - mysql_affected_rows no cuenta la filas afectadas - implícitamente a través del uso de ON DELETE CASCADE y/o ON UPDATE CASCADE - en las restricciones de las claves foráneas. - - - - - - &reftitle.seealso; - - mysql_num_rows - mysql_info - - - - diff --git a/reference/mysql/functions/mysql-client-encoding.xml b/reference/mysql/functions/mysql-client-encoding.xml deleted file mode 100644 index acf2eae366..0000000000 --- a/reference/mysql/functions/mysql-client-encoding.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - mysql_client_encoding - Devuelve el nombre del conjunto de caracteres - - - - - &mysql.alternative.note; - - mysqli_character_set_name - - - - - - &reftitle.description; - - stringmysql_client_encoding - resourcelink_identifierNULL - - - Recupera la variable character_set de MySQL. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Devuelve el nombre del conjunto de caracteres predeterminado de la conexión actual. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_client_encoding</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - mysql_set_charset - mysql_real_escape_string - - - - diff --git a/reference/mysql/functions/mysql-close.xml b/reference/mysql/functions/mysql-close.xml deleted file mode 100644 index 741864f6dd..0000000000 --- a/reference/mysql/functions/mysql-close.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - mysql_close - Cerrar una conexión de MySQL - - - - - &mysql.alternative.note; - - mysqli_close - PDO: Asignar el valor de &null; al objeto PDO - - - - - - &reftitle.description; - - boolmysql_close - resourcelink_identifierNULL - - - mysql_close cierra la conexión no persistente - al servidor de MySQL que está asociada con el identificador de enlace especificado. Si - link_identifier no se especifica, se usará el último - enlace abierto. - - &mysql.close.connections.result.sets; - - - - &reftitle.parameters; - - &mysql.linkid-noreopen.description; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_close</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.notes; - - - mysql_close no cerrará los enlaces persistentes - creados por mysql_pconnect. - Para más detalles, véase la página del manual sobre - conexiones persistentes. - - - - - - &reftitle.seealso; - - mysql_connect - mysql_free_result - - - - diff --git a/reference/mysql/functions/mysql-connect.xml b/reference/mysql/functions/mysql-connect.xml deleted file mode 100644 index ba5ef55b2f..0000000000 --- a/reference/mysql/functions/mysql-connect.xml +++ /dev/null @@ -1,243 +0,0 @@ - - - - - - mysql_connect - Abre una conexión al servidor MySQL - - - - - &mysql.alternative.note; - - mysqli_connect - PDO::__construct - - - - - - &reftitle.description; - - resourcefalsemysql_connect - stringserverini_get("mysql.default_host") - stringusernameini_get("mysql.default_user") - stringpasswordini_get("mysql.default_password") - boolnew_link&false; - intclient_flags0 - - - Abre o reutiliza una conexión a un servidor MySQL. - - - - - &reftitle.parameters; - - - server - - - El servidor MySQL. También se puede incluir un número de puerto. P.ej. - "nombre_anfitrión:puerto" o una ruta a un socket local, p.ej. ":/ruta/al/socket" para - el servidor local. - - - Si la directiva PHP - mysql.default_host no está definida (por defecto), el valor por - defecto es 'localhost:3306'. En &sqlsafemode;, éste parámetro es ignorado - y siempre se usa el valor 'localhost:3306'. - - - - - username - - - El nombre de usuario. El valor por defecto está definido por mysql.default_user. En - &sqlsafemode;, éste parámetro es ignorado y se usa el nombre de usuario que - posee el proceso del servidor. - - - - - password - - - La contraseña. El valor por defecto está definido por mysql.default_password. En - &sqlsafemode;, éste parámetro es ignorado y se usa la contraseña vacía. - - - - - new_link - - - Si se realiza una segunda llamada a mysql_connect - con los mismos argumentos, un nuevo enlace no será establecido, pero en - su lugar, será devuelto el identificador de enlace del enlace ya - abierto. El parámetro new_link modifica éste - comportamiento y hace que mysql_connect siempre abra - un nuevo enlace, aun si mysql_connect fue llamada - antes con los mismos parámetros. - En &sqlsafemode;, éste parámetro es ignorado. - - - - - client_flags - - - El parámetro client_flags puede ser una combinación - de las siguientes constantes: - 128 (habilita el manejo de LOAD DATA LOCAL), - MYSQL_CLIENT_SSL, - MYSQL_CLIENT_COMPRESS, - MYSQL_CLIENT_IGNORE_SPACE o - MYSQL_CLIENT_INTERACTIVE. - Lea la sección sobre para más información. - En &sqlsafemode;, éste parámetro es ignorado. - - - - - - - - &reftitle.returnvalues; - - Devuelve un identificador de enlace de MySQL en caso de éxito &return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_connect</function> - - -]]> - - - - Ejemplo de <function>mysql_connect</function> usando la sintaxis <literal>nombre_anfitrión:puerto</literal> - - -]]> - - - - Ejemplo de <function>mysql_connect</function> usando la sintaxis ":/rota/al/socket" - - -]]> - - - - - - &reftitle.notes; - - - Siempre que se especifique "localhost" o - "localhost:puerto" como servidor, la biblioteca cliente de MySQL - invalidará esto e intentará conectarse a un socket local (llamada tubería en - Windows). Si se quiere usar TCP/IP, se ha de utilizar "127.0.0.1" - en lugar de "localhost". Si la biblioteca cliente de MySQL intenta - conectarse al socket local erróneo, se debería establecer el ruta correcta como - mysql.default_host en &php.ini; y dejar el campo del servidor en - blanco. - - - - - El enlace al servidor se cerrará tan pronto finalice la ejecución - del script, a menos que se cierre antes por una llamada explícita a - mysql_close. - - - - - El error "Can't create TCP/IP socket (10106)" normalmente significa que la directiva - de configuración variables_order - no contiene el carácter E. En Windows, si el - entorno no es copiadola variable de entorno SYSTEMROOT - no estará disponible y PHP tendrá problemas al cargar Winsock. - - - - - - &reftitle.seealso; - - mysql_pconnect - mysql_close - - - - diff --git a/reference/mysql/functions/mysql-create-db.xml b/reference/mysql/functions/mysql-create-db.xml deleted file mode 100644 index cb17c0c3c1..0000000000 --- a/reference/mysql/functions/mysql-create-db.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - - mysql_create_db - Crea una base de datos MySQL - - - - - &mysql.alternative.note.4-3-0; - - mysqli_query - PDO::query - - - - - - &reftitle.description; - - boolmysql_create_db - stringdatabase_name - resourcelink_identifierNULL - - - mysql_create_db intenta crear una nueva - base de datos en el servidor asociado con el identificador de enlace - especificado. - - - - - &reftitle.parameters; - - - database_name - - - El nombre de la base de datos a crear. - - - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo alternativo de <function>mysql_create_db</function> - - La función mysql_create_db está obsoleta. Es - preferible el uso de mysql_query para emitir - una sentencia CREATE DATABASE de sql en su lugar. - - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - mysql_createdb - - - - - Ésta función no estará disponible si la extensión MySQL fue construida - con una biblioteca cliente MySQL 4.x. - - - - - - &reftitle.seealso; - - mysql_query - mysql_select_db - - - - diff --git a/reference/mysql/functions/mysql-data-seek.xml b/reference/mysql/functions/mysql-data-seek.xml deleted file mode 100644 index fba59210a3..0000000000 --- a/reference/mysql/functions/mysql-data-seek.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - mysql_data_seek - Mueve el puntero de resultados interno - - - - - &mysql.alternative.note; - - mysqli_data_seek - PDO::FETCH_ORI_ABS - - - - - - &reftitle.description; - - boolmysql_data_seek - resourceresult - introw_number - - - mysql_data_seek mueve el puntero de filas interno - del resultado de MySQL asociado con el identificador de resultado especificado - para apuntar al número de fila especificada. La siguiente llamada - a una función de obtención de MySQL, tal como mysql_fetch_assoc, - devolverá esa fila. - - - row_number empieza en 0. - row_number debería ser un valor en el rango de 0 a - mysql_num_rows -1. Sin embargo, si el conjunto de resultados - esta vacío (mysql_num_rows == 0), una búsqueda a 0 - fallará con un E_WARNING y - mysql_data_seek devolverá &false;. - - - - - &reftitle.parameters; - - &mysql.result.description; - - row_number - - - Número de la fila deseada del puntero de resultados nuevo. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_data_seek</function> - -= 0; $i--) { - if (!mysql_data_seek($resultado, $i)) { - echo "No se encuenta la fila $i: " . mysql_error() . "\n"; - continue; - } - - if (!($fila = mysql_fetch_assoc($resultado))) { - continue; - } - - echo $fila['apellido'] . ' ' . $fila['nombre'] . "
    \n"; -} - -mysql_free_result($resultado); -?> -]]> -
    -
    -
    - - - &reftitle.notes; - - - La función mysql_data_seek puede ser usada - solamente junto con mysql_query, y no con - mysql_unbuffered_query. - - - - - - &reftitle.seealso; - - mysql_query - mysql_num_rows - mysql_fetch_row - mysql_fetch_assoc - mysql_fetch_array - mysql_fetch_object - - -
    - diff --git a/reference/mysql/functions/mysql-db-name.xml b/reference/mysql/functions/mysql-db-name.xml deleted file mode 100644 index d6fd5426b8..0000000000 --- a/reference/mysql/functions/mysql-db-name.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - mysql_db_name - Recupera el nombre de la base de datos desde una llamada a mysql_list_dbs - - - - - &mysql.alternative.note; - - Consulta: SELECT DATABASE() - - - - - - &reftitle.description; - - stringmysql_db_name - resourceresult - introw - mixedfieldNULL - - - Recupera el nombre de la base de datos de una llamada a - mysql_list_dbs. - - - - - &reftitle.parameters; - - - result - - - El puntero de resultados desde una llamada a mysql_list_dbs. - - - - - row - - - El índice dentro del conjunto de resultados. - - - - - field - - - El nombre del campo. - - - - - - - - &reftitle.returnvalues; - - Devuelve el nombre de la base de datos en caso de éxito, y &false; en caso de error. - Si se devuelve &false;, se usa mysql_error para determinar la naturaleza - del error. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_db_name</function> - - -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - mysql_dbname - - - - - - &reftitle.seealso; - - mysql_list_dbs - mysql_tablename - - - - diff --git a/reference/mysql/functions/mysql-db-query.xml b/reference/mysql/functions/mysql-db-query.xml deleted file mode 100644 index 24b3fd2511..0000000000 --- a/reference/mysql/functions/mysql-db-query.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - - mysql_db_query - Selecciona una base de datos y ejecuta una consulta sobre la misma - - - - - &mysql.alternative.note.5-3-0; - - mysqli_select_db y luego la consulta - PDO::__construct - - - - - - &reftitle.description; - - resourceboolmysql_db_query - stringdatabase - stringquery - resourcelink_identifierNULL - - - mysql_db_query selecciona una base de datos y ejecuta una - consulta en ella. - - - - - &reftitle.parameters; - - - database - - - El nombre de la base de datos que va a ser seleccionada. - - - - - query - - - La consulta MySQL. - - - Los datos dentro de la consulta deben ser escapados apropiadamente. - - - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Devuelve un recurso de resultados de MySQL positivo al resultado de la consulta, - o &false; en caso de error. La función también retorna &true;/&false; para las consultas - INSERT/UPDATE/DELETE - indicando éxito/fallo. - - - - - &reftitle.examples; - - Ejemplo alternativo de <function>mysql_db_query</function> - - -]]> - - - - - - &reftitle.notes; - - - Se ha de tener en cuenta que ésta función NO - vuelve a la base de datos a la que se estaba conectado anteriormente. En otras palabras, - no se puede utilizar ésta función para ejecutar temporalmente una - consulta SQL en otra base de datos; se tendría que hacer el cambio manualmente. - Se recomienda encarecidamente usar la sintaxis - basedatos.tabla en las consultas SQL o - mysql_select_db en lugar de esta función. - - - - - - &reftitle.seealso; - - mysql_query - mysql_select_db - - - - diff --git a/reference/mysql/functions/mysql-drop-db.xml b/reference/mysql/functions/mysql-drop-db.xml deleted file mode 100644 index 47321a83af..0000000000 --- a/reference/mysql/functions/mysql-drop-db.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - - mysql_drop_db - Elimina (DROP) una base de datos MySQL - - - - - &mysql.alternative.note.4-3-0; - - Ejecutar una consulta DROP DATABASE - - - - - - &reftitle.description; - - boolmysql_drop_db - stringdatabase_name - resourcelink_identifierNULL - - - mysql_drop_db intenta eliminar (remover) una - base de datos entera del servidor asociado con el identificador - de enlace especificado. Esta función es obsoleta; es preferible usar - mysql_query para ejecutar una sentencia SQL - DROP DATABASE en su lugar. - - - - - &reftitle.parameters; - - - database_name - - - El nombre de la base de datos que va a ser eliminada. - - - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo alternativo de <function>mysql_drop_db</function> - - -]]> - - - - - - &reftitle.notes; - - - Ésta función no estará disponible si la extensión MySQL fue construida - con una biblioteca cliente MySQL 4.x. - - - - - &info.deprecated.alias; - mysql_dropdb - - - - - - &reftitle.seealso; - - mysql_query - - - - diff --git a/reference/mysql/functions/mysql-errno.xml b/reference/mysql/functions/mysql-errno.xml deleted file mode 100644 index d34d75c5bf..0000000000 --- a/reference/mysql/functions/mysql-errno.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - mysql_errno - Devuelve el valor numérico del mensaje de error de la última operación MySQL - - - - - &mysql.alternative.note; - - mysqli_errno - PDO::errorCode - - - - - - &reftitle.description; - - intmysql_errno - resourcelink_identifierNULL - - - Devuelve el número de error de la última función MySQL. - - - Los errores que provienen del procesamiento de la base de datos MySQL ya no - emiten advertencias. En su lugar, utilice mysql_errno para - recuperar el código de error. Tenga en cuenta que ésta función solamente devolverá el - código de error de la función MySQL ejecutada mas recientemente (sin - incluir a mysql_error y - mysql_errno), por lo que, si se quiere usar, - hay que asegurarse de revisar el valor antes de llamar otra función - MySQL. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Devuelve el número de error de la última función de MySQL, o - 0 (cero) si no ha ocurrido ningún error. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_errno</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - mysql_error - Códigos de error de MySQL - - - - diff --git a/reference/mysql/functions/mysql-error.xml b/reference/mysql/functions/mysql-error.xml deleted file mode 100644 index fb751e8093..0000000000 --- a/reference/mysql/functions/mysql-error.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - mysql_error - Devuelve el texto del mensaje de error de la operación MySQL anterior - - - - - &mysql.alternative.note; - - mysqli_error - PDO::errorInfo - - - - - - &reftitle.description; - - stringmysql_error - resourcelink_identifierNULL - - - Devuelve el texto del error de la última función MySQL. - Los errores que provienen del procesamiento de la base de datos MySQL ya no - emiten advertencias. En su lugar, utilice mysql_errno para - recuperar el código de error. Tenga en cuenta que ésta función solamente devolverá el - código de error de la función MySQL ejecutada mas recientemente (sin - incluir a mysql_error y - mysql_errno), por lo que, si se quiere usar, - hay que asegurarse de revisar el valor antes de llamar otra función - MySQL. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Devuelve el texto del error de la última función MySQL, o - '' (una cadena vacía) si no ha ocurrido ningún error. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_error</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - mysql_errno - Códigos de error de MySQL - - - - diff --git a/reference/mysql/functions/mysql-escape-string.xml b/reference/mysql/functions/mysql-escape-string.xml deleted file mode 100644 index 606ea2bb00..0000000000 --- a/reference/mysql/functions/mysql-escape-string.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - mysql_escape_string - Escapa una cadena para ser usada en mysql_query - - - - - &mysql.alternative.note.4-3-0; - - mysqli_escape_string - PDO::quote - - - - - - &reftitle.description; - - stringmysql_escape_string - stringunescaped_string - - - Esta función escapará unescaped_string, - para que sea segura ponerla en una mysql_query. - Esta función está obsoleta. - - - Esta función es idéntica a mysql_real_escape_string - excepto que mysql_real_escape_string toma un - gestor de conexión y escapa la cadena de acuerdo con el juego de caracteres - actual. mysql_escape_string no toma un - argumento de conexión y no respeta la configuración del juego de caracteres actual. - - - - - &reftitle.parameters; - - - unescaped_string - - - La cadena que va a ser escapada. - - - - - - - - &reftitle.returnvalues; - - Devuelve la cadena escapada. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_escape_string</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.notes; - - - mysql_escape_string no escapa los caracteres - % y _. - - - - - - &reftitle.seealso; - - mysql_real_escape_string - - - - diff --git a/reference/mysql/functions/mysql-fetch-array.xml b/reference/mysql/functions/mysql-fetch-array.xml deleted file mode 100644 index 43583bdb06..0000000000 --- a/reference/mysql/functions/mysql-fetch-array.xml +++ /dev/null @@ -1,190 +0,0 @@ - - - - - - - mysql_fetch_array - Recupera una fila de resultados como un array asociativo, un array numérico o como ambos - - - - - &mysql.alternative.note; - - mysqli_fetch_array - PDOStatement::fetch - - - - - - &reftitle.description; - - arraymysql_fetch_array - resourceresult - intresult_typeMYSQL_BOTH - - - Devuelve un array que corresponde a la fila recuperada - y mueve el puntero de datos interno hacia delante. - - - - - &reftitle.parameters; - - &mysql.result.description; - - result_type - - - El tipo de array que va a ser devuelto. Es una constante y puede - tomar los siguientes valores: MYSQL_ASSOC, - MYSQL_NUM, y - MYSQL_BOTH. - - - - - - - - &reftitle.returnvalues; - - Devuelve un array de cadenas que corresponde a la fila recuperada, o &false; - si no hay más filas. El tipo del array retornado depende de - como esté definido result_type. Al utilizar - MYSQL_BOTH (predeterminado), se obtendrá un array con ambos - índices: asociativos y numéricos. Al utilizar MYSQL_ASSOC, - se obtienen solo los índices asociativos (tal como funciona mysql_fetch_assoc). - Al utilizar MYSQL_NUM, se obtienen solo los índices numéricos - (tal como funciona mysql_fetch_row). - - - Si dos o más columnas del resultado tienen el mismo nombre de campo, - la última columna tomará precedencia. Para acceder a la/s otra/s columna/s - con el mismo nombre, se deberá usar el índice numérico de la columna o - crear un alias para la columna. Para las columnas con alias, no se puede - acceder al contenido con el nombre de la columna original. - - - - - &reftitle.examples; - - Consulta con nombres de campos duplicados con alias - - - - - - <function>mysql_fetch_array</function> con <constant>MYSQL_NUM</constant> - - -]]> - - - - <function>mysql_fetch_array</function> con <constant>MYSQL_ASSOC</constant> - - -]]> - - - - <function>mysql_fetch_array</function> con <constant>MYSQL_BOTH</constant> - - -]]> - - - - - - &reftitle.notes; - - Rendimiento - - Una cosa importante a tener en cuenta es que el uso de - mysql_fetch_array no es - significativamente más lento que el uso de - mysql_fetch_row, aunque provee un - valor añadido considerable. - - - &database.field-case; - &database.fetch-null; - - - - &reftitle.seealso; - - mysql_fetch_row - mysql_fetch_assoc - mysql_data_seek - mysql_query - - - - diff --git a/reference/mysql/functions/mysql-fetch-assoc.xml b/reference/mysql/functions/mysql-fetch-assoc.xml deleted file mode 100644 index ba6681ce0d..0000000000 --- a/reference/mysql/functions/mysql-fetch-assoc.xml +++ /dev/null @@ -1,163 +0,0 @@ - - - - - - - mysql_fetch_assoc - Recupera una fila de resultados como un array asociativo - - - - - &mysql.alternative.note; - - mysqli_fetch_assoc - - PDOStatement::fetch - con mode como PDO::FETCH_ASSOC - - - - - - - &reftitle.description; - - arraymysql_fetch_assoc - resourceresult - - - Devuelve un array asociativo que corresponde a la fila recuperada - y mueve el puntero de datos interno hacia adelante. - mysql_fetch_assoc es equivalente a llamar a - mysql_fetch_array con MYSQL_ASSOC como segundo - parámetro opcional. Únicamente devuelve un array asociativo. - - - - - &reftitle.parameters; - - &mysql.result.description; - - - - - &reftitle.returnvalues; - - Devuelve un array asociativo de strings que corresponde a la fila recuperada, o - &false; si no hay más filas disponibles. - - - Si dos o más columnas del resultado tienen los mismos nombres de campo, - la última columna tomará precedencia. Para acceder a la/s otra/s - columna/s con el mismo nombre, se tendrá que acceder al - resultado con índices numéricos mediante el uso de - mysql_fetch_row o agregando sobrenombres. - Véase el ejemplo en la descripción de mysql_fetch_array - respecto a los sobrenombres. - - - - - &reftitle.examples; - - Un ejemplo desarrolado de <function>mysql_fetch_assoc</function> - - -]]> - - - - - - &reftitle.notes; - - Rendimiento - - Algo importante a observar es que el uso de - mysql_fetch_assoc no es - significativamente más lento que el uso de - mysql_fetch_row, aunque provee un - valor añadido considerable. - - - &database.field-case; - &database.fetch-null; - - - - &reftitle.seealso; - - mysql_fetch_row - mysql_fetch_array - mysql_data_seek - mysql_query - mysql_error - - - - diff --git a/reference/mysql/functions/mysql-fetch-field.xml b/reference/mysql/functions/mysql-fetch-field.xml deleted file mode 100644 index a0ec344a02..0000000000 --- a/reference/mysql/functions/mysql-fetch-field.xml +++ /dev/null @@ -1,206 +0,0 @@ - - - - - - - mysql_fetch_field - Obtiene la información de una columna de un resultado y la devuelve como un objeto - - - - - &mysql.alternative.note; - - mysqli_fetch_field - PDOStatement::getColumnMeta - - - - - - &reftitle.description; - - objectmysql_fetch_field - resourceresult - intfield_offset0 - - - Devuelve un objeto que contiene la información de los campos. Esta función puede ser usada - para obtener información sobre campos en el resultado de la consulta proporcionada. - - - - - &reftitle.parameters; - - &mysql.result.description; - - field_offset - - - El índice numérico del campo. Si el índice del campo no se especifica, se - recuperará el siguiente campo que aún no haya recuperado esta función. - Los índices de field_offset comienzan en 0. - - - - - - - - &reftitle.returnvalues; - - Devuelve un object que contiene la información del campo. - Las propiedades del objeto son: - - - - - name - nombre de la columna - - - - - table - nombre de la tabla a la que pertenece la columna, el cual es el sobrenombre si alguno está definido - - - - - max_length - longitud máxima de la columna - - - - - not_null - 1 si la columna no puede ser &null; - - - - - primary_key - 1 si la columna es una clave primaria - - - - - unique_key - 1 si la columna es una clave única - - - - - multiple_key - 1 si la colmuna es una clave no única - - - - - numeric - 1 si la columna es numérica - - - - - blob - 1 si la columna es un BLOB - - - - - type - el tipo de la columna - - - - - unsigned - 1 si la columna es sin signo - - - - - zerofill - 1 si la columna es rellena de ceros - - - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_fetch_field</function> - -\n"; - $metadatos = mysql_fetch_field($resultado, $i); - if (!$metadatos) { - echo "No hay información disponible
    \n"; - } - echo "
    -blob:         $metadatos->blob
    -max_length:   $metadatos->max_length
    -multiple_key: $metadatos->multiple_key
    -name:         $metadatos->name
    -not_null:     $metadatos->not_null
    -numeric:      $metadatos->numeric
    -primary_key:  $metadatos->primary_key
    -table:        $metadatos->table
    -type:         $metadatos->type
    -unique_key:   $metadatos->unique_key
    -unsigned:     $metadatos->unsigned
    -zerofill:     $metadatos->zerofill
    -
    "; - $i++; -} -mysql_free_result($resultado); -?> -]]> -
    -
    -
    - - - &reftitle.notes; - &database.field-case; - - - Si se usa un alias para los campos o los nombres de tablas en la consulta SQL se - devolverá el nombre del alias. El nombre original se puede recuperar, por ejemplo, usando - mysqli_result::fetch_field. - - - - - - &reftitle.seealso; - - mysql_field_seek - - -
    - diff --git a/reference/mysql/functions/mysql-fetch-lengths.xml b/reference/mysql/functions/mysql-fetch-lengths.xml deleted file mode 100644 index 8ebb391915..0000000000 --- a/reference/mysql/functions/mysql-fetch-lengths.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - - mysql_fetch_lengths - Obtiene la longitud de cada salida en un resultado - - - - - &mysql.alternative.note; - - mysqli_fetch_lengths - PDOStatement::getColumnMeta - - - - - - &reftitle.description; - - arrayfalsemysql_fetch_lengths - resourceresult - - - Devuelve un array que corresponde a las longitudes de cada campo - de la última fila recuperada por MySQL. - - - mysql_fetch_lengths almacena las longitudes de - cada columna del resultado en la última fila devuelta mediante - mysql_fetch_row, - mysql_fetch_assoc, - mysql_fetch_array, y - mysql_fetch_object en un array, comenzando desde el - índice 0. - - - - - &reftitle.parameters; - - &mysql.result.description; - - - - - &reftitle.returnvalues; - - Un array de longitudes en caso de éxito &return.falseforfailure;. - - - - - &reftitle.examples; - - Un ejemplo de <function>mysql_fetch_lengths</function> - - -]]> - - &example.outputs.similar; - - 42 - [email] => user@example.com -) -Array -( - [0] => 2 - [1] => 16 - ) -]]> - - - - - - &reftitle.seealso; - - mysql_field_len - mysql_fetch_row - strlen - - - - diff --git a/reference/mysql/functions/mysql-fetch-object.xml b/reference/mysql/functions/mysql-fetch-object.xml deleted file mode 100644 index 5753e90419..0000000000 --- a/reference/mysql/functions/mysql-fetch-object.xml +++ /dev/null @@ -1,165 +0,0 @@ - - - - - - - mysql_fetch_object - Recupera una fila de resultados como un objeto - - - - - &mysql.alternative.note; - - mysqli_fetch_object - - PDOStatement::fetch - con mode como PDO::FETCH_OBJ - - - - - - - &reftitle.description; - - objectmysql_fetch_object - resourceresult - stringclass_name - arrayparams - - - Devuelve un objeto con propiedades que corresponden a la fila recuperada - y mueve el puntero interno hacia delante. - - - - - &reftitle.parameters; - - &mysql.result.description; - - class_name - - - El nombre de la clase donde instanciar, configurar las propiedades y devolver. - Si no se especifica, se devuelve un objeto stdClass. - - - - - params - - - Un array opcional de parámetros para pasar al constructor - de los objetos class_name. - - - - - - - - &reftitle.returnvalues; - - Devuelve un object con propiedades de tipo string que se corresponden con la - fila recuperada, o &false; si no quedan más filas. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_fetch_object</function> - -id_usuario; - echo $fila->nombre_completo; -} -mysql_free_result($resultado); -?> -]]> - - - - Ejemplo de <function>mysql_fetch_object</function> - - -]]> - - - - - - &reftitle.notes; - - Rendimiento - - En cuestión de velocidad, la función es idéntica a - mysql_fetch_array, y casi tan rápida como - mysql_fetch_row (la diferencia es - insignificante). - - - - - mysql_fetch_object es similar a - mysql_fetch_array, con una diferencia: se - devuelve un objeto, en lugar de un array. Indirectamente, esto significa - que se puede acceder a los datos únicamente mediante los nombres de los campos, y no - mediante sus índices (los números son ilegales como nombres de propiedades). - - - &database.field-case; - &database.fetch-null; - - - - &reftitle.seealso; - - mysql_fetch_array - mysql_fetch_assoc - mysql_fetch_row - mysql_data_seek - mysql_query - - - - diff --git a/reference/mysql/functions/mysql-fetch-row.xml b/reference/mysql/functions/mysql-fetch-row.xml deleted file mode 100644 index 6974c325c0..0000000000 --- a/reference/mysql/functions/mysql-fetch-row.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - - mysql_fetch_row - Obtiene una fila de resultados como un array numérico - - - - - &mysql.alternative.note; - - mysqli_fetch_row - - PDOStatement::fetch - con mode como PDO::FETCH_NUM - - - - - - - &reftitle.description; - - arraymysql_fetch_row - resourceresult - - - Devuelve un array numérico que corresponde a la fila recuperada - y mueve el puntero de datos interno hacia delante. - - - - - &reftitle.parameters; - - &mysql.result.description; - - - - - &reftitle.returnvalues; - - Devuelve un array numérico que corresponde a la fila recuperada, o - &false; si no quedan más filas. - - - mysql_fetch_row recupera una fila de datos del - resultado asociado al identificador de resultados especificado. La - fila es devuelta como un array. Cada columna del resultado es almacenada en un - índice del array, empezando desde 0. - - - - - &reftitle.examples; - - Recuperar una fila con <function>mysql_fetch_row</function> - - -]]> - - - - - - &reftitle.notes; - &database.fetch-null; - - - - &reftitle.seealso; - - mysql_fetch_array - mysql_fetch_assoc - mysql_fetch_object - mysql_data_seek - mysql_fetch_lengths - mysql_result - - - - diff --git a/reference/mysql/functions/mysql-field-flags.xml b/reference/mysql/functions/mysql-field-flags.xml deleted file mode 100644 index 9b58040c04..0000000000 --- a/reference/mysql/functions/mysql-field-flags.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - mysql_field_flags - Obtiene las banderas asociadas al campo especificado de un resultado - - - - - &mysql.alternative.note; - - mysqli_fetch_field_direct [flags] - PDOStatement::getColumnMeta [flags] - - - - - - &reftitle.description; - - stringfalsemysql_field_flags - resourceresult - intfield_offset - - - mysql_field_flags devuelve las banderas del - campo especificado. Las banderas son reportadas como una sola palabra - por bandera, separada por un solo espacio, por lo que se puede dividir el - valor devuelto usando explode. - - - - - &reftitle.parameters; - - &mysql.result.description; - &mysql.field-offset.req.description; - - - - - &reftitle.returnvalues; - - Devuelve un string de banderas asociadas con el resultado &return.falseforfailure;. - - - Las siguientes banderas son reportadas si la versión de MySQL es - suficientemente actual para soportarlas: "not_null", - "primary_key", "unique_key", - "multiple_key", "blob", - "unsigned", "zerofill", - "binary", "enum", - "auto_increment" y "timestamp". - - - - - &reftitle.examples; - - Un ejemplo de <function>mysql_field_flags</function> - - -]]> - - &example.outputs.similar; - - not_null - [1] => primary_key - [2] => auto_increment -) -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - mysql_fieldflags - - - - - - &reftitle.seealso; - - mysql_field_type - mysql_field_len - - - - - diff --git a/reference/mysql/functions/mysql-field-len.xml b/reference/mysql/functions/mysql-field-len.xml deleted file mode 100644 index e109b9246b..0000000000 --- a/reference/mysql/functions/mysql-field-len.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - mysql_field_len - Devuelve la longitud del campo especificado - - - - - &mysql.alternative.note; - - mysqli_fetch_field_direct [length] - PDOStatement::getColumnMeta [len] - - - - - - &reftitle.description; - - intfalsemysql_field_len - resourceresult - intfield_offset - - - mysql_field_len devuelve la longitud del - campo especificado. - - - - - &reftitle.parameters; - - &mysql.result.description; - &mysql.field-offset.req.description; - - - - - &reftitle.returnvalues; - - La longitud del índice del campo especificado en caso de éxito &return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_field_len</function> - - -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - mysql_fieldlen - - - - - - &reftitle.seealso; - - mysql_fetch_lengths - strlen - - - - diff --git a/reference/mysql/functions/mysql-field-name.xml b/reference/mysql/functions/mysql-field-name.xml deleted file mode 100644 index f893579671..0000000000 --- a/reference/mysql/functions/mysql-field-name.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - mysql_field_name - Obtiene el nombre del campo especificado de un resultado - - - - - &mysql.alternative.note; - - mysqli_fetch_field_direct [name] o [orgname] - PDOStatement::getColumnMeta [name] - - - - - - &reftitle.description; - - stringfalsemysql_field_name - resourceresult - intfield_offset - - - mysql_field_name devuelve el nombre del - índice del campo especificado. - - - - - &reftitle.parameters; - - &mysql.result.description; - &mysql.field-offset.req.description; - - - - - &reftitle.returnvalues; - - El nombre del índice del campo especificado en caso de éxito &return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_field_name</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.notes; - &database.field-case; - - - &info.deprecated.alias; - mysql_fieldname - - - - - - &reftitle.seealso; - - mysql_field_type - mysql_field_len - - - - - diff --git a/reference/mysql/functions/mysql-field-seek.xml b/reference/mysql/functions/mysql-field-seek.xml deleted file mode 100644 index fd3d8879a9..0000000000 --- a/reference/mysql/functions/mysql-field-seek.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - mysql_field_seek - Establece el puntero del resultado en un índice de campo específicado - - - - - &mysql.alternative.note; - - mysqli_field_seek - - PDOStatement::fetch empleando los parámetros - cursor_orientation y - offset - - - - - - - &reftitle.description; - - boolmysql_field_seek - resourceresult - intfield_offset - - - Busca el índice del campo especificado. Si la siguiente llamada a - mysql_fetch_field no incluye un índice de - campo, será devuelto el índice del campo especificado en - mysql_field_seek. - - - - - &reftitle.parameters; - - &mysql.result.description; - &mysql.field-offset.req.description; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - mysql_fetch_field - - - - diff --git a/reference/mysql/functions/mysql-field-table.xml b/reference/mysql/functions/mysql-field-table.xml deleted file mode 100644 index 80f078ba77..0000000000 --- a/reference/mysql/functions/mysql-field-table.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - mysql_field_table - Obtiene el nombre de la tabla en la que está el campo especificado - - - - - &mysql.alternative.note; - - mysqli_fetch_field_direct [table] o [orgtable] - PDOStatement::getColumnMeta [table] - - - - - - &reftitle.description; - - stringmysql_field_table - resourceresult - intfield_offset - - - Devuelve el nombre de la tabla en la que está el campo especificado. - - - - - &reftitle.parameters; - - &mysql.result.description; - &mysql.field-offset.req.description; - - - - - &reftitle.returnvalues; - - El nombre de la tabla en caso de éxito. - - - - - &reftitle.examples; - - Un ejemplo de <function>mysql_field_table</function> - - -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - mysql_fieldtable - - - - - - &reftitle.seealso; - - mysql_list_tables - - - - diff --git a/reference/mysql/functions/mysql-field-type.xml b/reference/mysql/functions/mysql-field-type.xml deleted file mode 100644 index 517f869133..0000000000 --- a/reference/mysql/functions/mysql-field-type.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - - mysql_field_type - Obtiene el tipo del campo especificado de un resultado - - - - - &mysql.alternative.note; - - mysqli_fetch_field_direct [type] - PDOStatement::getColumnMeta [driver:decl_type] o [pdo_type] - - - - - - &reftitle.description; - - stringmysql_field_type - resourceresult - intfield_offset - - - mysql_field_type es similar a la - función mysql_field_name. Los argumentos son - idénticos, pero se devuelve en su lugar el tipo de campo. - - - - - &reftitle.parameters; - - &mysql.result.description; - &mysql.field-offset.req.description; - - - - - &reftitle.returnvalues; - - El tipo de campo devuelto será uno de - los siguientes: "int", "real", - "string", "blob", y otros tal - como se detalla en la - documentación de MySQL. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_field_type</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - mysql_fieldtype - - - - - - &reftitle.seealso; - - mysql_field_name - mysql_field_len - - - - - diff --git a/reference/mysql/functions/mysql-free-result.xml b/reference/mysql/functions/mysql-free-result.xml deleted file mode 100644 index cb12fed501..0000000000 --- a/reference/mysql/functions/mysql-free-result.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - - mysql_free_result - Libera la memoria del resultado - - - - - &mysql.alternative.note; - - mysqli_free_result - Asignar el valor de &null; al objeto PDO, o PDOStatement::closeCursor - - - - - - &reftitle.description; - - boolmysql_free_result - resourceresult - - - mysql_free_result liberará toda la memoria - asociada con el identificador del resultado result. - - - mysql_free_result solo necesita ser llamado si - se está preocupado por la cantidad de memoria que está siendo usada por las consultas - que devuelven conjuntos de resultados grandes. Toda la memoria de resultados asociada - se liberará automaticamente al finalizar la ejecución del script. - - - - - &reftitle.parameters; - - &mysql.result.description; - - - - - &reftitle.returnvalues; - - &return.success; - - - Si se utiliza un recurso no válido para result, - se emitirá un error de nivel E_WARNING. Vale la pena señalar que - mysql_query solo devuelve un recurso - para las consultas SELECT, SHOW, EXPLAIN, y DESCRIBE. - - - - - &reftitle.examples; - - Un ejemplo de <function>mysql_free_result</function> - - -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - mysql_freeresult - - - - - - &reftitle.seealso; - - mysql_query - is_resource - - - - diff --git a/reference/mysql/functions/mysql-get-client-info.xml b/reference/mysql/functions/mysql-get-client-info.xml deleted file mode 100644 index 417d4908f4..0000000000 --- a/reference/mysql/functions/mysql-get-client-info.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - mysql_get_client_info - Obtiene información del cliente MySQL - - - - - &mysql.alternative.note; - - mysqli_get_client_info - - PDO::getAttribute - con attribute como PDO::ATTR_CLIENT_VERSION - - - - - - - &reftitle.description; - - stringmysql_get_client_info - - - - mysql_get_client_info devuelve un string - que representa la versión de la biblioteca cliente. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La versión del cliente MySQL. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_get_client_info</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - mysql_get_host_info - mysql_get_proto_info - mysql_get_server_info - - - - diff --git a/reference/mysql/functions/mysql-get-host-info.xml b/reference/mysql/functions/mysql-get-host-info.xml deleted file mode 100644 index 5756594c9f..0000000000 --- a/reference/mysql/functions/mysql-get-host-info.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - mysql_get_host_info - Obtener información del anfitrión de MySQL - - - - - &mysql.alternative.note; - - mysqli_get_host_info - - PDO::getAttribute - con attribute como PDO::ATTR_CONNECTION_STATUS - - - - - - - &reftitle.description; - - stringfalsemysql_get_host_info - resourcelink_identifierNULL - - - Describe el tipo de conexión en uso, incluyendo el nombre del - servidor anfitrión. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Devuelve un string que describe el tipo de conexión MySQL - en uso, o &return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_get_host_info</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - mysql_get_client_info - mysql_get_proto_info - mysql_get_server_info - - - - diff --git a/reference/mysql/functions/mysql-get-proto-info.xml b/reference/mysql/functions/mysql-get-proto-info.xml deleted file mode 100644 index c478070546..0000000000 --- a/reference/mysql/functions/mysql-get-proto-info.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - mysql_get_proto_info - Obtener información del protocolo MySQL - - - - - &mysql.alternative.note; - - mysqli_get_proto_info - - - - - - &reftitle.description; - - intfalsemysql_get_proto_info - resourcelink_identifierNULL - - - Recupera el protocolo MySQL. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Devuelve el protocolo MySQL en caso de éxito &return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_get_proto_info</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - mysql_get_client_info - mysql_get_host_info - mysql_get_server_info - - - - diff --git a/reference/mysql/functions/mysql-get-server-info.xml b/reference/mysql/functions/mysql-get-server-info.xml deleted file mode 100644 index caf5e9ef5d..0000000000 --- a/reference/mysql/functions/mysql-get-server-info.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - mysql_get_server_info - Obtiene información del servidor MySQL - - - - - &mysql.alternative.note; - - mysqli_get_server_info - - PDO::getAttribute - con attribute como PDO::ATTR_SERVER_VERSION - - - - - - - &reftitle.description; - - stringfalsemysql_get_server_info - resourcelink_identifierNULL - - - Recupera la versión del servidor MySQL. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Devuelve la versión del servidor MySQL en caso de éxito &return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_get_server_info</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - mysql_get_client_info - mysql_get_host_info - mysql_get_proto_info - phpversion - - - - diff --git a/reference/mysql/functions/mysql-info.xml b/reference/mysql/functions/mysql-info.xml deleted file mode 100644 index 3d2d544cb0..0000000000 --- a/reference/mysql/functions/mysql-info.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - mysql_info - Obtiene información sobre la consulta más reciente - - - - - &mysql.alternative.note; - - mysqli_info - - - - - - &reftitle.description; - - stringmysql_info - resourcelink_identifierNULL - - - Devuelve información detallada sobre la última consulta. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Devuele información sobre la sentencia en caso de éxito, o &false; en - caso de error. Vea el ejemplo siguiente para conocer qué sentencias proveen información, - y cuál puede ser la apariencia del valor devuelto. Las sentencias que no están en la lista - devolverán &false;. - - - - - &reftitle.examples; - - Sentencias MySQL Relevantes - - Sentencias que devuelven valores de tipo cadena. Los números están únicamente - por propósitos ilustrativos; sus valores corresponderán con la consulta. - - - - - - - - - &reftitle.notes; - - - mysql_info devuelve un valor diferente a &false; para la - sentencia INSERT ... VALUES sólo si se indican múltiples listas de valores - en la sentencia. - - - - - - &reftitle.seealso; - - mysql_affected_rows - mysql_insert_id - mysql_stat - - - - diff --git a/reference/mysql/functions/mysql-insert-id.xml b/reference/mysql/functions/mysql-insert-id.xml deleted file mode 100644 index 94b377a5fc..0000000000 --- a/reference/mysql/functions/mysql-insert-id.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - - mysql_insert_id - Obtiene el ID generado en la última consulta - - - - - &mysql.alternative.note; - - mysqli_insert_id - PDO::lastInsertId - - - - - - &reftitle.description; - - intmysql_insert_id - resourcelink_identifierNULL - - - Recupera el ID generado por la consulta anterior (normalmente INSERT) para - una columna AUTO_INCREMENT. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - El ID generado por la consulta anterior para una columna AUTO_INCREMENT - en caso de éxito, 0 si la consulta - anterior no genera un valor AUTO_INCREMENT, o &false; si - no se estableció una conexión MySQL. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_insert_id</function> - - -]]> - - - - - - &reftitle.notes; - - - mysql_insert_id convertirá el tipo devuelto de la - función nativa mysql_insert_id() de la API de C de MySQL a un tipo - long (llamado int en PHP). Si la - columna AUTO_INCREMENT tiene un tipo BIGINT (64 bits) la - conversión puede resultar en un valor incorrecto. En su lugar, use la función de SQL - interna LAST_INSERT_ID() de MySQL en una consulta SQL. Para más información - sobre los valores máximos de tipo integer, por favor vea la documentación de - integer. - - - - - Como mysql_insert_id actúa en la última consulta realizada, - asegúrese de llamar a mysql_insert_id inmediatamente - después de la consulta que genera el valor. - - - - - El valor de la función de SQL LAST_INSERT_ID() - de MySQL siempre contiene el valor AUTO_INCREMENT generado más - recientientemente, y no se restablece - entre consultas. - - - - - - &reftitle.seealso; - - mysql_query - mysql_info - - - - diff --git a/reference/mysql/functions/mysql-list-dbs.xml b/reference/mysql/functions/mysql-list-dbs.xml deleted file mode 100644 index 6cf6562185..0000000000 --- a/reference/mysql/functions/mysql-list-dbs.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - - mysql_list_dbs - Lista las bases de datos disponibles en un servidor MySQL - - - - - &mysql.alternative.note.5-4-0; - - Consulta SQL: SHOW DATABASES - - - - - - &reftitle.description; - - resourcemysql_list_dbs - resourcelink_identifierNULL - - - Devuelve un puntero de resultados que contiene las bases de datos disponibles en el - demonio de mysql actual. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Devuelve un resource de puntero de resultados en caso de éxito, o &false; en - caso de error. Use la función mysql_tablename para atravesar - este puntero de resultado, o cualquier función para obtener tablas, tal como - mysql_fetch_array. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_list_dbs</function> - -Database . "\n"; -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - mysql_listdbs - - - - - - &reftitle.seealso; - - mysql_db_name - mysql_select_db - - - - diff --git a/reference/mysql/functions/mysql-list-fields.xml b/reference/mysql/functions/mysql-list-fields.xml deleted file mode 100644 index a39c7cbc42..0000000000 --- a/reference/mysql/functions/mysql-list-fields.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - - mysql_list_fields - Lista los campos de una tabla de MySQL - - - - - &mysql.alternative.note.5-4-0; - - Consulta SQL: SHOW COLUMNS FROM alguna_tabla - - - - - - &reftitle.description; - - resourcemysql_list_fields - stringdatabase_name - stringtable_name - resourcelink_identifierNULL - - - Devuelve información sobre el nombre de la tabla dado. - - - Esta función está obsoleta. Es preferible usar - mysql_query para ejecutar una consulta SQL SHOW COLUMNS FROM - tabla [LIKE 'nombre'] en su lugar. - - - - - &reftitle.parameters; - - - database_name - - - El nombre de la base de la base de datos que está siendo consultada. - - - - - table_name - - - El nombre de la tabla que está siendo consultada. - - - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Un resource del puntero del resultado en caso de éxito, o &false; en - caso de error. - - - El resultado devuelto puede ser usado con mysql_field_flags, - mysql_field_len, - mysql_field_name&listendand; - mysql_field_type. - - - - - &reftitle.examples; - - Alternativa para la obsoleta <function>mysql_list_fields</function> - - 0) { - while ($fila = mysql_fetch_assoc($resultado)) { - print_r($fila); - } -} -?> -]]> - - &example.outputs.similar; - - id - [Type] => int(7) - [Null] => - [Key] => PRI - [Default] => - [Extra] => auto_increment -) -Array -( - [Field] => email - [Type] => varchar(100) - [Null] => - [Key] => - [Default] => - [Extra] => -) -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - mysql_listfields - - - - - - &reftitle.seealso; - - mysql_field_flags - mysql_info - - - - diff --git a/reference/mysql/functions/mysql-list-processes.xml b/reference/mysql/functions/mysql-list-processes.xml deleted file mode 100644 index 7a6b3c276a..0000000000 --- a/reference/mysql/functions/mysql-list-processes.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - mysql_list_processes - Lista los procesos de MySQL - - - - - &mysql.alternative.note; - - mysqli_thread_id - - - - - - &reftitle.description; - - resourcefalsemysql_list_processes - resourcelink_identifierNULL - - - Recupera los hilos del servidor MySQL actuales. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Un puntero de resultados de tipo resource en caso de éxito &return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_list_processes</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - mysql_thread_id - mysql_stat - - - - diff --git a/reference/mysql/functions/mysql-list-tables.xml b/reference/mysql/functions/mysql-list-tables.xml deleted file mode 100644 index ce70336f22..0000000000 --- a/reference/mysql/functions/mysql-list-tables.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - - mysql_list_tables - Lista las tablas de una base de datos MySQL - - - - - &mysql.alternative.note.4-3-0; - - Consulta SQL: SHOW TABLES FROM dbname - - - - - - &reftitle.description; - - resourcefalsemysql_list_tables - stringdatabase - resourcelink_identifierNULL - - - Lista las tablas de una base de datos MySQL especificada. - - - Esta función está deprecada. Es preferible utilizar la función - mysql_query para ejecutar la consulta SQL SHOW TABLES - [FROM db_name] [LIKE 'pattern'] en su lugar. - - - - - &reftitle.parameters; - - - database - - - El nombre de la base de datos - - - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Un puntero de resultados resource en caso de éxito&return.falseforfailure;. - - - Utilice la función mysql_tablename - para recorrer este puntero de resultados o cualquier otra función - para los resultados de tablas, como la función - mysql_fetch_array. - - - - - &reftitle.examples; - - Ejemplo de alternativa a <function>mysql_list_tables</function> - - -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - mysql_listtables - - - - - - &reftitle.seealso; - - mysql_list_dbs - mysql_tablename - - - - diff --git a/reference/mysql/functions/mysql-num-fields.xml b/reference/mysql/functions/mysql-num-fields.xml deleted file mode 100644 index 82e6f88b88..0000000000 --- a/reference/mysql/functions/mysql-num-fields.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - mysql_num_fields - Obtiene el número de campos de un resultado - - - - - &mysql.alternative.note; - - mysqli_num_fields - PDOStatement::columnCount - - - - - - &reftitle.description; - - intfalsemysql_num_fields - resourceresult - - - Obtiene el número de campos de una consulta. - - - - - &reftitle.parameters; - - &mysql.result.description; - - - - - &reftitle.returnvalues; - - Devuelve el número de campos del resource de conjunto de resultados en - caso de éxito &return.falseforfailure;. - - - - - &reftitle.examples; - - Un ejemplo de <function>mysql_num_fields</function> - - -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - mysql_numfields - - - - - - &reftitle.seealso; - - mysql_select_db - mysql_query - mysql_fetch_field - mysql_num_rows - - - - diff --git a/reference/mysql/functions/mysql-num-rows.xml b/reference/mysql/functions/mysql-num-rows.xml deleted file mode 100644 index 3126db9700..0000000000 --- a/reference/mysql/functions/mysql-num-rows.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - mysql_num_rows - Obtener el número de filas de un conjunto de resultados - - - - - &mysql.alternative.note; - - mysqli_num_rows - mysqli_stmt_num_rows - PDOStatement::rowCount - - - - - - &reftitle.description; - - intfalsemysql_num_rows - resourceresult - - - Recupera el número de filas de un conjunto de resultados. Este comando es únicamente válido - para sentencias como SELECT o SHOW que retornan un conjunto de resultados real. - Para recuperar el número de filas afectadas por una consulta INSERT, UPDATE, REPLACE o - DELETE, use mysql_affected_rows. - - - - - &reftitle.parameters; - - &mysql.result.description; - - - - - &reftitle.returnvalues; - - El número de filas de un conjunto de resultados en caso de éxito &return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_num_rows</function> - - -]]> - - - - - - &reftitle.notes; - - - Si se utiliza mysql_unbuffered_query, - mysql_num_rows no retornará el valor correcto - hasta que se hayan recuperado todas las filas del conjunto de - resultados. - - - - - &info.deprecated.alias; - mysql_numrows - - - - - - &reftitle.seealso; - - mysql_affected_rows - mysql_connect - mysql_data_seek - mysql_select_db - mysql_query - - - - diff --git a/reference/mysql/functions/mysql-pconnect.xml b/reference/mysql/functions/mysql-pconnect.xml deleted file mode 100644 index 65ac02b488..0000000000 --- a/reference/mysql/functions/mysql-pconnect.xml +++ /dev/null @@ -1,172 +0,0 @@ - - - - - - - mysql_pconnect - Abre una conexión persistente a un servidor MySQL - - - - - &mysql.alternative.note; - - mysqli_connect con el prefijo de host p: - PDO::__construct con PDO::ATTR_PERSISTENT como una opción de controlador - - - - - - &reftitle.description; - - resourcemysql_pconnect - stringserverini_get("mysql.default_host") - stringusernameini_get("mysql.default_user") - stringpasswordini_get("mysql.default_password") - intclient_flags0 - - - - Establece una conexión persistente a un servidor MySQL. - - - - mysql_pconnect se parece mucho a - mysql_connect con dos grandes diferencias. - - - En primer lugar, cuando se conecta, la función primero intenta encontrar un - enlace (persistente) que ya esté abierto con el mismo anfitrión, - nombre de usuario y contraseña. Si se encuentra uno, se devolverá un identificador - para él, en lugar de abrir una nueva conexión. - - - Segundo, la conexión al servidor SQL no será cerrada cuando - la ejecución del script finalice. En su lugar, el enlace permanecerá - abierto para su uso futuro (mysql_close no - cerrará los enlaces establecidos mediante mysql_pconnect). - - - Por eso a este tipo de enlace se le llama 'persistente'. - - - - - &reftitle.parameters; - - - server - - - El servidor de MySQL. También puede incluir un número de puerto. P.ej. - "nombre_anfitrión:puerto" o una ruta a un socket local, p.ej. ":/ruta/al/socket" para - el localhost. - - - Si la directiva de PHP - mysql.default_host no se ha definido (predeterminado), entonces el - valor por defecto es 'localhost:3306' - - - - - username - - - El nombre de usuario. El valor por defecto es el nombre del usuario al que pertenece el - proceso del servidor. - - - - - password - - - La contraseña. El valor por defecto es una contraseña vacia. - - - - - client_flags - - - El parámetro client_flags puede ser una combinación - de las siguientes constantes: - 128 (habilita el manejo de LOAD DATA LOCAL), - MYSQL_CLIENT_SSL, - MYSQL_CLIENT_COMPRESS, - MYSQL_CLIENT_IGNORE_SPACE o - MYSQL_CLIENT_INTERACTIVE. - - - - - - - - &reftitle.returnvalues; - - Devuelve un identificador de enlace persistente a MySQL en caso de éxito o &false; en - caso de error. - - - - - &reftitle.notes; - - - Tenga en cuenta que este tipo de enlaces solo funcionan si se está usando - una versión de módulo de PHP. Véase la - sección Conexiones - persistentes a bases de datos para más información. - - - - - El uso de conexiones persistentes puede requerir ajustar un poco las configuraciones - de Apache y de MySQL para asegurarse de que no se excede el número de conexiones - permitidas por MySQL. - - - - - - &reftitle.seealso; - - mysql_connect - Conexiones - persistentes a bases de datos - - - - diff --git a/reference/mysql/functions/mysql-ping.xml b/reference/mysql/functions/mysql-ping.xml deleted file mode 100644 index 83f74ea0de..0000000000 --- a/reference/mysql/functions/mysql-ping.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - mysql_ping - Efectuar un chequeo de respuesta (ping) sobre una conexión al servidor o reconectarse si no hay conexión - - - - - &mysql.alternative.note; - - mysqli_ping - - - - - - &reftitle.description; - - boolmysql_ping - resourcelink_identifierNULL - - - Chequea si está activa o no la conexión con - el servidor. Si ésta se ha caído, se intenta una reconexión - automática. Esta función puede ser usada por scripts que permanecen pasivos - durante largos espacios de tiempo, para chequear si el servidor ha cerrado la conexión - y reconectarse de ser necesario. - - - - La reconexión automática está deshabilitada de forma predeterminada en versiones de MySQL >= 5.0.3. - - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Devuelve &true; si la conexión con el servidor MySQL está funcionando, o - &false; si no. - - - - - &reftitle.examples; - - Un ejemplo de <function>mysql_ping</function> - - -]]> - - - - - - &reftitle.seealso; - - mysql_thread_id - mysql_list_processes - - - - diff --git a/reference/mysql/functions/mysql-query.xml b/reference/mysql/functions/mysql-query.xml deleted file mode 100644 index a11b54a00f..0000000000 --- a/reference/mysql/functions/mysql-query.xml +++ /dev/null @@ -1,191 +0,0 @@ - - - - - - - mysql_query - Enviar una consulta MySQL - - - - - &mysql.alternative.note; - - mysqli_query - PDO::query - - - - - - &reftitle.description; - - mixedmysql_query - stringquery - resourcelink_identifierNULL - - - mysql_query envía una única consulta (no hay soporte para - múltiples consultas) a la base de datos - actualmente activa en el servidor asociado con el - identificador de enlace especificado por link_identifier. - - - - - &reftitle.parameters; - - - query - - - Una consulta SQL - - - El string de la consulta no debería terminar con un punto y coma. - Los datos insertados en la consulta deberían estar correctamente escapados. - - - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Para SELECT, SHOW, DESCRIBE, EXPLAIN y otras sentencias que retornan un conjunto de resultados, - mysql_query - devuelve un resource en caso de éxito, o &false; en caso de - error. - - - Para otros tipos de sentencias SQL, tales como INSERT, UPDATE, DELETE, DROP, etc, - mysql_query devuelve &true; en caso de éxito - o &false; en caso de error. - - - El conjunto de resultados devuelto debería ser pasado a - mysql_fetch_array, y otras - funciones para manejar las tablas del resultado, para acceder a los datos retornados. - - - Use mysql_num_rows para averiguar cuántas filas - fueron devueltas por la sentencia SELECT, o - mysql_affected_rows para averiguar cuántas - filas fueron afectadas por las sentencias DELETE, INSERT, REPLACE, - o UPDATE. - - - mysql_query también fallará y retornará &false; - si el usuario no está autorizado para acceder a la/s tabla/s a la/s que hace - referencia la consulta. - - - - - &reftitle.examples; - - Consulta inválida - - La siguiente consulta no es sintácticamente válida, por lo que - mysql_query fallará y retornará &false;. - - - -]]> - - - - Consulta válida - - La siguiente consulta es válida, por lo que mysql_query - retornará un resource. - - - -]]> - - - - - - &reftitle.seealso; - - mysql_connect - mysql_error - mysql_real_escape_string - mysql_result - mysql_fetch_assoc - mysql_unbuffered_query - - - - - diff --git a/reference/mysql/functions/mysql-real-escape-string.xml b/reference/mysql/functions/mysql-real-escape-string.xml deleted file mode 100644 index ccc51e9766..0000000000 --- a/reference/mysql/functions/mysql-real-escape-string.xml +++ /dev/null @@ -1,226 +0,0 @@ - - - - - - - mysql_real_escape_string - Escapa caracteres especiales en una cadena para su uso en una sentencia SQL - - - - - &mysql.alternative.note; - - mysqli_real_escape_string - PDO::quote - - - - - - &reftitle.description; - - stringmysql_real_escape_string - stringunescaped_string - resourcelink_identifierNULL - - - Escapa caracteres especiales en la cadena dada por unescaped_string, - teniendo en cuenta el conjunto de caracteres en uso de la conexión, para que - sea seguro usarla en mysql_query. Si se van a insertar - datos binarios, se ha de usar esta función. - - - mysql_real_escape_string llama a la función mysql_real_escape_string - de la biblioteca de MySQL, la cual antepone barras invertidas a los siguientes caracteres: - \x00, \n, - \r, \, ', - " y \x1a. - - - Esta función siempre debe usarse (con pocas excepciones) para hacer seguros - los datos antes de enviar una consulta a MySQL. - - - - Seguridad: el conjunto de caracters predeterminado - - El conjunto de caracteres debe ser establecido o bien a nivel del servidor, o bien con - la función mysql_set_charset de la API para que afecte a - mysql_real_escape_string. Véase la sección sobre los conceptos - de conjuntos de caracters para - más información. - - - - - - &reftitle.parameters; - - - unescaped_string - - - La cadena a escapar. - - - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Devuelve la cadena escapada, o &false; en caso de error. - - - - - &reftitle.errors; - - Ejecutar esta función sin una conexión de MySQL presente también - emitirá errores de nivel E_WARNING de PHP. Solo - se ha de ejecutar con una conexión de MySQL válida presente. - - - - - &reftitle.examples; - - Ejemplo sencillo de <function>mysql_real_escape_string</function> - - -]]> - - - - <function>mysql_real_escape_string</function> requiere una conexión - - Este ejemplo muestra lo que sucede si no hay presente una conexión - de MySQL al invocar a esta función. - - - -]]> - - &example.outputs.similar; - - - - - - Un ejemplo de ataque de inyección de SQL - - -]]> - - - La consulta enviada a MySQL: - - - - - - Esto permitiría a alguien acceder a una sesión sin una contraseña válida. - - - - - - &reftitle.notes; - - - Se requiere una conexión a MySQL antes de usar - mysql_real_escape_string, si no, se generará - un error de nivel E_WARNING, y se devolverá &false;. - Si link_identifier no está definido, se - usará la última conexión a MySQL. - - - - - Si esta función no se utiliza para escapar los datos, la consulta es vulnerable a - Ataques de inyección SQL. - - - - - mysql_real_escape_string no escapa - % ni _. Estos son comodines en - MySQL si se combinan con LIKE, GRANT, - o REVOKE. - - - - - - &reftitle.seealso; - - mysql_set_charset - mysql_client_encoding - - - - diff --git a/reference/mysql/functions/mysql-result.xml b/reference/mysql/functions/mysql-result.xml deleted file mode 100644 index ae41803311..0000000000 --- a/reference/mysql/functions/mysql-result.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - - - mysql_result - Obtener datos de resultado - - - - - &mysql.alternative.note; - - - mysqli_data_seek junto con - mysqli_field_seek y - mysqli_fetch_field - - PDOStatement::fetchColumn - - - - - - &reftitle.description; - - stringmysql_result - resourceresult - introw - mixedfield0 - - - Recupera el contenido de una celda de un conjunto de resultados de MySQL. - - - Cuando se esté trabajando con conjuntos de resultados grandes, se debería considerar usar una - de las funciones que obtienen una fila completa (especificadas más abajo). Debido a que - estas funciones retornan el contenido de múltiples celdas en una única - llamada a función, son MUCHO MÁS rápidas que - mysql_result. Además, se ha de tener en cuenta que la especificación - de un índice numérico para el campo pasado como argumento es mucho más rápido que - especificar un nombre de campo o el argumento nombre_tabla.nombre_campo. - - - - - &reftitle.parameters; - - &mysql.result.description; - - row - - - El número de fila del conjunto de resultados que está siendo recuperado. El número de filas - empieza a partir de 0. - - - - - field - - - El nombre o el índice del campo que está siendo recuperado. - - - Puede ser el índice del campo, el nombre del campo, o el nombre de la tabla - punto nombre del campo (nombre_tabla.nombre_campo). Si se ha utilizado un alias - para el nombre de la columna ('select foo as bar from...'), utilice el alias en lugar - del nombre del campo. Si no está definido, se recuperará el primer campo. - - - - - - - - &reftitle.returnvalues; - - El contenido de una celda de un conjunto de resultados de MySQL en caso de éxito, o - &false; en caso de fallo. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_result</function> - - -]]> - - - - - - &reftitle.notes; - - - Las llamadas a mysql_result no deberían ser mezcladas - con llamadas a otras funciones que manejen conjuntos de resultados. - - - - - - &reftitle.seealso; - - mysql_fetch_row - mysql_fetch_array - mysql_fetch_assoc - mysql_fetch_object - - - - diff --git a/reference/mysql/functions/mysql-select-db.xml b/reference/mysql/functions/mysql-select-db.xml deleted file mode 100644 index 81dfb797e7..0000000000 --- a/reference/mysql/functions/mysql-select-db.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - - mysql_select_db - Seleccionar una base de datos MySQL - - - - - &mysql.alternative.note; - - mysqli_select_db - PDO::__construct (parte de dsn) - - - - - - &reftitle.description; - - boolmysql_select_db - stringdatabase_name - resourcelink_identifierNULL - - - Establece la base de datos activa actual en el servidor asociado con el - identificador de enlace especificado. Cada llamada posterior a - mysql_query será ejecutada en la base de datos activa. - - - - - &reftitle.parameters; - - - database_name - - - El nombre de la base de datos que va a ser seleccionada. - - - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo <function>mysql_select_db</function> - - -]]> - - - - - - &reftitle.notes; - - - &info.deprecated.alias; - mysql_selectdb - - - - - - &reftitle.seealso; - - mysql_connect - mysql_pconnect - mysql_query - - - - diff --git a/reference/mysql/functions/mysql-set-charset.xml b/reference/mysql/functions/mysql-set-charset.xml deleted file mode 100644 index 945726aea1..0000000000 --- a/reference/mysql/functions/mysql-set-charset.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - mysql_set_charset - Establece el conjunto de caracteres del cliente - - - - - &mysql.alternative.note; - - mysqli_set_charset - PDO: Añadir charset al string de conexión, tal como charset=utf8 - - - - - - &reftitle.description; - - boolmysql_set_charset - stringcharset - resourcelink_identifierNULL - - - Establece el conjunto de caracteres predeterminado para la conexión actual. - - - - - &reftitle.parameters; - - - charset - - - Un nombre válido de un conjunto de caracteres. - - - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.notes; - - - Esta función requiere MySQL 5.0.7 o posterior. - - - - - Esta es la mejor forma de cambiar el conjunto de caracteres. El uso de - mysql_query para establecerlo (como SET NAMES utf8) - no es recomendable. Véase la sección conceptos de conjuntos de caracteres de MySQL - para más información. - - - - - - &reftitle.seealso; - - Establecer conjuntos de caracteres en MySQL - Listado de los conjuntos de caracteres admitidos por MySQL - mysql_client_encoding - - - - - diff --git a/reference/mysql/functions/mysql-stat.xml b/reference/mysql/functions/mysql-stat.xml deleted file mode 100644 index 1dd8091d7e..0000000000 --- a/reference/mysql/functions/mysql-stat.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - - mysql_stat - Obtiene el estado actual del sistema - - - - - &mysql.alternative.note; - - mysqli_stat - - PDO::getAttribute - con attribute como PDO::ATTR_SERVER_INFO - - - - - - - &reftitle.description; - - stringmysql_stat - resourcelink_identifierNULL - - - mysql_stat devuelve el estado actual del servidor. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Devuelve un string con el estado del tiempo de funcionamiento, hilos, consultas, tablas abiertas, - tablas de volcado y consultas por segundo. Para obtener una lista completa de variables de - estado, es necesario usar el comando SQL SHOW STATUS. - Si link_identifier no es válido, se devuelve &null;. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_stat</function> - - -]]> - - &example.outputs.similar; - - Uptime: 5380 - [1] => Threads: 2 - [2] => Questions: 1321299 - [3] => Slow queries: 0 - [4] => Opens: 26 - [5] => Flush tables: 1 - [6] => Open tables: 17 - [7] => Queries per second avg: 245.595 -) -]]> - - - - Ejemplo alternativo de <function>mysql_stat</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - mysql_get_server_info - mysql_list_processes - - - - - diff --git a/reference/mysql/functions/mysql-tablename.xml b/reference/mysql/functions/mysql-tablename.xml deleted file mode 100644 index b3ceba688c..0000000000 --- a/reference/mysql/functions/mysql-tablename.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - - mysql_tablename - Obtiene el nombre de la tabla de un campo - - - - - &mysql.alternative.note; - - Consulta SQL: SHOW TABLES - - - - - - &reftitle.description; - - stringfalsemysql_tablename - resourceresult - inti - - - Recupera el nombre de tabla desde un resultado dado por result. - - - Esta función está obsoleta. Es preferible usar - mysql_query para ejecutar una consulta SQL SHOW TABLES - [FROM nombre_bd] [LIKE 'patrón'] en su lugar. - - - - - &reftitle.parameters; - - - result - - - Un resource de puntero de resultados que se devuelve desde - mysql_list_tables. - - - - - i - - - El índice de tipo integer (número de fila/tabla) - - - - - - - - &reftitle.returnvalues; - - El nombre de la tabla en caso de éxito &return.falseforfailure;. - - - Use la función mysql_tablename para - atravesar este puntero de resultados, o cualquier función para obtener tablas, - tal como mysql_fetch_array. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_tablename</function> - - -]]> - - - - - - &reftitle.notes; - - - La función mysql_num_rows puede ser usada para - determinar el número de tablas del puntero de resultados. - - - - - - &reftitle.seealso; - - mysql_list_tables - mysql_field_table - mysql_db_name - - - - diff --git a/reference/mysql/functions/mysql-thread-id.xml b/reference/mysql/functions/mysql-thread-id.xml deleted file mode 100644 index fbff789c1f..0000000000 --- a/reference/mysql/functions/mysql-thread-id.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - mysql_thread_id - Devuelve el ID del hilo actual - - - - - &mysql.alternative.note; - - mysqli_thread_id - - - - - - &reftitle.description; - - intfalsemysql_thread_id - resourcelink_identifierNULL - - - Recupera el ID del hilo actual. Si la conexión se ha perdido, y se ejecuta una - reconexión con mysql_ping, el ID del hilo - cambiará. Esto quiere decir que sólo se ha de recuperar el ID del hilo cuando sea necesario. - - - - - &reftitle.parameters; - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - El ID del hilo en caso de éxito &return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_thread_id</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - mysql_ping - mysql_list_processes - - - - diff --git a/reference/mysql/functions/mysql-unbuffered-query.xml b/reference/mysql/functions/mysql-unbuffered-query.xml deleted file mode 100644 index 0ea8607dee..0000000000 --- a/reference/mysql/functions/mysql-unbuffered-query.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - mysql_unbuffered_query - Envía una consulta SQL a MySQL, sin recuperar ni almacenar en búfer las filas de resultados - - - - - &mysql.alternative.note; - - Véase: Consultas almacenadas y no almacenadas en buffer - - - - - - &reftitle.description; - - resourcemysql_unbuffered_query - stringquery - resourcelink_identifierNULL - - - mysql_unbuffered_query envía la consulta SQL - query a MySQL, sin recuperar ni almacenar automáticamente - en búfer las filas de resultados, como - mysql_query lo hace. Esto ahorra una considerable - cantidad de memoria con las consultas SQL que producen conjuntos de resultados grandes, - y se puede empezar a trabajar con el conjunto de resultados inmediatamente después de - que la primera fila haya sido recuperada, ya que no es necesario esperar hasta que la - consulta SQL completa haya sido ejecutada. Para usar - mysql_unbuffered_query mientras están abiertas - múltiples conexiones a la base de datos, se debe especificar el parámetro opcional - link_identifier para identificar qué conexión - se desea utilizar. - - - - - &reftitle.parameters; - - - query - - - La consulta SQL a ejecutar. - - - Los datos dentro de la consulta deben estar propiamente escapados. - - - - &mysql.linkid.description; - - - - - &reftitle.returnvalues; - - Para sentencias SELECT, SHOW, DESCRIBE o EXPLAIN, - mysql_unbuffered_query - devuelve un resource en caso de éxito, o &false; en caso - de error. - - - Para otro tipo de sentencias SQL, UPDATE, DELETE, DROP, etc, - mysql_unbuffered_query devuelve &true; en caso de éxito - o &false; en caso de error. - - - - - &reftitle.notes; - - - Los beneficios de mysql_unbuffered_query tienen - un precio: no se puede usar mysql_num_rows ni - mysql_data_seek en un conjunto de resultados devuelto por - mysql_unbuffered_query, hasta que todas las filas sean recuperadas. - También se tendrán que recuperar todas las filas de resultados de una consulta SQL no almacenada en búfer - antes de poder enviar una nueva consulta SQL a MySQL, usando el mismo - link_identifier. - - - - - - &reftitle.seealso; - - mysql_query - - - - diff --git a/reference/mysql/ini.xml b/reference/mysql/ini.xml deleted file mode 100644 index aff083d07b..0000000000 --- a/reference/mysql/ini.xml +++ /dev/null @@ -1,273 +0,0 @@ - - - - -
    - &reftitle.runtime; - &extension.runtime; - - - &ConfigureOptions; MySQL - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - mysql.allow_local_infile - "1" - INI_SYSTEM - - - - mysql.allow_persistent - "1" - INI_SYSTEM - - - - mysql.max_persistent - "-1" - INI_SYSTEM - - - - mysql.max_links - "-1" - INI_SYSTEM - - - - mysql.trace_mode - "Off" - INI_ALL - - - - mysql.default_port - NULL - INI_ALL - - - - mysql.default_socket - NULL - INI_ALL - - - - mysql.default_host - NULL - INI_ALL - - - - mysql.default_user - NULL - INI_ALL - - - - mysql.default_password - NULL - INI_ALL - - - - mysql.connect_timeout - "60" - INI_ALL - - - - -
    - &ini.php.constants; -
    - -&ini.descriptions.title; - - - - - - mysql.allow_local_infile - int - - - - Permite el acceso, desde el punto de vista de PHP, a los ficheros locales, - con las consultas LOAD DATA. - - - - - - - mysql.allow_persistent - bool - - - - Activa o desactiva las - conexiones persistentes - a la base de datos MySQL. - - - - - - - mysql.max_persistent - int - - - - El número máximo de conexiones persistentes a las bases de datos - MySQL, por proceso. - - - - - - - mysql.max_links - int - - - - El número máximo de conexiones a las bases de datos MySQL, - incluyendo las conexiones persistentes, por proceso. - - - - - - - mysql.trace_mode - bool - - - - Modo de seguimiento. Cuando mysql.trace_mode está activado, - se mostrarán alertas para escaneos de tabla o de índice, para olvidos de liberación - de recursos o errores SQL. Esta opción fue introducida en PHP 4.3.0. - - - - - - - mysql.default_port - string - - - - El número de puerto TCP por defecto, utilizado para conectarse - a la base de datos, cuando no se especifica ningún puerto. Si no se - especifica ningún puerto por defecto, el puerto se obtendrá entonces - leyendo la variable de entorno MYSQL_TCP_PORT, - la entrada mysql-tcp en el fichero - /etc/services o la constante - de compilación MYSQL_PORT, en este orden. Windows - utilizará también solo la constante MYSQL_PORT. - - - - - - - mysql.default_socket - string - - - - El nombre por defecto del socket cuando se conecta - al servidor local, si no se especifica ningún otro socket. - - - - - - - mysql.default_host - string - - - - Dirección por defecto del servidor, a utilizar al conectarse a - un servidor MySQL, si no se especifica ningún host. - No se aplica cuando el &sqlsafemode; está activado. - - - - - - - mysql.default_user - string - - - - Usuario por defecto, a utilizar al conectarse a un servidor - MySQL, si no se especifica ningún usuario. - No se aplica cuando el &sqlsafemode; está activado. - - - - - - - mysql.default_password - string - - - - Contraseña por defecto, a utilizar al conectarse a un servidor - MySQL, si no se especifica ninguna contraseña. - No se aplica cuando el &sqlsafemode; está activado. - - - - - - - mysql.connect_timeout - int - - - - Tiempo máximo de espera de la respuesta de un servidor, en segundos. - En Linux, este tiempo sirve también durante el intercambio del primero con - el servidor. - - - - - -
    - diff --git a/reference/mysql/reference.xml b/reference/mysql/reference.xml deleted file mode 100644 index f94fccb7bc..0000000000 --- a/reference/mysql/reference.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - - &Functions; MySQL - - -
    - &reftitle.notes; - - - La mayoría de las funciones MySQL aceptan - link_identifier como último argumento - opcional. Si no se proporciona, se utiliza la última conexión abierta. Si no - existe, se intenta establecer una conexión con los parámetros por omisión - definidos en &php.ini;. Si las funciones no tienen éxito, devuelven &false;. - - -
    -
    - -&reference.mysql.entities.functions; - -
    - diff --git a/reference/mysql/setup.xml b/reference/mysql/setup.xml deleted file mode 100644 index b6161f7101..0000000000 --- a/reference/mysql/setup.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - Para poder utilizarlos, es necesario compilar PHP con el soporte MySQL. - - - &mysql.alternative.note; - -
    - - - - &reference.mysql.configure; - - - - &reference.mysql.ini; - - - -
    - &reftitle.resources; - - Existen dos tipos de recursos utilizados por el módulo MySQL. - El primero es un identificador de conexión al servidor, denominado - mysql link, - y el segundo es un identificador de resultado de consulta, denominado - mysql result. - -
    - - -
    - diff --git a/reference/mysql_xdevapi/book.xml b/reference/mysql_xdevapi/book.xml deleted file mode 100644 index 685cc77144..0000000000 --- a/reference/mysql_xdevapi/book.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - - Mysql_xdevapi - Mysql_xdevapi - - - &reftitle.intro; - - Esta extensión proporciona acceso al Document Store de MySQL a través de la DevAPI X. - La DevAPI X es una API común proporcionada por varios MySQL Connectors que permiten - un acceso fácil a las tablas relacionales así como a las colecciones de documentos, - que se representan en JSON, desde una API con operaciones de estilo CRUD. - - - La DevAPI de X utiliza el protocolo X, el protocolo de nueva generación cliente-servidor - de MySQL servidor 8.0. - - - Para información general sobre MySQL Document Store, consulte el capítulo - MySQL Document Store - del manual de MySQL. - - - - &reference.mysql-xdevapi.setup; - &reference.mysql-xdevapi.constants; - &reference.mysql-xdevapi.changelog; - &reference.mysql-xdevapi.examples; - &reference.mysql-xdevapi.reference; - - &reference.mysql-xdevapi.mysql-xdevapi.baseresult; - &reference.mysql-xdevapi.mysql-xdevapi.client; - &reference.mysql-xdevapi.mysql-xdevapi.collection; - &reference.mysql-xdevapi.mysql-xdevapi.collectionadd; - &reference.mysql-xdevapi.mysql-xdevapi.collectionfind; - &reference.mysql-xdevapi.mysql-xdevapi.collectionmodify; - &reference.mysql-xdevapi.mysql-xdevapi.collectionremove; - &reference.mysql-xdevapi.mysql-xdevapi.columnresult; - &reference.mysql-xdevapi.mysql-xdevapi.crudoperationbindable; - &reference.mysql-xdevapi.mysql-xdevapi.crudoperationlimitable; - &reference.mysql-xdevapi.mysql-xdevapi.crudoperationskippable; - &reference.mysql-xdevapi.mysql-xdevapi.crudoperationsortable; - &reference.mysql-xdevapi.mysql-xdevapi.databaseobject; - &reference.mysql-xdevapi.mysql-xdevapi.docresult; - &reference.mysql-xdevapi.mysql-xdevapi.driver; - &reference.mysql-xdevapi.mysql-xdevapi.exception; - &reference.mysql-xdevapi.mysql-xdevapi.executable; - &reference.mysql-xdevapi.mysql-xdevapi.executionstatus; - &reference.mysql-xdevapi.mysql-xdevapi.expression; - &reference.mysql-xdevapi.mysql-xdevapi.fieldmetadata; - &reference.mysql-xdevapi.mysql-xdevapi.result; - &reference.mysql-xdevapi.mysql-xdevapi.rowresult; - &reference.mysql-xdevapi.mysql-xdevapi.schema; - &reference.mysql-xdevapi.mysql-xdevapi.schemaobject; - &reference.mysql-xdevapi.mysql-xdevapi.session; - &reference.mysql-xdevapi.mysql-xdevapi.sqlstatement; - &reference.mysql-xdevapi.mysql-xdevapi.sqlstatementresult; - &reference.mysql-xdevapi.mysql-xdevapi.statement; - &reference.mysql-xdevapi.mysql-xdevapi.table; - &reference.mysql-xdevapi.mysql-xdevapi.tabledelete; - &reference.mysql-xdevapi.mysql-xdevapi.tableinsert; - &reference.mysql-xdevapi.mysql-xdevapi.tableselect; - &reference.mysql-xdevapi.mysql-xdevapi.tableupdate; - &reference.mysql-xdevapi.mysql-xdevapi.warning; - - - - diff --git a/reference/mysql_xdevapi/changelog.xml b/reference/mysql_xdevapi/changelog.xml deleted file mode 100644 index 0af9d1cc76..0000000000 --- a/reference/mysql_xdevapi/changelog.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - &ChangelogListingTitle; - &ChangelogListingDescription; - - - Historial de cambios general de la extensión ext/mysql_xdevapi - - Este historial de cambios hace referencia a la extensión ext/mysql_xdevapi. - - - - - Cambios globales de la extensión ext/mysql_xdevapi - - - - - - &Version; - &Description; - - - - - 8.0.28 - - - Eliminación del soporte de TLSv1 y TLSv1.1. Los valores "TLSv1", - "TLSv1.0" y "TLSv1.1" se consideran ahora inválidos - para el atributo de conexión "tls-versions". - - - - - 8.0.26 - - - Deprecación del soporte de TLSv1 y TLSv1.1. - - - - - - - - - - - - diff --git a/reference/mysql_xdevapi/constants.xml b/reference/mysql_xdevapi/constants.xml deleted file mode 100644 index 61e274fc82..0000000000 --- a/reference/mysql_xdevapi/constants.xml +++ /dev/null @@ -1,414 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - - - - MYSQLX_CLIENT_SSL - (int) - - - - - - - - - MYSQLX_TYPE_DECIMAL - (int) - - - - - - - - - MYSQLX_TYPE_TINY - (int) - - - - - - - - - MYSQLX_TYPE_SHORT - (int) - - - - - - - - - MYSQLX_TYPE_SMALLINT - (int) - - - - - - - - - MYSQLX_TYPE_MEDIUMINT - (int) - - - - - - - - - MYSQLX_TYPE_INT - (int) - - - - - - - - - MYSQLX_TYPE_BIGINT - (int) - - - - - - - - - MYSQLX_TYPE_LONG - (int) - - - - - - - - - MYSQLX_TYPE_FLOAT - (int) - - - - - - - - - MYSQLX_TYPE_DOUBLE - (int) - - - - - - - - - MYSQLX_TYPE_NULL - (int) - - - - - - - - - MYSQLX_TYPE_TIMESTAMP - (int) - - - - - - - - - MYSQLX_TYPE_LONGLONG - (int) - - - - - - - - - MYSQLX_TYPE_INT24 - (int) - - - - - - - - - MYSQLX_TYPE_DATE - (int) - - - - - - - - - MYSQLX_TYPE_TIME - (int) - - - - - - - - - MYSQLX_TYPE_DATETIME - (int) - - - - - - - - - MYSQLX_TYPE_YEAR - (int) - - - - - - - - - MYSQLX_TYPE_NEWDATE - (int) - - - - - - - - - MYSQLX_TYPE_ENUM - (int) - - - - - - - - - MYSQLX_TYPE_SET - (int) - - - - - - - - - MYSQLX_TYPE_TINY_BLOB - (int) - - - - - - - - - MYSQLX_TYPE_MEDIUM_BLOB - (int) - - - - - - - - - MYSQLX_TYPE_LONG_BLOB - (int) - - - - - - - - - MYSQLX_TYPE_BLOB - (int) - - - - - - - - - MYSQLX_TYPE_VAR_STRING - (int) - - - - - - - - - MYSQLX_TYPE_STRING - (int) - - - - - - - - - MYSQLX_TYPE_CHAR - (int) - - - - - - - - - MYSQLX_TYPE_BYTES - (int) - - - - - - - - - MYSQLX_TYPE_INTERVAL - (int) - - - - - - - - - MYSQLX_TYPE_GEOMETRY - (int) - - - - - - - - - MYSQLX_TYPE_JSON - (int) - - - - - - - - - MYSQLX_TYPE_NEWDECIMAL - (int) - - - - - - - - - MYSQLX_TYPE_BIT - (int) - - - - - - - - - MYSQLX_LOCK_DEFAULT - (int) - - - - - - - - - MYSQLX_LOCK_NOWAIT - (int) - - - - - - - - - MYSQLX_LOCK_SKIP_LOCKED - (int) - - - - - - - - - - - diff --git a/reference/mysql_xdevapi/examples.xml b/reference/mysql_xdevapi/examples.xml deleted file mode 100644 index 6a9e819968..0000000000 --- a/reference/mysql_xdevapi/examples.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - &reftitle.examples; - - El punto de entrada central de la API X es la función mysql_xdevapi\getSession, - que recibe una URI hacia un servidor MySQL 8.0 y devuelve un objeto - mysql_xdevapi\Session. - - - Conectar a un Servidor MySQL - -getMessage()); -} - -// ... usar $session -?> -]]> - - - - La sesión proporciona acceso completo a la API. Para una nueva instalación de servidor MySQL, - el primer paso es crear un esquema de base de datos con una colección - para almacenar datos: - - - Crear un Esquema y una Colección en el Servidor MySQL - -createSchema("test"); -$collection = $schema->createCollection("example"); -?> -]]> - - - - Al almacenar datos, generalmente json_encode se utiliza para codificar - los datos en JSON, que luego pueden ser almacenados en una colección. - - - Los siguientes ejemplos almacenan datos en la colección que hemos creado anteriormente, - y luego recuperan partes de estos datos nuevamente. - - - Almacenar y Recuperar Datos - - "Marco", - "age" => 19, - "job" => "Programmer" -]; -$mike = [ - "name" => "Mike", - "age" => 39, - "job" => "Manager" -]; - -$schema = $session->getSchema("test"); -$collection = $schema->getCollection("example"); - -$collection->add($marco, $mike)->execute(); - -var_dump($collection->find("name = 'Mike'")->execute()->fetchOne()); -?> -]]> - - &example.outputs.similar; - - - string(28) "00005ad66aaf0000000000000003" - ["age"]=> - int(39) - ["job"]=> - string(7) "Manager" - ["name"]=> - string(4) "Mike" -} -]]> - - - - Este ejemplo demuestra que el servidor MySQL añade un campo adicional llamado - _id, que sirve como clave primaria del documento. - - - Este ejemplo también demuestra que los datos recuperados están ordenados alfabéticamente. - Este orden específico proviene del almacenamiento binario eficiente dentro del servidor MySQL, pero - no debe confiarse en él. Consulte la documentación del tipo de datos JSON de MySQL para más detalles. - - - Opcionalmente, utilice los iteradores de PHP para recuperar múltiples documentos: - - - Recuperar e Iterar sobre Múltiples Documentos - -find()->execute(); -foreach ($result as $doc) { - echo "{$doc["name"]} es un {$doc["job"]}.\n"; -} -?> -]]> - - &example.outputs.similar; - - - - - - - diff --git a/reference/mysql_xdevapi/functions/mysql-xdevapi.expression.xml b/reference/mysql_xdevapi/functions/mysql-xdevapi.expression.xml deleted file mode 100644 index 502ad74881..0000000000 --- a/reference/mysql_xdevapi/functions/mysql-xdevapi.expression.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - expression - Vincula una expresión a una variable de consulta preparada - - - - &reftitle.description; - - objectmysql_xdevapi\expression - stringexpression - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - expression - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Expression</function> - -find("age > 30")->fields($expression)->limit(3)->execute(); -$data = $res->fetchAll(); - -print_r($data); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/functions/mysql-xdevapi.getsession.xml b/reference/mysql_xdevapi/functions/mysql-xdevapi.getsession.xml deleted file mode 100644 index b9a7e286aa..0000000000 --- a/reference/mysql_xdevapi/functions/mysql-xdevapi.getsession.xml +++ /dev/null @@ -1,251 +0,0 @@ - - - - - - getSession - Conecta a un servidor MySQL - - - - &reftitle.description; - - mysql_xdevapi\Sessionmysql_xdevapi\getSession - stringuri - - - Conecta al servidor MySQL. - - - - - &reftitle.parameters; - - - uri - - - El URI del servidor MySQL, tal como mysqlx://user:password@host. - - - Formato de URI: - - - scheme://[user[:[password]]@]target[:port][?attribute1=value1&attribute2=value2... - - - - scheme: requerido, el protocolo de conexión - En mysql_xdevapi es siempre 'mysqlx' (para el protocolo X) - - - user: opcional, la cuenta de usuario MySQL para la autenticación - - - password: opcional, la contraseña del usuario MySQL para la autenticación - - - target: requerido, la instancia del servidor a la que se refiere la conexión: - * Conexión TCP (nombre de host, dirección IPv4 o dirección IPv6) - * Ruta de socket Unix (ruta de fichero local) - * Pipe nombrado Windows (ruta de fichero local) - - - port: opcional, el puerto de red del servidor MySQL. - Por omisión, el puerto para el protocolo X es 33060 - - - - ?attribute=value: este elemento es opcional y especifica un diccionario de datos - que contiene diferentes opciones, incluyendo: - - - - - El atributo auth (mecanismo de autenticación) relacionado con las conexiones cifradas. - Para más información, ver Opciones de comando para las conexiones cifradas. - Los siguientes valores 'auth' son soportados: plain, - mysql41, external, y sha256_mem. - - - - - El atributo connect-timeout afecta la conexión y - no las operaciones siguientes. Se define por conexión, ya sea en - un solo host o en varios. - - - Pasar un entero positivo para definir el tiempo límite de conexión en segundos, - o pasar 0 (cero) para desactivar el tiempo límite (infinito). No definir - connect-timeout utiliza el valor por omisión de 10. - - - En relación, las variables de entorno MYSQLX_CONNECTION_TIMEOUT (tiempo límite en segundos) y MYSQLX_TEST_CONNECTION_TIMEOUT (utilizado durante la ejecución de pruebas) - pueden ser definidas y utilizadas en lugar de connect-timeout en el URI. La opción - connect-timeout del URI tiene prioridad sobre estas variables de entorno. - - - - - El atributo opcional compression acepta estos valores: - preferred (el cliente negocia con el servidor para encontrar un algoritmo soportado; la conexión no está comprimida si no se encuentra un algoritmo soportado mutuamente), - required (como "preferred", pero la conexión se termina si no se encuentra un algoritmo soportado mutuamente), o - disabled (la conexión no está comprimida). Por omisión, preferred. - - - Esta opción fue añadida en la versión 8.0.20. - - - - - El atributo opcional compression-algorithms define los algoritmos - de compresión deseados (y su orden de uso preferido): - zstd_stream (alias: zstd), - lz4_message (alias: lz4), o - deflate_stream (alias: deflate o zlib). - Por omisión, el orden utilizado (según la disponibilidad del sistema) es lz4_message, zstd_stream, y luego deflate_stream. - Por ejemplo, pasar compression-algorithms=[lz4,zstd_stream] utiliza lz4 si está disponible, de lo contrario - se utiliza zstd_stream. Si ninguno de los dos está disponible, el comportamiento depende del valor de compression - por ejemplo, si compression=required entonces fallará con un error. - - - Esta opción fue añadida en la versión 8.0.22. - - - - - - - - Ejemplo de URI - -mysqlx://foobar -mysqlx://root@localhost?socket=%2Ftmp%2Fmysqld.sock%2F -mysqlx://foo:bar@localhost:33060 -mysqlx://foo:bar@localhost:33160?ssl-mode=disabled -mysqlx://foo:bar@localhost:33260?ssl-mode=required -mysqlx://foo:bar@localhost:33360?ssl-mode=required&auth=mysql41 -mysqlx://foo:bar@(/path/to/socket) -mysqlx://foo:bar@(/path/to/socket)?auth=sha256_mem -mysqlx://foo:bar@[localhost:33060, 127.0.0.1:33061] -mysqlx://foobar?ssl-ca=(/path/to/ca.pem)&ssl-crl=(/path/to/crl.pem) -mysqlx://foo:bar@[localhost:33060, 127.0.0.1:33061]?ssl-mode=disabled -mysqlx://foo:bar@localhost:33160/?connect-timeout=0 -mysqlx://foo:bar@localhost:33160/?connect-timeout=10&compression=required -mysqlx://foo:bar@localhost:33160/?connect-timeout=10&compression=required&compression-algorithms=[lz4,zstd_stream] - - - - - Para más información, ver conexión a MySQL Shell - utilizando una cadena de URI. - - - - - - - - - &reftitle.returnvalues; - - Un objeto Session. - - - - - &reftitle.errors; - - Un error de conexión lanza una excepción Exception. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\getSession</function> - -getMessage()); -} - -$schemas = $session->getSchemas(); -print_r($schemas); - -$mysql_version = $session->getServerVersion(); -print_r($mysql_version); - -var_dump($collection->find("name = 'Alfred'")->execute()->fetchOne()); -?> -]]> - - &example.outputs.similar; - - mysql_xdevapi\Schema Object - ( - [name] => helloworld - ) - [1] => mysql_xdevapi\Schema Object - ( - [name] => information_schema - ) - [2] => mysql_xdevapi\Schema Object - ( - [name] => mysql - ) - [3] => mysql_xdevapi\Schema Object - ( - [name] => performance_schema - ) - [4] => mysql_xdevapi\Schema Object - ( - [name] => sys - ) -) - -80012 - -array(4) { - ["_id"]=> - string(28) "00005ad66abf0001000400000003" - ["age"]=> - int(42) - ["job"]=> - string(7) "Butler" - ["name"]=> - string(4) "Alfred" -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/ini.xml b/reference/mysql_xdevapi/ini.xml deleted file mode 100644 index 9c939a0a31..0000000000 --- a/reference/mysql_xdevapi/ini.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - -
    - &reftitle.runtime; - &extension.runtime; - - - &ConfigureOptions; Mysql_xdevapi - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - xmysqlnd.collect_memory_statistics - 0 - INI_SYSTEM - - - - xmysqlnd.collect_statistics - 1 - INI_ALL - - - - xmysqlnd.debug - - INI_SYSTEM - - - - xmysqlnd.mempool_default_size - 16000 - INI_ALL - - - - xmysqlnd.net_read_timeout - 31536000 - INI_SYSTEM - - - - xmysqlnd.trace_alloc - - INI_SYSTEM - - - - -
    -
    - - &ini.descriptions.title; - - - - - - xmysqlnd.collect_memory_statistics - int - - - - - - - - - - xmysqlnd.collect_statistics - int - - - - - - - - - - xmysqlnd.debug - string - - - - - - - - - - xmysqlnd.mempool_default_size - int - - - - - - - - - - xmysqlnd.net_read_timeout - int - - - - - - - - - - xmysqlnd.trace_alloc - string - - - - - - - - - - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.baseresult.xml b/reference/mysql_xdevapi/mysql-xdevapi.baseresult.xml deleted file mode 100644 index 84b57ba021..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.baseresult.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - Interfaz BaseResult - mysql_xdevapi\BaseResult - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\BaseResult - - - - - mysql_xdevapi\BaseResult - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.baseresult; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.client.xml b/reference/mysql_xdevapi/mysql-xdevapi.client.xml deleted file mode 100644 index 713f511c69..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.client.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - La clase Client - mysql_xdevapi\Client - - - - -
    - &reftitle.intro; - - Proporciona acceso a la conexión a la base de datos. - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\Client - - - - - mysql_xdevapi\Client - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.client; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.collection.xml b/reference/mysql_xdevapi/mysql-xdevapi.collection.xml deleted file mode 100644 index 0ddb9383cb..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.collection.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - - Clase Collection - mysql_xdevapi\Collection - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\Collection - - - - - mysql_xdevapi\Collection - - - - mysql_xdevapi\SchemaObject - - - - &Properties; - - public - name - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - name - - - - - -
    - - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.collection; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.collectionadd.xml b/reference/mysql_xdevapi/mysql-xdevapi.collectionadd.xml deleted file mode 100644 index c39ec3de41..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.collectionadd.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - Clase CollectionAdd - mysql_xdevapi\CollectionAdd - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\CollectionAdd - - - - - mysql_xdevapi\CollectionAdd - - - - mysql_xdevapi\Executable - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.collectionadd; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.collectionfind.xml b/reference/mysql_xdevapi/mysql-xdevapi.collectionfind.xml deleted file mode 100644 index ea0f1ecbe5..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.collectionfind.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - Clase CollectionFind - mysql_xdevapi\CollectionFind - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\CollectionFind - - - - - mysql_xdevapi\CollectionFind - - - - mysql_xdevapi\Executable - - - - mysql_xdevapi\CrudOperationBindable - - - - mysql_xdevapi\CrudOperationLimitable - - - - mysql_xdevapi\CrudOperationSortable - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.collectionfind; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.collectionmodify.xml b/reference/mysql_xdevapi/mysql-xdevapi.collectionmodify.xml deleted file mode 100644 index 5748328bbb..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.collectionmodify.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - - Clase CollectionModify - mysql_xdevapi\CollectionModify - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\CollectionModify - - - - - mysql_xdevapi\CollectionModify - - - - mysql_xdevapi\Executable - - - - mysql_xdevapi\CrudOperationBindable - - - - mysql_xdevapi\CrudOperationLimitable - - - - mysql_xdevapi\CrudOperationSkippable - - - - mysql_xdevapi\CrudOperationSortable - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.collectionmodify; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.collectionremove.xml b/reference/mysql_xdevapi/mysql-xdevapi.collectionremove.xml deleted file mode 100644 index 18208e0ff5..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.collectionremove.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - Clase CollectionRemove - mysql_xdevapi\CollectionRemove - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\CollectionRemove - - - - - mysql_xdevapi\CollectionRemove - - - - mysql_xdevapi\Executable - - - - mysql_xdevapi\CrudOperationBindable - - - - mysql_xdevapi\CrudOperationLimitable - - - - mysql_xdevapi\CrudOperationSortable - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.collectionremove; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.columnresult.xml b/reference/mysql_xdevapi/mysql-xdevapi.columnresult.xml deleted file mode 100644 index c0ba4f06c2..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.columnresult.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - Clase ColumnResult - mysql_xdevapi\ColumnResult - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\ColumnResult - - - - - mysql_xdevapi\ColumnResult - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.columnresult; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.crudoperationbindable.xml b/reference/mysql_xdevapi/mysql-xdevapi.crudoperationbindable.xml deleted file mode 100644 index df635f2d42..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.crudoperationbindable.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - Interfaz CrudOperationBindable - mysql_xdevapi\CrudOperationBindable - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\CrudOperationBindable - - - - - mysql_xdevapi\CrudOperationBindable - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.crudoperationbindable; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.crudoperationlimitable.xml b/reference/mysql_xdevapi/mysql-xdevapi.crudoperationlimitable.xml deleted file mode 100644 index 622792644f..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.crudoperationlimitable.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - Interfaz CrudOperationLimitable - mysql_xdevapi\CrudOperationLimitable - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\CrudOperationLimitable - - - - - mysql_xdevapi\CrudOperationLimitable - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.crudoperationlimitable; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.crudoperationskippable.xml b/reference/mysql_xdevapi/mysql-xdevapi.crudoperationskippable.xml deleted file mode 100644 index b7948d3f63..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.crudoperationskippable.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - Interfaz CrudOperationSkippable - mysql_xdevapi\CrudOperationSkippable - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\CrudOperationSkippable - - - - - mysql_xdevapi\CrudOperationSkippable - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.crudoperationskippable; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.crudoperationsortable.xml b/reference/mysql_xdevapi/mysql-xdevapi.crudoperationsortable.xml deleted file mode 100644 index c2019e78ec..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.crudoperationsortable.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - Interfaz CrudOperationSortable - mysql_xdevapi\CrudOperationSortable - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\CrudOperationSortable - - - - - mysql_xdevapi\CrudOperationSortable - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.crudoperationsortable; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.databaseobject.xml b/reference/mysql_xdevapi/mysql-xdevapi.databaseobject.xml deleted file mode 100644 index 8dd9e29b1a..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.databaseobject.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - Interfaz DatabaseObject - mysql_xdevapi\DatabaseObject - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\DatabaseObject - - - - - mysql_xdevapi\DatabaseObject - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.databaseobject; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.docresult.xml b/reference/mysql_xdevapi/mysql-xdevapi.docresult.xml deleted file mode 100644 index d926abb145..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.docresult.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - Clase DocResult - mysql_xdevapi\DocResult - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\DocResult - - - - - mysql_xdevapi\DocResult - - - - mysql_xdevapi\BaseResult - - - - Traversable - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.docresult; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.driver.xml b/reference/mysql_xdevapi/mysql-xdevapi.driver.xml deleted file mode 100644 index 274ab67614..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.driver.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - - Clase Driver - mysql_xdevapi\Driver - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\Driver - - - - - mysql_xdevapi\Driver - - - - &Constants; - - const - string - mysql_xdevapi\Driver::version - 8.0.3 - - - - - -
    - - -
    - &reftitle.constants; - - - - mysql_xdevapi\Driver::version - - - - - - -
    - - -
    - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.exception.xml b/reference/mysql_xdevapi/mysql-xdevapi.exception.xml deleted file mode 100644 index 0c3ab26736..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.exception.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - - Clase Exception - mysql_xdevapi\Exception - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\Exception - - - - - mysql_xdevapi\Exception - - - - extends - RuntimeException - - - - Throwable - - - - - - - - -
    - -
    - - - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.executable.xml b/reference/mysql_xdevapi/mysql-xdevapi.executable.xml deleted file mode 100644 index fbb7c2dc4b..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.executable.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - Interfaz Executable - mysql_xdevapi\Executable - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\Executable - - - - - mysql_xdevapi\Executable - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.executable; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.executionstatus.xml b/reference/mysql_xdevapi/mysql-xdevapi.executionstatus.xml deleted file mode 100644 index 8249067c55..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.executionstatus.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - - - Clase ExecutionStatus - mysql_xdevapi\ExecutionStatus - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\ExecutionStatus - - - - - mysql_xdevapi\ExecutionStatus - - - - &Properties; - - public - affectedItems - - - public - matchedItems - - - public - foundItems - - - public - lastInsertId - - - public - lastDocumentId - - - Constructor - - - - -
    - - -
    - &reftitle.properties; - - - affectedItems - - - - - - matchedItems - - - - - - foundItems - - - - - - lastInsertId - - - - - - lastDocumentId - - - - - -
    - - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.executionstatus; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.expression.xml b/reference/mysql_xdevapi/mysql-xdevapi.expression.xml deleted file mode 100644 index 7b053ad124..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.expression.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - - Clase Expression - mysql_xdevapi\Expression - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\Expression - - - - - mysql_xdevapi\Expression - - - - &Properties; - - public - name - - - Constructor - - - - -
    - - -
    - &reftitle.properties; - - - name - - - - - -
    - - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.expression; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.fieldmetadata.xml b/reference/mysql_xdevapi/mysql-xdevapi.fieldmetadata.xml deleted file mode 100644 index 542f21e0fb..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.fieldmetadata.xml +++ /dev/null @@ -1,204 +0,0 @@ - - - - - - - - Clase FieldMetadata - mysql_xdevapi\FieldMetadata - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\FieldMetadata - - - - - mysql_xdevapi\FieldMetadata - - - - &Properties; - - public - type - - - public - type_name - - - public - name - - - public - original_name - - - public - table - - - public - original_table - - - public - schema - - - public - catalog - - - public - collation - - - public - fractional_digits - - - public - length - - - public - flags - - - public - content_type - - - - - -
    - - -
    - &reftitle.properties; - - - 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 deleted file mode 100644 index 65838adfbe..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.result.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - Clase Result - mysql_xdevapi\Result - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\Result - - - - - mysql_xdevapi\Result - - - - mysql_xdevapi\BaseResult - - - - Traversable - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.result; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.rowresult.xml b/reference/mysql_xdevapi/mysql-xdevapi.rowresult.xml deleted file mode 100644 index 43a9cf7748..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.rowresult.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - Clase RowResult - mysql_xdevapi\RowResult - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\RowResult - - - - - mysql_xdevapi\RowResult - - - - mysql_xdevapi\BaseResult - - - - Traversable - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.rowresult; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.schema.xml b/reference/mysql_xdevapi/mysql-xdevapi.schema.xml deleted file mode 100644 index 38899aa076..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.schema.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - - Clase Schema - mysql_xdevapi\Schema - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\Schema - - - - - mysql_xdevapi\Schema - - - - mysql_xdevapi\DatabaseObject - - - - &Properties; - - public - name - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - name - - - - - -
    - - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.schema; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.schemaobject.xml b/reference/mysql_xdevapi/mysql-xdevapi.schemaobject.xml deleted file mode 100644 index c4dad83e84..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.schemaobject.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - Interfaz SchemaObject - mysql_xdevapi\SchemaObject - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\SchemaObject - - - - - mysql_xdevapi\SchemaObject - - - - mysql_xdevapi\DatabaseObject - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.schemaobject; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.session.xml b/reference/mysql_xdevapi/mysql-xdevapi.session.xml deleted file mode 100644 index 3ab1cfbbda..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.session.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - Clase Session - mysql_xdevapi\Session - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\Session - - - - - mysql_xdevapi\Session - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.session; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.sqlstatement.xml b/reference/mysql_xdevapi/mysql-xdevapi.sqlstatement.xml deleted file mode 100644 index 6ba4dc9ef6..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.sqlstatement.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - - Clase SqlStatement - mysql_xdevapi\SqlStatement - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\SqlStatement - - - - - mysql_xdevapi\SqlStatement - - - - &Constants; - - const - int - mysql_xdevapi\SqlStatement::EXECUTE_ASYNC - 1 - - - const - int - mysql_xdevapi\SqlStatement::BUFFERED - 2 - - - &Properties; - - public - statement - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - statement - - - - - -
    - - - -
    - &reftitle.constants; - - - - mysql_xdevapi\SqlStatement::EXECUTE_ASYNC - - - - - - - mysql_xdevapi\SqlStatement::BUFFERED - - - - - - -
    - - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.sqlstatement; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.sqlstatementresult.xml b/reference/mysql_xdevapi/mysql-xdevapi.sqlstatementresult.xml deleted file mode 100644 index 3b25efe6fe..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.sqlstatementresult.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - Clase SqlStatementResult - mysql_xdevapi\SqlStatementResult - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\SqlStatementResult - - - - - mysql_xdevapi\SqlStatementResult - - - - mysql_xdevapi\BaseResult - - - - Traversable - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.sqlstatementresult; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.statement.xml b/reference/mysql_xdevapi/mysql-xdevapi.statement.xml deleted file mode 100644 index ee5a4ed1c4..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.statement.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - - Clase Statement - mysql_xdevapi\Statement - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\Statement - - - - - mysql_xdevapi\Statement - - - - &Constants; - - const - int - mysql_xdevapi\Statement::EXECUTE_ASYNC - 1 - - - const - int - mysql_xdevapi\Statement::BUFFERED - 2 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - mysql_xdevapi\Statement::EXECUTE_ASYNC - - - - - - - mysql_xdevapi\Statement::BUFFERED - - - - - - -
    - - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.statement; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.table.xml b/reference/mysql_xdevapi/mysql-xdevapi.table.xml deleted file mode 100644 index 17814eaccf..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.table.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - - Clase Table - mysql_xdevapi\Table - - - - -
    - &reftitle.intro; - - Proporciona acceso a la tabla a través de declaraciones INSERT/SELECT/UPDATE/DELETE. - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\Table - - - - - mysql_xdevapi\Table - - - - mysql_xdevapi\SchemaObject - - - - &Properties; - - public - name - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - name - - - - - -
    - - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.table; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.tabledelete.xml b/reference/mysql_xdevapi/mysql-xdevapi.tabledelete.xml deleted file mode 100644 index 416b78339f..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.tabledelete.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - Clase TableDelete - mysql_xdevapi\TableDelete - - - - -
    - &reftitle.intro; - - Una declaración para operaciones de eliminación en una Tabla. - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\TableDelete - - - - - mysql_xdevapi\TableDelete - - - - mysql_xdevapi\Executable - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.tabledelete; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.tableinsert.xml b/reference/mysql_xdevapi/mysql-xdevapi.tableinsert.xml deleted file mode 100644 index 86502db561..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.tableinsert.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - Clase TableInsert - mysql_xdevapi\TableInsert - - - - -
    - &reftitle.intro; - - Una declaración para operaciones de inserción en una Tabla. - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\TableInsert - - - - - mysql_xdevapi\TableInsert - - - - mysql_xdevapi\Executable - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.tableinsert; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.tableselect.xml b/reference/mysql_xdevapi/mysql-xdevapi.tableselect.xml deleted file mode 100644 index a98df31838..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.tableselect.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - Clase TableSelect - mysql_xdevapi\TableSelect - - - - -
    - &reftitle.intro; - - Una declaración para operaciones de recuperación de entradas en una Tabla. - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\TableSelect - - - - - mysql_xdevapi\TableSelect - - - - mysql_xdevapi\Executable - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.tableselect; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.tableupdate.xml b/reference/mysql_xdevapi/mysql-xdevapi.tableupdate.xml deleted file mode 100644 index 8c89d60783..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.tableupdate.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - Clase TableUpdate - mysql_xdevapi\TableUpdate - - - - -
    - &reftitle.intro; - - Una declaración para operaciones de actualización en una Tabla. - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\TableUpdate - - - - - mysql_xdevapi\TableUpdate - - - - mysql_xdevapi\Executable - - - - - &Methods; - - - - -
    - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.tableupdate; - -
    - - diff --git a/reference/mysql_xdevapi/mysql-xdevapi.warning.xml b/reference/mysql_xdevapi/mysql-xdevapi.warning.xml deleted file mode 100644 index d757f1442d..0000000000 --- a/reference/mysql_xdevapi/mysql-xdevapi.warning.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - - Clase Warning - mysql_xdevapi\Warning - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - mysql_xdevapi\Warning - - - - - mysql_xdevapi\Warning - - - - &Properties; - - public - message - - - public - level - - - public - code - - - Constructor - - - - -
    - - -
    - &reftitle.properties; - - - message - - - - - - level - - - - - - code - - - - - -
    - - -
    - - &reference.mysql-xdevapi.mysql-xdevapi.entities.warning; - -
    - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/baseresult/getwarnings.xml b/reference/mysql_xdevapi/mysql_xdevapi/baseresult/getwarnings.xml deleted file mode 100644 index ddd9685c63..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/baseresult/getwarnings.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - BaseResult::getWarnings - Recupera los avisos de la última operación - - - - &reftitle.description; - - abstract public arraymysql_xdevapi\BaseResult::getWarnings - - - - Recupera los avisos generados por la última operación del servidor MySQL. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un array de objetos Warning de la última operación. Cada objeto - define un 'message' de error, un 'nivel' de error y un 'code' de error. Un array - vacío es devuelto si no hay errores. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\RowResult::getWarnings</function> - -sql("CREATE DATABASE foo")->execute(); -$session->sql("CREATE TABLE foo.test_table(x int)")->execute(); - -$schema = $session->getSchema("foo"); -$table = $schema->getTable("test_table"); - -$table->insert(['x'])->values([1])->values([2])->execute(); - -$res = $table->select(['x/0 as bad_x'])->execute(); -$warnings = $res->getWarnings(); - -print_r($warnings); -?> -]]> - - &example.outputs.similar; - - mysql_xdevapi\Warning Object - ( - [message] => Division by 0 - [level] => 2 - [code] => 1365 - ) - [1] => mysql_xdevapi\Warning Object - ( - [message] => Division by 0 - [level] => 2 - [code] => 1365 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/baseresult/getwarningscount.xml b/reference/mysql_xdevapi/mysql_xdevapi/baseresult/getwarningscount.xml deleted file mode 100644 index 63d04f6b06..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/baseresult/getwarningscount.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - BaseResult::getWarningsCount - Recupera el número de advertencias de la última operación - - - - &reftitle.description; - - abstract public intmysql_xdevapi\BaseResult::getWarningsCount - - - - Devuelve el número de advertencias generadas por la última operación. Más específicamente, - estas advertencias son generadas por el servidor MySQL. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El número de advertencias de la última operación. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\RowResult::getWarningsCount</function> - -sql("DROP DATABASE IF EXISTS foo")->execute(); -$session->sql("CREATE DATABASE foo")->execute(); -$session->sql("CREATE TABLE foo.test_table(x int)")->execute(); - -$schema = $session->getSchema("foo"); -$table = $schema->getTable("test_table"); - -$table->insert(['x'])->values([1])->values([2])->execute(); - -$res = $table->select(['x/0 as bad_x'])->execute(); - -echo $res->getWarningsCount(); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/client/close.xml b/reference/mysql_xdevapi/mysql_xdevapi/client/close.xml deleted file mode 100644 index 3bf94c7f38..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/client/close.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - mysql_xdevapi\Client::close - Cierra el cliente - - - - &reftitle.description; - - public boolmysql_xdevapi\Client::close - - - - Cierra todas las conexiones del cliente con el servidor. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; si las conexiones son cerradas. - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/client/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/client/construct.xml deleted file mode 100644 index e5cea07fb4..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/client/construct.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - Client::__construct - Constructor del cliente - - - - &reftitle.description; - - private mysql_xdevapi\Client::__construct - - - - Construye un objeto cliente. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Client::__construct</function> - -getSession(); -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/client/getsession.xml b/reference/mysql_xdevapi/mysql_xdevapi/client/getsession.xml deleted file mode 100644 index 5fbfe2bf3c..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/client/getsession.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - Client::getClient - Devuelve la sesión del cliente - - - - &reftitle.description; - - public mysql_xdevapi\Sessionmysql_xdevapi\Client::getSession - - - - Devuelve la sesión asociada al cliente. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objeto Session. - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/add.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/add.xml deleted file mode 100644 index c76971b151..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/add.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - Collection::add - Añade un documento a la colección - - - - &reftitle.description; - - public mysql_xdevapi\CollectionAddmysql_xdevapi\Collection::add - mixeddocument - - - Desencadena la inserción del o de los documentos dados en la colección, y - se admiten varias variantes de este método. Las opciones incluyen: - - - - - Añadir un solo documento en forma de string JSON. - - - - - Añadir un solo documento en forma de array como: - [ 'field' => 'value', 'field2' => 'value2' ... ] - - - - - Una mezcla de ambos, y varios documentos pueden ser añadidos en la misma operación. - - - - - - - &reftitle.parameters; - - - document - - - Uno o varios documentos, y esto puede ser tanto JSON como un array de campos con - sus valores asociados. No puede ser un array vacío. - - - El servidor MySQL genera automáticamente valores _id únicos para - cada documento (recomendado), aunque esto también puede ser añadido manualmente. Este - valor debe ser único, de lo contrario la operación de adición fallará. - - - - - - - - &reftitle.returnvalues; - - Una colección de objetos. Utilizar execute() para devolver un resultado que puede ser utilizado para - consultar el número de elementos afectados, el número de advertencias generadas por la operación, o para - recuperar una lista de identificadores generados para los documentos insertados. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Collection::add</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$collection = $schema->getCollection("people"); - -// Añade dos documentos -$collection->add('{"name": "Fred", "age": 21, "job": "Construction"}')->execute(); -$collection->add('{"name": "Wilma", "age": 23, "job": "Teacher"}')->execute(); - -// Añade dos documentos utilizando un solo objeto JSON -$result = $collection->add( - '{"name": "Bernie", - "jobs": [{"title":"Cat Herder","Salary":42000}, {"title":"Father","Salary":0}], - "hobbies": ["Sports","Making cupcakes"]}', - '{"name": "Jane", - "jobs": [{"title":"Scientist","Salary":18000}, {"title":"Mother","Salary":0}], - "hobbies": ["Walking","Making pies"]}')->execute(); - -// Recupera una lista de identificadores generados a partir del último add() -$ids = $result->getGeneratedIds(); -print_r($ids); -?> -]]> - - &example.outputs.similar; - - 00005b6b53610000000000000056 - [1] => 00005b6b53610000000000000057 -) -]]> - - - - - - &reftitle.notes; - - - Un identificador único _id es generado por MySQL Server 8.0 o superior, como se demuestra - en el ejemplo. El campo _id debe ser definido manualmente si se utiliza - MySQL Server 5.7. - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/addorreplaceone.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/addorreplaceone.xml deleted file mode 100644 index e7ca857688..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/addorreplaceone.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - Collection::addOrReplaceOne - Añade o reemplaza un documento de la colección - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\Collection::addOrReplaceOne - stringid - stringdoc - - - Añade un nuevo documento, o reemplaza un documento si ya existe. - - - Existen varios escenarios para este método: - - - - - Ni el id ni ningún valor de clave única están en conflicto con un documento de la colección, - entonces el documento es añadido. - - - - - Si el id no corresponde a ningún documento, pero uno o más valores de clave única - entran en conflicto con un documento de la colección, entonces se lanza un error. - - - - - Si el id corresponde a un documento existente y ninguna clave única está definida para la colección, - entonces el documento es reemplazado. - - - - - Si el id corresponde a un documento existente, y todas las claves únicas del documento de reemplazo - corresponden a ese mismo documento o no están en conflicto con ningún otro documento de la colección, - entonces el documento es reemplazado. - - - - - Si el id corresponde a un documento existente, y una o más claves únicas corresponden a otro - documento de la colección, entonces se lanza un error. - - - - - - - - &reftitle.parameters; - - - id - - - Este es el identificador del filtro. Si este identificador o cualquier otro campo que tiene un índice único ya existe - en la colección, entonces actualizará el documento correspondiente. - - - Por omisión, este identificador es generado automáticamente por el servidor MySQL cuando el documento ha sido añadido, - y es referenciado como un campo nombrado '_id'. - - - - - doc - - - Este es el documento a añadir o reemplazar, que es una cadena JSON. - - - - - - - - &reftitle.returnvalues; - - Un objeto Result. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Collection::addOrReplaceOne</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$collection = $schema->getCollection("people"); - -// Utilizar add() -$result = $collection->add('{"name": "Wilma", "age": 23, "job": "Teacher"}')->execute(); - -// Utilizar addOrReplaceOne() -// Nota: pasamos aquí un valor _id conocido -$result = $collection->addOrReplaceOne('00005b6b53610000000000000056', '{"name": "Fred", "age": 21, "job": "Construction"}'); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/construct.xml deleted file mode 100644 index 5ea95405a6..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/construct.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - Collection::__construct - Constructor de Collection - - - - &reftitle.description; - - private mysql_xdevapi\Collection::__construct - - - - Construye un objeto Collection. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Collection::getOne</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$result = $collection->add('{"name": "Alfred", "age": 42, "job": "Butler"}')->execute(); - -// Un identificador único _id es generado por MySQL Server -// Esto recupera los _id generados; uno solo en este ejemplo, por lo tanto $ids[0] -$ids = $result->getGeneratedIds(); -$alfreds_id = $ids[0]; - -// ... - -print_r($alfreds_id); -print_r($collection->getOne($alfreds_id)); -?> -]]> - - &example.outputs.similar; - - 00005b6b536100000000000000b1 - [age] => 42 - [job] => Butler - [name] => Alfred -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/count.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/count.xml deleted file mode 100644 index 57e1d298fa..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/count.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - Collection::count - Devuelve el número de documentos - - - - &reftitle.description; - - public intmysql_xdevapi\Collection::count - - - - Esta funcionalidad es similar a una operación SQL SELECT COUNT(*) - en el servidor MySQL para el esquema y la colección actuales. - En otras palabras, cuenta el número de documentos en la colección. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El número de documentos en la colección. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Collection::count</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$collection = $schema->getCollection("people"); - -$result = $collection - ->add( - '{"name": "Bernie", - "jobs": [ - {"title":"Cat Herder","Salary":42000}, - {"title":"Father","Salary":0} - ], - "hobbies": ["Sports","Making cupcakes"]}', - '{"name": "Jane", - "jobs": [ - {"title":"Scientist","Salary":18000}, - {"title":"Mother","Salary":0} - ], - "hobbies": ["Walking","Making pies"]}') - ->execute(); - -var_dump($collection->count()); -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/createindex.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/createindex.xml deleted file mode 100644 index 56bbdc1c7e..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/createindex.xml +++ /dev/null @@ -1,178 +0,0 @@ - - - - - - Collection::createIndex - Crear un índice de colección - - - - &reftitle.description; - - public voidmysql_xdevapi\Collection::createIndex - stringindex_name - stringindex_desc_json - - - Crear un índice en la colección. - - - Se lanza una excepción si ya existe un índice con el mismo nombre, - o si la definición del índice no está correctamente formada. - - - - - &reftitle.parameters; - - - index_name - - - El nombre del índice a crear. Este nombre debe ser un nombre de índice válido tal como - aceptado por la consulta SQL CREATE INDEX. - - - - - index_desc_json - - - La definición del índice a crear. Contiene un array de objetos IndexField, - y cada objeto describe un solo miembro de documento a incluir en el índice, - y una cadena opcional para el tipo de índice que podría ser INDEX (por omisión) o SPATIAL. - - - Una descripción única de IndexField se compone de los siguientes campos: - - - - - field: string, la ruta completa del documento hacia el miembro del documento o el campo a indexar. - - - - - type: string, uno de los tipos de columnas SQL admitidos para mapear el campo. - Para los tipos numéricos, la palabra clave opcional UNSIGNED puede seguir. - Para el tipo TEXT, la longitud a considerar para la indexación puede ser añadida. - - - - - unique: bool, (opcional) true si el campo debe ser existente en el documento. - Por omisión es &false;, excepto para GEOJSON donde por omisión es &true;. - - - - - options: integer, (opcional) flags de opciones especiales a utilizar - al decodificar datos GEOJSON. - - - - - srid: integer, (opcional) valor srid a utilizar al - decodificar datos GEOJSON. - - - - - - Es un error incluir otros campos no descritos anteriormente en - los documentos IndexDefinition o IndexField. - - - - - - - - &reftitle.returnvalues; - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Collection::createIndex</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -// Crear un índice de texto -$collection->createIndex( - 'myindex1', - '{"fields": [{ - "field": "$.name", - "type": "TEXT(25)", - "required": true}], - "unique": false}' -); - -// Un índice espacial -$collection->createIndex( - 'myindex2', - '{"fields": [{ - "field": "$.home", - "type": "GEOJSON", - "required": true}], - "type": "SPATIAL"}' -); - -// Índice con múltiples campos -$collection->createIndex( - 'myindex3', - '{"fields": [ - { - "field": "$.name", - "type": "TEXT(20)", - "required": true - }, - { - "field": "$.age", - "type": "INTEGER" - }, - { - "field": "$.job", - "type": "TEXT(30)", - "required": false - } - ], - "unique": true - }' -); -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/dropindex.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/dropindex.xml deleted file mode 100644 index b26a01382b..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/dropindex.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - Collection::dropIndex - Elimina un índice de colección - - - - &reftitle.description; - - public boolmysql_xdevapi\Collection::dropIndex - stringindex_name - - - Elimina un índice de colección. - - - Esta operación no lanza un error si el índice no existe, pero - &false; es devuelto en este caso. - - - - - &reftitle.parameters; - - - index_name - - - El nombre del índice de colección a eliminar. - - - - - - - - &reftitle.returnvalues; - - &true; si la operación DROP INDEX ha tenido éxito, de lo contrario &false;. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Collection::dropIndex</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -// ... - -$collection = $schema->getCollection("people"); - -$collection->createIndex( - 'myindex', - '{"fields": [{"field": "$.name", "type": "TEXT(25)", "required": true}], "unique": false}' -); - -// ... - -if ($collection->dropIndex('myindex')) { - echo "Un índice llamado 'myindex' fue encontrado y eliminado."; -} -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/existsindatabase.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/existsindatabase.xml deleted file mode 100644 index 519ebb4e2b..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/existsindatabase.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Collection::existsInDatabase - Verifica si la colección existe en la base de datos - - - - &reftitle.description; - - public boolmysql_xdevapi\Collection::existsInDatabase - - - - Verifica si el objeto Collection hace referencia a una colección en la base de datos (esquema). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si la colección existe en la base de datos, de lo contrario &false; si no existe. - - - Una tabla definida con dos columnas (doc y _id) se considera una colección, - y una tercera columna _json_schema a partir de MySQL 8.0.21. - Añadir una columna adicional significa que existsInDatabase() ya no la verá como una colección. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Collection::existsInDatabase</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -// ... - -$collection = $schema->getCollection("people"); - -// ... - -if (!$collection->existsInDatabase()) { - echo "La colección ya no existe en la base de datos llamada addressbook. ¿Qué pasó?"; -} -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/find.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/find.xml deleted file mode 100644 index 2fc301464d..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/find.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - Collection::find - Búsqueda de documento - - - - &reftitle.description; - - public mysql_xdevapi\CollectionFindmysql_xdevapi\Collection::find - stringsearch_condition - - - Busca una colección de base de datos para un documento o un conjunto de documentos. Los - documentos encontrados se devuelven en forma de un objeto CollectionFind para - modificarlos o recuperar resultados adicionales. - - - - - &reftitle.parameters; - - - search_condition - - - Aunque es opcional, normalmente se define una condición para limitar los resultados - a un subconjunto de documentos. - - - Varios elementos pueden construir la condición y la sintaxis soporta la ligadura de argumentos. - La expresión utilizada como condición de búsqueda debe ser una expresión SQL válida. - Si no se proporciona ninguna condición de búsqueda (campo vacío) entonces se supone find('true'). - - - - - - - - &reftitle.returnvalues; - - Un objeto CollectionFind para verificar la operación, - o recuperar los documentos encontrados. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Collection::find</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$collection->add('{"name": "Alfred", "age": 18, "job": "Butler"}')->execute(); -$collection->add('{"name": "Bob", "age": 19, "job": "Swimmer"}')->execute(); -$collection->add('{"name": "Fred", "age": 20, "job": "Construction"}')->execute(); -$collection->add('{"name": "Wilma", "age": 21, "job": "Teacher"}')->execute(); -$collection->add('{"name": "Suki", "age": 22, "job": "Teacher"}')->execute(); - -$find = $collection->find('job LIKE :job AND age > :age'); -$result = $find - ->bind(['job' => 'Teacher', 'age' => 20]) - ->sort('age DESC') - ->limit(2) - ->execute(); - -print_r($result->fetchAll()); -?> -]]> - - &example.outputs; - - Array - ( - [_id] => 00005b6b536100000000000000a8 - [age] => 22 - [job] => Teacher - [name] => Suki - ) - [1] => Array - ( - [_id] => 00005b6b536100000000000000a7 - [age] => 21 - [job] => Teacher - [name] => Wilma - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/getname.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/getname.xml deleted file mode 100644 index 64b677ffb2..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/getname.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Collection::getName - Devuelve el nombre de la colección - - - - &reftitle.description; - - public stringmysql_xdevapi\Collection::getName - - - - Devuelve el nombre de la colección. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El nombre de la colección, en forma de string. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Collection::getName</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -// ... - -var_dump($collection->getName()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/getone.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/getone.xml deleted file mode 100644 index 72661c51f2..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/getone.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - Collection::getOne - Devuelve un documento - - - - &reftitle.description; - - public Documentmysql_xdevapi\Collection::getOne - stringid - - - Recupera un documento de la colección. - - - Esto es un atajo para: - Collection.find("_id = :id").bind("id", id).execute().fetchOne(); - - - - - &reftitle.parameters; - - - id - - - El _id del documento en la colección. - - - - - - - - &reftitle.returnvalues; - - El objeto colección, o &null; si el _id no corresponde a un documento. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Collection::getOne</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$result = $collection->add('{"name": "Alfred", "age": 42, "job": "Butler"}')->execute(); - -// Un identificador único _id (por omisión, y recomendado) es generado por MySQL Server -// Esto recupera los _id generados; uno solo en este ejemplo, por lo tanto $ids[0] -$ids = $result->getGeneratedIds(); -$alfreds_id = $ids[0]; - -// ... - -print_r($alfreds_id); -print_r($collection->getOne($alfreds_id)); -?> -]]> - - &example.outputs.similar; - - 00005b6b536100000000000000b1 - [age] => 42 - [job] => Butler - [name] => Alfred -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/getschema.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/getschema.xml deleted file mode 100644 index d117c60113..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/getschema.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Collection::getSchema - Devuelve el objeto esquema - - - - &reftitle.description; - - public Schema Objectmysql_xdevapi\Collection::getSchema - - - - Devuelve el objeto esquema que contiene la colección. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El objeto esquema en caso de éxito, o &null; si el objeto no puede ser recuperado - para la colección dada. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Collection::getSchema</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -var_dump($collection->getSchema()); -?> -]]> - - &example.outputs.similar; - - - string(11) "addressbook" -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/getsession.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/getsession.xml deleted file mode 100644 index a67aaf4e10..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/getsession.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Collection::getSession - Devuelve el objeto session - - - - &reftitle.description; - - public Sessionmysql_xdevapi\Collection::getSession - - - - Devuelve un nuevo objeto Session a partir del objeto Collection. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objeto Session. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Collection::getSession</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -// ... - -$newsession = $collection->getSession(); - -var_dump($session); -var_dump($newsession); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/modify.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/modify.xml deleted file mode 100644 index b2b052a29a..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/modify.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - Collection::modify - Modifica los documentos de la colección - - - - &reftitle.description; - - public mysql_xdevapi\CollectionModifymysql_xdevapi\Collection::modify - stringsearch_condition - - - Modifica los documentos de una colección que cumplen con condiciones de búsqueda específicas. - Se permiten varias operaciones y se soporta la ligadura de argumentos. - - - - - &reftitle.parameters; - - - search_condition - - - Debe ser una expresión SQL válida utilizada para hacer coincidir los documentos a modificar. - Esta expresión puede ser tan simple como &true;, que coincide con todos los - documentos, o puede utilizar funciones y operadores tales como - 'CAST(_id AS SIGNED) >= 10', - 'age MOD 2 = 0 OR age MOD 3 = 0', o - '_id IN ["2","5","7","10"]'. - - - - - - - - &reftitle.returnvalues; - - SI la operación no se ejecuta, entonces la función devolverá - un objeto Modify que puede ser utilizado para añadir operaciones - de modificación adicionales. - - - Si la operación de modificación se ejecuta, entonces el objeto devuelto contendrá el - resultado de la operación. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Collection::modify</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$collection->add('{"name": "Alfred", "age": 18, "job": "Butler"}')->execute(); -$collection->add('{"name": "Bob", "age": 19, "job": "Painter"}')->execute(); - -// Añade dos nuevos trabajos para todos los Painters: Artist y Crafter -$collection - ->modify("job in ('Butler', 'Painter')") - ->arrayAppend('job', 'Artist') - ->arrayAppend('job', 'Crafter') - ->execute(); - -// Elimina el campo 'beer' de todos los documentos con edad menor a 21 -$collection - ->modify('age < 21') - ->unset(['beer']) - ->execute(); -?> -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/remove.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/remove.xml deleted file mode 100644 index 0d6ebaa64f..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/remove.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - Collection::remove - Elimina documentos de la colección - - - - &reftitle.description; - - public mysql_xdevapi\CollectionRemovemysql_xdevapi\Collection::remove - stringsearch_condition - - - Elimina documentos de una colección que cumplen con condiciones de búsqueda específicas. - Se permiten varias operaciones, y la ligadura de argumentos. - - - - - &reftitle.parameters; - - - search_condition - - - Debe ser una expresión SQL válida utilizada para hacer coincidir los documentos a modificar. - Esta expresión puede ser tan simple como &true;, que coincide con todos los - documentos, o puede utilizar funciones y operadores tales como - 'CAST(_id AS SIGNED) >= 10', - 'age MOD 2 = 0 OR age MOD 3 = 0', o - '_id IN ["2","5","7","10"]'. - - - - - - - - &reftitle.returnvalues; - - Si la operación no se ejecuta, entonces la función devolverá - un objeto Remove que puede ser utilizado para añadir operaciones - de eliminación adicionales. - - - SI la operación de eliminación se ejecuta, entonces el objeto devuelto contendrá el - resultado de la operación. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Collection::remove</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$collection->add('{"name": "Alfred", "age": 18, "job": "Butler"}')->execute(); -$collection->add('{"name": "Bob", "age": 19, "job": "Painter"}')->execute(); - -// Elimina todos los painters -$collection - ->remove("job in ('Painter')") - ->execute(); - -// Elimina el butler más viejo -$collection - ->remove("job in ('Butler')") - ->sort('age desc') - ->limit(1) - ->execute(); - -// Elimina el registro con la edad más alta -$collection - ->remove('true') - ->sort('age desc') - ->limit(1) - ->execute(); -?> -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/removeone.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/removeone.xml deleted file mode 100644 index 317df76f85..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/removeone.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - Collection::removeOne - Elimina un documento de la colección - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\Collection::removeOne - stringid - - - Elimina un documento de la colección con el ID correspondiente. - Esto es un atajo para Collection.remove("_id = :id").bind("id", id).execute(). - - - - - - &reftitle.parameters; - - - id - - - El identificador del documento de la colección a eliminar. Generalmente es - el _id generado por el servidor MySQL al añadir el registro. - - - - - - - - &reftitle.returnvalues; - - Un objeto Result que puede ser utilizado para consultar el número de elementos afectados - o el número de advertencias generadas por la operación. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Collection::removeOne</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$result = $collection->add('{"name": "Alfred", "age": 18, "job": "Butler"}')->execute(); - -// Normalmente el _id es conocido por otros medios, -// pero para este ejemplo, recuperemos el identificador generado y utilicémoslo -$ids = $result->getGeneratedIds(); -$alfred_id = $ids[0]; - -$result = $collection->removeOne($alfred_id); - -if(!$result->getAffectedItemsCount()) { - echo "Alfred con id $alfred_id no fue eliminado."; -} else { - echo "Adiós, Alfred, puedes llevarte el _id $alfred_id contigo."; -} -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collection/replaceone.xml b/reference/mysql_xdevapi/mysql_xdevapi/collection/replaceone.xml deleted file mode 100644 index d98bbe2ac4..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collection/replaceone.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - Collection::replaceOne - Reemplaza un documento de la colección - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\Collection::replaceOne - stringid - stringdoc - - - Modifica (o reemplaza) el documento identificado por ID, si existe. - - - - - - &reftitle.parameters; - - - id - - - El identificador del documento a reemplazar o actualizar. Típicamente es - el _id generado por el servidor MySQL al añadir el registro. - - - - - doc - - - El documento de la colección a actualizar o reemplazar correspondiente - al argumento . - - - Este documento puede ser un objeto documento o un string JSON válido - que describa el nuevo documento. - - - - - - - - &reftitle.returnvalues; - - Un objeto Result que puede ser utilizado para consultar el número de elementos afectados - y el número de advertencias generadas por la operación. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Collection::replaceOne</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$result = $collection->add('{"name": "Alfred", "age": 18, "job": "Butler"}')->execute(); - -// Normalmente el _id es conocido por otros medios, -// pero para este ejemplo, recuperemos el identificador generado y utilicémoslo -$ids = $result->getGeneratedIds(); -$alfred_id = $ids[0]; - -// ... - -$alfred = $collection->getOne($alfred_id); -$alfred['age'] = 81; -$alfred['job'] = 'Guru'; - -$collection->replaceOne($alfred_id, $alfred); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionadd/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionadd/construct.xml deleted file mode 100644 index 4e3778628d..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionadd/construct.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - CollectionAdd::__construct - Constructor de CollectionAdd - - - - &reftitle.description; - - private mysql_xdevapi\CollectionAdd::__construct - - - - Se utiliza para añadir un documento a una colección; se llama desde un objeto Collection. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\CollectionAdd::__construct</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$collection = $schema->getCollection("people"); - -// Añade dos documentos -$collection - ->add('{"name": "Fred", "age": 21, "job": "Construction"}') - ->execute(); - -$collection - ->add('{"name": "Wilma", "age": 23, "job": "Teacher"}') - ->execute(); - -// Añade dos documentos utilizando un solo objeto JSON -$result = $collection - ->add( - '{"name": "Bernie", - "jobs": [{"title":"Cat Herder","Salary":42000}, {"title":"Father","Salary":0}], - "hobbies": ["Sports","Making cupcakes"]}', - '{"name": "Jane", - "jobs": [{"title":"Scientist","Salary":18000}, {"title":"Mother","Salary":0}], - "hobbies": ["Walking","Making pies"]}') - ->execute(); - -// Recupera una lista de ID generados por el último add() -$ids = $result->getGeneratedIds(); -print_r($ids); - -?> -]]> - - &example.outputs.similar; - - 00005b6b53610000000000000056 - [1] => 00005b6b53610000000000000057 -) -]]> - - - - - - &reftitle.notes; - - - Un identificador único _id es generado por MySQL Server 8.0 o superior, como se demuestra - en el ejemplo. El campo _id debe ser definido manualmente si se utiliza - MySQL Server 5.7. - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionadd/execute.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionadd/execute.xml deleted file mode 100644 index db5504aa1b..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionadd/execute.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - CollectionAdd::execute - Ejecuta la declaración - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\CollectionAdd::execute - - - - El método execute es requerido para enviar la solicitud de operación CRUD - al servidor MySQL. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objeto Result que puede ser utilizado para verificar el estado de la operación, - como el número de filas afectadas. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\CollectionAdd::execute</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$collection = $schema->getCollection("people"); - -// Añade dos documentos -$collection - ->add('{"name": "Fred", "age": 21, "job": "Construction"}') - ->execute(); - -$collection - ->add('{"name": "Wilma", "age": 23, "job": "Teacher"}') - ->execute(); - -// Añade dos documentos utilizando un solo objeto JSON -$result = $collection - ->add( - '{"name": "Bernie", - "jobs": [{"title":"Cat Herder","Salary":42000}, {"title":"Father","Salary":0}], - "hobbies": ["Sports","Making cupcakes"]}', - '{"name": "Jane", - "jobs": [{"title":"Scientist","Salary":18000}, {"title":"Mother","Salary":0}], - "hobbies": ["Walking","Making pies"]}') - ->execute(); - -// Recupera una lista de ID generados por el último add() -$ids = $result->getGeneratedIds(); -print_r($ids); -?> -]]> - - &example.outputs.similar; - - 00005b6b53610000000000000056 - [1] => 00005b6b53610000000000000057 -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/bind.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/bind.xml deleted file mode 100644 index e8695ac1ae..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/bind.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - CollectionFind::bind - Liga un valor a un argumento de consulta - - - - &reftitle.description; - - public mysql_xdevapi\CollectionFindmysql_xdevapi\CollectionFind::bind - arrayplaceholder_values - - - Esto permite ligar un argumento al espacio reservado en la condición de búsqueda de la operación find. - El espacio reservado tiene la forma de :NOMBRE donde ':' es un prefijo común que siempre debe existir antes de cualquier NOMBRE. - NOMBRE es el nombre real del espacio reservado. La función bind acepta una lista de espacios reservados si varias - entidades deben ser sustituidas en la condición de búsqueda. - - - - - &reftitle.parameters; - - - placeholder_values - - - Los valores a sustituir en la condición de búsqueda; se permiten varios valores - y se pasan en forma de array donde "NOMBRE_ESPACIO_RESERVADO => VALOR_ESPACIO_RESERVADO". - - - - - - - - &reftitle.returnvalues; - - Un objeto CollectionFind, - o encadenado con execute() para devolver un objeto Result. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\CollectionFind::bind</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); -$result = $create - ->add('{"name": "Alfred", "age": 18, "job": "Butler"}') - ->execute(); - -// ... - -$collection = $schema->getCollection("people"); - -$result = $collection - ->find('job like :job and age > :age') - ->bind(['job' => 'Butler', 'age' => 16]) - ->execute(); - -var_dump($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - - array(4) { - ["_id"]=> - string(28) "00005b6b536100000000000000cf" - ["age"]=> - int(18) - ["job"]=> - string(6) "Butler" - ["name"]=> - string(6) "Alfred" - } -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/construct.xml deleted file mode 100644 index 3b40f455fc..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/construct.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - CollectionFind::__construct - Constructor de CollectionFind - - - - &reftitle.description; - - private mysql_xdevapi\CollectionFind::__construct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - Ejemplo de CollectionFind - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); -$result = $create - ->add('{"name": "Alfred", "age": 18, "job": "Butler"}') - ->execute(); - -// ... - -$collection = $schema->getCollection("people"); - -$result = $collection - ->find('job like :job and age > :age') - ->bind(['job' => 'Butler', 'age' => 16]) - ->execute(); - -var_dump($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - - array(4) { - ["_id"]=> - string(28) "00005b6b536100000000000000cf" - ["age"]=> - int(18) - ["job"]=> - string(6) "Butler" - ["name"]=> - string(6) "Alfred" - } -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/execute.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/execute.xml deleted file mode 100644 index 7821465e06..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/execute.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - CollectionFind::execute - Ejecuta la declaración - - - - &reftitle.description; - - public mysql_xdevapi\DocResultmysql_xdevapi\CollectionFind::execute - - - - Ejecuta la operación de búsqueda; - esta funcionalidad permite el encadenamiento de métodos. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objeto mysql_xdevapi\DocResult, que puede ser utilizado - para recuperar los resultados, o para interrogar el estado de la operación. - - - - - &reftitle.examples; - - Ejemplo de CollectionFind - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$create - ->add('{"name": "Alfred", "age": 18, "job": "Butler"}') - ->execute(); - -// ... - -$collection = $schema->getCollection("people"); - -$result = $collection - ->find('job like :job and age > :age') - ->bind(['job' => 'Butler', 'age' => 16]) - ->execute(); - -var_dump($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - - array(4) { - ["_id"]=> - string(28) "00005b6b536100000000000000cf" - ["age"]=> - int(18) - ["job"]=> - string(6) "Butler" - ["name"]=> - string(6) "Alfred" - } -} -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/fields.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/fields.xml deleted file mode 100644 index d7d5d99cdf..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/fields.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - CollectionFind::fields - Define el filtro de campo de documento - - - - &reftitle.description; - - public mysql_xdevapi\CollectionFindmysql_xdevapi\CollectionFind::fields - stringprojection - - - Define las columnas para la consulta a devolver. Si no se define, - se utilizan todas las columnas. - - - - - - &reftitle.parameters; - - - projection - - - Puede ser una cadena única o un array de cadenas identificando las - columnas a devolver para cada documento que coincida con la condición de búsqueda. - - - - - - - - &reftitle.returnvalues; - - Un objeto CollectionFind que puede ser utilizado para un procesamiento posterior. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\CollectionFind::fields</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$create - ->add('{"name": "Alfred", "age": 18, "job": "Butler"}') - ->execute(); - -// ... - -$collection = $schema->getCollection("people"); - -$result = $collection - ->find('job like :job and age > :age') - ->bind(['job' => 'Butler', 'age' => 16]) - ->fields('name') - ->execute(); - -var_dump($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - - array(1) { - ["name"]=> - string(6) "Alfred" - } -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/groupby.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/groupby.xml deleted file mode 100644 index 907d6a6adf..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/groupby.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - CollectionFind::groupBy - Define los criterios de agrupación - - - - &reftitle.description; - - public mysql_xdevapi\CollectionFindmysql_xdevapi\CollectionFind::groupBy - stringsort_expr - - - Esta función puede ser utilizada para agrupar el conjunto de resultados por una o más columnas. - Es a menudo utilizada con funciones de agregación tales como COUNT, - MAX, MIN, SUM etc. - - - - - &reftitle.parameters; - - - sort_expr - - - La o las columnas que deben ser utilizadas para la operación de agrupación, esto puede ser una cadena única - o un array de argumentos de string, uno para cada columna. - - - - - - - - &reftitle.returnvalues; - - Un objeto CollectionFind que puede ser utilizado para un procesamiento posterior. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\CollectionFind::groupBy</function> - -find()->groupBy('name')->execute(); - -?> -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/having.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/having.xml deleted file mode 100644 index 0f477e2e98..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/having.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - CollectionFind::having - Define la condición para las funciones de agregación - - - - &reftitle.description; - - public mysql_xdevapi\CollectionFindmysql_xdevapi\CollectionFind::having - stringsort_expr - - - Esta función puede ser utilizada después de la operación 'field' para hacer una selección sobre los documentos a extraer. - - - - - - &reftitle.parameters; - - - sort_expr - - - Debe ser una expresión SQL válida, el uso de funciones de agregación está permitido. - - - - - - - - &reftitle.returnvalues; - - Un objeto CollectionFind que puede ser utilizado para un procesamiento posterior. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\CollectionFind::having</function> - -find()->fields(['name','age'])->having('age > 40')->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/limit.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/limit.xml deleted file mode 100644 index 3047d6304b..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/limit.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - CollectionFind::limit - Limita el número de documentos devueltos - - - - &reftitle.description; - - public mysql_xdevapi\CollectionFindmysql_xdevapi\CollectionFind::limit - introws - - - Define el número máximo de documentos a devolver. - - - - - &reftitle.parameters; - - - rows - - - El número máximo de documentos. - - - - - - - - &reftitle.returnvalues; - - Un objeto mysql_xdevapi\CollectionFind que puede ser utilizado para un procesamiento posterior; - encadene con el método execute() para devolver un objeto DocResult. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\CollectionFind::limit</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); -$create - ->add('{"name": "Alfred", "age": 18, "job": "Butler"}') - ->execute(); -$create - ->add('{"name": "Reginald", "age": 42, "job": "Butler"}') - ->execute(); - -// ... - -$collection = $schema->getCollection("people"); - -$result = $collection - ->find('job like :job and age > :age') - ->bind(['job' => 'Butler', 'age' => 16]) - ->sort('age desc') - ->limit(1) - ->execute(); - -var_dump($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - - array(4) { - ["_id"]=> - string(28) "00005b6b536100000000000000f3" - ["age"]=> - int(42) - ["job"]=> - string(6) "Butler" - ["name"]=> - string(8) "Reginald" - } -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/lockexclusive.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/lockexclusive.xml deleted file mode 100644 index 59debe58a3..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/lockexclusive.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - CollectionFind::lockExclusive - Ejecuta la operación con un BLOQUEO EXCLUSIVO - - - - &reftitle.description; - - public mysql_xdevapi\CollectionFindmysql_xdevapi\CollectionFind::lockExclusive - intlock_waiting_option - - - Bloquea el documento de manera exclusiva. - Mientras el documento está bloqueado, - otras transacciones no pueden actualizar el documento, - utilizar SELECT ... LOCK IN SHARE MODE, - o leer los datos en ciertos niveles de aislamiento de transacción. - Las lecturas coherentes ignoran los bloqueos establecidos en los registros que existen en la vista de lectura. - - - Para evitar problemas de concurrencia, es lógico utilizar esta función con el método - mysql_xdevapi\Collection::modify. Esencialmente, esta función utiliza bloqueos de línea para serializar - el acceso a las líneas. - - - - - &reftitle.parameters; - - - lock_waiting_option - - - Una opción de espera opcional. Por omisión, es MYSQLX_LOCK_DEFAULT. Los valores válidos son estas constantes: - - - MYSQLX_LOCK_DEFAULT - MYSQLX_LOCK_NOWAIT - MYSQLX_LOCK_SKIP_LOCKED - - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto CollectionFind que puede ser utilizado para un procesamiento posterior. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\CollectionFind::lockExclusive</function> - -getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$session->startTransaction(); - -$result = $collection - ->find("age > 50") - ->lockExclusive() - ->execute(); - -// ... realizar una operación sobre el objeto - -// Validar la transacción y desbloquear el documento -$session->commit(); -?> -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/lockshared.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/lockshared.xml deleted file mode 100644 index 45553b357b..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/lockshared.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - CollectionFind::lockShared - Ejecuta la operación con un BLOQUEO COMPARTIDO - - - - &reftitle.description; - - public mysql_xdevapi\CollectionFindmysql_xdevapi\CollectionFind::lockShared - intlock_waiting_option - - - Permite el compartimiento de documentos entre múltiples transacciones que están bloqueadas en modo compartido. - - - Otras sesiones pueden leer las filas, pero no pueden modificarlas hasta que su transacción no haya sido validada. - - - Si una de estas filas ha sido modificada por otra transacción que no ha sido validada, - la consulta esperará a que esta transacción termine para poder utilizar los últimos valores. - - - - - &reftitle.parameters; - - - lock_waiting_option - - - Una opción de espera opcional. Por omisión, es MYSQLX_LOCK_DEFAULT. Los valores válidos son estas constantes: - - - MYSQLX_LOCK_DEFAULT - MYSQLX_LOCK_NOWAIT - MYSQLX_LOCK_SKIP_LOCKED - - - - - - - - &reftitle.returnvalues; - - Un objeto CollectionFind que puede ser utilizado para un tratamiento ulterior. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\CollectionFind::lockShared</function> - -getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$session->startTransaction(); - -$result = $collection - ->find("age > 50") - ->lockShared() - ->execute(); - -// ... leer el objeto en modo compartido - -// Validar la transacción y desbloquear el documento -$session->commit(); -?> -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/offset.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/offset.xml deleted file mode 100644 index 357b7f1d35..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/offset.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - CollectionFind::offset - Ignorar un número dado de elementos a devolver - - - - &reftitle.description; - - public mysql_xdevapi\CollectionFindmysql_xdevapi\CollectionFind::offset - intposition - - - Ignora (desplaza) un número dado de elementos que de otro modo serían devueltos - por la operación find. Utilícese con el método limit(). - - - Definir un desplazamiento mayor que el tamaño del conjunto de resultados da un conjunto vacío. - - - - - &reftitle.parameters; - - - position - - - El número de elementos a ignorar para la operación limit(). - - - - - - - - &reftitle.returnvalues; - - Un objeto CollectionFind que puede ser utilizado para un tratamiento ulterior. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\CollectionFind::offset</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); -$create - ->add('{"name": "Alfred", "age": 18, "job": "Butler"}') - ->execute(); -$create - ->add('{"name": "Reginald", "age": 42, "job": "Butler"}') - ->execute(); - -// ... - -$collection = $schema->getCollection("people"); - -$result = $collection - ->find() - ->sort('age asc') - ->offset(1) - ->limit(1) - ->execute(); - -var_dump($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - - array(4) { - ["_id"]=> - string(28) "00005b6b536100000000000000f3" - ["age"]=> - int(42) - ["job"]=> - string(6) "Butler" - ["name"]=> - string(8) "Reginald" - } -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/sort.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/sort.xml deleted file mode 100644 index 69069a7ae2..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionfind/sort.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - CollectionFind::sort - Define los criterios de ordenación - - - - &reftitle.description; - - public mysql_xdevapi\CollectionFindmysql_xdevapi\CollectionFind::sort - stringsort_expr - - - Ordena el conjunto de resultados por el campo seleccionado en el argumento sort_expr. Los órdenes - permitidos son ASC (Ascendente) o DESC (Descendente). Esta operación es equivalente a la operación 'ORDER BY' SQL - y sigue el mismo conjunto de reglas. - - - - - - &reftitle.parameters; - - - sort_expr - - - Una o más expresiones de ordenación pueden ser proporcionadas. La evaluación se realiza de izquierda a derecha, - y cada expresión está separada por una coma. - - - - - - - - &reftitle.returnvalues; - - Un objeto CollectionFind que puede ser utilizado para ejecutar el comando, o para añadir operaciones adicionales. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\CollectionFind::sort</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); -$create - ->add('{"name": "Alfred", "age": 18, "job": "Butler"}') - ->execute(); -$create - ->add('{"name": "Reginald", "age": 42, "job": "Butler"}') - ->execute(); - -// ... - -$collection = $schema->getCollection("people"); - -$result = $collection - ->find() - ->sort('job desc', 'age asc') - ->execute(); - -var_dump($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - - array(4) { - ["_id"]=> - string(28) "00005b6b53610000000000000106" - ["age"]=> - int(18) - ["job"]=> - string(6) "Butler" - ["name"]=> - string(6) "Alfred" - } - [1]=> - array(4) { - ["_id"]=> - string(28) "00005b6b53610000000000000107" - ["age"]=> - int(42) - ["job"]=> - string(6) "Butler" - ["name"]=> - string(8) "Reginald" - } -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/arrayappend.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/arrayappend.xml deleted file mode 100644 index 0193f445da..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/arrayappend.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - CollectionModify::arrayAppend - Añade un elemento a un campo de array - - - - &reftitle.description; - - public mysql_xdevapi\CollectionModifymysql_xdevapi\CollectionModify::arrayAppend - stringcollection_field - stringexpression_or_literal - - - Añade un elemento a un campo de un documento, ya que varios elementos de un campo se representan como un array. - A diferencia de arrayInsert(), arrayAppend() siempre añade el nuevo elemento - al final del array, mientras que arrayInsert() puede definir la ubicación. - - - - - &reftitle.parameters; - - - collection_field - - - El identificador del campo donde se inserta el nuevo elemento. - - - - - expression_or_literal - - - El nuevo elemento a insertar al final del array del campo del documento. - - - - - - - - &reftitle.returnvalues; - - Un objeto CollectionModify que puede ser utilizado para ejecutar el comando, o para añadir operaciones adicionales. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\CollectionModify::arrayAppend</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$result = $collection - ->add( - '{"name": "Bernie", - "traits": ["Friend", "Brother", "Human"]}') - ->execute(); - -$collection - ->modify("name in ('Bernie', 'Jane')") - ->arrayAppend('traits', 'Happy') - ->execute(); - -$result = $collection - ->find() - ->execute(); - -print_r($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [_id] => 00005b6b5361000000000000010c - [name] => Bernie - [traits] => Array - ( - [0] => Friend - [1] => Brother - [2] => Human - [3] => Happy - ) - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/arrayinsert.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/arrayinsert.xml deleted file mode 100644 index 63622daeaf..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/arrayinsert.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - CollectionModify::arrayInsert - Inserta un elemento en un campo de array - - - - &reftitle.description; - - public mysql_xdevapi\CollectionModifymysql_xdevapi\CollectionModify::arrayInsert - stringcollection_field - stringexpression_or_literal - - - Añade un elemento a un campo de un documento, ya que varios elementos de un campo están - representados en forma de array. A diferencia de - mysql_xdevapi\CollectionModify::arrayAppend este método - permite especificar dónde se inserta el nuevo elemento definiendo después de qué elemento, - mientras que - mysql_xdevapi\CollectionModify::arrayAppend siempre - añade el nuevo elemento al final del array. - - - - - &reftitle.parameters; - - - collection_field - - - Identifica el elemento del array después del cual se insertará el nuevo elemento. - El formato de este parámetro es - FIELD_NAME[ INDEX ] donde - FIELD_NAME es el nombre del campo del documento - donde se añadirá el elemento, y INDEX - es el INDEX del elemento en el campo. - - - El INDEX está basado en cero, por lo que el primer elemento del array tiene un índice de 0. - - - - - expression_or_literal - - - El nuevo elemento a insertar después de FIELD_NAME[ INDEX ] - - - - - - - - &reftitle.returnvalues; - - Un objeto CollectionModify que puede ser utilizado para ejecutar el comando, o para añadir operaciones adicionales. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\CollectionModify::arrayInsert</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$result = $collection - ->add( - '{"name": "Bernie", - "traits": ["Friend", "Brother", "Human"]}') - ->execute(); - -$collection - ->modify("name in ('Bernie', 'Jane')") - ->arrayInsert('traits[1]', 'Happy') - ->execute(); - -$result = $collection - ->find() - ->execute(); - -print_r($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [_id] => 00005b6b5361000000000000010d - [name] => Bernie - [traits] => Array - ( - [0] => Friend - [1] => Happy - [2] => Brother - [3] => Human - ) - ) -) -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/bind.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/bind.xml deleted file mode 100644 index be35d306b2..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/bind.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - CollectionModify::bind - Liga un valor a un parámetro de consulta - - - - &reftitle.description; - - public mysql_xdevapi\CollectionModifymysql_xdevapi\CollectionModify::bind - arrayplaceholder_values - - - Liga un parámetro a un espacio reservado en la condición de búsqueda de la operación de modificación. - - - El espacio reservado tiene la forma de :NOMBRE donde ':' es un prefijo común que siempre debe existir antes de cualquier NOMBRE - donde NOMBRE es el nombre del espacio reservado. El método bind acepta una lista de espacios reservados si varias - entidades deben ser sustituidas en la condición de búsqueda de la operación de modificación. - - - - - - &reftitle.parameters; - - - placeholder_values - - - Los valores de espacio reservado a sustituir en la condición de búsqueda. Se permiten varios valores - y deben ser pasados en forma de array de mapeos NOMBRE_ESPACIO_RESERVADO->VALOR_ESPACIO_RESERVADO. - - - - - - - - &reftitle.returnvalues; - - Un objeto CollectionModify que puede ser utilizado para ejecutar el comando, o para añadir operaciones adicionales. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\CollectionModify::bind</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$result = $collection - ->add( - '{"name": "Bernie", - "traits": ["Friend", "Brother", "Human"]}') - ->execute(); - -$collection - ->modify("name = :name") - ->bind(['name' => 'Bernie']) - ->arrayAppend('traits', 'Happy') - ->execute(); - -$result = $collection - ->find() - ->execute(); - -print_r($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [_id] => 00005b6b53610000000000000110 - [name] => Bernie - [traits] => Array - ( - [0] => Friend - [1] => Brother - [2] => Human - [3] => Happy - ) - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/construct.xml deleted file mode 100644 index 052d8690b2..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/construct.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - CollectionModify::__construct - Constructor de CollectionModify - - - - &reftitle.description; - - private mysql_xdevapi\CollectionModify::__construct - - - - Modifica (actualiza) una colección y es instanciado por el método - mysql_xdevapi\Collection::modify. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\CollectionModify::__construct</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$result = $collection - ->add( - '{"name": "Bernie", - "traits": ["Friend", "Brother", "Human"]}') - ->execute(); - -$collection - ->modify("name in ('Bernie', 'Jane')") - ->arrayAppend('traits', 'Happy') - ->execute(); - -$result = $collection - ->find() - ->execute(); - -print_r($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [_id] => 00005b6b5361000000000000010c - [name] => Bernie - [traits] => Array - ( - [0] => Friend - [1] => Brother - [2] => Human - [3] => Happy - ) - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/execute.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/execute.xml deleted file mode 100644 index 1f7841ed8a..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/execute.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - CollectionModify::execute - Ejecuta la operación de modificación - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\CollectionModify::execute - - - - El método execute es requerido para enviar la solicitud de operación CRUD - al servidor MySQL. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objeto Result que puede ser utilizado para verificar el estado de la operación, - como el número de filas afectadas. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\CollectionModify::execute</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/limit.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/limit.xml deleted file mode 100644 index 59ac00f713..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/limit.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - CollectionModify::limit - Limita el número de documentos modificados - - - - &reftitle.description; - - public mysql_xdevapi\CollectionModifymysql_xdevapi\CollectionModify::limit - introws - - - Limita el número de documentos modificados por esta operación. - Combina eventualmente con skip() para definir un valor de desplazamiento. - - - - - &reftitle.parameters; - - - rows - - - El número máximo de documentos a modificar. - - - - - - - - &reftitle.returnvalues; - - Un objeto CollectionModify. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\CollectionModify::limit</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$collection->add('{"name": "Fred", "age": 21, "job": "Construction"}')->execute(); -$collection->add('{"name": "Wilma", "age": 23, "job": "Teacher"}')->execute(); -$collection->add('{"name": "Betty", "age": 24, "job": "Teacher"}')->execute(); - -$collection - ->modify("job = :job") - ->bind(['job' => 'Teacher']) - ->set('job', 'Principal') - ->limit(1) - ->execute(); - -$result = $collection - ->find() - ->execute(); - -print_r($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [_id] => 00005b6b53610000000000000118 - [age] => 21 - [job] => Construction - [name] => Fred - ) - [1] => Array - ( - [_id] => 00005b6b53610000000000000119 - [age] => 23 - [job] => Principal - [name] => Wilma - ) - [2] => Array - ( - [_id] => 00005b6b5361000000000000011a - [age] => 24 - [job] => Teacher - [name] => Betty - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/patch.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/patch.xml deleted file mode 100644 index 5b540526c3..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/patch.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - CollectionModify::patch - Corrige un documento - - - - &reftitle.description; - - public mysql_xdevapi\CollectionModifymysql_xdevapi\CollectionModify::patch - stringdocument - - - Toma un objeto patch y lo aplica sobre uno o varios documentos, y - puede actualizar varias propiedades del documento. - - - - - &reftitle.parameters; - - - document - - - Un documento con las propiedades a aplicar a los documentos correspondientes. - - - - - - - - &reftitle.returnvalues; - - Un objeto CollectionModify. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\CollectionModify::patch</function> - -modify('"Programmatore" IN job')->patch('{"Hobby" : "Programmare"}')->execute(); - -?> -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/replace.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/replace.xml deleted file mode 100644 index bb16a0b0c6..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/replace.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - CollectionModify::replace - Reemplaza un campo de documento - - - - &reftitle.description; - - public mysql_xdevapi\CollectionModifymysql_xdevapi\CollectionModify::replace - stringcollection_field - stringexpression_or_literal - - - Reemplaza (actualiza) un valor de campo dado por uno nuevo. - - - - - &reftitle.parameters; - - - collection_field - - - La ruta de acceso del documento del elemento a definir. - - - - - expression_or_literal - - - El valor a definir en el atributo especificado. - - - - - - - - &reftitle.returnvalues; - - Un objeto CollectionModify. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\CollectionModify::replace</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$result = $collection - ->add( - '{"name": "Bernie", - "traits": ["Friend", "Brother", "Human"]}') - ->execute(); - -$collection - ->modify("name = :name") - ->bind(['name' => 'Bernie']) - ->replace("name", "Bern") - ->execute(); - -$result = $collection - ->find() - ->execute(); - -print_r($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [_id] => 00005b6b5361000000000000011b - [name] => Bern - [traits] => Array - ( - [0] => Friend - [1] => Brother - [2] => Human - ) - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/set.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/set.xml deleted file mode 100644 index f8ac3fe3e8..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/set.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - CollectionModify::set - Define un atributo de documento - - - - &reftitle.description; - - public mysql_xdevapi\CollectionModifymysql_xdevapi\CollectionModify::set - stringcollection_field - stringexpression_or_literal - - - Define o actualiza atributos en documentos de una colección. - - - - - &reftitle.parameters; - - - collection_field - - - La ruta (nombre) del documento del elemento a definir. - - - - - expression_or_literal - - - El valor a definir en el atributo especificado. - - - - - - - - &reftitle.returnvalues; - - Un objeto CollectionModify. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\CollectionModify::set</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$result = $collection - ->add( - '{"name": "Bernie", - "traits": ["Friend", "Brother", "Human"]}') - ->execute(); - -$collection - ->modify("name = :name") - ->bind(['name' => 'Bernie']) - ->set("name", "Bern") - ->execute(); - -$result = $collection - ->find() - ->execute(); - -print_r($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [_id] => 00005b6b53610000000000000111 - [name] => Bern - [traits] => Array - ( - [0] => Friend - [1] => Brother - [2] => Human - ) - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/skip.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/skip.xml deleted file mode 100644 index ada505dc7a..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/skip.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - CollectionModify::skip - Ignorar los elementos - - - - &reftitle.description; - - public mysql_xdevapi\CollectionModifymysql_xdevapi\CollectionModify::skip - intposition - - - Ignora los N primeros elementos que de otro modo serían devueltos por una operación de búsqueda. - Si el número de elementos ignorados es superior al tamaño del conjunto de resultados, - entonces la operación de búsqueda devuelve un conjunto vacío. - - - - - &reftitle.parameters; - - - position - - - El número de elementos a ignorar. - - - - - - - - &reftitle.returnvalues; - - Un objeto CollectionModify para ser utilizado en un procesamiento posterior. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\CollectionModify::skip</function> - -modify('age > :age')->sort('age desc')->unset(['age'])->bind(['age' => 20])->limit(4)->skip(1)->execute(); - -?> -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/sort.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/sort.xml deleted file mode 100644 index 9c46499e35..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/sort.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - CollectionModify::sort - Define los criterios de ordenación - - - - &reftitle.description; - - public mysql_xdevapi\CollectionModifymysql_xdevapi\CollectionModify::sort - stringsort_expr - - - Ordena el conjunto de resultados por el campo seleccionado en el argumento sort_expr. Los órdenes permitidos - son ASC (Ascendente) o DESC (Descendente). Esta operación es equivalente a la operación SQL 'ORDER BY' - y sigue el mismo conjunto de reglas. - - - - - &reftitle.parameters; - - - sort_expr - - - Una o más expresiones de ordenación pueden ser proporcionadas. La evaluación se realiza de - izquierda a derecha y cada expresión debe estar separada por una coma. - - - - - - - - &reftitle.returnvalues; - - Un objeto CollectionModify que puede ser utilizado para un procesamiento posterior. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\CollectionModify::sort</function> - -modify('true')->sort('name desc', 'age asc')->limit(4)->set('Married', 'NO')->execute(); - -?> -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/unset.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/unset.xml deleted file mode 100644 index 60246e27e4..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionmodify/unset.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - CollectionModify::unset - Elimina el valor de los campos del documento - - - - &reftitle.description; - - public mysql_xdevapi\CollectionModifymysql_xdevapi\CollectionModify::unset - arrayfields - - - Elimina los atributos de los documentos en una colección. - - - - - &reftitle.parameters; - - - fields - - - Los atributos a eliminar de los documentos en una colección. - - - - - - - - &reftitle.returnvalues; - - Un objeto CollectionModify que puede ser utilizado para un procesamiento posterior. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\CollectionModify::unset</function> - -modify('job like :job_name')->unset(["age", "name"])->bind(['job_name' => 'Plumber'])->execute(); - -?> -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/bind.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/bind.xml deleted file mode 100644 index 221f8db48c..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/bind.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CollectionRemove::bind - Liga un valor a un argumento - - - - &reftitle.description; - - public mysql_xdevapi\CollectionRemovemysql_xdevapi\CollectionRemove::bind - arrayplaceholder_values - - - Liga un argumento al espacio reservado en la condición de búsqueda de la operación de eliminación. - - - El espacio reservado tiene la forma :NAME donde ':' es un prefijo común que siempre debe existir antes de cualquier NAME - donde NAME es el nombre del espacio reservado. El método bind acepta una lista de espacios reservados si varias - entidades deben ser sustituidas en la condición de búsqueda de la operación de eliminación. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - placeholder_values - - - El valor del espacio reservado a sustituir en la condición de búsqueda. Se permiten varios valores - y deben ser pasados en forma de un array de mapeos NOMBRE_ESPACIO_RESERVADO->VALOR_ESPACIO_RESERVADO. - - - - - - - - &reftitle.returnvalues; - - Un objeto CollectionRemove que puede ser utilizado para ejecutar el comando, o para añadir operaciones adicionales. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\CollectionRemove::bind</function> - -remove('age > :age_from and age < :age_to')->bind(['age_from' => 20, 'age_to' => 50])->limit(7)->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/construct.xml deleted file mode 100644 index 412a52b4b4..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/construct.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - CollectionRemove::__construct - Constructor de CollectionRemove - - - - &reftitle.description; - - private mysql_xdevapi\CollectionRemove::__construct - - - - Elimina los documentos de la colección y es instanciado por el método - mysql_xdevapi\Collection::remove. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Collection::remove</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("people"); - -$collection->add('{"name": "Alfred", "age": 18, "job": "Butler"}')->execute(); -$collection->add('{"name": "Bob", "age": 19, "job": "Painter"}')->execute(); - -// Elimina todos los pintores -$collection - ->remove("job in ('Painter')") - ->execute(); - -// Elimina el mayordomo más viejo -$collection - ->remove("job in ('Butler')") - ->sort('age desc') - ->limit(1) - ->execute(); - -// Elimina el registro con la edad más baja -$collection - ->remove('true') - ->sort('age desc') - ->limit(1) - ->execute(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/execute.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/execute.xml deleted file mode 100644 index 04da2a48f1..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/execute.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - CollectionRemove::execute - Ejecuta la operación de eliminación - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\CollectionRemove::execute - - - - La función execute debe ser invocada para desencadenar el envío de la solicitud de operación CRUD al servidor por parte del cliente. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Objeto Result. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\CollectionRemove::execute</function> - -remove('true')->sort('age desc')->limit(2)->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/limit.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/limit.xml deleted file mode 100644 index ea4766623f..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/limit.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - CollectionRemove::limit - Limita el número de documentos a eliminar - - - - &reftitle.description; - - public mysql_xdevapi\CollectionRemovemysql_xdevapi\CollectionRemove::limit - introws - - - Define el número máximo de documentos a eliminar. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - rows - - - El número máximo de documentos a eliminar. - - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto CollectionRemove que puede ser utilizado para ejecutar el comando, - o para añadir operaciones adicionales. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\CollectionRemove::limit</function> - -remove('job in (\'Barista\', \'Programmatore\', \'Ballerino\', \'Programmatrice\')')->limit(5)->sort(['age desc', 'name asc'])->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/sort.xml b/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/sort.xml deleted file mode 100644 index 19a066b26c..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/collectionremove/sort.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - CollectionRemove::sort - Define el criterio de ordenación - - - - &reftitle.description; - - public mysql_xdevapi\CollectionRemovemysql_xdevapi\CollectionRemove::sort - stringsort_expr - - - Ordena el conjunto de resultados por el campo seleccionado en el argumento sort_expr. Los órdenes permitidos - son ASC (Ascending) o DESC (Descending). Esta operación es equivalente a la operación SQL 'ORDER BY' - y sigue el mismo conjunto de reglas. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - sort_expr - - - Una o más expresiones de ordenación pueden ser proporcionadas. La evaluación se realiza de izquierda a derecha, - y cada expresión está separada por una coma. - - - - - - - - &reftitle.returnvalues; - - Un objeto CollectionRemove que puede ser utilizado para ejecutar el comando, o para añadir operaciones adicionales. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\CollectionRemove::sort</function> - -remove('true')->sort('age desc')->limit(2)->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/construct.xml deleted file mode 100644 index 1aa6a27519..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/construct.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - ColumnResult::__construct - Constructor de ColumnResult - - - - &reftitle.description; - - private mysql_xdevapi\ColumnResult::__construct - - - - Devuelve los metadatos de columna, tales como su conjunto de caracteres; esto es instanciado - por el método mysql_xdevapi\RowResult::getColumns. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\ColumnResult::__construct</function> - -sql("DROP DATABASE IF EXISTS nonsense")->execute(); -$session->sql("CREATE DATABASE nonsense")->execute(); -$session->sql("CREATE TABLE nonsense.numbers (hello int, world float unsigned)")->execute(); -$session->sql("INSERT INTO nonsense.numbers values (42, 42)")->execute(); - -$schema = $session->getSchema("nonsense"); -$table = $schema->getTable("numbers"); - -$result1 = $table->select('hello','world')->execute(); - -// Devuelve un array de objetos ColumnResult -$columns = $result1->getColumns(); - -foreach ($columns as $column) { - echo "\nColumn label " , $column->getColumnLabel(); - echo " is type " , $column->getType(); - echo " and is ", ($column->isNumberSigned() === 0) ? "unsigned." : "signed."; -} - -// O bien -$result2 = $session->sql("SELECT * FROM nonsense.numbers")->execute(); - -// Devuelve un array de objetos FieldMetadata -print_r($result2->getColumns()); -]]> - - &example.outputs.similar; - - mysql_xdevapi\FieldMetadata Object - ( - [type] => 1 - [type_name] => SINT - [name] => hello - [original_name] => hello - [table] => numbers - [original_table] => numbers - [schema] => nonsense - [catalog] => def - [collation] => 0 - [fractional_digits] => 0 - [length] => 11 - [flags] => 0 - [content_type] => 0 - ) - [1] => mysql_xdevapi\FieldMetadata Object - ( - [type] => 6 - [type_name] => FLOAT - [name] => world - [original_name] => world - [table] => numbers - [original_table] => numbers - [schema] => nonsense - [catalog] => def - [collation] => 0 - [fractional_digits] => 31 - [length] => 12 - [flags] => 1 - [content_type] => 0 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getcharactersetname.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getcharactersetname.xml deleted file mode 100644 index 5f30b7753a..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getcharactersetname.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - ColumnResult::getCharacterSetName - Devuelve el conjunto de caracteres - - - - &reftitle.description; - - public stringmysql_xdevapi\ColumnResult::getCharacterSetName - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\ColumnResult::getCharacterSetName</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getcollationname.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getcollationname.xml deleted file mode 100644 index a3855d51c2..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getcollationname.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - ColumnResult::getCollationName - Devuelve el nombre de la intercalación - - - - &reftitle.description; - - public stringmysql_xdevapi\ColumnResult::getCollationName - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\ColumnResult::getCollationName</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getcolumnlabel.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getcolumnlabel.xml deleted file mode 100644 index d18dd1e5a2..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getcolumnlabel.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - ColumnResult::getColumnLabel - Devuelve la etiqueta de columna - - - - &reftitle.description; - - public stringmysql_xdevapi\ColumnResult::getColumnLabel - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\ColumnResult::getColumnLabel</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getcolumnname.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getcolumnname.xml deleted file mode 100644 index ca65c67254..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getcolumnname.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - ColumnResult::getColumnName - Devuelve el nombre de la columna - - - - &reftitle.description; - - public stringmysql_xdevapi\ColumnResult::getColumnName - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\ColumnResult::getColumnName</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getfractionaldigits.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getfractionaldigits.xml deleted file mode 100644 index 7fb9c3d134..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getfractionaldigits.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - ColumnResult::getFractionalDigits - Devuelve la longitud de los dígitos fraccionarios - - - - &reftitle.description; - - public intmysql_xdevapi\ColumnResult::getFractionalDigits - - - - Recupera el número de dígitos fraccionarios para la columna. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\ColumnResult::getFractionalDigits</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getlength.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getlength.xml deleted file mode 100644 index 73c37aa2da..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getlength.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - ColumnResult::getLength - Devuelve la longitud del campo - - - - &reftitle.description; - - public intmysql_xdevapi\ColumnResult::getLength - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\ColumnResult::getLength</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getschemaname.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getschemaname.xml deleted file mode 100644 index f852e43b85..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/getschemaname.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - ColumnResult::getSchemaName - Devuelve el nombre del esquema - - - - &reftitle.description; - - public stringmysql_xdevapi\ColumnResult::getSchemaName - - - - Recupera el nombre del esquema donde la columna está almacenada. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\ColumnResult::getSchemaName</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/gettablelabel.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/gettablelabel.xml deleted file mode 100644 index 4942cf9800..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/gettablelabel.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - ColumnResult::getTableLabel - Devuelve la etiqueta de la tabla - - - - &reftitle.description; - - public stringmysql_xdevapi\ColumnResult::getTableLabel - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\ColumnResult::getTableLabel</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/gettablename.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/gettablename.xml deleted file mode 100644 index 0debc2c4dd..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/gettablename.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - ColumnResult::getTableName - Devuelve el nombre de la tabla - - - - &reftitle.description; - - public stringmysql_xdevapi\ColumnResult::getTableName - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El nombre de la tabla para la columna. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\ColumnResult::getTableName</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/gettype.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/gettype.xml deleted file mode 100644 index 55c07d5165..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/gettype.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - ColumnResult::getType - Devuelve el tipo de columna - - - - &reftitle.description; - - public intmysql_xdevapi\ColumnResult::getType - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\ColumnResult::getType</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/isnumbersigned.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/isnumbersigned.xml deleted file mode 100644 index 59252d86e4..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/isnumbersigned.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - ColumnResult::isNumberSigned - Indica si el tipo es signado - - - - &reftitle.description; - - public intmysql_xdevapi\ColumnResult::isNumberSigned - - - - Recupera la información de columna de una tabla e instancia el método - mysql_xdevapi\RowResult::getColumns. - - - &warn.undocumented.func; - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; si una columna dada es de tipo signado. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\ColumnResult::isNumberSigned</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/ispadded.xml b/reference/mysql_xdevapi/mysql_xdevapi/columnresult/ispadded.xml deleted file mode 100644 index c76d766c7c..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/columnresult/ispadded.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - ColumnResult::isPadded - Verifica si el campo tiene un relleno - - - - &reftitle.description; - - public intmysql_xdevapi\ColumnResult::isPadded - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; si una columna dada tiene un relleno. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\ColumnResult::isPadded</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/crudoperationbindable/bind.xml b/reference/mysql_xdevapi/mysql_xdevapi/crudoperationbindable/bind.xml deleted file mode 100644 index 688103160d..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/crudoperationbindable/bind.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - CrudOperationBindable::bind - Liga un valor a un espacio reservado - - - - &reftitle.description; - - abstract public mysql_xdevapi\CrudOperationBindablemysql_xdevapi\CrudOperationBindable::bind - arrayplaceholder_values - - - Liga un valor a un espacio reservado específico. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - placeholder_values - - - El nombre de los espacios reservados y los valores a ligar. - - - - - - - - &reftitle.returnvalues; - - Un objeto CrudOperationBindable - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\CrudOperationBindable::bind</function> - -modify('name like :name')->arrayInsert('job[0]', 'Calciatore')->bind(['name' => 'ENTITY'])->execute(); -$res = $table->delete()->orderby('age desc')->where('age < 20 and age > 12 and name != :name')->bind(['name' => 'Tierney'])->limit(2)->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/crudoperationlimitable/limit.xml b/reference/mysql_xdevapi/mysql_xdevapi/crudoperationlimitable/limit.xml deleted file mode 100644 index abb3c54365..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/crudoperationlimitable/limit.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - CrudOperationLimitable::limit - Define el límite de resultados - - - - &reftitle.description; - - abstract public mysql_xdevapi\CrudOperationLimitablemysql_xdevapi\CrudOperationLimitable::limit - introws - - - Define el número máximo de resultados o documentos a devolver. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - rows - - - El número máximo de resultados o documentos. - - - - - - - - &reftitle.returnvalues; - - Un objeto CrudOperationLimitable. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\CrudOperationLimitable::limit</function> - -find()->fields(['name as n','age as a','job as j'])->groupBy('j')->limit(11)->execute(); -$res = $table->update()->set('age',69)->where('age > 15 and age < 22')->limit(4)->orderby(['age asc','name desc'])->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/crudoperationskippable/skip.xml b/reference/mysql_xdevapi/mysql_xdevapi/crudoperationskippable/skip.xml deleted file mode 100644 index d829ce2d9e..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/crudoperationskippable/skip.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - CrudOperationSkippable::skip - El número de operaciones a ignorar - - - - &reftitle.description; - - abstract public mysql_xdevapi\CrudOperationSkippablemysql_xdevapi\CrudOperationSkippable::skip - intskip - - - Ignora este número de registros en la operación devuelta. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - skip - - - El número de elementos a ignorar. - - - - - - - - &reftitle.returnvalues; - - Un objeto CrudOperationSkippable. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\CrudOperationSkippable::skip</function> - -find('job like \'Programmatore\'')->limit(1)->skip(3)->sort('age asc')->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/crudoperationsortable/sort.xml b/reference/mysql_xdevapi/mysql_xdevapi/crudoperationsortable/sort.xml deleted file mode 100644 index 7fb16a523b..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/crudoperationsortable/sort.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - CrudOperationSortable::sort - Ordena los resultados - - - - &reftitle.description; - - abstract public mysql_xdevapi\CrudOperationSortable - mysql_xdevapi\CrudOperationSortable::sort - stringsort_expr - - - Ordena el conjunto de resultados por el campo seleccionado en el argumento sort_expr. Los órdenes permitidos - son ASC (Ascendente) o DESC (Descendente). Esta operación es equivalente a la operación SQL 'ORDER BY' - y sigue el mismo conjunto de reglas. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - sort_expr - - - Una o más expresiones de ordenación pueden ser proporcionadas. La evaluación se realiza de izquierda a derecha, - y cada expresión está separada por una coma. - - - - - - - - &reftitle.returnvalues; - - Un objeto CrudOperationSortable. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\CrudOperationSortable::sort</function> - -find('job like \'Cavia\'')->sort('age desc', '_id desc')->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/databaseobject/existsindatabase.xml b/reference/mysql_xdevapi/mysql_xdevapi/databaseobject/existsindatabase.xml deleted file mode 100644 index 3cb22af4b9..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/databaseobject/existsindatabase.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - DatabaseObject::existsInDatabase - Verifica si el objeto existe en la base de datos - - - - &reftitle.description; - - abstract public boolmysql_xdevapi\DatabaseObject::existsInDatabase - - - - Verifica si el objeto de base de datos hace referencia a un objeto que existe en la base de datos. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si el objeto existe en la base de datos, de lo contrario &false; si no existe. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\DatabaseObject::existsInDatabase</function> - -existsInDatabase(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/databaseobject/getname.xml b/reference/mysql_xdevapi/mysql_xdevapi/databaseobject/getname.xml deleted file mode 100644 index 0a579872f7..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/databaseobject/getname.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - DatabaseObject::getName - Devuelve el nombre del objeto - - - - &reftitle.description; - - abstract public stringmysql_xdevapi\DatabaseObject::getName - - - - Recupera el nombre de este objeto de base de datos. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El nombre de este objeto de base de datos. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\DatabaseObject::getName</function> - -getName(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/databaseobject/getsession.xml b/reference/mysql_xdevapi/mysql_xdevapi/databaseobject/getsession.xml deleted file mode 100644 index 08c495fcca..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/databaseobject/getsession.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - DatabaseObject::getSession - Devuelve el nombre de la sesión - - - - &reftitle.description; - - abstract public mysql_xdevapi\Sessionmysql_xdevapi\DatabaseObject::getSession - - - - Recupera la sesión asociada al objeto de base de datos. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El objeto Session. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\DatabaseObject::getSession</function> - -getSession(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/docresult/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/docresult/construct.xml deleted file mode 100644 index 250b828977..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/docresult/construct.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - DocResult::__construct - Constructor de DocResult - - - - &reftitle.description; - - private mysql_xdevapi\DocResult::__construct - - - - Recupera los resultados y las advertencias del documento, - y es instanciado por CollectionFind. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - Un ejemplo de DocResult - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$create->add('{"name": "Alfred", "age": 18, "job": "Butler"}')->execute(); -$create->add('{"name": "Reginald", "age": 42, "job": "Butler"}')->execute(); - -// ... - -$collection = $schema->getCollection("people"); - -// Devuelve un objeto DocResult -$result = $collection - ->find('job like :job and age > :age') - ->bind(['job' => 'Butler', 'age' => 16]) - ->sort('age desc') - ->limit(1) - ->execute(); - -var_dump($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - - array(4) { - ["_id"]=> - string(28) "00005b6b536100000000000000f3" - ["age"]=> - int(42) - ["job"]=> - string(6) "Butler" - ["name"]=> - string(8) "Reginald" - } -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/docresult/fetchall.xml b/reference/mysql_xdevapi/mysql_xdevapi/docresult/fetchall.xml deleted file mode 100644 index 2dbd91763d..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/docresult/fetchall.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - DocResult::fetchAll - Devuelve todas las filas - - - - &reftitle.description; - - public arraymysql_xdevapi\DocResult::fetchAll - - - - Devuelve todas las filas de un conjunto de resultados. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un array numérico con todos los resultados de la consulta; cada resultado es - un array asociativo. Un array vacío es devuelto si no hay - filas presentes. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\DocResult::fetchAll</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$create->add('{"name": "Alfred", "age": 18, "job": "Butler"}')->execute(); -$create->add('{"name": "Reginald", "age": 42, "job": "Butler"}')->execute(); - -// ... - -$collection = $schema->getCollection("people"); - -// Devuelve un objeto DocResult -$result = $collection - ->find('job like :job and age > :age') - ->bind(['job' => 'Butler', 'age' => 16]) - ->sort('age desc') - ->execute(); - -var_dump($result->fetchAll()); -?> -]]> - - &example.outputs.similar; - - - array(4) { - ["_id"]=> - string(28) "00005b6b53610000000000000123" - ["age"]=> - int(42) - ["job"]=> - string(6) "Butler" - ["name"]=> - string(8) "Reginald" - } - - [1]=> - array(4) { - ["_id"]=> - string(28) "00005b6b53610000000000000122" - ["age"]=> - int(18) - ["job"]=> - string(6) "Butler" - ["name"]=> - string(6) "Alfred" - } - -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/docresult/fetchone.xml b/reference/mysql_xdevapi/mysql_xdevapi/docresult/fetchone.xml deleted file mode 100644 index bd9f7a8b56..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/docresult/fetchone.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - DocResult::fetchOne - Devuelve una fila - - - - &reftitle.description; - - public arraymysql_xdevapi\DocResult::fetchOne - - - - Recupera un resultado de un conjunto de resultados. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El resultado, en forma de array asociativo - o &null; si no hay resultado presente. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\DocResult::fetchOne</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$create->add('{"name": "Alfred", "age": 18, "job": "Butler"}')->execute(); -$create->add('{"name": "Reginald", "age": 42, "job": "Butler"}')->execute(); - -// ... - -$collection = $schema->getCollection("people"); - -// Devuelve un objeto DocResult -$result = $collection - ->find('job like :job and age > :age') - ->bind(['job' => 'Butler', 'age' => 16]) - ->sort('age desc') - ->execute(); - -var_dump($result->fetchOne()); -?> -]]> - - &example.outputs.similar; - - - string(28) "00005b6b53610000000000000125" - ["age"]=> - int(42) - ["job"]=> - string(6) "Butler" - ["name"]=> - string(8) "Reginald" -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/docresult/getwarnings.xml b/reference/mysql_xdevapi/mysql_xdevapi/docresult/getwarnings.xml deleted file mode 100644 index aed902317c..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/docresult/getwarnings.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - DocResult::getWarnings - Devuelve los avisos de la última operación - - - - &reftitle.description; - - public Arraymysql_xdevapi\DocResult::getWarnings - - - - Recupera los avisos generados por la última operación del servidor MySQL. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un array de objetos Warning de la última operación. Cada objeto - define un 'message' de error, un 'nivel' de error y un 'code' de error. Un array - vacío es devuelto si no hay errores presentes. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\DocResult::getWarnings</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$create->add('{"name": "Alfred", "age": 18, "job": "Butler"}')->execute(); -$create->add('{"name": "Reginald", "age": 42, "job": "Butler"}')->execute(); - -// ... - -$collection = $schema->getCollection("people"); - -// Devuelve un objeto DocResult -$result = $collection - ->find('job like :job and age > :age') - ->bind(['job' => 'Butler', 'age' => 16]) - ->sort('age desc') - ->execute(); - -if (!$result->getWarningsCount()) { - echo "Hubo un error:\n"; - print_r($result->getWarnings()); - exit; -} - -var_dump($result->fetchOne()); -?> -]]> - - &example.outputs.similar; - - mysql_xdevapi\Warning Object - ( - [message] => Algo malo y así sucesivamente - [level] => 2 - [code] => 1365 - ) - [1] => mysql_xdevapi\Warning Object - ( - [message] => Algo malo y así sucesivamente - [level] => 2 - [code] => 1365 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/docresult/getwarningscount.xml b/reference/mysql_xdevapi/mysql_xdevapi/docresult/getwarningscount.xml deleted file mode 100644 index 394e7e820c..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/docresult/getwarningscount.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - DocResult::getWarningsCount - Devuelve el número de advertencias de la última operación - - - - &reftitle.description; - - public intmysql_xdevapi\DocResult::getWarningsCount - - - - Devuelve el número de advertencias generadas por la última operación. Más - precisamente, estas advertencias son generadas por el servidor MySQL. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El número de advertencias de la última operación. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\DocResult::getWarningsCount</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$create->add('{"name": "Alfred", "age": 18, "job": "Butler"}')->execute(); -$create->add('{"name": "Reginald", "age": 42, "job": "Butler"}')->execute(); - -// ... - -$collection = $schema->getCollection("people"); - -// Devuelve un objeto DocResult -$result = $collection - ->find('job like :job and age > :age') - ->bind(['job' => 'Butler', 'age' => 16]) - ->sort('age desc') - ->execute(); - -if (!$result->getWarningsCount()) { - echo "Hubo un error:\n"; - print_r($result->getWarnings()); - exit; -} - -var_dump($result->fetchOne()); -?> -]]> - - &example.outputs.similar; - - - string(28) "00005b6b53610000000000000135" - ["age"]=> - int(42) - ["job"]=> - string(6) "Butler" - ["name"]=> - string(8) "Reginald" -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/executable/execute.xml b/reference/mysql_xdevapi/mysql_xdevapi/executable/execute.xml deleted file mode 100644 index f173b969b3..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/executable/execute.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Executable::execute - Ejecuta una declaración - - - - &reftitle.description; - - abstract public mysql_xdevapi\Resultmysql_xdevapi\Executable::execute - - - - Ejecuta la declaración a partir de una operación de colección o de una consulta de tabla; - esta funcionalidad permite el encadenamiento de métodos. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Uno de los objetos Result, tales como Result o SqlStatementResult. - - - - - &reftitle.examples; - - Ejemplos de execute() - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$result_sql = $session->sql("CREATE DATABASE addressbook")->execute(); - -var_dump($result_sql); - -$schema = $session->getSchema("addressbook"); -$collection = $schema->createCollection("humans"); - -$result_collection = $collection->add( - '{"name": "Jane", - "jobs": [{"title":"Scientist","Salary":18000}, {"title":"Mother","Salary":0}], - "hobbies": ["Walking","Making pies"]}'); - -$result_collection_executed = $result_collection->execute(); - -var_dump($result_collection); -var_dump($result_collection_executed); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/executionstatus/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/executionstatus/construct.xml deleted file mode 100644 index 59d06fbeca..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/executionstatus/construct.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - ExecutionStatus::__construct - Constructor de ExecutionStatus - - - - &reftitle.description; - - private mysql_xdevapi\ExecutionStatus::__construct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\ExecutionStatus::__construct</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/expression/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/expression/construct.xml deleted file mode 100644 index d39fbb7c76..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/expression/construct.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Expression::__construct - Constructor de Expression - - - - &reftitle.description; - - public mysql_xdevapi\Expression::__construct - stringexpression - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - expression - - - - - - - - - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Expression::__construct</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/result/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/result/construct.xml deleted file mode 100644 index c2c3872565..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/result/construct.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Result::__construct - Constructor de Result - - - - &reftitle.description; - - private mysql_xdevapi\Result::__construct - - - - Un objeto que recupera los ID generados, los valores AUTO_INCREMENT y las advertencias, - para un conjunto de resultados. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Result::__construct</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql(" - CREATE TABLE addressbook.names - (id INT NOT NULL AUTO_INCREMENT, name VARCHAR(30), age INT, PRIMARY KEY (id)) - ")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$result = $table->insert("name", "age")->values(["Suzanne", 31],["Julie", 43])->execute(); -$result = $table->insert("name", "age")->values(["Suki", 34])->execute(); - -$ai = $result->getAutoIncrementValue(); -var_dump($ai); -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/result/getaffecteditemscount.xml b/reference/mysql_xdevapi/mysql_xdevapi/result/getaffecteditemscount.xml deleted file mode 100644 index e93fb73d0c..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/result/getaffecteditemscount.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Result::getAffectedItemsCount - Devuelve el número de filas afectadas - - - - &reftitle.description; - - public intmysql_xdevapi\Result::getAffectedItemsCount - - - - Devuelve el número de filas afectadas por la operación anterior. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El número (como integer) de filas afectadas. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Result::getAffectedItemsCount</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$collection = $schema->getCollection("people"); - -$result = $collection->add('{"name": "Wilma", "age": 23, "job": "Teacher"}')->execute(); - -var_dump( $res->getAffectedItemsCount() ); -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/result/getautoincrementvalue.xml b/reference/mysql_xdevapi/mysql_xdevapi/result/getautoincrementvalue.xml deleted file mode 100644 index e47a72573e..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/result/getautoincrementvalue.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - Result::getAutoIncrementValue - Devuelve el valor auto-incrementado - - - - &reftitle.description; - - public intmysql_xdevapi\Result::getAutoIncrementValue - - - - Devuelve el último valor AUTO_INCREMENT (último identificador insertado). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El último valor AUTO_INCREMENT. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Result::getAutoIncrementValue</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql(" - CREATE TABLE addressbook.names - (id INT NOT NULL AUTO_INCREMENT, name VARCHAR(30), age INT, PRIMARY KEY (id)) - ")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$result = $table->insert("name", "age")->values(["Suzanne", 31],["Julie", 43])->execute(); -$result = $table->insert("name", "age")->values(["Suki", 34])->execute(); - -$ai = $result->getAutoIncrementValue(); -var_dump($ai); -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/result/getgeneratedids.xml b/reference/mysql_xdevapi/mysql_xdevapi/result/getgeneratedids.xml deleted file mode 100644 index 7f56565d91..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/result/getgeneratedids.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - Result::getGeneratedIds - Devuelve los ID generados - - - - &reftitle.description; - - public arraymysql_xdevapi\Result::getGeneratedIds - - - - Recupera los valores _id generados por la última operación. - El campo _id único es generado por el servidor MySQL. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un array de _id generados por la última operación, - o un array vacío si no hay ninguno. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Result::getGeneratedIds</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$create = $schema->createCollection("people"); - -$collection = $schema->getCollection("people"); - -$result = $collection->add( - '{"name": "Bernie", - "jobs": [{"title":"Cat Herder","Salary":42000}, {"title":"Father","Salary":0}], - "hobbies": ["Sports","Making cupcakes"]}', - '{"name": "Jane", - "jobs": [{"title":"Scientist","Salary":18000}, {"title":"Mother","Salary":0}], - "hobbies": ["Walking","Making pies"]}')->execute(); - -$ids = $result->getGeneratedIds(); -var_dump($ids); -?> -]]> - - &example.outputs.similar; - - - string(28) "00005b6b53610000000000000064" - [1]=> - string(28) "00005b6b53610000000000000065" -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/result/getwarnings.xml b/reference/mysql_xdevapi/mysql_xdevapi/result/getwarnings.xml deleted file mode 100644 index 62c0a28f26..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/result/getwarnings.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Result::getWarnings - Devuelve las advertencias de la última operación - - - - &reftitle.description; - - public arraymysql_xdevapi\Result::getWarnings - - - - Devuelve las advertencias de la última operación Result. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un array de objetos Warning de la última operación. Cada objeto - define un mensaje de error, un nivel de error y un código de error. - Se devuelve un array vacío si no hay errores. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\RowResult::getWarnings</function> - -sql("CREATE DATABASE foo")->execute(); -$session->sql("CREATE TABLE foo.test_table(x int)")->execute(); - -$schema = $session->getSchema("foo"); -$table = $schema->getTable("test_table"); - -$table->insert(['x'])->values([1])->values([2])->execute(); - -$res = $table->select(['x/0 as bad_x'])->execute(); -$warnings = $res->getWarnings(); - -print_r($warnings); -?> -]]> - - &example.outputs.similar; - - mysql_xdevapi\Warning Object - ( - [message] => Division by 0 - [level] => 2 - [code] => 1365 - ) - [1] => mysql_xdevapi\Warning Object - ( - [message] => Division by 0 - [level] => 2 - [code] => 1365 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/result/getwarningscount.xml b/reference/mysql_xdevapi/mysql_xdevapi/result/getwarningscount.xml deleted file mode 100644 index 256f874693..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/result/getwarningscount.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Result::getWarningsCount - Devuelve el número de advertencias de la última operación - - - - &reftitle.description; - - public intmysql_xdevapi\Result::getWarningsCount - - - - Devuelve el número de advertencias generadas por la última operación. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El número de advertencias generadas por la última operación. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\RowResult::getWarningsCount</function> - -sql("DROP DATABASE IF EXISTS foo")->execute(); -$session->sql("CREATE DATABASE foo")->execute(); -$session->sql("CREATE TABLE foo.test_table(x int)")->execute(); - -$schema = $session->getSchema("foo"); -$table = $schema->getTable("test_table"); - -$table->insert(['x'])->values([1])->values([2])->execute(); - -$res = $table->select(['x/0 as bad_x'])->execute(); - -echo $res->getWarningsCount(); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/construct.xml deleted file mode 100644 index 37637e6eb7..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/construct.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - RowResult::__construct - Constructor de RowResult - - - - &reftitle.description; - - private mysql_xdevapi\RowResult::__construct - - - - Representa el conjunto de resultados obtenidos a partir de la consulta de la base de datos. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\RowResult::__construct</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$row = $table->select('name', 'age')->where('age > 18')->execute()->fetchAll(); - -print_r($row); -]]> - - &example.outputs.similar; - - Array - ( - [name] => John - [age] => 42 - ) - [1] => Array - ( - [name] => Sam - [age] => 33 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/fetchall.xml b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/fetchall.xml deleted file mode 100644 index c69ae86a7b..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/fetchall.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - RowResult::fetchAll - Devuelve todas las filas del resultado - - - - &reftitle.description; - - public arraymysql_xdevapi\RowResult::fetchAll - - - - Recupera todas las filas del conjunto de resultados. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un array numérico con todos los resultados de la consulta; cada resultado es - un array asociativo. Se devuelve un array vacío si no hay filas presentes. - - - - - &reftitle.examples; - - <function>mysql_xdevapi\RowResult::fetchAll</function> example - -sql("DROP DATABASE addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$row = $table->select('name', 'age')->execute()->fetchAll(); - -print_r($row); -]]> - - &example.outputs.similar; - - Array - ( - [name] => John - [age] => 42 - ) - [1] => Array - ( - [name] => Sam - [age] => 33 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/fetchone.xml b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/fetchone.xml deleted file mode 100644 index de2159c48e..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/fetchone.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - RowResult::fetchOne - Devuelve una fila del resultado - - - - &reftitle.description; - - public arraymysql_xdevapi\RowResult::fetchOne - - - - Recupera una fila del conjunto de resultados. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El resultado, en forma de array asociativo - o &null; si no hay resultado presente. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\RowResult::fetchOne</function> - -sql("DROP DATABASE addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$row = $table->select('name', 'age')->where('age < 40')->execute()->fetchOne(); - -print_r($row); -]]> - - &example.outputs.similar; - - Sam - [age] => 33 -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumncount.xml b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumncount.xml deleted file mode 100644 index f1ae291d9c..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumncount.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - RowResult::getColumnsCount - Devuelve el número de columnas - - - - &reftitle.description; - - public intmysql_xdevapi\RowResult::getColumnsCount - - - - Devuelve el número de columnas presentes en el conjunto de resultados. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El número de columnas; 0 si no hay ninguna. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.0.14 - - El método ha sido renombrado de getColumnCount() a getColumnsCount(). - - - - - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\RowResult::getColumnsCount</function> - -sql("DROP DATABASE addressbook")->execute(); -$session->sql("CREATE DATABASE foo")->execute(); -$session->sql("CREATE TABLE foo.test_table(x int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$sql = $session->sql("SELECT * from addressbook.names")->execute(); - -echo $sql->getColumnsCount(); -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumnnames.xml b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumnnames.xml deleted file mode 100644 index f6750dcb22..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumnnames.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - RowResult::getColumnNames - Devuelve el nombre de todas las columnas - - - - &reftitle.description; - - public arraymysql_xdevapi\RowResult::getColumnNames - - - - Devuelve el nombre de las columnas presentes en el conjunto de resultados. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un array numérico de nombres de columnas de tabla, - o un array vacío si el conjunto de resultados está vacío. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\RowResult::getColumnNames</function> - -sql("DROP DATABASE addressbook")->execute(); -$session->sql("CREATE DATABASE foo")->execute(); -$session->sql("CREATE TABLE foo.test_table(x int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$sql = $session->sql("SELECT * from addressbook.names")->execute(); - -$colnames = $sql->getColumnNames(); - -print_r($colnames); -]]> - - &example.outputs.similar; - - name - [1] => age -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumns.xml b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumns.xml deleted file mode 100644 index eb7af7bb9e..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumns.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - RowResult::getColumns - Devuelve los metadatos de las columnas - - - - &reftitle.description; - - public arraymysql_xdevapi\RowResult::getColumns - - - - Devuelve los metadatos de las columnas presentes en el conjunto de resultados. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un array de FieldMetadata que representa las columnas del resultado, - o un array vacío si el conjunto de resultados está vacío. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\RowResult::getColumns</function> - -sql("DROP DATABASE addressbook")->execute(); -$session->sql("CREATE DATABASE foo")->execute(); -$session->sql("CREATE TABLE foo.test_table(x int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$sql = $session->sql("SELECT * from addressbook.names")->execute(); - -$cols = $sql->getColumns(); - -print_r($cols); -]]> - - &example.outputs.similar; - - mysql_xdevapi\FieldMetadata Object - ( - [type] => 7 - [type_name] => BYTES - [name] => name - [original_name] => name - [table] => names - [original_table] => names - [schema] => addressbook - [catalog] => def - [collation] => 255 - [fractional_digits] => 0 - [length] => 65535 - [flags] => 0 - [content_type] => 0 - ) - [1] => mysql_xdevapi\FieldMetadata Object - ( - [type] => 1 - [type_name] => SINT - [name] => age - [original_name] => age - [table] => names - [original_table] => names - [schema] => addressbook - [catalog] => def - [collation] => 0 - [fractional_digits] => 0 - [length] => 11 - [flags] => 0 - [content_type] => 0 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getwarnings.xml b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getwarnings.xml deleted file mode 100644 index cdc4f01ea1..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getwarnings.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - RowResult::getWarnings - Devuelve las advertencias de la última operación - - - - &reftitle.description; - - public arraymysql_xdevapi\RowResult::getWarnings - - - - Devuelve las advertencias de la última operación RowResult. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un array de objetos Warning de la última operación. Cada objeto - define un mensaje de error 'message', un nivel de error 'level', y un código de error 'code'. Un array - vacío es devuelto si no hay errores presentes. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\RowResult::getWarnings</function> - -sql("CREATE DATABASE foo")->execute(); -$session->sql("CREATE TABLE foo.test_table(x int)")->execute(); - -$schema = $session->getSchema("foo"); -$table = $schema->getTable("test_table"); - -$table->insert(['x'])->values([1])->values([2])->execute(); - -$res = $table->select(['x/0 as bad_x'])->execute(); -$warnings = $res->getWarnings(); - -print_r($warnings); -?> -]]> - - &example.outputs.similar; - - mysql_xdevapi\Warning Object - ( - [message] => Division by 0 - [level] => 2 - [code] => 1365 - ) - [1] => mysql_xdevapi\Warning Object - ( - [message] => Division by 0 - [level] => 2 - [code] => 1365 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getwarningscount.xml b/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getwarningscount.xml deleted file mode 100644 index 2e1b834234..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/rowresult/getwarningscount.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - RowResult::getWarningsCount - Devuelve el número de advertencias de la última operación - - - - &reftitle.description; - - public intmysql_xdevapi\RowResult::getWarningsCount - - - - Devuelve el número de advertencias generadas por la última operación. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El número de advertencias generadas por la última operación. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\RowResult::getWarningsCount</function> - -sql("DROP DATABASE IF EXISTS foo")->execute(); -$session->sql("CREATE DATABASE foo")->execute(); -$session->sql("CREATE TABLE foo.test_table(x int)")->execute(); - -$schema = $session->getSchema("foo"); -$table = $schema->getTable("test_table"); - -$table->insert(['x'])->values([1])->values([2])->execute(); - -$res = $table->select(['x/0 as bad_x'])->execute(); - -echo $res->getWarningsCount(); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/construct.xml deleted file mode 100644 index 132a70b2f7..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/construct.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Schema::__construct - Constructor de schema - - - - &reftitle.description; - - private mysql_xdevapi\Schema::__construct - - - - El objeto Schema proporciona acceso completo al esquema (base de datos). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - Ejemplo de <methodname>mysql_xdevapi\Schema::__construct</methodname> - -sql("DROP DATABASE IF EXISTS food")->execute(); -$session->sql("CREATE DATABASE food")->execute(); -$session->sql("CREATE TABLE food.fruit(name text, rating text)")->execute(); - -$schema = $session->getSchema("food"); -$schema->createCollection("trees"); - -print_r($schema->gettables()); -print_r($schema->getcollections()); -]]> - - &example.outputs.similar; - - mysql_xdevapi\Table Object - ( - [name] => fruit - ) -) -Array -( - [trees] => mysql_xdevapi\Collection Object - ( - [name] => trees - ) -) -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/createcollection.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/createcollection.xml deleted file mode 100644 index 2b5a977e31..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/createcollection.xml +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - Schema::createCollection - Añade una colección al esquema - - - - &reftitle.description; - - public mysql_xdevapi\Collectionmysql_xdevapi\Schema::createCollection - stringname - stringvalidate - - - Crea una colección en el esquema. - - - - - &reftitle.parameters; - - - name - - - El nombre de la colección. - - - - - validate - - - La definición de validación, como un objeto JSON. - - - - - - - - &reftitle.returnvalues; - - El objeto Collection. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.0.20 - - Adición del argumento opcional validate. - - - - - - - - - &reftitle.examples; - - Ejemplo de <methodname>mysql_xdevapi\Schema::createCollection</methodname> - -sql("DROP DATABASE IF EXISTS food")->execute(); -$session->sql("CREATE DATABASE food")->execute(); -$session->sql("CREATE TABLE food.fruit(name text, rating text)")->execute(); - -$schema = $session->getSchema("food"); -$schema->createCollection("trees"); - -print_r($schema->gettables()); -print_r($schema->getcollections()); -]]> - - &example.outputs.similar; - - mysql_xdevapi\Table Object - ( - [name] => fruit - ) -) -Array -( - [trees] => mysql_xdevapi\Collection Object - ( - [name] => trees - ) -) -]]> - - - - Ejemplo de <methodname>mysql_xdevapi\Schema::createCollection</methodname> - - createCollection("mycollection", '{ - "validation": { - "level": "strict", - "schema": { - "id": "http://json-schema.org/geo", - "description": "A geographical coordinate", - "type": "object", - "properties": { - "latitude": { - "type": "number" - }, - "longitude": { - "type": "number" - } - }, - "required": ["latitude", "longitude"] - } - } -}'); -// Éxito -$collection->add('{"latitude": 10, "longitude": 20}')->execute(); - -// Fallo, tipos inválidos (no son números) -$collection->add('{"latitude": "lat", "longitude": "long"}')->execute(); -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/dropcollection.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/dropcollection.xml deleted file mode 100644 index 0b4ec7e608..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/dropcollection.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - Schema::dropCollection - Elimina una colección del esquema - - - - &reftitle.description; - - public boolmysql_xdevapi\Schema::dropCollection - stringcollection_name - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - collection_name - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo de <methodname>mysql_xdevapi\Schema::dropCollection</methodname> - -sql("DROP DATABASE IF EXISTS food")->execute(); -$session->sql("CREATE DATABASE food")->execute(); -$session->sql("CREATE TABLE food.fruit(name text, rating text)")->execute(); - -$schema = $session->getSchema("food"); - -$schema->createCollection("trees"); -$schema->dropCollection("trees"); -$schema->createCollection("buildings"); - -print_r($schema->gettables()); -print_r($schema->getcollections()); -]]> - - &example.outputs.similar; - - mysql_xdevapi\Table Object - ( - [name] => fruit - ) -) -Array -( - [buildings] => mysql_xdevapi\Collection Object - ( - [name] => buildings - ) -) -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/existsindatabase.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/existsindatabase.xml deleted file mode 100644 index c119577181..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/existsindatabase.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Schema::existsInDatabase - Verifica si el objeto existe en la base de datos - - - - &reftitle.description; - - public boolmysql_xdevapi\Schema::existsInDatabase - - - - Verifica si el objeto actual (esquema, tabla, colección o vista) existe - en el objeto esquema. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; si el esquema, la tabla, la colección o la vista aún existe en el esquema, de lo contrario &false;. - - - - - &reftitle.examples; - - Ejemplo de <methodname>mysql_xdevapi\Schema::existsInDatabase</methodname> - -sql("DROP DATABASE IF EXISTS food")->execute(); -$session->sql("CREATE DATABASE food")->execute(); -$session->sql("CREATE TABLE food.fruit(name text, rating text)")->execute(); - -$schema = $session->getSchema("food"); -$schema->createCollection("trees"); - -// ... - -$trees = $schema->getCollection("trees"); - -// ... - -// ¿Esta colección aún está en la base de datos (esquema)? -if ($trees->existsInDatabase()) { - echo "Yes, the 'trees' collection is still present."; -} -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollection.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollection.xml deleted file mode 100644 index 5fe73f3b44..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollection.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - Schema::getCollection - Devuelve una colección del esquema - - - - &reftitle.description; - - public mysql_xdevapi\Collectionmysql_xdevapi\Schema::getCollection - stringname - - - Devuelve una colección del esquema. - - - - - &reftitle.parameters; - - - name - - - El nombre de la colección a recuperar. - - - - - - - - &reftitle.returnvalues; - - El objeto Collection para la colección seleccionada. - - - - - &reftitle.examples; - - Ejemplo de <methodname>mysql_xdevapi\Schema::getCollection</methodname> - -sql("DROP DATABASE IF EXISTS food")->execute(); -$session->sql("CREATE DATABASE food")->execute(); - -$schema = $session->getSchema("food"); -$schema->createCollection("trees"); - -// ... - -$trees = $schema->getCollection("trees"); - -var_dump($trees); -]]> - - &example.outputs.similar; - - - string(5) "trees" -} -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollectionastable.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollectionastable.xml deleted file mode 100644 index 4b39e60b43..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollectionastable.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - Schema::getCollectionAsTable - Devuelve una colección como objeto Table - - - - &reftitle.description; - - public mysql_xdevapi\Tablemysql_xdevapi\Schema::getCollectionAsTable - stringname - - - Devuelve una colección, pero como objeto Table en lugar de un objeto Collection. - - - - - &reftitle.parameters; - - - name - - - El nombre de la colección a partir de la cual instanciar un objeto Table. - - - - - - - - &reftitle.returnvalues; - - Un objeto mysql_xdevapi\Table para la colección. - - - - - &reftitle.examples; - - Ejemplo de <methodname>mysql_xdevapi\Schema::getCollectionAsTable</methodname> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collect = $schema->createCollection("people"); -$collect->add('{"name": "Fred", "age": 21, "job": "Construction"}')->execute(); -$collect->add('{"name": "Wilma", "age": 23, "job": "Teacher"}')->execute(); - -$table = $schema->getCollectionAsTable("people"); -$collection = $schema->getCollection("people"); - -var_dump($table); -var_dump($collection); -]]> - - &example.outputs.similar; - - - string(6) "people" -} - -object(mysql_xdevapi\Collection)#5 (1) { - ["name"]=> - string(6) "people" -} -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollections.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollections.xml deleted file mode 100644 index ef2922b4ee..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/getcollections.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Schema::getCollections - Devuelve todas las colecciones del esquema - - - - &reftitle.description; - - public arraymysql_xdevapi\Schema::getCollections - - - - Recupera una lista de colecciones para este esquema. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un array de todas las colecciones de este esquema, donde cada elemento del array - es una Collection con el nombre de la colección como clave. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Schema::getCollections</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); -$collect = $schema->createCollection("people"); -$collect->add('{"name": "Fred", "age": 21, "job": "Construction"}')->execute(); -$collect->add('{"name": "Wilma", "age": 23, "job": "Teacher"}')->execute(); - -$collections = $schema->getCollections(); -var_dump($collections); -?> -]]> - - &example.outputs.similar; - - - object(mysql_xdevapi\Collection)#4 (1) { - ["name"]=> - string(6) "people" - } -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/getname.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/getname.xml deleted file mode 100644 index 29ea28dfdb..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/getname.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - Schema::getName - Devuelve el nombre del esquema - - - - &reftitle.description; - - public stringmysql_xdevapi\Schema::getName - - - - Devuelve el nombre del esquema. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El nombre del esquema conectado al objeto esquema, en forma de string. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Schema::getName</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); - -// ... - -var_dump($schema->getName()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/getsession.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/getsession.xml deleted file mode 100644 index 9fc2fbc754..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/getsession.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Schema::getSession - Devuelve la sesión del esquema - - - - &reftitle.description; - - public mysql_xdevapi\Sessionmysql_xdevapi\Schema::getSession - - - - Devuelve un nuevo objeto Session a partir del objeto Schema. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objeto Session. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Schema::getSession</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$schema = $session->getSchema("addressbook"); - -// ... - -$newsession = $schema->getSession(); - -var_dump($session); -var_dump($newsession); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/gettable.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/gettable.xml deleted file mode 100644 index 7e099be886..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/gettable.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - Schema::getTable - Devuelve la tabla del esquema - - - - &reftitle.description; - - public mysql_xdevapi\Tablemysql_xdevapi\Schema::getTable - stringname - - - Recupera un objeto Table para la tabla proporcionada en el esquema. - - - - - &reftitle.parameters; - - - name - - - El nombre de la tabla. - - - - - - - - &reftitle.returnvalues; - - Un objeto table. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Schema::getTable</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$row = $table->select('name', 'age')->execute()->fetchAll(); - -print_r($row); -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => John - [age] => 42 - ) - [1] => Array - ( - [name] => Sam - [age] => 33 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schema/gettables.xml b/reference/mysql_xdevapi/mysql_xdevapi/schema/gettables.xml deleted file mode 100644 index edb309fa63..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/schema/gettables.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Schema::getTables - Devuelve las tablas del esquema - - - - &reftitle.description; - - public arraymysql_xdevapi\Schema::getTables - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un array de todas las tablas de este esquema, donde cada elemento del array - es un objeto Table con el nombre de la tabla como clave. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Schema::getTables</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); - -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$session->sql("CREATE TABLE addressbook.cities(name text, population int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('Portland', 639863), ('Seattle', 704352)")->execute(); - -$schema = $session->getSchema("addressbook"); -$tables = $schema->getTables(); - -var_dump($tables); -?> -]]> - - &example.outputs.similar; - - - object(mysql_xdevapi\Table)#3 (1) { - ["name"]=> - string(6) "cities" - } - - ["names"]=> - object(mysql_xdevapi\Table)#4 (1) { - ["name"]=> - string(5) "names" - } -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/schemaobject/getschema.xml b/reference/mysql_xdevapi/mysql_xdevapi/schemaobject/getschema.xml deleted file mode 100644 index 9936d308c0..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/schemaobject/getschema.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - SchemaObject::getSchema - Devuelve el objeto esquema - - - - &reftitle.description; - - abstract mysql_xdevapi\Schemamysql_xdevapi\SchemaObject::getSchema - - - - Utilizado por otros objetos para recuperar un objeto esquema. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El objeto esquema actual. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Session::getSchema</function> - -getSchema("addressbook"); - -print_r($schema); -]]> - - &example.outputs.similar; - - addressbook -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/close.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/close.xml deleted file mode 100644 index 415c6da345..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/close.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - Session::close - Cierra la sesión - - - - &reftitle.description; - - public boolmysql_xdevapi\Session::close - - - - Cierra la sesión con el servidor. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; si la sesión ha sido cerrada. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Session::close</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$session->close(); -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/commit.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/commit.xml deleted file mode 100644 index 6fc62d8526..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/commit.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - Session::commit - Valida la transacción - - - - &reftitle.description; - - public Objectmysql_xdevapi\Session::commit - - - - Valida la transacción. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objeto SqlStatementResult. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Session::commit</function> - -getSchema("addressbook")->getCollection("friends"); - -$session->startTransaction(); - -$collection->add('{"John":42, "Sam":33}')->execute(); -$savepoint = $session->setSavepoint(); - -$session->commit(); -$session->close(); -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/construct.xml deleted file mode 100644 index 2940f5c2f3..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/construct.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - Session::__construct - Descripción del constructor - - - - &reftitle.description; - - private mysql_xdevapi\Session::__construct - - - - Un objeto Session, tal como iniciado por getSession(). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Session::__construct</function> - -close(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/createschema.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/createschema.xml deleted file mode 100644 index d0fc67649c..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/createschema.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - Session::createSchema - Crear un nuevo esquema - - - - &reftitle.description; - - public mysql_xdevapi\Schemamysql_xdevapi\Session::createSchema - stringschema_name - - - Crear un nuevo esquema. - - - - - &reftitle.parameters; - - - schema_name - - - El nombre del esquema a crear. - - - - - - - - &reftitle.returnvalues; - - Un objeto Schema en caso de éxito, y lanza una excepción en caso de fallo. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Session::createSchema</function> - -createSchema('fruit')) { - echo "Info: I created a schema named 'fruit'\n"; - } - -} catch (Exception $e) { - - echo $e->getMessage(); - -} -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/dropschema.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/dropschema.xml deleted file mode 100644 index 68ed896016..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/dropschema.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Session::dropSchema - Elimina un esquema - - - - &reftitle.description; - - public boolmysql_xdevapi\Session::dropSchema - stringschema_name - - - Elimina un esquema (base de datos). - - - - - &reftitle.parameters; - - - schema_name - - - El nombre del esquema a eliminar. - - - - - - - - &reftitle.returnvalues; - - &true; si el esquema es eliminado, o &false; si no existe - o no puede ser eliminado. - - - Un nivel de error E_WARNING es generado si el - esquema no existe. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Session::dropSchema</function> - -dropSchema("addressbook"); - -$session->close(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/generateuuid.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/generateuuid.xml deleted file mode 100644 index 65798bfba7..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/generateuuid.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - Session::generateUUID - Devuelve un nuevo UUID - - - - &reftitle.description; - - public stringmysql_xdevapi\Session::generateUUID - - - - Genera un identificador único universal (Universal Unique IDentifier - UUID) generado según la - RFC 4122. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El UUID; una cadena de 32 caracteres. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Session::generateUuid</function> - -generateUuid(); - -var_dump($uuid); -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/getdefaultschema.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/getdefaultschema.xml deleted file mode 100644 index dca8c2b34b..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/getdefaultschema.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - Session::getDefaultSchema - Devuelve el nombre del esquema predeterminado - - - - &reftitle.description; - - public mysql_xdevapi\Schemanullmysql_xdevapi\Session::getDefaultSchema - - - - Recupera el esquema por defecto que se suele establecer en el URI de conexión. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El esquema por defecto definido por la conexión, o &null; si no se ha establecido ninguno. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Session::getSchema</function> - -getDefaultSchema(); -echo $schema->getName(); -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/getschema.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/getschema.xml deleted file mode 100644 index 33f8cb8b0f..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/getschema.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Session::getSchema - Devuelve un nuevo objeto esquema - - - - &reftitle.description; - - public mysql_xdevapi\Schemamysql_xdevapi\Session::getSchema - stringschema_name - - - Un nuevo objeto Schema para el nombre de esquema proporcionado. - - - - - &reftitle.parameters; - - - schema_name - - - El nombre del esquema (base de datos) para el cual se obtiene un objeto Schema. - - - - - - - - &reftitle.returnvalues; - - Un objeto Schema. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Session::getSchema</function> - -getSchema("addressbook"); - -print_r($schema); -]]> - - &example.outputs.similar; - - addressbook -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/getschemas.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/getschemas.xml deleted file mode 100644 index ae7f88e0e6..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/getschemas.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Session::getSchemas - Devuelve los esquemas - - - - &reftitle.description; - - public arraymysql_xdevapi\Session::getSchemas - - - - Obtiene los objetos esquema para todos los esquemas disponibles para la sesión. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un array que contiene objetos que representan todos los esquemas - disponibles para la sesión. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Session::getSchemas</function> - -getSchemas(); - -print_r($schemas); -]]> - - &example.outputs.similar; - - mysql_xdevapi\Schema Object - ( - [name] => addressbook - ) - [1] => mysql_xdevapi\Schema Object - ( - [name] => information_schema - ) - ... -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/getserverversion.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/getserverversion.xml deleted file mode 100644 index c052437167..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/getserverversion.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - Session::getServerVersion - Devuelve la versión del servidor - - - - &reftitle.description; - - public intmysql_xdevapi\Session::getServerVersion - - - - Devuelve la versión del servidor MySQL para la sesión. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La versión del servidor MySQL para la sesión, en forma de entero como "80012". - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Session::getServerVersion</function> - -getServerVersion(); - -var_dump($version); -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/listclients.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/listclients.xml deleted file mode 100644 index 35e3052ef1..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/listclients.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - Session::listClients - Devuelve la lista de clientes - - - - &reftitle.description; - - public arraymysql_xdevapi\Session::listClients - - - - Devuelve la lista de conexiones de clientes al servidor MySQL de la sesión. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un array que contiene los clientes actualmente conectados. Los elementos - del array son "client_id", "user", "host" y "sql_session". - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Session::listClients</function> - -listClients(); - -var_dump($ids); -?> -]]> - - &example.outputs.similar; - - - array(4) { - ["client_id"]=> - int(61) - ["user"]=> - string(4) "root" - ["host"]=> - string(9) "localhost" - ["sql_session"]=> - int(72) - } -} -]]> - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/quotename.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/quotename.xml deleted file mode 100644 index 907241e496..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/quotename.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - Session::quoteName - Añade comillas - - - - &reftitle.description; - - public stringmysql_xdevapi\Session::quoteName - stringname - - - Una función que pone entre comillas para escapar los nombres e identificadores SQL. Es capaz de - escapar el identificador dado conforme a los parámetros de la conexión actual. Esta función - de escape no debe ser utilizada para escapar valores. - - - - - &reftitle.parameters; - - - name - - - La cadena a poner entre comillas. - - - - - - - - &reftitle.returnvalues; - - La cadena puesta entre comillas. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Session::quoteName</function> - -quoteName($first)); - -$second = 'Another `test` "like" `this`'; -var_dump($second); -var_dump($session->quoteName($second)); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/releasesavepoint.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/releasesavepoint.xml deleted file mode 100644 index 6aea5da022..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/releasesavepoint.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Session::releaseSavepoint - Libera el punto de salvaguarda - - - - &reftitle.description; - - public voidmysql_xdevapi\Session::releaseSavepoint - stringname - - - Libera un punto de salvaguarda previamente definido. - - - - - &reftitle.parameters; - - - name - - - El nombre del punto de salvaguarda a liberar. - - - - - - - - &reftitle.returnvalues; - - Un objeto SqlStatementResult. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Session::releaseSavepoint</function> - -getSchema("addressbook")->getCollection("friends"); - -$session->startTransaction(); -$collection->add( '{"test1":1, "test2":2}' )->execute(); - -$savepoint = $session->setSavepoint(); - -$collection->add( '{"test3":3, "test4":4}' )->execute(); - -$session->releaseSavepoint($savepoint); -$session->rollback(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/rollback.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/rollback.xml deleted file mode 100644 index ed58cc2c52..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/rollback.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Session::rollback - Revierte la transacción - - - - &reftitle.description; - - public voidmysql_xdevapi\Session::rollback - - - - Revierte la transacción. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objeto SqlStatementResult. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Session::rollback</function> - -getSchema("addressbook")->getCollection("names"); - -$session->startTransaction(); -$collection->add( '{"test1":1, "test2":2}' )->execute(); - -$savepoint = $session->setSavepoint(); - -$collection->add( '{"test3":3, "test4":4}' )->execute(); - -$session->releaseSavepoint($savepoint); -$session->rollback(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/rollbackto.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/rollbackto.xml deleted file mode 100644 index cb33d4d587..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/rollbackto.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Session::rollbackTo - Anula la transacción hasta el punto de salvaguarda - - - - &reftitle.description; - - public voidmysql_xdevapi\Session::rollbackTo - stringname - - - Anula la transacción hasta el punto de salvaguarda. - - - - - &reftitle.parameters; - - - name - - - El nombre del punto de salvaguarda hasta el cual anular; no sensible a mayúsculas y minúsculas. - - - - - - - - &reftitle.returnvalues; - - Un objeto SqlStatementResult. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Session::rollbackTo</function> - -getSchema("addressbook")->getCollection("names"); - -$session->startTransaction(); -$collection->add( '{"test1":1, "test2":2}' )->execute(); - -$savepoint1 = $session->setSavepoint(); - -$collection->add( '{"test3":3, "test4":4}' )->execute(); - -$savepoint2 = $session->setSavepoint(); - -$session->rollbackTo($savepoint1); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/setsavepoint.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/setsavepoint.xml deleted file mode 100644 index 0b7f2f0ff8..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/setsavepoint.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Session::setSavepoint - Crear un punto de salvaguarda - - - - &reftitle.description; - - public stringmysql_xdevapi\Session::setSavepoint - stringname - - - Crear un nuevo punto de salvaguarda para la transacción. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - name - - - El nombre del punto de salvaguarda. El nombre se genera automáticamente si el argumento opcional name - no está definido como 'SAVEPOINT1', 'SAVEPOINT2', etc. - - - - - - - - &reftitle.returnvalues; - - El nombre del punto de salvaguarda. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Session::setSavepoint</function> - -getSchema("addressbook")->getCollection("names"); - -$session->startTransaction(); -$collection->add( '{"test1":1, "test2":2}' )->execute(); - -$savepoint = $session->setSavepoint(); - -$collection->add( '{"test3":3, "test4":4}' )->execute(); - -$session->releaseSavepoint($savepoint); -$session->rollback(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/sql.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/sql.xml deleted file mode 100644 index c6452970d0..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/sql.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - Session::sql - Crear una consulta SQL - - - - &reftitle.description; - - public mysql_xdevapi\SqlStatementmysql_xdevapi\Session::sql - stringquery - - - Crear una declaración SQL nativa. Los espacios reservados son compatibles utilizando la sintaxis nativa "?". - Utilizar el método execute para ejecutar la declaración SQL. - - - - - &reftitle.parameters; - - - query - - - La declaración SQL a ejecutar. - - - - - - - - &reftitle.returnvalues; - - Un objeto SqlStatement. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Session::sql</function> - -sql("CREATE DATABASE addressbook")->execute(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/session/starttransaction.xml b/reference/mysql_xdevapi/mysql_xdevapi/session/starttransaction.xml deleted file mode 100644 index 2c14d34708..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/session/starttransaction.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Session::startTransaction - Inicia una transacción - - - - &reftitle.description; - - public voidmysql_xdevapi\Session::startTransaction - - - - Inicia una nueva transacción. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objeto SqlStatementResult. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Session::startTransaction</function> - -getSchema("addressbook")->getCollection("friends"); - -$session->startTransaction(); -$collection->add( '{"test1":1, "test2":2}' )->execute(); - -$savepoint = $session->setSavepoint(); - -$collection->add( '{"test3":3, "test4":4}' )->execute(); - -$session->releaseSavepoint($savepoint); -$session->rollback(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/bind.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/bind.xml deleted file mode 100644 index 991ce49c3b..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/bind.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - SqlStatement::bind - Liga los argumentos de la instrucción - - - - &reftitle.description; - - public mysql_xdevapi\SqlStatementmysql_xdevapi\SqlStatement::bind - stringparam - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - param - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\SqlStatement::bind</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/construct.xml deleted file mode 100644 index 8f0557e46b..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/construct.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - SqlStatement::__construct - Descripción del constructor - - - - &reftitle.description; - - private mysql_xdevapi\SqlStatement::__construct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\SqlStatement::__construct</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/execute.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/execute.xml deleted file mode 100644 index f0a558db94..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/execute.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - SqlStatement::execute - Ejecuta la operación - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\SqlStatement::execute - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\SqlStatement::execute</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/getnextresult.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/getnextresult.xml deleted file mode 100644 index cb57149efe..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/getnextresult.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - SqlStatement::getNextResult - Devuelve el resultado siguiente - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\SqlStatement::getNextResult - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\SqlStatement::getNextResult</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/getresult.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/getresult.xml deleted file mode 100644 index 1b2fc76022..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/getresult.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - SqlStatement::getResult - Devuelve el resultado - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\SqlStatement::getResult - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\SqlStatement::getResult</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/hasmoreresults.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/hasmoreresults.xml deleted file mode 100644 index 7b56e0245c..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatement/hasmoreresults.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - SqlStatement::hasMoreResults - Verifica si hay más resultados - - - - &reftitle.description; - - public boolmysql_xdevapi\SqlStatement::hasMoreResults - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; si quedan objetos por recuperar en el conjunto de resultados. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\SqlStatement::hasMoreResults</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/construct.xml deleted file mode 100644 index 0a0b3fbca8..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/construct.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - SqlStatementResult::__construct - Descripción del constructor - - - - &reftitle.description; - - private mysql_xdevapi\SqlStatementResult::__construct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\SqlStatementResult::__construct</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/fetchall.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/fetchall.xml deleted file mode 100644 index 336cc60d1b..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/fetchall.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - SqlStatementResult::fetchAll - Devuelve todas las filas del resultado - - - - &reftitle.description; - - public arraymysql_xdevapi\SqlStatementResult::fetchAll - - - - Recupera todas las filas del conjunto de resultados. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un array numérico con todos los resultados de la consulta; cada resultado es - un array asociativo. Se devuelve un array vacío si no hay - filas presentes. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\SqlStatementResult::fetchAll</function> - -sql("DROP DATABASE IF EXISTS dbtest")->execute(); -$session->sql("CREATE DATABASE dbtest")->execute(); -$session->sql("CREATE TABLE dbtest.workers(name text, age int, job text)")->execute(); -$session->sql("INSERT INTO dbtest.workers values ('John', 42, 'bricklayer'), ('Sam', 33, 'carpenter')")->execute(); - -$schema = $session->getSchema("dbtest"); -$table = $schema->getTable("workers"); - -$rows = $session->sql("SELECT * FROM dbtest.workers")->execute()->fetchAll(); - -print_r($rows); -?> -]]> - - - &example.outputs.similar; - - Array - ( - [name] => John - [age] => 42 - ) - [1] => Array - ( - [name] => Sam - [age] => 33 - ) -) -]]> - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/fetchone.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/fetchone.xml deleted file mode 100644 index 99324011b0..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/fetchone.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - SqlStatementResult::fetchOne - Devuelve una sola línea - - - - &reftitle.description; - - public arraymysql_xdevapi\SqlStatementResult::fetchOne - - - - Recupera una sola línea del conjunto de resultados. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El resultado, en forma de array asociativo. En caso de ausencia de - resultado, null será devuelto. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\SqlStatementResult::fetchOne</function> - -sql("DROP DATABASE IF EXISTS dbtest")->execute(); -$session->sql("CREATE DATABASE dbtest")->execute(); -$session->sql("CREATE TABLE dbtest.workers(name text, age int, job text)")->execute(); -$session->sql("INSERT INTO dbtest.workers values ('John', 42, 'bricklayer'), ('Sam', 33, 'carpenter')")->execute(); - -$schema = $session->getSchema("dbtest"); -$table = $schema->getTable("workers"); - -$rows = $session->sql("SELECT * FROM dbtest.workers")->execute()->fetchOne(); - -print_r($rows); -?> -]]> - - &example.outputs.similar; - - John - [age] => 42 - [job] => bricklayer -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getaffecteditemscount.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getaffecteditemscount.xml deleted file mode 100644 index 1fad8e4666..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getaffecteditemscount.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - SqlStatementResult::getAffectedItemsCount - Devuelve el número de filas afectadas - - - - &reftitle.description; - - public intmysql_xdevapi\SqlStatementResult::getAffectedItemsCount - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\SqlStatementResult::getAffectedItemsCount</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumncount.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumncount.xml deleted file mode 100644 index a61fcd3ce9..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumncount.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - SqlStatementResult::getColumnsCount - Devuelve el número de columnas - - - - &reftitle.description; - - public intmysql_xdevapi\SqlStatementResult::getColumnsCount - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El número de columnas; 0 si no hay ninguna. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 8.0.14 - - El método fue renombrado de getColumnCount() a getColumnsCount(). - - - - - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\SqlStatementResult::getColumnsCount</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumnnames.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumnnames.xml deleted file mode 100644 index 105d37b1ef..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumnnames.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - SqlStatementResult::getColumnNames - Devuelve el nombre de las columnas - - - - &reftitle.description; - - public arraymysql_xdevapi\SqlStatementResult::getColumnNames - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\SqlStatementResult::getColumnNames</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumns.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumns.xml deleted file mode 100644 index 9782206733..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getcolumns.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - SqlStatementResult::getColumns - Devuelve las columnas - - - - &reftitle.description; - - public Arraymysql_xdevapi\SqlStatementResult::getColumns - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\SqlStatementResult::getColumns</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getgeneratedids.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getgeneratedids.xml deleted file mode 100644 index 7340461ee1..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getgeneratedids.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - SqlStatementResult::getGeneratedIds - Devuelve los identificadores generados - - - - &reftitle.description; - - public arraymysql_xdevapi\SqlStatementResult::getGeneratedIds - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un array de identificadores generados a partir de la última operación, - o un array vacío si no hay ninguno. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\SqlStatementResult::getGeneratedIds</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getlastinsertid.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getlastinsertid.xml deleted file mode 100644 index 1e658c6bb2..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getlastinsertid.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - SqlStatementResult::getLastInsertId - Devuelve el ID de la última inserción - - - - &reftitle.description; - - public Stringmysql_xdevapi\SqlStatementResult::getLastInsertId - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El ID de la última operación de inserción. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\SqlStatementResult::getLastInsertId</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getwarnings.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getwarnings.xml deleted file mode 100644 index 91a37205d3..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getwarnings.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - SqlStatementResult::getWarnings - Devuelve las advertencias de la última operación - - - - &reftitle.description; - - public arraymysql_xdevapi\SqlStatementResult::getWarnings - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un array de objetos Warning de la última operación. Cada objeto - define un 'message' de error, un 'nivel' de error y un - 'code' de error. Un array vacío es devuelto si no hay errores. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\SqlStatementResult::getWarnings</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getwarningscount.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getwarningscount.xml deleted file mode 100644 index 03b6e5835c..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/getwarningscount.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - SqlStatementResult::getWarningsCount - Devuelve el número de advertencias de la última operación - - - - &reftitle.description; - - public intmysql_xdevapi\SqlStatementResult::getWarningCounts - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El número de advertencias generadas durante la última operación CRUD. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\SqlStatementResult::getWarningsCount</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/hasdata.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/hasdata.xml deleted file mode 100644 index 9f9f29190e..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/hasdata.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - SqlStatementResult::hasData - Verifica si el resultado contiene datos - - - - &reftitle.description; - - public boolmysql_xdevapi\SqlStatementResult::hasData - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; si el resultado contiene datos. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\SqlStatementResult::hasData</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/nextresult.xml b/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/nextresult.xml deleted file mode 100644 index 7b3920a368..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/sqlstatementresult/nextresult.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - SqlStatementResult::nextResult - Devuelve el resultado siguiente - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\SqlStatementResult::nextResult - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El objeto Result siguiente del conjunto de resultados. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\SqlStatementResult::nextResult</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/statement/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/statement/construct.xml deleted file mode 100644 index b5ee539ab2..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/statement/construct.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - Statement::__construct - Descripción del constructor - - - - &reftitle.description; - - private mysql_xdevapi\Statement::__construct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Statement::__construct</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/statement/getnextresult.xml b/reference/mysql_xdevapi/mysql_xdevapi/statement/getnextresult.xml deleted file mode 100644 index e37852b781..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/statement/getnextresult.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Statement::getNextResult - Devuelve el resultado siguiente - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\Statement::getNextResult - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Statement::getNextResult</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/statement/getresult.xml b/reference/mysql_xdevapi/mysql_xdevapi/statement/getresult.xml deleted file mode 100644 index 55008207d0..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/statement/getresult.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Statement::getResult - Devuelve el resultado - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\Statement::getResult - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Statement::getResult</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/statement/hasmoreresults.xml b/reference/mysql_xdevapi/mysql_xdevapi/statement/hasmoreresults.xml deleted file mode 100644 index bb08678eae..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/statement/hasmoreresults.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Statement::hasMoreResults - Verifica si hay más resultados - - - - &reftitle.description; - - public boolmysql_xdevapi\Statement::hasMoreResults - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Statement::hasMoreResults</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/construct.xml deleted file mode 100644 index 853e74fe74..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/construct.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Table::__construct - Constructor de Table - - - - &reftitle.description; - - private mysql_xdevapi\Table::__construct - - - - Construye un objeto table. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Table::__construct</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/count.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/count.xml deleted file mode 100644 index d81d75d8fe..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/count.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Table::count - Devuelve el número de filas - - - - &reftitle.description; - - public intmysql_xdevapi\Table::count - - - - Recupera el número de filas en la tabla. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El número total de filas en la tabla. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Table::count</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -var_dump($table->count()); -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/delete.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/delete.xml deleted file mode 100644 index 7c3a617f3e..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/delete.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - Table::delete - Elimina filas de la tabla - - - - &reftitle.description; - - public mysql_xdevapi\TableDeletemysql_xdevapi\Table::delete - - - - Elimina filas de una tabla. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objeto TableDelete; utilice el método execute() para ejecutar la consulta de eliminación. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Table::delete</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table->delete()->where("name = :name")->orderby("age DESC")->limit(1)->bind(['name' => 'John'])->execute(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/existsindatabase.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/existsindatabase.xml deleted file mode 100644 index 21801b0783..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/existsindatabase.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Table::existsInDatabase - Verifica si la tabla existe en la base de datos - - - - &reftitle.description; - - public boolmysql_xdevapi\Table::existsInDatabase - - - - Verifica si esta tabla existe en la base de datos. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si la tabla existe en la base de datos, de lo contrario &false; si no existe. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Table::existsInDatabase</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -if ($table->existsInDatabase()) { - echo "Yes, this table still exists in the session's schema."; -} -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/getname.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/getname.xml deleted file mode 100644 index ec839b011f..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/getname.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Table::getName - Devuelve el nombre de la tabla - - - - &reftitle.description; - - public stringmysql_xdevapi\Table::getName - - - - Devuelve el nombre de este objeto base de datos. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El nombre de este objeto base de datos. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Table::getName</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -var_dump($table->getName()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/getschema.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/getschema.xml deleted file mode 100644 index a1ee14f559..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/getschema.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Table::getSchema - Devuelve el esquema de la tabla - - - - &reftitle.description; - - public mysql_xdevapi\Schemamysql_xdevapi\Table::getSchema - - - - Recupera el esquema asociado a la tabla. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objeto Schema. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Table::getSchema</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -var_dump($table->getSchema()); -?> -]]> - - &example.outputs.similar; - - - string(11) "addressbook" -} -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/getsession.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/getsession.xml deleted file mode 100644 index da466d35d8..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/getsession.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Table::getSession - Devuelve la sesión de la tabla - - - - &reftitle.description; - - public mysql_xdevapi\Sessionmysql_xdevapi\Table::getSession - - - - Obtiene la sesión asociada a la tabla. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objeto Session. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Table::getSession</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -var_dump($table->getSession()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/insert.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/insert.xml deleted file mode 100644 index a62eb1e8a5..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/insert.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Table::insert - Inserta filas en una tabla - - - - &reftitle.description; - - public mysql_xdevapi\TableInsertmysql_xdevapi\Table::insert - mixedcolumns - mixedmore_columns - - - Inserta filas en una tabla. - - - - - - &reftitle.parameters; - - - columns - - - Las columnas en las que insertar los datos. Puede ser un array - con uno o más valores, o un string. - - - - - more_columns - - - Definiciones de columnas adicionales. - - - - - - - - &reftitle.returnvalues; - - Un objeto TableInsert; utilice el método execute() para ejecutar la instrucción de inserción. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Table::insert</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table ->insert("name", "age") - ->values(["Suzanne", 31],["Julie", 43]) - ->execute(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/isview.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/isview.xml deleted file mode 100644 index 397b99101f..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/isview.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Table::isView - Devuelve si la tabla es una vista - - - - &reftitle.description; - - public boolmysql_xdevapi\Table::isView - - - - Determina si el objeto subyacente es una vista o no. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; si el objeto subyacente es una vista, de lo contrario &false;. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Table::isView</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -if ($table->isView()) { - echo "This is a view."; -} else { - echo "This is not a view."; -} -?> -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/select.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/select.xml deleted file mode 100644 index c3d6ebe1a0..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/select.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - Table::select - Selecciona filas en una tabla - - - - &reftitle.description; - - public mysql_xdevapi\TableSelectmysql_xdevapi\Table::select - mixedcolumns - mixedmore_columns - - - Recupera datos de una tabla. - - - - - - &reftitle.parameters; - - - columns - - - Las columnas desde las cuales recuperar los datos. Puede ser un array - con uno o más valores, o un string. - - - - - more_columns - - - Definiciones de columnas adicionales. - - - - - - - - &reftitle.returnvalues; - - Un objeto TableSelect; utilice el método execute() para ejecutar la - selección y devolver un objeto RowResult. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Table::count</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$row = $table->select('name', 'age')->execute()->fetchAll(); - -print_r($row); -]]> - - &example.outputs.similar; - - Array - ( - [name] => John - [age] => 42 - ) - [1] => Array - ( - [name] => Sam - [age] => 33 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/table/update.xml b/reference/mysql_xdevapi/mysql_xdevapi/table/update.xml deleted file mode 100644 index e5a8823677..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/table/update.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Table::update - Actualiza las filas de la tabla - - - - &reftitle.description; - - public mysql_xdevapi\TableUpdatemysql_xdevapi\Table::update - - - - Actualiza las columnas de una tabla. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objeto TableUpdate; utilice el método execute() para ejecutar la instrucción de actualización. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Table::update</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table->update()->set('age',34)->where('name = "Sam"')->limit(1)->execute(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/bind.xml b/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/bind.xml deleted file mode 100644 index 1825b2f079..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/bind.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - TableDelete::bind - Liga los argumentos de la petición de eliminación - - - - &reftitle.description; - - public mysql_xdevapi\TableDeletemysql_xdevapi\TableDelete::bind - arrayplaceholder_values - - - Liga un valor a un espacio reservado. - - - - - - &reftitle.parameters; - - - placeholder_values - - - El nombre del espacio reservado y el valor a ligar. - - - - - - - - &reftitle.returnvalues; - - Un objeto TableDelete - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\TableDelete::bind</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table->delete() - ->where("name = :name") - ->bind(['name' => 'John']) - ->orderby("age DESC") - ->limit(1) - ->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/construct.xml deleted file mode 100644 index e49334cda2..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/construct.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - TableDelete::__construct - Constructor de TableDelete - - - - &reftitle.description; - - private mysql_xdevapi\TableDelete::__construct - - - - Inicializado utilizando el método delete(). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\TableDelete::__construct</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table->delete() - ->where("name = :name") - ->bind(['name' => 'John']) - ->orderby("age DESC") - ->limit(1) - ->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/execute.xml b/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/execute.xml deleted file mode 100644 index 7544627072..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/execute.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - TableDelete::execute - Ejecuta la consulta de eliminación - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\TableDelete::execute - - - - Ejecuta la consulta de eliminación. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objeto Result. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\TableDelete::execute</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table->delete() - ->where("name = :name") - ->bind(['name' => 'John']) - ->orderby("age DESC") - ->limit(1) - ->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/limit.xml b/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/limit.xml deleted file mode 100644 index 8872169e7e..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/limit.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - TableDelete::limit - Limita las filas eliminadas - - - - &reftitle.description; - - public mysql_xdevapi\TableDeletemysql_xdevapi\TableDelete::limit - introws - - - Define el número máximo de registros o documentos a eliminar. - - - - - - &reftitle.parameters; - - - rows - - - El máximo de registros o documentos a eliminar. - - - - - - - - &reftitle.returnvalues; - - Un objeto TableDelete. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\TableDelete::limit</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table->delete() - ->where("name = :name") - ->bind(['name' => 'John']) - ->orderby("age DESC") - ->limit(1) - ->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/orderby.xml b/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/orderby.xml deleted file mode 100644 index 113df8f136..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/orderby.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - TableDelete::orderby - Define los criterios de ordenación de la eliminación - - - - &reftitle.description; - - public mysql_xdevapi\TableDeletemysql_xdevapi\TableDelete::orderby - stringorderby_expr - - - Define las opciones de ordenación para un conjunto de resultados. - - - - - - &reftitle.parameters; - - - orderby_expr - - - La definición de la ordenación. - - - - - - - - &reftitle.returnvalues; - - Un objeto TableDelete. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\TableDelete::orderBy</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table->delete() - ->where("age = :age") - ->bind(['age' => 42]) - ->orderby("name DESC") - ->limit(1) - ->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/where.xml b/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/where.xml deleted file mode 100644 index 5aabd74e9f..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tabledelete/where.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - TableDelete::where - Define la condición de búsqueda para la eliminación - - - - &reftitle.description; - - public mysql_xdevapi\TableDeletemysql_xdevapi\TableDelete::where - stringwhere_expr - - - Define la condición de búsqueda para filtrar. - - - - - - &reftitle.parameters; - - - where_expr - - - Define la condición de búsqueda para filtrar los documentos o los registros. - - - - - - - - &reftitle.returnvalues; - - Un objeto TableDelete. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\TableDelete::where</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table->delete() - ->where("id = :id") - ->bind(['id' => 42]) - ->limit(1) - ->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/construct.xml deleted file mode 100644 index 6b1054039b..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/construct.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - TableInsert::__construct - Constructor de TableInsert - - - - &reftitle.description; - - private mysql_xdevapi\TableInsert::__construct - - - - Inicializado por el método insert(). - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\TableInsert::__construct</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table - ->insert("name", "age") - ->values(["Suzanne", 31],["Julie", 43]) - ->execute(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/execute.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/execute.xml deleted file mode 100644 index 6eeb86362c..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/execute.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - TableInsert::execute - Ejecuta una consulta de inserción - - - - &reftitle.description; - - public mysql_xdevapi\Resultmysql_xdevapi\TableInsert::execute - - - - Ejecuta la declaración. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objeto Result. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\TableInsert::execute</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table - ->insert("name", "age") - ->values(["Suzanne", 31],["Julie", 43]) - ->execute(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/values.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/values.xml deleted file mode 100644 index 7360d1531f..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableinsert/values.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - TableInsert::values - Añade valores de fila - - - - &reftitle.description; - - public mysql_xdevapi\TableInsertmysql_xdevapi\TableInsert::values - arrayrow_values - - - Define los valores a insertar. - - - - - - &reftitle.parameters; - - - row_values - - - Los valores (un array) de las columnas a insertar. - - - - - - - - &reftitle.returnvalues; - - Un objeto TableInsert. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\TableInsert::values</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table - ->insert("name", "age") - ->values(["Suzanne", 31],["Julie", 43]) - ->execute(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/bind.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/bind.xml deleted file mode 100644 index 7a3c59864c..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/bind.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - TableSelect::bind - Liga los argumentos de la petición select - - - - &reftitle.description; - - public mysql_xdevapi\TableSelectmysql_xdevapi\TableSelect::bind - arrayplaceholder_values - - - Liga un valor a un espacio reservado específico. - - - - - - &reftitle.parameters; - - - placeholder_values - - - El nombre del espacio reservado y el valor a ligar. - - - - - - - - &reftitle.returnvalues; - - Un objeto TableSelect. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\TableSelect::bind</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$result = $table->select('name','age') - ->where('name like :name and age > :age') - ->bind(['name' => 'John', 'age' => 42]) - ->execute(); - -$row = $result->fetchAll(); -print_r($row); -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => John - [age] => 42 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/construct.xml deleted file mode 100644 index 3a26b67e5d..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/construct.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - TableSelect::__construct - Constructor de TableSelect - - - - &reftitle.description; - - private mysql_xdevapi\TableSelect::__construct - - - - Un objeto devuelto por el método select(); utilice execute() para - ejecutar la consulta. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\TableSelect::__construct</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$result = $table->select('name','age') - ->where('name like :name and age > :age') - ->bind(['name' => 'John', 'age' => 42]) - ->orderBy('age desc') - ->execute(); - -$row = $result->fetchAll(); -print_r($row); - -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => John - [age] => 42 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/execute.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/execute.xml deleted file mode 100644 index 1c4b250059..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/execute.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - TableSelect::execute - Ejecuta una declaración select - - - - &reftitle.description; - - public mysql_xdevapi\RowResultmysql_xdevapi\TableSelect::execute - - - - Ejecuta la declaración select encadenándola con el método execute(). - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objeto RowResult. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\TableSelect::execute</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$result = $table->select('name','age') - ->where('name like :name and age > :age') - ->bind(['name' => 'John', 'age' => 42]) - ->orderBy('age desc') - ->execute(); - -$row = $result->fetchAll(); -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => John - [age] => 42 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/groupby.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/groupby.xml deleted file mode 100644 index ed209769ff..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/groupby.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - TableSelect::groupBy - Define los criterios de agrupación de la selección - - - - &reftitle.description; - - public mysql_xdevapi\TableSelectmysql_xdevapi\TableSelect::groupBy - mixedsort_expr - - - Define un criterio de agrupación para el conjunto de resultados. - - - - - - &reftitle.parameters; - - - sort_expr - - - El criterio de agrupación. - - - - - - - - &reftitle.returnvalues; - - Un objeto TableSelect. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\TableSelect::groupBy</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 42)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('Suki', 31)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$result = $table->select('count(*) as count', 'age') - ->groupBy('age')->orderBy('age asc') - ->execute(); - -$row = $result->fetchAll(); -print_r($row); -?> -]]> - - &example.outputs.similar; - - Array - ( - [count] => 1 - [age] => 31 - ) - [1] => Array - ( - [count] => 2 - [age] => 42 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/having.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/having.xml deleted file mode 100644 index 838bedc83c..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/having.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - TableSelect::having - Define la condición de agrupamiento - - - - &reftitle.description; - - public mysql_xdevapi\TableSelectmysql_xdevapi\TableSelect::having - stringsort_expr - - - Define una condición para los registros a considerar en las operaciones de función de agregación. - - - - - &reftitle.parameters; - - - sort_expr - - - Una condición sobre las funciones de agregación utilizadas en los criterios de agrupamiento. - - - - - - - - &reftitle.returnvalues; - - Un objeto TableSelect. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\TableSelect::having</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 42)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('Suki', 31)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$result = $table->select('count(*) as count', 'age') - ->groupBy('age')->orderBy('age asc') - ->having('count > 1') - ->execute(); - -$row = $result->fetchAll(); -print_r($row); -?> -]]> - - &example.outputs.similar; - - Array - ( - [count] => 2 - [age] => 42 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/limit.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/limit.xml deleted file mode 100644 index 7e7fd5161a..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/limit.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - TableSelect::limit - Limita las filas seleccionadas - - - - &reftitle.description; - - public mysql_xdevapi\TableSelectmysql_xdevapi\TableSelect::limit - introws - - - Define el número máximo de registros o documentos a devolver. - - - - - - &reftitle.parameters; - - - rows - - - El número máximo de registros o documentos. - - - - - - - - &reftitle.returnvalues; - - Un objeto TableSelect. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\TableSelect::limit</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$result = $table->select('name', 'age') - ->limit(1) - ->execute(); - -$row = $result->fetchAll(); -print_r($row); -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => John - [age] => 42 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/lockexclusive.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/lockexclusive.xml deleted file mode 100644 index 22c5820cd5..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/lockexclusive.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - TableSelect::lockExclusive - Ejecuta EXCLUSIVE LOCK - - - - &reftitle.description; - - public mysql_xdevapi\TableSelectmysql_xdevapi\TableSelect::lockExclusive - intlock_waiting_option - - - Ejecuta una operación de lectura con EXCLUSIVE LOCK. Solo un bloqueo puede estar activo a la vez. - - - - - - &reftitle.parameters; - - - lock_waiting_option - - - Una opción de espera opcional que está definida por omisión en MYSQLX_LOCK_DEFAULT. - Los valores válidos son: - - - MYSQLX_LOCK_DEFAULT - MYSQLX_LOCK_NOWAIT - MYSQLX_LOCK_SKIP_LOCKED - - - - - - - - &reftitle.returnvalues; - - Un objeto TableSelect. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\TableSelect::lockExclusive</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$session->startTransaction(); - -$result = $table->select('name', 'age') - ->lockExclusive(MYSQLX_LOCK_NOWAIT) - ->execute(); - -$session->commit(); - -$row = $result->fetchAll(); -print_r($row); -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => John - [age] => 42 - ) - [1] => Array - ( - [name] => Sam - [age] => 42 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/lockshared.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/lockshared.xml deleted file mode 100644 index 665379140e..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/lockshared.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - TableSelect::lockShared - Ejecuta SHARED LOCK - - - - &reftitle.description; - - public mysql_xdevapi\TableSelectmysql_xdevapi\TableSelect::lockShared - intlock_waiting_option - - - Ejecuta una operación de lectura con SHARED LOCK. Solo un bloqueo puede estar activo a la vez. - - - - - - &reftitle.parameters; - - - lock_waiting_option - - - Una opción de espera opcional que se establece por omisión en MYSQLX_LOCK_DEFAULT. - Los valores válidos son: - - - MYSQLX_LOCK_DEFAULT - MYSQLX_LOCK_NOWAIT - MYSQLX_LOCK_SKIP_LOCKED - - - - - - - - &reftitle.returnvalues; - - Un objeto TableSelect. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\TableSelect::lockShared</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$session->startTransaction(); - -$result = $table->select('name', 'age') - ->lockShared(MYSQLX_LOCK_NOWAIT) - ->execute(); - -$session->commit(); - -$row = $result->fetchAll(); -print_r($row); -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => John - [age] => 42 - ) - [1] => Array - ( - [name] => Sam - [age] => 42 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/offset.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/offset.xml deleted file mode 100644 index 5377be06f2..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/offset.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - TableSelect::offset - Define el desplazamiento del límite - - - - &reftitle.description; - - public mysql_xdevapi\TableSelectmysql_xdevapi\TableSelect::offset - intposition - - - Ignora un número dado de filas en el resultado. - - - - - - &reftitle.parameters; - - - position - - - El desplazamiento del límite. - - - - - - - - &reftitle.returnvalues; - - Un objeto TableSelect. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\TableSelect::offset</function> - -sql("DROP DATABASE IF EXISTS addressbook")->execute(); -$session->sql("CREATE DATABASE addressbook")->execute(); -$session->sql("CREATE TABLE addressbook.names(name text, age int)")->execute(); -$session->sql("INSERT INTO addressbook.names values ('John', 42), ('Sam', 42)")->execute(); - -$schema = $session->getSchema("addressbook"); -$table = $schema->getTable("names"); - -$result = $table->select('name', 'age') - ->limit(1) - ->offset(1) - ->execute(); - -$row = $result->fetchAll(); -print_r($row); -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => Sam - [age] => 42 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/orderby.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/orderby.xml deleted file mode 100644 index 89e321b5c5..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/orderby.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - TableSelect::orderby - Define los criterios de ordenación de la selección - - - - &reftitle.description; - - public mysql_xdevapi\TableSelectmysql_xdevapi\TableSelect::orderby - mixedsort_expr - mixedsort_exprs - - - Define los criterios de ordenación. - - - - - - &reftitle.parameters; - - - sort_expr - - - La expresión que define los criterios de ordenación. Puede ser un array - con una o más expresiones, o un string. - - - - - sort_exprs - - - Parámetros adicionales para sort_expr. - - - - - - - - &reftitle.returnvalues; - - Un objeto TableSelect. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\TableSelect::orderBy</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$result = $table->select('name', 'age') - ->orderBy('name desc') - ->execute(); - -$row = $result->fetchAll(); -print_r($row); -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => Sam - [age] => 42 - ) - [1] => Array - ( - [name] => John - [age] => 42 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/where.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableselect/where.xml deleted file mode 100644 index 1cbdb40604..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableselect/where.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - TableSelect::where - Define los criterios de búsqueda de la selección - - - - &reftitle.description; - - public mysql_xdevapi\TableSelectmysql_xdevapi\TableSelect::where - stringwhere_expr - - - Define las condiciones de búsqueda para filtrar. - - - - - - &reftitle.parameters; - - - where_expr - - - Define la condición de búsqueda para filtrar los documentos o los registros. - - - - - - - - &reftitle.returnvalues; - - Un objeto TableSelect. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\TableSelect::where</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$result = $table->select('name','age') - ->where('name like :name and age > :age') - ->bind(['name' => 'John', 'age' => 42]) - ->execute(); - -$row = $result->fetchAll(); -print_r($row); -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => John - [age] => 42 - ) -) -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/bind.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/bind.xml deleted file mode 100644 index 005f8fa4a8..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/bind.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - TableUpdate::bind - Liga los argumentos de la solicitud de actualización - - - - &reftitle.description; - - public mysql_xdevapi\TableUpdatemysql_xdevapi\TableUpdate::bind - arrayplaceholder_values - - - Liga un valor a un emplazamiento específico. - - - - - - &reftitle.parameters; - - - placeholder_values - - - El nombre del emplazamiento reservado y el valor a ligar, definidos - como un array JSON. - - - - - - - - &reftitle.returnvalues; - - Un objeto TableUpdate. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\TableUpdate::bind</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$table->update() - ->set('status', 'admin') - ->where('name = :name and age > :age') - ->bind(['name' => 'Bernie', 'age' => 2000]) - ->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/construct.xml deleted file mode 100644 index b399aab8ad..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/construct.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - TableUpdate::__construct - Constructor de TableUpdate - - - - &reftitle.description; - - private mysql_xdevapi\TableUpdate::__construct - - - - Inicializado por el método update(). - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\TableUpdate::__construct</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$res = $table->update() - ->set('level', 3) - ->where('age > 15 and age < 22') - ->limit(4) - ->orderby(['age asc','name desc']) - ->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/execute.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/execute.xml deleted file mode 100644 index 2c1844a49e..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/execute.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - TableUpdate::execute - Ejecuta la consulta de actualización - - - - &reftitle.description; - - public mysql_xdevapi\TableUpdatemysql_xdevapi\TableUpdate::execute - - - - Ejecuta la declaración de actualización. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objeto TableUpdate. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\TableUpdate::execute</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$res = $table->update() - ->set('level', 3) - ->where('age > 15 and age < 22') - ->limit(4) - ->orderby(['age asc','name desc']) - ->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/limit.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/limit.xml deleted file mode 100644 index b76c0a2b55..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/limit.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - TableUpdate::limit - Limita el número de filas actualizadas - - - - &reftitle.description; - - public mysql_xdevapi\TableUpdatemysql_xdevapi\TableUpdate::limit - introws - - - Define el número máximo de filas o documentos a actualizar. - - - - - - &reftitle.parameters; - - - rows - - - El número máximo de filas o documentos a actualizar. - - - - - - - - &reftitle.returnvalues; - - Un objeto TableUpdate. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\TableUpdate::limit</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$res = $table->update() - ->set('level', 3) - ->where('age > 15 and age < 22') - ->limit(4) - ->orderby(['age asc','name desc']) - ->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/orderby.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/orderby.xml deleted file mode 100644 index d4f1ee5606..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/orderby.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - TableUpdate::orderby - Define los criterios de ordenación - - - - &reftitle.description; - - public mysql_xdevapi\TableUpdatemysql_xdevapi\TableUpdate::orderby - mixedorderby_expr - mixedorderby_exprs - - - Define los criterios de ordenación. - - - - - - &reftitle.parameters; - - - orderby_expr - - - La expresión que define los criterios de ordenación. Puede ser un array - con una o más expresiones, o un string. - - - - - orderby_exprs - - - Parámetros adicionales para las expresiones de ordenación. - - - - - - - - &reftitle.returnvalues; - - Un objeto TableUpdate. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\TableUpdate::orderby</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$res = $table->update() - ->set('level', 3) - ->where('age > 15 and age < 22') - ->limit(4) - ->orderby(['age asc','name desc']) - ->execute(); -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/set.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/set.xml deleted file mode 100644 index d34ff39c84..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/set.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - TableUpdate::set - Añade un campo a actualizar - - - - &reftitle.description; - - public mysql_xdevapi\TableUpdatemysql_xdevapi\TableUpdate::set - stringtable_field - stringexpression_or_literal - - - Actualiza el valor de la columna en los registros de una tabla. - - - - - - &reftitle.parameters; - - - table_field - - - El nombre de la columna a actualizar. - - - - - expression_or_literal - - - El valor a definir en la columna especificada. - - - - - - - - &reftitle.returnvalues; - - Un objeto TableUpdate. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\TableUpdate::set</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$res = $table->update() - ->set('level', 3) - ->where('age > 15 and age < 22') - ->limit(4) - ->orderby(['age asc','name desc']) - ->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/where.xml b/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/where.xml deleted file mode 100644 index 15468d1622..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/tableupdate/where.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - TableUpdate::where - Define el filtro de búsqueda - - - - &reftitle.description; - - public mysql_xdevapi\TableUpdatemysql_xdevapi\TableUpdate::where - stringwhere_expr - - - Define la condición de búsqueda para el filtro. - - - - - - &reftitle.parameters; - - - where_expr - - - La condición de búsqueda para filtrar los documentos o los registros. - - - - - - - - &reftitle.returnvalues; - - Un objeto TableUpdate. - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\TableUpdate::where</function> - -getSchema("addressbook"); -$table = $schema->getTable("names"); - -$res = $table->update() - ->set('level', 3) - ->where('age > 15 and age < 22') - ->limit(4) - ->orderby(['age asc','name desc']) - ->execute(); - -?> -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/mysql_xdevapi/warning/construct.xml b/reference/mysql_xdevapi/mysql_xdevapi/warning/construct.xml deleted file mode 100644 index dbc0f170d4..0000000000 --- a/reference/mysql_xdevapi/mysql_xdevapi/warning/construct.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - Warning::__construct - Constructor de Warning - - - - &reftitle.description; - - private mysql_xdevapi\Warning::__construct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - &reftitle.examples; - - Ejemplo de <function>mysql_xdevapi\Warning::__construct</function> - - -]]> - - - - - - - diff --git a/reference/mysql_xdevapi/reference.xml b/reference/mysql_xdevapi/reference.xml deleted file mode 100644 index 4657576e26..0000000000 --- a/reference/mysql_xdevapi/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - &Functions; Mysql_xdevapi - - &reference.mysql-xdevapi.entities.functions; - - - - diff --git a/reference/mysql_xdevapi/setup.xml b/reference/mysql_xdevapi/setup.xml deleted file mode 100644 index cdec6fb5ad..0000000000 --- a/reference/mysql_xdevapi/setup.xml +++ /dev/null @@ -1,167 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Esta extensión requiere un servidor MySQL 8+ con el complemento X - activado (por omisión). - - - Las bibliotecas prerrequisitos para compilar esta extensión son: - Boost (1.53.0 o superior), OpenSSL y Protobuf. - - -
    - -
    - &reftitle.install; - - - &pecl.moved; - - - - Un ejemplo de procedimiento de instalación en Ubuntu 18.04 con PHP 7.2: - - - - - - - El comando pecl install no activa las extensiones PHP (por omisión) - y activar las extensiones PHP puede hacerse de varias maneras. - Otro ejemplo con PHP 7.2 en Ubuntu 18.04: - - - - /etc/php/7.2/mods-available/mysql_xdevapi.ini - -// Utilizar el comando 'phpenmod' (nota: específico de Debian/Ubuntu) -$ phpenmod -v 7.2 -s ALL mysql_xdevapi - -// Una alternativa a 'phpenmod' es crear un enlace simbólico manualmente -// $ ln -s /etc/php/7.2/mods-available/mysql_xdevapi.ini /etc/php/7.2/cli/conf.d/20-mysql_xdevapi.ini - -// Veamos qué extensiones MySQL están activadas ahora -$ php -m |grep mysql - -mysql_xdevapi -mysqli -mysqlnd -pdo_mysql -]]> - - - - &pecl.info; - &url.pecl.package;mysql_xdevapi. - -
    - - - &reference.mysql-xdevapi.ini; - - -
    - Compilar a partir de las fuentes - - Consideraciones para compilar esta extensión a partir de las fuentes. - - - - - - El nombre de la extensión es 'mysql_xdevapi', por lo tanto, utilice --enable-mysql-xdevapi. - - - - - Boost; requerido, utilice opcionalmente la opción de configuración --with-boost=DIR - o defina la variable de entorno MYSQL_XDEVAPI_BOOST_ROOT. Solo se requieren - los ficheros de encabezado boost; no los binarios. - - - - - Google Protocol Buffers (protobuf): requerido, utilice opcionalmente la opción de configuración - --with-protobuf=DIR o defina la variable de entorno MYSQL_XDEVAPI_PROTOBUF_ROOT. - - - Opcionalmente utilice make protobufs para generar los ficheros protobuf (*.pb.cc/.h), - y make clean-protobufs para eliminar los ficheros protobuf generados. - - - Nota específica para Windows: según su entorno, la biblioteca estática con - un runtime DLL multi-thread puede ser necesaria. - Para preparar, utilice las siguientes opciones: - -Dprotobuf_MSVC_STATIC_RUNTIME=OFF -Dprotobuf_BUILD_SHARED_LIBS=OFF - - - - - Google Protocol Buffers / protoc: requerido, asegúrese de que el correcto - 'protoc' esté disponible en el PATH durante la compilación. Esto es particularmente - importante ya que los scripts batch del SDK PHP Windows pueden sobrescribir el entorno. - - - - - Bison: requerido, y disponible en el PATH. - - - Nota específica para bison Windows: se recomienda encarecidamente utilizar bison - proporcionado con el SDK PHP elegido, de lo contrario, un error similar a "zend_globals_macros.h(39): - error C2375: 'zendparse': redefinition; different linkage - Zend/zend_language_parser.h(214): note: see declaration of 'zendparse'" puede - ser el resultado. Además, los scripts batch del SDK PHP Windows pueden sobrescribir el entorno. - - - - - Nota específica para Windows: para preparar el entorno, consulte la documentación oficial - de construcción de Windows para - el SDK actual. - - - Se recomienda utilizar las barras invertidas '\\' en lugar de una barra '/' para todos los caminos. - - - -
    -
    - - diff --git a/reference/mysqli/setup.xml b/reference/mysqli/setup.xml index c90109de90..22e9e452e2 100644 --- a/reference/mysqli/setup.xml +++ b/reference/mysqli/setup.xml @@ -33,7 +33,7 @@ default_authentication_plugin=mysql_native_password en my.cnf. El plugin caching_sha2_password es completamente soportado a partir de PHP 7.4.4. Para versiones anteriores, - la extensión mysql_xdevapi lo soporta. + la extensión mysql_xdevapi lo soporta. diff --git a/reference/mysqlinfo/set.xml b/reference/mysqlinfo/set.xml index 450f5f819c..0a09d2e13d 100644 --- a/reference/mysqlinfo/set.xml +++ b/reference/mysqlinfo/set.xml @@ -1,6 +1,6 @@ - + Plugins y drivers MySQL MySQL @@ -191,6 +191,28 @@ $pdo = new PDO('mysql:host=example.com;dbname=database', 'user', 'password'); $statement = $pdo->query("SELECT '¡Hola, querido usuario de MySQL!' AS _message FROM DUAL"); $row = $statement->fetch(PDO::FETCH_ASSOC); echo htmlentities($row['_message']); +]]> + + + + Comparación de las instrucciones preparadas + +prepare("SELECT District FROM City WHERE Name=?"); +$statement->execute(["Amersfoort"]); +$result = $statement->get_result(); +$row = $result->fetch_assoc(); +echo htmlentities($row['District']); + +// PDO +$pdo = new PDO('mysql:host=example.com;dbname=base de datos', 'usuario', 'contraseña'); +$statement = $pdo->prepare("SELECT District FROM City WHERE Name=?"); +$statement->execute(["Amersfoort"]); +$row = $statement->fetch(PDO::FETCH_ASSOC); +echo htmlentities($row['District']); ]]> @@ -331,28 +353,6 @@ $ ./configure --with-mysqli --with-pdo-mysql // No recomendado, compilación con libmysqlclient $ ./configure --with-mysqli=/path/to/mysql_config --with-pdo-mysql=/path/to/mysql_config -]]> - - - - Comparación de las instrucciones preparadas - -prepare("SELECT District FROM City WHERE Name=?"); -$statement->execute(["Amersfoort"]); -$result = $statement->get_result(); -$row = $result->fetch_assoc(); -echo htmlentities($row['District']); - -// PDO -$pdo = new PDO('mysql:host=example.com;dbname=base de datos', 'usuario', 'contraseña'); -$statement = $pdo->prepare("SELECT District FROM City WHERE Name=?"); -$statement->execute(["Amersfoort"]); -$row = $statement->fetch(PDO::FETCH_ASSOC); -echo htmlentities($row['District']); ]]> @@ -470,8 +470,6 @@ echo htmlentities($row['District']); &reference.mysqli.book; - &reference.mysql-xdevapi.book; - &reference.mysql.book; &reference.mysqlnd.book; diff --git a/reference/oauth/book.xml b/reference/oauth/book.xml deleted file mode 100644 index 415e12a6d2..0000000000 --- a/reference/oauth/book.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - - OAuth - - - &reftitle.intro; - - Esta extensión proporciona un cliente y un proveedor de servicio OAuth 1.0a. OAuth es un protocolo de autorización - que se construye sobre HTTP, y que permite a las aplicaciones asegurar - el acceso a los datos sin tener que almacenar nombres de usuario y contraseñas. - - - - &reference.oauth.setup; - &reference.oauth.constants; - &reference.oauth.examples; - &reference.oauth.reference; - &reference.oauth.oauth; - &reference.oauth.oauthprovider; - &reference.oauth.oauthexception; - - - diff --git a/reference/oauth/configure.xml b/reference/oauth/configure.xml deleted file mode 100644 index 8eb7a4ae53..0000000000 --- a/reference/oauth/configure.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - -
    - &reftitle.install; - - &pecl.info; - &url.pear.package;oauth - -
    - diff --git a/reference/oauth/constants.xml b/reference/oauth/constants.xml deleted file mode 100644 index 7f620beaf0..0000000000 --- a/reference/oauth/constants.xml +++ /dev/null @@ -1,352 +0,0 @@ - - - - - - &reftitle.constants; - &extension.constants; - - La mayoría de estas constantes implican problemas descritos en la documentación - oficial de informe de problemas - de OAuth. Tenga en cuenta, sin embargo, que los nombres de las constantes son específicos de PHP, a pesar - del hecho de que el esquema de nomenclatura es similar. - - - - - OAUTH_SIG_METHOD_RSASHA1 - (string) - - - - Método de firma OAuth RSA-SHA1. - - - - - - OAUTH_SIG_METHOD_HMACSHA1 - (string) - - - - Método de firma OAuth HMAC-SHA1. - - - - - - OAUTH_SIG_METHOD_HMACSHA256 - (string) - - - - Método de firma OAuth HMAC-SHA256. - - - - - - OAUTH_AUTH_TYPE_AUTHORIZATION - (string) - - - - Esta constante representa el encabezado Authorization. - - - - - - OAUTH_AUTH_TYPE_NONE - (string) - - - - Esta constante indica una petición NoAuth OAuth. - - - - - - OAUTH_AUTH_TYPE_URI - (string) - - - - Esta constante representa los parámetros OAuth en el URI de la petición. - - - - - - OAUTH_AUTH_TYPE_FORM - (string) - - - - Esta constante representa los parámetros OAuth como parte - del cuerpo HTTP POST. - - - - - - OAUTH_HTTP_METHOD_GET - (string) - - - - Utiliza el método GET para la petición OAuth. - - - - - - OAUTH_HTTP_METHOD_POST - (string) - - - - Utiliza el método POST para la petición OAuth. - - - - - - OAUTH_HTTP_METHOD_PUT - (string) - - - - Utiliza el método PUT para la petición OAuth. - - - - - - OAUTH_HTTP_METHOD_HEAD - (string) - - - - Utiliza el método HEAD para la petición OAuth. - - - - - - OAUTH_HTTP_METHOD_DELETE - (string) - - - - Utiliza el método DELETE para la petición OAuth. - - - - - - OAUTH_REQENGINE_STREAMS - (int) - - - - Utilizado por el método Oauth::setRequestEngine - para definir el motor de flujos PHP, - en oposición a OAUTH_REQENGINE_CURL para - Curl. - - - - - - OAUTH_REQENGINE_CURL - (int) - - - - Utilizado por el método Oauth::setReqeustEngine - para definir el motor de Curl, - en oposición a OAUTH_REQENGINE_STREAMS para - los flujos PHP. - - - - - - OAUTH_OK - (int) - - - - La vida es bella. - - - - - - OAUTH_BAD_NONCE - (int) - - - - El valor oauth_nonce ha sido utilizado para una - petición previa, y no puede ser utilizado ahora. - - - - - - OAUTH_BAD_TIMESTAMP - (int) - - - - El valor oauth_timestamp no es aceptado - por el proveedor de servicio. En este caso, la respuesta deberá también contener - el parámetro oauth_acceptable_timestamps. - - - - - - OAUTH_CONSUMER_KEY_UNKNOWN - (int) - - - - oauth_consumer_key es temporalmente inaceptable - por el proveedor de servicio. Por ejemplo, el proveedor de servicio - sobrecarga al consumidor. - - - - - - OAUTH_CONSUMER_KEY_REFUSED - (int) - - - - La clave del consumidor ha sido rechazada. - - - - - - OAUTH_INVALID_SIGNATURE - (int) - - - - oauth_signature es inválida porque no coincide - con la firma calculada por el proveedor de servicio. - - - - - - OAUTH_TOKEN_USED - (int) - - - - oauth_token ha sido consumido. Ya no puede ser utilizado - porque ha sido utilizado en una o más peticiones previas. - - - - - - OAUTH_TOKEN_EXPIRED - (int) - - - - oauth_token ha expirado. - - - - - - OAUTH_TOKEN_REVOKED - (int) - - - - oauth_token ha sido revocado y no será aceptado. - - - - - - OAUTH_TOKEN_REJECTED - (int) - - - - oauth_token no ha sido aceptado por el proveedor de - servicio. La razón es desconocida, pero podría ser que el token nunca - haya sido utilizado, ya haya sido consumido, haya expirado y/o haya sido olvidado por el - proveedor de servicio. - - - - - - OAUTH_VERIFIER_INVALID - (int) - - - - oauth_verifier es incorrecto. - - - - - - OAUTH_PARAMETER_ABSENT - (int) - - - - Un parámetro requerido no ha sido recibido. En este caso, la respuesta deberá también - contener el parámetro oauth_parameters_absent. - - - - - - OAUTH_SIGNATURE_METHOD_REJECTED - (int) - - - - oauth_signature_method no ha sido aceptado por el proveedor - de servicio. - - - - - - diff --git a/reference/oauth/examples.xml b/reference/oauth/examples.xml deleted file mode 100644 index 39425610ea..0000000000 --- a/reference/oauth/examples.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - &reftitle.examples; - -
    - FireEagle - - - <programlisting role="php" xml:id="oauth.examples.fireeagle.location"> -<![CDATA[ -<?php -$req_url = 'https://fireeagle.yahooapis.com/oauth/request_token'; -$authurl = 'https://fireeagle.yahoo.net/oauth/authorize'; -$acc_url = 'https://fireeagle.yahooapis.com/oauth/access_token'; -$api_url = 'https://fireeagle.yahooapis.com/api/0.1'; -$conskey = 'your_consumer_key'; -$conssec = 'your_consumer_secret'; - -session_start(); - -// En state=1 la siguiente solicitud debe incluir un oauth_token. -// Si no vuelve a 0 (cero) -if(!isset($_GET['oauth_token']) && $_SESSION['state']==1) $_SESSION['state'] = 0; -try { - $oauth = new OAuth($conskey,$conssec,OAUTH_SIG_METHOD_HMACSHA1,OAUTH_AUTH_TYPE_URI); - $oauth->enableDebug(); - if(!isset($_GET['oauth_token']) && !$_SESSION['state']) { - $request_token_info = $oauth->getRequestToken($req_url); - $_SESSION['secret'] = $request_token_info['oauth_token_secret']; - $_SESSION['state'] = 1; - header('Location: '.$authurl.'?oauth_token='.$request_token_info['oauth_token']); - exit; - } else if($_SESSION['state']==1) { - $oauth->setToken($_GET['oauth_token'],$_SESSION['secret']); - $access_token_info = $oauth->getAccessToken($acc_url); - $_SESSION['state'] = 2; - $_SESSION['token'] = $access_token_info['oauth_token']; - $_SESSION['secret'] = $access_token_info['oauth_token_secret']; - } - $oauth->setToken($_SESSION['token'],$_SESSION['secret']); - $oauth->fetch("$api_url/user.json"); - $json = json_decode($oauth->getLastResponse()); - print_r($json); -} catch(OAuthException $E) { - print_r($E); -} -?> -]]> - </programlisting> - </example> - </section> - -</chapter> -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/oauth/functions/oauth-get-sbs.xml b/reference/oauth/functions/oauth-get-sbs.xml deleted file mode 100644 index d26a094311..0000000000 --- a/reference/oauth/functions/oauth-get-sbs.xml +++ /dev/null @@ -1,81 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: andresdzphp Status: ready --> -<!-- Reviewed: yes Maintainer: andresdzphp --> -<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.oauth-get-sbs"> - <refnamediv> - <refname>oauth_get_sbs</refname> - <refpurpose>Genera una cadena de firma base</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>string</type><methodname>oauth_get_sbs</methodname> - <methodparam><type>string</type><parameter>http_method</parameter></methodparam> - <methodparam><type>string</type><parameter>uri</parameter></methodparam> - <methodparam choice="opt"><type>array</type><parameter>request_parameters</parameter></methodparam> - </methodsynopsis> - <simpara> - Genera un string de firma base con PECL/OAuth. - </simpara> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <variablelist> - <varlistentry> - <term><parameter>http_method</parameter></term> - <listitem> - <simpara> - El método HTTP. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>uri</parameter></term> - <listitem> - <simpara> - La URI a códificar. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>request_parameters</parameter></term> - <listitem> - <simpara> - Array de parámetros de petición. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <simpara> - Devuelve el string de firma base. - </simpara> - </refsect1> - -</refentry> -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/oauth/functions/oauth-urlencode.xml b/reference/oauth/functions/oauth-urlencode.xml deleted file mode 100644 index 4f80ffac69..0000000000 --- a/reference/oauth/functions/oauth-urlencode.xml +++ /dev/null @@ -1,62 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: agarzon Status: ready --> -<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.oauth-urlencode"> - <refnamediv> - <refname>oauth_urlencode</refname> - <refpurpose>Códifica una URI a RFC 3986</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>string</type><methodname>oauth_urlencode</methodname> - <methodparam><type>string</type><parameter>uri</parameter></methodparam> - </methodsynopsis> - <simpara> - Códifica una URI a <link xlink:href="&url.rfc;3986">RFC 3986</link>. - </simpara> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <variablelist> - <varlistentry> - <term><parameter>uri</parameter></term> - <listitem> - <simpara> - URI a codificar. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <simpara> - Devuelve una cadena codificada según <link xlink:href="&url.rfc;3986">RFC 3986</link>. - </simpara> - </refsect1> - -</refentry> -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/oauth/oauth.xml b/reference/oauth/oauth.xml deleted file mode 100644 index ae6f7fbb3d..0000000000 --- a/reference/oauth/oauth.xml +++ /dev/null @@ -1,111 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<!-- EN-Revision: bdee7e8c1b344c85fa9c3d320ba3f6b0db849c6a Maintainer: PhilDaiguille Status: ready --> -<!-- Reviewed: no Maintainer: Marqitos --> -<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.oauth" role="class"> - <title>La clase <classname>OAuth</classname> - OAuth - - - - -
    - &reftitle.intro; - - La extensión OAuth proporciona una interfaz simple para interactuar con - proveedores de datos, utilizando las especificaciones HTTP OAuth - para proteger los recursos. - -
    - - -
    - &reftitle.classsynopsis; - - - - OAuth - - - - - OAuth - - - - - &Properties; - - public - debug - - - public - sslChecks - - - public - debugInfo - - - &Methods; - - - - - - - - - -
    - -
    - &reftitle.properties; - - - debug - - - - - - sslChecks - - - - - - debugInfo - - - - - -
    - -
    - - &reference.oauth.entities.oauth; - - - diff --git a/reference/oauth/oauth/construct.xml b/reference/oauth/oauth/construct.xml deleted file mode 100644 index 6c136a6a0a..0000000000 --- a/reference/oauth/oauth/construct.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - OAuth::__construct - Crea un nuevo objeto OAuth - - - - &reftitle.description; - - public OAuth::__construct - stringconsumer_key - stringconsumer_secret - stringsignature_methodOAUTH_SIG_METHOD_HMACSHA1 - intauth_type0 - - - Crea un nuevo objeto OAuth. - - - - - &reftitle.parameters; - - - consumer_key - - - La clave de consumidor proporcionada por el proveedor de servicios. - - - - - consumer_secret - - - El secreto de consumidor proporcionado por el proveedor de servicios. - - - - - signature_method - - - Este parámetro opcional define el método de firma utilizado. - Por omisión, es OAUTH_SIG_METHOD_HMACSHA1 (HMAC-SHA1). - - - - - auth_type - - - Este parámetro opcional define el método de paso de los - parámetros OAuth al proveedor de servicios. Por omisión, es - OAUTH_AUTH_TYPE_AUTHORIZATION (en el encabezado - Authorization). - - - - - - - - diff --git a/reference/oauth/oauth/destruct.xml b/reference/oauth/oauth/destruct.xml deleted file mode 100644 index abb152eab1..0000000000 --- a/reference/oauth/oauth/destruct.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - OAuth::__destruct - El destructor - - - - &reftitle.description; - - public voidOAuth::__destruct - - - - El destructor. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - OAuth::__construct - - - - - diff --git a/reference/oauth/oauth/disabledebug.xml b/reference/oauth/oauth/disabledebug.xml deleted file mode 100644 index 48966cd578..0000000000 --- a/reference/oauth/oauth/disabledebug.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - OAuth::disableDebug - Desactiva los mensajes de depuración - - - - &reftitle.description; - - public boolOAuth::disableDebug - - - - Desactiva los mensajes de depuración. Se encuentra desactivado por omisión. - Puede definirse la propiedad debug - a &false; para desactivar la depuración. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL oauth 0.99.8 - - Se ha añadido la propiedad debug - - - - - - - - - &reftitle.seealso; - - OAuth::enableDebug - - - - - diff --git a/reference/oauth/oauth/disableredirects.xml b/reference/oauth/oauth/disableredirects.xml deleted file mode 100644 index 8db758f0ed..0000000000 --- a/reference/oauth/oauth/disableredirects.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - OAuth::disableRedirects - Desactiva las redirecciones - - - - &reftitle.description; - - public boolOAuth::disableRedirects - - - - Desactiva las redirecciones automáticas, permitiendo que la petición sea manualmente redirigida. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; - - - - - &reftitle.seealso; - - OAuth::enableRedirects - - - - - diff --git a/reference/oauth/oauth/disablesslchecks.xml b/reference/oauth/oauth/disablesslchecks.xml deleted file mode 100644 index 256965e477..0000000000 --- a/reference/oauth/oauth/disablesslchecks.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - OAuth::disableSSLChecks - Desactiva la verificación SSL - - - - &reftitle.description; - - public boolOAuth::disableSSLChecks - - - - Desactiva las verificaciones de certificados y de hosts SSL (activado por omisión). - Se recomienda no utilizar esta función en producción. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL oauth 0.99.8 - - Se ha añadido la propiedad debug - - - - - - - - - &reftitle.seealso; - - OAuth::enableSSLChecks - - - - - diff --git a/reference/oauth/oauth/enabledebug.xml b/reference/oauth/oauth/enabledebug.xml deleted file mode 100644 index abd1828b5a..0000000000 --- a/reference/oauth/oauth/enabledebug.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - OAuth::enableDebug - Activa los mensajes de depuración - - - - &reftitle.description; - - public boolOAuth::enableDebug - - - - Activa los mensajes de depuración, útiles en desarrollo, pero - innecesarios en producción. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL oauth 0.99.8 - - Se añadió la propiedad debug - - - - - - - - - &reftitle.seealso; - - OAuth::disableDebug - - - - - diff --git a/reference/oauth/oauth/enableredirects.xml b/reference/oauth/oauth/enableredirects.xml deleted file mode 100644 index 2513e5f15b..0000000000 --- a/reference/oauth/oauth/enableredirects.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - OAuth::enableRedirects - Activa las re-direcciones - - - - &reftitle.description; - - public boolOAuth::enableRedirects - - - - Sigue y firma las re-direcciones automáticamente, el cual está en activado por omisión. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; - - - - - &reftitle.seealso; - - OAuth::disableRedirects - - - - - diff --git a/reference/oauth/oauth/enablesslchecks.xml b/reference/oauth/oauth/enablesslchecks.xml deleted file mode 100644 index d0a323dacc..0000000000 --- a/reference/oauth/oauth/enablesslchecks.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - OAuth::enableSSLChecks - Activa la verificación SSL - - - - &reftitle.description; - - public boolOAuth::enableSSLChecks - - - - Activa las verificaciones de certificados y de hosts SSL (activado por omisión). - Alternativamente, la propiedad sslChecks puede ser definida sobre - un valor diferente de &false; para activar las verificaciones SSL. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &true; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL oauth 0.99.8 - - La propiedad debug ha sido añadida - - - - - - - - - &reftitle.seealso; - - OAuth::disableSSLChecks - - - - - diff --git a/reference/oauth/oauth/fetch.xml b/reference/oauth/oauth/fetch.xml deleted file mode 100644 index d76addb120..0000000000 --- a/reference/oauth/oauth/fetch.xml +++ /dev/null @@ -1,166 +0,0 @@ - - - - - - - OAuth::fetch - Lee un recurso protegido por OAuth - - - - &reftitle.description; - - public mixedOAuth::fetch - stringprotected_resource_url - arrayextra_parameters - stringhttp_method - arrayhttp_headers - - - Lee un recurso protegido por OAuth. - - - - - &reftitle.parameters; - - - protected_resource_url - - - URL del recurso protegido por OAuth. - - - - - extra_parameters - - - Argumentos adicionales a enviar con la petición, al recurso. - - - - - http_method - - - Una de las constantes OAUTH_HTTP_METHOD_* - OAUTH, incluyendo GET, POST, PUT, HEAD, o DELETE. - - - HEAD (OAUTH_HTTP_METHOD_HEAD) puede ser útil - para descubrir información antes de la petición (si las autorizaciones - OAuth están en el encabezado Authorization). - - - - - http_headers - - - Los encabezados HTTP del cliente (tales como User-Agent, - Accept, etc.) - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL oauth 1.0.0 - - &oauth.changelog.error.null; - - - - PECL oauth 0.99.5 - - Se añadió el argumento http_method - - - - PECL oauth 0.99.8 - - Se añadió el argumento http_headers - - - - - - - - - &reftitle.examples; - - Ejemplo con <function>OAuth::fetch</function> - -setToken("access_token","access_token_secret"); - - $oauth->fetch("http://photos.example.net/photo?file=vacation.jpg"); - - $response_info = $oauth->getLastResponseInfo(); - header("Content-Type: {$response_info["content_type"]}"); - echo $oauth->getLastResponse(); -} catch(OAuthException $E) { - echo "Exception caught!\n"; - echo "Response: ". $E->lastResponse . "\n"; -} -?> -]]> - - - - - - &reftitle.seealso; - - OAuth::getLastResponse - OAuth::getLastResponseInfo - OAuth::setToken - - - - - diff --git a/reference/oauth/oauth/generatesignature.xml b/reference/oauth/oauth/generatesignature.xml deleted file mode 100644 index f1c1a9b6eb..0000000000 --- a/reference/oauth/oauth/generatesignature.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - OAuth::generateSignature - Genera una firma - - - - &reftitle.description; - - public stringfalseOAuth::generateSignature - stringhttp_method - stringurl - mixedextra_parameters - - - Genera una firma basada en el método HTTP final, - la URL y una cadena/array de parámetros. - - - - - - &reftitle.parameters; - - - http_method - - - Método HTTP para la petición. - - - - - url - - - URL de la petición. - - - - - extra_parameters - - - Cadena o array de parámetros adicionales. - - - - - - - - &reftitle.returnvalues; - - Una cadena que contiene la firma generada&return.falseforfailure; - - - - - diff --git a/reference/oauth/oauth/getaccesstoken.xml b/reference/oauth/oauth/getaccesstoken.xml deleted file mode 100644 index 432079d314..0000000000 --- a/reference/oauth/oauth/getaccesstoken.xml +++ /dev/null @@ -1,178 +0,0 @@ - - - - - - - OAuth::getAccessToken - Recupera un token de acceso - - - - &reftitle.description; - - public arrayOAuth::getAccessToken - stringaccess_token_url - stringauth_session_handle - stringverifier_token - stringhttp_method - - - Lee un token de acceso, un secreto y cualquier información adicional en - un proveedor de servicios. - - - - - &reftitle.parameters; - - - access_token_url - - - La URL a utilizar. - - - - - auth_session_handle - - - El identificador de sesión. Este parámetro no existe - en las especificaciones OAuth 1.0, pero puede ser implementado - por grandes implementaciones. Véase - ScalableOAuth - para más detalles. - - - - - verifier_token - - - Para los proveedores de servicio que soportan 1.0a, - el parámetro verifier_token debe ser - proporcionado, al intercambiar el token de solicitud para obtener el token - de acceso. Si verifier_token está presente en - $_GET o $_POST, es - automáticamente pasado y el llamante no necesita especificar - el parámetro verifier_token (generalmente, el token - de acceso es intercambiado vía la URL de devolución callback_url). - Véase ScalableOAuth - para más información. - - - - - http_method - - - Método HTTP a utilizar, por ejemplo - GET o POST. - - - - - - - - &reftitle.returnvalues; - - Devuelve un array que contiene la respuesta OAuth analizada, en caso de éxito, - y &false; en caso contrario. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL oauth 1.0.0 - - &oauth.changelog.error.null; - - - - PECL oauth 0.99.9 - - Se añadió el parámetro verifier_token - - - - - - - - - &reftitle.examples; - - Ejemplo con <function>OAuth::getAccessToken</function> - -setToken($request_token,$request_token_secret); - $access_token_info = $oauth->getAccessToken("https://example.com/oauth/access_token"); - if(!empty($access_token_info)) { - print_r($access_token_info); - } else { - print "Error al obtener el token de acceso, la respuesta fue: " . $oauth->getLastResponse(); - } -} catch(OAuthException $E) { - echo "Respuesta: ". $E->lastResponse . "\n"; -} -?> -]]> - - &example.outputs.similar; - - some_token - [oauth_token_secret] => some_token_secret -) -]]> - - - - - - &reftitle.seealso; - - OAuth::getLastResponse - OAuth::getLastResponseInfo - OAuth::setToken - - - - - diff --git a/reference/oauth/oauth/getcapath.xml b/reference/oauth/oauth/getcapath.xml deleted file mode 100644 index eb91313375..0000000000 --- a/reference/oauth/oauth/getcapath.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - OAuth::getCAPath - Obtiene la información CA - - - - &reftitle.description; - - public arrayOAuth::getCAPath - - - - Obtiene la información del certificado de Autoridad, el cual incluye los - ca_path y ca_info establecidos por OAuth::setCaPath. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un array con información del Certificado de Autoridad, específicamente como claves - ca_path y ca_info dentro del array asociativo devuelto. - - - - - &reftitle.seealso; - - OAuth::setCAPath - OAuth::getLastResponseInfo - - - - - diff --git a/reference/oauth/oauth/getlastresponse.xml b/reference/oauth/oauth/getlastresponse.xml deleted file mode 100644 index 3c754ef8b3..0000000000 --- a/reference/oauth/oauth/getlastresponse.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - OAuth::getLastResponse - Obtiene la última respuesta - - - - &reftitle.description; - - public stringOAuth::getLastResponse - - - - Obtiene la respuesta original de la más reciente petición. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la cadena conteniendo la última respuesta. - - - - - &reftitle.seealso; - - OAuth::getLastResponseInfo - OAuth::fetch - - - - - diff --git a/reference/oauth/oauth/getlastresponseheaders.xml b/reference/oauth/oauth/getlastresponseheaders.xml deleted file mode 100644 index 5c611a7593..0000000000 --- a/reference/oauth/oauth/getlastresponseheaders.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - OAuth::getLastResponseHeaders - Recupera los encabezados de la última respuesta - - - - &reftitle.description; - - public stringfalseOAuth::getLastResponseHeaders - - - - Recupera los encabezados de la última respuesta. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un &string; que contiene los encabezados de la última - respuesta&return.falseforfailure; - - - - - diff --git a/reference/oauth/oauth/getlastresponseinfo.xml b/reference/oauth/oauth/getlastresponseinfo.xml deleted file mode 100644 index bf4472a9e0..0000000000 --- a/reference/oauth/oauth/getlastresponseinfo.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - OAuth::getLastResponseInfo - Obtiene la información HTTP sobre la última respuesta - - - - &reftitle.description; - - public arrayOAuth::getLastResponseInfo - - - - Obtiene la información HTTP sobre la última respuesta. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un array conteniendo la información de respuesta de la última petición. Constantes de curl_getinfo pueden ser usadas. - - - - - &reftitle.seealso; - - OAuth::fetch - OAuth::getLastResponse - - - - - diff --git a/reference/oauth/oauth/getrequestheader.xml b/reference/oauth/oauth/getrequestheader.xml deleted file mode 100644 index 3079867e20..0000000000 --- a/reference/oauth/oauth/getrequestheader.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - OAuth::getRequestHeader - Genera una firma de encabezado OAuth - - - - &reftitle.description; - - public stringfalseOAuth::getRequestHeader - stringhttp_method - stringurl - mixedextra_parameters - - - Genera una firma de encabezado OAuth basada en el método HTTP - final, así como en la URL y sus parámetros. - - - - - &reftitle.parameters; - - - http_method - - - Método HTTP para la petición. - - - - - url - - - URL de la petición. - - - - - extra_parameters - - - Parámetros adicionales (&string; o array). - - - - - - - - &reftitle.returnvalues; - - Un &string; que contiene el encabezado generado de la petición - &return.falseforfailure; - - - - - diff --git a/reference/oauth/oauth/getrequesttoken.xml b/reference/oauth/oauth/getrequesttoken.xml deleted file mode 100644 index f70cc31165..0000000000 --- a/reference/oauth/oauth/getrequesttoken.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - - OAuth::getRequestToken - Lee el token de solicitud - - - - &reftitle.description; - - public arrayOAuth::getRequestToken - stringrequest_token_url - stringcallback_url - stringhttp_method - - - Lee el token de solicitud, el secreto y cualquier información adicional - del proveedor de servicios. - - - - - &reftitle.parameters; - - - request_token_url - - - La URL de la que se debe obtener el token. - - - - - callback_url - - - URL de devolución de llamada OAuth. Si callback_url es pasado - y su valor es vacío, entonces toma el valor de - "oob" para cumplir con los requisitos de - OAuth 2009.1 advisory. - - - - - http_method - - - Método HTTP a utilizar, por ejemplo - GET o POST. - - - - - - - - &reftitle.returnvalues; - - Devuelve un array que contiene la respuesta OAuth analizada, en caso de éxito, - o &false; en caso de fallo. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL oauth 1.0.0 - - &oauth.changelog.error.null; - - - - PECL oauth 0.99.9 - - Se ha añadido el parámetro callback_url - - - - - - - - - &reftitle.examples; - - Ejemplo con <function>OAuth::getRequestToken</function> - -getRequestToken("https://example.com/oauth/request_token"); - if(!empty($request_token_info)) { - print_r($request_token_info); - } else { - print "Failed fetching request token, response was: " . $oauth->getLastResponse(); - } -} catch(OAuthException $E) { - echo "Response: ". $E->lastResponse . "\n"; -} -?> -]]> - - &example.outputs.similar; - - some_token - [oauth_token_secret] => some_token_secret -) -]]> - - - - - - &reftitle.seealso; - - OAuth::getLastResponse - OAuth::getLastResponseInfo - - - - - diff --git a/reference/oauth/oauth/setauthtype.xml b/reference/oauth/oauth/setauthtype.xml deleted file mode 100644 index fc8a9e3095..0000000000 --- a/reference/oauth/oauth/setauthtype.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - - OAuth::setAuthType - Define el tipo de autorización - - - - &reftitle.description; - - public boolOAuth::setAuthType - intauth_type - - - Configura los parámetros OAuth. - - - - - &reftitle.parameters; - - - auth_type - - - auth_type puede ser una de las siguientes opciones - (clasificadas por orden decreciente de preferencia, - como se especifica en la sección 5.2 de OAuth 1.0) : - - - OAUTH_AUTH_TYPE_AUTHORIZATION - - - Pasa los parámetros OAuth en el encabezado HTTP Authorization. - - - - - OAUTH_AUTH_TYPE_FORM - - - Añade los parámetros OAuth al cuerpo de la petición HTTP POST. - - - - - OAUTH_AUTH_TYPE_URI - - - Añade los parámetros OAuth a la URI. - - - - - OAUTH_AUTH_TYPE_NONE - - - Ninguno. - - - - - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si un parámetro es definido correctamente, - &false; en los demás casos. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL oauth 1.0.0 - - &oauth.changelog.error.null; - - - - - - - - - diff --git a/reference/oauth/oauth/setcapath.xml b/reference/oauth/oauth/setcapath.xml deleted file mode 100644 index 2bbddb3877..0000000000 --- a/reference/oauth/oauth/setcapath.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - OAuth::setCAPath - Define el camino y la información de la CA - - - - &reftitle.description; - - public mixedOAuth::setCAPath - stringca_path - stringca_info - - - Define el certificado de autoridad (CA), tanto para - el camino como para la información. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - ca_path - - - El camino de la CA a definir. - - - - - ca_info - - - La información de la CA a definir. - - - - - - - - - &reftitle.returnvalues; - - Retorna &true; en caso de éxito, o &false; si ca_path - o ca_info son considerados inválidos. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL oauth 1.0.0 - - &oauth.changelog.error.null; - - - - - - - - - &reftitle.seealso; - - OAuth::getCaPath - - - - - diff --git a/reference/oauth/oauth/setnonce.xml b/reference/oauth/oauth/setnonce.xml deleted file mode 100644 index 8be6db34ce..0000000000 --- a/reference/oauth/oauth/setnonce.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - OAuth::setNonce - Configura el nonce OAuth - - - - &reftitle.description; - - public mixedOAuth::setNonce - stringnonce - - - Configura el nonce OAuth para las llamadas siguientes. - - - - - &reftitle.parameters; - - - nonce - - - El valor de oauth_nonce. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; en caso de éxito, o &false; si el - argumento nonce es considerado - inválido. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL oauth 1.0.0 - - &oauth.changelog.error.null; - - - - - - - - - &reftitle.seealso; - - OAuth::setToken - OAuth::setAuthType - OAuth::setVersion - - - - - diff --git a/reference/oauth/oauth/setrequestengine.xml b/reference/oauth/oauth/setrequestengine.xml deleted file mode 100644 index 56a6b7afe7..0000000000 --- a/reference/oauth/oauth/setrequestengine.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - OAuth::setRequestEngine - El propósito de setRequestEngine - - - - &reftitle.description; - - public voidOAuth::setRequestEngine - intreqengine - - - Establece el motor de peticiones, que estará enviando las peticiones HTTP. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - reqengine - - - El motor de peticiones deseado. Poner a OAUTH_REQENGINE_STREAMS - para usar el Stream PHP, o OAUTH_REQENGINE_CURL para usar - Curl. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Emite una excepción OAuthException si un motor de peticiones inválido es - escogido. - - - - - &reftitle.examples; - - Ejemplo de <function>OAuth::setRequestEngine</function> - -setRequestEngine(OAUTH_REQENGINE_STREAMS); -?> -]]> - - - - - - &reftitle.seealso; - - Curl - flujos PHP - OAuthException - - - - diff --git a/reference/oauth/oauth/setrsacertificate.xml b/reference/oauth/oauth/setrsacertificate.xml deleted file mode 100644 index c3e0339df8..0000000000 --- a/reference/oauth/oauth/setrsacertificate.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - OAuth::setRSACertificate - Define el certificado RSA - - - - &reftitle.description; - - public mixedOAuth::setRSACertificate - stringcert - - - Define el certificado RSA. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - cert - - - El certificado RSA. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; en caso de éxito, o &false; si ocurre un error - (es decir, el certificado RSA no puede ser analizado). - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL oauth 1.0.0 - - &oauth.changelog.error.null; - - - - - - - - - &reftitle.examples; - - Ejemplo con <methodname>OAuth::setRsaCertificate</methodname> - -setRSACertificate(file_get_contents('test.pem')); -?> -]]> - - - - - - &reftitle.seealso; - - OAuth::setCaPath - - - - - diff --git a/reference/oauth/oauth/setsslchecks.xml b/reference/oauth/oauth/setsslchecks.xml deleted file mode 100644 index 8b32c77627..0000000000 --- a/reference/oauth/oauth/setsslchecks.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - OAuth::setSSLChecks - Ajustar controles específicos de SSL para las solicitudes - - - - &reftitle.description; - - public boolOAuth::setSSLChecks - intsslcheck - - - Ajusta controles específicos de SSL para las solicitudes. - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - sslcheck - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/oauth/oauth/settimestamp.xml b/reference/oauth/oauth/settimestamp.xml deleted file mode 100644 index f9d32b853d..0000000000 --- a/reference/oauth/oauth/settimestamp.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - OAuth::setTimestamp - Define el timestamp - - - - &reftitle.description; - - public mixedOAuth::setTimestamp - stringtimestamp - - - Define el timestamp OAuth para las próximas peticiones. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - timestamp - - - El timestamp. - - - - - - - - &reftitle.returnvalues; - - Retorna &true;, o &false; si timestamp es inválido. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL oauth 1.0.0 - - &oauth.changelog.error.null; - - - - - - - - - &reftitle.seealso; - - OAuth::setNonce - - - - - diff --git a/reference/oauth/oauth/settoken.xml b/reference/oauth/oauth/settoken.xml deleted file mode 100644 index f8193868e8..0000000000 --- a/reference/oauth/oauth/settoken.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - OAuth::setToken - Establece el token y el secreto - - - - &reftitle.description; - - public boolOAuth::setToken - stringtoken - stringtoken_secret - - - Establece el token y el secreto para las subsecuentes peticiones. - - - - - &reftitle.parameters; - - - token - - - El token OAuth. - - - - - token_secret - - - El secreto OAuth. - - - - - - - - &reftitle.returnvalues; - - &true; - - - - - &reftitle.examples; - - Ejemplo <function>OAuth::setToken</function> - -setToken("token","token-secret"); -?> -]]> - - - - - - diff --git a/reference/oauth/oauth/setversion.xml b/reference/oauth/oauth/setversion.xml deleted file mode 100644 index 3dd8f1251f..0000000000 --- a/reference/oauth/oauth/setversion.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - OAuth::setVersion - Configura la versión OAuth - - - - &reftitle.description; - - public boolOAuth::setVersion - stringversion - - - Establece la versión OAuth para las subsecuentes peticiones - - - - - &reftitle.parameters; - - - version - - - Versión OAuth, el valor por omisión es siempre "1.0" - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/oauth/oauthexception.xml b/reference/oauth/oauthexception.xml deleted file mode 100644 index e7f2697404..0000000000 --- a/reference/oauth/oauthexception.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - Clase OAuthException - OAuthException - - - - -
    - &reftitle.intro; - - Esta excepción es lanzada cuando un error excepcional durante el uso de la extensión OAuth y contiene información útil de depuración. - -
    - - -
    - &reftitle.classsynopsis; - - - - OAuthException - - - - - OAuthException - - - - extends - Exception - - - - &Properties; - - public - lastResponse - - - public - debugInfo - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - lastResponse - - La respuesta de la excepción ocurrida, si la hubiera - - - - debugInfo - - - - - -
    - - -
    - -
    - diff --git a/reference/oauth/oauthprovider.xml b/reference/oauth/oauthprovider.xml deleted file mode 100644 index 2dae696f8d..0000000000 --- a/reference/oauth/oauthprovider.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - La clase OAuthProvider - OAuthProvider - - - - -
    - &reftitle.intro; - - Gestiona una clase OAuthProvider. - - - Consúltese también un tutorial externo denominado - Escribir un servicio OAuth Provider, - que proporciona un buen enfoque para ofrecer este servicio. Asimismo, existen - ejemplos OAuth provider directamente - en las fuentes de la extensión OAuth. - -
    - - -
    - &reftitle.classsynopsis; - - - - OAuthProvider - - - - - OAuthProvider - - - - - &Methods; - - - - -
    - -
    - - &reference.oauth.entities.oauthprovider; - -
    - diff --git a/reference/oauth/oauthprovider/addrequiredparameter.xml b/reference/oauth/oauthprovider/addrequiredparameter.xml deleted file mode 100644 index 38289db625..0000000000 --- a/reference/oauth/oauthprovider/addrequiredparameter.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - OAuthProvider::addRequiredParameter - Agregar parámetros necesarios - - - - &reftitle.description; - - final public boolOAuthProvider::addRequiredParameter - stringreq_params - - - Agregar parámetros requeridos por el proveedor OAuth. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - req_params - - - Los parámetros requeridos. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - OAuthProvider::removeRequiredParameter - - - - - diff --git a/reference/oauth/oauthprovider/callconsumerhandler.xml b/reference/oauth/oauthprovider/callconsumerhandler.xml deleted file mode 100644 index 5121710df0..0000000000 --- a/reference/oauth/oauthprovider/callconsumerhandler.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - OAuthProvider::callconsumerHandler - Llama al callback consumerNonceHandler - - - - &reftitle.description; - - public voidOAuthProvider::callconsumerHandler - - - - Llama al callback del manejador del consumidor registrado, la cual es establecida - con OAuthProvider::consumerHandler. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &oauth.callback.error; - - - - - &reftitle.seealso; - - OAuthProvider::consumerHandler - - - - - diff --git a/reference/oauth/oauthprovider/calltimestampnoncehandler.xml b/reference/oauth/oauthprovider/calltimestampnoncehandler.xml deleted file mode 100644 index 28aae99141..0000000000 --- a/reference/oauth/oauthprovider/calltimestampnoncehandler.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - OAuthProvider::callTimestampNonceHandler - Llama al callback timestampNonceHandler - - - - &reftitle.description; - - public voidOAuthProvider::callTimestampNonceHandler - - - - Llama a la función callback del timestamp registrado, que fue establecido - con OAuthProvider::timestampNonceHandler. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &oauth.callback.error; - - - - - &reftitle.seealso; - - OAuthProvider::timestampNonceHandler - - - - - diff --git a/reference/oauth/oauthprovider/calltokenhandler.xml b/reference/oauth/oauthprovider/calltokenhandler.xml deleted file mode 100644 index ea04463189..0000000000 --- a/reference/oauth/oauthprovider/calltokenhandler.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - OAuthProvider::calltokenHandler - Llama al callback tokenNonceHandler - - - - &reftitle.description; - - public voidOAuthProvider::calltokenHandler - - - - Llama a la función callback del token registrado, que fue establecido - con OAuthProvider::tokenHandler. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - &oauth.callback.error; - - - - - &reftitle.seealso; - - OAuthProvider::tokenHandler - - - - - diff --git a/reference/oauth/oauthprovider/checkoauthrequest.xml b/reference/oauth/oauthprovider/checkoauthrequest.xml deleted file mode 100644 index 85aed949fd..0000000000 --- a/reference/oauth/oauthprovider/checkoauthrequest.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - OAuthProvider::checkOAuthRequest - Verifica una petición OAuth - - - - &reftitle.description; - - public voidOAuthProvider::checkOAuthRequest - stringuri - stringmethod - - - Verifica una petición OAuth. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - uri - - - La URI, opcional, o un punto final. - - - - - method - - - El método HTTP. Opcional; pase una de las constantes OAuth - OAUTH_HTTP_METHOD_*. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Emite un error de nivel E_ERROR si el método - HTTP no puede ser detectado. - - - - - &reftitle.seealso; - - OAuthProvider::reportProblem - - - - - diff --git a/reference/oauth/oauthprovider/construct.xml b/reference/oauth/oauthprovider/construct.xml deleted file mode 100644 index bce475360d..0000000000 --- a/reference/oauth/oauthprovider/construct.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - OAuthProvider::__construct - Construye un nuevo objeto OAuthProvider - - - - &reftitle.description; - - public OAuthProvider::__construct - arrayparams_array - - - Inicia un nuevo object OAuthProvider . - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - params_array - - - La configuración de estos parámetros opcionales se limita al - CLI SAPI. - - - - - - - - &reftitle.returnvalues; - - Un object OAuthProvider . - - - - - &reftitle.examples; - - Ejemplo de <function>OAuthProvider::__construct</function> - -consumerHandler(array($this, 'lookupConsumer')); - $op->timestampNonceHandler(array($this, 'timestampNonceChecker')); - $op->tokenHandler(array($this, 'myTokenHandler')); - - // Ignora el parámetro foo_uri - $op->setParam('foo_uri', NULL); - - // No es necesario el token para este punto final - $op->setRequestTokenPath('/v1/oauth/request_token'); - - $op->checkOAuthRequest(); - -} catch (OAuthException $e) { - - echo OAuthProvider::reportProblem($e); -} -?> -]]> - - - - - - &reftitle.seealso; - - OAuthProvider::setParam - - - - - diff --git a/reference/oauth/oauthprovider/consumerhandler.xml b/reference/oauth/oauthprovider/consumerhandler.xml deleted file mode 100644 index a62e2a2d5f..0000000000 --- a/reference/oauth/oauthprovider/consumerhandler.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - OAuthProvider::consumerHandler - Establece el manejador callback consumerHandler - - - - &reftitle.description; - - public voidOAuthProvider::consumerHandler - callablecallback_function - - - Establece el manejador callback, que más tarde será llamado con - OAuthProvider::callConsumerHandler. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - callback_function - - - El nombre de la función callable. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo del callback <methodname>OAuthProvider::consumerHandler</methodname> - -consumer_key === 'unknown') { - return OAUTH_CONSUMER_KEY_UNKNOWN; - } else if($provider->consumer_key == 'blacklisted' || $provider->consumer_key === 'throttled') { - return OAUTH_CONSUMER_KEY_REFUSED; - } - - $provider->consumer_secret = "the_consumers_secret"; - - return OAUTH_OK; -} -?> -]]> - - - - - - &reftitle.seealso; - - OAuthProvider::callConsumerHandler - - - - - diff --git a/reference/oauth/oauthprovider/generatetoken.xml b/reference/oauth/oauthprovider/generatetoken.xml deleted file mode 100644 index 0f81b797c1..0000000000 --- a/reference/oauth/oauthprovider/generatetoken.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - - OAuthProvider::generateToken - Genera un token aleatorio - - - - &reftitle.description; - - final public static stringOAuthProvider::generateToken - intsize - boolstrong&false; - - - Genera un &string; de bytes pseudo-aleatorios. - - - - - &reftitle.parameters; - - - size - - - La longitud deseada del token, en bytes. - - - - - strong - - - Definido como &true;, indica que se utilizará /dev/random, - de lo contrario, se utilizará /dev/urandom. Este parámetro es ignorado en Windows. - - - - - - - - &reftitle.returnvalues; - - El token generado, en forma de &string; de bytes. - - - - - &reftitle.errors; - - Si el parámetro strong es &true;, entonces se emitirá - una advertencia de nivel E_WARNING cuando la - función de devolución de llamada rand se utilice para completar - los bytes aleatorios faltantes (es decir, cuando no hay suficientes datos - aleatorios inicialmente). - - - - - &reftitle.examples; - - Ejemplo con <function>OAuthProvider::generateToken</function> - -generateToken(4); - -echo strlen($t), PHP_EOL; -echo bin2hex($t), PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.notes; - - - Cuando no hay suficientes datos aleatorios disponibles en el sistema, - esta función completará los bytes faltantes utilizando la función - interna de PHP rand. - - - - - - &reftitle.seealso; - - openssl_random_pseudo_bytes - mcrypt_create_iv - - - - - diff --git a/reference/oauth/oauthprovider/is2leggedendpoint.xml b/reference/oauth/oauthprovider/is2leggedendpoint.xml deleted file mode 100644 index 9370fbbf9f..0000000000 --- a/reference/oauth/oauthprovider/is2leggedendpoint.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - OAuthProvider::is2LeggedEndpoint - is2LeggedEndpoint - - - - &reftitle.description; - - public voidOAuthProvider::is2LeggedEndpoint - mixedparams_array - - - El flujo de 2-piernas, o la suscripción de petición. No requiere token. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - params_array - - - - - - - - - - - &reftitle.returnvalues; - - Un object de OAuthProvider. - - - - - &reftitle.examples; - - Ejemplo de <function>OAuthProvider::is2LeggedEndpoint</function> - -is2LeggedEndpoint(true); - -?> -]]> - - - - - - &reftitle.seealso; - - OAuthProvider::__construct - - - - - diff --git a/reference/oauth/oauthprovider/isrequesttokenendpoint.xml b/reference/oauth/oauthprovider/isrequesttokenendpoint.xml deleted file mode 100644 index 03b59a85a9..0000000000 --- a/reference/oauth/oauthprovider/isrequesttokenendpoint.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - OAuthProvider::isRequestTokenEndpoint - Establece isRequestTokenEndpoint - - - - &reftitle.description; - - public voidOAuthProvider::isRequestTokenEndpoint - boolwill_issue_request_token - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - will_issue_request_token - - - Establece si emitirá o no una emisión de petición de token, determinando si - OAuthProvider::tokenHandler necesita ser llamado. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - OAuthProvider::setRequestTokenPath - OAuthProvider::reportProblem - - - - - diff --git a/reference/oauth/oauthprovider/removerequiredparameter.xml b/reference/oauth/oauthprovider/removerequiredparameter.xml deleted file mode 100644 index 7a5ebc55d2..0000000000 --- a/reference/oauth/oauthprovider/removerequiredparameter.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - OAuthProvider::removeRequiredParameter - Remueve un parámetro requerido - - - - &reftitle.description; - - final public boolOAuthProvider::removeRequiredParameter - stringreq_params - - - Remueve un parámetro requerido. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - req_params - - - El parámetro requerido a ser removido. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - OAuthProvider::setParam - OAuthProvider::addRequiredParameter - - - - - diff --git a/reference/oauth/oauthprovider/reportproblem.xml b/reference/oauth/oauthprovider/reportproblem.xml deleted file mode 100644 index 2e0da7dd3f..0000000000 --- a/reference/oauth/oauthprovider/reportproblem.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - OAuthProvider::reportProblem - Se informa sobre un problema - - - - &reftitle.description; - - final public static stringOAuthProvider::reportProblem - stringoauthexception - boolsend_headers&true; - - - Se informa sobre un problema en forma de excepción - OAuthException; los problemas posibles se enumeran - en la sección de las constantes OAuth. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - oauthexception - - - La excepción OAuthException. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - OAuthProvider::checkOAuthRequest - OAuthProvider::isRequestTokenEndpoint - - - - - diff --git a/reference/oauth/oauthprovider/setparam.xml b/reference/oauth/oauthprovider/setparam.xml deleted file mode 100644 index 61c78258fb..0000000000 --- a/reference/oauth/oauthprovider/setparam.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - OAuthProvider::setParam - Establece un parámetro - - - - &reftitle.description; - - final public boolOAuthProvider::setParam - stringparam_key - mixedparam_val - - - Establece un parámetro. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - param_key - - - La clave del parámetro. - - - - - param_val - - - El valor opcional del parámetro. - - - Para excluir un parámetro de la verificación de firmas, colocar este valor a &null;. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - OAuthProvider::addRequiredParameter - - - - - diff --git a/reference/oauth/oauthprovider/setrequesttokenpath.xml b/reference/oauth/oauthprovider/setrequesttokenpath.xml deleted file mode 100644 index 9a39325b2b..0000000000 --- a/reference/oauth/oauthprovider/setrequesttokenpath.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - OAuthProvider::setRequestTokenPath - Establece la ruta de petición del token - - - - &reftitle.description; - - final public boolOAuthProvider::setRequestTokenPath - stringpath - - - Establece la ruta de petición del token. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - path - - - La ruta. - - - - - - - - &reftitle.returnvalues; - - &true; - - - - - &reftitle.seealso; - - OAuthProvider::tokenHandler - - - - - diff --git a/reference/oauth/oauthprovider/timestampnoncehandler.xml b/reference/oauth/oauthprovider/timestampnoncehandler.xml deleted file mode 100644 index 9e4cd29d95..0000000000 --- a/reference/oauth/oauthprovider/timestampnoncehandler.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - OAuthProvider::timestampNonceHandler - Establece el callback timestampNonceHandler - - - - &reftitle.description; - - public voidOAuthProvider::timestampNonceHandler - callablecallback_function - - - Establece el manejador callback timestamp nonce, el cual será llamado luego con - OAuthProvider::callTimestampNonceHandler. Errores relacionados con - timestamp/nonce son lanzados a este callback. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - callback_function - - - El nombre de la función callable. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <methodname>OAuthProvider::timestampNonceHandler</methodname> - -nonce === 'bad') { - return OAUTH_BAD_NONCE; - } elseif ($provider->timestamp == '0') { - return OAUTH_BAD_TIMESTAMP; - } - - return OAUTH_OK; -} -?> -]]> - - - - - - &reftitle.seealso; - - OAuthProvider::callTimestampNonceHandler - - - - - diff --git a/reference/oauth/oauthprovider/tokenhandler.xml b/reference/oauth/oauthprovider/tokenhandler.xml deleted file mode 100644 index ed6c79a0da..0000000000 --- a/reference/oauth/oauthprovider/tokenhandler.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - OAuthProvider::tokenHandler - Establece el manejador callback de tokenHandler - - - - &reftitle.description; - - public voidOAuthProvider::tokenHandler - callablecallback_function - - - Establece el token del callback, que será llamado después con - OAuthProvider::callTokenHandler. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - callback_function - - - El nombre de la función callable. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo del callback <methodname>OAuthProvider::tokenHandler</methodname> - -token === 'rejected') { - return OAUTH_TOKEN_REJECTED; - } elseif ($provider->token === 'revoked') { - return OAUTH_TOKEN_REVOKED; - } - - $provider->token_secret = "the_tokens_secret"; - return OAUTH_OK; -} -?> -]]> - - - - - - &reftitle.seealso; - - OAuthProvider::callTokenHandler - - - - - diff --git a/reference/oauth/reference.xml b/reference/oauth/reference.xml deleted file mode 100644 index cf4c62e305..0000000000 --- a/reference/oauth/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - &Functions; de OAuth - - &reference.oauth.entities.functions; - - - - diff --git a/reference/oauth/setup.xml b/reference/oauth/setup.xml deleted file mode 100644 index 5085661abc..0000000000 --- a/reference/oauth/setup.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - PECL/oauth requiere PHP 5.1 o una versión más reciente, así como las extensiones - ext/hash y ext/pcre. - - - PECL/oauth puede también requerir la biblioteca libcurl - si fue seleccionada durante la compilación. En tal caso, PECL/oauth debe también ser compilado con - soporte HTTPS. - -
    - - - &reference.oauth.configure; - - -
    - diff --git a/reference/openal/book.xml b/reference/openal/book.xml deleted file mode 100644 index d06fb833a8..0000000000 --- a/reference/openal/book.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - Vinculaciones de audio del OpenAL - OpenAL - - - - &reftitle.intro; - - Vinculaciones de audio independientes de la plataforma. - Requiere la biblioteca OpenAL. - - - - - &reference.openal.setup; - &reference.openal.constants; - &reference.openal.reference; - - - diff --git a/reference/openal/configure.xml b/reference/openal/configure.xml deleted file mode 100644 index 37ba1a3702..0000000000 --- a/reference/openal/configure.xml +++ /dev/null @@ -1,36 +0,0 @@ - - - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;openal. - - - &pecl.windows.download; - -
    - diff --git a/reference/openal/constants.xml b/reference/openal/constants.xml deleted file mode 100644 index d96682884f..0000000000 --- a/reference/openal/constants.xml +++ /dev/null @@ -1,416 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - - - ALC_FREQUENCY - (int) - - - - Atributo de contexto - - - - - - ALC_REFRESH - (int) - - - - Atributo de contexto - - - - - - ALC_SYNC - (int) - - - - Atributo de contexto - - - - - - AL_FREQUENCY - (int) - - - - Configuración del buffer - - - - - - AL_BITS - (int) - - - - Configuración del buffer - - - - - - AL_CHANNELS - (int) - - - - Configuración del buffer - - - - - - AL_SIZE - (int) - - - - Configuración del buffer - - - - - - AL_BUFFER - (int) - - - - Configuración de la fuente/escucha (Entero) - - - - - - AL_SOURCE_RELATIVE - (int) - - - - Configuración de la fuente/escucha (Entero) - - - - - - AL_SOURCE_STATE - (int) - - - - Configuración de la fuente/escucha (Entero) - - - - - - AL_PITCH - (int) - - - - Configuración de la fuente/escucha (Número de punto flotante) - - - - - - AL_GAIN - (int) - - - - Configuración de la fuente/escucha (Número de punto flotante) - - - - - - AL_MIN_GAIN - (int) - - - - Configuración de la fuente/escucha (Número de punto flotante) - - - - - - AL_MAX_GAIN - (int) - - - - Configuración de la fuente/escucha (Número de punto flotante) - - - - - - AL_MAX_DISTANCE - (int) - - - - Configuración de la fuente/escucha (Número de punto flotante) - - - - - - AL_ROLLOFF_FACTOR - (int) - - - - Configuración de la fuente/escucha (Número de punto flotante) - - - - - - AL_CONE_OUTER_GAIN - (int) - - - - Configuración de la fuente/escucha (Número de punto flotante) - - - - - - AL_CONE_INNER_ANGLE - (int) - - - - Configuración de la fuente/escucha (Número de punto flotante) - - - - - - AL_CONE_OUTER_ANGLE - (int) - - - - Configuración de la fuente/escucha (Número de punto flotante) - - - - - - AL_REFERENCE_DISTANCE - (int) - - - - Configuración de la fuente/escucha (Número de punto flotante) - - - - - - AL_POSITION - (int) - - - - Configuración de la fuente/escucha (Número vectorial de punto flotante) - - - - - - AL_VELOCITY - (int) - - - - Configuración de la fuente/escucha (Número vectorial de punto flotante) - - - - - - AL_DIRECTION - (int) - - - - Configuración de la fuente/escucha (Número vectorial de punto flotante) - - - - - - AL_ORIENTATION - (int) - - - - Configuración de la fuente/escucha (Número vectorial de punto flotante) - - - - - - AL_FORMAT_MONO8 - (int) - - - - Formato PCM - - - - - - AL_FORMAT_MONO16 - (int) - - - - Formato PCM - - - - - - AL_FORMAT_STEREO8 - (int) - - - - Formato PCM - - - - - - AL_FORMAT_STEREO16 - (int) - - - - Formato PCM - - - - - - AL_INITIAL - (int) - - - - Estado de la Fuente - - - - - - AL_PLAYING - (int) - - - - Estado de la Fuente - - - - - - AL_PAUSED - (int) - - - - Estado de la Fuente - - - - - - AL_STOPPED - (int) - - - - Estado de la Fuente - - - - - - AL_LOOPING - (int) - - - - Estado de la Fuente - - - - - - AL_TRUE - (int) - - - - Valor booleano reconocido por OpenAL - - - - - - AL_FALSE - (int) - - - - Valor booleano reconocido por OpenAL - - - - - - diff --git a/reference/openal/functions/openal-buffer-create.xml b/reference/openal/functions/openal-buffer-create.xml deleted file mode 100644 index 23985cb941..0000000000 --- a/reference/openal/functions/openal-buffer-create.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - openal_buffer_create - Genera un buffer OpenAL - - - &reftitle.description; - - resourceopenal_buffer_create - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - openal_buffer_create devuelve un recurso - Open AL(Buffer) o &false; en caso de error. - - - - &reftitle.seealso; - - openal_buffer_loadwav - openal_buffer_data - - - - diff --git a/reference/openal/functions/openal-buffer-data.xml b/reference/openal/functions/openal-buffer-data.xml deleted file mode 100644 index 84d3ec1bd9..0000000000 --- a/reference/openal/functions/openal-buffer-data.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - openal_buffer_data - - Carga un buffer con datos - - - - &reftitle.description; - - boolopenal_buffer_data - resourcebuffer - intformat - stringdata - intfreq - - - - &reftitle.parameters; - - - buffer - - - Un recurso Open AL(Buffer) - (previamente creado por openal_buffer_create). - - - - - format - - - Formato de data, uno de: - AL_FORMAT_MONO8, - AL_FORMAT_MONO16, - AL_FORMAT_STEREO8&listendand; - AL_FORMAT_STEREO16 - - - - - data - - - Bloque de datos de audio binario en el format y el - freq especificado. - - - - - freq - - - Frecuencia de data dados en Hz. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_buffer_loadwav - openal_stream - - - - diff --git a/reference/openal/functions/openal-buffer-destroy.xml b/reference/openal/functions/openal-buffer-destroy.xml deleted file mode 100644 index b8e4248456..0000000000 --- a/reference/openal/functions/openal-buffer-destroy.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - openal_buffer_destroy - - Destruye un buffer OpenAL - - - - &reftitle.description; - - boolopenal_buffer_destroy - resourcebuffer - - - - &reftitle.parameters; - - - buffer - - - Un recurso Open AL(Buffer) - (previamente creado por openal_buffer_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_buffer_create - - - - diff --git a/reference/openal/functions/openal-buffer-get.xml b/reference/openal/functions/openal-buffer-get.xml deleted file mode 100644 index 0174a88228..0000000000 --- a/reference/openal/functions/openal-buffer-get.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - openal_buffer_get - Obtiene las propiedades del buffer OpenAL - - - - &reftitle.description; - - intfalseopenal_buffer_get - resourcebuffer - intproperty - - - - - &reftitle.parameters; - - - buffer - - - Un recurso Open AL(Buffer) - (creado previamente por openal_buffer_create). - - - - - property - - - Una propiedad específica, una de las siguientes: - AL_FREQUENCY, - AL_BITS, - AL_CHANNELS&listendand; - AL_SIZE. - - - - - - - - &reftitle.returnvalues; - - Devuelve un valor entero apropiado para la propiedad solicitada - property&return.falseforfailure;. - - - - - &reftitle.seealso; - - openal_buffer_create - - - - - diff --git a/reference/openal/functions/openal-buffer-loadwav.xml b/reference/openal/functions/openal-buffer-loadwav.xml deleted file mode 100644 index d87e8bd21b..0000000000 --- a/reference/openal/functions/openal-buffer-loadwav.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - openal_buffer_loadwav - - Carga un archivo .wav dentro de un buffer - - - - &reftitle.description; - - boolopenal_buffer_loadwav - resourcebuffer - stringwavfile - - - - &reftitle.parameters; - - - buffer - - - Un recurso Open AL(Buffer) - (previamente creado por openal_buffer_create). - - - - - wavfile - - - Ruta al archivo .wav en - el sistema de archivo local. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_buffer_data - openal_stream - - - - diff --git a/reference/openal/functions/openal-context-create.xml b/reference/openal/functions/openal-context-create.xml deleted file mode 100644 index 889ca9d725..0000000000 --- a/reference/openal/functions/openal-context-create.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - openal_context_create - - Crea un contexto de procesamiento de audio - - - - &reftitle.description; - - resourceopenal_context_create - resourcedevice - - - - &reftitle.parameters; - - - device - - - Un recurso Open AL(Device) - (previamente creado por openal_device_open). - - - - - - - &reftitle.returnvalues; - - Devuelve un recurso Open AL(Context) en éxito o - &false; en fallo. - - - - &reftitle.seealso; - - openal_device_open - openal_context_destroy - - - - diff --git a/reference/openal/functions/openal-context-current.xml b/reference/openal/functions/openal-context-current.xml deleted file mode 100644 index f90d032c10..0000000000 --- a/reference/openal/functions/openal-context-current.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - openal_context_current - - Crea el corriente contexto especificado - - - - &reftitle.description; - - boolopenal_context_current - resourcecontext - - - - &reftitle.parameters; - - - context - - - Un recurso Open AL(Context) - (previamente creado por openal_context_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_context_create - - - - diff --git a/reference/openal/functions/openal-context-destroy.xml b/reference/openal/functions/openal-context-destroy.xml deleted file mode 100644 index 69242fc1d6..0000000000 --- a/reference/openal/functions/openal-context-destroy.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - openal_context_destroy - - Destruye un contexto - - - - &reftitle.description; - - boolopenal_context_destroy - resourcecontext - - - - &reftitle.parameters; - - - context - - - Un recurso Open AL(Context) - (previamente creado por openal_context_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_context_create - - - - diff --git a/reference/openal/functions/openal-context-process.xml b/reference/openal/functions/openal-context-process.xml deleted file mode 100644 index e8247a48a7..0000000000 --- a/reference/openal/functions/openal-context-process.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - openal_context_process - - Procesa un contexto especificado - - - - &reftitle.description; - - boolopenal_context_process - resourcecontext - - - - &reftitle.parameters; - - - context - - - Un recurso Open AL(Context) - (previamente creado por openal_context_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_context_create - openal_context_current - openal_context_suspend - - - - diff --git a/reference/openal/functions/openal-context-suspend.xml b/reference/openal/functions/openal-context-suspend.xml deleted file mode 100644 index dc92e52110..0000000000 --- a/reference/openal/functions/openal-context-suspend.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - openal_context_suspend - - Suspende el contexto especificado - - - - &reftitle.description; - - boolopenal_context_suspend - resourcecontext - - - - &reftitle.parameters; - - - context - - - Un recurso Open AL(Context) - (previamente creado por openal_context_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_context_create - openal_context_current - openal_context_process - - - - diff --git a/reference/openal/functions/openal-device-close.xml b/reference/openal/functions/openal-device-close.xml deleted file mode 100644 index fdc4e3afbf..0000000000 --- a/reference/openal/functions/openal-device-close.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - openal_device_close - - Cierra un dispositivo OpenAL - - - - &reftitle.description; - - boolopenal_device_close - resourcedevice - - - - &reftitle.parameters; - - - device - - - Un recurso Open AL(Device) - (previamente creado por openal_device_open) - para ser cerrado. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_device_open - - - - diff --git a/reference/openal/functions/openal-device-open.xml b/reference/openal/functions/openal-device-open.xml deleted file mode 100644 index 1dff8948fd..0000000000 --- a/reference/openal/functions/openal-device-open.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - openal_device_open - - Inicia la capa de audio del OpenAL - - - - &reftitle.description; - - resourceopenal_device_open - stringdevice_desc - - - - &reftitle.parameters; - - - device_desc - - - Abre un dispositivo de audio especiado opcionalmente por device_desc. - Si device_desc no está especificado el primer dispositivo de - audio disponible será usado. - - - - - - - &reftitle.returnvalues; - - Devuelve un recurso Open AL(Device) en éxito o - &false; en fallo. - - - - &reftitle.seealso; - - openal_device_close - openal_context_create - - - - diff --git a/reference/openal/functions/openal-listener-get.xml b/reference/openal/functions/openal-listener-get.xml deleted file mode 100644 index 1fbba7430c..0000000000 --- a/reference/openal/functions/openal-listener-get.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - openal_listener_get - - Devuelve una propiedad de oyente - - - - &reftitle.description; - - mixedopenal_listener_get - intproperty - - - - &reftitle.parameters; - - - property - - - Propiedad para recuperar, una de: - AL_GAIN (float), - AL_POSITION (array(float,float,float)), - AL_VELOCITY (array(float,float,float))&listendand; - AL_ORIENTATION (array(float,float,float)). - - - - - - - &reftitle.returnvalues; - - Devuelve un flotante o un arreglo de flotantes (como apropiado)&return.falseforfailure;. - - - - &reftitle.seealso; - - openal_listener_set - - - - diff --git a/reference/openal/functions/openal-listener-set.xml b/reference/openal/functions/openal-listener-set.xml deleted file mode 100644 index 326bbf961b..0000000000 --- a/reference/openal/functions/openal-listener-set.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - openal_listener_set - - Establece una propiedad de oyente - - - - &reftitle.description; - - boolopenal_listener_set - intproperty - mixedsetting - - - - &reftitle.parameters; - - - property - - - Propiedad a establecer, una de: - AL_GAIN (float), - AL_POSITION (array(float,float,float)), - AL_VELOCITY (array(float,float,float))&listendand; - AL_ORIENTATION (array(float,float,float)). - - - - - setting - - - Valor a establecer, ya sea flotante, o un arreglo de flotantes como apropiado. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_listener_get - - - - diff --git a/reference/openal/functions/openal-source-create.xml b/reference/openal/functions/openal-source-create.xml deleted file mode 100644 index b10c9a877c..0000000000 --- a/reference/openal/functions/openal-source-create.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - openal_source_create - Genera un recurso de fuente - - - &reftitle.description; - - resourceopenal_source_create - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un recurso Open AL(Source) - o &false; en caso de error. - - - - &reftitle.seealso; - - openal_source_set - openal_source_play - openal_source_destroy - - - - diff --git a/reference/openal/functions/openal-source-destroy.xml b/reference/openal/functions/openal-source-destroy.xml deleted file mode 100644 index b5b369fcec..0000000000 --- a/reference/openal/functions/openal-source-destroy.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - openal_source_destroy - - Destruye una fuente de recursos - - - - &reftitle.description; - - boolopenal_source_destroy - resourcesource - - - - &reftitle.parameters; - - - source - - - Un recurso Open AL(Source) - (previamente creado por openal_source_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_source_create - - - - diff --git a/reference/openal/functions/openal-source-get.xml b/reference/openal/functions/openal-source-get.xml deleted file mode 100644 index 6c9dd22b92..0000000000 --- a/reference/openal/functions/openal-source-get.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - openal_source_get - - Recupera una propiedad de una fuente del OpenAL - - - - &reftitle.description; - - mixedopenal_source_get - resourcesource - intproperty - - - - &reftitle.parameters; - - - source - - - Un recurso Open AL(Source) - (previamente creado por openal_source_create). - - - - - property - - - Propiedad para obtener, una de: - AL_SOURCE_RELATIVE (int), - AL_SOURCE_STATE (int), - AL_PITCH (float), - AL_GAIN (float), - AL_MIN_GAIN (float), - AL_MAX_GAIN (float), - AL_MAX_DISTANCE (float), - AL_ROLLOFF_FACTOR (float), - AL_CONE_OUTER_GAIN (float), - AL_CONE_INNER_ANGLE (float), - AL_CONE_OUTER_ANGLE (float), - AL_REFERENCE_DISTANCE (float), - AL_POSITION (array(float,float,float)), - AL_VELOCITY (array(float,float,float)), - AL_DIRECTION (array(float,float,float)). - - - - - - - &reftitle.returnvalues; - - Devuelve el tipo asociado con la propiedad que se recupera - &return.falseforfailure;. - - - - &reftitle.seealso; - - openal_source_create - openal_source_set - openal_source_play - - - - diff --git a/reference/openal/functions/openal-source-pause.xml b/reference/openal/functions/openal-source-pause.xml deleted file mode 100644 index cff66ba932..0000000000 --- a/reference/openal/functions/openal-source-pause.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - openal_source_pause - - Pausa la fuente - - - - &reftitle.description; - - boolopenal_source_pause - resourcesource - - - - &reftitle.parameters; - - - source - - - Un recurso Open AL(Source) - (previamente creado por openal_source_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_source_stop - openal_source_play - openal_source_rewind - - - - diff --git a/reference/openal/functions/openal-source-play.xml b/reference/openal/functions/openal-source-play.xml deleted file mode 100644 index 9a256800f3..0000000000 --- a/reference/openal/functions/openal-source-play.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - openal_source_play - - Empieza la reproducción de la fuente - - - - &reftitle.description; - - boolopenal_source_play - resourcesource - - - - &reftitle.parameters; - - - source - - - Un recurso Open AL(Source) - (previamente creado por openal_source_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_source_stop - openal_source_pause - openal_source_rewind - - - - diff --git a/reference/openal/functions/openal-source-rewind.xml b/reference/openal/functions/openal-source-rewind.xml deleted file mode 100644 index 0d82147610..0000000000 --- a/reference/openal/functions/openal-source-rewind.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - openal_source_rewind - - Rebobina la fuente - - - - &reftitle.description; - - boolopenal_source_rewind - resourcesource - - - - &reftitle.parameters; - - - source - - - Un recurso Open AL(Source) - (previamente creado por openal_source_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_source_stop - openal_source_pause - openal_source_play - - - - diff --git a/reference/openal/functions/openal-source-set.xml b/reference/openal/functions/openal-source-set.xml deleted file mode 100644 index 361086c7a5..0000000000 --- a/reference/openal/functions/openal-source-set.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - openal_source_set - - Establece la propiedad de la fuente - - - - &reftitle.description; - - boolopenal_source_set - resourcesource - intproperty - mixedsetting - - - - &reftitle.parameters; - - - source - - - Un recurso Open AL(Source) - (previamente creado por openal_source_create). - - - - - property - - - Propiedad para establecer, una de: - AL_BUFFER (OpenAL(Source)), - AL_LOOPING (bool), - AL_SOURCE_RELATIVE (int), - AL_SOURCE_STATE (int), - AL_PITCH (float), - AL_GAIN (float), - AL_MIN_GAIN (float), - AL_MAX_GAIN (float), - AL_MAX_DISTANCE (float), - AL_ROLLOFF_FACTOR (float), - AL_CONE_OUTER_GAIN (float), - AL_CONE_INNER_ANGLE (float), - AL_CONE_OUTER_ANGLE (float), - AL_REFERENCE_DISTANCE (float), - AL_POSITION (array(float,float,float)), - AL_VELOCITY (array(float,float,float)), - AL_DIRECTION (array(float,float,float)). - - - - - setting - - - El valor para asignar a la property especifica. - Consulta la descripción de la property - para una descripción de el valor(es) esperando. - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_source_create - openal_source_get - openal_source_play - - - - diff --git a/reference/openal/functions/openal-source-stop.xml b/reference/openal/functions/openal-source-stop.xml deleted file mode 100644 index 7fac7afb12..0000000000 --- a/reference/openal/functions/openal-source-stop.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - openal_source_stop - - Detiene la reproducción de la fuente - - - - &reftitle.description; - - boolopenal_source_stop - resourcesource - - - - &reftitle.parameters; - - - source - - - Un recurso Open AL(Source) - (previamente creado por openal_source_create). - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - openal_source_play - openal_source_pause - openal_source_rewind - - - - diff --git a/reference/openal/functions/openal-stream.xml b/reference/openal/functions/openal-stream.xml deleted file mode 100644 index 33ec935e41..0000000000 --- a/reference/openal/functions/openal-stream.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - openal_stream - Inicia el streaming de una fuente - - - &reftitle.description; - - resourcefalseopenal_stream - resourcesource - intformat - intrate - - - - &reftitle.parameters; - - - source - - - Un recurso Open AL(Source) - (previamente creado por openal_source_create). - - - - - format - - - El formato del argumento data, uno de los siguientes: - AL_FORMAT_MONO8, - AL_FORMAT_MONO16, - AL_FORMAT_STEREO8&listendand; - AL_FORMAT_STEREO16. - - - - - rate - - - La frecuencia de los datos a streamear, en Hz. - - - - - - - &reftitle.returnvalues; - - Devuelve un recurso de streaming&return.falseforfailure;. - - - - &reftitle.seealso; - - openal_source_create - fwrite - - - - diff --git a/reference/openal/reference.xml b/reference/openal/reference.xml deleted file mode 100644 index b4b15fbbfc..0000000000 --- a/reference/openal/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - &Functions; de OpenAL - - &reference.openal.entities.functions; - - - - diff --git a/reference/openal/resources.xml b/reference/openal/resources.xml deleted file mode 100644 index 18ffb947db..0000000000 --- a/reference/openal/resources.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - -
    - &reftitle.resources; - - - Esta extensión define cuatro tipos de recursos: - Open AL(Device) - Devuelto por openal_device_open, - Open AL(Context) - Devuelto por openal_context_create, - Open AL(Buffer) - Devuelto por openal_buffer_create, - y Open AL(Source) - Devuelto por openal_source_create. - - -
    - diff --git a/reference/openal/setup.xml b/reference/openal/setup.xml deleted file mode 100644 index ceb33636f6..0000000000 --- a/reference/openal/setup.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - - - - - &reftitle.setup; - - - &reference.openal.configure; - - - - &reference.openal.resources; - - - - - - diff --git a/reference/parallel/book.xml b/reference/parallel/book.xml deleted file mode 100644 index 5889c00e6d..0000000000 --- a/reference/parallel/book.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - parallel - parallel - - - &reftitle.intro; - - parallel es una extensión de concurrencia paralela para PHP ≥ 7.2.0. - A partir de parallel 1.2.0, PHP ≥ 8.0.0 es requerido. - - - A continuación se presenta una breve descripción de los conceptos básicos de parallel, se puede encontrar información más detallada en esta sección del manual. - - - Ejecución - - Un parallel\Runtime representa un hilo de intérprete PHP. Un parallel\Runtime se configura con un fichero de arranque opcional pasado a parallel\Runtime::__construct, generalmente un cargador automático, - o alguna otra rutina de precarga: el fichero de arranque será incluido antes de la ejecución de cualquier tarea. - - - Después de la construcción, el parallel\Runtime permanece disponible hasta que se cierre, se mate, o se destruya por las reglas de ámbito normales de los objetos PHP. - parallel\Runtime::run permite al desarrollador programar tareas para una ejecución paralela. - Un parallel\Runtime tiene un orden de programación FIFO, las tareas se ejecutarán en el orden en que se programen. - - - - API Funcional - - Parallel implementa una API funcional, de alto nivel sobre parallel\Runtime que proporciona un único punto de entrada para ejecutar código paralelo - con una programación automática: parallel\run. - - - - Tareas - - Una tarea (Task) es simplemente una Closure destinada a una ejecución paralela. La Closure puede contener casi cualquier instrucción, incluyendo cierres anidados. - Sin embargo, algunas instrucciones están prohibidas en las tareas: - - - yield - - - use by-reference - - - declare class - - - declare named function - - - - - - Los cierres anidados pueden usar yield o use by-reference, pero no deben contener declaraciones de clase o funciones nombradas. - - - - - Ninguna instrucción está prohibida en los ficheros que la tarea puede incluir. - - - - - Future - - El parallel\Future se utiliza para acceder al valor de retorno de la tarea, y expone una API para la cancelación de la tarea. - - - - Canales - - Una tarea puede ser programada con argumentos, usar variables de ámbito léxico (por valor), y devolver un valor (a través de un parallel\Future), pero estos solo permiten la comunicación unidireccional: - Permiten al desarrollador enviar datos a una tarea y recuperar datos de una tarea, pero no permiten la comunicación bidireccional entre las tareas. La API parallel\Channel permite la comunicación bidireccional entre las tareas, un parallel\Channel es un enlace de tipo socket entre las tareas que el desarrollador puede usar para enviar y recibir datos. - - - - Eventos - - La API parallel\Events implementa un bucle de eventos (Traversable) nativo, y el método parallel\Events::poll. - Esto permite al desarrollador trabajar con conjuntos de canales y/o futuros. - El desarrollador simplemente añade canales y futuros al bucle de eventos, definiendo opcionalmente la entrada para las escrituras con parallel\Events::setInput, - y entra en un bucle foreach: parallel leerá y escribirá en los objetos a medida que se vuelvan disponibles, devolviendo objetos parallel\Events\Event - describiendo las operaciones que han ocurrido. - - - - &reftitle.seealso; - - - - - - - &reference.parallel.setup; - &reference.parallel.philosophy; - &reference.parallel.functional; - &reference.parallel.parallel.runtime; - &reference.parallel.parallel.future; - &reference.parallel.parallel.channel; - &reference.parallel.parallel.events; - &reference.parallel.parallel.events.input; - &reference.parallel.parallel.events.event; - &reference.parallel.parallel.events.event.type; - - &reference.parallel.parallel.sync; - - - - diff --git a/reference/parallel/configure.xml b/reference/parallel/configure.xml deleted file mode 100644 index b23bf01296..0000000000 --- a/reference/parallel/configure.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - -
    - &reftitle.install; - - - Utilice la opción - durante la compilación de PHP. - - - - Los usuarios de Windows deben incluir el fichero - php_parallel.dll en &php.ini; - - -
    - diff --git a/reference/parallel/functional.xml b/reference/parallel/functional.xml deleted file mode 100644 index e2243c836e..0000000000 --- a/reference/parallel/functional.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - API Funcional - - - La API parallel\Runtime proporciona un alto grado de control al desarrollador PHP experimentado, y a aquellos que están íntimamente familiarizados con la escritura de aplicaciones que utilizan - la concurrencia paralela. - - - La API funcional proporciona menos control a cambio de la capacidad de tomar decisiones para el desarrollador: - - - todos los runtimes en ejecución se inician de manera idéntica - - - la programación es determinada por la API, y no por el desarrollador - - - parallel\run proporciona la garantía de que la tarea comenzará a ejecutarse en paralelo tan pronto como las restricciones de hardware y del sistema operativo lo permitan, sin - crear innecesariamente espacios de ejecución. Para la mayoría de las aplicaciones, la API funcional debería ser preferida. - - - - &reference.parallel.functions.parallel.bootstrap; - &reference.parallel.functions.parallel.run; - - diff --git a/reference/parallel/functions/parallel.bootstrap.xml b/reference/parallel/functions/parallel.bootstrap.xml deleted file mode 100644 index eefa9ed89b..0000000000 --- a/reference/parallel/functions/parallel.bootstrap.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - parallel\bootstrap - Inicialización - - - - &reftitle.description; - - voidparallel\bootstrap - stringfile - - - Utiliza el file proporcionado para inicializar todas las ejecuciones creadas para la planificación automática a través de parallel\run. - - - - - &reftitle.parameters; - - - file - - - La ruta del fichero para inicializar todas las ejecuciones. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - - Lanza una excepción parallel\Runtime\Error\Bootstrap si ya ha sido llamado para este proceso. - - - - - Lanza una excepción parallel\Runtime\Error\Bootstrap si es llamado después de parallel\run. - - - - - - &reftitle.seealso; - - - - - - - diff --git a/reference/parallel/functions/parallel.run.xml b/reference/parallel/functions/parallel.run.xml deleted file mode 100644 index 9085dc2ceb..0000000000 --- a/reference/parallel/functions/parallel.run.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - parallel\run - Ejecución - - - - &reftitle.description; - - Futurenullparallel\run - Closuretask - - - Programa task para ejecución en paralelo. - - - Futurenullparallel\run - Closuretask - arrayargv - - - Programa task para ejecución en paralelo, pasando argv a la ejecución. - - - - - Planificación automática - - Si un \parallel\Runtime creado y almacenado en caché por una llamada previa a parallel\run está inactivo, - se utilizará para ejecutar la tarea. Si ningún \parallel\Runtime está inactivo, parallel creará y almacenará en caché un - \parallel\Runtime. - - - - Los objetos \parallel\Runtime creados por el desarrollador no se utilizan para la planificación automática. - - - - - - - - - - - - - &reftitle.seealso; - - - - - - - diff --git a/reference/parallel/parallel.channel.xml b/reference/parallel/parallel.channel.xml deleted file mode 100644 index 4301cab2e4..0000000000 --- a/reference/parallel/parallel.channel.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - La clase parallel\Channel - parallel\Channel - - -
    - canales no tamponados - - Un canal no tamponado bloqueará las llamadas a parallel\Channel::send hasta que haya un receptor, y bloqueará las llamadas a - parallel\Channel::recv hasta que haya un emisor. Esto significa que un canal no tamponado no es solo un medio para compartir datos entre las tareas - sino también un método simple de sincronización. - - - Un canal no tamponado es la forma más rápida de compartir datos entre las tareas, requiriendo la menor cantidad de copias. - -
    - -
    - canales tamponados - - Un canal tamponado no bloqueará las llamadas a parallel\Channel::send hasta que se alcance la capacidad, las llamadas a - parallel\Channel::recv bloquearán hasta que haya datos en el búfer. - -
    - -
    - Cierres en los canales - - Una funcionalidad poderosa de los canales paralelos es que permiten el intercambio de cierres entre las tareas (y los entornos de ejecución). - - - Cuando un cierre es enviado a través de un canal, el cierre es tamponado, esto no cambia el búfer del canal que transmite el cierre, - pero afecta el ámbito estático dentro del cierre: el mismo cierre enviado a diferentes ejecuciones, o a la misma ejecución, - no compartirá su ámbito estático. - - - Esto significa que cada vez que un cierre es ejecutado y ha sido transmitido por un canal, el estado estático será el mismo que cuando el cierre fue tamponado. - -
    - -
    - canales anónimos - - La construcción de canales anónimos permite al desarrollador evitar asignar nombres a cada canal: parallel generará un nombre único para los canales anónimos. - -
    - -
    - &reftitle.classsynopsis; - - - - parallel\Channel - - - - - final - parallel\Channel - - - - - Constructores anónimos - - - - - Acceso - - - - - Compartir - - - - - Cerrar - - - - - Constantes para el tamponamiento infinito - - const - Infinite - - - - - -
    - -
    - - &reference.parallel.parallel.channel.construct; - &reference.parallel.parallel.channel.make; - &reference.parallel.parallel.channel.open; - &reference.parallel.parallel.channel.recv; - &reference.parallel.parallel.channel.send; - &reference.parallel.parallel.channel.close; - -
    - diff --git a/reference/parallel/parallel.events.event.type.xml b/reference/parallel/parallel.events.event.type.xml deleted file mode 100644 index b2dd465a58..0000000000 --- a/reference/parallel/parallel.events.event.type.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - - La clase parallel\Events\Event\Type - parallel\Events\Event\Type - - - -
    - &reftitle.classsynopsis; - - - - parallel\Events\Event\Type - - - - - final - parallel\Events\Event\Type - - - - - Event::$object fue leído en Event::$value - - const - Read - - - Entrada para Event::$source escrita en Event::$object - - const - Write - - - Event::$object (Channel) fue cerrado - - const - Close - - - Event::$object (Future) fue cancelado - - const - Cancel - - - El entorno de ejecución de Event::$object (Future) fue terminado - - const - Kill - - - Event::$object (Future) generó un error - - const - Error - - - - - -
    - -
    - -
    - - diff --git a/reference/parallel/parallel.events.event.xml b/reference/parallel/parallel.events.event.xml deleted file mode 100644 index 81edb824fb..0000000000 --- a/reference/parallel/parallel.events.event.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - La clase parallel\Events\Event - parallel\Events\Event - - - -
    - Objeto de evento - - Cuando un evento es devuelto, Event::$object debe ser retirado del bucle que lo devolvió. Si el evento es un evento de escritura, el Input para Event::$source también debe ser retirado. - -
    -
    - &reftitle.classsynopsis; - - - - parallel\Events\Event - - - - - final - parallel\Events\Event - - - - - Debe ser una de las constantes Event\Type - - public - int - type - - - Debe ser la fuente del evento (nombre del objetivo) - - public - string - source - - - Debe ser un Future o un Channel - - public - object - object - - - Debe definir los eventos de lectura/Error - - public - value - - - - - -
    - -
    - -
    - diff --git a/reference/parallel/parallel.events.input.xml b/reference/parallel/parallel.events.input.xml deleted file mode 100644 index d8c6d8a92d..0000000000 --- a/reference/parallel/parallel.events.input.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - La clase parallel\Events\Input - parallel\Events\Input - - - -
    - Eventos de entrada - - Un objeto de entrada es un contenedor para los datos que el objeto parallel\Events escribirá en - los objetos parallel\Channel a medida que se vayan haciendo disponibles. Varios bucles de eventos pueden compartir un contenedor de entrada - parallel no verifica - el contenido del contenedor cuando se establece como entrada para un objeto parallel\Events. - - - - Cuando un objeto parallel\Events realiza una escritura, el objetivo se retira del objeto de entrada como si - parallel\Events\Input::remove fuera llamado. - - -
    - -
    - &reftitle.classsynopsis; - - - - parallel\Events\Input - - - - - final - parallel\Events\Input - - - - - - - - - - - - - - - - - -
    - -
    - -&reference.parallel.parallel.entities.input; - -
    - diff --git a/reference/parallel/parallel.events.xml b/reference/parallel/parallel.events.xml deleted file mode 100644 index f5f1e1557a..0000000000 --- a/reference/parallel/parallel.events.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - La clase parallel\Events - parallel\Events - - -
    - El bucle de eventos - - El bucle de eventos supervisa el estado de los conjuntos de futuros y/o canales (objetivos) para realizar operaciones de lectura (parallel\Future::value, parallel\Channel::recv) y escritura (parallel\Channel::send) cuando los objetivos se vuelven disponibles y las operaciones pueden ser realizadas sin bloquear el bucle de eventos. - -
    -
    - &reftitle.classsynopsis; - - - - parallel\Events - - - - - final - parallel\Events - - - Countable - - - Traversable - - - - - Entrada - - - - - Objetivos - - - - - Comportamiento - - - - - Sondeo - - - - - - -
    - -
    - - &reference.parallel.parallel.events.setblocking; - &reference.parallel.parallel.events.settimeout; - &reference.parallel.parallel.events.setinput; - &reference.parallel.parallel.events.addchannel; - &reference.parallel.parallel.events.addfuture; - &reference.parallel.parallel.events.remove; - &reference.parallel.parallel.events.poll; - -
    - diff --git a/reference/parallel/parallel.future.xml b/reference/parallel/parallel.future.xml deleted file mode 100644 index 7543b0de8b..0000000000 --- a/reference/parallel/parallel.future.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - La clase parallel\Future - parallel\Future - - - -
    - Futures - - Un Future representa el valor de retorno o la excepción no capturada de una tarea, y expone una API para la cancelación. - - - Ejemplo mostrando Future como valor de retorno - -run(function(){ - return "World"; -}); -printf("Hello %s\n", $future->value()); -?> -]]> - - &example.outputs.similar; - - - - - - El comportamiento de un Future permite también su uso como un simple punto de sincronización incluso si la tarea no devuelve explícitamente un valor. - - - Ejemplo mostrando Future como punto de sincronización - -run(function(){ - echo "in child "; - for ($i = 0; $i < 500; $i++) { - if ($i % 10 == 0) { - echo "."; - } - } - echo " leaving child"; -}); - -$future->value(); -echo "\nparent continues\n"; -?> -]]> - - &example.outputs.similar; - - - - -
    - -
    - &reftitle.classsynopsis; - - - - parallel\Future - - - - - final - parallel\Future - - - - - Resolución - - - - - Estados - - - - - Cancelación - - - - - - - -
    - -
    - - &reference.parallel.parallel.entities.future; - -
    - diff --git a/reference/parallel/parallel.runtime.xml b/reference/parallel/parallel.runtime.xml deleted file mode 100644 index df543a0daa..0000000000 --- a/reference/parallel/parallel.runtime.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - La clase parallel\Runtime - parallel\Runtime - - - -
    - Objetos de ejecución - - Cada ejecución representa un solo thread PHP, el thread es creado (e inicializado) durante la construcción. - El thread espera luego a que se programen tareas: las tareas programadas serán ejecutadas FIFO y luego el thread volverá - a esperar hasta que se programen otras tareas, o hasta que sea cerrado, eliminado o destruido por las reglas de ámbito normales de los objetos PHP. - - - - Cuando una ejecución es destruida por las reglas de ámbito normales de los objetos PHP, primero ejecutará todas las tareas que han sido programadas, - y bloqueará durante este tiempo. - - -
    - -
    - Amortiguación de ejecución - - Cuando se crea una nueva ejecución, no comparte código con el thread (o el proceso) que la creó. Esto significa que no tiene las mismas - clases y funciones cargadas, ni el mismo cargador automático definido. En algunos casos, una ejecución muy ligera es deseable porque las tareas que - serán programadas no necesitan acceder al código del thread padre. En los casos en que las tareas necesitan acceder al mismo código, basta con definir - un cargador automático como amortiguación. - - - - La precarga puede ser utilizada en conjunción con parallel, en este caso el código precargado está disponible sin amortiguación. - - -
    - -
    - &reftitle.classsynopsis; - - - - parallel\Runtime - - - - - final - parallel\Runtime - - - - - Crear - - - - - Ejecutar - - - - - Unir - - - - - - -
    - -
    - - &reference.parallel.parallel.runtime.construct; - &reference.parallel.parallel.runtime.run; - &reference.parallel.parallel.runtime.close; - &reference.parallel.parallel.runtime.kill; - -
    - diff --git a/reference/parallel/parallel.sync.xml b/reference/parallel/parallel.sync.xml deleted file mode 100644 index 8937339cf0..0000000000 --- a/reference/parallel/parallel.sync.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - La clase parallel\Sync - parallel\Sync - - -
    - Sincronización de bajo nivel - - La clase parallel\Sync proporciona acceso a las primitivas de sincronización de bajo nivel, mutex, variables de condición y permite la implementación de semáforos. - - - - La sincronización para la mayoría de las aplicaciones se implementa mucho mejor utilizando canales, sin embargo, en algunos casos los autores de código de bajo nivel pueden encontrar útil poder acceder a estos mecanismos de nivel más bajo. - - -
    - -
    - &reftitle.classsynopsis; - - - - parallel\Sync - - - - - final - parallel\Sync - - - - - Constructor - - - - - Acceso - - - - - Sincronización - - - - - - - -
    - -
    - - &reference.parallel.parallel.sync.construct; - &reference.parallel.parallel.sync.get; - &reference.parallel.parallel.sync.set; - &reference.parallel.parallel.sync.wait; - &reference.parallel.parallel.sync.notify; - &reference.parallel.parallel.sync.invoke; - -
    - diff --git a/reference/parallel/parallel/channel/close.xml b/reference/parallel/parallel/channel/close.xml deleted file mode 100644 index aa87e1ae9b..0000000000 --- a/reference/parallel/parallel/channel/close.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - parallel\Channel::close - Cierra - - - - &reftitle.description; - - public voidparallel\Channel::close - - - - Cierra este canal. - - - - - - Excepciones - - - Lanza una parallel\Channel\Error\Closed si el canal está cerrado. - - - - - - diff --git a/reference/parallel/parallel/channel/construct.xml b/reference/parallel/parallel/channel/construct.xml deleted file mode 100644 index 3cf3d5235e..0000000000 --- a/reference/parallel/parallel/channel/construct.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - parallel\Channel::__construct - Construcción de canal - - - - &reftitle.description; - - public parallel\Channel::__construct - - - - Crear un canal anónimo no tamponado. - - - public parallel\Channel::__construct - intcapacity - - - Crear un canal anónimo tamponado con la capacidad dada. - - - - - - &reftitle.parameters; - - - capacity - - - Puede ser Channel::Infinite o un integer positivo - - - - - - - - diff --git a/reference/parallel/parallel/channel/make.xml b/reference/parallel/parallel/channel/make.xml deleted file mode 100644 index 9bc4fb68fe..0000000000 --- a/reference/parallel/parallel/channel/make.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - parallel\Channel::make - Acceso - - - - &reftitle.description; - - public Channelparallel\Channel::make - stringname - - - Crear un canal no tamponado con el nombre dado. - - - public Channelparallel\Channel::make - stringname - intcapacity - - - Crear un canal tamponado con el nombre y la capacidad dados. - - - - - - &reftitle.parameters; - - - name - - - El nombre del canal. - - - - - capacity - - - Puede ser Channel::Infinite o un entero positivo. - - - - - - - - Excepciones - - - Lanza una parallel\Channel\Error\Existence si el canal ya existe. - - - - - - diff --git a/reference/parallel/parallel/channel/open.xml b/reference/parallel/parallel/channel/open.xml deleted file mode 100644 index 02bf533318..0000000000 --- a/reference/parallel/parallel/channel/open.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - parallel\Channel::open - Acceso - - - - &reftitle.description; - - public Channelparallel\Channel::open - stringname - - - Abre el canal con el nombre dado. - - - - - - Excepciones - - - Lanza una parallel\Channel\Error\Existence si el canal no existe. - - - - - - diff --git a/reference/parallel/parallel/channel/recv.xml b/reference/parallel/parallel/channel/recv.xml deleted file mode 100644 index 22873978c7..0000000000 --- a/reference/parallel/parallel/channel/recv.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - parallel\Channel::recv - Compartir - - - - &reftitle.description; - - public mixedparallel\Channel::recv - - - - Recibe un valor de este canal. - - - - - - Excepciones - - - Lanza una parallel\Channel\Error\Closed si el canal está cerrado. - - - - - - diff --git a/reference/parallel/parallel/channel/send.xml b/reference/parallel/parallel/channel/send.xml deleted file mode 100644 index 85c857c474..0000000000 --- a/reference/parallel/parallel/channel/send.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - parallel\Channel::send - Compartir - - - - &reftitle.description; - - public voidparallel\Channel::send - mixedvalue - - - Envía el valor dado sobre este canal. - - - - - - Excepciones - - - Lanza una parallel\Channel\Error\Closed si el canal está cerrado. - - - - - Lanza una parallel\Channel\Error\IllegalValue si el valor es ilegal. - - - - - - diff --git a/reference/parallel/parallel/events/addchannel.xml b/reference/parallel/parallel/events/addchannel.xml deleted file mode 100644 index c88ba3037f..0000000000 --- a/reference/parallel/parallel/events/addchannel.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - parallel\Events::addChannel - Objetivo - - - - &reftitle.description; - - public voidparallel\Events::addChannel - parallel\Channelchannel - - - Observa los eventos en el channel dado. - - - - - Excepciones - - - Lanza una parallel\Events\Error\Existence si el canal ya ha sido añadido. - - - - - - diff --git a/reference/parallel/parallel/events/addfuture.xml b/reference/parallel/parallel/events/addfuture.xml deleted file mode 100644 index ed6193a9f5..0000000000 --- a/reference/parallel/parallel/events/addfuture.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - parallel\Events::addFuture - Objetivo - - - - &reftitle.description; - - public voidparallel\Events::addFuture - stringname - parallel\Futurefuture - - - Observa los eventos en el future dado. - - - - - Excepciones - - - Lanza una parallel\Events\Error\Existence si el objetivo con el nombre dado ya ha sido añadido. - - - - - - diff --git a/reference/parallel/parallel/events/poll.xml b/reference/parallel/parallel/events/poll.xml deleted file mode 100644 index b5939dc642..0000000000 --- a/reference/parallel/parallel/events/poll.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - parallel\Events::poll - Interroga - - - - &reftitle.description; - - public parallel\Events\Eventnullparallel\Events::poll - - - - Interroga para el próximo evento. - - - - - &reftitle.returnvalues; - - Si no quedan más objetivos, &null; será devuelto. - - - Esto es un bucle no bloqueante, y si se produce un bloqueo, &null; será devuelto. - - - De lo contrario, el parallel\Events\Event devuelto describe el evento. - - - - - Excepciones - - - Lanza una parallel\Events\Error\Existence si se supera el tiempo de espera. - - - - - - diff --git a/reference/parallel/parallel/events/remove.xml b/reference/parallel/parallel/events/remove.xml deleted file mode 100644 index 0b023b9196..0000000000 --- a/reference/parallel/parallel/events/remove.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - parallel\Events::remove - Objetivo - - - - &reftitle.description; - - public voidparallel\Events::remove - stringtarget - - - Elimina el target dado. - - - - - Excepciones - - - Lanza una parallel\Events\Error\Existence si el objetivo con el nombre dado no ha sido encontrado. - - - - - - diff --git a/reference/parallel/parallel/events/setblocking.xml b/reference/parallel/parallel/events/setblocking.xml deleted file mode 100644 index 998f1eba6a..0000000000 --- a/reference/parallel/parallel/events/setblocking.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - parallel\Events::setBlocking - Comportamiento - - - - &reftitle.description; - - Por omisión, cuando un evento es interrogado, se produce un bloqueo (a nivel de PHP) hasta que el primer evento pueda ser devuelto: Definir el modo de bloqueo a &false; hará que la interrogación devuelva el control si la primera cible interrogada no está lista. - - - Esto difiere de definir un tiempo límite de 0 con parallel\Events::setTimeout, ya que un tiempo límite de 0, aunque permitido, provocará que se lance una excepción, lo cual puede ser extremadamente lento o derrochador si lo que realmente se desea es un comportamiento no bloqueante. - - - Un bucle no bloqueante afecta el valor de retorno de parallel\Events::poll, de modo que puede ser &null; antes de que todos los eventos hayan sido procesados. - - - public voidparallel\Events::setBlocking - boolblocking - - - Define el modo de bloqueo. - - - - - Excepciones - - - Lanza una parallel\Events\Error si el bucle tiene un tiempo límite definido. - - - - - - diff --git a/reference/parallel/parallel/events/setinput.xml b/reference/parallel/parallel/events/setinput.xml deleted file mode 100644 index 0ca86fd3da..0000000000 --- a/reference/parallel/parallel/events/setinput.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - parallel\Events::setInput - Entrada - - - - &reftitle.description; - - public voidparallel\Events::setInput - Inputinput - - - Define el input para este bucle de eventos - - - - - diff --git a/reference/parallel/parallel/events/settimeout.xml b/reference/parallel/parallel/events/settimeout.xml deleted file mode 100644 index 307325b78b..0000000000 --- a/reference/parallel/parallel/events/settimeout.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - parallel\Events::setTimeout - Comportamiento - - - - &reftitle.description; - - Por omisión, cuando los eventos son interrogados, se produce un bloqueo (a nivel de PHP) hasta que el primer evento pueda ser devuelto: Definir el tiempo de espera provoca el lanzamiento de una excepción cuando el tiempo de espera es alcanzado. - - - Esto difiere de definir el modo de bloqueo a &false; con parallel\Events::setBlocking, que no provocará el lanzamiento de una excepción. - - - public voidparallel\Events::setTimeout - inttimeout - - - Define el tiempo de espera en microsegundos. - - - - - Excepciones - - - Lanza una parallel\Events\Error si el bucle es no bloqueante. - - - - - - diff --git a/reference/parallel/parallel/future/cancel.xml b/reference/parallel/parallel/future/cancel.xml deleted file mode 100644 index 10407da1dc..0000000000 --- a/reference/parallel/parallel/future/cancel.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - parallel\Future::cancel - Cancelación - - - - &reftitle.description; - - public boolparallel\Future::cancel - - - - Intenta cancelar la tarea. - - - - Si la tarea está en ejecución, será interrumpida. - - - - - Las llamadas de funciones internas en curso no pueden ser interrumpidas. - - - - - - Excepciones - - - Lanza una parallel\Future\Error\Killed si la tarea ejecutada por parallel\Runtime ha sido interrumpida. - - - - - Lanza una parallel\Future\Error\Cancelled si la tarea ya ha sido cancelada. - - - - - - diff --git a/reference/parallel/parallel/future/cancelled.xml b/reference/parallel/parallel/future/cancelled.xml deleted file mode 100644 index b75f423912..0000000000 --- a/reference/parallel/parallel/future/cancelled.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - parallel\Future::cancelled - Detección de estado - - - - &reftitle.description; - - public boolparallel\Future::cancelled - - - - Indica si la tarea ha sido cancelada. - - - - - - diff --git a/reference/parallel/parallel/future/done.xml b/reference/parallel/parallel/future/done.xml deleted file mode 100644 index 85fa001ad1..0000000000 --- a/reference/parallel/parallel/future/done.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - parallel\Future::done - Detección de estado - - - - &reftitle.description; - - public boolparallel\Future::done - - - - Indica si la tarea está terminada. - - - - - - diff --git a/reference/parallel/parallel/future/value.xml b/reference/parallel/parallel/future/value.xml deleted file mode 100644 index 7d7bba064f..0000000000 --- a/reference/parallel/parallel/future/value.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - parallel\Future::value - Resolución - - - - &reftitle.description; - - public mixedparallel\Future::value - - - - Devuelve (y espera si es necesario) el retorno de la tarea. - - - - - Excepciones - - - Lanza una parallel\Future\Error si la espera ha fallado (error interno). - - - - - Lanza una parallel\Future\Error\Killed si la tarea ejecutada por parallel\Runtime ha sido interrumpida. - - - - - Lanza una parallel\Future\Error\Cancelled si la tarea ha sido cancelada. - - - - - Lanza una parallel\Future\Error\Foreign si la tarea ha levantado una excepción no reconocida. - - - - - Vuelve a lanzar una Throwable no capturada en la tarea. - - - - - - diff --git a/reference/parallel/parallel/input/add.xml b/reference/parallel/parallel/input/add.xml deleted file mode 100644 index c183f14037..0000000000 --- a/reference/parallel/parallel/input/add.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - parallel\Events\Input::add - Entradas - - - - &reftitle.description; - - public voidparallel\Events\Input::add - stringtarget - mixedvalue - - - Define una entrada para el objetivo dado. - - - - - Excepciones - - - Lanza una parallel\Events\Input\Error\Existence si la entrada para el objetivo ya existe. - - - - - Lanza una parallel\Events\Input\Error\IllegalValue si el valor es ilegal (&object;, &null;). - - - - - - diff --git a/reference/parallel/parallel/input/clear.xml b/reference/parallel/parallel/input/clear.xml deleted file mode 100644 index 06993c0e49..0000000000 --- a/reference/parallel/parallel/input/clear.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - parallel\Events\Input::clear - Entradas - - - - &reftitle.description; - - public voidparallel\Events\Input::clear - - - - Elimina la entrada para todos los objetivos. - - - - - diff --git a/reference/parallel/parallel/input/remove.xml b/reference/parallel/parallel/input/remove.xml deleted file mode 100644 index b9c455cbc8..0000000000 --- a/reference/parallel/parallel/input/remove.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - parallel\Events\Input::remove - Entradas - - - - &reftitle.description; - - public voidparallel\Events\Input::remove - stringtarget - - - Elimina la entrada para el objetivo dado. - - - - - Excepciones - - - Lanza una parallel\Events\Input\Error\Existence si la entrada para el objetivo no existe. - - - - - - diff --git a/reference/parallel/parallel/runtime/close.xml b/reference/parallel/parallel/runtime/close.xml deleted file mode 100644 index ae27e8ad9c..0000000000 --- a/reference/parallel/parallel/runtime/close.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - parallel\Runtime::close - Se une graciosamente a la ejecución - - - - &reftitle.description; - - public voidparallel\Runtime::close - - - - Solicita que la ejecución se detenga. - - - - Las tareas programadas para la ejecución se ejecutarán antes de que se produzca la detención. - - - - - - Excepciones - - - Lanza una parallel\Runtime\Error\Closed si Runtime ya estaba cerrado. - - - - - - diff --git a/reference/parallel/parallel/runtime/construct.xml b/reference/parallel/parallel/runtime/construct.xml deleted file mode 100644 index 426c3ee332..0000000000 --- a/reference/parallel/parallel/runtime/construct.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - parallel\Runtime::__construct - Construcción de la ejecución - - - - &reftitle.description; - - public parallel\Runtime::__construct - - - - Construye una ejecución sin cargador automático. - - - public parallel\Runtime::__construct - stringbootstrap - - - Construye una ejecución amorcada. - - - - - - &reftitle.parameters; - - - bootstrap - - - La localización de un fichero de amorce, generalmente un cargador automático. - - - - - - - - Excepciones - - - Lanza una parallel\Runtime\Error si el hilo no ha podido ser creado. - - - - - Lanza una parallel\Runtime\Bootstrap si el amorce ha fallado. - - - - - - diff --git a/reference/parallel/parallel/runtime/kill.xml b/reference/parallel/parallel/runtime/kill.xml deleted file mode 100644 index ec5e27630d..0000000000 --- a/reference/parallel/parallel/runtime/kill.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - parallel\Runtime::kill - Se une a la ejecución - - - - &reftitle.description; - - public voidparallel\Runtime::kill - - - - Intenta forzar la detención de la ejecución. - - - - Las tareas programadas para la ejecución no se ejecutarán, la tarea en curso será interrumpida. - - - - - Las llamadas de funciones internas en curso no pueden ser interrumpidas. - - - - - - Excepciones - - - Lanza una parallel\Runtime\Error\Closed si Runtime ya estaba cerrado. - - - - - - diff --git a/reference/parallel/parallel/runtime/run.xml b/reference/parallel/parallel/runtime/run.xml deleted file mode 100644 index b34a35e934..0000000000 --- a/reference/parallel/parallel/runtime/run.xml +++ /dev/null @@ -1,181 +0,0 @@ - - - - - - parallel\Runtime::run - Ejecución - - - - &reftitle.description; - - public Futurenullparallel\Runtime::run - Closuretask - - - Planifica task para la ejecución en paralelo. - - - public Futurenullparallel\Runtime::run - Closuretask - arrayargv - - - Planifica task para la ejecución en paralelo, pasando argv en el momento de la ejecución. - - - - - - &reftitle.parameters; - - - task - - - Una Closure con características específicas. - - - - - argv - - - Un array de argumentos con características específicas para pasar a task en el momento de la ejecución. - - - - - - - - Características de la tarea - - Las cierres planificadas para la ejecución en paralelo no deben: - - aceptar o devolver por referencia - aceptar o devolver objetos internos (ver notas) - ejecutar un conjunto limitado de instrucciones - - - - Las instrucciones prohibidas en los cierres destinados a la ejecución en paralelo son: - - yield - usar by-reference - declarar clases - declarar funciones nombradas - - - - - Los cierres anidados pueden usar yield o by-reference, pero no deben contener declaraciones de clases o funciones nombradas. - - - - - Ninguna instrucción está prohibida en los ficheros que la tarea puede incluir. - - - - - - Características de los argumentos - - Los argumentos no deben: - - contener referencias - contener recursos - contener objetos internos (ver notas) - - - - En el caso de los recursos de flujo de ficheros, el recurso será convertido en descriptor de fichero y pasado en int si es posible, esto no está soportado en Windows. - - - - - - - Notas sobre los objetos internos - - Los objetos internos utilizan generalmente una estructura personalizada que no puede ser copiada de manera segura por valor, PHP carece actualmente de mecanismos para hacerlo (sin serialización) - y por lo tanto solo los objetos que no utilizan una estructura personalizada pueden ser compartidos. - - - Algunos objetos internos no utilizan una estructura personalizada, por ejemplo parallel\Events\Event y por lo tanto pueden ser compartidos. - - - Los cierres son un tipo especial de objeto interno y soportan ser copiados por valor, y por lo tanto pueden ser compartidos. - - - Los canales son centrales para la escritura de código paralelo y soportan el acceso y la ejecución concurrentes por necesidad, y por lo tanto pueden ser compartidos. - - - - Una clase de usuario que extiende una clase interna puede usar una estructura personalizada tal como está definida por la clase interna, en cuyo caso no puede ser copiada de manera segura por valor, - y por lo tanto no puede ser compartida. - - - - - - &reftitle.returnvalues; - - - El Future devuelto no debe ser ignorado cuando la tarea contiene una declaración de retorno o de lanzamiento. - - - - - - Excepciones - - - Lanza una parallel\Runtime\Error\Closed si parallel\Runtime estaba cerrado. - - - - - Lanza una parallel\Runtime\Error\IllegalFunction si task es un cierre creado a partir de una función interna. - - - - - Lanza una parallel\Runtime\Error\IllegalInstruction si task contiene instrucciones ilegales. - - - - - Lanza una parallel\Runtime\Error\IllegalParameter si task acepta o argv contiene variables ilegales. - - - - - Lanza una parallel\Runtime\Error\IllegalReturn si task devuelve de manera ilegal. - - - - - - diff --git a/reference/parallel/parallel/sync/construct.xml b/reference/parallel/parallel/sync/construct.xml deleted file mode 100644 index d0e1bd3776..0000000000 --- a/reference/parallel/parallel/sync/construct.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - parallel\Sync::__construct - Construcción - - - - &reftitle.description; - - public parallel\Sync::__construct - - - - Construye un nuevo objeto de sincronización sin valor. - - - - public parallel\Sync::__construct - scalarvalue - - - Construye un nuevo objeto de sincronización que contiene el valor escalar dado. - - - - - - Excepciones - - - Lanza una parallel\Sync\Error\IllegalValue si value no es escalar. - - - - - - diff --git a/reference/parallel/parallel/sync/get.xml b/reference/parallel/parallel/sync/get.xml deleted file mode 100644 index 4df38cc520..0000000000 --- a/reference/parallel/parallel/sync/get.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - parallel\Sync::get - Acceso - - - - &reftitle.description; - - public scalarparallel\Sync::get - - - - Devuelve de manera atómica el valor del objeto de sincronización. - - - - - - diff --git a/reference/parallel/parallel/sync/invoke.xml b/reference/parallel/parallel/sync/invoke.xml deleted file mode 100644 index f3e951544f..0000000000 --- a/reference/parallel/parallel/sync/invoke.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - parallel\Sync::__invoke - Sincronización - - - - &reftitle.description; - - public parallel\Sync::__invoke - callablecritical - - - Entra exclusivamente en el código crítico - - - - - - diff --git a/reference/parallel/parallel/sync/notify.xml b/reference/parallel/parallel/sync/notify.xml deleted file mode 100644 index 605ba33323..0000000000 --- a/reference/parallel/parallel/sync/notify.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - parallel\Sync::notify - Sincronización - - - - &reftitle.description; - - public parallel\Sync::notify - boolall - - - Notifica un (por omisión) o todos los hilos en espera sobre el objeto de sincronización - - - - - - diff --git a/reference/parallel/parallel/sync/set.xml b/reference/parallel/parallel/sync/set.xml deleted file mode 100644 index e310c82b40..0000000000 --- a/reference/parallel/parallel/sync/set.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - parallel\Sync::set - Acceso - - - - &reftitle.description; - - public parallel\Sync::set - scalarvalue - - - Establece atómicamente el valor del objeto de sincronización - - - - - - Excepciones - - - Lanza una parallel\Sync\Error\IllegalValue si value no es escalar. - - - - - - diff --git a/reference/parallel/parallel/sync/wait.xml b/reference/parallel/parallel/sync/wait.xml deleted file mode 100644 index 054d76b689..0000000000 --- a/reference/parallel/parallel/sync/wait.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - parallel\Sync::wait - Sincronización - - - - &reftitle.description; - - public parallel\Sync::wait - - - - Espera la notificación en este objeto de sincronización - - - - - - diff --git a/reference/parallel/philosophy.xml b/reference/parallel/philosophy.xml deleted file mode 100644 index 77334b7457..0000000000 --- a/reference/parallel/philosophy.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - Filosofía - - Esta sección contiene filosofías importantes para escribir código paralelo y algunos detalles sobre la implementación interna de parallel. - - - No se comunica compartiendo memoria; comparta memoria comunicando. - - Esta filosofía, adoptada por parallel, tiene sus orígenes en Go, una de las plataformas más ampliamente admiradas, si no utilizadas, para escribir código paralelo en este momento. - Los desarrolladores de Go deben trabajar duro para estar a la altura de este ideal: PHP y parallel hacen todo el trabajo difícil para el programador, y por omisión. - - - En los modelos de hilos convencionales encontrados en otros lenguajes, generalmente los hilos se comunican entre sí por el simple hecho de que operan en el mismo espacio de direcciones. - El desarrollador debe desplegar exclusiones mutuas, variables de condición y otras primitivas de bajo nivel de hilos o sincronización para garantizar una comunicación adecuada del estado y la coherencia. - - - Cuando el modelo convencional se invierte, significa que los hilos solo comparten memoria mediante la comunicación (una variable se pasa sobre un canal, por ejemplo). - - - Cuando parallel pasa una variable de un hilo a otro por cualquier medio - argumentos de tarea, retorno a través de Future y Channels - se pasa por valor. - En todos los casos, excepto en el caso de los canales no almacenados en búfer, la variable también se almacena en búfer de modo que no pueda cambiar (o ser destruida) antes de ser utilizada en el hilo - al que se transmite la variable. Una lectura no almacenada en búfer en un canal es el único caso en el que un hilo lee directamente la memoria asignada por otro hilo, puede hacerlo de manera segura porque - el hilo que posee la memoria espera a que la lectura termine antes de poder continuar manipulándola, y el hilo que no posee la memoria lee por valor. Cuando - ambos hilos continúan, ya no comparten memoria. - - - Esto hace que escribir y razonar sobre el código paralelo sea mucho más fácil que el modelo convencional de hilos. Esto significa que el programador no necesita considerar que los hilos - pueden manipular datos simultáneamente, ya que esto no es posible. - - - Esto también convierte a PHP en la plataforma perfecta para implementar una API de concurrencia paralela basada en CSP (paso de mensajes sobre canales), ya que PHP en sí mismo no comparte nada - - los hilos de PHP funcionan en su propio espacio de direcciones virtual por omisión, y por lo tanto solo pueden compartir memoria comunicándose. - - - - Los datos deben tener un propietario único y definitivo - - Cuando se aborda el modelo CSP por primera vez, un programador versado en el modelo tradicional de hilos puede encontrarse buscando estructuras de datos concurrentes, - ya que es a lo que está acostumbrado: pasa objetos compartidos para manipularlos. - - - Cuando se aborda el modelo CSP, no es necesario que las estructuras de datos sean compartidas por muchas tareas, y de hecho, es más simple si no lo son. Los datos deben ser propiedad - de una sola tarea, las modificaciones (o operaciones) de esta estructura de datos deben ser comunicadas a través de canales y realizadas por el propietario de los datos, el éxito, el fracaso, - o el resultado (estado) del cambio (o de la operación) siendo comunicado de vuelta. - - - Una vez más, la naturaleza de PHP y la naturaleza de copia por valor de parallel ayuda al desarrollador a alcanzar este objetivo, ningún dato será compartido por accidente, - solo como resultado de la comunicación. - - - - diff --git a/reference/parallel/setup.xml b/reference/parallel/setup.xml deleted file mode 100644 index 3f9ad4d47c..0000000000 --- a/reference/parallel/setup.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - Instalación - - - &reftitle.required; - - parallel requiere una compilación de PHP con ZTS (Zend Thread Safety) activado - (, o en sistemas no-Windows antes de PHP 8.0.0, - ) - - - - Zend Thread Safety no puede ser activado después de la compilación; es una opción de configuración de compilación. - - - - parallel debería compilarse en cualquier lugar donde haya un encabezado Posix Threads funcional (pthread.h) y una compilación ZTS de PHP, incluyendo Windows (utilizando el proyecto pthread-w32 de redhat). - - - - - &reftitle.install; - - Las versiones de parallel son alojadas por PECL y el código fuente por - github, - el método de instalación más simple es la ruta PECL normal: - &url.pecl.package;parallel. - - - Los usuarios de Windows pueden descargar binarios de versiones precompiladas desde el sitio PECL. - - - - Los usuarios de Windows deben tomar la medida adicional de añadir pthreadVC?.dll (distribuido con las versiones de Windows) a su PATH. - - - - - diff --git a/reference/parle/book.xml b/reference/parle/book.xml deleted file mode 100644 index 184f624420..0000000000 --- a/reference/parle/book.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - Análisis léxico y sintáctico - Parle - - - &reftitle.intro; - &warn.experimental; - - La extensión parle proporciona facilidades de lexing y parsing de uso general. La implementación se basa en las bibliotecas de estas librerías y requiere un compilador compatible con C++14. El análisis léxico se basa en la correspondencia regex, el análisis sintáctico es LALR(1). Los analizadores se generan sobre la marcha y pueden ser utilizados inmediatamente después de haber sido finalizados. Parle maneja el análisis léxico y sintáctico, la representación y el tratamiento de las estructuras de datos apropiadas son tarea del implementador. La serialización y la generación de código no son soportadas por la extensión, por el momento. - - - El analizador léxico es un proceso de división de una secuencia de caracteres en una lista de lexemas. La lista de lexemas puede ser utilizada posteriormente para el análisis sintáctico en relación con una gramática formal. Estas operaciones también son conocidas como análisis léxico (lexing) y análisis sintáctico (parsing). Esta documentación no tiene como objetivo proporcionar información exhaustiva sobre el lexing y el parsing. Buena información sobre estos temas está disponible en numerosos recursos en la red. Varios ejemplos de uso están incluidos para mostrar la funcionalidad. La extensión es útil para los desarrolladores PHP que deseen aprender o utilizar el análisis léxico y sintáctico. Las máquinas de estado y el análisis de gramática no tienen - - - Los casos de uso comunes para parle son cuando un formato de datos es demasiado complejo para ser manejado por la correspondencia regex con PCRE. La aplicación práctica es, por lo tanto, amplia. Ya sea un formato de datos específico, una modificación del comportamiento de las funciones existentes, o incluso un lenguaje de programación y más allá. Los métodos de ayuda como Parle\Lexer::dump para inspeccionar la máquina de estado generada, o Parle\Parser::dump para inspeccionar la gramática generada, son útiles. El método Parle\Parser::trace también puede ser utilizado para seguir la operación de análisis. - - - - &reference.parle.setup; - &reference.parle.constants; - &reference.parle.pattern.matching; - &reference.parle.examples; - &reference.parle.parle.lexer; - &reference.parle.parle.rlexer; - &reference.parle.parle.parser; - &reference.parle.parle.rparser; - &reference.parle.parle.stack; - &reference.parle.parle.token; - &reference.parle.parle.errorinfo; - &reference.parle.parle.lexerexception; - &reference.parle.parle.parserexception; - - - - diff --git a/reference/parle/configure.xml b/reference/parle/configure.xml deleted file mode 100644 index 4cedd01200..0000000000 --- a/reference/parle/configure.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;parle - - -
    - - diff --git a/reference/parle/constants.xml b/reference/parle/constants.xml deleted file mode 100644 index 62b003399e..0000000000 --- a/reference/parle/constants.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - - - Parle\INTERNAL_UTF32 - bool - - - - Flag que permite saber si el soporte interno UTF-32 ha sido compilado correctamente. Disponible a partir de parle 0.7.2. - - - - - - - diff --git a/reference/parle/examples.xml b/reference/parle/examples.xml deleted file mode 100644 index e4fa10d3c5..0000000000 --- a/reference/parle/examples.xml +++ /dev/null @@ -1,233 +0,0 @@ - - - - - &reftitle.examples; -
    - Ejemplos de análisis léxico (Lexer) - - Tokenizar una lista de enteros separados por comas - - id */ -$token = array( - "COMMA" => 1, - "CRLF" => 2, - "DECIMAL" => 3, -); -/* id => name */ -$tokenIdToName = array_flip($token); - -$lex = new Lexer; -$lex->push("[\x2c]", $token["COMMA"]); -$lex->push("[\r][\n]", $token["CRLF"]); -$lex->push("[\d]+", $token["DECIMAL"]); -$lex->build(); - -$in = "0,1,2\r\n3,42,5\r\n6,77,8\r\n"; - -$lex->consume($in); - -do { - $lex->advance(); - $tok = $lex->getToken(); - - if (Token::UNKNOWN == $tok->id) { - throw new LexerException("Unknown token '{$tok->value}' at offset {$lex->marker}."); - } - - echo "TOKEN: ", $tokenIdToName[$tok->id], PHP_EOL; -} while (Token::EOI != $tok->id); -]]> - - - - Tokenizar una instrucción de asignación - -push("\$[a-zA-Z_][a-zA-Z0-9_]*", 1); -$lex->push("=", 2); -$lex->push("\d+", 3); -$lex->push(";", 4); - -$lex->build(); - -$lex->consume('$x = 42; $y = 24;'); - -do { - $lex->advance(); - $tok = $lex->getToken(); - var_dump($tok); -} while (Token::EOI != $tok->id); -]]> - - -
    -
    - Ejemplos de análisis sintáctico (Parser) - - Calculadora simple - -token("INTEGER"); -$p->left("'+' '-' '*' '/'"); - -$p->push("start", "exp"); -$prod_add = $p->push("exp", "exp '+' exp"); -$prod_sub = $p->push("exp", "exp '-' exp"); -$prod_mul = $p->push("exp", "exp '*' exp"); -$prod_div = $p->push("exp", "exp '/' exp"); -$p->push("exp", "INTEGER"); /* Production index unused. */ - -$p->build(); - -$lex = new Lexer; -$lex->push("[+]", $p->tokenId("'+'")); -$lex->push("[-]", $p->tokenId("'-'")); -$lex->push("[*]", $p->tokenId("'*'")); -$lex->push("[/]", $p->tokenId("'/'")); -$lex->push("\\d+", $p->tokenId("INTEGER")); -$lex->push("\\s+", Token::SKIP); - -$lex->build(); - -$exp = array( - "1 + 1", - "33 / 10", - "100 * 45", - "17 - 45", -); - -foreach ($exp as $in) { - if (!$p->validate($in, $lex)) { - throw new ParserException("Failed to validate input"); - } - - $p->consume($in, $lex); - - while (Parser::ACTION_ERROR != $p->action && Parser::ACTION_ACCEPT != $p->action) { - switch ($p->action) { - case Parser::ACTION_ERROR: - throw new ParserException("Parser error"); - break; - case Parser::ACTION_SHIFT: - case Parser::ACTION_GOTO: - case Parser::ACTION_ACCEPT: - break; - case Parser::ACTION_REDUCE: - switch ($p->reduceId) { - case $prod_add: - $l = $p->sigil(0); - $r = $p->sigil(2); - echo "$l + $r = " . ($l + $r) . "\n"; - break; - case $prod_sub: - $l = $p->sigil(0); - $r = $p->sigil(2); - echo "$l - $r = " . ($l - $r) . "\n"; - break; - case $prod_mul: - $l = $p->sigil(0); - $r = $p->sigil(2); - echo "$l * $r = " . ($l * $r) . "\n"; - break; - case $prod_div: - $l = $p->sigil(0); - $r = $p->sigil(2); - echo "$l / $r = " . ($l / $r) . "\n"; - break; - } - break; - } - $p->advance(); - } -} -]]> - - - - Analizar una frase para extraer las palabras - -token("WORD"); -$p->push("START", "SENTENCE"); -$p->push("SENTENCE", "WORDS"); -$prod_word_0 = $p->push("WORDS", "WORDS WORD"); -$prod_word_1 = $p->push("WORDS", "WORD"); -$p->build(); - -$lex = new Lexer; -$lex->push("[^\s]{-}[\.,\:\;\?]+", $p->tokenId("WORD")); -$lex->push("[\s\.,\:\;\?]+", Token::SKIP); -$lex->build(); - -$in = "Dis-moi où est ton papa?"; -$p->consume($in, $lex); -do { - switch ($p->action) { - case Parser::ACTION_ERROR: - throw new ParserException("Error"); - break; - case Parser::ACTION_SHIFT: - case Parser::ACTION_GOTO: - /* var_dump($p->trace());*/ - break; - case Parser::ACTION_REDUCE: - $rid = $p->reduceId(); - if ($rid == $prod_word_1) { - var_dump($p->sigil(0)); - } if ($rid == $prod_word_0) { - var_dump($p->sigil(1)); - } - break; - } - $p->advance(); -} while (Parser::ACTION_ACCEPT != $p->action); -]]> - - -
    -
    - - diff --git a/reference/parle/parle.errorinfo.xml b/reference/parle/parle.errorinfo.xml deleted file mode 100644 index 3a679093b6..0000000000 --- a/reference/parle/parle.errorinfo.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - - - La clase Parle\ErrorInfo - Parle\ErrorInfo - - - - -
    - &reftitle.intro; - - La clase representa la información detallada de los errores, tal como se proporciona - por el método Parle\Parser::errorInfo - -
    - - -
    - &reftitle.classsynopsis; - - - - Parle\ErrorInfo - - - - - Parle\ErrorInfo - - - - &Properties; - - public - int - id - - - public - int - position - - - public - mixed - token - - - &Methods; - - - - - -
    - - -
    - &reftitle.properties; - - - id - - Identificador del error. - - - - position - - Posición en la entrada donde ocurrió el error. - - - - token - - - Si es aplicable, la clase Parle\Token relativa al error, - de lo contrario &null;. - - - -
    - - -
    - - - -
    - - diff --git a/reference/parle/parle.lexer.xml b/reference/parle/parle.lexer.xml deleted file mode 100644 index 04cbf47232..0000000000 --- a/reference/parle/parle.lexer.xml +++ /dev/null @@ -1,212 +0,0 @@ - - - - - La clase Parle\Lexer - Parle\Lexer - - - - -
    - &reftitle.intro; - - Clase de análisis léxico de estado único. Los lexemas pueden ser definidos sobre la marcha. Si la instancia particular del lexer está destinada a ser utilizada con Parle\Parser, los identificadores de tokens deben ser tomados de allí. De lo contrario, pueden proporcionarse identificadores de tokens arbitrarios. Este lexer puede ofrecer cierta ventaja de rendimiento en comparación con Parle\RLexer, si no se necesitan múltiples estados. Es importante señalar que Parle\RParser no es compatible con este lexer. - -
    - - -
    - &reftitle.classsynopsis; - - - - Parle\Lexer - - - - - Parle\Lexer - - - - &Constants; - - const - int - Parle\Lexer::ICASE - 1 - - - const - int - Parle\Lexer::DOT_NOT_LF - 2 - - - const - int - Parle\Lexer::DOT_NOT_CRLF - 4 - - - const - int - Parle\Lexer::SKIP_WS - 8 - - - const - int - Parle\Lexer::MATCH_ZERO_LEN - 16 - - - &Properties; - - public - bool - bol - &false; - - - public - int - flags - 0 - - - public - int - state - 0 - - - public - int - marker - 0 - - - public - int - cursor - 0 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - Parle\Lexer::ICASE - - - - - - - Parle\Lexer::DOT_NOT_LF - - - - - - - Parle\Lexer::DOT_NOT_CRLF - - - - - - - Parle\Lexer::SKIP_WS - - - - - - - Parle\Lexer::MATCH_ZERO_LEN - - - - - - -
    - - - -
    - &reftitle.properties; - - - bol - - Indicador de inicio de entrada. - - - - flags - - Flags del lexer. - - - - state - - Estado actual del lexer, solo lectura. - - - - marker - - Posición de la última coincidencia de token, solo lectura. - - - - cursor - - Desplazamiento de entrada actual, solo lectura. - - - -
    - - -
    - - - &reference.parle.parle.entities.lexer; - -
    - - diff --git a/reference/parle/parle.lexerexception.xml b/reference/parle/parle.lexerexception.xml deleted file mode 100644 index d56f1396dc..0000000000 --- a/reference/parle/parle.lexerexception.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - - La clase Parle\LexerException - Parle\LexerException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Parle\LexerException - - - - - Parle\LexerException - - - - extends - Exception - - - - Throwable - - - - &InheritedProperties; - - - &Methods; - - - - &InheritedMethods; - - - - - -
    - -
    - - - -
    - - diff --git a/reference/parle/parle.parser.xml b/reference/parle/parle.parser.xml deleted file mode 100644 index 78c56c8946..0000000000 --- a/reference/parle/parle.parser.xml +++ /dev/null @@ -1,215 +0,0 @@ - - - - - La clase Parle\Parser - Parle\Parser - - - - -
    - &reftitle.intro; - - Clase de análisis sintáctico. Las reglas pueden ser definidas sobre la marcha. Una vez finalizada, se requiere una instancia de Parle\Lexer para proporcionar el flujo de tokens. - -
    - - -
    - &reftitle.classsynopsis; - - - - Parle\Parser - - - - - Parle\Parser - - - - &Constants; - - const - int - Parle\Parser::ACTION_ERROR - 0 - - - const - int - Parle\Parser::ACTION_SHIFT - 1 - - - const - int - Parle\Parser::ACTION_REDUCE - 2 - - - const - int - Parle\Parser::ACTION_GOTO - 3 - - - const - int - Parle\Parser::ACTION_ACCEPT - 4 - - - const - int - Parle\Parser::ERROR_SYNTAX - 0 - - - const - int - Parle\Parser::ERROR_NON_ASSOCIATIVE - 1 - - - const - int - Parle\Parser::ERROR_UNKNOWN_TOKEN - 2 - - - &Properties; - - public - int - action - 0 - - - public - int - reduceId - 0 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - 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 - - - - - - -
    - - - -
    - &reftitle.properties; - - - action - - Las acciones del analizador actual que corresponden a una de las constantes de clase de acción, en modo de solo lectura. - - - - reduceId - - Las reglas de gramática id justo tratadas en la acción de reducción. El valor corresponde a un token o a un identificador de producción. En modo de solo lectura. - - - -
    - - -
    - - - &reference.parle.parle.entities.parser; - -
    - - diff --git a/reference/parle/parle.parserexception.xml b/reference/parle/parle.parserexception.xml deleted file mode 100644 index 5e7e67788d..0000000000 --- a/reference/parle/parle.parserexception.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - - La clase Parle\ParserException - Parle\ParserException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Parle\ParserException - - - - - Parle\ParserException - - - - extends - Exception - - - - Throwable - - - - &InheritedProperties; - - - &Methods; - - - - &InheritedMethods; - - - - - -
    - -
    - - - -
    - - diff --git a/reference/parle/parle.rlexer.xml b/reference/parle/parle.rlexer.xml deleted file mode 100644 index 31e148fbd3..0000000000 --- a/reference/parle/parle.rlexer.xml +++ /dev/null @@ -1,212 +0,0 @@ - - - - - La clase Parle\RLexer - Parle\RLexer - - - - -
    - &reftitle.intro; - - Clase de análisis léxico de múltiples estados. Los lexemas pueden ser definidos sobre la marcha. Si la instancia particular del lexer está destinada a ser utilizada con Parle\RParser, los identificadores de tokens deben ser tomados de allí. De lo contrario, se pueden proporcionar identificadores de tokens arbitrarios. Es importante señalar que Parle\Parser no es compatible con este lexer. - -
    - - -
    - &reftitle.classsynopsis; - - - - Parle\RLexer - - - - - Parle\RLexer - - - - &Constants; - - const - int - Parle\RLexer::ICASE - 1 - - - const - int - Parle\RLexer::DOT_NOT_LF - 2 - - - const - int - Parle\RLexer::DOT_NOT_CRLF - 4 - - - const - int - Parle\RLexer::SKIP_WS - 8 - - - const - int - Parle\RLexer::MATCH_ZERO_LEN - 16 - - - &Properties; - - public - bool - bol - &false; - - - public - int - flags - 0 - - - public - int - state - 0 - - - public - int - marker - 0 - - - public - int - cursor - 0 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - Parle\RLexer::ICASE - - - - - - - Parle\RLexer::DOT_NOT_LF - - - - - - - Parle\RLexer::DOT_NOT_CRLF - - - - - - - Parle\RLexer::SKIP_WS - - - - - - - Parle\RLexer::MATCH_ZERO_LEN - - - - - - -
    - - - -
    - &reftitle.properties; - - - bol - - Indicador de inicio de entrada. - - - - flags - - Flags del lexer. - - - - state - - Estado actual del lexer, de solo lectura. - - - - marker - - Posición de la última coincidencia de token, de solo lectura. - - - - cursor - - Desplazamiento de entrada actual, de solo lectura. - - - -
    - - -
    - - - &reference.parle.parle.entities.rlexer; - -
    - - diff --git a/reference/parle/parle.rparser.xml b/reference/parle/parle.rparser.xml deleted file mode 100644 index 970fac7d50..0000000000 --- a/reference/parle/parle.rparser.xml +++ /dev/null @@ -1,215 +0,0 @@ - - - - - La clase Parle\RParser - Parle\RParser - - - - -
    - &reftitle.intro; - - Clase de análisis sintáctico. Las reglas pueden ser definidas sobre la marcha. Una vez finalizada, se requiere una instancia de Parle\RLexer para proporcionar el flujo de tokens. - -
    - - -
    - &reftitle.classsynopsis; - - - - Parle\RParser - - - - - Parle\RParser - - - - &Constants; - - const - int - Parle\RParser::ACTION_ERROR - 0 - - - const - int - Parle\RParser::ACTION_SHIFT - 1 - - - const - int - Parle\RParser::ACTION_REDUCE - 2 - - - const - int - Parle\RParser::ACTION_GOTO - 3 - - - const - int - Parle\RParser::ACTION_ACCEPT - 4 - - - const - int - Parle\RParser::ERROR_SYNTAX - 0 - - - const - int - Parle\RParser::ERROR_NON_ASSOCIATIVE - 1 - - - const - int - Parle\RParser::ERROR_UNKNOWN_TOKEN - 2 - - - &Properties; - - public - int - action - 0 - - - public - int - reduceId - 0 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - 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 - - - - - - -
    - - - -
    - &reftitle.properties; - - - action - - Las acciones del parser actual que corresponden a una de las constantes de clase de acción, en modo de solo lectura. - - - - reduceId - - Las reglas de gramática id justo tratadas en la acción de reducción. El valor corresponde a un token o a un identificador de producción. En modo de solo lectura. - - - -
    - - -
    - - - &reference.parle.parle.entities.rparser; - -
    - - diff --git a/reference/parle/parle.stack.xml b/reference/parle/parle.stack.xml deleted file mode 100644 index 11ae0fbde2..0000000000 --- a/reference/parle/parle.stack.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - La clase Parle\Stack - Parle\Stack - - - - -
    - &reftitle.intro; - - Parle\Stack es una pila LIFO. Los elementos son insertados y retirados únicamente de un extremo. - -
    - - -
    - &reftitle.classsynopsis; - - - - Parle\Stack - - - - - Parle\Stack - - - - - &Properties; - - public - bool - empty - &true; - - - public - int - size - 0 - - - public - mixed - top - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - empty - - Si la pila está vacía, en solo lectura. - - - - size - - Tamaño de la pila, en solo lectura. - - - - top - - Elemento en la cima de la pila. - - - -
    - - -
    - - - &reference.parle.parle.entities.stack; - -
    - - diff --git a/reference/parle/parle.token.xml b/reference/parle/parle.token.xml deleted file mode 100644 index 326b44a082..0000000000 --- a/reference/parle/parle.token.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - La clase Parle\Token - Parle\Token - - - - -
    - &reftitle.intro; - - Esta clase representa un token. El analizador léxico devuelve instancias de esta clase. - -
    - - -
    - &reftitle.classsynopsis; - - - - Parle\Token - - - - - Parle\Token - - - - &Constants; - - const - int - Parle\Token::EOI - 0 - - - const - int - Parle\Token::UNKNOWN - -1 - - - const - int - Parle\Token::SKIP - -2 - - - &Properties; - - public - int - id - - - public - string - value - - - &Methods; - - - - - -
    - - -
    - &reftitle.properties; - - - id - - El identificador del token. - - - - value - - El valor del token. - - - -
    - - - -
    - &reftitle.constants; - - - - Parle\Token::EOI - - El identificador de token de fin de entrada. - - - - - Parle\Token::UNKNOWN - - El identificador de token desconocido. - - - - - Parle\Token::SKIP - - El identificador de token a ignorar. - - - - -
    - - -
    - - - -
    - - diff --git a/reference/parle/parle/lexer/advance.xml b/reference/parle/parle/lexer/advance.xml deleted file mode 100644 index 7f2c68204f..0000000000 --- a/reference/parle/parle/lexer/advance.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\Lexer::advance - Avanzar a la regla siguiente del lexer - - - - &reftitle.description; - - public voidParle\Lexer::advance - - - - Avanza a la regla siguiente y prepara los datos del token resultante. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/lexer/build.xml b/reference/parle/parle/lexer/build.xml deleted file mode 100644 index 5bd0ea8bd2..0000000000 --- a/reference/parle/parle/lexer/build.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - Parle\Lexer::build - Finaliza el conjunto de reglas del lexer - - - - &reftitle.description; - - public voidParle\Lexer::build - - - - Las reglas, previamente añadidas con Parle\Lexer::push, son finalizadas. Esta llamada de método debe realizarse después de que todas las reglas necesarias hayan sido añadidas. El conjunto de reglas se vuelve de solo lectura. El análisis léxico puede comenzar. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/lexer/callout.xml b/reference/parle/parle/lexer/callout.xml deleted file mode 100644 index df3ed6be15..0000000000 --- a/reference/parle/parle/lexer/callout.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - Parle\Lexer::callout - Define una función de retrollamada de token - - - - &reftitle.description; - - public voidParle\Lexer::callout - intid - callablecallback - - - Define una función de retrollamada a invocar una vez que el lexer encuentre un token particular. - - - - - &reftitle.parameters; - - - id - - - El identificador del token. - - - - - callback - - - La función de retrollamada a invocar. La función de retrollamada no recibe ningún argumento y su valor de retorno es ignorado. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/lexer/consume.xml b/reference/parle/parle/lexer/consume.xml deleted file mode 100644 index 0e1e103e8e..0000000000 --- a/reference/parle/parle/lexer/consume.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Parle\Lexer::consume - Pasa los datos para el procesamiento - - - - &reftitle.description; - - public voidParle\Lexer::consume - stringdata - - - Consume los datos para el análisis léxico. - - - - - &reftitle.parameters; - - - data - - - Los datos a analizar. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/lexer/dump.xml b/reference/parle/parle/lexer/dump.xml deleted file mode 100644 index e30245fa62..0000000000 --- a/reference/parle/parle/lexer/dump.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - Parle\Lexer::dump - Muestra la máquina de estado - - - - &reftitle.description; - - public voidParle\Lexer::dump - - - - Muestra la máquina de estado actual en la salida estándar. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/lexer/gettoken.xml b/reference/parle/parle/lexer/gettoken.xml deleted file mode 100644 index 0d4f70b0ad..0000000000 --- a/reference/parle/parle/lexer/gettoken.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - Parle\Lexer::getToken - Devuelve el token actual - - - - &reftitle.description; - - public Parle\TokenParle\Lexer::getToken - - - - Devuelve el token actual. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una instancia de Parle\Token. - - - - - - diff --git a/reference/parle/parle/lexer/insertmacro.xml b/reference/parle/parle/lexer/insertmacro.xml deleted file mode 100644 index bd2a999cc3..0000000000 --- a/reference/parle/parle/lexer/insertmacro.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - Parle\Lexer::insertMacro - Inserta una macro regex - - - - &reftitle.description; - - public voidParle\Lexer::insertMacro - stringname - stringregex - - - Inserta una macro regex, que puede ser utilizada más tarde como un atajo e incluida en otras expresiones regulares. - - - - - &reftitle.parameters; - - - name - - - El nombre de la macro. - - - - - regex - - - La expresión regular. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/lexer/push.xml b/reference/parle/parle/lexer/push.xml deleted file mode 100644 index 37bed27cff..0000000000 --- a/reference/parle/parle/lexer/push.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - Parle\Lexer::push - Añade una regla de análisis - - - - &reftitle.description; - - public voidParle\Lexer::push - stringregex - intid - - - - Añade un patrón para el reconocimiento de los lexemas. - - - - - &reftitle.parameters; - - - regex - - - Expresión regular utilizada para el reconocimiento de los lexemas. - - - - - id - - - El identificador del token. Si la instancia del analizador léxico está destinada a ser utilizada sola, puede ser un número arbitrario. Si la instancia del analizador léxico debe ser pasada al analizador, debe ser un identificador devuelto por Parle\Parser::tokenid. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/lexer/reset.xml b/reference/parle/parle/lexer/reset.xml deleted file mode 100644 index 5fc2c4cf79..0000000000 --- a/reference/parle/parle/lexer/reset.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Parle\Lexer::reset - Reinicializa el analizador léxico - - - - &reftitle.description; - - public voidParle\Lexer::reset - intpos - - - Reinicializa el analizador léxico pasando opcionalmente la posición deseada. - - - - - &reftitle.parameters; - - - pos - - - La posición para reinicializar. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/parser/advance.xml b/reference/parle/parle/parser/advance.xml deleted file mode 100644 index 7911784e6f..0000000000 --- a/reference/parle/parle/parser/advance.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - Parle\Parser::advance - Procesa la regla siguiente del analizador - - - - &reftitle.description; - - public voidParle\Parser::advance - - - - Procesa la regla siguiente del analizador. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/parser/build.xml b/reference/parle/parle/parser/build.xml deleted file mode 100644 index ae505763dd..0000000000 --- a/reference/parle/parle/parser/build.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - Parle\Parser::build - Finaliza las reglas de gramática - - - - &reftitle.description; - - public voidParle\Parser::build - - - - Cada token y regla de gramática previamente añadidos son finalizados. El conjunto de reglas se vuelve de solo lectura y el analizador está listo para comenzar. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/parser/consume.xml b/reference/parle/parle/parser/consume.xml deleted file mode 100644 index 68c940a8b0..0000000000 --- a/reference/parle/parle/parser/consume.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - Parle\Parser::consume - Consume los datos para el procesamiento - - - - &reftitle.description; - - public voidParle\Parser::consume - stringdata - Parle\Lexerlexer - - - Consume los datos para el procesamiento. - - - - - &reftitle.parameters; - - - data - - - Los datos a analizar. - - - - - lexer - - - Un objeto lexer que contiene las reglas de análisis lexicales preparadas para la gramática particular. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/parser/dump.xml b/reference/parle/parle/parser/dump.xml deleted file mode 100644 index 761316f0f4..0000000000 --- a/reference/parle/parle/parser/dump.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - Parle\Parser::dump - Muestra la gramática - - - - &reftitle.description; - - public voidParle\Parser::dump - - - - Muestra la gramática actual en la salida estándar. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/parser/errorinfo.xml b/reference/parle/parle/parser/errorinfo.xml deleted file mode 100644 index 275a56a4c6..0000000000 --- a/reference/parle/parle/parser/errorinfo.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - Parle\Parser::errorInfo - Recupera las informaciones de error - - - - &reftitle.description; - - public Parle\ErrorInfoParle\Parser::errorInfo - - - - Recupera las informaciones de error en el caso de que Parle\Parser::action hubiera devuelto la acción de error. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una instancia de Parle\ErrorInfo. - - - - - - diff --git a/reference/parle/parle/parser/left.xml b/reference/parle/parle/parser/left.xml deleted file mode 100644 index a05335923d..0000000000 --- a/reference/parle/parle/parser/left.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Parle\Parser::left - Declara un token con asociatividad a la izquierda - - - - &reftitle.description; - - public voidParle\Parser::left - stringtok - - - Declara un token con asociatividad a la izquierda. - - - - - &reftitle.parameters; - - - tok - - - El nombre del token. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/parser/nonassoc.xml b/reference/parle/parle/parser/nonassoc.xml deleted file mode 100644 index d9c0f63c51..0000000000 --- a/reference/parle/parle/parser/nonassoc.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Parle\Parser::nonassoc - Declara un token sin asociatividad - - - - &reftitle.description; - - public voidParle\Parser::nonassoc - stringtok - - - Declara un token, que solo puede aparecer una vez en la línea. - - - - - &reftitle.parameters; - - - tok - - - El nombre del token. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/parser/precedence.xml b/reference/parle/parle/parser/precedence.xml deleted file mode 100644 index 77a1256bbf..0000000000 --- a/reference/parle/parle/parser/precedence.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Parle\Parser::precedence - Declara una regla de precedencia - - - - &reftitle.description; - - public voidParle\Parser::precedence - stringtok - - - Declara una regla de precedencia para un token ficticio. Esta regla puede ser utilizada más tarde en reglas de gramática específicas. - - - - - &reftitle.parameters; - - - tok - - - El nombre del token. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/parser/push.xml b/reference/parle/parle/parser/push.xml deleted file mode 100644 index ca235b7844..0000000000 --- a/reference/parle/parle/parser/push.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - Parle\Parser::push - Añade una regla de gramática - - - - &reftitle.description; - - public intParle\Parser::push - stringname - stringrule - - - Añade una regla de gramática. El identificador de producción devuelto puede ser utilizado más tarde en el proceso de análisis para identificar la regla correspondiente. - - - - - &reftitle.parameters; - - - name - - - El nombre de la regla. - - - - - rule - - - La regla a añadir. La sintaxis es compatible con Bison. - - - - - - - - &reftitle.returnvalues; - - Devuelve un &integer; que representa el índice de la regla. - - - - - - diff --git a/reference/parle/parle/parser/reset.xml b/reference/parle/parle/parser/reset.xml deleted file mode 100644 index 05eb8451ae..0000000000 --- a/reference/parle/parle/parser/reset.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Parle\Parser::reset - Reinicializa el estado del analizador - - - - &reftitle.description; - - public voidParle\Parser::reset - inttokenId - - - Reinicializa el estado del analizador utilizando el identificador de token dado. - - - - - &reftitle.parameters; - - - tokenId - - - El identificador del token. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/parser/right.xml b/reference/parle/parle/parser/right.xml deleted file mode 100644 index 44a4fb8d8f..0000000000 --- a/reference/parle/parle/parser/right.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Parle\Parser::right - Declara un token con asociatividad a la derecha - - - - &reftitle.description; - - public voidParle\Parser::right - stringtok - - - Declara un token con asociatividad a la derecha. - - - - - &reftitle.parameters; - - - tok - - - El nombre del token. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/parser/sigil.xml b/reference/parle/parle/parser/sigil.xml deleted file mode 100644 index ba4a2eec3d..0000000000 --- a/reference/parle/parle/parser/sigil.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Parle\Parser::sigil - Recupera una parte correspondiente de una regla - - - - &reftitle.description; - - public stringParle\Parser::sigil - intidx - - - Recupera una parte correspondiente de una regla. Este método es equivalente a la funcionalidad de pseudo-variable en Bison. - - - - - &reftitle.parameters; - - - idx - - - El identificador de correspondencia, basado en cero. - - - - - - - - &reftitle.returnvalues; - - Devuelve una &string; con la parte correspondiente. - - - - - - diff --git a/reference/parle/parle/parser/sigilcount.xml b/reference/parle/parle/parser/sigilcount.xml deleted file mode 100644 index 4e6e23173d..0000000000 --- a/reference/parle/parle/parser/sigilcount.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - Parle\Parser::sigilCount - Número de elementos en la regla correspondiente - - - - &reftitle.description; - - public intParle\Parser::sigilCount - - - - Devuelve el número de elementos en la regla correspondiente. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un &integer; - - - - - - diff --git a/reference/parle/parle/parser/sigilname.xml b/reference/parle/parle/parser/sigilname.xml deleted file mode 100644 index 1d77320e7d..0000000000 --- a/reference/parle/parle/parser/sigilname.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Parle\Parser::sigilName - Recupera un nombre de regla o de token - - - - &reftitle.description; - - public stringParle\Parser::sigilName - intidx - - - Recupera un nombre de regla parcial o de token correspondiente al índice de sigil. - - - - - &reftitle.parameters; - - - idx - - - El identificador de correspondencia, basado en cero. - - - - - - - - &reftitle.returnvalues; - - Devuelve un &string; con la parte correspondiente. - - - - - - diff --git a/reference/parle/parle/parser/token.xml b/reference/parle/parle/parser/token.xml deleted file mode 100644 index 5ee96f0e34..0000000000 --- a/reference/parle/parle/parser/token.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Parle\Parser::token - Declara un token - - - - &reftitle.description; - - public voidParle\Parser::token - stringtok - - - Declara un token para utilizar en la gramática. - - - - - &reftitle.parameters; - - - tok - - - El nombre del token. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/parser/tokenid.xml b/reference/parle/parle/parser/tokenid.xml deleted file mode 100644 index 7866346366..0000000000 --- a/reference/parle/parle/parser/tokenid.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Parle\Parser::tokenId - Devuelve el identificador del token - - - - &reftitle.description; - - public intParle\Parser::tokenId - stringtok - - - Devuelve el identificador del token nombrado. - - - - - &reftitle.parameters; - - - tok - - - El nombre utilizado en Parle\Parser::token. - - - - - - - - &reftitle.returnvalues; - - Devuelve un &integer; que representa el identificador del token. - - - - - - diff --git a/reference/parle/parle/parser/trace.xml b/reference/parle/parle/parser/trace.xml deleted file mode 100644 index 1ecd34bce8..0000000000 --- a/reference/parle/parle/parser/trace.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - Parle\Parser::trace - Rastrea la operación del analizador - - - - &reftitle.description; - - public stringParle\Parser::trace - - - - Recupera la descripción de la operación del analizador en curso. Esto puede ser particularmente útil para estudiar el analizador y optimizar la gramática. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un &string; con la información de rastreo. - - - - - - diff --git a/reference/parle/parle/parser/validate.xml b/reference/parle/parle/parser/validate.xml deleted file mode 100644 index d8f341a311..0000000000 --- a/reference/parle/parle/parser/validate.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - Parle\Parser::validate - Valida una entrada - - - - &reftitle.description; - - public boolParle\Parser::validate - stringdata - Parle\Lexerlexer - - - Valida una string de entrada. La string es analizada internamente, por lo que este método es útil para la validación rápida de la entrada. - - - - - &reftitle.parameters; - - - data - - - La string a validar. - - - - - lexer - - - Un objeto lexer que contiene las reglas de análisis léxico preparadas para la gramática particular. - - - - - - - - &reftitle.returnvalues; - - Devuelve un &boolean; que indica si la entrada cumple o no con las reglas definidas. - - - - - - diff --git a/reference/parle/parle/rlexer/advance.xml b/reference/parle/parle/rlexer/advance.xml deleted file mode 100644 index 3899ed133f..0000000000 --- a/reference/parle/parle/rlexer/advance.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Parle\RLexer::advance - Procesa la regla siguiente del analizador - - - - &reftitle.description; - - public voidParle\RLexer::advance - - - - Procesa la regla siguiente del analizador y prepara los datos del token resultante. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/rlexer/build.xml b/reference/parle/parle/rlexer/build.xml deleted file mode 100644 index 66b7874d70..0000000000 --- a/reference/parle/parle/rlexer/build.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - Parle\RLexer::build - Finaliza el conjunto de reglas del lexer - - - - &reftitle.description; - - public voidParle\RLexer::build - - - - Las reglas previamente añadidas con Parle\RLexer::push son finalizadas. Esta llamada de método debe realizarse después de que todas las reglas necesarias hayan sido añadidas. El conjunto de reglas se vuelve de solo lectura. El análisis léxico puede comenzar. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/rlexer/callout.xml b/reference/parle/parle/rlexer/callout.xml deleted file mode 100644 index dc929c3bcf..0000000000 --- a/reference/parle/parle/rlexer/callout.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - Parle\RLexer::callout - Define una función de retrollamada de token - - - - &reftitle.description; - - public voidParle\RLexer::callout - intid - callablecallback - - - Define una función de retrollamada a invocar una vez que el lexer encuentre un token particular. - - - - - &reftitle.parameters; - - - id - - - El identificador del token. - - - - - callback - - - La función de retrollamada a invocar. La función de retrollamada no recibe ningún argumento y su valor de retorno es ignorado. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/rlexer/consume.xml b/reference/parle/parle/rlexer/consume.xml deleted file mode 100644 index 8e472c91ab..0000000000 --- a/reference/parle/parle/rlexer/consume.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Parle\RLexer::consume - Pasa los datos para su procesamiento - - - - &reftitle.description; - - public voidParle\RLexer::consume - stringdata - - - Consume los datos para el análisis léxico. - - - - - &reftitle.parameters; - - - data - - - Los datos a analizar. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/rlexer/dump.xml b/reference/parle/parle/rlexer/dump.xml deleted file mode 100644 index 869f0140f5..0000000000 --- a/reference/parle/parle/rlexer/dump.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - Parle\RLexer::dump - Muestra la máquina de estado - - - - &reftitle.description; - - public voidParle\RLexer::dump - - - - Muestra la máquina de estado actual en la salida estándar. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/rlexer/gettoken.xml b/reference/parle/parle/rlexer/gettoken.xml deleted file mode 100644 index e6b6880b5e..0000000000 --- a/reference/parle/parle/rlexer/gettoken.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - Parle\RLexer::getToken - Devuelve el token actual - - - - &reftitle.description; - - public Parle\TokenParle\RLexer::getToken - - - - Devuelve el token actual. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una instancia de Parle\Token. - - - - - - diff --git a/reference/parle/parle/rlexer/insertmacro.xml b/reference/parle/parle/rlexer/insertmacro.xml deleted file mode 100644 index 57e7f48893..0000000000 --- a/reference/parle/parle/rlexer/insertmacro.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - Parle\RLexer::insertMacro - Inserta una macro regex - - - - &reftitle.description; - - public voidParle\RLexer::insertMacro - stringname - stringregex - - - Inserta una macro regex, que puede ser utilizada más tarde como un atajo e incluida en otras expresiones regulares. - - - - - &reftitle.parameters; - - - name - - - El nombre de la macro. - - - - - regex - - - La expresión regular. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/rlexer/push.xml b/reference/parle/parle/rlexer/push.xml deleted file mode 100644 index 755b14e3fa..0000000000 --- a/reference/parle/parle/rlexer/push.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - Parle\RLexer::push - Añade una regla de análisis - - - - &reftitle.description; - - public voidParle\RLexer::push - stringregex - intid - - - - public voidParle\RLexer::push - stringstate - stringregex - intid - stringnewState - - - - public voidParle\RLexer::push - stringstate - stringregex - stringnewState - - - Añade un patrón para el reconocimiento de lexemas. - - Un 'estado de inicio' y un 'estado de salida' pueden ser especificados utilizando una firma adecuada. - Un 'estado de inicio' (start state) y un 'estado de salida' (exit state) pueden ser especificados utilizando una firma adecuada. - - - - - &reftitle.parameters; - - - regex - - - Expresión regular utilizada para el reconocimiento de lexemas. - - - - - id - - - El identificador del token. Si la instancia del analizador léxico está destinada a ser utilizada sola, puede ser un número arbitrario. Si la instancia del analizador léxico debe ser pasada al analizador, debe ser un identificador devuelto por Parle\RParser::tokenid. - - - - - state - - - Nombre del estado. Si '*' se utiliza como estado de inicio, entonces la regla se aplica a todos los estados del analizador léxico. - - - - - newState - - - El nuevo nombre del estado, después de la aplicación de la regla. - - - Si '.' se especifica como estado de salida, entonces el estado del analizador léxico no se modifica cuando esta regla coincide. Un estado de salida con '>' antes del nombre significa empujar. Utilice la firma sin id para la continuación o para comenzar la coincidencia, cuando se requiere una continuación o recursión. - - - Si '<' se especifica como estado de salida, esto significa extraer. En este caso, la firma que contiene el id puede ser utilizada para identificar la coincidencia. Es importante señalar que incluso en el caso de que un id sea especificado, la regla terminará primero cuando todas las empujes previas hayan sido eliminadas. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/rlexer/pushstate.xml b/reference/parle/parle/rlexer/pushstate.xml deleted file mode 100644 index 3c5b528e53..0000000000 --- a/reference/parle/parle/rlexer/pushstate.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Parle\RLexer::pushState - Empuja un nuevo estado de inicio - - - - &reftitle.description; - - public intParle\RLexer::pushState - stringstate - - - Este analizador léxico puede tener más de una máquina de estados. Esto permite analizar diferentes tokens según el contexto, permitiendo así realizar un análisis sintáctico simple. Una vez empujado un estado, puede ser utilizado con una variante de firma Parle\RLexer::push adecuada. - - - - - &reftitle.parameters; - - - state - - - El nombre del estado. - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/parle/parle/rlexer/reset.xml b/reference/parle/parle/rlexer/reset.xml deleted file mode 100644 index d53eb4a4ea..0000000000 --- a/reference/parle/parle/rlexer/reset.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Parle\RLexer::reset - Reinicializa el analizador léxico - - - - &reftitle.description; - - public voidParle\RLexer::reset - intpos - - - Reinicializa el analizador léxico pasando opcionalmente la posición deseada. - - - - - &reftitle.parameters; - - - pos - - - La posición para reinicializar. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/rparser/advance.xml b/reference/parle/parle/rparser/advance.xml deleted file mode 100644 index 37985c9774..0000000000 --- a/reference/parle/parle/rparser/advance.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - Parle\RParser::advance - Procesa la regla siguiente del analizador - - - - &reftitle.description; - - public voidParle\RParser::advance - - - - Procesa la regla siguiente del analizador. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/rparser/build.xml b/reference/parle/parle/rparser/build.xml deleted file mode 100644 index 8dffb4998c..0000000000 --- a/reference/parle/parle/rparser/build.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - Parle\RParser::build - Finaliza las reglas de gramática - - - - &reftitle.description; - - public voidParle\RParser::build - - - - Cada token y regla de gramática previamente añadidos se finalizan. El conjunto de reglas se vuelve de solo lectura y el analizador está listo para iniciar. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/rparser/consume.xml b/reference/parle/parle/rparser/consume.xml deleted file mode 100644 index fa132c3eed..0000000000 --- a/reference/parle/parle/rparser/consume.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - Parle\RParser::consume - Consume los datos para el procesamiento - - - - &reftitle.description; - - public voidParle\RParser::consume - stringdata - Parle\RLexerrlexer - - - Consume los datos para el procesamiento. - - - - - &reftitle.parameters; - - - data - - - Los datos a analizar. - - - - - lexer - - - Un objeto lexer que contiene las reglas de análisis léxicas preparadas para la gramática particular. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/rparser/dump.xml b/reference/parle/parle/rparser/dump.xml deleted file mode 100644 index 26e2cf2fbf..0000000000 --- a/reference/parle/parle/rparser/dump.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - Parle\RParser::dump - Muestra la gramática - - - - &reftitle.description; - - public voidParle\RParser::dump - - - - Muestra la gramática actual en la salida estándar. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/rparser/errorinfo.xml b/reference/parle/parle/rparser/errorinfo.xml deleted file mode 100644 index ad353760f3..0000000000 --- a/reference/parle/parle/rparser/errorinfo.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - Parle\RParser::errorInfo - Recupera las informaciones de error - - - - &reftitle.description; - - public Parle\ErrorInfoParle\RParser::errorInfo - - - - Recupera las informaciones de error en el caso de que Parle\RParser::action hubiera devuelto la acción de error. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una instancia de Parle\ErrorInfo. - - - - - - diff --git a/reference/parle/parle/rparser/left.xml b/reference/parle/parle/rparser/left.xml deleted file mode 100644 index 8d4dc618c4..0000000000 --- a/reference/parle/parle/rparser/left.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Parle\RParser::left - Declara un token con asociatividad a la izquierda - - - - &reftitle.description; - - public voidParle\RParser::left - stringtok - - - Declara un token con asociatividad a la izquierda. - - - - - &reftitle.parameters; - - - tok - - - El nombre del token. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/rparser/nonassoc.xml b/reference/parle/parle/rparser/nonassoc.xml deleted file mode 100644 index 3d1fc9825b..0000000000 --- a/reference/parle/parle/rparser/nonassoc.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Parle\RParser::nonassoc - Declara un token sin asociatividad - - - - &reftitle.description; - - public voidParle\RParser::nonassoc - stringtok - - - Declara un token, que solo puede aparecer una vez en la línea. - - - - - &reftitle.parameters; - - - tok - - - El nombre del token. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/rparser/precedence.xml b/reference/parle/parle/rparser/precedence.xml deleted file mode 100644 index 0a2ea29e59..0000000000 --- a/reference/parle/parle/rparser/precedence.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Parle\RParser::precedence - Declara una regla de precedencia - - - - &reftitle.description; - - public voidParle\RParser::precedence - stringtok - - - Declara una regla de precedencia para un token ficticio. Esta regla puede ser utilizada más tarde en reglas de gramática específicas. - - - - - &reftitle.parameters; - - - tok - - - El token ficticio. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/rparser/push.xml b/reference/parle/parle/rparser/push.xml deleted file mode 100644 index 5b93494e78..0000000000 --- a/reference/parle/parle/rparser/push.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - Parle\RParser::push - Añade una regla de gramática - - - - &reftitle.description; - - public intParle\RParser::push - stringname - stringrule - - - Añade una regla de gramática. El identificador de producción devuelto puede ser utilizado más tarde en el proceso de análisis para identificar la regla correspondiente. - - - - - &reftitle.parameters; - - - name - - - El nombre de la regla. - - - - - rule - - - La regla a añadir. La sintaxis es compatible con Bison. - - - - - - - - &reftitle.returnvalues; - - Devuelve un &integer; representando el índice de la regla. - - - - - - diff --git a/reference/parle/parle/rparser/reset.xml b/reference/parle/parle/rparser/reset.xml deleted file mode 100644 index 922d969c4a..0000000000 --- a/reference/parle/parle/rparser/reset.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Parle\RParser::reset - Reinicializa el estado del analizador - - - - &reftitle.description; - - public voidParle\RParser::reset - inttokenId - - - Reinicializa el estado del analizador utilizando el identificador de token dado. - - - - - &reftitle.parameters; - - - tokenId - - - El identificador del token. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/rparser/right.xml b/reference/parle/parle/rparser/right.xml deleted file mode 100644 index 58c2fadc20..0000000000 --- a/reference/parle/parle/rparser/right.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Parle\RParser::right - Declara un token con asociatividad a la derecha - - - - &reftitle.description; - - public voidParle\RParser::right - stringtok - - - Declara un token con asociatividad a la derecha. - - - - - &reftitle.parameters; - - - tok - - - El nombre del token. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/rparser/sigil.xml b/reference/parle/parle/rparser/sigil.xml deleted file mode 100644 index eabaadb75c..0000000000 --- a/reference/parle/parle/rparser/sigil.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Parle\RParser::sigil - Recupera una parte correspondiente de una regla - - - - &reftitle.description; - - public stringParle\RParser::sigil - intidx - - - Recupera una parte correspondiente de una regla. Este método es equivalente a la funcionalidad de pseudo-variable en Bison. - - - - - &reftitle.parameters; - - - idx - - - El identificador de correspondencia, basado en cero. - - - - - - - - &reftitle.returnvalues; - - Devuelve una &string; con la parte correspondiente. - - - - - - diff --git a/reference/parle/parle/rparser/sigilcount.xml b/reference/parle/parle/rparser/sigilcount.xml deleted file mode 100644 index e9fc9cbb55..0000000000 --- a/reference/parle/parle/rparser/sigilcount.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - Parle\RParser::sigilCount - Número de elementos en la regla correspondiente - - - - &reftitle.description; - - public intParle\RParser::sigilCount - - - - Devuelve el número de elementos en la regla correspondiente. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un &integer; - - - - - - diff --git a/reference/parle/parle/rparser/sigilname.xml b/reference/parle/parle/rparser/sigilname.xml deleted file mode 100644 index 934f45c959..0000000000 --- a/reference/parle/parle/rparser/sigilname.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Parle\RParser::sigilName - Recupera un nombre de regla o de token - - - - &reftitle.description; - - public stringParle\RParser::sigilName - intidx - - - Recupera un nombre de regla parcial o de token correspondiente al índice de sigil. - - - - - &reftitle.parameters; - - - idx - - - El identificador de correspondencia, basado en cero. - - - - - - - - &reftitle.returnvalues; - - Devuelve una &string; con la parte correspondiente. - - - - - - diff --git a/reference/parle/parle/rparser/token.xml b/reference/parle/parle/rparser/token.xml deleted file mode 100644 index ecf3027dc0..0000000000 --- a/reference/parle/parle/rparser/token.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Parle\RParser::token - Declara un token - - - - &reftitle.description; - - public voidParle\RParser::token - stringtok - - - Declara un token para usar en la gramática. - - - - - &reftitle.parameters; - - - tok - - - El nombre del token. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/rparser/tokenid.xml b/reference/parle/parle/rparser/tokenid.xml deleted file mode 100644 index 71a2b3be88..0000000000 --- a/reference/parle/parle/rparser/tokenid.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Parle\RParser::tokenId - Devuelve el identificador del token - - - - &reftitle.description; - - public intParle\RParser::tokenId - stringtok - - - Devuelve el identificador del token nombrado. - - - - - &reftitle.parameters; - - - tok - - - El nombre utilizado en Parle\RParser::token. - - - - - - - - &reftitle.returnvalues; - - Devuelve un &integer; que representa el identificador del token. - - - - - - diff --git a/reference/parle/parle/rparser/trace.xml b/reference/parle/parle/rparser/trace.xml deleted file mode 100644 index 5920472c3e..0000000000 --- a/reference/parle/parle/rparser/trace.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - Parle\RParser::trace - Rastrea la operación del analizador - - - - &reftitle.description; - - public stringParle\RParser::trace - - - - Recupera la descripción de la operación del analizador en curso. Esto puede ser particularmente útil para estudiar el analizador y optimizar la gramática. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un &string; con la información de rastreo. - - - - - - diff --git a/reference/parle/parle/rparser/validate.xml b/reference/parle/parle/rparser/validate.xml deleted file mode 100644 index bf03e3ec41..0000000000 --- a/reference/parle/parle/rparser/validate.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - Parle\RParser::validate - Valida una entrada - - - - &reftitle.description; - - public boolParle\RParser::validate - stringdata - Parle\RLexerlexer - - - Valida una cadena de entrada. La cadena es analizada internamente, por lo que este método es útil para la validación rápida de la entrada. - - - - - &reftitle.parameters; - - - data - - - La cadena a validar. - - - - - lexer - - - Un objeto lexer que contiene las reglas de análisis lexical preparadas para la gramática particular. - - - - - - - - &reftitle.returnvalues; - - Devuelve un &boolean; que indica si la entrada cumple o no con las reglas definidas. - - - - - - diff --git a/reference/parle/parle/stack/pop.xml b/reference/parle/parle/stack/pop.xml deleted file mode 100644 index 14864e77bc..0000000000 --- a/reference/parle/parle/stack/pop.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - Parle\Stack::pop - Extrae un elemento de la pila - - - - &reftitle.description; - - public voidParle\Stack::pop - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/parle/stack/push.xml b/reference/parle/parle/stack/push.xml deleted file mode 100644 index 09edfdaefa..0000000000 --- a/reference/parle/parle/stack/push.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Parle\Stack::push - Añade un elemento a la pila - - - - &reftitle.description; - - public voidParle\Stack::push - mixeditem - - - - - - - - &reftitle.parameters; - - - item - - - La variable a añadir. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/parle/pattern.matching.xml b/reference/parle/pattern.matching.xml deleted file mode 100644 index 675cbc7bd4..0000000000 --- a/reference/parle/pattern.matching.xml +++ /dev/null @@ -1,412 +0,0 @@ - - - - - Correspondencia de patrón Parle - Correspondencia de patrón - - Parle soporta la correspondencia de patrón con expresiones regulares similares a flex. - Los siguientes conjuntos de caracteres POSIX también son soportados: - - [:alnum:] - [:alpha:] - [:blank:] - [:cntrl:] - [:digit:] - [:graph:] - [:lower:] - [:print:] - [:punct:] - [:space:] - [:upper:] - [:xdigit:] - . - - - Las clases de caracteres Unicode no están actualmente activadas por omisión, pase --enable-parle-utf32 para hacerlas disponibles. - Una codificación particular puede ser mapeada con una regex correctamente construida. - Por ejemplo, para corresponder al símbolo EURO codificado en UTF-8, la expresión regular [\xe2][\x82][\xac] puede ser utilizada. - El patrón para una cadena codificada en UTF-8 podría ser [ -\x7f]{+}[\x80-\xbf]{+}[\xc2-\xdf]{+}[\xe0-\xef]{+}[\xf0-\xff]+. - - -
    - Representación de caracteres - - - Representación de caracteres - - - - SecuenciaDescripción - - - - - \aAlerta (campana). - - - \bRetroceso (Backspace). - - - \eCarácter ESC, \x1b. - - - \nNueva línea. - - - \rRetorno de carro. - - - \fSalto de página, \x0c. - - - \tTabulación horizontal, \x09. - - - \vTabulación vertical, \x0b. - - - \octCarácter especificado por un código octal de tres dígitos. - - - \xhexCarácter especificado por un código hexadecimal. - - - \ccharCarácter de control nombrado. - - - -
    -
    -
    -
    - Clases de caracteres - - - Clases de caracteres - - - - SecuenciaDescripción - - - - - [...]Un solo carácter listado o contenido en un rango listado. Los rangos pueden ser combinados con los operadores {+} y {-}. Por ejemplo [a-z]{+}[0-9] es lo mismo que [0-9a-z] y [a-z]{-}[aeiou] es lo mismo que [b-df-hj-np-tv-z]. - - - [^...]Un solo carácter no listado y no contenido en un rango listado. - - - .Cualquier carácter, por omisión [^\n]. - - - \dCarácter numérico, [0-9]. - - - \DCarácter no numérico, [^0-9]. - - - \sCarácter de espacio en blanco, [ \t\n\r\f\v]. - - - \SCarácter no de espacio en blanco, [^ \t\n\r\f\v]. - - - \wCarácter de palabra, [a-zA-Z0-9_]. - - - \WCarácter de no palabra, [^a-zA-Z0-9_]. - - - -
    -
    -
    -
    - Clases de caracteres Unicode - - - Clases de caracteres Unicode - - - - SecuenciaDescripción - - - - - \p{C}Otro. - - - \p{Cc}Otro, control. - - - \p{Cf}Otro, formato. - - - \p{Co}Otro, uso privado. - - - \p{Cs}Otro, sustituto. - - - \p{L}Letra. - - - \p{LC}Letra, con casos. - - - \p{Ll}Letra, minúscula. - - - \p{Lm}Letra, modificada. - - - \p{Lo}Letra, otra. - - - \p{Lt}Letra, de título. - - - \p{Lu}Letra, mayúscula. - - - \p{M}Marca. - - - \p{Mc}Marca, espacio combinado. - - - \p{Me}Marca, encuadre. - - - \p{Mn}Marca, no espaciada. - - - \p{N}Número. - - - \p{Nd}Número, dígito decimal. - - - \p{Nl}Número, letra. - - - \p{No}Número, otro. - - - \p{P}Puntuación. - - - \p{Pc}Puntuación, conector. - - - \p{Pd}Puntuación, guion. - - - \p{Pe}Puntuación, cierre. - - - \p{Pf}Puntuación, comilla final. - - - \p{Pi}Puntuación, comilla inicial. - - - \p{Po}Puntuación, otra. - - - \p{Ps}Puntuación, apertura. - - - \p{S}Símbolo. - - - \p{Sc}Símbolo, moneda. - - - \p{Sk}Símbolo, modificado. - - - \p{Sm}Símbolo, matemático. - - - \p{So}Símbolo, otro. - - - \p{Z}Separador. - - - \p{Zl}Separador, línea. - - - \p{Zp}Separador, párrafo. - - - \p{Zs}Separador, espacio. - - - -
    -
    - - Estas clases de caracteres solo están disponibles si la opción --enable-parle-utf32 ha sido pasada durante la compilación. - -
    -
    - Alternancia y repetición - - - Alternancia y repetición - - - - SecuenciaVorazDescripción - - - - - ...|...-Probar los subpatrones en alternancia. - - - *síCorresponde 0 o más veces. - - - +síCorresponde 1 o más veces. - - - ?síCorresponde 0 o 1 vez. - - - {n}noCorresponde exactamente n veces. - - - {n,}noCorresponde al menos n veces. - - - {n,m}síCorresponde al menos n veces pero no más de m veces. - - - *?noCorresponde 0 o más veces. - - - +?noCorresponde 1 o más veces. - - - ??noCorresponde 0 o 1 vez. - - - {n,}?noCorresponde al menos n veces. - - - {n,m}?noCorresponde al menos n veces pero no más de m veces. - - - {MACRO}-Incluye la regex MACRO en la regex actual. - - - -
    -
    -
    -
    - Ancla - - - Ancla - - - - SecuenciaDescripción - - - - - ^Comienza por una cadena o después de un retorno de línea. - - - $Termina por una cadena o antes de un retorno de línea. - - - -
    -
    -
    -
    - Agrupamiento - - - Agrupamiento - - - - Secuencia - Descripción - - - - - (...) - Agrupa una expresión regular para modificar el orden de evaluación. - - - (?r-s:pattern) - - - Aplica la opción r y omite la opción s al interpretar el patrón. - Las opciones pueden ser cero o más de los caracteres i, s o x. - - - i significa insensible a mayúsculas y minúsculas. - - - -i significa sensible a mayúsculas y minúsculas. - - - s modifica el significado de . para que corresponda a cualquier carácter. - - - -s modifica el significado de . para que corresponda a cualquier carácter excepto \n. - - - x ignora los comentarios y los espacios en los patrones. - Los espacios son ignorados excepto si están escapados por una barra invertida, contenidos en ""s, - o aparecen dentro de un rango de caracteres. - - - Estas opciones pueden ser aplicadas globalmente al nivel de las reglas pasando una combinación de los indicadores de bits al analizador léxico. - - - - - (?# comment ) - Omite todo lo que está en (). El primer carácter ) encontrado termina el patrón. No es posible para el comentario contener un carácter ). El comentario puede extenderse sobre varias líneas. - - - -
    -
    -
    -
    - - diff --git a/reference/parle/setup.xml b/reference/parle/setup.xml deleted file mode 100644 index c2263414ca..0000000000 --- a/reference/parle/setup.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - PHP 7.4 o superior es soportado. - Un compilador C++14 es necesario. Una compilación exitosa de la extensión - ha sido realizada con, al menos, clang 5.0, GCC 5.0 y Visual Studio 2015. - -
    - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;parle. - - - - Opciones de configuración disponibles - - - - OpciónDescripción - - - - - --enable-parleActivación de la extensión parle. - - - --enable-parle-utf32Activación del soporte interno UTF-32. Disponible desde parle 0.7.2. - - - -
    -
    -
    - - - -
    - - diff --git a/reference/pdo/drivers.xml b/reference/pdo/drivers.xml index d9fce7bc69..cea426f6fa 100644 --- a/reference/pdo/drivers.xml +++ b/reference/pdo/drivers.xml @@ -20,7 +20,7 @@ - PDO_CUBRID + PDO_CUBRID Cubrid @@ -32,11 +32,11 @@ Firebird - PDO_IBM + PDO_IBM IBM DB2 - PDO_INFORMIX + PDO_INFORMIX IBM Informix Dynamic Server @@ -60,7 +60,7 @@ SQLite 3 y SQLite 2 - PDO_SQLSRV + PDO_SQLSRV Microsoft SQL Server / SQL Azure @@ -69,16 +69,12 @@ - &reference.pdo-cubrid.reference; &reference.pdo-dblib.reference; &reference.pdo-dblib.pdo-dblib; &reference.pdo-firebird.reference; &reference.pdo-firebird.pdo-firebird; - &reference.pdo-ibm.reference; - &reference.pdo-informix.reference; &reference.pdo-mysql.reference; &reference.pdo-mysql.pdo-mysql; - &reference.pdo-sqlsrv.reference; &reference.pdo-oci.reference; &reference.pdo-odbc.reference; &reference.pdo-odbc.pdo-odbc; diff --git a/reference/pdo_cubrid/configure.xml b/reference/pdo_cubrid/configure.xml deleted file mode 100644 index fd832b15b9..0000000000 --- a/reference/pdo_cubrid/configure.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - -
    - &reftitle.install; - - Para construir la extensión PDO_CUBRID, el sistema de gestión de bases de datos CUBRID debe estar instalado - en el mismo sistema que PHP. - - PDO_CUBRID es una extensión &link.pecl;, - por lo tanto, debe seguirse las instrucciones de para - instalar la extensión PDO_CUBRID. Ejecute el comando configure - para localizar el directorio base de CUBRID de la siguiente manera: - - - - El comando configure tomará por omisión el valor de la - variable de entorno CUBRID. - - - &pecl.windows.download; - Información sobre la instalación manual en Linux y Windows puede encontrarse en el archivo build-guide.html del paquete CUBRID de PECL. - -
    - diff --git a/reference/pdo_cubrid/constants.xml b/reference/pdo_cubrid/constants.xml deleted file mode 100644 index 1aa3e4a313..0000000000 --- a/reference/pdo_cubrid/constants.xml +++ /dev/null @@ -1,222 +0,0 @@ - - - - -
    - &reftitle.constants; - &pdo.driver-constants; - - Las constantes siguientes pueden ser utilizadas para configurar los atributos - de la base de datos. Pueden ser pasadas al método - PDO::getAttribute o al método - PDO::setAttribute. - - Banderas para los atributos PDO::CUBRID - - - - Constante - Descripción - - - - - PDO::CUBRID_ATTR_ISOLATION_LEVEL - El nivel de aislamiento de la transacción para la conexión a la base de datos. - - - PDO::CUBRID_ATTR_LOCK_TIMEOUT - Tiempo de expiración de la transacción en segundos. - - - PDO::CUBRID_ATTR_MAX_STRING_LENGTH - Solo lectura. La longitud máxima del string para los - tipos de datos bit, varbit, char, varchar, nchar, nvarchar - al utilizar la API CUBRID PDO. - - - -
    -
    - - - Las constantes siguientes pueden ser utilizadas al configurar - el nivel de aislamiento de la transacción. Pueden ser pasadas al - método PDO::getAttribute o al método - PDO::setAttribute. - - Banderas para el nivel de aislamiento PDO::CUBRID - - - - Constante - Descripción - - - - - PDO::TRAN_COMMIT_CLASS_UNCOMMIT_INSTANCE - El nivel de aislamiento más bajo (1). Una lectura - no fiable, no reproducible o fantasma puede ocurrir sobre - el tuple, pero también una lectura no reproducible puede - ocurrir para la tabla. - - - PDO::TRAN_COMMIT_CLASS_COMMIT_INSTANCE - Un nivel de aislamiento relativamente bajo (2). Una lectura - no fiable no puede ocurrir, pero una lectura - no reproducible o fantasma puede ocurrir. - - - PDO::TRAN_REP_CLASS_UNCOMMIT_INSTANCE - El nivel de aislamiento por defecto para CUBRID (3). - Una lectura no fiable o fantasma puede ocurrir sobre el tuple, - pero la reproducibilidad de la lectura está asegurada sobre la tabla. - - - PDO::TRAN_REP_CLASS_COMMIT_INSTANCE - Un nivel de aislamiento relativamente bajo (4). Una lectura - no fiable no puede ocurrir, pero las lecturas no reproducibles - o fantasma pueden ocurrir. - - - PDO::TRAN_REP_CLASS_REP_INSTANCE - Un nivel de aislamiento relativamente alto (5). Las - lecturas no fiables o no reproducibles no pueden - ocurrir, pero una lectura fantasma es posible. - - - PDO::TRAN_SERIALIZABLE - El nivel de aislamiento más alto (6). Los problemas - relacionados con la concurrencia (i.e. lectura no fiable, lectura - no reproducible, lectura fantasma, etc...) no pueden ocurrir. - - - -
    -
    - - - Las constantes siguientes pueden ser utilizadas para recuperar - la información sobre el esquema. Pueden ser pasadas - a la función PDO::cubrid_schema. - - Banderas para el esquema CUBRID - - - - Constante - Descripción - - - - - PDO::CUBRID_SCH_TABLE - Recupera el nombre y el tipo de tabla CUBRID. - - - PDO::CUBRID_SCH_VIEW - Recupera el nombre y el tipo de vista en CUBRID. - - - PDO::CUBRID_SCH_QUERY_SPEC - Recupera la definición de la consulta de la vista. - - - PDO::CUBRID_SCH_ATTRIBUTE - Recupera los atributos de la columna de la tabla. - - - PDO::CUBRID_SCH_TABLE_ATTRIBUTE - Recupera los atributos de la tabla. - - - PDO::CUBRID_SCH_METHOD - Recupera el método de la instancia. Es un método llamado - por la instancia de la clase. Se utiliza más a menudo que el - método de la clase ya que la mayoría de las operaciones se ejecutan - en la instancia. - - - PDO::CUBRID_SCH_TABLE_METHOD - Recupera el método de la clase. Es un método llamado - por un objeto de la clase. Se utiliza habitualmente - para crear una nueva instancia de la clase o para inicializarla. - También se utiliza para acceder o actualizar los atributos - de la clase. - - - PDO::CUBRID_SCH_METHOD_FILE - Recupera la información sobre el archivo donde el método de la tabla - está definido. - - - PDO::CUBRID_SCH_SUPER_TABLE - Recupera el nombre y el tipo de la tabla de la que los atributos heredan. - - - PDO::CUBRID_SCH_SUB_TABLE - Recupera el nombre y el tipo de la tabla de la que los atributos heredan. - - - PDO::CUBRID_SCH_CONSTRAINT - Recupera las restricciones de la tabla. - - - PDO::CUBRID_SCH_TRIGGER - Recupera los triggers de la tabla. - - - PDO::CUBRID_SCH_TABLE_PRIVILEGE - Recupera la información sobre los privilegios de la tabla. - - - PDO::CUBRID_SCH_COL_PRIVILEGE - Recupera la información sobre los privilegios de una columna. - - - PDO::CUBRID_SCH_DIRECT_SUPER_TABLE - Recupera la tabla directamente superior a la tabla. - - - PDO::CUBRID_SCH_PRIMARY_KEY - Recupera la clave primaria de la tabla. - - - PDO::CUBRID_SCH_IMPORTED_KEYS - Recupera las claves importadas de una tabla. - - - PDO::CUBRID_SCH_EXPORTED_KEYS - Recupera las claves exportadas de una tabla. - - - PDO::CUBRID_SCH_CROSS_REFERENCE - Recupera las relaciones de referencia entre 2 tablas. - - - -
    -
    -
    - - diff --git a/reference/pdo_cubrid/pdo_overloaded/cubrid-schema.xml b/reference/pdo_cubrid/pdo_overloaded/cubrid-schema.xml deleted file mode 100644 index 6e31c38251..0000000000 --- a/reference/pdo_cubrid/pdo_overloaded/cubrid-schema.xml +++ /dev/null @@ -1,550 +0,0 @@ - - - - - - - PDO::cubrid_schema - Recupera el esquema de información solicitado - - - &reftitle.description; - - public arrayPDO::cubrid_schema - intschema_type - stringtable_name - stringcol_name - - - Esta función se utiliza para recuperar el esquema de información solicitado desde - la base de datos. - Debe designarse el argumento table_name, - si se desea recuperar las informaciones de una cierta tabla, el - argumento col_name, si se desea recuperar las informaciones - de una cierta columna (solo puede ser utilizado con - PDO::CUBRID_SCH_COL_PRIVILEGE). - - - - El resultado de esta función es devuelto en forma de un array - de 2 dimensiones (columna(array asociativo) * fila (array numérico)). - Las tablas siguientes muestran los tipos de esquema y la estructura de la columna - del array resultante. - - - - Composición del resultado para cada tipo - - - - Esquema - Número de la columna - Nombre de la columna - Valor - - - - - PDO::CUBRID_SCH_TABLE - 1 - NAME - - - - - 2 - TYPE - 0:tabla del sistema 1:vista 2:tabla - - - - PDO::CUBRID_SCH_VIEW - 1 - NAME - - - - - 2 - TYPE - 1:vista - - - - PDO::CUBRID_SCH_QUERY_SPEC - 1 - QUERY_SPEC - - - - - PDO::CUBRID_SCH_ATTRIBUTE / PDO::CUBRID_SCH_TABLE_ATTRIBUTE - 1 - ATTR_NAME - - - - - 2 - DOMAIN - - - - - 3 - SCALE - - - - - 4 - PRECISION - - - - - 5 - INDEXED - 1:indexado - - - - 6 - NOT NULL - 1:no nulo - - - - 7 - SHARED - 1:compartido - - - - 8 - UNIQUE - 1:único - - - - 9 - DEFAULT - - - - - 10 - ATTR_ORDER - base:1 - - - - 11 - CLASS_NAME - - - - - 12 - SOURCE_CLASS - - - - - 13 - IS_KEY - 1:clave - - - - PDO::CUBRID_SCH_METHOD / PDO::CUBRID_SCH_TABLE_METHOD - 1 - NAME - - - - - 2 - RET_DOMAIN - - - - - 3 - ARG_DOMAIN - - - - - PDO::CUBRID_SCH_METHOD_FILE - 1 - METHOD_FILE - - - - - PDO::CUBRID_SCH_SUPER_TABLE / PDO::CUBRID_SCH_DIRECT_SUPER_TABLE / PDO::CUBRID_SCH_SUB_TABLE - 1 - CLASS_NAME - - - - - 2 - TYPE - 0:tabla del sistema 1:vista 2:tabla - - - - PDO::CUBRID_SCH_CONSTRAINT - 1 - TYPE - 0:único 1:índice 2:único inverso 3:índice inverso - - - - 2 - NAME - - - - - 3 - ATTR_NAME - - - - - 4 - NUM_PAGES - - - - - 5 - NUM_KEYS - - - - - 6 - PRIMARY_KEY - 1:clave primaria - - - - 7 - KEY_ORDER - base:1 - - - - PDO::CUBRID_SCH_TRIGGER - 1 - NAME - - - - - 2 - STATUS - - - - - 3 - EVENT - - - - - 4 - TARGET_CLASS - - - - - 5 - TARGET_ATTR - - - - - 6 - ACTION_TIME - - - - - 7 - ACTION - - - - - 8 - PRIORITY - - - - - 9 - CONDITION_TIME - - - - - 10 - CONDITION - - - - - PDO::CUBRID_SCH_TABLE_PRIVILEGE / PDO::CUBRID_SCH_COL_PRIVILEGE - 1 - CLASS_NAME / ATTR_NAME - - - - - 2 - PRIVILEGE - - - - - 3 - GRANTABLE - - - - - PDO::CUBRID_SCH_PRIMARY_KEY - 1 - CLASS_NAME - - - - - 2 - ATTR_NAME - - - - - 3 - KEY_SEQ - base:1 - - - - 4 - KEY_NAME - - - - - PDO::CUBRID_SCH_IMPORTED_KEYS / PDO::CUBRID_SCH_EXPORTED_KEYS / PDO::CUBRID_SCH_CROSS_REFERENCE - 1 - PKTABLE_NAME - - - - - 2 - PKCOLUMN_NAME - - - - - 3 - FKTABLE_NAME - base:1 - - - - 4 - FKCOLUMN_NAME - - - - - 5 - KEY_SEQ - base:1 - - - - 6 - UPDATE_ACTION - 0:cascada 1:restringir 2:sin acción 3:establecer nulo - - - - 7 - DELETE_ACTION - 0:cascada 1:restringir 2:sin acción 3:establecer nulo - - - - 8 - FK_NAME - - - - - 9 - PK_NAME - - - - -
    - -
    - - &reftitle.parameters; - - - schema_type - - - El tipo de esquema que se desea recuperar. - - - - - table_name - - - La tabla de la cual se desea recuperar el esquema. - - - - - col_name - - - La columna de la cual se desea recuperar el esquema. - - - - - - - - &reftitle.returnvalues; - - Un array que contiene las informaciones relativas al esquema, cuando el - proceso se ha ejecutado con éxito. - - - FALSE será devuelto si ocurre un error. - - - - - &reftitle.examples; - - Ejemplo con <function>PDO::cubrid_schema</function> - - Este ejemplo muestra cómo recuperar las claves primarias y extranjeras - de la tabla "game". - - -cubrid_schema(PDO::CUBRID_SCH_PRIMARY_KEY, "game"); -print_r($pk_list); - -$fk_list = $dbh->cubrid_schema(PDO::CUBRID_SCH_IMPORTED_KEYS, "game"); -print_r($fk_list); -?> -]]> - - &example.outputs; - - Array - ( - [CLASS_NAME] => game - [ATTR_NAME] => athlete_code - [KEY_SEQ] => 3 - [KEY_NAME] => pk_game_host_year_event_code_athlete_code - ) - - [1] => Array - ( - [CLASS_NAME] => game - [ATTR_NAME] => event_code - [KEY_SEQ] => 2 - [KEY_NAME] => pk_game_host_year_event_code_athlete_code - ) - - [2] => Array - ( - [CLASS_NAME] => game - [ATTR_NAME] => host_year - [KEY_SEQ] => 1 - [KEY_NAME] => pk_game_host_year_event_code_athlete_code - ) - -) -Array -( - [0] => Array - ( - [PKTABLE_NAME] => athlete - [PKCOLUMN_NAME] => code - [FKTABLE_NAME] => game - [FKCOLUMN_NAME] => athlete_code - [KEY_SEQ] => 1 - [UPDATE_RULE] => 1 - [DELETE_RULE] => 1 - [FK_NAME] => fk_game_athlete_code - [PK_NAME] => pk_athlete_code - ) - - [1] => Array - ( - [PKTABLE_NAME] => event - [PKCOLUMN_NAME] => code - [FKTABLE_NAME] => game - [FKCOLUMN_NAME] => event_code - [KEY_SEQ] => 1 - [UPDATE_RULE] => 1 - [DELETE_RULE] => 1 - [FK_NAME] => fk_game_event_code - [PK_NAME] => pk_event_code - ) - -) -]]> - - - - -
    - diff --git a/reference/pdo_cubrid/reference.xml b/reference/pdo_cubrid/reference.xml deleted file mode 100644 index 0784bfb24b..0000000000 --- a/reference/pdo_cubrid/reference.xml +++ /dev/null @@ -1,335 +0,0 @@ - - - - - Funciones del controlador PDO CUBRID (PDO_CUBRID) - Controlador PDO CUBRID - - -
    &reftitle.intro; - - PDO_CUBRID es un controlador que implementa la - interfaz PHP Data Objects (PDO) - para permitir el acceso desde PHP a las bases de datos CUBRID. - - - La versión actual de PDO_CUBRID no soporta la conexión persistente en este momento. - -
    - - - &reference.pdo-cubrid.configure; - -
    - Características de PDO_CUBRID - -
    - Cursores desplazables - - PDO_CUBRID soporta los cursores desplazables. El tipo de cursor por omisión es - de solo avance, y se puede utilizar el argumento driver_options en - PDO::prepare para cambiar el tipo de cursor. - -
    - -
    - Tiempo límite - - PDO_CUBRID soporta la configuración del tiempo límite de ejecución de la instrucción SQL; - se puede utilizar PDO::setAttribute para definir el valor del tiempo límite. - -
    - -
    - Modo autocommit y transacción - - - PDO_CUBRID soporta tanto el modo autocommit como la transacción, y - el modo autocommit está activado por omisión. Se puede utilizar - PDO::setAttribute para cambiar su estado. - - - - Si se utiliza PDO::beginTransaction para comenzar una - transacción, esto desactivará automáticamente el modo autocommit y - lo restaurará después de PDO::commit o - PDO::rollBack. - - - - - Antes de desactivar el modo autocommit, - todo trabajo pendiente es validado automáticamente. - - -
    - -
    - Instrucciones SQL múltiples - - - PDO_CUBRID soporta las instrucciones SQL múltiples. - Las instrucciones SQL múltiples están separadas por puntos y coma (;). - -
    - -
    - Información sobre el esquema - - - PDO_CUBRID implementa PDO::cubrid_schema - para obtener información sobre el esquema. - -
    - -
    - LOBs - - - PDO_CUBRID soporta los tipos de datos BLOB/CLOB. El LOB en PDO es - representado como un flujo, por lo que se pueden insertar LOBs vinculando un flujo, - y obtener LOBs leyendo un flujo devuelto por CUBRID PDO. - Por ejemplo: - - - - Insertar LOBs en CUBRID PDO - -prepare($sql_stmt); -$ret = $stmt->bindParam(1, $fp, PDO::PARAM_LOB); -$ret = $stmt->execute(); -?> -]]> - - - - - Recuperar LOBs en CUBRID PDO - -prepare($sql_stmt); -$stmt->execute(); -$result = $stmt->fetch(PDO::FETCH_NUM); - -header("Content-Type: image/png"); -fpassthru($result[0]); -?> -]]> - - -
    - -
    - Meta-columna - - - El método PDOStatement::getColumnMeta en CUBRID PDO - devolverá un array asociativo que contiene los siguientes valores: - - type - name - table - def - precision - scale - not_null - auto_increment - unique_key - multiple_key - primary_key - foreign_key - reverse_index - reverse_unique - - -
    -
    - Tipo de datos Colección - - - PDO_CUBRID soporta los tipos de datos SET/MULTISET/SEQUENCE. - Si no se especifica el tipo de datos, el tipo de datos por omisión es char. - Por ejemplo: - - - - Insertar un conjunto en CUBRID PDO con el tipo de datos por omisión. - -exec("DROP TABLE if exists test_tbl"); -$cubrid_pdo->exec("CREATE TABLE test_tbl (col_1 SET(VARCHAR))"); - -$sql_stmt_insert = "INSERT INTO test_tbl VALUES (?);"; -$stmt = $cubrid_pdo->prepare($sql_stmt_insert); -$data = array("abc","def","ghi"); -$ret = $stmt->bindParam(1, $data, PDO::PARAM_NULL); -$ret = $stmt->execute(); -var_Dump($ret); -?> -]]> - - - - - Especificar el tipo de datos al insertar un conjunto en CUBRID PDO - -exec("DROP TABLE if exists test_tbl"); -$cubrid_pdo->exec("CREATE TABLE test_tbl (col_1 SET(int))"); - -$sql_stmt_insert = "INSERT INTO test_tbl VALUES (?);"; -$stmt = $cubrid_pdo->prepare($sql_stmt_insert); -$data = array(1,2,3,4); -$ret = $stmt->bindParam(1, $data, 0,0,"int"); -$ret = $stmt->execute(); -var_Dump($ret); -?> -]]> - - - - - Tipos de datos de enlace CUBRID para el quinto argumento de - PDOStatement::bindParam: - - CHAR - STRING - NCHAR - VARNCHAR - BIT - VARBIT - NUMERIC - NUMBER - INT - SHORT - BIGINT - MONETARY - FLOAT - DOUBLE - DATE - TIME - DATETIME - TIMESTAMP - - -
    -
    - - - &reference.pdo-cubrid.constants; - -
    - - - - DSN PDO_CUBRID - Conexión a las bases de datos CUBRID - - - - &reftitle.description; - - El DSN PDO_CUBRID está compuesto por los siguientes elementos, delimitados por un punto y coma: - - - prefijo DSN - - - El prefijo DSN es cubrid:. - - - - - host - - - El nombre de host donde se encuentra el servidor de base de datos. - - - - - port - - - El puerto en el que funciona el servidor de base de datos. - - - - - dbname - - - El nombre de la base de datos. - - - - - - - - - &reftitle.notes; - - - Al establecer la conexión a CUBRID, se debe proporcionar el nombre de - usuario y la contraseña, pero no el DSN. - - - - - - &reftitle.examples; - - Ejemplos de DSN PDO_CUBRID - - El siguiente ejemplo muestra un DSN PDO_CUBRID para una conexión a una base de datos CUBRID: - - - - - - - - - &reference.pdo-cubrid.entities.pdo-overloaded; - -
    - diff --git a/reference/pdo_ibm/configure.xml b/reference/pdo_ibm/configure.xml deleted file mode 100644 index 106325d075..0000000000 --- a/reference/pdo_ibm/configure.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - -
    - &reftitle.install; - - Para compilar la extensión PDO_IBM, el cliente DB2 v9.1 o superior debe ser - instalado en el mismo sistema que PHP. El cliente DB2 puede ser descargado - desde el sitio de IBM de desarrollo - de aplicaciones. - - - Nota - - El cliente DB2 v9.1 o superior soporta los accesos directos a DB2 - para los sistemas Linux, UNIX y los servidores Windows v8 y v9.1. - - - El cliente DB2 v9.1 soporta asimismo los accesos a DB2 UDB para i5 - y DB2 UDB para los servidores z/OS utilizando el - producto de conexión DB2 de pago. - - - - PDO_IBM es una extensión &link.pecl;; - por lo tanto, las instrucciones de - deben ser seguidas para instalar la extensión PDO_IBM. Ejecute el comando - configure para que apunte hacia el directorio - que contiene los ficheros de encabezado y las bibliotecas del - cliente DB2 de la siguiente manera: - - - - El comando configure utiliza por omisión - el valor de la variable de entorno DB2DIR. - -
    - - diff --git a/reference/pdo_ibm/ini.xml b/reference/pdo_ibm/ini.xml deleted file mode 100644 index 0737110003..0000000000 --- a/reference/pdo_ibm/ini.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - - Opciones de configuración PDO_IBM - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - pdo_ibm.i5_dbcs_alloc - "0" - INI_SYSTEM - Añadido en PDO_IBM 1.5.0 - - - pdo_ibm.i5_override_ccsid - "0" - INI_SYSTEM - Añadido en PDO_IBM 1.5.0 - - - -
    - &ini.php.constants; -
    - -&ini.descriptions.title; - - - - - - pdo_ibm.i5_dbcs_alloc - int - - - - Esta opción afecta a la estrategia de asignación de memoria interna en IBM i. - Por omisión, esta opción es 0. Cuando esta opción está definida, se asignan - búferes con un tamaño mucho mayor, por si la base de datos engañara sobre el - tamaño de los caracteres durante la conversión entre codificaciones. Esta opción - utiliza seis veces más memoria para los búferes (para tener en cuenta las secuencias - UTF-8 más largas), pero puede ser necesaria si se devuelven datos truncados. - - - - 0 - Se asigna el tamaño mínimo de los búferes. - - - - - 1 - Se asigna un tamaño mayor de los búferes. - - - - - - - - - pdo_ibm.i5_override_ccsid - int - - - - El CCSID ASCII a utilizar para la conversión de EBCDIC en IBM i. Al definirlo - como 1208, se utilizará UTF-8. Por omisión es 0, lo que seleccionará el CCSID - ASCII de trabajo predeterminado. - - - Para obtener más información sobre los CCSID en IBM i, consulte la - documentación de IBM. - - - - - -
    - - diff --git a/reference/pdo_ibm/reference.xml b/reference/pdo_ibm/reference.xml deleted file mode 100644 index ac72bba810..0000000000 --- a/reference/pdo_ibm/reference.xml +++ /dev/null @@ -1,183 +0,0 @@ - - - - - - - - Funciones del controlador PDO IBM (PDO_IBM) - Controlador PDO IBM - - -
    - &reftitle.intro; - - PDO_IBM es un driver que implementa la interfaz PHP Data - Objects (PDO) para habilitar el acceso - desde PHP a las bases de datos IBM. - -
    - - - &reference.pdo-ibm.configure; - - &reference.pdo-ibm.ini; - -
    - - - - PDO_IBM DSN - Conexión a las bases de datos IBM - - - - &reftitle.description; - - El nombre de la fuente de datos PDO_IBM (DSN) se basa en el IBM CLI DSN. - Los componentes principales de PDO_IBM DSN son : - - - Prefijo DSN - - - El prefijo DSN es ibm:. - - - - - DSN - - - El DSN puede ser uno de los siguientes : - - - - a) Configuración de la fuente de datos utilizando el archivo - db2cli.ini - o odbc.ini - - - - - b) Nombre de base de datos catalogado, es decir, alias de base de datos contenidos en - el catálogo del cliente DB2 - - - - - c) Cadena de conexión completa en el siguiente formato : - DRIVER={IBM DB2 ODBC DRIVER};DATABASE=database;HOSTNAME=hostname;PORT=port;PROTOCOL=TCPIP;UID=username;PWD=password; - donde los parámetros representan los siguientes valores : - - - database - - - El nombre de la base de datos. - - - - - hostname - - - El nombre del host o la dirección IP del servidor de base de datos. - - - - - port - - - El puerto TCP/IP en el que la base de datos escucha las consultas. - - - - - username - - - El nombre de usuario utilizado para la conexión a la base de datos. - - - - - password - - - La contraseña utilizada para la conexión a la base de datos. - - - - - - - - - - - - - - - &reftitle.examples; - - - Ejemplo con PDO_IBM DSN utilizando <filename>db2cli.ini</filename> - - El siguiente ejemplo muestra el uso de PDO_IBM DSN para la conexión a una - base de datos DB2 catalogada como DB2_9 en el archivo - db2cli.ini : - - - - - - - Ejemplo con PDO_IBM DSN utilizando una cadena completa de conexión - - El siguiente ejemplo muestra el uso de PDO_IBM DSN para la conexión a una - base de datos DB2 llamada testdb utilizando - la cadena completa de conexión DB2 CLI : - - - - - - - - -
    - - diff --git a/reference/pdo_informix/configure.xml b/reference/pdo_informix/configure.xml deleted file mode 100644 index 4a95b4dbef..0000000000 --- a/reference/pdo_informix/configure.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - -
    - &reftitle.install; - - Para compilar la extensión PDO_INFORMIX, debe estar instalado el SDK Client Informix 2.81 UC1 o superior en el mismo sistema que PHP. El SDK Client Informix está disponible en el Sitio de Soporte IBM Informix. - - - PDO_INFORMIX es una extensión &link.pecl;, por lo que se deben seguir las instrucciones en para instalar la extensión PDO_INFORMIX. Se debe escribir el comando configure para indicar la ruta de los ficheros de encabezado del SDK Client Informix así como las bibliotecas de la siguiente manera: - - - - El comando configure utiliza por omisión la variable de entorno INFORMIXDIR. - -
    - - diff --git a/reference/pdo_informix/reference.xml b/reference/pdo_informix/reference.xml deleted file mode 100644 index 02fb313662..0000000000 --- a/reference/pdo_informix/reference.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - - - Funciones del controlador PDO Informix (PDO_INFORMIX) - Controlador PDO Informix - - -
    - &reftitle.intro; - - PDO_INFORMIX es un controlador que implementa la interfaz de PHP Data - Objects (PDO) - para permitir el acceso de PHP a las bases de datos Informix. - -
    - - - &reference.pdo-informix.configure; - -
    - Cursores flotantes - - PDO_INFORMIX soporta los cursores flotantes; sin embargo, no están - activados por omisión. Para activar el soporte de los cursores flotantes, debe - establecer ENABLESCROLLABLECURSORS=1 en - las configuraciones de la conexión ODBC correspondiente en - odbc.ini o pasar la cláusula - EnableScrollableCursors=1 en la cadena de - conexión DSN. - -
    - -
    - - - - PDO_INFORMIX DSN - Conexión a las bases de datos Informix - - - - &reftitle.description; - - El Data Source Name (DSN) de PDO_INFORMIX se basa en la cadena de - caracteres DSN de Informix ODBC. Los detalles sobre la configuración de un DSN - Informix ODBC están disponibles en - Informix Dynamic Server Information - Center. - Los componentes principales del DSN de PDO_INFORMIX son: - - - Prefijo DSN - - - El prefijo DSN es informix:. - - - - - DSN - - - El DSN puede ser una fuente de datos de configuración - utilizando odbc.ini o una cadena de - conexión completa. - - - - - - - - &reftitle.examples; - - - Ejemplo de DSN de PDO_INFORMIX con <filename>odbc.ini</filename> - - El siguiente ejemplo muestra el DSN de PDO_INFORMIX para conectarse a una base - de datos Informix catalogada como Infdrv33 en - odbc.ini: - - - - - - Ejemplo de DSN de PDO_INFORMIX con una cadena de conexión - - El siguiente ejemplo muestra el DSN de PDO_INFORMIX para conectarse a una base - de datos Informix llamada common_db utilizando - la sintaxis de cadena de conexión de Informix. - - - - - - - - - -
    - diff --git a/reference/pdo_mysql/reference.xml b/reference/pdo_mysql/reference.xml index 94b9f31aec..2dc6b8eefd 100644 --- a/reference/pdo_mysql/reference.xml +++ b/reference/pdo_mysql/reference.xml @@ -2,7 +2,7 @@ - + Funciones del controlador PDO MySQL (PDO_MYSQL) Controlador PDO MySQL @@ -38,7 +38,7 @@ default_authentication_plugin=mysql_native_password en my.cnf. El complemento caching_sha2_password es completamente soportado a partir de PHP 7.4.4. Para versiones anteriores, - la extensión mysql_xdevapi lo soporta. + la extensión mysql_xdevapi lo soporta. diff --git a/reference/pdo_sqlsrv/configure.xml b/reference/pdo_sqlsrv/configure.xml deleted file mode 100644 index 85ef86570d..0000000000 --- a/reference/pdo_sqlsrv/configure.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - -
    - &reftitle.install; - - La versión más reciente del controlador está disponible para su descarga aquí: - descarga SQLSRV. - Las fuentes del controlador se alojan en un repositorio público. - - - Para obtener más información acerca de los requisitos del sistema, consúltese el - capítulo sobre los - requisitos del sistema SQLSRV. - - - En Windows, la extensión PDO_SQLSRV se activa descargando y añadiendo - los archivos DLL correspondientes en el directorio de extensiones de PHP - y la entrada correspondiente en el archivo &php.ini;. - - - En Linux y macOS, la extensión PDO_SQLSRV puede ser instalada utilizando &link.pecl;. - Consúltese el tutorial de instalación para más detalles. - -
    - diff --git a/reference/pdo_sqlsrv/constants.xml b/reference/pdo_sqlsrv/constants.xml deleted file mode 100644 index affcbf2c78..0000000000 --- a/reference/pdo_sqlsrv/constants.xml +++ /dev/null @@ -1,179 +0,0 @@ - - - - - -
    - &reftitle.constants; - &pdo.driver-constants; - - - - PDO::SQLSRV_TXN_READ_UNCOMMITTED - (int) - - - - Esta constante es un valor posible para la clave "TransactionIsolation" del DSN para SQLSRV. - Esta constante establece el nivel de aislamiento de la transacción a "Read Uncommitted". - - - - - - PDO::SQLSRV_TXN_READ_COMMITTED - (int) - - - - Esta constante es un valor posible para la clave "TransactionIsolation" del DSN para SQLSRV. - Esta constante establece el nivel de aislamiento de la transacción a "Read Committed". - - - - - - PDO::SQLSRV_TXN_REPEATABLE_READ - (int) - - - - Esta constante es un valor posible para la clave "TransactionIsolation" del DSN para SQLSRV. - Esta constante establece el nivel de aislamiento de la transacción a "Repeatable Read". - - - - - - PDO::SQLSRV_TXN_SNAPSHOT - (int) - - - - Esta constante es un valor posible para la clave "TransactionIsolation" del DSN para SQLSRV. - Esta constante establece el nivel de aislamiento de la transacción a "Snapshot". - - - - - - PDO::SQLSRV_TXN_SERIALIZABLE - (int) - - - - Esta constante es un valor posible para la clave "TransactionIsolation" del DSN para SQLSRV. - Esta constante establece el nivel de aislamiento de la transacción a "Serializable". - - - - - - PDO::SQLSRV_ENCODING_BINARY - (int) - - - - Especifica que estos datos son enviados al (o recibidos del) servidor como un flujo de bytes, - sin realizar codificación o traducción. Esta constante puede ser utilizada en las llamadas a - PDOStatement::setAttribute, PDO::prepare, PDOStatement::bindColumn, y - PDOStatement::bindParam. - - - - - - PDO::SQLSRV_ENCODING_SYSTEM - (int) - - - - Especifica que estos datos son enviados al (o recibidos del) servidor como un flujo de caracteres 8 bits, - como se especifica en la página de código de la configuración local de Windows activa en el sistema. - Todo carácter multibyte, o carácter que no existe en esta página de código, - es sustituido por un simple signo de interrogación (?). Esta constante puede ser utilizada - en las llamadas a PDOStatement::setAttribute, PDO::setAttribute, PDO::prepare, - PDOStatement::bindColumn, y PDOStatement::bindParam. - - - - - - PDO::SQLSRV_ENCODING_UTF8 - (int) - - - - Especifica que estos datos son enviados al (o recibidos del) servidor como un flujo de caracteres UTF-8. - Se trata de la codificación por defecto. Esta constante puede ser utilizada - en las llamadas a PDOStatement::setAttribute, PDO::setAttribute, PDO::prepare, - PDOStatement::bindColumn, y PDOStatement::bindParam. - - - - - - PDO::SQLSRV_ENCODING_DEFAULT - (int) - - - - Especifica que estos datos son enviados al (o recibidos del) servidor utilizando la codificación - PDO::SQLSRV_ENCODING_SYSTEM si es especificada durante la conexión. Si es especificada - en una instrucción "prepare", se utiliza la codificación de la conexión. - Esta constante puede ser utilizada en las llamadas a PDOStatement::setAttribute, - PDO::setAttribute, PDO::prepare, PDOStatement::bindColumn, y PDOStatement::bindParam. - - - - - - PDO::SQLSRV_ATTR_QUERY_TIMEOUT - (int) - - - - Un entero positivo o nulo que representa la duración del tiempo límite, en segundos. Cero (0) - es el valor por omisión y significa que no hay tiempo límite. - Esta constante puede ser utilizada en las llamadas a - PDOStatement::setAttribute, PDO::setAttribute, y PDO::prepare. - - - - - - PDO::SQLSRV_ATTR_DIRECT_QUERY - (int) - - - - Indica una consulta que debe ser ejecutada directamente, sin ser preparada. - Esta constante puede ser utilizada en las llamadas a PDO::setAttribute, y PDO::prepare. - Para más información, ver (en inglés) - Direct and Prepared Statement Execution. - - - - -
    - - diff --git a/reference/pdo_sqlsrv/reference.xml b/reference/pdo_sqlsrv/reference.xml deleted file mode 100644 index ce0043e4dd..0000000000 --- a/reference/pdo_sqlsrv/reference.xml +++ /dev/null @@ -1,226 +0,0 @@ - - - - - - - Funciones Microsoft del controlador PDO SQL Server (PDO_SQLSRV) - Controlador PDO MS SQL Server - - -
    - &reftitle.intro; - - PDO_SQLSRV es un controlador que implementa la interfaz - PDO (PHP Data Objects) para permitir el acceso desde PHP a las bases de - datos MS SQL Server (versión SQL Server 2005 y superiores) y SQL Azure. - -
    - &reference.pdo-sqlsrv.configure; - &reference.pdo-sqlsrv.constants; -
    - - - - PDO_SQLSRV DSN - Conexión a bases de datos MS SQL Server y SQL Azure - - - - &reftitle.description; - - El archivo DSN (Data Source Name) PDO_SQLSRV se compone de los siguientes elementos: - - - prefijo DSN - - - El prefijo DSN es sqlsrv:. - - - - - APP - - - El nombre de la aplicación, utilizado para las trazas. - - - - - ConnectionPooling - - - Especifica si la conexión está asignada a un pool de conexiones - (1 o &true;) o no (0 o &false;). - - - - - Database - - - El nombre de la base de datos. - - - - - Encrypt - - - Especifica si la comunicación con el servidor SQL Server está cifrada - (1 o &true;) o no cifrada (0 o &false;). - - - - - Failover_Partner - - - Especifica el servidor y la instancia de la base de datos espejo (si está - activada y configurada) a utilizar cuando el servidor principal es - inaccesible. - - - - - LoginTimeout - - - Especifica el número de segundos de espera antes de detener y poner en - error el intento de conexión. - - - - - MultipleActiveResultSets - - - Desactiva, o activa explícitamente, el soporte para juegos de resultados - múltiples (Multiple Active Result Sets, MARS). - - - - - QuotedId - - - Especifica si se deben utilizar las reglas SQL-92 para los identificadores - entre comillas (1 o &true;) o si se deben utilizar las reglas Transact-SQL estándar (0 o &false;). - - - - - Server - - - El nombre del servidor de base de datos. - - - - - TraceFile - - - La ruta del archivo utilizado para las trazas. - - - - - TraceOn - - - Especifica si las trazas ODBC están activadas (1 o &true;) o desactivadas - (0 o &false;) al activar la conexión. - - - - - TransactionIsolation - - - Especifica el nivel de aislamiento de la transacción. Los valores posibles - para esta opción son - PDO::SQLSRV_TXN_READ_UNCOMMITTED, PDO::SQLSRV_TXN_READ_COMMITTED, - PDO::SQLSRV_TXN_REPEATABLE_READ, PDO::SQLSRV_TXN_SNAPSHOT, y - PDO::SQLSRV_TXN_SERIALIZABLE. - - - - - TrustServerCertificate - - - Especifica si el cliente debe confiar (1 o &true;) o rechazar - (0 o &false;) un certificado servidor autosignado. - - - - - WSID - - - Especifica el nombre de la computadora para las trazas. - - - - - - - - - &reftitle.examples; - - Ejemplos de DSN PDO_SQLSRV - - El siguiente ejemplo muestra cómo conectarse a la base de datos MS SQL Server especificada: - - - - - - El siguiente ejemplo muestra cómo conectarse a la base de datos MS SQL Server especificada - en un puerto específico: - - - - - - El siguiente ejemplo muestra cómo conectarse a una base de datos SQL Azure con - el ID servidor 12345abcde. Tenga en cuenta que, al conectarse a Azure con PDO, - su nombre de usuario será Usuario@12345abcde (Usuario@IdServidor). - - - - - - - - -
    - diff --git a/reference/ps/book.xml b/reference/ps/book.xml deleted file mode 100644 index abc877c0fc..0000000000 --- a/reference/ps/book.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - - Creación de documentos PostScript - PS - - - - &reftitle.intro; - - Este módulo permite crear documentos PostScript. Tiene muchas - similitudes con la extensión pdf. Actualmente, esta API es - prácticamente idéntica y en la mayoría de los casos, solo se reemplazan - los prefijos de cada función de pdf_ por ps_. Esto también funciona - para las funciones que no tienen significado en el documento PostScript - (por ejemplo, la adición de hipervínculos) pero tendrá un efecto si el - documento se convierte en PDF. - - Los documentos creados por esta extensión son a veces incluso - superiores a los documentos creados con la extensión pdf, porque las - funciones de rendimiento de texto de pslib pueden manejar el crénage, - la división de palabras y las ligaduras que resultan en una mejor - visualización de la caja de texto. - - - - - &reference.ps.setup; - &reference.ps.constants; - &reference.ps.reference; - - - - diff --git a/reference/ps/configure.xml b/reference/ps/configure.xml deleted file mode 100644 index edc3bbcc77..0000000000 --- a/reference/ps/configure.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;ps. - -
    - - diff --git a/reference/ps/constants.xml b/reference/ps/constants.xml deleted file mode 100644 index 96d79d90e0..0000000000 --- a/reference/ps/constants.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - Las dos tablas siguientes listan todas las constantes definidas por - la extensión ps. - - Constantes para line caps - - - - &Name; - &Description; - - - - - ps_LINECAP_BUTT - - - - ps_LINECAP_ROUND - - - - ps_LINECAP_SQUARED - - - - -
    - - - Constantes para line joins - - - - &Name; - &Description; - - - - - ps_LINEJOIN_MITER - - - - ps_LINEJOIN_ROUND - - - - ps_LINEJOIN_BEVEL - - - - -
    -
    -
    - - diff --git a/reference/ps/functions/ps-add-bookmark.xml b/reference/ps/functions/ps-add-bookmark.xml deleted file mode 100644 index 39d254d34a..0000000000 --- a/reference/ps/functions/ps-add-bookmark.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - - ps_add_bookmark - Añadir un marcapáginas a la página actual - - - - &reftitle.description; - - intps_add_bookmark - resourcepsdoc - stringtext - intparent0 - intopen0 - - - Añade un marcapáginas a la página actual. Los marcapáginas normalmente aparecen en - los visualizadores de PDF a la izquierda de la página como un árbol jerárquico. Al hacer clic en un - marcapáginas saltará a la página en cuestión. - - &ps.note.visible; - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - text - - - El texto usado para mostrar el marcapáginas. - - - - - parent - - - Un marcapáginas previamente creado por esta función que - se usa como padre del nuevo marcapáginas. - - - - - open - - - Si open es distinto de cero, el visualizador de PDF - mostrará el marcapáginas abierto. - - - - - - - - - &reftitle.returnvalues; - - El valor devuelto es una referencia al marcapáginas. Sólo se utiliza si - el marcapáginas se usa como padre. El valor es mayor que cero si - la función tiene éxito. En caso de error se devolverá - cero. - - - - - &reftitle.seealso; - - - ps_add_launchlink - ps_add_pdflink - ps_add_weblink - - - - - - - diff --git a/reference/ps/functions/ps-add-launchlink.xml b/reference/ps/functions/ps-add-launchlink.xml deleted file mode 100644 index 0a28b5043e..0000000000 --- a/reference/ps/functions/ps-add-launchlink.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - - - ps_add_launchlink - Añadir un vínculo que lance un fichero - - - - &reftitle.description; - - boolps_add_launchlink - resourcepsdoc - floatllx - floatlly - floaturx - floatury - stringfilename - - - Coloca un hipervínculo, en la posición dada, que apunta a un fichero de un programa, - el cual se iniciará al hacer clic sobre él. La posición origen del hipervículo - es un rectángulo - que tiene su esquina inferior izquierda en (llx, lly) y su esquina superior derecha en - (urx, ury). El rectángulo tiene por defecto un borde fino azul. - - &ps.note.visible; - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - llx - - - La coordenada x de la esquina inferior izquierda. - - - - - lly - - - La coordenada y de la esquina inferior izquierda. - - - - - urx - - - La coordenada x de la esquina superior derecha. - - - - - ury - - - La coordenada y de la esquina superior derecha. - - - - - filename - - - La ruta del programa a iniciar cuando se haga clic sobre el vínculo. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_add_locallink - ps_add_pdflink - ps_add_weblink - - - - - - - diff --git a/reference/ps/functions/ps-add-locallink.xml b/reference/ps/functions/ps-add-locallink.xml deleted file mode 100644 index 6ddb005a96..0000000000 --- a/reference/ps/functions/ps-add-locallink.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - - - ps_add_locallink - Añadir un vínculo hacia una página del mismo documento - - - - &reftitle.description; - - boolps_add_locallink - resourcepsdoc - floatllx - floatlly - floaturx - floatury - intpage - stringdest - - - Coloca un hipervínculo, en la posición dada, que apunta a una página del mismo - documento. Al hacer clic sobre el vínculo se irá a la página en cuestión. La - primera página de un documento tiene el número 1. - - - La posición origen del hipervículo es un rectángulo que tiene su esquina inferior izquierda en - (llx, lly) y su esquina - superior derecha en (urx, ury). - El rectángulo tiene por defecto un borde fino azul. - - &ps.note.visible; - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - llx - - - La coordenada x de la esquina inferior izquierda. - - - - - lly - - - La coordenada y de la esquina inferior izquierda. - - - - - urx - - - La coordenada x de la esquina superior derecha. - - - - - ury - - - La coordenada y de la esquina superior derecha. - - - - - page - - - El número de la página mostrada al hacer clic en el vínculo. - - - - - dest - - - El parámetro dest determina cómo visualizar - el documento. Puede ser fitpage, - fitwidth, fitheight, o - fitbbox. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_add_launchlink - ps_add_pdflink - ps_add_weblink - - - - - - - diff --git a/reference/ps/functions/ps-add-note.xml b/reference/ps/functions/ps-add-note.xml deleted file mode 100644 index 7e5b97d7db..0000000000 --- a/reference/ps/functions/ps-add-note.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - - - ps_add_note - Añadir una nota a la página actual - - - - &reftitle.description; - - boolps_add_note - resourcepsdoc - floatllx - floatlly - floaturx - floatury - stringcontents - stringtitle - stringicon - intopen - - - Añade una nota en una cierta posición del página. Las notas son como pequeñas - hojas rectangulares con texto dentro que pueden ser colocadas en cualquer lugar de - una página. - Se muestran tanto plegadas como desplegadas. Si están desplegadas se utiliza el - icono especificado como marcador de posición. - - &ps.note.visible; - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - llx - - - La coordenada x de la esquina inferior izquierda. - - - - - lly - - - La coordenada y de la esquina inferior izquierda. - - - - - urx - - - La coordenada x de la esquina superior derecha. - - - - - ury - - - La coordenada y de la esquina superior derecha. - - - - - contents - - - El texto de la nota. - - - - - title - - - El título de la nota a mostrar en la cabecera de la nota. - - - - - icon - - - El icono mostrado si la nota está plegada. Este parámetro puede ser establecido - a comment, insert, - note, paragraph, - newparagraph, key, o - help. - - - - - open - - - Si open es distinto de cero, la nota se - mostrará desplegada después de abrir el documento con un visualizador de pdf. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_add_pdflink - ps_add_launchlink - ps_add_locallink - ps_add_weblink - - - - - - - diff --git a/reference/ps/functions/ps-add-pdflink.xml b/reference/ps/functions/ps-add-pdflink.xml deleted file mode 100644 index f6bd1e5de7..0000000000 --- a/reference/ps/functions/ps-add-pdflink.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - - - ps_add_pdflink - Añadir un vínculo hacia una página de un segundo documento PDF - - - - &reftitle.description; - - boolps_add_pdflink - resourcepsdoc - floatllx - floatlly - floaturx - floatury - stringfilename - intpage - stringdest - - - Coloca un hipervínculo, en la posición dada, que apunta a un segundo documento pdf. - Al hacer clic sobre el vínculo se irá a la página dada del segundo documento. La - primera página de un documento tiene el número 1. - - - La posición origen del hipervículo es un rectángulo que tiene su esquina inferior izquierda en - (llx, lly) y su esquina - superior derecha en (urx, ury). - El rectángulo tiene por defecto un borde fino azul. - - &ps.note.visible; - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - llx - - - La coordenada x de la esquina inferior izquierda. - - - - - lly - - - La coordenada y de la esquina inferior izquierda. - - - - - urx - - - La coordenada x de la esquina superior derecha. - - - - - ury - - - La coordenada y de la esquina superior derecha. - - - - - filename - - - El nombre del documento pdf a abrir cuando se haga clic en - este vínculo. - - - - - page - - - El número de página del documento pdf destino - - - - - dest - - - El parámetro dest determina cómo visualizar - el documento. Puede ser fitpage, - fitwidth, fitheight, o - fitbbox. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_add_launchlink - ps_add_locallink - ps_add_weblink - - - - - - - diff --git a/reference/ps/functions/ps-add-weblink.xml b/reference/ps/functions/ps-add-weblink.xml deleted file mode 100644 index 76501429fc..0000000000 --- a/reference/ps/functions/ps-add-weblink.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - - - ps_add_weblink - Añadir un vínculo hacia una ubicación web - - - - &reftitle.description; - - boolps_add_weblink - resourcepsdoc - floatllx - floatlly - floaturx - floatury - stringurl - - - Coloca un hipervínculo, en la posición dada, que apunta a una página web. La - posición origen del hipervículo es un rectángulo que tiene su esquina inferior izquierda en - (llx, lly) y - su esquina superior derecha en (urx, - ury). El rectángulo tiene por defecto un borde - fino azul. - - &ps.note.visible; - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - llx - - - La coordenada x de la esquina inferior izquierda. - - - - - lly - - - La coordenada y de la esquina inferior izquierda. - - - - - urx - - - La coordenada x de la esquina superior derecha. - - - - - ury - - - La coordenada y de la esquina superior derecha. - - - - - url - - - El URL del hipervínculo a abrir cuando se haga clic en - este vínculo, p.ej. http://www.php.net. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_add_launchlink - ps_add_locallink - ps_add_pdflink - - - - - - - diff --git a/reference/ps/functions/ps-arc.xml b/reference/ps/functions/ps-arc.xml deleted file mode 100644 index 0a040a4bac..0000000000 --- a/reference/ps/functions/ps-arc.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - - - ps_arc - Dibujar un arco en el sentido contrario a las agujas del reloj - - - - &reftitle.description; - - boolps_arc - resourcepsdoc - floatx - floaty - floatradius - floatalpha - floatbeta - - - Dibuja una porción de un círculo con su punto medio en - (x, y). El arco comienza en un - ángulo dado por alpha y termina en un ángulo dado por - beta. Se dibuja en el sentido contrario al de las agujas del reloj (use la función - ps_arcn para dibujarlo en el sentido de las agujas del reloj). El trazado añadido - al trazado actual comienza en el arco con el ángulo alpha - y termina en el arco con el ángulo beta. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - x - - - La coordenada x del punto medio del círculo. - - - - - y - - - La coordenada y del punto medio del círculo. - - - - - radius - - - El radio del círculo - - - - - alpha - - - El ángulo de inicio dado en grados. - - - - - beta - - - El ángulo final dado en grados. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_arcn - - - - - - - diff --git a/reference/ps/functions/ps-arcn.xml b/reference/ps/functions/ps-arcn.xml deleted file mode 100644 index 0b4b91453f..0000000000 --- a/reference/ps/functions/ps-arcn.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - - - ps_arcn - Dibujar un arco en el sentido de las agujas del reloj - - - - &reftitle.description; - - boolps_arcn - resourcepsdoc - floatx - floaty - floatradius - floatalpha - floatbeta - - - Dibuja una porción de un círculo con su punto medio en - (x, y). El arco comienza en un - ángulo dado por alpha y termina en un ángulo dado por - beta. Se dibuja en el sentido de las agujas del reloj (use la función - ps_arc para dibujarlo en sentido contrario al de las agujas del reloj). El trazado añadido - al trazado actual comienza en el arco con el ángulo beta - y termina en el arco con el ángulo alpha. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - x - - - La coordenada x del punto medio del círculo. - - - - - y - - - La coordenada y del punto medio del círculo. - - - - - radius - - - El radio del círculo - - - - - alpha - - - El ángulo de inicio dado en grados. - - - - - beta - - - El ángulo final dado en grados. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_arc - - - - - - - diff --git a/reference/ps/functions/ps-begin-page.xml b/reference/ps/functions/ps-begin-page.xml deleted file mode 100644 index 7517274c23..0000000000 --- a/reference/ps/functions/ps-begin-page.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - - ps_begin_page - Empezar una nueva página - - - - &reftitle.description; - - boolps_begin_page - resourcepsdoc - floatwidth - floatheight - - - Empiza una nueva página. Aunque los parámetros width - y height implican un tamaño de página diferente para cada - página, esto no es posible en PostScript. La primera llamada a la función - ps_begin_page establecerá el tamaño de página para el documento - entero. Las llamadas consecutivas no tendrán efecto, excepto para crear una nueva - página. La situación es diferente si se intenta convertir el documento - PostScript a PDF. Esta función coloca marcas pdf dentro del documento, con lo que - se puede establecer el tamaño de cada página individualmente. El documento PDF resultante - tendrá diferentes tamaños de página. - - - Aunque PostScript no conoce diferentes tamaños de página, pslib coloca - una caja circundante para cada página dentro del documento. Este tamaño es evaluado - por algunos visualizadores de PostScript y tendrá precedencia sobre el campo BoundingBox - de la cabecera (Header) del documento. Esto puede llevar a resultados inesperados cuando - se establece BoundingBox con su esquina inferior izquierda diferente de (0, 0), ya que la - caja circundante de la página siempre tendrá una esquina inferior izquierda (0, 0) - y sobrescribirá la configuración global. - - - Cada página está encapsulada en la forma guardar/restaurar. Esto significa que la mayoría de los - ajustes hechos en una página no se conservarán para la siguiente página. - - - Si hasta la primera llamada a la función ps_begin_page no existen - llamadas a la función ps_findfont, la cabecera del documento - PostScript se imprimirá y la caja circundante será establecida al tamaño de - la primera página. La esquina inferior izquierda de la caja circundante se establecerá a (0, 0). - Si si llamó antes a la función ps_findfont, la - cabecera ya ha sido impresa, y el documento no tendrá una caja circundante - válida. Para prevenir esto, se debería llamar a la función - ps_set_info para establecer el campo de información - BoundingBox y posiblemente Orientation - antes de cualquier llamada a las funciones ps_findfont o - ps_begin_page. - - - - Hasta la versión 0.2.6 de pslib, esta función siempre sobrescribía - los campos BoundingBox y Orientation si antes habían sido establecidos con la función - ps_set_info y no se había llamado antes - a la función ps_findfont. - - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - width - - - El ancho de la página en píxeles, p.ej. 596 para el formato A4 - - - - - height - - - El alto de la página en píxeles, p.ej. 842 para el formato A4 - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_end_page - ps_findfont - ps_set_info - - - - - - - diff --git a/reference/ps/functions/ps-begin-pattern.xml b/reference/ps/functions/ps-begin-pattern.xml deleted file mode 100644 index 5dc5c2cf2c..0000000000 --- a/reference/ps/functions/ps-begin-pattern.xml +++ /dev/null @@ -1,174 +0,0 @@ - - - - - - - - ps_begin_pattern - Inicia un nuevo patrón - - - - &reftitle.description; - - intfalseps_begin_pattern - resourcepsdoc - floatwidth - floatheight - floatxstep - floatystep - intpainttype - - - Inicia un nuevo patrón. Un patrón es como una página que contiene, por ejemplo, - un dibujo que puede ser utilizado para rellenar sectores. Se utiliza - como un color al llamar a ps_setcolor y configurando - la posición del color en el patrón. - - - - - &reftitle.parameters; - - - - psdoc - - - Identificador de un archivo postscript devuelto por - ps_new. - - - - - width - - - El ancho del patrón en píxeles. - - - - - height - - - La altura del patrón en píxeles. - - - - - xstep - - - La distancia en píxeles de la posición del patrón en la dirección - horizontal. - - - - - ystep - - - La distancia en píxeles de la posición del patrón en la dirección - vertical. - - - - - painttype - - - Debe ser 1 o 2. - - - - - - - - - &reftitle.returnvalues; - - El identificador del patrón &return.falseforfailure;. - - - - - &reftitle.examples; - - - Creación y utilización de un patrón - - -]]> - - - - - - - &reftitle.seealso; - - - ps_end_pattern - ps_setcolor - ps_shading_pattern - - - - - - diff --git a/reference/ps/functions/ps-begin-template.xml b/reference/ps/functions/ps-begin-template.xml deleted file mode 100644 index 4c3ce0c6b1..0000000000 --- a/reference/ps/functions/ps-begin-template.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - - - ps_begin_template - Iniciar una nueva plantilla - - - - &reftitle.description; - - intps_begin_template - resourcepsdoc - floatwidth - floatheight - - - Inicia una nueva plantilla. A una plantilla se le conoce como forma en el lenguaje - postscript. Se crea de forma similar a un patrón pero se utiliza como una imagen. - Las plantilla a menudo se usan para dibujar algo que se coloca varias veces - a lo largo de un documento, p.ej. el logotipo de una compañía. Se puede usar - todas las funciones de dibujo dentro de una plantilla. La plantilla no será dibujada hasta - que sea colocada mediante la función ps_place_image. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - width - - - El ancho de la plantilla en píxeles. - - - - - height - - - El alto de la plantilla en píxeles. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Crear y utilizar una plantilla - - -]]> - - - - - - - &reftitle.seealso; - - - ps_end_template - - - - - - - diff --git a/reference/ps/functions/ps-circle.xml b/reference/ps/functions/ps-circle.xml deleted file mode 100644 index 1bd5fa4e90..0000000000 --- a/reference/ps/functions/ps-circle.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - - ps_circle - Dibujar un círculo - - - - &reftitle.description; - - boolps_circle - resourcepsdoc - floatx - floaty - floatradius - - - Dibuja un círculo con su punto medio en (x, - y). El círculo comienza y termina en la posición - (x+radius, - y). Si esta función es llamada fuera de un trazado - se iniciará un nuevo trazado. Si es llamada dentro de un trazado añadirá el círculo - como un subtrazado. Si la última operación de dibujo no finaliza en el punto - (x+radius, - y) habrá un hueco en el trazado. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - x - - - La coordenada x del punto medio del círculo. - - - - - y - - - La coordenada y del punto medio del círculo. - - - - - radius - - - El radio del círculo - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_arc - ps_arcn - - - - - - - diff --git a/reference/ps/functions/ps-clip.xml b/reference/ps/functions/ps-clip.xml deleted file mode 100644 index 3b17b27782..0000000000 --- a/reference/ps/functions/ps-clip.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - ps_clip - Realizar un recorte utilizando el trazado actual - - - - &reftitle.description; - - boolps_clip - resourcepsdoc - - - Toma el trazado actual y lo usa para definir el borde de un área de recorte. - Todo lo dibujado fuera de ese área no será visible. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_closepath - - - - - - - diff --git a/reference/ps/functions/ps-close-image.xml b/reference/ps/functions/ps-close-image.xml deleted file mode 100644 index 74d8a3915c..0000000000 --- a/reference/ps/functions/ps-close-image.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - - ps_close_image - Cierra la imagen y libera la memoria - - - - &reftitle.description; - - voidfalseps_close_image - resourcepsdoc - intimageid - - - Cierra una imagen y libera sus recursos. Una vez cerrada la imagen, ya no - puede ser utilizada. - - - - - &reftitle.parameters; - - - - psdoc - - - Identificador de un fichero postscript devuelto por - ps_new. - - - - - imageid - - - Identificador de una imagen devuelto por - ps_open_image o - ps_open_image_file. - - - - - - - - - &reftitle.returnvalues; - - Devuelve &null; en caso de éxito&return.falseforfailure;. - - - - - &reftitle.seealso; - - - ps_open_image - ps_open_image_file - - - - - - diff --git a/reference/ps/functions/ps-close.xml b/reference/ps/functions/ps-close.xml deleted file mode 100644 index 25b127bd00..0000000000 --- a/reference/ps/functions/ps-close.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - - ps_close - Cerrar un documento PostScript - - - - &reftitle.description; - - boolps_close - resourcepsdoc - - - Cierra el documento PostScript. - - - Esta función escribe el tráiler del documento PostScript. - También escribe el árbol de marcapáginas. ps_close no - libera ningún recurso, lo que se realiza mediante la función ps_delete. - - - Esta función también es llamda por la función ps_delete si - no ha sido llamada antes. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_open_file - ps_delete - - - - - - - diff --git a/reference/ps/functions/ps-closepath-stroke.xml b/reference/ps/functions/ps-closepath-stroke.xml deleted file mode 100644 index 569f024b4c..0000000000 --- a/reference/ps/functions/ps-closepath-stroke.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - ps_closepath_stroke - Cerrar y contornear un trazado - - - - &reftitle.description; - - boolps_closepath_stroke - resourcepsdoc - - - Conecta el último punto con el primer punto de un trazado y dibuja la línea cerrada - resultante. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_closepath - - - - - - - diff --git a/reference/ps/functions/ps-closepath.xml b/reference/ps/functions/ps-closepath.xml deleted file mode 100644 index b48e4a5c5e..0000000000 --- a/reference/ps/functions/ps-closepath.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - ps_closepath - Cerrar un trazado - - - - &reftitle.description; - - boolps_closepath - resourcepsdoc - - - Conecta el último punto con el primer punto de un trazado. El trazado - resultante puede usarse para contornear, rellenar, recortar, etc... - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_clip - ps_closepath_stroke - - - - - - - diff --git a/reference/ps/functions/ps-continue-text.xml b/reference/ps/functions/ps-continue-text.xml deleted file mode 100644 index 587bd8b65a..0000000000 --- a/reference/ps/functions/ps-continue-text.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - - ps_continue_text - Continuar el texto en la siguiente línea - - - - &reftitle.description; - - boolps_continue_text - resourcepsdoc - stringtext - - - Imprime un texto una línea por debajo de la última línea. La interlínea - se toma del valor "leading", el cual debe establecerse con la función - ps_set_value. La posición actual del - texto se determina por los valores "textx" y "texty", los cuales pueden solicitarse - con la función ps_get_value. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - text - - - El texto a imprimir. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_show - ps_show_xy - ps_show_boxed - - - - - - - diff --git a/reference/ps/functions/ps-curveto.xml b/reference/ps/functions/ps-curveto.xml deleted file mode 100644 index 0c01e916f0..0000000000 --- a/reference/ps/functions/ps-curveto.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - - ps_curveto - Dibujar una curva - - - - &reftitle.description; - - boolps_curveto - resourcepsdoc - floatx1 - floaty1 - floatx2 - floaty2 - floatx3 - floaty3 - - - Añade una sección de una curva cúbica de Bézier al trazado actual descrita por los tres puntos de control - dados. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - x1 - - - La coordenada x del primer punto de control. - - - - - y1 - - - La coordenada y del primer punto de control. - - - - - x2 - - - La coordenada x del segundo punto de control. - - - - - y2 - - - La coordenada y del segundo punto de control. - - - - - x3 - - - La coordenada x del tercer punto de control. - - - - - y3 - - - La coordenada y del tercer punto de control. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_lineto - - - - - - - diff --git a/reference/ps/functions/ps-delete.xml b/reference/ps/functions/ps-delete.xml deleted file mode 100644 index 41eec792bc..0000000000 --- a/reference/ps/functions/ps-delete.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - ps_delete - Borrar todos los recursos de un documento PostScript - - - - &reftitle.description; - - boolps_delete - resourcepsdoc - - - Principalmente libera la memoria usada por el documento. También cierra un fichero, si no fue - cerrado antes con la función ps_close. En cualquier caso, antes se - debería cerrar el fichero con la función ps_close, ya que - ps_close no sólo cierra el fichero, sino que también imprime un - tráiler que contiene comentarios de PostScript, como el número de páginas del - documento, y añade la jerarquía de marcapáginas. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_close - - - - - - - diff --git a/reference/ps/functions/ps-end-page.xml b/reference/ps/functions/ps-end-page.xml deleted file mode 100644 index 349f337097..0000000000 --- a/reference/ps/functions/ps-end-page.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - ps_end_page - Finaliza una página - - - - &reftitle.description; - - boolps_end_page - resourcepsdoc - - - Finaliza una página que ha sido iniciada con ps_begin_page. - Finalizar una página deja el contexto de dibujo actual, lo que por ejemplo - requiere recargar las fuentes si fueron cargadas con la página y fija varios - otros parámetros de dibujo como el grosor de las líneas, el color. - - - - - &reftitle.parameters; - - - - psdoc - - - Identificador de un archivo postscript devuelto por - ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_begin_page - - - - - - diff --git a/reference/ps/functions/ps-end-pattern.xml b/reference/ps/functions/ps-end-pattern.xml deleted file mode 100644 index 96a30cfdb0..0000000000 --- a/reference/ps/functions/ps-end-pattern.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - ps_end_pattern - Finalizar un patrón - - - - &reftitle.description; - - boolps_end_pattern - resourcepsdoc - - - Finaliza un patrón que fue creado con la función ps_begin_pattern. - Una vez que el patrón ha sido finalizado se puede usar como un color para rellenar - áreas. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_begin_pattern - - - - - - - diff --git a/reference/ps/functions/ps-end-template.xml b/reference/ps/functions/ps-end-template.xml deleted file mode 100644 index f1b035d2f8..0000000000 --- a/reference/ps/functions/ps-end-template.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - ps_end_template - Finalizar una plantilla - - - - &reftitle.description; - - boolps_end_template - resourcepsdoc - - - Finaliza una plantilla que fue creada con la función ps_begin_template. - Una vez que la plantilla ha sido finalizada se puede usar como una imagen. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_begin_template - - - - - - - diff --git a/reference/ps/functions/ps-fill-stroke.xml b/reference/ps/functions/ps-fill-stroke.xml deleted file mode 100644 index 16450e37e3..0000000000 --- a/reference/ps/functions/ps-fill-stroke.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - ps_fill_stroke - Rellenar y contornear el trazado actual - - - - &reftitle.description; - - boolps_fill_stroke - resourcepsdoc - - - Rellena y dibuja el trazado construido previamente con llamadas a funciones de dibujo, - como ps_lineto. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_fill - ps_stroke - - - - - - - diff --git a/reference/ps/functions/ps-fill.xml b/reference/ps/functions/ps-fill.xml deleted file mode 100644 index f78cb58fa7..0000000000 --- a/reference/ps/functions/ps-fill.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - ps_fill - Rellenar el trazado actual - - - - &reftitle.description; - - boolps_fill - resourcepsdoc - - - Rellena el trazaco construido previamente con llamdas a las funciones de dibujo, como - ps_lineto. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_fill_stroke - ps_stroke - - - - - - - diff --git a/reference/ps/functions/ps-findfont.xml b/reference/ps/functions/ps-findfont.xml deleted file mode 100644 index 35667fa001..0000000000 --- a/reference/ps/functions/ps-findfont.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - - - ps_findfont - Carga una fuente - - - - &reftitle.description; - - intps_findfont - resourcepsdoc - stringfontname - stringencoding - boolembed&false; - - - ps_findfont carga una fuente para su uso posterior. - Antes de que el texto sea escrito con la fuente cargada, debe ser fijada con - ps_setfont. Esta función debe tener el archivo de - métricas de la fuente "adobe" para calcular el espacio utilizado por los - caracteres. Una fuente que se carga en una página solo estará disponible en - esa página. Las fuentes que se utilizarán en todo el documento deben ser - cargadas antes de la primera llamada a - ps_begin_page. La llamada a - ps_findfont entre páginas hará que esta fuente esté - disponible para todas las páginas siguientes. - - - El nombre del archivo afm debe ser - fontname.afm. Si la fuente debe - ser incorporada, el archivo - fontname.pfb que contiene el dibujo - de la fuente también debe estar presente. - - - La llamada a ps_findfont antes de la primera página - requiere mostrar el encabezado del postscript que incluye el BoundingBox para - el documento completo. Normalmente, el BoundingBox se fija con la primera - llamada a ps_begin_page que ahora viene después de - ps_findfont. En consecuencia, el BoundingBox no ha sido - fijado y se lanzará un error cuando - ps_findfont sea llamada. Para prever esta situación, - debe llamarse a la función - ps_set_parameter para fijar el BoundingBox antes de que - ps_findfont sea llamada. - - - - - &reftitle.parameters; - - - - psdoc - - - Identificador de un archivo postscript devuelto por - ps_new. - - - - - fontname - - - El nombre de la fuente. - - - - - encoding - - - ps_findfont intentará cargar el archivo pasado - en el argumento encoding. Los archivos de - codificación tienen la misma sintaxis que los utilizados por - dvips(1). Contienen un vector de codificación de - fuente (que actualmente no se utiliza, pero que debe estar presente) y - una lista de ligaduras adicionales para extender la lista de ligaduras - derivadas del archivo AFM. - - - encoding puede ser &null; o una &string; vacía - si se desea utilizar la codificación por omisión (TeXBase1). - - - Si la codificación se establece en builtin entonces - no habrá codificación adicional y se utilizará la codificación - específica de la fuente. Esto es muy útil para fuentes con símbolos. - - - - - embed - - - Si se establece en un valor >0, la fuente será incorporada en el - documento. Esto requiere la presencia del archivo de dibujo (.pfb). - - - - - - - - - &reftitle.returnvalues; - - Devuelve un identificador de la fuente o cero en caso de error. El - identificador es un número positivo. - - - - - &reftitle.seealso; - - - ps_begin_page - ps_setfont - - - - - - diff --git a/reference/ps/functions/ps-get-buffer.xml b/reference/ps/functions/ps-get-buffer.xml deleted file mode 100644 index d72b53cd4b..0000000000 --- a/reference/ps/functions/ps-get-buffer.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - ps_get_buffer - Obtener el buffer completo que contiene la información generada de PS - - - - &reftitle.description; - - stringps_get_buffer - resourcepsdoc - - Esta función aún no está implementada. Siempre devolverá una cadena - vacía. La idea para una implementación posterior es escribir el contenido del - fichero postscript en un buffer interno si se solicita la creación en - memoria, y recuperar el contenifo del buffer con esta función. - Actualmente, los documentos - creados en memoria son enviados al visualizador sin la participación de un buffer. - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - - - - - &reftitle.seealso; - - - ps_open_file - - - - - - - diff --git a/reference/ps/functions/ps-get-parameter.xml b/reference/ps/functions/ps-get-parameter.xml deleted file mode 100644 index fb5e740f63..0000000000 --- a/reference/ps/functions/ps-get-parameter.xml +++ /dev/null @@ -1,214 +0,0 @@ - - - - - - - - ps_get_parameter - Recupera ciertos parámetros - - - - &reftitle.description; - - stringfalseps_get_parameter - resourcepsdoc - stringname - floatmodifier - - - Recupera varios parámetros que han sido establecidos directamente por - ps_set_parameter o indirectamente por una o más - funciones. Los parámetros son, por definición, - valores de &string;. Esta función no puede ser utilizada para - recuperar los recursos que también han sido establecidos por - ps_set_parameter. - - - El parámetro name puede tener una de las siguientes - valores. - - - - - fontname - - - El nombre de la fuente actualmente activa o la fuente cuyo identificador - es pasado en el parámetro modifier. - - - - - fontencoding - - - La codificación de la fuente actualmente activa. - - - - - dottedversion - - - La versión de la biblioteca subyacente pslib en el formato - <mayor>.<menor>.<submenor> - - - - - scope - - - El ámbito actual del dibujo. Puede ser un objeto, un documento, &null;, - una página, un patrón, un camino, un modelo, un prólogo, una fuente, un - glifo. - - - - - ligaturedisolvechar - - - El carácter que descompone una ligadura. Si se utiliza una fuente que - contiene una ligadura `ff' y `|` es el carácter para descomponer la - ligadura, entonces `f|f' dará dos `f' en lugar de la ligadura `ff'. - - - - - imageencoding - - - La codificación utilizada para codificar las imágenes. Puede ser - hex o 85. La codificación hex utiliza - dos octetos en el archivo PostScript, cada octeto en una imagen. - 85 representa la codificación Ascii85. - - - - - linenumbermode - - - Se establece en paragraph si las líneas son numeradas - dentro de un párrafo o box si son numeradas en una - caja que las rodea. - - - - - linebreak - - - Solo utilizado si el texto es mostrado con - ps_show_boxed. Si se establece en &true;, un retorno - de carro añadirá un salto de línea. - - - - - parbreak - - - Solo utilizado si el texto es mostrado con - ps_show_boxed. Si se establece en &true;, un retorno - de carro iniciará un nuevo párrafo. - - - - - hyphenation - - - Solo utilizado si el texto es mostrado con - ps_show_boxed. Si se establece en &true;, el párrafo - será dividido si un diccionario de guiones es establecido y existe. - - - - - hyphendict - - - Nombre del archivo del diccionario utilizado para el patrón de guiones. - - - - - - - - - &reftitle.parameters; - - - - psdoc - - - Identificador de un archivo postscript devuelto por - ps_new. - - - - - name - - - Nombre del parámetro. - - - - - modifier - - - Un identificador requerido si el parámetro de un recurso es requerido, - por ejemplo, el tamaño de una imagen. En este caso, el identificador del - recurso es pasado. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor del parámetro &return.falseforfailure;. - - - - - &reftitle.seealso; - - - ps_set_parameter - - - - - - diff --git a/reference/ps/functions/ps-get-value.xml b/reference/ps/functions/ps-get-value.xml deleted file mode 100644 index bdbcc5a89c..0000000000 --- a/reference/ps/functions/ps-get-value.xml +++ /dev/null @@ -1,319 +0,0 @@ - - - - - - - - ps_get_value - Recupera ciertos valores - - - - &reftitle.description; - - floatps_get_value - resourcepsdoc - stringname - floatmodifier - - - Recupera varios valores que han sido establecidos por - ps_set_value. Los valores son, por definición, valores de &float;. - - - El argumento name puede tener uno de los siguientes valores. - - - - - fontsize - - - El tamaño de la fuente actualmente activa o la fuente cuyo identificador se pasa en el argumento - modifier. - - - - - font - - - La fuente actualmente activa en sí misma. - - - - - imagewidth - - - La anchura de la imagen cuyo identificador se pasa en el argumento - modifier. - - - - - imageheight - - - La altura de la imagen cuyo identificador se pasa en el argumento - modifier. - - - - - capheight - - - La altura de una letra mayúscula M en la fuente actualmente activa o la fuente cuyo identificador se pasa en el argumento - modifier. - - - - - ascender - - - La hampe de la fuente actualmente activa o la fuente cuyo identificador se pasa en el argumento - modifier. - - - - - descender - - - El jambage de la fuente actualmente activa o la fuente cuyo identificador se pasa en el argumento - modifier. - - - - - italicangle - - - El parámetro italicangle de la fuente actualmente activa o la fuente cuyo identificador se pasa en el argumento - modifier. - - - - - underlineposition - - - El parámetro underlineposition de la fuente actualmente activa o la fuente cuyo identificador se pasa en el argumento - modifier. - - - - - underlinethickness - - - El parámetro underlinethickness de la fuente actualmente activa o la fuente cuyo identificador se pasa en el argumento - modifier. - - - - - textx - - - La posición x actual de visualización del texto. - - - - - texty - - - La posición y actual de visualización del texto. - - - - - textrendering - - - El modo actual para el renderizado del texto. - - - - - textrise - - - El espacio por el cual el texto es aumentado por encima de la línea de base. - - - - - leading - - - La distancia entre las líneas de texto en puntos. - - - - - wordspacing - - - El espacio entre las palabras como múltiplo de la anchura de un carácter de espacio. - - - - - charspacing - - - El espacio entre los caracteres. Si charspacing es != 0.0, las ligaduras siempre estarán desactivadas. - - - - - hyphenminchars - - - Número mínimo de caracteres antes de un guion al final de una palabra. - - - - - parindent - - - La indentación de las primeras n líneas en un párrafo. - - - - - numindentlines - - - Número de líneas en un párrafo a indentar si paraindent != 0.0. - - - - - parskip - - - Distancia entre los párrafos. - - - - - linenumberspace - - - Espacio general frente a cada línea para el número de línea. - - - - - linenumbersep - - - Espacio entre las líneas y los números de línea. - - - - - major - - - El número de versión mayor de pslib. - - - - - minor - - - El número de versión menor de pslib. - - - - - subminor, revision - - - El número de versión submenor de pslib. - - - - - - - - - &reftitle.parameters; - - - - psdoc - - - Identificador de un archivo postscript devuelto por - ps_new. - - - - - name - - - Nombre del valor. - - - - - modifier - - - El argumento modifier especifica el recurso para el cual se recuperará el valor. Esto puede ser el ID de la fuente o una imagen. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor del parámetro o &false;. - - - - - &reftitle.seealso; - - - ps_set_value - - - - - - diff --git a/reference/ps/functions/ps-hyphenate.xml b/reference/ps/functions/ps-hyphenate.xml deleted file mode 100644 index 51bdadece4..0000000000 --- a/reference/ps/functions/ps-hyphenate.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - - ps_hyphenate - Une palabras - - - - &reftitle.description; - - arrayfalseps_hyphenate - resourcepsdoc - stringtext - - - Une la palabra pasada. ps_hyphenate evalúa la valor - hyphenminchars (establecido por ps_set_value) y el argumento - hyphendic (establecido por ps_set_parameter). hyphendict debe - ser establecido antes de llamar a esta función. - - - Esta función requiere que la configuración local LC_CTYPE esté - correctamente hecha. Esto se realiza cuando la extensión es inicializada - utilizando las variables de entorno. En sistemas Unix, consulte las páginas de manual - de locale para más información. - - - - - &reftitle.parameters; - - - - psdoc - - - Identificador de un archivo postscript devuelto por - ps_new. - - - - - text - - - text no debería contener caracteres no - alfabéticos. Las posiciones posibles para los cortes son devueltas en un - array de números enteros. Cada número es la posición del carácter - en text después de que la unión pueda tener lugar. - - - - - - - - - &reftitle.returnvalues; - - Un array de enteros que indica la posición de los cortes posibles en el - texto &return.falseforfailure;. - - - - - &reftitle.examples; - - - Corta un texto - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - - ps_show_boxed - locale(1) - - - - - - diff --git a/reference/ps/functions/ps-include-file.xml b/reference/ps/functions/ps-include-file.xml deleted file mode 100644 index 9190e19cd4..0000000000 --- a/reference/ps/functions/ps-include-file.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - ps_include_file - Leer un fichero externo con código PostScript sin tratar - - - - &reftitle.description; - - boolps_include_file - resourcepsdoc - stringfile - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - file - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/ps/functions/ps-lineto.xml b/reference/ps/functions/ps-lineto.xml deleted file mode 100644 index f701a0a236..0000000000 --- a/reference/ps/functions/ps-lineto.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - - ps_lineto - Dibujar una línea - - - - &reftitle.description; - - boolps_lineto - resourcepsdoc - floatx - floaty - - - Añade una línea recta al trazado actual desde el punto actual hasta las coordenadas - dadas. Use la función ps_moveto para establecer el punto de inicio - de la línea. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - x - - - La coordenada x del punto final de la línea. - - - - - y - - - La coordenada y del punto final de la línea. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Dibujar un rectángulo - - -]]> - - - - - - - &reftitle.seealso; - - - ps_moveto - - - - - - - diff --git a/reference/ps/functions/ps-makespotcolor.xml b/reference/ps/functions/ps-makespotcolor.xml deleted file mode 100644 index 15ffb830b7..0000000000 --- a/reference/ps/functions/ps-makespotcolor.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - - - ps_makespotcolor - Crear un color directo - - - - &reftitle.description; - - intps_makespotcolor - resourcepsdoc - stringname - intreserved0 - - - Crea un color directo desde el color de relleno actual. El color de relleno debe ser - definido en los espacios de color RGB, CMYK o gris. El nombre del color directo puede ser un - nombre arbitrario. Un color directo se puede establecer como cualquier otro color - con la función ps_setcolor. Cuando el documento no se imprime, - sino que se muestra con un visualizador de postscript, se utiliza el color dado en el espacio - de color especificado. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - name - - - El nombre del color directo, p.ej. Pantone 5565. - - - - - - - - - &reftitle.returnvalues; - - El ID del nuevo color directo o 0 en caso de error. - - - - - &reftitle.examples; - - - Crear y utilizar un color directo - - -]]> - - - Este ejemplo crea el color directo "PANTONE 5565 C" que - es un verde oscuro (oliva) y rellena un rectángulo con el 50% de intensidad. - - - - - - - &reftitle.seealso; - - - ps_setcolor - - - - - - - diff --git a/reference/ps/functions/ps-moveto.xml b/reference/ps/functions/ps-moveto.xml deleted file mode 100644 index f3419f0a03..0000000000 --- a/reference/ps/functions/ps-moveto.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - - ps_moveto - Establecer el punto actual - - - - &reftitle.description; - - boolps_moveto - resourcepsdoc - floatx - floaty - - - Establece el punto actual a unas coordenadas nuevas. Si esta es la primera llamada a la función - ps_moveto después de haber finalizado un trazado previo, - se iniciará un nuevo trazado. Si esta función es llamada en mitad de un trazado - establecerá el punto actual e iniciará un subtrazado. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - x - - - La coordenada x del punto al que moverse. - - - - - y - - - La coordenada y del punto al que moverse. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_lineto - - - - - - - diff --git a/reference/ps/functions/ps-new.xml b/reference/ps/functions/ps-new.xml deleted file mode 100644 index 676f6f212a..0000000000 --- a/reference/ps/functions/ps-new.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - - ps_new - Crea un nuevo objeto de documento PostScript - - - - &reftitle.description; - - resourcefalseps_new - - - - Crea una nueva instancia de documento. No crea el fichero en el disco ni en la memoria. Simplemente prepara todo. - ps_new es normalmente seguida por una llamada a - ps_open_file para crear el documento PostScript. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Recurso de un documento PostScript&return.falseforfailure;. El valor de retorno es pasado a todas las demás funciones como primer argumento. - - - - - &reftitle.seealso; - - - ps_delete - - - - - - diff --git a/reference/ps/functions/ps-open-file.xml b/reference/ps/functions/ps-open-file.xml deleted file mode 100644 index 665ad78d09..0000000000 --- a/reference/ps/functions/ps-open-file.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - - ps_open_file - Abrir un fichero para su impresión - - - - &reftitle.description; - - boolps_open_file - resourcepsdoc - stringfilename - - - Crea un fichero en disco y escribe el documento PostScript en él. El - fichero será cerrado cuando se llame a la función ps_close. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - filename - - - El nombre del fichero postscript. - Si no se proporciona filename el documento será - creado en memoria y todas las salidas irán directas al visualizador. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_close - - - - - - - diff --git a/reference/ps/functions/ps-open-image-file.xml b/reference/ps/functions/ps-open-image-file.xml deleted file mode 100644 index fa51eec5bb..0000000000 --- a/reference/ps/functions/ps-open-image-file.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - - ps_open_image_file - Abre una imagen desde un fichero - - - - &reftitle.description; - - intps_open_image_file - resourcepsdoc - stringtype - stringfilename - stringstringparam - intintparam0 - - - Carga una imagen para su uso posterior. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - type - - - El tipo de la imagen. Los posibles valores son png, - jpeg, o eps. - - - - - filename - - - El nombre del fichero que contiene la información de la imagen. - - - - - stringparam - - - No se utiliza. - - - - - intparam - - - No se utiliza. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el identificador de la imagen, o cero en caso de error. El identificador es - un número positivo mayor que 0. - - - - - &reftitle.seealso; - - - ps_open_image - ps_place_image - ps_close_image - - - - - - - diff --git a/reference/ps/functions/ps-open-image.xml b/reference/ps/functions/ps-open-image.xml deleted file mode 100644 index 10b4b98b85..0000000000 --- a/reference/ps/functions/ps-open-image.xml +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - - - ps_open_image - Leer una imagen para su colocación posterior - - - - &reftitle.description; - - intps_open_image - resourcepsdoc - stringtype - stringsource - stringdata - intlength - intwidth - intheight - intcomponents - intbpc - stringparams - - - Lee una imagen que ya está disponible en memoria. El parámetro - source actualmente no se evalua y se asume que es - memory. La información de la imagen es una secuencia de píxeles que comienza - en la esquina superior izquierda y termina en la esquina inferior derecha. Cada píxel - consiste en componentes de color dados por components, y cada - componente tiene bpc bits. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - type - - - El tipo de la imagen. Los posibles valores son png, - jpeg, o eps. - - - - - source - - - No se utiliza. - - - - - data - - - La información de la imagen. - - - - - length - - - La longitud de la información de la imagen. - - - - - width - - - El ancho de la imagen. - - - - - height - - - El alto de la imagen. - - - - - components - - - El número de componentes de cada píxel. Puede ser - 1 (imágenes en escala de grises), 3 (imágenes rgb), o 4 (imágenes cmyk, rgba). - - - - - bpc - - - Número de bits por componente (normalmente 8). - - - - - params - - - - - - - - - - - &reftitle.returnvalues; - - Devuelve el identificador de la imagen, o cero en caso de error. El identificador es - un número positivo mayor que 0. - - - - - &reftitle.seealso; - - - ps_open_image_file - ps_place_image - ps_close_image - - - - - - - - diff --git a/reference/ps/functions/ps-open-memory-image.xml b/reference/ps/functions/ps-open-memory-image.xml deleted file mode 100644 index 41a9552ff5..0000000000 --- a/reference/ps/functions/ps-open-memory-image.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - ps_open_memory_image - Tomar una imagen de GD y devolverla como una imagen para colcarla en un documento PS - - - - &reftitle.description; - - intps_open_memory_image - resourcepsdoc - intgd - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - gd - - - - - - - - - - - - - diff --git a/reference/ps/functions/ps-place-image.xml b/reference/ps/functions/ps-place-image.xml deleted file mode 100644 index 6c1ec3f510..0000000000 --- a/reference/ps/functions/ps-place-image.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - - ps_place_image - Colocar una imágen en la página - - - - &reftitle.description; - - boolps_place_image - resourcepsdoc - intimageid - floatx - floaty - floatscale - - - Coloca una imagen cargada anteriormente en la página. La imagen puede ser redimensionada. - Si la imagen también debe rotarse, se ha de rotar antes el - sistema de coordenadas con la función ps_rotate. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - imageid - - - El identificador de recursos de la imagen, como el devuelto por las funciones - ps_open_image o - ps_open_image_file. - - - - - x - - - La coordenada x de la esquina inferior izquierda de la imagen. - - - - - y - - - La coordenada y de la esquina inferior izquierda de la imagen. - - - - - scale - - - El factor de escala de la imagen. Una escala de 1.0 resultará - en una resolución de 72 dpi, ya que cada píxel es equivalente a - 1 punto. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_open_image - ps_open_image_file - - - - - - - diff --git a/reference/ps/functions/ps-rect.xml b/reference/ps/functions/ps-rect.xml deleted file mode 100644 index 03c58717c4..0000000000 --- a/reference/ps/functions/ps-rect.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - - ps_rect - Dibujar un rectángulo - - - - &reftitle.description; - - boolps_rect - resourcepsdoc - floatx - floaty - floatwidth - floatheight - - - Dibuja un rectángulo con su esquina inferior izquierda en (x, - y). El rectángulo comienza y finaliza en su esquina inferior - izquierda. Si se llama a esta función fuera de un trazado iniciará un nuevo trazado. - Se es llamada dentro de un trazado añadirá el rectángulo como un subtrazado. Si - la última operación de dibujo no finaliza en la esquina inferior izquierda, existirá - un hueco en el trazado. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - x - - - La coordenada x de la esquina inferior izquierda del rectángulo. - - - - - y - - - La coordenada y de la esquina inferior izquierda del rectángulo. - - - - - width - - - El ancho de la imagen. - - - - - height - - - El alto de la imagen. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_arc - ps_circle - ps_lineto - - - - - - - diff --git a/reference/ps/functions/ps-restore.xml b/reference/ps/functions/ps-restore.xml deleted file mode 100644 index d82157c2e7..0000000000 --- a/reference/ps/functions/ps-restore.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - ps_restore - Restaurar un contexto previamente guardado - - - - &reftitle.description; - - boolps_restore - resourcepsdoc - - - Restaura un conexto de gráficos previamente guardado. Cualquier llamada a la función - ps_save debe estar acompañada por una llamada a - ps_restore. Todas las transformaciones de coordenadas, ajustes - de estilos de línea, ajustes de color, etc., son restauradas al estado - anterior de la llamada a la función ps_save. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_save - - - - - - - diff --git a/reference/ps/functions/ps-rotate.xml b/reference/ps/functions/ps-rotate.xml deleted file mode 100644 index 9c9bf871c9..0000000000 --- a/reference/ps/functions/ps-rotate.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - - - ps_rotate - Establecer el factor de rotación - - - - &reftitle.description; - - boolps_rotate - resourcepsdoc - floatrot - - - Establece la rotación del sistema de coordenadas. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - rot - - - El ángulo de rotación en grados. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Rotación del sistema de coordenadas - - -]]> - - - El ejemplo anterior ilustra una forma muy común de rotar un - gráfico (en este caso un rectángulo) simplemente rotando el - sistema de coordenadas. Ya que se asume que el origen del sistema de coordenadas del - gráfico es (0,0), el sistema de coordenadas de la página también es trasladado - para colocar los gráficos no en el extremo de la pagina. Se debe poner atención - en el orden de ps_translate y - ps_rotate. En el caso anterior el rectángulo es - rotado alrededor del punto (100, 100) en el sistema de coordenadas sin - trasladar. Si se cambian las dos sentencias se obtendrá un resultado - completamente diferente. - - - Para poder imprimir el texto siguiente en la posición original, todas - las modificaciones del sistema de coordenadas son encapsuladas en las funciones - ps_save y ps_restore. - - - - - - - &reftitle.seealso; - - - ps_scale - ps_translate - - - - - - - diff --git a/reference/ps/functions/ps-save.xml b/reference/ps/functions/ps-save.xml deleted file mode 100644 index deee689c57..0000000000 --- a/reference/ps/functions/ps-save.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - ps_save - Guardar el contexto actual - - - - &reftitle.description; - - boolps_save - resourcepsdoc - - - Guarda el contexto de gráficos actual, conteniendo ajustes de color, de traslación y - de rotación, y algunos más. Un contexto guardado puede ser restaurado con - ps_restore. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_restore - - - - - - - diff --git a/reference/ps/functions/ps-scale.xml b/reference/ps/functions/ps-scale.xml deleted file mode 100644 index e8e5f48ebc..0000000000 --- a/reference/ps/functions/ps-scale.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - - ps_scale - Estalecer el factor de escala - - - - &reftitle.description; - - boolps_scale - resourcepsdoc - floatx - floaty - - - Establece el factor de escala horizontal y vertical del sistema de coordenadas. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - x - - - El factor de escala en dirección horizontal. - - - - - y - - - El factor de escala en dirección vertical. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_rotate - ps_translate - - - - - - - diff --git a/reference/ps/functions/ps-set-border-color.xml b/reference/ps/functions/ps-set-border-color.xml deleted file mode 100644 index 10996adc3e..0000000000 --- a/reference/ps/functions/ps-set-border-color.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - - ps_set_border_color - Establecer el color del borde de las anotaciones - - - - &reftitle.description; - - boolps_set_border_color - resourcepsdoc - floatred - floatgreen - floatblue - - - Los vínculos añadidos con una de las funciones ps_add_weblink, - ps_add_pdflink, etc., se mostrarán con un - rectángulo circundante cuando el documento postscript es convertido a - pdf y visualizado en un visualizador de pdf. Este rectángulo no es visible en - el documento postscript. - Esta función establece el color de la línea del borde del rectángulo. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - red - - - El componente rojo del color del borde. - - - - - green - - - El componente verde del color del borde. - - - - - blue - - - El componente azul del color del borde. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_set_border_dash - ps_set_border_style - - - - - - - diff --git a/reference/ps/functions/ps-set-border-dash.xml b/reference/ps/functions/ps-set-border-dash.xml deleted file mode 100644 index 4656acb2d8..0000000000 --- a/reference/ps/functions/ps-set-border-dash.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - - ps_set_border_dash - Establece la longitud de las rayas del borde de las anotaciones - - - - &reftitle.description; - - boolps_set_border_dash - resourcepsdoc - floatblack - floatwhite - - - Los vínculos añadidos con una de las funciones ps_add_weblink, - ps_add_pdflink, etc. se mostrarán con un - rectángulo circundante cuando el documento postscript es convertido a - pdf y visualizado en un visualizador de pdf. Este rectángulo no es visible en - el documento postscript. - Esta función establece la longitud de las porciones negras y blancas de una - línea de borde discontinua. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - black - - - La longitud de la raya. - - - - - white - - - La longitud del hueco entre rayas. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_set_border_color - ps_set_border_style - - - - - - - diff --git a/reference/ps/functions/ps-set-border-style.xml b/reference/ps/functions/ps-set-border-style.xml deleted file mode 100644 index 084a674502..0000000000 --- a/reference/ps/functions/ps-set-border-style.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - - ps_set_border_style - Establecer el estilo del borde de las anotaciones - - - - &reftitle.description; - - boolps_set_border_style - resourcepsdoc - stringstyle - floatwidth - - - Los vínculos añadidos con una de las funciones ps_add_weblink, - ps_add_pdflink, etc. se mostrarán con un - rectángulo circundante cuando el documento postscript es convertido a - pdf y visualizado en un visualizador de pdf. Este rectángulo no es visible en - el documento postscript. - Esta función establece la apariencia y el ancho de la línea del borde. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - style - - - style puede ser solid o - dashed. - - - - - width - - - El ancho del borde. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_set_border_color - ps_set_border_dash - - - - - - - diff --git a/reference/ps/functions/ps-set-info.xml b/reference/ps/functions/ps-set-info.xml deleted file mode 100644 index 25b43cbf0b..0000000000 --- a/reference/ps/functions/ps-set-info.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - - - ps_set_info - Establecer los campos de información del documento - - - - &reftitle.description; - - boolps_set_info - resourcepsdoc - stringkey - stringvalue - - - Establece ciertos campos de información del documento. Estos campos se mostrarán - como un comentario en la cabecera del fichero PostScript. Si el documento es - convertido a pdf, estos campos también se usarán para la información del - documento. - - - El campo BoundingBox normalmente se establece al valor dado a la - primera página. Esto sólo funciona si no se ha llamado antes a la función - ps_findfont. En tal caso BoundingBox estará sin establecer - a menos que se establezca explícitamente con esta función. - - - Esta función ya no tendrá efecto cuando la cabecera del fichero - postscript ha sido escrita. Debe ser llamada antes de la primera página - o de la primera llamada a la función ps_findfont. - - - - - &reftitle.parameters; - - - - psdoc - - - Un identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - key - - - El nombre del campo de información a establecer. Los valores que se pueden - establecer son Keywords (palabras clave), Subject (asunto), - Title (título), Creator (creador), - Author (autor), BoundingBox (caja circundante), y - Orientation (orientación). Tenga en cuenta que algunos de ellos tienen un - significado para los visualizadoes de PostScript. - - - - - value - - - El valor del campo de información. El campo - Orientation puede ser establecido a - Portrait (horizontal) o Landscape (vertical). El campo - BoundingBox es una cadena de caracteres que consiste en cuatro números. - Los dos primeros son las coordenadas de la esquina inferior izquierda de - la página. Los dos últimos son las coordenadas de la esquina - superior derecha. - - - - Hasta la versión 0.2.6 de pslib, los campos BoundingBox y Orientation - eran sobrescritos por la función ps_begin_page, - a menos que se llamara antes a la función ps_findfont. - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_findfont - ps_begin_page - - - - - - - diff --git a/reference/ps/functions/ps-set-parameter.xml b/reference/ps/functions/ps-set-parameter.xml deleted file mode 100644 index 3e81ab4dca..0000000000 --- a/reference/ps/functions/ps-set-parameter.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - - ps_set_parameter - Establecer ciertos parámetros - - - - &reftitle.description; - - boolps_set_parameter - resourcepsdoc - stringname - stringvalue - - - Establece varios parámetros que son utilizados por muchas funciones. Los parámetros son por - definción valores de tipo string. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - name - - - Para una lista de los posibles nombres véase la función ps_get_parameter. - - - - - value - - - El valor del parámetro. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_get_parameters - ps_set_value - - - - - - - diff --git a/reference/ps/functions/ps-set-text-pos.xml b/reference/ps/functions/ps-set-text-pos.xml deleted file mode 100644 index 048cbc3bb9..0000000000 --- a/reference/ps/functions/ps-set-text-pos.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - - - ps_set_text_pos - Establecer la posición de la salida de texto - - - - &reftitle.description; - - boolps_set_text_pos - resourcepsdoc - floatx - floaty - - - Establece la posición de la siguiente salida de texto. Alternativamente se puede establecer los - valores x e y por separado llamando a la función ps_set_value y - eligiendo textx y texty respectivamente como - el nombre del valor. - - - Si se ha de imprimir el texto en una cierta posición es más conveniente - utilizar la función ps_show_xy en lugar de establecer la posición del texto - y llamar a la función ps_show. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - x - - - La coordenada x de la nueva posición del texto. - - - - - y - - - La coordenada y de la nueva posición del texto. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Colocar texto en una posición dada - - -]]> - - - - - - - &reftitle.seealso; - - - ps_set_value - ps_show - - - - - - - diff --git a/reference/ps/functions/ps-set-value.xml b/reference/ps/functions/ps-set-value.xml deleted file mode 100644 index 336b9695fe..0000000000 --- a/reference/ps/functions/ps-set-value.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - - ps_set_value - Establecer ciertos valores - - - - &reftitle.description; - - boolps_set_value - resourcepsdoc - stringname - floatvalue - - - Establece varios valores que son utilizados por muchas funciones. Los parámetros son por - definición valores de tipo float. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - name - - - El nombre dado por name puede ser uno de los siguientes: - - - textrendering - - - La manera en que se muestra el texto. - - - - - textx - - - La coordenada x para la impresión del texto. - - - - - texty - - - La coordenada y para la impresión del texto. - - - - - wordspacing - - - La distancia entre palabras relativa al ancho de un espacio. - - - - - leading - - - La distancia entre líneas en píxeles. - - - - - - - - - value - - - El valor del parámetro. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_get_value - ps_set_parameter - - - - - - - diff --git a/reference/ps/functions/ps-setcolor.xml b/reference/ps/functions/ps-setcolor.xml deleted file mode 100644 index 741fe81153..0000000000 --- a/reference/ps/functions/ps-setcolor.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - - - ps_setcolor - Establece el color actual - - - - &reftitle.description; - - boolps_setcolor - resourcepsdoc - stringtype - stringcolorspace - floatc1 - floatc2 - floatc3 - floatc4 - - - Establece el color para el dibujo, relleno o ambos. - - - - - &reftitle.parameters; - - - - psdoc - - - Identificador de un fichero postscript devuelto por - ps_new. - - - - - type - - - El argumento type puede ser - both, fill o - fillstroke. - - - - - colorspace - - - El espacio de color puede ser gray, - rgb, cmyk, - spot, pattern. Dependiendo del - espacio de color, pueden usarse el primer, los tres primeros o todos los - argumentos. - - - - - c1 - - - Dependiendo del espacio de color, este valor puede ser el componente rojo (rgb), el componente cian (cmyk), el valor de gris (gris), el identificador de la mancha de color o el identificador del patrón. - - - - - c2 - - - Dependiendo del espacio de color, este valor puede ser el componente verde (rgb) o el componente magenta (cmyk). - - - - - c3 - - - Dependiendo del espacio de color, este valor puede ser el componente azul (rgb) o el componente amarillo (cymk). - - - - - c4 - - - Este argumento debe fijarse solo en el espacio de color cymk y especifica el componente negro. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.notes; - - - El segundo argumento no siempre es evaluado actualmente. La color puede ser establecida para rellenar y dibujar como si - fillstroke hubiera sido pasado. - - - - - - diff --git a/reference/ps/functions/ps-setdash.xml b/reference/ps/functions/ps-setdash.xml deleted file mode 100644 index 8b9f36442a..0000000000 --- a/reference/ps/functions/ps-setdash.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - - ps_setdash - Establecer la apariencia de una línea discontinua - - - - &reftitle.description; - - boolps_setdash - resourcepsdoc - floaton - floatoff - - - Establece la longitud de las porciones negras y blancas de una línea discontinua. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - on - - - La longitud de la raya. - - - - - off - - - La longitud del hueco entre rayas. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_setpolydash - - - - - - - diff --git a/reference/ps/functions/ps-setflat.xml b/reference/ps/functions/ps-setflat.xml deleted file mode 100644 index 37e7cb35ab..0000000000 --- a/reference/ps/functions/ps-setflat.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - ps_setflat - Establecer la planicidad - - - - &reftitle.description; - - boolps_setflat - resourcepsdoc - floatvalue - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - value - - - El valor dado a value debe estar entre 0.2 y 1. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/ps/functions/ps-setfont.xml b/reference/ps/functions/ps-setfont.xml deleted file mode 100644 index 359aa3652e..0000000000 --- a/reference/ps/functions/ps-setfont.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - - ps_setfont - Establecer la fuente a usar para la siguiente impresión - - - - &reftitle.description; - - boolps_setfont - resourcepsdoc - intfontid - floatsize - - - Establece una fuente, la cual ha de ser cargada antes con la función - ps_findfont. Imprimir texto sin establecer una fuente - resultará en un error. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - fontid - - - El identificador de la fuente, como el devuelto por la función ps_findfont. - - - - - size - - - El tamaño de la fuente. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_findfont - ps_set_text_pos para un ejemplo. - - - - - - - diff --git a/reference/ps/functions/ps-setgray.xml b/reference/ps/functions/ps-setgray.xml deleted file mode 100644 index a117bdae91..0000000000 --- a/reference/ps/functions/ps-setgray.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - - ps_setgray - Establecer el valor de gris - - - - &reftitle.description; - - boolps_setgray - resourcepsdoc - floatgray - - - Establece el valor de gris para todas las operaciones de dibujo siguientes. - - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - gray - - - El valor debe estar entre 0 (blanco) and 1 (negro). - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_setcolor - - - - - - - diff --git a/reference/ps/functions/ps-setlinecap.xml b/reference/ps/functions/ps-setlinecap.xml deleted file mode 100644 index 74d6e729aa..0000000000 --- a/reference/ps/functions/ps-setlinecap.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - ps_setlinecap - Establecer la apariencia de los extremos de línea - - - - &reftitle.description; - - boolps_setlinecap - resourcepsdoc - inttype - - - Establece la apariencia de los extremos de línea. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - type - - - El tipo de extremo de línea. Los valores posibles son - PS_LINECAP_BUTT, - PS_LINECAP_ROUND, o - PS_LINECAP_SQUARED. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_setlinejoin - ps_setlinewidth - ps_setmiterlimit - - - - - - - diff --git a/reference/ps/functions/ps-setlinejoin.xml b/reference/ps/functions/ps-setlinejoin.xml deleted file mode 100644 index 7f9a16cfd3..0000000000 --- a/reference/ps/functions/ps-setlinejoin.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - ps_setlinejoin - Establecer cómo están unidas las líneas conectadas - - - - &reftitle.description; - - boolps_setlinejoin - resourcepsdoc - inttype - - - Establece cómo se unen las líneas - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - type - - - La forma de unir las líneas. Los valores posibles son - PS_LINEJOIN_MITER, - PS_LINEJOIN_ROUND, o - PS_LINEJOIN_BEVEL. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_setlinecap - ps_setlinewidth - ps_setmiterlimit - - - - - - - diff --git a/reference/ps/functions/ps-setlinewidth.xml b/reference/ps/functions/ps-setlinewidth.xml deleted file mode 100644 index 38c4b9e65b..0000000000 --- a/reference/ps/functions/ps-setlinewidth.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - - ps_setlinewidth - Establecer el ancho de una línea - - - - &reftitle.description; - - boolps_setlinewidth - resourcepsdoc - floatwidth - - - Esteblece el ancho de línea para todas las operaciones de dibujo siguientes. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - width - - - El ancho de las líneas en puntos. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_setlinecap - ps_setlinejoin - ps_setmiterlimit - - - - - - - diff --git a/reference/ps/functions/ps-setmiterlimit.xml b/reference/ps/functions/ps-setmiterlimit.xml deleted file mode 100644 index 6691fa9359..0000000000 --- a/reference/ps/functions/ps-setmiterlimit.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - - ps_setmiterlimit - Establecer el límite del inglete - - - - &reftitle.description; - - boolps_setmiterlimit - resourcepsdoc - floatvalue - - - Si dos líneas se unen en un ángulo pequeño y la unión de líneas está establecida a - PS_LINEJOIN_MITER, - el pico resultante será muy largo. El límite de inglete es la proporción - máxima entre la longitud del inglete (la longitud del pico) y del ancho de línea. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - value - - - La proporción máxima entre la longitud del inglete y del ancho de línea. Los valores - grandes (> 10) resultarán en picos muy largos cuando dos líneas se encuentren - en un ángulo pequeño. Mantenga el predeterminado a menos que sepa lo que está haciendo. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_setlinecap - ps_setlinejoin - ps_setlinewidth - - - - - - - diff --git a/reference/ps/functions/ps-setoverprintmode.xml b/reference/ps/functions/ps-setoverprintmode.xml deleted file mode 100644 index 63d414cff2..0000000000 --- a/reference/ps/functions/ps-setoverprintmode.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - ps_setoverprintmode - Establecer el modo de sobreimpresión - - - - &reftitle.description; - - boolps_setoverprintmode - resourcepsdoc - intmode - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - mode - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/ps/functions/ps-setpolydash.xml b/reference/ps/functions/ps-setpolydash.xml deleted file mode 100644 index fce13957b0..0000000000 --- a/reference/ps/functions/ps-setpolydash.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - - ps_setpolydash - Establecer la apariencia de una línea discontinua - - - - &reftitle.description; - - boolps_setpolydash - resourcepsdoc - floatarr - - - Establece la longitud de las porciones negras y blancas de una línea discontinua. - La función ps_setpolydash se usa para establecer patrones discontinuos - más complejos. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - arr - - - arr es una lista de elementos de longitud alternados para - las porciones negras y blancas. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Dibujar una línea discontinua - - -]]> - - - Este ejemplo dibuja una línea con rayas de 10 y 2 puntos de longitud, y - huecos de 5 puntos entre ellas. - - - - - - - &reftitle.seealso; - - - ps_setdash - - - - - - - diff --git a/reference/ps/functions/ps-shading-pattern.xml b/reference/ps/functions/ps-shading-pattern.xml deleted file mode 100644 index 4c9262f38f..0000000000 --- a/reference/ps/functions/ps-shading-pattern.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - - ps_shading_pattern - Crea un patrón basado en el tono - - - - &reftitle.description; - - intfalseps_shading_pattern - resourcepsdoc - intshadingid - stringoptlist - - - Crea un patrón basado en el tono, que debe haber sido creado previamente con - ps_shading. Los patrones de tono pueden ser utilizados - como patrones regulares. - - - - - &reftitle.parameters; - - - - psdoc - - - Identificador de un fichero postscript devuelto por - ps_new. - - - - - shadingid - - - El identificador de tono creado previamente con - ps_shading. - - - - - optlist - - - Este argumento no se utiliza actualmente. - - - - - - - - - &reftitle.returnvalues; - - El identificador del patrón &return.falseforfailure;. - - - - - &reftitle.seealso; - - - ps_shading - ps_shfill - - - - - - diff --git a/reference/ps/functions/ps-shading.xml b/reference/ps/functions/ps-shading.xml deleted file mode 100644 index a07609dc03..0000000000 --- a/reference/ps/functions/ps-shading.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - - - ps_shading - Crea un tono para uso futuro - - - - &reftitle.description; - - intfalseps_shading - resourcepsdoc - stringtype - floatx0 - floaty0 - floatx1 - floaty1 - floatc1 - floatc2 - floatc3 - floatc4 - stringoptlist - - - Crea un tono, que puede ser utilizado por ps_shfill o - ps_shading_pattern. - - - El color del tono puede ser cualquier color de espacio excepto para - pattern. - - - - - &reftitle.parameters; - - - - psdoc - - - Identificador de un fichero postscript devuelto por - ps_new. - - - - - type - - - El tipo de tono puede ser radial o - axial. Cada tono comienza con el color de relleno actual y termina con el valor de color dado pasado en los argumentos c1 a c4 - (véase ps_setcolor para su significado). - - - - - x0, x1, y0, y1 - - - Las coordenadas x0, y0, - x1, y1 son el punto de inicio y fin del tono. Si el tipo de tono es radial, los dos puntos son los puntos medios del inicio y fin del círculo. - - - - - c1, c2, c3, c4 - - - Véase ps_setcolor para su significado. - - - - - optlist - - - Si el tono es de tipo radial, el - optlist debe contener también los argumentos - r0 y r1 con el radio de inicio y fin del círculo. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un identificador del patrón &return.falseforfailure;. - - - - - &reftitle.seealso; - - - ps_shading_pattern - ps_shfill - - - - - - diff --git a/reference/ps/functions/ps-shfill.xml b/reference/ps/functions/ps-shfill.xml deleted file mode 100644 index 7076678dd5..0000000000 --- a/reference/ps/functions/ps-shfill.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - ps_shfill - Rellenar un área con un sombreado - - - - &reftitle.description; - - boolps_shfill - resourcepsdoc - intshadingid - - - Rellena un área con un sombreado, que ha de ser creado antes con la función - ps_shading. Esta es una manera alternativa de crear - un patrón desde un sombreado con la función ps_shading_pattern y usar - el patrón como color de relleno. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - shadingid - - - El identificador de un sombreado previamente creado con la función - ps_shading. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_shading - ps_shading_pattern - - - - - - - diff --git a/reference/ps/functions/ps-show-boxed.xml b/reference/ps/functions/ps-show-boxed.xml deleted file mode 100644 index 45f224c641..0000000000 --- a/reference/ps/functions/ps-show-boxed.xml +++ /dev/null @@ -1,324 +0,0 @@ - - - - - - - - ps_show_boxed - Escritura de texto en una caja - - - - &reftitle.description; - - intps_show_boxed - resourcepsdoc - stringtext - floatleft - floatbottom - floatwidth - floatheight - stringhmode - stringfeature - - - ps_show_boxed escribe texto en una caja dada. - La esquina inferior izquierda de la caja se encuentra en (left, - bottom). Se insertarán saltos de línea donde sea necesario. - Los espacios múltiples se tratan como uno solo. Las tabulaciones se tratan como espacios. - - - El texto será ligado si el parámetro hyphenation está - fijado a &true; y el parámetro hyphendict contiene - un archivo válido para un archivo de ligadura. El espacio entre líneas se toma - de la valor leading. Los párrafos pueden ser separados - por una línea vacía como en TeX. Si el valor parindent - está fijado a un valor > 0.0, entonces las primeras n líneas serán indentadas. - El número n de líneas está fijado por el parámetro numindentlines. - Para prever la indentación de los primeros m párrafos, fije el valor - parindentskip a un número positivo. - - - - - &reftitle.parameters; - - - - psdoc - - - Identificador de un archivo PostScript devuelto por - ps_new. - - - - - text - - - El texto a ser mostrado en la caja dada. - - - - - left - - - La posición x de la esquina inferior izquierda de la caja. - - - - - bottom - - - La posición y de la esquina inferior izquierda de la caja. - - - - - width - - - Ancho de la caja. - - - - - height - - - Altura de la caja. - - - - - hmode - - - El parámetro hmode puede ser - justify, fulljustify, - right, left, - o center. La diferencia entre - justify y fulljustify afecta - simplemente a la última línea de la caja. - En el modo fulljustify, la última línea será - justificada de izquierda a derecha a menos que sea también la última - línea del párrafo. En el modo "justify", - el texto será siempre justificado a la izquierda. - - - - - feature - - - - - - - - - - - Parámetros utilizados - - La escritura de ps_show_boxed puede ser configurada con - varios parámetros y valores que pueden ser fijados por ps_set_parameter - o ps_set_value. Además de los parámetros y valores que afectan - la escritura del texto, los siguientes parámetros y valores son evaluados. - - - leading (valor) - - - Distancia entre las líneas de base de dos líneas consecutivas. - - - - - linebreak (parámetro) - - - Fijado a &true; si se desea un retorno de carro para iniciar una - nueva línea en lugar de tratarlo como un espacio. Por omisión, - este parámetro vale &false;. - - - - - parbreak (parámetro) - - - Fijado a &true; si se desea un retorno de carro de una sola línea - para iniciar un nuevo párrafo en lugar de tratarlo como un espacio. - Por omisión, este parámetro vale &true;. - - - - - hyphenation (parámetro) - - - Fijado a &true; para activar las ligaduras. Esto requiere un - diccionario fijado por el parámetro hyphendict. - Por omisión, este parámetro vale &false;. - - - - - hyphendict (parámetro) - - - Archivo del diccionario utilizado para un patrón de ligadura (ver más abajo). - - - - - hyphenminchar (valor) - - - El número de caracteres que debe haber al menos a la izquierda antes o - después del guión. Esto implica que solo las palabras con al menos el doble - de este valor pueden ser ligadas. El valor por omisión es tres. Fijar - un valor de cero resultará en el valor por omisión. - - - - - parindent (valor) - - - Fija el número de espacio en píxeles para la indentación de las primeras m - líneas de un párrafo. m puede ser configurado con el valor - numindentlines. - - - - - parskip (valor) - - - Fija el número de espacio extra en píxeles entre los párrafos. Por - omisión, al poner 0, el resultado será una distancia normal - entre las líneas. - - - - - numindentlines (valor) - - - Número de líneas desde el inicio del párrafo que serán indentadas. - Por omisión, este valor vale 1. - - - - - parindentskip (valor) - - - Número de párrafos en la caja a los cuales las primeras líneas no - serán indentadas. Por omisión, este valor vale 0. - Esto es útil para los párrafos inmediatamente después de una sección de - encabezado o texto que comienza en una segunda caja. En ambos casos, - debe ser fijado a 1. - - - - - linenumbermode (parámetro) - - - Fija cómo se numeran las líneas. Los valores posibles son - box para numerar las líneas en toda la caja o - paragraph para numerar las líneas en cada párrafo. - - - - - linenumberspace (valor) - - - El espacio para la columna dejado de las líneas numeradas que contiene - el número de línea. El número de las líneas será justificado a la derecha - en esta columna. Por omisión, este valor vale 20. - - - - - linenumbersep (valor) - - - El espacio entre la columna con el número de líneas y la línea - misma. Por omisión, este valor vale 5. - - - - - - - - - Ligadura - - El texto es ligado si el parámetro hyphenation está fijado a - &true; y un diccionario válido de ligadura está fijado. pslib no proporciona - su propio diccionario de ligadura, sino que utiliza uno de openoffice, scribus - o koffice. Puede encontrar estos diccionarios para diferentes idiomas en uno - de los siguientes directorios si el programa está instalado: - - - /usr/share/apps/koffice/hyphdicts/ - - - /usr/lib/scribus/dicts/ - - - /usr/lib/openoffice/share/dict/ooo/ - - - Actualmente, Scribus parece tener los diccionarios de ligadura más completos. - - - - - - &reftitle.returnvalues; - - Número de caracteres que no pueden ser escritos. - - - - - &reftitle.seealso; - - - ps_continue_text - - - - - - diff --git a/reference/ps/functions/ps-show-xy.xml b/reference/ps/functions/ps-show-xy.xml deleted file mode 100644 index c34309413d..0000000000 --- a/reference/ps/functions/ps-show-xy.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - - ps_show_xy - Imprimir texto en una posición dada - - - - &reftitle.description; - - boolps_show_xy - resourcepsdoc - stringtext - floatx - floaty - - - Imprime texto en la posición de texto dada. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - text - - - El texto a imprimir. - - - - - x - - - La coordenada x de la esquina inferior izquierda de la caja circundante del texto. - - - - - y - - - La coordenada y de la esquina inferior izquierda de la caja circundante del texto. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_continue_text - ps_show - - - - - - - diff --git a/reference/ps/functions/ps-show-xy2.xml b/reference/ps/functions/ps-show-xy2.xml deleted file mode 100644 index 7a33646658..0000000000 --- a/reference/ps/functions/ps-show-xy2.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - ps_show_xy2 - Imprimir texto en una posición - - - - &reftitle.description; - - boolps_show_xy2 - resourcepsdoc - stringtext - intlen - floatxcoor - floatycoor - - &warn.undocumented.func; - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/ps/functions/ps-show.xml b/reference/ps/functions/ps-show.xml deleted file mode 100644 index 338b54b8bd..0000000000 --- a/reference/ps/functions/ps-show.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - - - ps_show - Imprimir texto - - - - &reftitle.description; - - boolps_show - resourcepsdoc - stringtext - - - Imprime un texto en la posición de texto actual. La posición de texto puede ser establecida - almacenado las coordenadas x e y en los valores textx - y texty con la función - ps_set_value. La función emitirá un - error si no se estableció antes una fuente con la función ps_setfont. - - - ps_show evalúa los siguientes parámetros y valores - establecidos por las funciones ps_set_parameter y - ps_set_value: - - - - charspacing (valor) - - - Distancia entre dos glifos consecutivos. Si este valor es distinto de - cero todas las ligaduras serán resueltas. Están permitidos valores menores - que cero. - - - - - kerning (parámetro) - - - Establecer este parámetro a "false" desactivará el interletraje. El interletraje está - activado por defecto. - - - - - ligatures (parámetro) - - - Establecer esta parámetro a "false" desactivará el uso de ligaduras. - Las ligaduras están activadas por defecto. - - - - - underline (parámetro) - - - Establecer esta parámetro a "true" activará el subrayado. El subrayado - está desctivado por defecto. - - - - - overline (parámetro) - - - Establecer esta parámetro a "true" activará el suprarayado. El suprarayado está - desctivado por defecto. - - - - - strikeout (parámetro) - - - Establecer esta parámetro a "true" activará el tachado. El tachado - está desctivado por defecto. - - - - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - text - - - El texto a imprimir. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_continue_text - ps_show_xy - ps_setfont - - - - - - - diff --git a/reference/ps/functions/ps-show2.xml b/reference/ps/functions/ps-show2.xml deleted file mode 100644 index 48b5f86b27..0000000000 --- a/reference/ps/functions/ps-show2.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - ps_show2 - Imprimir texto en la posición actual - - - - &reftitle.description; - - boolps_show2 - resourcepsdoc - stringtext - intlen - - - Imprime texto en la posición actual. No imprime más de len caracteres. - - - - - &reftitle.parameters; - - - - psdoc - - - Un identificador de recurso del fichero postscript, - como el devuelto por la función ps_new. - - - - - text - - - El texto a imprimir. - - - - - len - - - El número máximo de caracteres a imprimir. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/ps/functions/ps-string-geometry.xml b/reference/ps/functions/ps-string-geometry.xml deleted file mode 100644 index 773e85f431..0000000000 --- a/reference/ps/functions/ps-string-geometry.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - - ps_string_geometry - Establecer la geometría de una cadena de caracteres - - - - &reftitle.description; - - arrayps_string_geometry - resourcepsdoc - stringtext - intfontid0 - floatsize0.0 - - - Esta función es similar a la función ps_stringwidth, excepto que devuelve - un array de dimensiones que contiene el ancho, el ascendente y el descendente - del texto. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - text - - - El texto por el cual se calcula la geometría. - - - - - fontid - - - El identificador de la fuente a usar. Si no se especifica una fuente - se usará la fuente actual. - - - - - size - - - El tamaño de la fuente. Si no se especifica un tamaño se usará el tamaño - actual. - - - - - - - - - &reftitle.returnvalues; - - Un array con las dimensiones de una cadena. El elemento 'width' contiene el - ancho de la cadena devuelto por la función ps_stringwidth. El - elemento 'descender' contiene el descendente máximo y 'ascender' el - ascendente máximo de la cadena. - - - - - &reftitle.seealso; - - - ps_continue_text - ps_stringwidth - - - - - - - diff --git a/reference/ps/functions/ps-stringwidth.xml b/reference/ps/functions/ps-stringwidth.xml deleted file mode 100644 index 2e926218a2..0000000000 --- a/reference/ps/functions/ps-stringwidth.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - - ps_stringwidth - Obtener el ancho de una cadena - - - - &reftitle.description; - - floatps_stringwidth - resourcepsdoc - stringtext - intfontid0 - floatsize0.0 - - - Calcula el ancho de una cadena en puntos si fue impresa - con la fuente y tamaño de fuente dados. - Esta función necesita un fichero de métrica de fuente - de Adobe para calcular el ancho preciso. Si la partición silábica está activada - se tomará en cuenta. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - text - - - El texto por el que calcular el ancho. - - - - - fontid - - - El identificador de la fuente a usar. Si no se especifica ninguna fuente - se usará la fuente actual. - - - - - size - - - El tamaño de la fuente. Si no se especifica ningún tamaño se usará el - tamaño actual. - - - - - - - - - &reftitle.returnvalues; - - El ancho de una cadena en puntos. - - - - - &reftitle.seealso; - - - ps_string_geometry - - - - - - - diff --git a/reference/ps/functions/ps-stroke.xml b/reference/ps/functions/ps-stroke.xml deleted file mode 100644 index 5c0c703725..0000000000 --- a/reference/ps/functions/ps-stroke.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - ps_stroke - Dibujar el trazado actual - - - - &reftitle.description; - - boolps_stroke - resourcepsdoc - - - Dibuja el trazado construido previamente con las llamadas a las funciones de dibujo como - ps_lineto. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_closepath_stroke - ps_fill - ps_fill_stroke - - - - - - - diff --git a/reference/ps/functions/ps-symbol-name.xml b/reference/ps/functions/ps-symbol-name.xml deleted file mode 100644 index aedc6c2d30..0000000000 --- a/reference/ps/functions/ps-symbol-name.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - - ps_symbol_name - Obtener el nombre de un glifo - - - - &reftitle.description; - - stringps_symbol_name - resourcepsdoc - intord - intfontid0 - - - Esta función necesita un fichero de métrica de fuentes de Adobe para conocer los glifos que están - disponibles. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - ord - - - El parámetro ord es la posición del glifo - en el vector de codificación de fuente. - - - - - fontid - - - El identificador de la fuente a usar. Si no se especifica ninguna fuente - se usará la fuente actual. - - - - - - - - - &reftitle.returnvalues; - - El nombre de un glifo de la fuente dada. - - - - - &reftitle.seealso; - - - ps_symbol - ps_symbol_width - - - - - - - diff --git a/reference/ps/functions/ps-symbol-width.xml b/reference/ps/functions/ps-symbol-width.xml deleted file mode 100644 index a2ac082a6a..0000000000 --- a/reference/ps/functions/ps-symbol-width.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - - ps_symbol_width - Obtener el ancho de un glifo - - - - &reftitle.description; - - floatps_symbol_width - resourcepsdoc - intord - intfontid0 - floatsize0.0 - - - Calcula el ancho de un glifo en puntos si fue impreso con la fuente - y el tamaño de fuente dados. Esta función necesita un fichero de métrica de fuentes de Adobe para - calcular el ancho preciso. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - ord - - - La posición del glifo en el vector de codificación de fuente. - - - - - fontid - - - El identificador de la fuente a usar. Si no se especifica ninguna fuente - se usará la fuente actual. - - - - - size - - - El tamaño de la fuente. Si no se especifica ningún tamaño se usará el - tamaño actual. - - - - - - - - - &reftitle.returnvalues; - - El ancho de un glifo en puntos. - - - - - &reftitle.seealso; - - - ps_symbol - ps_symbol_name - - - - - - - diff --git a/reference/ps/functions/ps-symbol.xml b/reference/ps/functions/ps-symbol.xml deleted file mode 100644 index 607aa3e087..0000000000 --- a/reference/ps/functions/ps-symbol.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - - ps_symbol - Imprimir un glifo - - - - &reftitle.description; - - boolps_symbol - resourcepsdoc - intord - - - Imprime el glifo de la posición ord del vector de - codificación de fuentes de la fuente actual. La codificación de fuente para una fuente se puede - establecer cargando la fuente con la función ps_findfont. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - ord - - - La posición del glifo en el vector de codificación de fuentes. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ps_symbol_name - ps_symbol_width - - - - - - - diff --git a/reference/ps/functions/ps-translate.xml b/reference/ps/functions/ps-translate.xml deleted file mode 100644 index ae6af04443..0000000000 --- a/reference/ps/functions/ps-translate.xml +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - - - ps_translate - Establecer una traslación - - - - &reftitle.description; - - boolps_translate - resourcepsdoc - floatx - floaty - - - Establece un nuevo punto inicial del sistema de coordenadas. - - - - - &reftitle.parameters; - - - - psdoc - - - El identificador de recursos del fichero postscript, - como el devuelto por la función ps_new. - - - - - x - - - La coordenada x del origen del sistema de coordenadas trasladado. - - - - - y - - - La coordenada y del origen del sistema de coordenadas trasladado. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Traslación del sistema de coordenadas - - - -]]> - - El ejemplo anterior demuestra dos maneras posibles de colocar - un gráfico (en este caso un rectángulo) en cualquier posición de la página, - mientras que el gráfico mismo utiliza su propio sistema de coordenadas. El truco está - en cambiar el origen del sistema de coordenadas actual antes de dibujar - el rectángulo. La traslación tiene que ser deshecha después de dibujar - el gráfico. - - - En la segunda página se aplica un enfoque algo diferente y más elegante. - En vez de deshacer la traslación con una segunda llamada a la función - ps_translate el contexto de gráficos se guarda antes - de modificar el sistema de coordenadas y se restaura después de dibujar el rectángulo. - - - - - - - &reftitle.seealso; - - - ps_scale - ps_rotate - - - - - - - diff --git a/reference/ps/reference.xml b/reference/ps/reference.xml deleted file mode 100644 index 2dc1ff29ad..0000000000 --- a/reference/ps/reference.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - &Functions; de PS - - -
    - Información de contacto - - Si tiene comentarios, correcciones de errores, mejoras para esta extensión o - para pslib, por favor envíeme un correo - steinm@php.net. Cualquier ayuda es - bienvenida. - -
    - -
    - - &reference.ps.entities.functions; - -
    - - diff --git a/reference/ps/setup.xml b/reference/ps/setup.xml deleted file mode 100644 index f85567c578..0000000000 --- a/reference/ps/setup.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - Se requiere al menos pslib >= 0.1.12. La biblioteca ps - (pslib) está disponible en &url.pslib;. - -
    - - - - &reference.ps.configure; - - - -
    - &reftitle.resources; - - Esta extensión define un recurso de documento PostScript, devuelto - por la función ps_new. - -
    - - -
    - - diff --git a/reference/pthreads/book.xml b/reference/pthreads/book.xml deleted file mode 100644 index 80f8de75cb..0000000000 --- a/reference/pthreads/book.xml +++ /dev/null @@ -1,175 +0,0 @@ - - - - - - - pthreads - pthreads - - - &reftitle.intro; - - pthreads es una API orientada a objetos que aporta todas las herramientas necesarias para - el multithreading en PHP. - Las aplicaciones PHP pueden crear, leer, escribir, ejecutar - y sincronizar Threads, Workers, y objetos Threaded. - - - - Esta extensión es considerada no mantenida y obsoleta. - - - - - Considerar el uso de parallel en su lugar. - - - - - La extensión pthreads no puede ser utilizada en un entorno de - servidor Web. El threading en PHP se limita por tanto a aplicaciones basadas - en CLI únicamente. - - - - - pthreads (v3) puede ser utilizado únicamente con PHP 7.2+ debido a un - modo ZTS peligroso en PHP 7.0 y 7.1. - - - - La clase Threaded constituye la base de la - funcionalidad que permite a pthreads funcionar. Expone los métodos - de sincronización y algunas interfaces útiles para el programador. - - - La clase Thread permite crear threads extendiéndola simplemente e - implementando un método run. Todos los miembros pueden ser escritos y leídos - por cualquier contexto con una referencia al thread. Todo contexto puede igualmente ejecutar - todos los métodos públicos y protegidos. El cuerpo del método run será ejecutado - en un thread separado cuando el método Thread::start - de la implementación sea llamado desde el contexto que lo creó. Solo el - contexto que crea un thread puede iniciarlo y unirse a él. - - - La clase Worker tiene un estado persistente y estará - disponible desde la llamada a Thread::start (un método heredado) - hasta que el objeto esté fuera de alcance, o sea explícitamente detenido (vía - Worker::shutdown). Todo contexto con una referencia al objeto Worker - puede apilar tareas en el Worker (vía Worker::stack), donde estas - tareas serán ejecutadas por el Worker en un thread separado. El método - run de un objeto worker es ejecutado antes de cualquier objeto de la pila del worker, - lo que permite que los recursos sean inicializados para que los objetos a ejecutar puedan usarlos. - - - La clase Pool se utiliza para crear un grupo de - workers para distribuir objetos Threaded entre ellos. - Es el medio más fácil y eficiente de utilizar múltiples threads en aplicaciones PHP. - - - - La clase Pool no extiende la clase - Threaded, y por tanto los objetos basados en pool son - considerados como objetos PHP normales. En consecuencia, sus instancias no - deben ser compartidas entre contextos diferentes. - - - - La clase Volatile es nueva para pthreads v3. - Se utiliza para designar las propiedades Threaded mutables - de las clases Threaded (ya que estas son ahora inmutables por defecto). - También se utiliza para almacenar arrays PHP en contextos Threaded. - - - La sincronización es una capacidad importante al realizar threading. Todos los - objetos creados por pthreads han sido construidos con sincronización en la forma - (que será familiar a los programadores Java) de - Threaded::wait y - Threaded::notify. La llamada a - Threaded::wait sobre un objeto hará que el contexto - espere a que otro contexto llame a - Threaded::notify sobre el mismo objeto. Este mecanismo - permite una sincronización poderosa entre los objetos - Threaded en PHP. - - - - Todo objeto previsto para ser utilizado en una parte multithread de la aplicación - debe extender Threaded. - - - - Almacenamiento de datos: En regla general, todos los tipos de datos que puedan ser serializados pueden - ser utilizados como miembro de un objeto Threaded, pueden ser leídos y escritos desde cualquier - contexto con una referencia al objeto Threaded. No todos los tipos de datos son almacenados - después de la serialización; los tipos simples son almacenados en su forma inicial. Los tipos - complejos, los arrays y los objetos que no son Threaded, son almacenados serializados; pueden ser - leídos y escritos en el objeto Threaded desde cualquier contexto con una referencia. - A excepción de los objetos Threaded, toda referencia utilizada para definir un miembro de un objeto - Threaded es separada de la referencia en el objeto Threaded; los mismos datos pueden ser leídos - directamente desde el objeto Threaded en cualquier momento por cualquier contexto con una referencia - al objeto Threaded. - - - Miembros estáticos: Cuando un nuevo contexto es creado (Thread o Worker), - generalmente son copiados, pero los recursos y objetos con estado interno son nullificados - (por razones de seguridad). Esto permite a la función una especie de almacenamiento local - a nivel de thread. Por ejemplo, al iniciar el contexto, una clase cuyos miembros estáticos - incluyen información de conexión a un servidor de base de datos, solo la información - será copiada, y no la conexión en sí. Esto permite al nuevo contexto inicializar - una conexión de la misma forma que el contexto que lo creó, almacenando la conexión - en el mismo lugar sin afectar al contexto original. - - - - Cuando print_r, var_dump y otras funciones de depuración son ejecutadas, no incluyen - protección contra la recursión. - - - - - Recursos: Las extensiones y funcionalidades que definen recursos en PHP no están preparadas - para este tipo de entorno; pthreads toma disposiciones en materia de recursos a compartir entre - los contextos, sin embargo, para la mayoría de los recursos, deberán ser considerados como peligrosos. - Un cuidado y una extrema precaución deberán ser de aplicación para compartir recursos entre los contextos. - - - - - En el entorno de ejecución de pthreads, restricciones y limitaciones son necesarias para - proporcionar un entorno estable. - - - - - &reference.pthreads.setup; - &reference.pthreads.constants; - &reference.pthreads.threaded; - &reference.pthreads.thread; - &reference.pthreads.worker; - &reference.pthreads.collectable; - &reference.pthreads.pool; - &reference.pthreads.volatile; - - - diff --git a/reference/pthreads/collectable.xml b/reference/pthreads/collectable.xml deleted file mode 100644 index bf105f2c41..0000000000 --- a/reference/pthreads/collectable.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - La interfaz Collectable - Collectable - - - -
    - &reftitle.intro; - - Representa un objeto de colección de datos obsoletos. - -
    - - -
    - &reftitle.classsynopsis; - - - - Collectable - - - - - Collectable - - - - - &Methods; - - - - - -
    - -
    - - &reference.pthreads.entities.collectable; - -
    - diff --git a/reference/pthreads/collectable/isgarbage.xml b/reference/pthreads/collectable/isgarbage.xml deleted file mode 100644 index 82e17b2988..0000000000 --- a/reference/pthreads/collectable/isgarbage.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - Collectable::isGarbage - Determina si un objeto ha sido marcado como obsoleto - - - - &reftitle.description; - - public trueCollectable::isGarbage - - - - Puede ser llamado en Pool::collect - para determinar si este objeto está obsoleto. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.true.always; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &return.type.true; - - - - - - - &reftitle.seealso; - - Pool::collect - - - - - diff --git a/reference/pthreads/configure.xml b/reference/pthreads/configure.xml deleted file mode 100644 index a0da46460c..0000000000 --- a/reference/pthreads/configure.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - -
    - &reftitle.install; - - - Utilizar durante la - compilación de PHP. - - - - Los usuarios de Windows deben incluir php_pthreads.dll - en el &php.ini; - - - - - Los usuarios de Windows deben asegurarse asimismo de que - pthreadVC2.dll (incluido en la distribución) - esté presente en una de las carpetas especificadas en la variable de entorno - PATH. - - - -
    - diff --git a/reference/pthreads/constants.xml b/reference/pthreads/constants.xml deleted file mode 100644 index 19f2ce861b..0000000000 --- a/reference/pthreads/constants.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - &reftitle.constants; - &extension.constants; - - - - PTHREADS_INHERIT_ALL - (int) - - - - Las opciones por omisión para todos los hilos, - haciendo que los pthreads copien los entornos - cuando los nuevos hilos son iniciados - - - - - - PTHREADS_INHERIT_NONE - (int) - - - - No hereda nada cuando los nuevos hilos son iniciados - - - - - - PTHREADS_INHERIT_INI - (int) - - - - Hereda las entradas INI cuando los nuevos hilos son iniciados - - - - - - PTHREADS_INHERIT_CONSTANTS - (int) - - - - Hereda las constantes declaradas por el usuario cuando los - nuevos hilos son iniciados - - - - - - PTHREADS_INHERIT_CLASSES - (int) - - - - Hereda las clases declaradas por el usuario cuando los nuevos - hilos son iniciados - - - - - - PTHREADS_INHERIT_FUNCTIONS - (int) - - - - Hereda las funciones declaradas por el usuario cuando los nuevos - hilos son iniciados - - - - - - PTHREADS_INHERIT_INCLUDES - (int) - - - - La herencia incluye la información de fichero cuando los nuevos - hilos son iniciados - - - - - - PTHREADS_INHERIT_COMMENTS - (int) - - - - Hereda todos los comentarios cuando los nuevos hilos son - iniciados - - - - - - PTHREADS_ALLOW_HEADERS - (int) - - - - Permite que los nuevos hilos envíen los encabezados a la salida - estándar (normalmente no permitido) - - - - - - diff --git a/reference/pthreads/pool.xml b/reference/pthreads/pool.xml deleted file mode 100644 index 71c34b77b6..0000000000 --- a/reference/pthreads/pool.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - - La clase Pool - Pool - - - - -
    - &reftitle.intro; - - Un Pool es un contenedor para, y controlado por, un número ajustable de Workers. - - - El pooling proporciona un nivel alto de abstracción sobre la funcionalidad Worker, incluyendo la gestión de referencias en el sentido requerido por pthreads. - -
    - - -
    - &reftitle.classsynopsis; - - - - Pool - - - - - Pool - - - - &Properties; - - protected - size - - - protected - class - - - protected - workers - - - protected - ctor - - - protected - last - - - &Methods; - - - - - - - - - -
    - - -
    - &reftitle.properties; - - - size - - Número máximo de Workers que este pool puede utilizar - - - - class - - La clase del Worker - - - - workers - - referencias a los Workers - - - - ctor - - Los argumentos para el constructor de los nuevos Workers - - - - last - - desplazamiento en los workers del último Worker utilizado - - - -
    - - -
    - - &reference.pthreads.entities.pool; - -
    - diff --git a/reference/pthreads/pool/collect.xml b/reference/pthreads/pool/collect.xml deleted file mode 100644 index 58a6b6147a..0000000000 --- a/reference/pthreads/pool/collect.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - Pool::collect - Recopila las referencias de las tareas completadas - - - - &reftitle.description; - - public intPool::collect - Callablecollector - - - Permite al pool recopilar referencias determinadas para ser colectadas - por el colector dado opcionalmente. - - - - - &reftitle.parameters; - - - collector - - - Un colector que puede ser llamado y que devuelve un valor booleano para - determinar si la tarea puede ser colectada o no. Solo en casos raros debe - utilizarse un colector personalizado. - - - - - - - - &reftitle.returnvalues; - - Número de tareas restantes en el pool para ser colectadas. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL pthreads 3.0.0 - - Ahora se devuelve un entero, y el argumento - collector es ahora opcional. - - - - - - - - - &reftitle.examples; - - Un ejemplo básico de <methodname>Pool::collect</methodname> - -submit(new class extends Threaded {}); -} - -while ($pool->collect()); // bloquea hasta que todas las tareas hayan finalizado - -$pool->shutdown(); -]]> - - - - - - diff --git a/reference/pthreads/pool/construct.xml b/reference/pthreads/pool/construct.xml deleted file mode 100644 index edd5fd4554..0000000000 --- a/reference/pthreads/pool/construct.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - Pool::__construct - Crea un nuevo Pool de Workers - - - - &reftitle.description; - - public Pool::__construct - intsize - stringclass - arrayctor - - - Construye un nuevo pool de workers. Los pools crean sus hilos de forma perezosa, - lo que significa que los nuevos hilos solo se generarán cuando sean necesarios - para ejecutar tareas. - - - - - &reftitle.parameters; - - - size - - - El número máximo de Workers que este Pool puede crear - - - - - class - - - La clase para los nuevos Workers. Si no se proporciona ninguna clase, la clase por defecto es Worker. - - - - - ctor - - - Un array de argumentos para pasar al constructor de los nuevos Workers - - - - - - - - &reftitle.examples; - - Creación de un Pool - -something = $something; - } - - public function run() { - /** ... **/ - } -} - -$pool = new Pool(8, \MyWorker::class, [new Something()]); - -var_dump($pool); -?> -]]> - - &example.outputs; - - - int(8) - ["class":protected]=> - string(8) "MyWorker" - ["workers":protected]=> - NULL - ["work":protected]=> - NULL - ["ctor":protected]=> - array(1) { - [0]=> - object(Something)#2 (0) { - } - } - ["last":protected]=> - int(0) -} -]]> - - - - - - diff --git a/reference/pthreads/pool/resize.xml b/reference/pthreads/pool/resize.xml deleted file mode 100644 index 56ef98129c..0000000000 --- a/reference/pthreads/pool/resize.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - Pool::resize - Redimensiona el Pool - - - - &reftitle.description; - - public voidPool::resize - intsize - - - Redimensiona el Pool. - - - - - &reftitle.parameters; - - - size - - - El número máximo de Workers que este Pool puede crear - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/pthreads/pool/shutdown.xml b/reference/pthreads/pool/shutdown.xml deleted file mode 100644 index 2de607be76..0000000000 --- a/reference/pthreads/pool/shutdown.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - Pool::shutdown - Detiene todos los workers - - - - &reftitle.description; - - public voidPool::shutdown - - - - Detiene todos los workers de este Pool. Esto se bloqueará hasta que todas - las tareas enviadas hayan sido ejecutadas. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Detener un pool - -submit(new Task()); -} - -$pool->shutdown(); // se bloquea hasta que todas las tareas enviadas hayan terminado la ejecución -]]> - - - - - diff --git a/reference/pthreads/pool/submit.xml b/reference/pthreads/pool/submit.xml deleted file mode 100644 index d74a3b4ac1..0000000000 --- a/reference/pthreads/pool/submit.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - - Pool::submit - Envía un objeto para su ejecución - - - - &reftitle.description; - - public intPool::submit - Threadedtask - - - Envía la tarea al próximo Worker del Pool - - - - - &reftitle.parameters; - - - size - - - La tarea para su ejecución - - - - - - - - &reftitle.returnvalues; - - El identificador del Worker que ejecuta el objeto - - - - - &reftitle.examples; - - Envío de tareas - -something = $something; - } - - public function run() { - /** ... **/ - } -} - -$pool = new Pool(8, \MyWorker::class, [new Something()]); -$pool->submit(new MyWork()); -var_dump($pool); -?> -]]> - - &example.outputs; - - - int(8) - ["class":protected]=> - string(8) "MyWorker" - ["workers":protected]=> - array(1) { - [0]=> - object(MyWorker)#4 (1) { - ["something"]=> - object(Something)#5 (0) { - } - } - } - ["work":protected]=> - array(1) { - [0]=> - object(MyWork)#3 (1) { - ["worker"]=> - object(MyWorker)#5 (1) { - ["something"]=> - object(Something)#6 (0) { - } - } - } - } - ["ctor":protected]=> - array(1) { - [0]=> - object(Something)#2 (0) { - } - } - ["last":protected]=> - int(1) -} -]]> - - - - - - diff --git a/reference/pthreads/pool/submitTo.xml b/reference/pthreads/pool/submitTo.xml deleted file mode 100644 index 06a3038c83..0000000000 --- a/reference/pthreads/pool/submitTo.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - Pool::submitTo - Envía una tarea a un worker específico para su ejecución - - - - &reftitle.description; - - public intPool::submitTo - intworker - Threadedtask - - - Envía la tarea al worker especificado en el Pool. Los workers están - indexados a partir de 0, y solo existirán si el pool necesita crearlos - (ya que los threads se generan de forma perezosa). - - - - - &reftitle.parameters; - - - worker - - - El worker donde apilar la tarea, indexado a partir de 0. - - - - - size - - - La tarea, para su ejecución - - - - - - - - &reftitle.returnvalues; - - El identificador del Worker que ha aceptado la tarea. - - - - - &reftitle.examples; - - Envío de una tarea a un worker específico - -submit(new Task()); - -for ($i = 0; $i < 5; ++$i) { - $pool->submitTo(0, new Task()); // apilar todas las tareas en el primer worker -} - -$pool->submitTo(1, new Task()); // No es posible apilar la tarea en el segundo worker ya que aún no existe - -$pool->shutdown(); -?> -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/setup.xml b/reference/pthreads/setup.xml deleted file mode 100644 index 917e0a0146..0000000000 --- a/reference/pthreads/setup.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Pthreads requiere una construcción de PHP con ZTS activado - (, o en sistemas no-Windows anteriores a PHP 8.0.0, - ). - - - - La seguridad de los Threads Zend (Zend Thread Safety - ZTS) no puede ser activada - después de la construcción; es una opción de compilación. - - - - pthreads debería compilar siempre que exista un encabezado Posix Threads funcional - (pthread.h) así como una construcción ZTS de PHP, lo cual incluye Windows (utilizando - el proyecto pthread-w32 de redhat). - -
    - -
    - &reftitle.install; - - Las versiones de pthreads están alojadas en PECL y las fuentes en - github. - El procedimiento de instalación más sencillo es el estándar de PECL: - &url.pecl.package;pthreads. - - - Los usuarios de Windows pueden descargar binarios preconstruidos desde - el sitio de PECL. - - - - Los usuarios de Windows deben añadir pthreadVC2.dll (distribuido - con Windows) a su PATH. - - -
    - -
    - diff --git a/reference/pthreads/thread.xml b/reference/pthreads/thread.xml deleted file mode 100644 index e11931316b..0000000000 --- a/reference/pthreads/thread.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - La clase Thread - Thread - - - - -
    - &reftitle.intro; - - Cuando el método start de un Thread es llamado, el código del método run será - ejecutado de forma paralela en un Thread separado. - - - Después de la ejecución del método run, el Thread se terminará inmediatamente, será - vinculado al Thread original posteriormente. - - - - Basarse en el motor para determinar cuándo un Thread será vinculado puede - provocar un comportamiento no deseado. El desarrollador debe ser explícito - en la medida de lo posible. - - -
    - - -
    - &reftitle.classsynopsis; - - - - Thread - - - - - Thread - - - - extends - Threaded - - - - Countable - - - - Traversable - - - - ArrayAccess - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.pthreads.entities.thread; - -
    - diff --git a/reference/pthreads/thread/getcreatorid.xml b/reference/pthreads/thread/getcreatorid.xml deleted file mode 100644 index 91dd231b1e..0000000000 --- a/reference/pthreads/thread/getcreatorid.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - Thread::getCreatorId - Identificación - - - - &reftitle.description; - - public intThread::getCreatorId - - - - Devuelve la identidad del Thread que ha creado el Thread referenciado. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Una identidad numérica. - - - - - &reftitle.examples; - - Devuelve la identidad del Thread o del proceso que ha creado el Thread referenciado - -getCreatorId()); - } -} -$my = new My(); -$my->start(); -?> -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/thread/getcurrentthread.xml b/reference/pthreads/thread/getcurrentthread.xml deleted file mode 100644 index aec90404c1..0000000000 --- a/reference/pthreads/thread/getcurrentthread.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - Thread::getCurrentThread - Identificación - - - - &reftitle.description; - - public static ThreadThread::getCurrentThread - - - - Devuelve una referencia del hilo actualmente en ejecución - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objeto que representa el hilo actualmente en ejecución. - - - - - &reftitle.examples; - - Devuelve el hilo actualmente en ejecución - -start(); -?> -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/thread/getcurrentthreadid.xml b/reference/pthreads/thread/getcurrentthreadid.xml deleted file mode 100644 index 1fc728582b..0000000000 --- a/reference/pthreads/thread/getcurrentthreadid.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - Thread::getCurrentThreadId - Identificación - - - - &reftitle.description; - - public static intThread::getCurrentThreadId - - - - Se devuelve la identidad del hilo actualmente en ejecución - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Una identidad numérica - - - - - &reftitle.examples; - - Se devuelve la identidad del hilo actualmente en ejecución - -start(); -?> -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/thread/getthreadid.xml b/reference/pthreads/thread/getthreadid.xml deleted file mode 100644 index c4493551bc..0000000000 --- a/reference/pthreads/thread/getthreadid.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - Thread::getThreadId - Identificación - - - - &reftitle.description; - - public intThread::getThreadId - - - - Se devuelve la identidad del Thread referenciado. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Una identidad numérica. - - - - - &reftitle.examples; - - Se devuelve la identidad del Thread referenciado - -getThreadId()); - } -} -$my = new My(); -$my->start(); -?> -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/thread/isjoined.xml b/reference/pthreads/thread/isjoined.xml deleted file mode 100644 index d94b074ee8..0000000000 --- a/reference/pthreads/thread/isjoined.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - Thread::isJoined - Detección de estado - - - - &reftitle.description; - - public boolThread::isJoined - - - - Indica si el Thread referenciado ha sido unido. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Detecta el estado del Thread referenciado - -synchronized(function($thread){ - if (!$thread->done) - $this->wait(); - }, $this); - } -} -$my = new My(); -$my->start(); -var_dump($my->isJoined()); -$my->synchronized(function($thread){ - $thread->done = true; - $thread->notify(); -}, $my); -?> -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/thread/isstarted.xml b/reference/pthreads/thread/isstarted.xml deleted file mode 100644 index 3336c34c66..0000000000 --- a/reference/pthreads/thread/isstarted.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - Thread::isStarted - Detección de estado - - - - &reftitle.description; - - public boolThread::isStarted - - - - Indica si el Thread referenciado ha sido iniciado. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Indica si el Thread referenciado ha sido iniciado - -start(); -var_dump($worker->isStarted()); -?> -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/thread/join.xml b/reference/pthreads/thread/join.xml deleted file mode 100644 index aa0ea3e5d1..0000000000 --- a/reference/pthreads/thread/join.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - Thread::join - Sincronización - - - - &reftitle.description; - - public boolThread::join - - - - Permite esperar al contexto llamante del Thread referenciado - hasta que finalice la ejecución. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Une el Thread referenciado - -start(); -/* ... */ -var_dump($my->join()); -/* ... */ -?> -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/thread/start.xml b/reference/pthreads/thread/start.xml deleted file mode 100644 index ccfc542c57..0000000000 --- a/reference/pthreads/thread/start.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - - Thread::start - Ejecución - - - - &reftitle.description; - - public boolThread::start - intoptions - - - Inicia un nuevo Thread y ejecuta el método run implementado. - - - - - &reftitle.parameters; - - - options - - - Una máscara opcional de constantes heredadas; por omisión, - PTHREADS_INHERIT_ALL - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Inicia los Threads - -start()); -?> -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/threaded.xml b/reference/pthreads/threaded.xml deleted file mode 100644 index 5e36f9b2a4..0000000000 --- a/reference/pthreads/threaded.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - La clase Threaded - Threaded - - - - -
    - &reftitle.intro; - - Los objetos Threaded constituyen la base de pthreads para ejecutar código de forma paralela; exponen e incluyen métodos de sincronización así como diversas interfaces útiles. - - - Los objetos Threaded proporcionan seguridad nativa para el desarrollador; todas las operaciones son thread-safe dentro del ámbito del objeto. - -
    - - -
    - &reftitle.classsynopsis; - - - - Threaded - - - - - Threaded - - - - Collectable - - - - Traversable - - - - Countable - - - - ArrayAccess - - - - - &Methods; - - - - -
    - -
    - - &reference.pthreads.entities.threaded; - -
    - diff --git a/reference/pthreads/threaded/chunk.xml b/reference/pthreads/threaded/chunk.xml deleted file mode 100644 index ba92ba918e..0000000000 --- a/reference/pthreads/threaded/chunk.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - Threaded::chunk - Manipulación - - - - &reftitle.description; - - public arrayThreaded::chunk - intsize - boolpreserve - - - Recorre una parte de la tabla de propiedades de los objetos - preservando, opcionalmente, las claves. - - - - - &reftitle.parameters; - - - size - - - El número de elementos a recorrer - - - - - preserve - - - Preserva las claves de los miembros; por omisión, vale &false; - - - - - - - - &reftitle.returnvalues; - - Un array de elementos desde la tabla de propiedades de los objetos. - - - - - &reftitle.examples; - - Recorrido de una parte de la tabla de propiedades - -chunk(5)); -?> -]]> - - &example.outputs; - - - int(0) - [1]=> - int(1) - [2]=> - int(2) - [3]=> - int(3) - [4]=> - int(4) -} -]]> - - - - - - diff --git a/reference/pthreads/threaded/count.xml b/reference/pthreads/threaded/count.xml deleted file mode 100644 index c575af2587..0000000000 --- a/reference/pthreads/threaded/count.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - Threaded::count - Manipulación - - - - &reftitle.description; - - public intThreaded::count - - - - Devuelve el número de propiedades para este objeto. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Cuenta las propiedades de un objeto - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/threaded/extend.xml b/reference/pthreads/threaded/extend.xml deleted file mode 100644 index 2077053425..0000000000 --- a/reference/pthreads/threaded/extend.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - Threaded::extend - Manipulación durante la ejecución - - - - &reftitle.description; - - public boolThreaded::extend - stringclass - - - Hace que la clase estándar sea segura a nivel de thread durante la ejecución. - - - - - &reftitle.parameters; - - - class - - - La clase a extender. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Herencia durante la ejecución - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/threaded/isrunning.xml b/reference/pthreads/threaded/isrunning.xml deleted file mode 100644 index 9f2cbe8f94..0000000000 --- a/reference/pthreads/threaded/isrunning.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - Threaded::isRunning - Detección de estado - - - - &reftitle.description; - - public boolThreaded::isRunning - - - - Se verifica si el objeto referenciado está en ejecución. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un valor booleano que indica el estado. - - - Un objeto se considera en ejecución cuando ejecuta el método run. - - - - - - - &reftitle.examples; - - Detecta el estado del objeto referenciado - -synchronized(function($thread){ - if (!$thread->done) - $thread->wait(); - }, $this); - } -} -$my = new My(); -$my->start(); -var_dump($my->isRunning()); -$my->synchronized(function($thread){ - $thread->done = true; - $thread->notify(); -}, $my); -?> -]]> - - &example.outputs; - - - - - - - diff --git a/reference/pthreads/threaded/isterminated.xml b/reference/pthreads/threaded/isterminated.xml deleted file mode 100644 index f46a1b2ecc..0000000000 --- a/reference/pthreads/threaded/isterminated.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - Threaded::isTerminated - Detección de estado - - - - &reftitle.description; - - public boolThreaded::isTerminated - - - - Se verifica si el objeto referenciado ha finalizado durante la ejecución; - si ha sufrido un error fatal o ha generado excepciones que no han podido - ser capturadas. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un valor booleano que indica el estado. - - - - - &reftitle.examples; - - Detecta el estado del objeto referenciado - -start(); -$my->join(); -var_dump($my->isTerminated()); -?> -]]> - - &example.outputs; - - - - - - - diff --git a/reference/pthreads/threaded/merge.xml b/reference/pthreads/threaded/merge.xml deleted file mode 100644 index 9cbbfeb9ab..0000000000 --- a/reference/pthreads/threaded/merge.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - - Threaded::merge - Manipulación - - - - &reftitle.description; - - public boolThreaded::merge - mixedfrom - booloverwrite - - - Fusiona los datos en el objeto actual - - - - - &reftitle.parameters; - - - from - - - Los datos a fusionar - - - - - overwrite - - - Sobrescribe las claves existentes; por omisión vale &true; - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Fusiona el objeto thread en la tabla de propiedades - -foo = "foo"; -$stdClass->bar = "bar"; -$stdClass->baz = "baz"; - -$safe = new Threaded(); -$safe->merge($array); - -$safe->foo = "bar"; -$safe->merge($stdClass, false); - -var_dump($safe); -?> -]]> - - &example.outputs; - - - int(0) - ["1"]=> - int(1) - ["2"]=> - int(2) - ["3"]=> - int(3) - ["4"]=> - int(4) - ["5"]=> - int(5) - ["6"]=> - int(6) - ["7"]=> - int(7) - ["8"]=> - int(8) - ["9"]=> - int(9) - ["foo"]=> - string(3) "bar" - ["bar"]=> - string(3) "bar" - ["baz"]=> - string(3) "baz" -} -]]> - - - - - diff --git a/reference/pthreads/threaded/notify.xml b/reference/pthreads/threaded/notify.xml deleted file mode 100644 index 606c8e8d82..0000000000 --- a/reference/pthreads/threaded/notify.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - Threaded::notify - Sincronización - - - - &reftitle.description; - - public boolThreaded::notify - - - - Envía una notificación al objeto referenciado - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Notificaciones y espera - -synchronized(function($thread){ - if (!$thread->done) - $this->wait(); - }, $this); - } -} -$my = new My(); -$my->start(); -/** envía la notificación al hilo que espera **/ -$my->synchronized(function($thread){ - $thread->done = true; - $thread->notify(); -}, $my); -var_dump($my->join()); -?> -]]> - - &example.outputs; - - - - - - - diff --git a/reference/pthreads/threaded/notifyone.xml b/reference/pthreads/threaded/notifyone.xml deleted file mode 100644 index 71fddb9e9b..0000000000 --- a/reference/pthreads/threaded/notifyone.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - Threaded::notifyOne - Sincronizar - - - - &reftitle.description; - - public boolThreaded::notifyOne - - - - Envía una notificación al objeto referenciado. Esto desbloquea al menos uno de - los threads bloqueados (a diferencia de desbloquearlos todos, como ocurre con - Threaded::notify). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Notificaciones y espera - -synchronized(function($thread){ - if (!$thread->done) - $this->wait(); - }, $this); - } -} -$my = new My(); -$my->start(); -/** envía una notificación al thread en espera **/ -$my->synchronized(function($thread){ - $thread->done = true; - $thread->notifyOne(); -}, $my); -var_dump($my->join()); -?> -]]> - - &example.outputs; - - - - - - - diff --git a/reference/pthreads/threaded/pop.xml b/reference/pthreads/threaded/pop.xml deleted file mode 100644 index 2f90767dd5..0000000000 --- a/reference/pthreads/threaded/pop.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - Threaded::pop - Manipulación - - - - &reftitle.description; - - public boolThreaded::pop - - - - Se elimina el último elemento de la tabla de propiedades del objeto. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El último elemento de la tabla de propiedades del objeto. - - - - - &reftitle.examples; - - Eliminar el último elemento de la tabla de propiedades de un objeto thread - -pop()); -?> -]]> - - &example.outputs; - - - - - - - diff --git a/reference/pthreads/threaded/run.xml b/reference/pthreads/threaded/run.xml deleted file mode 100644 index 256145cbe4..0000000000 --- a/reference/pthreads/threaded/run.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - Threaded::run - Ejecución - - - - &reftitle.description; - - public voidThreaded::run - - - - El desarrollador debe siempre implementar el método run para los objetos - que deben ser ejecutados. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - diff --git a/reference/pthreads/threaded/shift.xml b/reference/pthreads/threaded/shift.xml deleted file mode 100644 index 2320568e51..0000000000 --- a/reference/pthreads/threaded/shift.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - Threaded::shift - Manipulación - - - - &reftitle.description; - - public boolThreaded::shift - - - - Se elimina el primer elemento de la tabla de propiedades del objeto. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El primer elemento de la tabla de propiedades del objeto. - - - - - &reftitle.examples; - - - Eliminación del primer elemento de la tabla de propiedades del objeto threadado - -shift()); -?> -]]> - - &example.outputs; - - - - - - - diff --git a/reference/pthreads/threaded/synchronized.xml b/reference/pthreads/threaded/synchronized.xml deleted file mode 100644 index 1a66335929..0000000000 --- a/reference/pthreads/threaded/synchronized.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - Threaded::synchronized - Sincronización - - - - &reftitle.description; - - public mixedThreaded::synchronized - Closureblock - mixedargs - - - Se ejecuta el bloque mientras se retienen los candados de sincronización - de los objetos referenciados para el contexto llamante. - - - - - &reftitle.parameters; - - - block - - - El bloque de código a ejecutar - - - - - args - - - Lista variable de argumentos a utilizar como argumento de la función - - - - - - - - &reftitle.returnvalues; - - El valor devuelto del bloque - - - - - &reftitle.examples; - - Sincronización - -synchronized(function($thread){ - if (!$thread->done) - $thread->wait(); - }, $this); - } -} -$my = new My(); -$my->start(); -$my->synchronized(function($thread){ - $thread->done = true; - $thread->notify(); -}, $my); -var_dump($my->join()); -?> -]]> - - &example.outputs; - - - - - - - diff --git a/reference/pthreads/threaded/wait.xml b/reference/pthreads/threaded/wait.xml deleted file mode 100644 index e04af78f97..0000000000 --- a/reference/pthreads/threaded/wait.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - Threaded::wait - Sincronización - - - - &reftitle.description; - - public boolThreaded::wait - inttimeout - - - Hace esperar al contexto llamante una notificación desde el objeto referenciado. - - - - - &reftitle.parameters; - - - timeout - - - Un tiempo de espera máximo opcional, en microsegundos. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Notificaciones y espera - -synchronized(function($thread){ - if (!$thread->done) - $thread->wait(); - }, $this); - } -} -$my = new My(); -$my->start(); -/** Envía la notificación al hilo que espera **/ -$my->synchronized(function($thread){ - $thread->done = true; - $thread->notify(); -}, $my); -var_dump($my->join()); -?> -]]> - - &example.outputs; - - - - - - - diff --git a/reference/pthreads/volatile.xml b/reference/pthreads/volatile.xml deleted file mode 100644 index b32c12f7d6..0000000000 --- a/reference/pthreads/volatile.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - La clase Volatile - Volatile - - - - -
    - &reftitle.intro; - - La clase Volatile es nueva en pthreads v3. Su - introducción es una consecuencia de las nuevas semánticas de inmutabilidad - de los miembros Threaded de las clases Threaded. - La clase Volatile permite la mutabilidad de sus miembros - Threaded, y es igualmente utilizada para almacenar - arrays PHP en contextos Threaded. - -
    - - -
    - &reftitle.classsynopsis; - - - - Volatile - - - - - Volatile - - - - extends - Threaded - - - - Collectable - - - - Traversable - - - - &InheritedMethods; - - - - - - -
    - -
    - &reftitle.examples; - - Nuevas semánticas de inmutabilidad de Threaded - -data = new Threaded(); - - // intenta reemplazar una propiedad Threaded de una clase Threaded (inválido) - $this->data = new stdClass(); - } -} - -var_dump((new Task())->data); -]]> - - &example.outputs.similar; - - - - - - Caso de uso de Volatile - -data = new Threaded(); - - // intenta reemplazar una propiedad Threaded de una clase Volatile (válido) - $this->data = new stdClass(); - } -} - -var_dump((new Task())->data); -]]> - - &example.outputs.similar; - - - - -
    - -
    - -
    - diff --git a/reference/pthreads/worker.xml b/reference/pthreads/worker.xml deleted file mode 100644 index d37201be20..0000000000 --- a/reference/pthreads/worker.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - La clase Worker - Worker - - - - -
    - &reftitle.intro; - - Los Threads Worker tienen un contexto persistente, por lo tanto, - pueden ser utilizados mediante Threads en la mayoría de los casos. - - - Cuando un Worker es iniciado, el método run será - ejecutado, pero el Thread no - se detendrá hasta que una de las siguientes condiciones se cumpla: - - - - el Worker está fuera de alcance (no hay referencias restantes); - - - el desarrollador llama a shutdown; - - - el script muere. - - - - Esto significa que el desarrollador puede reutilizar el contexto durante - toda la ejecución; colocar objetos en la pila del - Worker hará que el Worker - ejecute el método run sobre los objetos apilados. - -
    - - -
    - &reftitle.classsynopsis; - - - - Worker - - - - - Worker - - - - extends - Thread - - - - Traversable - - - - Countable - - - - ArrayAccess - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.pthreads.entities.worker; - -
    - diff --git a/reference/pthreads/worker/collect.xml b/reference/pthreads/worker/collect.xml deleted file mode 100644 index e866e3855a..0000000000 --- a/reference/pthreads/worker/collect.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Worker::collect - Recopila las referencias de las tareas finalizadas - - - - &reftitle.description; - - public intWorker::collect - Callablecollector - - - Permite al worker recopilar las referencias determinadas como migajas por el - collector eventualmente proporcionado. - - - - - &reftitle.parameters; - - - collector - - - Una función de retrollamada que devuelve un booleano sobre la posibilidad de - recopilar la tarea o no. Solo en casos raros debería utilizarse un collector - personalizado. - - - - - - - - &reftitle.returnvalues; - - El número de tareas restantes en la pila del worker a recopilar. - - - - - &reftitle.examples; - - Un ejemplo básico de <methodname>Worker::collect</methodname> - -collect()} tasks on the stack to be collected\n"; - -for ($i = 0; $i < 15; ++$i) { - $worker->stack(new class extends Threaded {}); -} - -echo "There are {$worker->collect()} tasks remaining on the stack to be collected\n"; - -$worker->start(); - -while ($worker->collect()); // bloque hasta que todas las tareas estén finalizadas - -echo "There are now {$worker->collect()} tasks on the stack to be collected\n"; - -$worker->shutdown(); -]]> - - &example.outputs; - - - - - - - diff --git a/reference/pthreads/worker/getstacked.xml b/reference/pthreads/worker/getstacked.xml deleted file mode 100644 index f989268c07..0000000000 --- a/reference/pthreads/worker/getstacked.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - Worker::getStacked - Obtiene el tamaño de pila restante - - - - &reftitle.description; - - public intWorker::getStacked - - - - Devuelve el número de tareas dejadas en la pila - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el número de tareas actualmente en espera de ser ejecutadas por el worker - - - - - &reftitle.examples; - - Un ejemplo básico de <classname>Worker::getStacked</classname> - -stack(new class extends Threaded {}); -} - -echo "Hay {$worker->getStacked()} tareas apiladas\n"; -]]> - - &example.outputs; - - - - - - - diff --git a/reference/pthreads/worker/isshutdown.xml b/reference/pthreads/worker/isshutdown.xml deleted file mode 100644 index 290cc1aef4..0000000000 --- a/reference/pthreads/worker/isshutdown.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - Worker::isShutdown - Detección de estado - - - - &reftitle.description; - - public boolWorker::isShutdown - - - - Indica si el Worker ha sido detenido o no. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve si el Worker ha sido detenido o no. - - - - - &reftitle.examples; - - Detecta el estado de un worker - -start(); - -var_dump($worker->isShutdown()); - -$worker->shutdown(); - -var_dump($worker->isShutdown()); -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/worker/shutdown.xml b/reference/pthreads/worker/shutdown.xml deleted file mode 100644 index ce31137f45..0000000000 --- a/reference/pthreads/worker/shutdown.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - Worker::shutdown - Detener el worker - - - - &reftitle.description; - - public boolWorker::shutdown - - - - Detiene el Worker después de ejecutar todas las tareas apiladas. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Apaga el worker referenciado - -start(); -/* apilar/ejecutar tareas */ -var_dump($my->shutdown()); -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/worker/stack.xml b/reference/pthreads/worker/stack.xml deleted file mode 100644 index ba61edd68f..0000000000 --- a/reference/pthreads/worker/stack.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - Worker::stack - Apila la tarea - - - - &reftitle.description; - - public intWorker::stack - Threadedwork - - - Añade la nueva tarea a la pila del worker referenciado. - - - - - &reftitle.parameters; - - - work - - - Objeto Threaded a ejecutar por el worker. - - - - - - - - &reftitle.returnvalues; - - El nuevo tamaño de la pila. - - - - - &reftitle.examples; - - Apilamiento de una tarea para ejecución en un worker - -stack($work));]]> - - &example.outputs; - - - - - - - - diff --git a/reference/pthreads/worker/unstack.xml b/reference/pthreads/worker/unstack.xml deleted file mode 100644 index 21faa79597..0000000000 --- a/reference/pthreads/worker/unstack.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - Worker::unstack - Desapila una tarea - - - - &reftitle.description; - - public intWorker::unstack - - - - Elimina la primera tarea (la más antigua) de la pila. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El nuevo tamaño de la pila. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL pthreads 3.0.0 - - El argumento para especificar la tarea a desapilar ha sido eliminado. - Ahora, solo la primera tarea en la pila es eliminada. - - - - - - - - - &reftitle.examples; - - Elimina el objeto desde la cola de espera de los Workers - -stack($work)); -var_dump($my->unstack()); -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/quickhash/book.xml b/reference/quickhash/book.xml deleted file mode 100644 index 42e1f1cac3..0000000000 --- a/reference/quickhash/book.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - Quickhash - Quickhash - - - &reftitle.intro; - - La extensión Quickhash contiene un conjunto de clases específicas fuertemente tipadas - para tratar implementaciones específicas de arrays y hashes. - - - - &reference.quickhash.setup; - &reference.quickhash.examples; - - &reference.quickhash.quickhashintset; - &reference.quickhash.quickhashinthash; - &reference.quickhash.quickhashstringinthash; - &reference.quickhash.quickhashintstringhash; - - diff --git a/reference/quickhash/examples.xml b/reference/quickhash/examples.xml deleted file mode 100644 index e4df111886..0000000000 --- a/reference/quickhash/examples.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - &reftitle.examples; - - Ejemplo de Quickhash - -add( 1 ); -$set->add( 3 ); - -var_dump( $set->exists( 3 ) ); -var_dump( $set->exists( 4 ) ); - -$set->saveToFile( "/tmp/test-set.set" ); - -$newSet = QuickHashIntSet::loadFromFile( - "/tmp/test-set.set" -); - -var_dump( $newSet->exists( 3 ) ); -var_dump( $newSet->exists( 4 ) ); -?> -]]> - - &example.outputs.similar; - - - - - - Ejemplo de ArrayAccess Quickhash - - -]]> - - &example.outputs.similar; - - - - - - Ejemplo de Iterator Quickhash - - $value ) -{ - echo $key, ' => ', $value, "\n"; -} -?> -]]> - - &example.outputs.similar; - - -4234 -4 => 712314 -1 => 145926 -2 => 1415926 -3 => 72 -]]> - - - - Ejemplo de valor de string Quickhash - -add( 2, "one more" ); - -foreach( $hash as $key => $value ) -{ - echo $key, ' => ', $value, "\n"; -} -?> -]]> - - &example.outputs.similar; - - one million four hundred fifteen thousand nine hundred twenty six -2 => one more -]]> - - - - - diff --git a/reference/quickhash/quickhashinthash.xml b/reference/quickhash/quickhashinthash.xml deleted file mode 100644 index e76a4a6063..0000000000 --- a/reference/quickhash/quickhashinthash.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - La clase QuickHashIntHash - QuickHashIntHash - - - - -
    - &reftitle.intro; - - Esta clase envuelve un hash que contiene números enteros, donde los - valores son también números enteros. Los hashes están disponibles como - implementación de la interfaz ArrayAccess. - - - Los hashes pueden ser iterados con foreach ya que la interfaz Iterator está - también implementada. El orden en el que los elementos son devueltos no está - garantizado. - -
    - - -
    - &reftitle.classsynopsis; - - - - QuickHashIntHash - - - - - QuickHashIntHash - - - - &Constants; - - const - int - QuickHashIntHash::CHECK_FOR_DUPES - 1 - - - const - int - QuickHashIntHash::DO_NOT_USE_ZEND_ALLOC - 2 - - - const - int - QuickHashIntHash::HASHER_NO_HASH - 256 - - - const - int - QuickHashIntHash::HASHER_JENKINS1 - 512 - - - const - int - QuickHashIntHash::HASHER_JENKINS2 - 1024 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - QuickHashIntHash::CHECK_FOR_DUPES - - Si está activado, la adición de elementos duplicados a un hash (vía QuickHashIntHash::add o - QuickHashIntHash::loadFromFile) resultará en la eliminación de estos elementos del - hash. Esto tomará más tiempo, por lo que úselo solo si es necesario. - - - - - QuickHashIntHash::DO_NOT_USE_ZEND_ALLOC - - Desactiva el uso del gestor de memoria interno de PHP para las estructuras de juego internas. - Con esta opción activada, las asignaciones internas no contarán en - los parámetros memory_limit. - - - - - QuickHashIntHash::HASHER_NO_HASH - - Selecciona no usar una función de hash, sino simplemente usar un módulo para encontrar el índice de la lista de cubos. Esto no es más rápido que el hash normal, y - da más colisiones. - - - - - QuickHashIntHash::HASHER_JENKINS1 - - Esta es la función de hash por defecto para transformar los hashes enteros - en índice de lista de cubos. - - - - - QuickHashIntHash::HASHER_JENKINS2 - - Selecciona un algoritmo de hash de variante. - - - - -
    - - -
    - - &reference.quickhash.entities.quickhashinthash; - -
    - diff --git a/reference/quickhash/quickhashinthash/add.xml b/reference/quickhash/quickhashinthash/add.xml deleted file mode 100644 index 1dee329994..0000000000 --- a/reference/quickhash/quickhashinthash/add.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - QuickHashIntHash::add - Este método añade una nueva entrada al hash - - - - &reftitle.description; - - public boolQuickHashIntHash::add - intkey - intvalue - - - Este método añade una nueva entrada al hash y devuelve si la entrada ha sido - añadida. Las entradas se añaden por omisión siempre que - QuickHashIntHash::CHECK_FOR_DUPES no haya sido pasado durante la creación del hash. - - - - - &reftitle.parameters; - - - key - - - La clave de la entrada a añadir. - - - - - value - - - El valor opcional de la entrada a añadir. Si no se especifica ningún valor, - 1 será utilizado. - - - - - - - - &reftitle.returnvalues; - - &true; cuando la entrada ha sido añadida, y &false; si la entrada no ha sido añadida. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashIntHash::add</function> - -exists( 4 ) ); -var_dump( $hash->get( 4 ) ); -var_dump( $hash->add( 4, 22 ) ); -var_dump( $hash->exists( 4 ) ); -var_dump( $hash->get( 4 ) ); -var_dump( $hash->add( 4, 12 ) ); - -echo "\ncon verificación de duplicados\n"; -$hash = new QuickHashIntHash( 1024, QuickHashIntHash::CHECK_FOR_DUPES ); -var_dump( $hash->exists( 4 ) ); -var_dump( $hash->get( 4 ) ); -var_dump( $hash->add( 4, 78 ) ); -var_dump( $hash->exists( 4 ) ); -var_dump( $hash->get( 4 ) ); -var_dump( $hash->add( 4, 9 ) ); - -echo "\nvalor por omisión\n"; -var_dump( $hash->add( 5 ) ); -var_dump( $hash->get( 5 ) ); -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/quickhash/quickhashinthash/construct.xml b/reference/quickhash/quickhashinthash/construct.xml deleted file mode 100644 index eae304b2cd..0000000000 --- a/reference/quickhash/quickhashinthash/construct.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - QuickHashIntHash::__construct - Crear un nuevo objeto QuickHashIntHash - - - - &reftitle.description; - - public QuickHashIntHash::__construct - intsize - intoptions - - - Este constructor crea un nuevo objeto QuickHashIntHash. El tamaño es el número de - listas de cubos a crear. Cuantas más listas haya, menos colisiones se tendrán. - Las opciones también son soportadas. - - - - - &reftitle.parameters; - - - size - - - La cantidad de listas de cubos a configurar. El número que se pase será - automáticamente redondeado a la siguiente potencia de dos. También se - limita automáticamente de 64 a 4194304. - - - - - options - - - Las opciones que se pueden pasar son: QuickHashIntHash::CHECK_FOR_DUPES, - que asegura que ninguna entrada duplicada sea añadida al hash; - QuickHashIntHash::DO_NOT_USE_ZEND_ALLOC para no utilizar el gestor de memoria interno de PHP - así como una de las QuickHashIntHash::HASHER_NO_HASH, - QuickHashIntHash::HASHER_JENKINS1 o QuickHashIntHash::HASHER_JENKINS2. - Estas tres últimas configuran el algoritmo de hash a utilizar. Todas las opciones - pueden ser combinadas utilizando máscaras de bits. - - - - - - - - &reftitle.returnvalues; - - Devuelve un nuevo objeto QuickHashIntHash. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashIntHash::__construct</function> - - -]]> - - - - - - diff --git a/reference/quickhash/quickhashinthash/delete.xml b/reference/quickhash/quickhashinthash/delete.xml deleted file mode 100644 index 3723d558c4..0000000000 --- a/reference/quickhash/quickhashinthash/delete.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - QuickHashIntHash::delete - Este método elimina una entrada del hash - - - - &reftitle.description; - - public boolQuickHashIntHash::delete - intkey - - - Este método elimina una entrada del hash y devuelve si la entrada ha sido - eliminada. Las estructuras de memoria asociadas no se liberarán inmediatamente, - sino cuando el hash mismo es liberado. - - - Los elementos no pueden ser eliminados cuando el hash está siendo utilizado en un iterador. El - método no lanzará una excepción, sino que simplemente devolverá &false; como ocurriría con cualquier otro fallo de eliminación. - - - - - &reftitle.parameters; - - - key - - - La clave de la entrada a eliminar. - - - - - - - - &reftitle.returnvalues; - - &true; cuando la entrada ha sido eliminada, y &false; si la entrada no ha sido eliminada. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashIntHash::delete</function> - -exists( 4 ) ); -var_dump( $hash->add( 4, 5 ) ); -var_dump( $hash->delete( 4 ) ); -var_dump( $hash->exists( 4 ) ); -var_dump( $hash->delete( 4 ) ); -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/quickhash/quickhashinthash/exists.xml b/reference/quickhash/quickhashinthash/exists.xml deleted file mode 100644 index a77b3f9030..0000000000 --- a/reference/quickhash/quickhashinthash/exists.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - QuickHashIntHash::exists - Este método verifica si una clave forma parte del hash - - - - &reftitle.description; - - public boolQuickHashIntHash::exists - intkey - - - Este método verifica si una entrada con la clave proporcionada existe en el - hash. - - - - - &reftitle.parameters; - - - key - - - La clave de la entrada a verificar si existe en el hash. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; cuando la entrada es encontrada, o &false; cuando la entrada no es - encontrada. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashIntHash::exists</function> - -add( $key, 56 ); -} - -echo "Realizando 1000 pruebas: ", microtime( true ), "\n"; -foreach( $testForEntries as $key ) -{ - $foundCount += $hash->exists( $key ); -} -echo "Hecho, $foundCount encontrados: ", microtime( true ), "\n"; -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/quickhash/quickhashinthash/get.xml b/reference/quickhash/quickhashinthash/get.xml deleted file mode 100644 index 3e6310ee41..0000000000 --- a/reference/quickhash/quickhashinthash/get.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - QuickHashIntHash::get - Este método recupera un valor del hash por su clave - - - - &reftitle.description; - - public intQuickHashIntHash::get - intkey - - - Este método recupera un valor del hash por su clave. - - - - - &reftitle.parameters; - - - key - - - La clave de la entrada a recuperar. - - - - - - - - &reftitle.returnvalues; - - El valor si la clave existe, o &null; si la clave no era parte del hash. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashIntHash::get</function> - -get( 1 ) ); - -var_dump( $hash->add( 2 ) ); -var_dump( $hash->get( 2 ) ); - -var_dump( $hash->add( 3, 5 ) ); -var_dump( $hash->get( 3 ) ); -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/quickhash/quickhashinthash/getsize.xml b/reference/quickhash/quickhashinthash/getsize.xml deleted file mode 100644 index 7d3d2fb518..0000000000 --- a/reference/quickhash/quickhashinthash/getsize.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - QuickHashIntHash::getSize - Devuelve el número de elementos en el hash - - - - &reftitle.description; - - public intQuickHashIntHash::getSize - - - Devuelve el número de elementos en el hash. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El número de elementos en el hash. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashIntHash::getSize</function> - -add( 2 ) ); -var_dump( $hash->add( 3, 5 ) ); -var_dump( $hash->getSize() ); -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/quickhash/quickhashinthash/loadfromfile.xml b/reference/quickhash/quickhashinthash/loadfromfile.xml deleted file mode 100644 index 5e74ce19b0..0000000000 --- a/reference/quickhash/quickhashinthash/loadfromfile.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - - QuickHashIntHash::loadFromFile - Este método de fábrica crea un hash a partir de un fichero - - - - &reftitle.description; - - public static QuickHashIntHashQuickHashIntHash::loadFromFile - stringfilename - intoptions - - - Este método de fábrica crea un nuevo hash a partir de un fichero de definición en disco. El - formato de fichero consiste en una firma 'QH\0x11\0', el número de elementos como - un entero de 32 bits con signo en Endianness de sistema, seguido de enteros de 32 bits con signo empaquetados juntos - en el Endianness que el sistema en el que se ejecuta el código utiliza. Para cada elemento de hash, hay dos enteros de 32 bits con signo - almacenados. El primero de cada elemento es la clave, y el segundo es el valor - perteneciente a la clave. Un ejemplo podría ser: - - - Formato de fichero QuickHash IntHash - - - - Formato de fichero QuickHash IntHash - - - - - - - &reftitle.parameters; - - - filename - - - El nombre del fichero desde el cual leer el hash. - - - - - options - - - Las mismas opciones que el constructor de la clase; con la excepción de la opción - size que es ignorada. Se calcula automáticamente para ser la misma que el - número de entradas en el hash, redondeada a la potencia de dos más cercana - con un límite máximo de 4194304. - - - - - - - - &reftitle.returnvalues; - - Devuelve un nuevo QuickHashIntHash. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashIntHash::loadFromFile</function> - -exists( $key ) ? 'set' : 'unset' - ); -} -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/quickhash/quickhashinthash/loadfromstring.xml b/reference/quickhash/quickhashinthash/loadfromstring.xml deleted file mode 100644 index 34a57a872c..0000000000 --- a/reference/quickhash/quickhashinthash/loadfromstring.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - QuickHashIntHash::loadFromString - Este método de fábrica crea un hash a partir de una string - - - - &reftitle.description; - - public static QuickHashIntHashQuickHashIntHash::loadFromString - stringcontents - intoptions - - - Este método de fábrica crea un nuevo hash a partir de una definición en una string. El - formato de fichero consiste en enteros de 32 bits con signo empaquetados juntos en el Endianness que el sistema - en el que se ejecuta el código utiliza. Para cada elemento de hash, hay dos enteros de 32 bits con signo - almacenados juntos. El primero de cada elemento es la clave, y el segundo es el valor perteneciente a la clave. - - - - - &reftitle.parameters; - - - contents - - - La string que contiene un formato serializado del hash. - - - - - options - - - Las mismas opciones que el constructor de la clase; con la excepción de la opción - size que es ignorada. Se calcula automáticamente para ser la misma que el - número de entradas en el hash, redondeada a la potencia de dos más cercana - con un límite máximo de 4194304. - - - - - - - - &reftitle.returnvalues; - - Devuelve un nuevo QuickHashIntHash. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashIntHash::loadFromString</function> - -exists( $key ) ? 'set' : 'unset' - ); -} -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/quickhash/quickhashinthash/savetofile.xml b/reference/quickhash/quickhashinthash/savetofile.xml deleted file mode 100644 index 90992a2e4f..0000000000 --- a/reference/quickhash/quickhashinthash/savetofile.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - QuickHashIntHash::saveToFile - Este método almacena un hash en memoria en disco - - - - &reftitle.description; - - public voidQuickHashIntHash::saveToFile - stringfilename - - - Este método almacena un hash existente en un fichero en disco, en el mismo formato - que QuickHashIntHash::loadFromFile puede leer. - - - - - &reftitle.parameters; - - - filename - - - El nombre del fichero en el cual almacenar el hash. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashIntHash::saveToFile</function> - -exists( 4 ) ); -var_dump( $hash->add( 4, 43 ) ); -var_dump( $hash->exists( 4 ) ); -var_dump( $hash->add( 4, 52 ) ); - -$hash->saveToFile( '/tmp/test.hash' ); -?> -]]> - - - - - - diff --git a/reference/quickhash/quickhashinthash/savetostring.xml b/reference/quickhash/quickhashinthash/savetostring.xml deleted file mode 100644 index e060a593af..0000000000 --- a/reference/quickhash/quickhashinthash/savetostring.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - QuickHashIntHash::saveToString - Este método devuelve una versión serializada del hash - - - - &reftitle.description; - - public stringQuickHashIntHash::saveToString - - - Este método devuelve una versión serializada del hash en el mismo formato que - QuickHashIntHash::loadFromString puede leer. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Este método devuelve una string que contiene una versión serializada del hash. - Cada elemento se almacena como un valor de cuatro bytes en el Endianness que - el sistema actual utiliza. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashIntHash::saveToString</function> - -exists( 4 ) ); -var_dump( $hash->add( 4, 34 ) ); -var_dump( $hash->exists( 4 ) ); -var_dump( $hash->add( 4, 55 ) ); - -var_dump( $hash->saveToString() ); -?> -]]> - - - - - - diff --git a/reference/quickhash/quickhashinthash/set.xml b/reference/quickhash/quickhashinthash/set.xml deleted file mode 100644 index fdd3fab8bf..0000000000 --- a/reference/quickhash/quickhashinthash/set.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - QuickHashIntHash::set - Este método actualiza una entrada en el hash con un nuevo valor, o - añade una nueva entrada si la entrada no existe - - - - &reftitle.description; - - public intQuickHashIntHash::set - intkey - intvalue - - - Este método intenta actualizar una entrada con un nuevo valor. Si la entrada - no existía, añadirá una nueva entrada. Devuelve si la entrada ha sido - añadida o actualizada. Si hay claves duplicadas, solo el primer - elemento encontrado será actualizado. Utilice - QuickHashIntHash::CHECK_FOR_DUPES al crear el hash para evitar que las claves duplicadas - formen parte del hash. - - - - - &reftitle.parameters; - - - key - - - La clave de la entrada a añadir o actualizar. - - - - - value - - - El nuevo valor para actualizar la entrada. - - - - - - - - &reftitle.returnvalues; - - 2 si la entrada ha sido nuevamente añadida, 1 si la entrada ha sido encontrada y actualizada, o 0 - si ha habido un error. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashIntHash::set</function> - -Add\n"; -var_dump($hash->get(46692)); -var_dump($hash->set(46692, 16091)); -var_dump($hash->get(46692)); - -echo "\n\nSet->Update\n"; -var_dump($hash->set(46692, 29906)); -var_dump($hash->get(46692)); -]]> - - &example.outputs.similar; - -Add -bool(false) -int(2) -int(16091) - -Set->Update -int(1) -int(29906) -]]> - - - - - - diff --git a/reference/quickhash/quickhashinthash/update.xml b/reference/quickhash/quickhashinthash/update.xml deleted file mode 100644 index c292b4896b..0000000000 --- a/reference/quickhash/quickhashinthash/update.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - QuickHashIntHash::update - Este método actualiza una entrada en el hash con un nuevo valor - - - - &reftitle.description; - - public boolQuickHashIntHash::update - intkey - intvalue - - - Este método actualiza una entrada con un nuevo valor y devuelve si la entrada ha sido actualizada. Si hay claves duplicadas, solo el primer elemento encontrado será actualizado. Utilice QuickHashIntHash::CHECK_FOR_DUPES al crear el hash para evitar que las claves duplicadas formen parte del hash. - - - - - &reftitle.parameters; - - - key - - - La clave de la entrada a actualizar. - - - - - value - - - El nuevo valor para actualizar la entrada. - - - - - - - - &reftitle.returnvalues; - - &true; cuando la entrada ha sido encontrada y actualizada, y &false; si la entrada no estaba ya presente en el hash. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashIntHash::update</function> - -add( 141421, 173205 ) ); -var_dump( $hash->update( 141421, 223606 ) ); -var_dump( $hash->get( 141421 ) ); -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/quickhash/quickhashintset.xml b/reference/quickhash/quickhashintset.xml deleted file mode 100644 index 027d24ef8f..0000000000 --- a/reference/quickhash/quickhashintset.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - La clase QuickHashIntSet - QuickHashIntSet - - - - -
    - &reftitle.intro; - - Esta clase envuelve un conjunto que contiene números enteros. - - - Los conjuntos pueden ser utilizados para almacenar valores únicos con foreach ya que la interfaz Iterator está - implementada. El orden en el que los elementos son devueltos no está - garantizado. - -
    - - -
    - &reftitle.classsynopsis; - - - - QuickHashIntSet - - - - - QuickHashIntSet - - - - &Constants; - - const - int - QuickHashIntSet::CHECK_FOR_DUPES - 1 - - - const - int - QuickHashIntSet::DO_NOT_USE_ZEND_ALLOC - 2 - - - const - int - QuickHashIntSet::HASHER_NO_HASH - 256 - - - const - int - QuickHashIntSet::HASHER_JENKINS1 - 512 - - - const - int - QuickHashIntSet::HASHER_JENKINS2 - 1024 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - QuickHashIntSet::CHECK_FOR_DUPES - - Si está activado, la adición de elementos duplicados a un conjunto (a través de QuickHashIntSet::add o - QuickHashIntSet::loadFromFile) resultará en la eliminación de estos elementos del conjunto. - Esto tomará más tiempo, por lo que solo se debe utilizar esta opción si es necesario. - - - - - QuickHashIntSet::DO_NOT_USE_ZEND_ALLOC - - Desactiva el uso del gestor de memoria interno de PHP - para las estructuras de juego internas. Con esta opción activada, las asignaciones internas no - contarán para los parámetros memory_limit. - - - - - QuickHashIntSet::HASHER_NO_HASH - - Selecciona no utilizar una función de hash, sino simplemente - utilizar un módulo para encontrar el índice de la lista de cubos. Esto no es más rápido que el hash normal, y - da más colisiones. - - - - - QuickHashIntSet::HASHER_JENKINS1 - - Esta es la función de hash por omisión para transformar los hash enteros - en índice de lista de cubos. - - - - - QuickHashIntSet::HASHER_JENKINS2 - - Selecciona un algoritmo de hash de variante. - - - - -
    - - -
    - - &reference.quickhash.entities.quickhashintset; - -
    - diff --git a/reference/quickhash/quickhashintset/add.xml b/reference/quickhash/quickhashintset/add.xml deleted file mode 100644 index 7bf2c7b0ad..0000000000 --- a/reference/quickhash/quickhashintset/add.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - QuickHashIntSet::add - Este método añade una nueva entrada al conjunto - - - - &reftitle.description; - - public boolQuickHashIntSet::add - intkey - - - Este método añade una nueva entrada al conjunto y devuelve si la entrada - ha sido añadida. Las entradas se añaden por omisión siempre que - QuickHashIntSet::CHECK_FOR_DUPES no haya sido pasado durante la creación del conjunto. - - - - - &reftitle.parameters; - - - key - - - La clave de la entrada a añadir. - - - - - - - - &reftitle.returnvalues; - - &true; cuando la entrada ha sido añadida, y &false; si la entrada no ha sido añadida. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashIntSet::add</function> - -exists( 4 ) ); -var_dump( $set->add( 4 ) ); -var_dump( $set->exists( 4 ) ); -var_dump( $set->add( 4 ) ); - -echo "\ncon verificación de duplicados\n"; -$set = new QuickHashIntSet( 1024, QuickHashIntSet::CHECK_FOR_DUPES ); -var_dump( $set->exists( 4 ) ); -var_dump( $set->add( 4 ) ); -var_dump( $set->exists( 4 ) ); -var_dump( $set->add( 4 ) ); -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/quickhash/quickhashintset/construct.xml b/reference/quickhash/quickhashintset/construct.xml deleted file mode 100644 index b5a04a1a64..0000000000 --- a/reference/quickhash/quickhashintset/construct.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - QuickHashIntSet::__construct - Crear un nuevo objeto QuickHashIntSet - - - - &reftitle.description; - - public QuickHashIntSet::__construct - intsize - intoptions - - - Este constructor crea un nuevo QuickHashIntSet. El tamaño es el número de - listas de cubos a crear. Cuantas más listas haya, menos colisiones habrá. - Las opciones también son soportadas. - - - - - &reftitle.parameters; - - - size - - - La cantidad de listas de cubos a configurar. El número que se pasa será - automáticamente redondeado a la siguiente potencia de dos. También se limita - automáticamente de 4 a 4194304. - - - - - options - - - Las opciones que se pueden pasar son: QuickHashIntSet::CHECK_FOR_DUPES, - que asegura que ninguna entrada duplicada sea añadida al conjunto; - QuickHashIntSet::DO_NOT_USE_ZEND_ALLOC para no utilizar el gestor de memoria - interno de PHP así como una de las QuickHashIntSet::HASHER_NO_HASH, - QuickHashIntSet::HASHER_JENKINS1 o QuickHashIntSet::HASHER_JENKINS2. - Estas tres últimas configuran el algoritmo de hash a utilizar. Todas las opciones - pueden ser combinadas utilizando máscaras de bits. - - - - - - - - &reftitle.returnvalues; - - Devuelve un nuevo objeto QuickHashIntSet. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashIntSet::__construct</function> - - -]]> - - - - - - diff --git a/reference/quickhash/quickhashintset/delete.xml b/reference/quickhash/quickhashintset/delete.xml deleted file mode 100644 index af9f95d577..0000000000 --- a/reference/quickhash/quickhashintset/delete.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - QuickHashIntSet::delete - Este método elimina una entrada del conjunto - - - - &reftitle.description; - - public boolQuickHashIntSet::delete - intkey - - - Este método elimina una entrada del conjunto y devuelve si la entrada - ha sido eliminada. Las estructuras de memoria asociadas no se liberarán - inmediatamente, sino cuando el conjunto mismo sea liberado. - - - - - &reftitle.parameters; - - - key - - - La clave de la entrada a eliminar. - - - - - - - - &reftitle.returnvalues; - - &true; cuando la entrada ha sido eliminada, y &false; si la entrada no ha sido eliminada. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashIntSet::delete</function> - -exists( 4 ) ); -var_dump( $set->add( 4 ) ); -var_dump( $set->delete( 4 ) ); -var_dump( $set->exists( 4 ) ); -var_dump( $set->delete( 4 ) ); -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/quickhash/quickhashintset/exists.xml b/reference/quickhash/quickhashintset/exists.xml deleted file mode 100644 index d462a7d82f..0000000000 --- a/reference/quickhash/quickhashintset/exists.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - QuickHashIntSet::exists - Este método verifica si una clave forma parte del conjunto - - - - &reftitle.description; - - public boolQuickHashIntSet::exists - intkey - - - Este método verifica si una entrada con la clave proporcionada existe en el conjunto. - - - - - &reftitle.parameters; - - - key - - - La clave de la entrada a verificar si existe en el conjunto. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; cuando la entrada es encontrada, o &false; cuando la entrada no es encontrada. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashIntSet::exists</function> - -add( $key ); -} - -echo "Realizando 1000 pruebas: ", microtime( true ), "\n"; -foreach( $testForEntries as $key ) -{ - $foundCount += $set->exists( $key ); -} -echo "Hecho, $foundCount encontrados: ", microtime( true ), "\n"; -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/quickhash/quickhashintset/getsize.xml b/reference/quickhash/quickhashintset/getsize.xml deleted file mode 100644 index 2c664f2451..0000000000 --- a/reference/quickhash/quickhashintset/getsize.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - QuickHashIntSet::getSize - Devuelve el número de elementos en el conjunto - - - - &reftitle.description; - - publicintQuickHashIntSet::getSize - - - Devuelve el número de elementos en el conjunto. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El número de elementos en el conjunto. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashIntSet::getSize</function> - -add( 2 ) ); -var_dump( $set->add( 3 ) ); -var_dump( $set->getSize() ); -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/quickhash/quickhashintset/loadfromfile.xml b/reference/quickhash/quickhashintset/loadfromfile.xml deleted file mode 100644 index 863aa3ea83..0000000000 --- a/reference/quickhash/quickhashintset/loadfromfile.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - QuickHashIntSet::loadFromFile - Este método de fábrica crea un conjunto a partir de un fichero - - - - &reftitle.description; - - public static QuickHashIntSetQuickHashIntSet::loadFromFile - stringfilename - intsize - intoptions - - - Este método de fábrica crea un nuevo conjunto a partir de un fichero en disco. El - formato del fichero consiste en enteros de 32 bits con signo empaquetados juntos en - el orden de bytes que el sistema en el que se ejecuta el código utiliza. - - - - - &reftitle.parameters; - - - filename - - - El nombre del fichero desde el cual leer el conjunto. - - - - - size - - - La cantidad de listas de cubos a configurar. El número que se pasa será - automáticamente redondeado a la siguiente potencia de dos. También se limita - automáticamente de 4 a 4194304. - - - - - options - - - Las mismas opciones que el constructor de la clase; excepto que la opción de tamaño - es ignorada. Se calcula automáticamente para ser la misma que el número de - entradas en el conjunto, redondeada a la potencia de dos más cercana con un - límite máximo de 4194304. - - - - - - - - &reftitle.returnvalues; - - Devuelve un nuevo QuickHashIntSet. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashIntSet::loadFromFile</function> - -exists( $key ) ? 'set' : 'unset' - ); -} -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/quickhash/quickhashintset/loadfromstring.xml b/reference/quickhash/quickhashintset/loadfromstring.xml deleted file mode 100644 index 395b7c55e2..0000000000 --- a/reference/quickhash/quickhashintset/loadfromstring.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - QuickHashIntSet::loadFromString - Este método de fábrica crea un conjunto a partir de una string - - - - &reftitle.description; - - public static QuickHashIntSetQuickHashIntSet::loadFromString - stringcontents - intsize - intoptions - - - Este método de fábrica crea un nuevo conjunto a partir de una string. - El formato del fichero consiste en enteros de 32 bits con signo empaquetados juntos en - el orden de bytes que el sistema en el que se ejecuta el código utiliza. - - - - - &reftitle.parameters; - - - contents - - - La string que contiene un formato serializado del conjunto. - - - - - size - - - La cantidad de listas de cubos a configurar. El número que se pasa será - automáticamente redondeado a la siguiente potencia de dos. También está - automáticamente limitado de 4 a 4194304. - - - - - options - - - Las mismas opciones que el constructor de la clase; excepto que la opción de tamaño - es ignorada. Se calcula automáticamente para ser el mismo que el número de - entradas en el conjunto, redondeado a la potencia de dos más cercana - con un límite máximo de 4194304. - - - - - - - - &reftitle.returnvalues; - - Devuelve un nuevo QuickHashIntSet. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashIntSet::loadFromString</function> - -exists( $key ) ? 'set' : 'unset' - ); -} -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/quickhash/quickhashintset/savetofile.xml b/reference/quickhash/quickhashintset/savetofile.xml deleted file mode 100644 index 129d89ce71..0000000000 --- a/reference/quickhash/quickhashintset/savetofile.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - QuickHashIntSet::saveToFile - Este método almacena un conjunto en memoria en disco - - - - &reftitle.description; - - public voidQuickHashIntSet::saveToFile - stringfilename - - - Este método almacena un conjunto existente en un fichero en disco, en el mismo formato - que QuickHashIntSet::loadFromFile puede leer. - - - - - &reftitle.parameters; - - - filename - - - El nombre del fichero en el cual almacenar el conjunto. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashIntSet::saveToFile</function> - -exists( 4 ) ); -var_dump( $set->add( 4 ) ); -var_dump( $set->exists( 4 ) ); -var_dump( $set->add( 4 ) ); - -$set->saveToFile( '/tmp/test.set' ); -?> -]]> - - - - - - diff --git a/reference/quickhash/quickhashintset/savetostring.xml b/reference/quickhash/quickhashintset/savetostring.xml deleted file mode 100644 index e4c56773d4..0000000000 --- a/reference/quickhash/quickhashintset/savetostring.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - QuickHashIntSet::saveToString - Este método devuelve una versión serializada del conjunto - - - - &reftitle.description; - - public stringQuickHashIntSet::saveToString - - - Este método devuelve una versión serializada del conjunto en el mismo formato que - QuickHashIntSet::loadFromString puede leer. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Este método devuelve una string que contiene una versión serializada del conjunto. - Cada elemento se almacena como un valor de cuatro bytes en el orden de bytes que el - sistema actual utiliza. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashIntSet::saveToString</function> - -exists( 4 ) ); -var_dump( $set->add( 4 ) ); -var_dump( $set->exists( 4 ) ); -var_dump( $set->add( 4 ) ); - -var_dump( $set->saveToString() ); -?> -]]> - - - - - - diff --git a/reference/quickhash/quickhashintstringhash.xml b/reference/quickhash/quickhashintstringhash.xml deleted file mode 100644 index bec292c38f..0000000000 --- a/reference/quickhash/quickhashintstringhash.xml +++ /dev/null @@ -1,147 +0,0 @@ - - - - - La clase QuickHashIntStringHash - QuickHashIntStringHash - - - - -
    - &reftitle.intro; - - Esta clase envuelve un array que contiene números enteros, donde los valores son strings. Los arrays también están disponibles como una implementación de la interfaz ArrayAccess. - - - Los hashes también pueden ser recorridos con foreach ya que la interfaz Iterator está implementada. El orden en el que los elementos son devueltos no está garantizado. - -
    - - -
    - &reftitle.classsynopsis; - - - - QuickHashIntStringHash - - - - - QuickHashIntStringHash - - - - &Constants; - - const - int - QuickHashIntStringHash::CHECK_FOR_DUPES - 1 - - - const - int - QuickHashIntStringHash::DO_NOT_USE_ZEND_ALLOC - 2 - - - const - int - QuickHashIntStringHash::HASHER_NO_HASH - 256 - - - const - int - QuickHashIntStringHash::HASHER_JENKINS1 - 512 - - - const - int - QuickHashIntStringHash::HASHER_JENKINS2 - 1024 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - QuickHashIntStringHash::CHECK_FOR_DUPES - - Si está activado, añadir elementos duplicados a un conjunto (a través de QuickHashIntStringHash::add o - QuickHashIntStringHash::loadFromFile) resultará en la eliminación de estos elementos del conjunto. - Esto tomará más tiempo, por lo que sólo debe usarse si es necesario. - - - - - QuickHashIntStringHash::DO_NOT_USE_ZEND_ALLOC - - Desactiva el uso del gestor de memoria interno de PHP para las estructuras de juego internas. Con esta opción activada, las asignaciones internas no contarán - hacia los parámetros memory_limit. - - - - - QuickHashIntStringHash::HASHER_NO_HASH - - Selecciona no usar una función de hash, sino simplemente usar un módulo para encontrar el índice de la lista de cubos. Esto no es más rápido que el hash normal, y - da más colisiones. - - - - - QuickHashIntStringHash::HASHER_JENKINS1 - - Esta es la función de hash por defecto para transformar los hashes enteros en índices de lista de cubos. - - - - - QuickHashIntStringHash::HASHER_JENKINS2 - - Selecciona un algoritmo de hash de variantes. - - - - -
    - - -
    - - &reference.quickhash.entities.quickhashintstringhash; - -
    - diff --git a/reference/quickhash/quickhashintstringhash/add.xml b/reference/quickhash/quickhashintstringhash/add.xml deleted file mode 100644 index 1a23fd48ed..0000000000 --- a/reference/quickhash/quickhashintstringhash/add.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - QuickHashIntStringHash::add - Este método añade una nueva entrada al hash - - - - &reftitle.description; - - public boolQuickHashIntStringHash::add - intkey - stringvalue - - - Este método añade una nueva entrada al hash y devuelve si la entrada ha sido - añadida. Las entradas se añaden por omisión siempre que - QuickHashIntStringHash::CHECK_FOR_DUPES no haya sido pasado durante la creación del hash. - - - - - &reftitle.parameters; - - - key - - - La clave de la entrada a añadir. - - - - - value - - - El valor de la entrada a añadir. Si se pasa un valor no-string, se convertirá automáticamente en string si es posible. - - - - - - - - &reftitle.returnvalues; - - &true; cuando la entrada ha sido añadida, y &false; si la entrada no ha sido añadida. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashIntStringHash::add</function> - -exists( 4 ) ); -var_dump( $hash->get( 4 ) ); -var_dump( $hash->add( 4, "twenty two" ) ); -var_dump( $hash->exists( 4 ) ); -var_dump( $hash->get( 4 ) ); -var_dump( $hash->add( 4, "twelve" ) ); - -echo "\ncon verificación de duplicados\n"; -$hash = new QuickHashIntStringHash( 1024, QuickHashIntStringHash::CHECK_FOR_DUPES ); -var_dump( $hash->exists( 4 ) ); -var_dump( $hash->get( 4 ) ); -var_dump( $hash->add( 4, "seventy eight" ) ); -var_dump( $hash->exists( 4 ) ); -var_dump( $hash->get( 4 ) ); -var_dump( $hash->add( 4, "nine" ) ); -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/quickhash/quickhashintstringhash/construct.xml b/reference/quickhash/quickhashintstringhash/construct.xml deleted file mode 100644 index cabca1e8af..0000000000 --- a/reference/quickhash/quickhashintstringhash/construct.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - QuickHashIntStringHash::__construct - Crear un nuevo objeto QuickHashIntStringHash - - - - &reftitle.description; - - public QuickHashIntStringHash::__construct - intsize - intoptions0 - - - Este constructor crea un nuevo objeto QuickHashIntStringHash. El tamaño es el número de - listas de cubos a crear. Cuantas más listas haya, menos colisiones habrá. - Las opciones también son compatibles. - - - - - &reftitle.parameters; - - - size - - - La cantidad de listas de cubos a configurar. El número que se pasa será - automáticamente redondeado a la siguiente potencia de dos. También se - limita automáticamente de 64 a 4194304. - - - - - options - - - Las opciones que se pueden pasar son: QuickHashIntStringHash::CHECK_FOR_DUPES, - que asegura que ninguna entrada duplicada se añada al hash; - QuickHashIntStringHash::DO_NOT_USE_ZEND_ALLOC para no utilizar el gestor de memoria interno de PHP - así como uno de los valores QuickHashIntStringHash::HASHER_NO_HASH, - QuickHashIntStringHash::HASHER_JENKINS1 o QuickHashIntStringHash::HASHER_JENKINS2. - Estas tres últimas configuran el algoritmo de hash a utilizar. Todas las opciones - pueden ser combinadas utilizando máscaras de bits. - - - - - - - - &reftitle.returnvalues; - - Devuelve un nuevo objeto QuickHashIntStringHash. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashIntStringHash::__construct</function> - - -]]> - - - - - - diff --git a/reference/quickhash/quickhashintstringhash/delete.xml b/reference/quickhash/quickhashintstringhash/delete.xml deleted file mode 100644 index b7f49b6abb..0000000000 --- a/reference/quickhash/quickhashintstringhash/delete.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - QuickHashIntStringHash::delete - Este método elimina una entrada del hash - - - - &reftitle.description; - - public boolQuickHashIntStringHash::delete - intkey - - - Este método elimina una entrada del hash y devuelve si la entrada ha sido - eliminada. Las estructuras de memoria asociadas no se liberarán inmediatamente, - sino cuando el hash mismo es liberado. - - - Los elementos no pueden ser eliminados cuando el hash está siendo utilizado en un iterador. El - método no lanzará una excepción, sino que simplemente devolverá &false; como ocurriría con cualquier otro fallo de eliminación. - - - - - &reftitle.parameters; - - - key - - - La clave de la entrada a eliminar. - - - - - - - - &reftitle.returnvalues; - - &true; cuando la entrada ha sido eliminada, y &false; si la entrada no ha sido eliminada. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashIntStringHash::delete</function> - -exists( 4 ) ); -var_dump( $hash->add( 4, "five" ) ); -var_dump( $hash->delete( 4 ) ); -var_dump( $hash->exists( 4 ) ); -var_dump( $hash->delete( 4 ) ); -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/quickhash/quickhashintstringhash/exists.xml b/reference/quickhash/quickhashintstringhash/exists.xml deleted file mode 100644 index fc4c7c4805..0000000000 --- a/reference/quickhash/quickhashintstringhash/exists.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - QuickHashIntStringHash::exists - Este método verifica si una clave forma parte del hash - - - - &reftitle.description; - - public boolQuickHashIntStringHash::exists - intkey - - - Este método verifica si una entrada con la clave proporcionada existe en el hash. - - - - - &reftitle.parameters; - - - key - - - La clave de la entrada a verificar si existe en el hash. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; cuando la entrada ha sido encontrada, o &false; cuando la entrada no es encontrada. - - - - - diff --git a/reference/quickhash/quickhashintstringhash/get.xml b/reference/quickhash/quickhashintstringhash/get.xml deleted file mode 100644 index 08d2e470e0..0000000000 --- a/reference/quickhash/quickhashintstringhash/get.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - QuickHashIntStringHash::get - Este método recupera un valor del hash por su clave - - - - &reftitle.description; - - public mixedQuickHashIntStringHash::get - intkey - - - Este método recupera un valor del hash por su clave. - - - - - &reftitle.parameters; - - - key - - - La clave de la entrada a recuperar. - - - - - - - - &reftitle.returnvalues; - - El valor si la clave existe, o &null; si la clave no era parte del hash. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashIntStringHash::get</function> - -get( 1 ) ); - -var_dump( $hash->add( 2, "two" ) ); -var_dump( $hash->get( 2 ) ); - -var_dump( $hash->add( 3, 5 ) ); -var_dump( $hash->get( 3 ) ); -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/quickhash/quickhashintstringhash/getsize.xml b/reference/quickhash/quickhashintstringhash/getsize.xml deleted file mode 100644 index d0bc2505ea..0000000000 --- a/reference/quickhash/quickhashintstringhash/getsize.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - QuickHashIntStringHash::getSize - Devuelve el número de elementos en el hash - - - - &reftitle.description; - - public intQuickHashIntStringHash::getSize - - - Devuelve el número de elementos en el hash. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El número de elementos en el hash. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashIntStringHash::getSize</function> - -add( 2, "two" ) ); -var_dump( $hash->add( 3, 5 ) ); -var_dump( $hash->getSize() ); -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/quickhash/quickhashintstringhash/loadfromfile.xml b/reference/quickhash/quickhashintstringhash/loadfromfile.xml deleted file mode 100644 index f2bceabaeb..0000000000 --- a/reference/quickhash/quickhashintstringhash/loadfromfile.xml +++ /dev/null @@ -1,171 +0,0 @@ - - - - - - QuickHashIntStringHash::loadFromFile - Este método de fábrica crea un hash a partir de un fichero - - - - &reftitle.description; - - public static QuickHashIntStringHashQuickHashIntStringHash::loadFromFile - stringfilename - intsize0 - intoptions0 - - - Este método de fábrica crea un nuevo hash a partir de un fichero de definición en el disco. El - formato del fichero consiste en una firma 'QH\0x12\0', el número de elementos como - un entero signado de 32 bits en Endianness del sistema, un entero no signado de 32 bits - conteniendo el número de datos de elementos a seguir en caracteres. Estos datos - de elementos contienen todas las strings. Después del encabezado y las strings, los - elementos siguen por pares de dos enteros no signados de 32 bits donde el primero - es la clave, y el segundo el índice en la string de datos de elementos. - Un ejemplo podría ser: - - - Formato de fichero QuickHash IntString - - - - Formato de fichero QuickHash IntString - - - - - - &reftitle.parameters; - - - filename - - - El nombre del fichero desde el cual leer el hash. - - - - - size - - - La cantidad de listas de cubos a configurar. El número que se pasa será - automáticamente redondeado a la siguiente potencia de dos. También está - automáticamente limitado de 4 a 4194304. - - - - - options - - - Las mismas opciones que el constructor de la clase; excepto que la opción - size es ignorada. Se calcula automáticamente para ser la misma que - el número de entradas en el hash, redondeada a la potencia de dos más cercana - con un límite máximo de 4194304. - - - - - - - - &reftitle.returnvalues; - - Devuelve un nuevo QuickHashIntStringHash. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashIntStringHash::loadFromFile</function> - -exists( $key ) ? 'set' : 'unset' - ); -} -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/quickhash/quickhashintstringhash/loadfromstring.xml b/reference/quickhash/quickhashintstringhash/loadfromstring.xml deleted file mode 100644 index 1924b5c6cf..0000000000 --- a/reference/quickhash/quickhashintstringhash/loadfromstring.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - QuickHashIntStringHash::loadFromString - Este método de fábrica crea un hash a partir de una string - - - - &reftitle.description; - - public static QuickHashIntStringHashQuickHashIntStringHash::loadFromString - stringcontents - intsize0 - intoptions0 - - - Este método de fábrica crea un nuevo hash a partir de una definición en una string. El - formato es el mismo que el utilizado en "loadFromFile". - - - - - &reftitle.parameters; - - - contents - - - La string que contiene un formato serializado del hash. - - - - - size - - - La cantidad de listas de buckets a configurar. El número que se pasa será - automáticamente redondeado a la siguiente potencia de dos. También se limita - automáticamente de 4 a 4194304. - - - - - options - - - Las mismas opciones que el constructor de la clase; excepto que la opción - size es ignorada. Se calcula automáticamente para ser la misma que el número de - entradas en el hash, redondeada a la potencia de dos más cercana con un límite máximo de 4194304. - - - - - - - - &reftitle.returnvalues; - - Devuelve un nuevo QuickHashIntStringHash. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashIntStringHash::loadFromString</function> - -exists( $key ) ? 'set' : 'unset' - ); -} -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/quickhash/quickhashintstringhash/savetofile.xml b/reference/quickhash/quickhashintstringhash/savetofile.xml deleted file mode 100644 index d9bb35a3c3..0000000000 --- a/reference/quickhash/quickhashintstringhash/savetofile.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - QuickHashIntStringHash::saveToFile - Este método almacena un hash en memoria en disco - - - - &reftitle.description; - - public voidQuickHashIntStringHash::saveToFile - stringfilename - - - Este método almacena un hash existente en un fichero en disco, en el mismo formato - que loadFromFile() puede leer. - - - - - &reftitle.parameters; - - - filename - - - El nombre del fichero donde almacenar el hash. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashIntStringHash::saveToFile</function> - -exists( 4 ) ); -var_dump( $hash->add( 4, "forty three" ) ); -var_dump( $hash->exists( 4 ) ); -var_dump( $hash->add( 4, "fifty two" ) ); - -$hash->saveToFile( '/tmp/test.string.hash' ); -?> -]]> - - - - - - diff --git a/reference/quickhash/quickhashintstringhash/savetostring.xml b/reference/quickhash/quickhashintstringhash/savetostring.xml deleted file mode 100644 index 0abd10efc9..0000000000 --- a/reference/quickhash/quickhashintstringhash/savetostring.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - QuickHashIntStringHash::saveToString - Este método devuelve una versión serializada del hash - - - - &reftitle.description; - - public stringQuickHashIntStringHash::saveToString - - - Este método devuelve una versión serializada del hash en el mismo formato que - QuickHashIntStringHash::loadFromString puede leer. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Este método devuelve una string que contiene una versión serializada del hash. - Cada elemento se almacena como un valor de cuatro bytes en el Endianness - que el sistema actual utiliza. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashIntStringHash::saveToString</function> - -exists( 4 ) ); -var_dump( $hash->add( 4, "thirty four" ) ); -var_dump( $hash->exists( 4 ) ); -var_dump( $hash->add( 5, "fifty five" ) ); - -var_dump( $hash->saveToString() ); -?> -]]> - - - - - - diff --git a/reference/quickhash/quickhashintstringhash/set.xml b/reference/quickhash/quickhashintstringhash/set.xml deleted file mode 100644 index 71e6fa72ff..0000000000 --- a/reference/quickhash/quickhashintstringhash/set.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - QuickHashIntStringHash::set - Este método actualiza una entrada en el hash con un nuevo valor, o - añade una nueva entrada si la entrada no existe - - - - &reftitle.description; - - public intQuickHashIntStringHash::set - intkey - stringvalue - - - Este método intenta actualizar una entrada con un nuevo valor. Si - la entrada no existía, añadirá una nueva entrada. Devuelve si - la entrada ha sido añadida o actualizada. Si hay claves duplicadas, - solo el primer elemento encontrado será actualizado. Utilice - QuickHashIntStringHash::CHECK_FOR_DUPES al crear el hash para evitar que las claves duplicadas - formen parte del hash. - - - - - &reftitle.parameters; - - - key - - - La clave de la entrada a añadir o actualizar. - - - - - value - - - El valor de la entrada a añadir. Si se pasa un valor que no es una string, será - convertido automáticamente a string si es posible. - - - - - - - - &reftitle.returnvalues; - - 2 si la entrada ha sido encontrada y actualizada, 1 si la entrada ha sido nuevamente añadida o 0 - si ha habido un error. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashIntStringHash::set</function> - -Add\n"; -var_dump( $hash->get( 46692 ) ); -var_dump( $hash->set( 46692, "sixteen thousand ninety one" ) ); -var_dump( $hash->get( 46692 ) ); - -echo "Set->Update\n"; -var_dump( $hash->set( 46692, "twenty nine thousand nine hundred six" ) ); -var_dump( $hash->get( 46692 ) ); -?> -]]> - - &example.outputs.similar; - -Add -bool(false) -int(2) -string(27) "sixteen thousand ninety one" -Set->Update -int(1) -string(37) "twenty nine thousand nine hundred six" -]]> - - - - - - diff --git a/reference/quickhash/quickhashintstringhash/update.xml b/reference/quickhash/quickhashintstringhash/update.xml deleted file mode 100644 index 05809b474c..0000000000 --- a/reference/quickhash/quickhashintstringhash/update.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - QuickHashIntStringHash::update - Este método actualiza una entrada en el hash con un nuevo valor - - - - &reftitle.description; - - public boolQuickHashIntStringHash::update - intkey - stringvalue - - - Este método actualiza una entrada con un nuevo valor y devuelve si - la entrada ha sido actualizada. Si hay claves duplicadas, solo el - primer elemento encontrado será actualizado. Utilice QuickHashIntStringHash::CHECK_FOR_DUPES - al crear el hash para evitar que las claves duplicadas formen parte del hash. - - - - - &reftitle.parameters; - - - key - - - La clave de la entrada a actualizar. - - - - - value - - - El nuevo valor para la entrada. Si se pasa un valor que no es una string, se - convertirá automáticamente en una string si es posible. - - - - - - - - &reftitle.returnvalues; - - &true; cuando la entrada ha sido encontrada y actualizada, y &false; si la entrada no - era ya parte del hash. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashIntStringHash::update</function> - -add( 161803398, "--" ); -$hash->add( 314159265, "a lot" ); - -echo $hash->get( 161803398 ), "\n"; -echo $hash->get( 314159265 ), "\n"; - -var_dump( $hash->update( 314159265, "a lot plus one" ) ); -var_dump( $hash->update( 314159999, "a lot plus one" ) ); - -echo $hash->get( 161803398 ), "\n"; -echo $hash->get( 314159265 ), "\n"; -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/quickhash/quickhashstringinthash.xml b/reference/quickhash/quickhashstringinthash.xml deleted file mode 100644 index a4b90ded28..0000000000 --- a/reference/quickhash/quickhashstringinthash.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - La clase QuickHashStringIntHash - QuickHashStringIntHash - - - - -
    - &reftitle.intro; - - Esta clase envuelve un hash que contiene strings, donde los valores son enteros. Los hashes también están disponibles como una implementación de la interfaz ArrayAccess. - - - Los hashes también pueden ser recorridos con foreach ya que la interfaz Iterator está implementada. El orden en el que los elementos son devueltos no está garantizado. - -
    - - -
    - &reftitle.classsynopsis; - - - - QuickHashStringIntHash - - - - - QuickHashStringIntHash - - - - &Constants; - - const - int - QuickHashStringIntHash::CHECK_FOR_DUPES - 1 - - - const - int - QuickHashStringIntHash::DO_NOT_USE_ZEND_ALLOC - 2 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - QuickHashStringIntHash::CHECK_FOR_DUPES - - Si está activado, la adición de elementos duplicados a un hash (vía QuickHashStringIntHash::add o QuickHashStringIntHash::loadFromFile) resultará en la eliminación de estos elementos del hash. Esto tomará tiempo adicional, por lo que solo se debe usar esta opción si es necesario. - - - - - QuickHashStringIntHash::DO_NOT_USE_ZEND_ALLOC - - Desactiva el uso del gestor de memoria interno de PHP para las estructuras de hash internas. Con esta opción activada, las asignaciones internas no serán consideradas en los parámetros memory_limit. - - - - -
    - - -
    - - &reference.quickhash.entities.quickhashstringinthash; - -
    - diff --git a/reference/quickhash/quickhashstringinthash/add.xml b/reference/quickhash/quickhashstringinthash/add.xml deleted file mode 100644 index 5ca9fb0b8c..0000000000 --- a/reference/quickhash/quickhashstringinthash/add.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - QuickHashStringIntHash::add - Este método añade una nueva entrada al hash - - - - &reftitle.description; - - public boolQuickHashStringIntHash::add - stringkey - intvalue - - - Este método añade una nueva entrada al hash y devuelve si la entrada ha sido añadida. Por omisión, las entradas siempre se añaden a menos que QuickHashStringIntHash::CHECK_FOR_DUPES haya sido pasado durante la creación del hash. - - - - - &reftitle.parameters; - - - key - - - La clave de la entrada a añadir. - - - - - value - - - El valor de la entrada a añadir. - - - - - - - - &reftitle.returnvalues; - - &true; cuando la entrada ha sido añadida, y &false; si la entrada no ha sido añadida. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashStringIntHash::add</function> - -exists( "four" ) ); -var_dump( $hash->get( "four" ) ); -var_dump( $hash->add( "four", 22 ) ); -var_dump( $hash->exists( "four" ) ); -var_dump( $hash->get( "four" ) ); -var_dump( $hash->add( "four", 12 ) ); - -echo "\ncon verificación de duplicados\n"; -$hash = new QuickHashStringIntHash( 1024, QuickHashStringIntHash::CHECK_FOR_DUPES ); -var_dump( $hash ); -var_dump( $hash->exists( "four" ) ); -var_dump( $hash->get( "four" ) ); -var_dump( $hash->add( "four", 78 ) ); -var_dump( $hash->exists( "four" ) ); -var_dump( $hash->get( "four" ) ); -var_dump( $hash->add( "four", 9 ) ); -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/quickhash/quickhashstringinthash/construct.xml b/reference/quickhash/quickhashstringinthash/construct.xml deleted file mode 100644 index be33621641..0000000000 --- a/reference/quickhash/quickhashstringinthash/construct.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - QuickHashStringIntHash::__construct - Crear un nuevo objeto QuickHashStringIntHash - - - - &reftitle.description; - - public QuickHashStringIntHash::__construct - intsize - intoptions0 - - - Este constructor crea un nuevo objeto QuickHashStringIntHash. El tamaño es el número de - listas de cubos a crear. Cuantas más listas haya, menos colisiones habrá. - Las opciones también son soportadas. - - - - - &reftitle.parameters; - - - size - - - La cantidad de listas de cubos a configurar. El número que se pasa será - automáticamente redondeado a la siguiente potencia de dos. También se limita - automáticamente de 64 a 4194304. - - - - - options - - - Las opciones que se pueden pasar son: - QuickHashStringIntHash::CHECK_FOR_DUPES, que verifica que ninguna entrada duplicada - se añade al hash y - QuickHashStringIntHash::DO_NOT_USE_ZEND_ALLOC para no utilizar el gestor de memoria - interno de PHP. - - - - - - - - &reftitle.returnvalues; - - Devuelve un nuevo objeto QuickHashStringIntHash. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashStringIntHash::__construct</function> - - -]]> - - - - - - diff --git a/reference/quickhash/quickhashstringinthash/delete.xml b/reference/quickhash/quickhashstringinthash/delete.xml deleted file mode 100644 index adba3bb672..0000000000 --- a/reference/quickhash/quickhashstringinthash/delete.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - QuickHashStringIntHash::delete - Este método elimina una entrada del hash - - - - &reftitle.description; - - public boolQuickHashStringIntHash::delete - stringkey - - - Este método elimina una entrada del hash y devuelve si la entrada ha sido - eliminada o no. Las estructuras de memoria asociadas no serán liberadas inmediatamente, - sino cuando el hash mismo es liberado. - - - Los elementos no pueden ser eliminados cuando el hash está siendo utilizado en un iterador. La - método no lanzará una excepción, sino que simplemente devolverá &false; como ocurriría - con cualquier otro fallo de eliminación. - - - - - &reftitle.parameters; - - - key - - - La clave de la entrada a eliminar. - - - - - - - - &reftitle.returnvalues; - - &true; cuando la entrada ha sido eliminada, y &false; si la entrada no ha sido eliminada. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashStringIntHash::delete</function> - -exists( 'four' ) ); -var_dump( $hash->add( 'four', 5 ) ); -var_dump( $hash->get( 'four' ) ); -var_dump( $hash->delete( 'four' ) ); -var_dump( $hash->exists( 'four' ) ); -var_dump( $hash->get( 'four' ) ); -var_dump( $hash->delete( 'four' ) ); -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/quickhash/quickhashstringinthash/exists.xml b/reference/quickhash/quickhashstringinthash/exists.xml deleted file mode 100644 index 1e9aa100bb..0000000000 --- a/reference/quickhash/quickhashstringinthash/exists.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - QuickHashStringIntHash::exists - Este método verifica si una clave forma parte del hash - - - - &reftitle.description; - - public boolQuickHashStringIntHash::exists - stringkey - - - Este método verifica si una entrada con la clave proporcionada existe en el - hash. - - - - - &reftitle.parameters; - - - key - - - La clave de la entrada a verificar si existe en el hash. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; cuando la entrada es encontrada, o &false; cuando la entrada no es - encontrada. - - - - - diff --git a/reference/quickhash/quickhashstringinthash/get.xml b/reference/quickhash/quickhashstringinthash/get.xml deleted file mode 100644 index 5fbc9d1d7a..0000000000 --- a/reference/quickhash/quickhashstringinthash/get.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - QuickHashStringIntHash::get - Este método recupera un valor del hash por su clave - - - - &reftitle.description; - - public mixedQuickHashStringIntHash::get - stringkey - - - Este método recupera un valor del hash por su clave. - - - - - &reftitle.parameters; - - - key - - - La clave de la entrada a recuperar. - - - - - - - - &reftitle.returnvalues; - - El valor si la clave existe, o &null; si la clave no era parte del hash. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashStringIntHash::get</function> - -get( "one" ) ); - -var_dump( $hash->add( "two", 2 ) ); -var_dump( $hash->get( "two" ) ); -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/quickhash/quickhashstringinthash/getsize.xml b/reference/quickhash/quickhashstringinthash/getsize.xml deleted file mode 100644 index 1c703281dc..0000000000 --- a/reference/quickhash/quickhashstringinthash/getsize.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - QuickHashStringIntHash::getSize - Devuelve el número de elementos en el hash - - - - &reftitle.description; - - public intQuickHashStringIntHash::getSize - - - Devuelve el número de elementos en el hash. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El número de elementos en el hash. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashStringIntHash::getSize</function> - -add( "two", 2 ) ); -var_dump( $hash->add( "three", 5 ) ); -var_dump( $hash->getSize() ); -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/quickhash/quickhashstringinthash/loadfromfile.xml b/reference/quickhash/quickhashstringinthash/loadfromfile.xml deleted file mode 100644 index 7b06b75d3e..0000000000 --- a/reference/quickhash/quickhashstringinthash/loadfromfile.xml +++ /dev/null @@ -1,181 +0,0 @@ - - - - - - QuickHashStringIntHash::loadFromFile - Este método de fábrica crea un hash a partir de un fichero - - - - &reftitle.description; - - public static QuickHashStringIntHashQuickHashStringIntHash::loadFromFile - stringfilename - intsize0 - intoptions0 - - - Este método de fábrica crea un nuevo hash a partir de un fichero de definición en el disco. El - formato del fichero se compone de una firma 'QH\0x21\0', del número de elementos como - entero signado de 32 bits en Endianness del sistema, un entero no signado de 32 bits - conteniendo el número de datos de elementos a seguir en caracteres. Estos datos - de elementos contienen todas las strings. Sigue otro entero signado de 32 bits - conteniendo el número de listas de cubos. Después del encabezado y las strings, - los elementos siguen. Están ordenados por lista de cubos de manera que las claves no - deben ser hasheadas para restaurar el hash. Para cada lista de cubos, la siguiente información es almacenada (todas en enteros de 32 bits): el índice de la lista de cubos, - el número de elementos en esta lista, y luego por parejas de dos - enteros no signados de 32 bits los elementos, donde el primero es el índice - en la lista de strings conteniendo las claves, y el segundo el valor. Un - ejemplo podría ser: - - - Formato de fichero QuickHash StringIntHash - - - - Formato de fichero QuickHash IntHash - - - - - - &reftitle.parameters; - - - filename - - - El nombre del fichero desde el cual leer el hash. - - - - - size - - - El número de listas de cubos a configurar. El número que se pasa será - automáticamente redondeado a la siguiente potencia de dos. También es - automáticamente limitado de 4 a 4194304. - - - - - options - - - Las mismas opciones que el constructor de la clase; excepto que la opción - size es ignorada. Se lee desde el formato de fichero (a diferencia de las - clases QuickHashIntHash y QuickHashIntStringHash, donde se - calcula automáticamente a partir del número de entradas en el hash.) - - - - - - - - &reftitle.returnvalues; - - Devuelve un nuevo QuickHashStringIntHash. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashStringIntHash::loadFromFile</function> - - ', $hash->get( $k ), "\n"; -} -?> -]]> - - &example.outputs.similar; - - 48712 -12uf => 50343 -143q => 51974 -15d1 => 53605 -16mc => 55236 -17vn => 56867 -194y => 58498 -1ae9 => 60129 -1bnk => 61760 -1cwv => 63391 -1e66 => 65022 -1ffh => 66653 -1gos => 68284 -1hy3 => 69915 -1j7e => 71546 -1kgp => 73177 -]]> - - - - - - diff --git a/reference/quickhash/quickhashstringinthash/loadfromstring.xml b/reference/quickhash/quickhashstringinthash/loadfromstring.xml deleted file mode 100644 index 437c233ba8..0000000000 --- a/reference/quickhash/quickhashstringinthash/loadfromstring.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - QuickHashStringIntHash::loadFromString - Este método de fábrica crea un hash a partir de una cadena - - - - &reftitle.description; - - public static QuickHashStringIntHashQuickHashStringIntHash::loadFromString - stringcontents - intsize0 - intoptions0 - - - Este método de fábrica crea un nuevo hash a partir de una definición en una cadena. El - formato es el mismo que el utilizado en "loadFromFile". - - - - - &reftitle.parameters; - - - contents - - - La cadena que contiene un formato serializado del hash. - - - - - size - - - La cantidad de listas de cubos a configurar. El número que se pasa será - automáticamente redondeado a la siguiente potencia de dos. También se - limita automáticamente de 4 a 4194304. - - - - - options - - - Las mismas opciones que el constructor de la clase; excepto que la opción - size es ignorada. Se calcula automáticamente para ser la misma que el - número de entradas en el hash, redondeada a la potencia de dos más cercana - con un límite máximo de 4194304. - - - - - - - - &reftitle.returnvalues; - - Devuelve un nuevo QuickHashStringIntHash. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashStringIntHash::loadFromString</function> - - ', $hash->get( $k ), "\n"; -} -?> -]]> - - &example.outputs.similar; - - 48712 -12uf => 50343 -143q => 51974 -15d1 => 53605 -16mc => 55236 -17vn => 56867 -194y => 58498 -1ae9 => 60129 -1bnk => 61760 -1cwv => 63391 -1e66 => 65022 -1ffh => 66653 -1gos => 68284 -1hy3 => 69915 -1j7e => 71546 -1kgp => 73177 -]]> - - - - - - diff --git a/reference/quickhash/quickhashstringinthash/savetofile.xml b/reference/quickhash/quickhashstringinthash/savetofile.xml deleted file mode 100644 index e54dda9245..0000000000 --- a/reference/quickhash/quickhashstringinthash/savetofile.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - QuickHashStringIntHash::saveToFile - Este método almacena un hash en memoria en el disco - - - - &reftitle.description; - - public voidQuickHashStringIntHash::saveToFile - stringfilename - - - Este método almacena un hash existente en un fichero en el disco, en el mismo formato - que loadFromFile() puede leer. - - - - - &reftitle.parameters; - - - filename - - - El nombre del fichero donde almacenar el hash. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashStringIntHash::saveToFile</function> - -add( "forty three", 42 ) ); -var_dump( $hash->add( "fifty two", 52 ) ); - -$hash->saveToFile( '/tmp/test.hash.string' ); -?> -]]> - - - - - - diff --git a/reference/quickhash/quickhashstringinthash/savetostring.xml b/reference/quickhash/quickhashstringinthash/savetostring.xml deleted file mode 100644 index 1d75b64cd2..0000000000 --- a/reference/quickhash/quickhashstringinthash/savetostring.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - QuickHashStringIntHash::saveToString - Este método devuelve una versión serializada del hash - - - - &reftitle.description; - - public stringQuickHashStringIntHash::saveToString - - - Este método devuelve una versión serializada del hash en el mismo formato que - QuickHashStringIntHash::loadFromString puede leer. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Este método devuelve una versión serializada del hash, en el mismo formato que - QuickHashStringIntHash::loadFromString puede leer. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashStringIntHash::saveToString</function> - -add( "forty three", 42 ) ); -var_dump( $hash->add( "fifty two", 52 ) ); - -var_dump( $hash->saveToString() ); -?> -]]> - - - - - - diff --git a/reference/quickhash/quickhashstringinthash/set.xml b/reference/quickhash/quickhashstringinthash/set.xml deleted file mode 100644 index f1ef58ff45..0000000000 --- a/reference/quickhash/quickhashstringinthash/set.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - QuickHashStringIntHash::set - Este método actualiza una entrada en el hash con un nuevo valor, o - añade una nueva entrada si la entrada no existe - - - - &reftitle.description; - - public intQuickHashStringIntHash::set - stringkey - intvalue - - - Este método actualiza una entrada con un nuevo valor. Si la entrada - no existía, añadirá una nueva entrada. Devuelve si la entrada - ha sido añadida o actualizada. Si hay claves duplicadas, solo el - primer elemento encontrado será actualizado. Utilice - QuickHashStringIntHash::CHECK_FOR_DUPES al crear el hash para evitar que las claves duplicadas - formen parte del hash. - - - - - &reftitle.parameters; - - - key - - - La clave de la entrada a añadir o actualizar. - - - - - value - - - El valor de la entrada a añadir. Si se pasa un valor no string, será - convertido a string automáticamente si es posible. - - - - - - - - &reftitle.returnvalues; - - 2 si la entrada ha sido encontrada y actualizada, 1 si la entrada ha sido nuevamente añadida o 0 - si ha habido un error. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashStringIntHash::set</function> - -Add\n"; -var_dump( $hash->get( "forty six thousand six hundred ninety two" ) ); -var_dump( $hash->set( "forty six thousand six hundred ninety two", 16091 ) ); -var_dump( $hash->get( "forty six thousand six hundred ninety two" ) ); - -echo "Set->Update\n"; -var_dump( $hash->set( "forty six thousand six hundred ninety two", 29906 ) ); -var_dump( $hash->get( "forty six thousand six hundred ninety two" ) ); -?> -]]> - - &example.outputs.similar; - -Add -bool(false) -int(2) -int(16091) -Set->Update -int(1) -int(29906) -]]> - - - - - - diff --git a/reference/quickhash/quickhashstringinthash/update.xml b/reference/quickhash/quickhashstringinthash/update.xml deleted file mode 100644 index b8c6811b27..0000000000 --- a/reference/quickhash/quickhashstringinthash/update.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - QuickHashStringIntHash::update - Este método actualiza una entrada en el hash con un nuevo valor - - - - &reftitle.description; - - public boolQuickHashStringIntHash::update - stringkey - intvalue - - - Este método actualiza una entrada con un nuevo valor y devuelve si - la entrada ha sido actualizada. Si hay claves duplicadas, solo - el primer elemento encontrado será actualizado. Utilice QuickHashStringIntHash::CHECK_FOR_DUPES al - crear el hash para evitar que las claves duplicadas formen parte del hash. - - - - - &reftitle.parameters; - - - key - - - La clave de la entrada a actualizar. - - - - - value - - - El nuevo valor de la entrada. Si se pasa un valor que no es una cadena, se convertirá automáticamente en una cadena si es posible. - - - - - - - - &reftitle.returnvalues; - - &true; cuando la entrada ha sido encontrada y actualizada, y &false; si la entrada no era - ya parte del hash. - - - - - &reftitle.examples; - - Ejemplo de <function>QuickHashStringIntHash::update</function> - -add( 'six', 314159265 ); -$hash->add( "a lot", 314159265 ); - -echo $hash->get( 'six' ), "\n"; -echo $hash->get( 'a lot' ), "\n"; - -var_dump( $hash->update( 'a lot', 314159266 ) ); -var_dump( $hash->update( "a lot plus one", 314159999 ) ); - -echo $hash->get( 'six' ), "\n"; -echo $hash->get( 'a lot' ), "\n"; -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/quickhash/setup.xml b/reference/quickhash/setup.xml deleted file mode 100644 index 2553e99981..0000000000 --- a/reference/quickhash/setup.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Esta extensión requiere PHP 5.2.0 o superior. - -
    - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;quickhash - -
    - -
    - diff --git a/reference/radius/book.xml b/reference/radius/book.xml deleted file mode 100644 index d33f763b3d..0000000000 --- a/reference/radius/book.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Radius - - - - &reftitle.intro; - - Este paquete se basa en los libradius de FreeBSD (Autenticación remota telefónica - de servicio de usuario). Permite a los clientes realizar la autenticación y la - contabilidad por medio de solicitudes de red a servidores remotos. - - - Esta extensión PECL añade soporte completo para la autenticación Radius - (RFC 2865) y contabilidad Radius - (RFC 2866). Este paquete está disponible - para Unix (probado en FreeBSD y Linux) y para Windows. - - - - Una descripción exacta de libradius se pueden encontrar - aquí. Una descripción detallada del archivo - de configuración se puede encontrar aquí. - - - - - - &reference.radius.setup; - &reference.radius.constants; - &reference.radius.examples; - &reference.radius.reference; - - - diff --git a/reference/radius/configure.xml b/reference/radius/configure.xml deleted file mode 100644 index f39a613092..0000000000 --- a/reference/radius/configure.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;radius. - -
    - diff --git a/reference/radius/constants.xml b/reference/radius/constants.xml deleted file mode 100644 index 23b7a8dd5c..0000000000 --- a/reference/radius/constants.xml +++ /dev/null @@ -1,2001 +0,0 @@ - - - - - - &reftitle.constants; - &extension.constants; - - - - - RADIUS_MPPE_KEY_LEN - (int) - - - - La longitud máxima de las claves MPPE. - - - - - -
    - Opciones RADIUS - - - Varias funciones RADIUS aceptan opciones en forma de máscara de octetos. - Las constantes que representan estas opciones se enumeran a continuación. - - - - - - RADIUS_OPTION_SALT - (int) - - - - Cuando se define, esta opción hará que el valor del atributo - sea cifrado salt. - - - - - - RADIUS_OPTION_TAGGED - (int) - - - - Cuando se define, esta opción hará que el valor del atributo - provenga del argumento tag. - - - - -
    - -
    - Tipos de paquetes RADIUS - - - Los paquetes RADIUS, ya sean solicitados o recibidos como respuesta, siempre incluyen - un tipo. Esta constante se proporciona para facilitar - la especificación de un tipo al utilizar la función - radius_create_request, y al comparar el resultado con la función radius_send_request. - - - - - - RADIUS_ACCESS_REQUEST - (int) - - - - Un Access-Request, utilizado para autenticar un usuario - en un servidor RADIUS. Los paquetes Access-Request deben incluir - un atributo RADIUS_NAS_IP_ADDRESS, - o un atributo RADIUS_NAS_IDENTIFIER - pero también incluir un atributo RADIUS_USER_PASSWORD, - y un atributo RADIUS_CHAP_PASSWORD - o bien un atributo RADIUS_STATE, - y deben incluir un atributo RADIUS_USER_NAME. - - - - - - RADIUS_ACCESS_ACCEPT - (int) - - - - Una respuesta Access-Accept a un paquete Access-Request indica que el servidor RADIUS - ha autenticado al usuario con éxito. - - - - - - RADIUS_ACCESS_REJECT - (int) - - - - Una respuesta Access-Reject a un paquete Access-Request indica que el servidor RADIUS - no ha logrado autenticar al usuario. - - - - - - RADIUS_ACCESS_CHALLENGE - (int) - - - - Una respuesta Access-Challenge a un paquete Access-Request indica que el servidor RADIUS - requiere más información de otro paquete Access-Request antes de autenticar - al usuario. - - - - - - RADIUS_ACCOUNTING_REQUEST - (int) - - - - Un paquete Accounting-Request, utilizado para transmitir información de - contabilidad para un servicio del servidor RADIUS. - - - - - - RADIUS_ACCOUNTING_RESPONSE - (int) - - - - Una respuesta Accounting-Response a un paquete Accounting-Request. - - - - - - RADIUS_COA_REQUEST - (int) - - - - Un paquete CoA-Request, enviado desde un servidor RADIUS para - indicar que los permisos han cambiado en la sesión del usuario. - Se debe emitir una respuesta en forma de CoA-ACK o CoA-NAK. - - - Esta constante está disponible desde PECL radius 1.3.0 y versiones posteriores. - - - - - - RADIUS_COA_ACK - (int) - - - - Un paquete CoA-ACK, enviado al servidor RADIUS para indicar - que los permisos del usuario han sido actualizados. - - - Esta constante está disponible desde PECL radius 1.3.0 y versiones posteriores. - - - - - - RADIUS_COA_NAK - (int) - - - - Un paquete CoA-NAK, enviado al servidor RADIUS para indicar que los permisos - del usuario no han podido ser actualizados. - - - Esta constante está disponible desde PECL radius 1.3.0 y versiones posteriores. - - - - - - RADIUS_DISCONNECT_REQUEST - (int) - - - - Un paquete Disconnect-Request, enviado desde el servidor RADIUS para indicar - que la sesión del usuario debe cerrarse. - - - Esta constante está disponible desde PECL radius 1.3.0 y versiones posteriores. - - - - - - RADIUS_DISCONNECT_ACK - (int) - - - - Un paquete Disconnect-ACK, enviado al servidor RADIUS para indicar que - la sesión del usuario ha finalizado. - - - Esta constante está disponible desde PECL radius 1.3.0 y versiones posteriores. - - - - - - RADIUS_DISCONNECT_NAK - (int) - - - - Un paquete Disconnect-NAK, enviado al servidor RADIUS para indicar - que la sesión del usuario no ha podido finalizar. - - - Esta constante está disponible desde PECL radius 1.3.0 y versiones posteriores. - - - - -
    - -
    - Tipos de atributo RADIUS - - - Estas constantes definen tipos de atributo RADIUS que pueden ser utilizadas - con las funciones radius_put_addr, radius_put_attr, - radius_put_int y radius_put_string. - - - - - - RADIUS_USER_NAME - (int) - - - - El atributo User-Name. El valor del atributo debe ser un string que - contenga el nombre de usuario que desea autenticarse, - y puede ser definido utilizando la función radius_put_attr. - - - - - - RADIUS_USER_PASSWORD - (int) - - - - El atributo User-Password. El valor del atributo debe ser un string que - contenga la contraseña del usuario, y puede ser definido utilizando la función radius_put_attr. - Este valor será cifrado durante la transmisión como se describe en - la sección 5.2 de la RFC 2865. - - - - - - RADIUS_CHAP_PASSWORD - (int) - - - - El atributo Chap-Password. El valor del atributo debe ser un string que - contenga el primer octeto (que es el identificador CHAP), seguido de - una subsecuencia de 16 octetos que contenga el hash MD5 del identificador - CHAP, la contraseña en texto plano, y el valor del desafío CHAP, - todo concatenado. Tenga en cuenta que el valor del desafío CHAP - también debe ser enviado por separado en el atributo - RADIUS_CHAP_CHALLENGE. - - - Uso de contraseñas CHAP - - -]]> - - - - - - - RADIUS_NAS_IP_ADDRESS - (int) - - - - El atributo NAS-IP-Address. El valor del atributo esperado es la dirección - IP del cliente RADIUS codificada como un entero, que puede - ser definida utilizando la función radius_put_addr. - - - - - - RADIUS_NAS_PORT - (int) - - - - El atributo NAS-Port. El valor del atributo esperado es el puerto - físico del usuario en el cliente RADIUS, codificado como un entero, que puede ser definido - utilizando la función radius_put_int. - - - - - - RADIUS_SERVICE_TYPE - (int) - - - - El atributo Service-Type. El valor del atributo indica el tipo - de servicio que el usuario solicita, y debe ser un entero, - que puede ser definido utilizando la función - radius_put_int. - - - Se proporcionan constantes para representar los valores posibles - de este atributo. Aquí están: - - RADIUS_LOGIN - RADIUS_FRAMED - RADIUS_CALLBACK_LOGIN - RADIUS_CALLBACK_FRAMED - RADIUS_OUTBOUND - RADIUS_ADMINISTRATIVE - RADIUS_NAS_PROMPT - RADIUS_AUTHENTICATE_ONLY - RADIUS_CALLBACK_NAS_PROMPT - - - - - - - RADIUS_FRAMED_PROTOCOL - (int) - - - - El atributo Framed-Protocol. El valor del atributo esperado es - un entero, que indica el framing a utilizar para el acceso, y puede ser - definido utilizando la función radius_put_int. - Los valores posibles para este atributo son: - - RADIUS_PPP - RADIUS_SLIP - RADIUS_ARAP - RADIUS_GANDALF - RADIUS_XYLOGICS - - - - - - - RADIUS_FRAMED_IP_ADDRESS - (int) - - - - El atributo Framed-IP-Address. El valor esperado es una dirección - de la red del usuario codificada como un entero, - que puede ser definida utilizando la función radius_put_addr - y recuperada utilizando la función radius_cvt_addr. - - - - - - RADIUS_FRAMED_IP_NETMASK - (int) - - - - El atributo Framed-IP-Netmask. El valor esperado es una máscara de red - del usuario, codificada como un entero, que - puede ser definida utilizando la función radius_put_addr - y recuperada utilizando la función radius_cvt_addr. - - - - - - RADIUS_FRAMED_ROUTING - (int) - - - - El atributo Framed-Routing. El valor esperado es un entero - que indica el método de enrutamiento para el usuario, que puede - ser definido utilizando la función radius_put_int. - - - Valores posibles: - - 0: Sin enrutamiento - 1: Enviar paquetes de enrutamiento - 2: Escuchar paquetes de enrutamiento - 3: Enviar y escuchar - - - - - - - RADIUS_FILTER_ID - (int) - - - - El atributo Filter-ID. El valor esperado es una implementación - específica, legible por humanos, de strings de filtros, que - pueden ser definidas utilizando la función - radius_put_attr. - - - - - - RADIUS_FRAMED_MTU - (int) - - - - El atributo Framed-MTU. El valor esperado es un entero, que indica - el MTU a configurar para el usuario, y puede ser - definido utilizando la función radius_put_int. - - - - - - RADIUS_FRAMED_COMPRESSION - (int) - - - - El atributo Framed-Compression. El valor esperado es un entero, - que indica el protocolo de compresión a utilizar, y puede ser - definido utilizando la función radius_put_int. - Valores posibles: - - RADIUS_COMP_NONE: Sin compresión - RADIUS_COMP_VJ: Compresión de cabecera VJ TCP/IP - RADIUS_COMP_IPXHDR: Compresión de cabecera IPX - - RADIUS_COMP_STAC_LZS: Compresión Stac-LZS (añadido en PECL radius 1.3.0b2) - - - - - - - - RADIUS_LOGIN_IP_HOST - (int) - - - - El atributo Login-IP-Host. El valor esperado es la dirección IP - de conexión del usuario, codificada como un entero, - que puede ser definido utilizando la función - radius_put_addr. - - - - - - RADIUS_LOGIN_SERVICE - (int) - - - - El atributo Login-Service. El valor esperado es un entero que indica - el servicio al que el usuario se conecta en el host de identificación. - El valor puede ser convertido a un entero PHP mediante la función - radius_cvt_int. - - - - - - RADIUS_LOGIN_TCP_PORT - (int) - - - - El atributo Login-TCP-Port. El valor esperado es un entero que indica - el puerto al que el usuario se conecta en el host de identificación. - El valor puede ser convertido a un entero PHP mediante la función - radius_cvt_int. - - - - - - RADIUS_REPLY_MESSAGE - (int) - - - - El atributo Reply-Message. El valor esperado es un string que - contiene un texto que puede ser mostrado al usuario en respuesta - a una solicitud de acceso. - - - - - - RADIUS_CALLBACK_NUMBER - (int) - - - - El atributo Callback-Number. El valor esperado es un string que - contiene la cadena de marcación a utilizar para - la función de devolución de llamada. - - - - - - RADIUS_CALLBACK_ID - (int) - - - - El atributo Callback-Id. El valor esperado es un string que contiene - el nombre de la implementación específica del lugar a llamar. - - - - - - RADIUS_FRAMED_ROUTE - (int) - - - - El atributo Framed-Route. El valor esperado es un string que - contiene un conjunto de rutas de implementación específica a configurar - para el usuario. - - - - - - RADIUS_FRAMED_IPX_NETWORK - (int) - - - - El atributo Framed-IPX-Network. El valor esperado es un entero - que contiene la red IPX a configurar para el usuario, o - 0xFFFFFFFE para indicar que el cliente RADIUS debe seleccionar - la red, y puede ser accedido mediante la función - radius_cvt_int. - - - - - - RADIUS_STATE - (int) - - - - El atributo State. El valor esperado es un string que contiene - la implementación definida incluida en un Access-Challenge desde - un servidor que debe ser incluida en la subsiguiente Access-Request, - y puede ser definido utilizando la función - radius_put_attr. - - - - - - RADIUS_CLASS - (int) - - - - El atributo Class. El valor esperado es un string arbitrario que incluye - el mensaje de un Access-Accept que debe ser enviado al servidor de cuentas - en los mensajes Accounting-Request, y puede ser definido mediante la función - radius_put_attr. - - - - - - RADIUS_VENDOR_SPECIFIC - (int) - - - - El atributo Vendor-Specific. En general, los valores del atributo del vendedor - deben ser definidos utilizando las funciones - radius_put_vendor_addr, - radius_put_vendor_attr, - radius_put_vendor_int y - radius_put_vendor_string, en lugar de hacerlo directamente. - - - Esta constante es útil al interpretar los atributos - específicos del vendedor en las respuestas de un servidor RADIUS; cuando se recibe - un atributo específico del vendedor, la función - radius_get_vendor_attr debe ser utilizada para - acceder al identificador del vendedor, el tipo de atributo y el valor del atributo. - - - - - - RADIUS_SESSION_TIMEOUT - (int) - - - - Tiempo de espera de la sesión - - - - - - RADIUS_IDLE_TIMEOUT - (int) - - - - Tiempo de expiración - - - - - - RADIUS_TERMINATION_ACTION - (int) - - - - Acción de terminación - - - - - - RADIUS_CALLED_STATION_ID - (int) - - - - Identificador de la estación llamada - - - - - - RADIUS_CALLING_STATION_ID - (int) - - - - Identificador de la estación llamante - - - - - - RADIUS_NAS_IDENTIFIER - (int) - - - - Identificador NAS - - - - - - RADIUS_PROXY_STATE - (int) - - - - Estado del Proxy - - - - - - RADIUS_LOGIN_LAT_SERVICE - (int) - - - - Servicio de identificación LAT - - - - - - RADIUS_LOGIN_LAT_NODE - (int) - - - - Nodo de identificación LAT - - - - - - RADIUS_LOGIN_LAT_GROUP - (int) - - - - Grupo de identificación LAT - - - - - - RADIUS_FRAMED_APPLETALK_LINK - (int) - - - - Enlace framé Appletalk - - - - - - RADIUS_FRAMED_APPLETALK_NETWORK - (int) - - - - Red framé Appletalk - - - - - - RADIUS_FRAMED_APPLETALK_ZONE - (int) - - - - Zona framé Appletalk - - - - - - RADIUS_CHAP_CHALLENGE - (int) - - - - Desafío - - - - - - RADIUS_NAS_PORT_TYPE - (int) - - - - Tipo de puerto NAS: - - RADIUS_ASYNC - RADIUS_SYNC - RADIUS_ISDN_SYNC - RADIUS_ISDN_ASYNC_V120 - RADIUS_ISDN_ASYNC_V110 - RADIUS_VIRTUAL - RADIUS_PIAFS - RADIUS_HDLC_CLEAR_CHANNEL - RADIUS_X_25 - RADIUS_X_75 - RADIUS_G_3_FAX - RADIUS_SDSL - RADIUS_ADSL_CAP - RADIUS_ADSL_DMT - RADIUS_IDSL - RADIUS_ETHERNET - RADIUS_XDSL - RADIUS_CABLE - RADIUS_WIRELESS_OTHER - RADIUS_WIRELESS_IEEE_802_11 - - - - - - - RADIUS_PORT_LIMIT - (int) - - - - Límite del puerto - - - - - - RADIUS_LOGIN_LAT_PORT - (int) - - - - Puerto de identificación LAT - - - - - - RADIUS_CONNECT_INFO - (int) - - - - Información de conexión - - - - - - RADIUS_ACCT_STATUS_TYPE - (int) - - - - Tipo de estado de la cuenta: - - RADIUS_START - RADIUS_STOP - RADIUS_ACCOUNTING_ON - RADIUS_ACCOUNTING_OFF - - - - - - - RADIUS_ACCT_DELAY_TIME - (int) - - - - Tiempo de espera máximo de identificación - - - - - - RADIUS_ACCT_INPUT_OCTETS - (int) - - - - Octetos de entrada de identificación - - - - - - RADIUS_ACCT_OUTPUT_OCTETS - (int) - - - - Octetos de salida de identificación - - - - - - RADIUS_ACCT_SESSION_ID - (int) - - - - Identificador de sesión de identificación - - - - - - RADIUS_ACCT_AUTHENTIC - (int) - - - - Identificación auténtica, uno entre: - - RADIUS_AUTH_RADIUS - RADIUS_AUTH_LOCAL - RADIUS_AUTH_REMOTE - - - - - - - RADIUS_ACCT_SESSION_TIME - (int) - - - - Duración de la sesión de identificación - - - - - - RADIUS_ACCT_INPUT_PACKETS - (int) - - - - Paquetes de entrada de identificación - - - - - - RADIUS_ACCT_OUTPUT_PACKETS - (int) - - - - Paquetes de salida de identificación - - - - - - RADIUS_ACCT_TERMINATE_CAUSE - (int) - - - - Causa de la finalización de la identificación, uno entre: - - RADIUS_TERM_USER_REQUEST - RADIUS_TERM_LOST_CARRIER - RADIUS_TERM_LOST_SERVICE - RADIUS_TERM_IDLE_TIMEOUT - RADIUS_TERM_SESSION_TIMEOUT - RADIUS_TERM_ADMIN_RESET - RADIUS_TERM_ADMIN_REBOOT - RADIUS_TERM_PORT_ERROR - RADIUS_TERM_NAS_ERROR - RADIUS_TERM_NAS_REQUEST - RADIUS_TERM_NAS_REBOOT - RADIUS_TERM_PORT_UNNEEDED - RADIUS_TERM_PORT_PREEMPTED - RADIUS_TERM_PORT_SUSPENDED - RADIUS_TERM_SERVICE_UNAVAILABLE - RADIUS_TERM_CALLBACK - RADIUS_TERM_USER_ERROR - RADIUS_TERM_HOST_REQUEST - - - - - - - RADIUS_ACCT_MULTI_SESSION_ID - (int) - - - - Identificador de una sesión múltiple de identificación - - - - - - RADIUS_ACCT_LINK_COUNT - (int) - - - - Número de enlaces de identificación - - - - - - Constantes de tipo de servicio - - - RADIUS_LOGIN - - - - - - - - - RADIUS_FRAMED - - - - - - - - - RADIUS_CALLBACK_LOGIN - - - - - - - - - RADIUS_CALLBACK_FRAMED - - - - - - - - - RADIUS_OUTBOUND - - - - - - - - - RADIUS_ADMINISTRATIVE - - - - - - - - - RADIUS_NAS_PROMPT - - - - - - - - - RADIUS_AUTHENTICATE_ONLY - - - - - - - - - RADIUS_CALLBACK_NAS_PROMPT - - - - - - - - - - Constantes de Framed-Protocol - - - RADIUS_PPP - - - - - - - - - RADIUS_SLIP - - - - - - - - - RADIUS_ARAP - - - - - - - - - RADIUS_GANDALF - - - - - - - - - RADIUS_XYLOGICS - - - - - - - - - - Constantes de Framed-Compression - - - RADIUS_COMP_NONE - - - - - - - - - RADIUS_COMP_VJ - - - - - - - - - RADIUS_COMP_IPXHDR - - - - - - - - - RADIUS_COMP_STAC_LZS - - - - - - - - - - Constantes de tipo de puerto NAS - - - RADIUS_ASYNC - - - - - - - - - RADIUS_SYNC - - - - - - - - - RADIUS_ISDN_SYNC - - - - - - - - - RADIUS_ISDN_ASYNC_V120 - - - - - - - - - RADIUS_ISDN_ASYNC_V110 - - - - - - - - - RADIUS_VIRTUAL - - - - - - - - - RADIUS_PIAFS - - - - - - - - - RADIUS_HDLC_CLEAR_CHANNEL - - - - - - - - - RADIUS_X_25 - - - - - - - - - RADIUS_X_75 - - - - - - - - - RADIUS_G_3_FAX - - - - - - - - - RADIUS_SDSL - - - - - - - - - RADIUS_ADSL_CAP - - - - - - - - - RADIUS_ADSL_DMT - - - - - - - - - RADIUS_IDSL - - - - - - - - - RADIUS_ETHERNET - - - - - - - - - RADIUS_XDSL - - - - - - - - - RADIUS_CABLE - - - - - - - - - RADIUS_WIRELESS_OTHER - - - - - - - - - RADIUS_WIRELESS_IEEE_802_11 - - - - - - - - - - Constantes de tipo de estado de contabilidad - - - RADIUS_START - - - - - - - - - RADIUS_STOP - - - - - - - - - RADIUS_ACCOUNTING_ON - - - - - - - - - RADIUS_ACCOUNTING_OFF - - - - - - - - - - Constantes de autenticación de contabilidad - - - RADIUS_AUTH_RADIUS - - - - - - - - - RADIUS_AUTH_LOCAL - - - - - - - - - RADIUS_AUTH_REMOTE - - - - - - - - - - Constantes de causa de terminación de contabilidad - - - RADIUS_TERM_USER_REQUEST - - - - - - - - - RADIUS_TERM_LOST_CARRIER - - - - - - - - - RADIUS_TERM_LOST_SERVICE - - - - - - - - - RADIUS_TERM_IDLE_TIMEOUT - - - - - - - - - RADIUS_TERM_SESSION_TIMEOUT - - - - - - - - - RADIUS_TERM_ADMIN_RESET - - - - - - - - - RADIUS_TERM_ADMIN_REBOOT - - - - - - - - - RADIUS_TERM_PORT_ERROR - - - - - - - - - RADIUS_TERM_NAS_ERROR - - - - - - - - - RADIUS_TERM_NAS_REQUEST - - - - - - - - - RADIUS_TERM_NAS_REBOOT - - - - - - - - - RADIUS_TERM_PORT_UNNEEDED - - - - - - - - - RADIUS_TERM_PORT_PREEMPTED - - - - - - - - - RADIUS_TERM_PORT_SUSPENDED - - - - - - - - - RADIUS_TERM_SERVICE_UNAVAILABLE - - - - - - - - - RADIUS_TERM_CALLBACK - - - - - - - - - RADIUS_TERM_USER_ERROR - - - - - - - - - RADIUS_TERM_HOST_REQUEST - - - - - - - - - RADIUS_MICROSOFT_MS_CHAP_RESPONSE - - - - - - - - - RADIUS_MICROSOFT_MS_CHAP_ERROR - - - - - - - - - RADIUS_MICROSOFT_MS_CHAP_PW_1 - - - - - - - - - RADIUS_MICROSOFT_MS_CHAP_PW_2 - - - - - - - - - RADIUS_MICROSOFT_MS_CHAP_LM_ENC_PW - - - - - - - - - RADIUS_MICROSOFT_MS_CHAP_NT_ENC_PW - - - - - - - - - RADIUS_MICROSOFT_MS_MPPE_ENCRYPTION_POLICY - - - - - - - - - RADIUS_MICROSOFT_MS_MPPE_ENCRYPTION_TYPES - - - - - - - - - RADIUS_MICROSOFT_MS_RAS_VENDOR - - - - - - - - - RADIUS_MICROSOFT_MS_CHAP_DOMAIN - - - - - - - - - RADIUS_MICROSOFT_MS_CHAP_CHALLENGE - - - - - - - - - RADIUS_MICROSOFT_MS_CHAP_MPPE_KEYS - - - - - - - - - RADIUS_MICROSOFT_MS_BAP_USAGE - - - - - - - - - RADIUS_MICROSOFT_MS_LINK_UTILIZATION_THRESHOLD - - - - - - - - - RADIUS_MICROSOFT_MS_LINK_DROP_TIME_LIMIT - - - - - - - - - RADIUS_MICROSOFT_MS_MPPE_SEND_KEY - - - - - - - - - RADIUS_MICROSOFT_MS_MPPE_RECV_KEY - - - - - - - - - RADIUS_MICROSOFT_MS_RAS_VERSION - - - - - - - - - RADIUS_MICROSOFT_MS_OLD_ARAP_PASSWORD - - - - - - - - - RADIUS_MICROSOFT_MS_NEW_ARAP_PASSWORD - - - - - - - - - RADIUS_MICROSOFT_MS_ARAP_PASSWORD_CHANGE_REASON - - - - - - - - - RADIUS_MICROSOFT_MS_FILTER - - - - - - - - - RADIUS_MICROSOFT_MS_ACCT_AUTH_TYPE - - - - - - - - - RADIUS_MICROSOFT_MS_ACCT_EAP_TYPE - - - - - - - - - RADIUS_MICROSOFT_MS_CHAP2_RESPONSE - - - - - - - - - RADIUS_MICROSOFT_MS_CHAP2_SUCCESS - - - - - - - - - RADIUS_MICROSOFT_MS_CHAP2_PW - - - - - - - - - RADIUS_MICROSOFT_MS_PRIMARY_DNS_SERVER - - - - - - - - - RADIUS_MICROSOFT_MS_SECONDARY_DNS_SERVER - - - - - - - - - RADIUS_MICROSOFT_MS_PRIMARY_NBNS_SERVER - - - - - - - - - RADIUS_MICROSOFT_MS_SECONDARY_NBNS_SERVER - - - - - - - - - RADIUS_MICROSOFT_MS_ARAP_CHALLENGE - - - - - - - -
    - -
    - Tipos de atributo RADIUS específicos del vendedor - - - - - RADIUS_VENDOR_MICROSOFT - (int) - - - - Atributos específicos de Microsoft (RFC 2548): - - RADIUS_MICROSOFT_MS_CHAP_RESPONSE - RADIUS_MICROSOFT_MS_CHAP_ERROR - RADIUS_MICROSOFT_MS_CHAP_PW_1 - RADIUS_MICROSOFT_MS_CHAP_PW_2 - RADIUS_MICROSOFT_MS_CHAP_LM_ENC_PW - RADIUS_MICROSOFT_MS_CHAP_NT_ENC_PW - RADIUS_MICROSOFT_MS_MPPE_ENCRYPTION_POLICY - RADIUS_MICROSOFT_MS_MPPE_ENCRYPTION_TYPES - RADIUS_MICROSOFT_MS_RAS_VENDOR - RADIUS_MICROSOFT_MS_CHAP_DOMAIN - RADIUS_MICROSOFT_MS_CHAP_CHALLENGE - RADIUS_MICROSOFT_MS_CHAP_MPPE_KEYS - RADIUS_MICROSOFT_MS_BAP_USAGE - RADIUS_MICROSOFT_MS_LINK_UTILIZATION_THRESHOLD - RADIUS_MICROSOFT_MS_LINK_DROP_TIME_LIMIT - RADIUS_MICROSOFT_MS_MPPE_SEND_KEY - RADIUS_MICROSOFT_MS_MPPE_RECV_KEY - RADIUS_MICROSOFT_MS_RAS_VERSION - RADIUS_MICROSOFT_MS_OLD_ARAP_PASSWORD - RADIUS_MICROSOFT_MS_NEW_ARAP_PASSWORD - RADIUS_MICROSOFT_MS_ARAP_PASSWORD_CHANGE_REASON - RADIUS_MICROSOFT_MS_FILTER - RADIUS_MICROSOFT_MS_ACCT_AUTH_TYPE - RADIUS_MICROSOFT_MS_ACCT_EAP_TYPE - RADIUS_MICROSOFT_MS_CHAP2_RESPONSE - RADIUS_MICROSOFT_MS_CHAP2_SUCCESS - RADIUS_MICROSOFT_MS_CHAP2_PW - RADIUS_MICROSOFT_MS_PRIMARY_DNS_SERVER - RADIUS_MICROSOFT_MS_SECONDARY_DNS_SERVER - RADIUS_MICROSOFT_MS_PRIMARY_NBNS_SERVER - RADIUS_MICROSOFT_MS_SECONDARY_NBNS_SERVER - RADIUS_MICROSOFT_MS_ARAP_CHALLENGE - - - - - -
    -
    - diff --git a/reference/radius/examples.xml b/reference/radius/examples.xml deleted file mode 100644 index 3568961607..0000000000 --- a/reference/radius/examples.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - &reftitle.examples; - - - ¿Cómo iniciar? - - Obtener un recurso radius - Configurar la librería - Crear la petición - Poner atributos - Enviar la petición - Recibir atributos - Cerrar el recurso radius (opcional) - - También sirve echar un vistazo a los ejemplos en este paquete. - - - El paquete contiene un ejemplo de script php. Este script demuestra como - autenticar con radius utilizando PAP o CHAP (md5). Si se autentica con - servidores Microsoft Radius entonces no le será posible utilizar CHAP (md5). Si - quisiera autenticarse con servidores Microsoft tiene que utilizar - MS-CHAPv1 o MS-CHAPv2, pero es más complicado, porque usted necesita md4, - sha1 y des para generar los datos correctos. Los ejemplos adjuntos demuestran - todos los métodos de autenticación, incluyendo MS-CHAPv1 y MS-CHAPv2. Para tener - funcionando MS-CHAP necesita las extensiones mcrypt y - mhash iniciando con la - version 1.2 de este paquete, la extensión mcrypt ya no es necesaria. - - - diff --git a/reference/radius/functions/radius-acct-open.xml b/reference/radius/functions/radius-acct-open.xml deleted file mode 100644 index aecfb6e848..0000000000 --- a/reference/radius/functions/radius-acct-open.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - radius_acct_open - Crea un manejador Radius para el conteo - - - - &reftitle.description; - - resourceradius_acct_open - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un manejador en caso de tener éxito, &false; en caso de error. Esta función falla solamente si - hay insuficiencia de memoria. - - - - - &reftitle.examples; - - <function>radius_acct_open</function> example - - -]]> - - - - - diff --git a/reference/radius/functions/radius-add-server.xml b/reference/radius/functions/radius-add-server.xml deleted file mode 100644 index 6c3c31eb40..0000000000 --- a/reference/radius/functions/radius-add-server.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - - radius_add_server - Añade un servidor - - - - &reftitle.description; - - boolradius_add_server - resourceradius_handle - stringhostname - intport - stringsecret - inttimeout - intmax_tries - - - radius_add_server puede ser utilizado varias veces, y puede ser - utilizado junto con la función radius_config. - Como máximo, pueden especificarse 10 servidores. Cuando se proporcionan varios servidores, - se intentan de forma round-robin hasta que se recibe una respuesta válida, - o hasta que se alcanza el límite max_tries de cada servidor. - - - - - &reftitle.parameters; - - - radius_handle - - - - - - - hostname - - - El argumento hostname especifica el host servidor, - ya sea como nombre de dominio completo o como dirección IP. - - - - - port - - - El port especifica el puerto UDP al que - conectar en el servidor. Si el puerto dado es 0, la biblioteca - buscará el servicio radius/udp o - radacct/udp - en la base de datos de servicios de red y utilizará el puerto - encontrado. Si no se encuentra ninguna entrada, la biblioteca utilizará los puertos - Radius estándar, 1812 para la autenticación y 1813 para las cuentas. - - - - - secret - - - El secreto compartido para el host servidor se pasa al argumento - secret. El protocolo Radius ignora - todo excepto los primeros 128 bytes del secreto compartido. - - - - - timeout - - - El tiempo límite para recibir respuestas del servidor se pasa al - argumento timeout, en segundos. - - - - - max_tries - - - El número máximo de solicitudes repetidas a realizar antes de fallar. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>radius_add_server</function> - -"; - exit; -} -?> -]]> - - - - - - &reftitle.seealso; - - radius_config - - - - diff --git a/reference/radius/functions/radius-auth-open.xml b/reference/radius/functions/radius-auth-open.xml deleted file mode 100644 index 101057e3a3..0000000000 --- a/reference/radius/functions/radius-auth-open.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - radius_auth_open - Crea un identificador de Radius para la autenticación - - - - &reftitle.description; - - resourceradius_auth_open - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un manejador en caso de éxito, &false; en caso de error. Esta función sólo falla si hay - insuficiente memoria disponible. - - - - - &reftitle.examples; - - Ejemplo de <function>radius_auth_open</function> - - -]]> - - - - - diff --git a/reference/radius/functions/radius-close.xml b/reference/radius/functions/radius-close.xml deleted file mode 100644 index 92aceedec4..0000000000 --- a/reference/radius/functions/radius-close.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - radius_close - Libera todos los recursos - - - - &reftitle.description; - - boolradius_close - resourceradius_handle - - - No es necesario llamar a esta función debido a que php libera todos los recursos - al final de cada petición. - - - - - &reftitle.parameters; - - &radius.parameter.handle; - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/radius/functions/radius-config.xml b/reference/radius/functions/radius-config.xml deleted file mode 100644 index a58374e2db..0000000000 --- a/reference/radius/functions/radius-config.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - radius_config - Solicita a la biblioteca que lea un archivo de configuración dado - - - - &reftitle.description; - - boolradius_config - resourceradius_handle - stringfile - - - Antes de cualquier petición Radius, la biblioteca debe conocer el servidor a contactar. - La manera sencilla de configurar la biblioteca es llamar a la función - radius_config. radius_config - solicita a la biblioteca que lea un archivo de configuración cuyo formato - se describe en la página radius.conf. - - - - - &reftitle.parameters; - - - radius_handle - - - - - - - - file - - - La ruta hacia el archivo de configuración se pasa como - argumento a la función radius_config. - La biblioteca puede ser configurada también llamando a la - función radius_add_server. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - radius_add_server - - - - diff --git a/reference/radius/functions/radius-create-request.xml b/reference/radius/functions/radius-create-request.xml deleted file mode 100644 index d9f789a33e..0000000000 --- a/reference/radius/functions/radius-create-request.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - radius_create_request - Crea una solicitud de cuenta o de identificación - - - - &reftitle.description; - - boolradius_create_request - resourceradius_handle - inttype - - - Una solicitud Radius consiste en código que especifica una solicitud concreta, - así como cero o varios atributos que proporcionan información adicional. - Para comenzar a construir una nueva solicitud, llámese a la función - radius_create_request. - - - - Advertencia: Debe llamarse a esta función antes de pasar cualquier argumento. - - - - - - &reftitle.parameters; - - - radius_handle - - - - - - - type - - - El tipo es RADIUS_ACCESS_REQUEST o - RADIUS_ACCOUNTING_REQUEST. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>radius_create_request</function> - -"; - exit; -} -?> -]]> - - - - - - &reftitle.seealso; - - radius_send_request - - - - diff --git a/reference/radius/functions/radius-cvt-addr.xml b/reference/radius/functions/radius-cvt-addr.xml deleted file mode 100644 index e00e50c2a9..0000000000 --- a/reference/radius/functions/radius-cvt-addr.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - radius_cvt_addr - Convierte datos brutos en dirección IP - - - - &reftitle.description; - - stringradius_cvt_addr - stringdata - - - Convierte datos brutos en dirección IP - - - - - &reftitle.parameters; - - - data - - - Datos de entrada - - - - - - - - &reftitle.returnvalues; - - Devuelve la dirección IP. - - - - - &reftitle.examples; - - Ejemplo con <function>radius_cvt_addr</function> - -\n"; - break; - - case RADIUS_FRAMED_IP_NETMASK: - $mask = radius_cvt_addr($data); - echo "MÁSCARA: $mask
    \n"; - break; - } -} -?> -]]> -
    -
    -
    - - - &reftitle.seealso; - - radius_cvt_int - radius_cvt_string - - -
    - diff --git a/reference/radius/functions/radius-cvt-int.xml b/reference/radius/functions/radius-cvt-int.xml deleted file mode 100644 index e5b391b8fe..0000000000 --- a/reference/radius/functions/radius-cvt-int.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - radius_cvt_int - Convierte datos brutos en entero - - - - &reftitle.description; - - intradius_cvt_int - stringdata - - - Convierte datos brutos en entero - - - - - &reftitle.parameters; - - - data - - - Datos de entrada. - - - - - - - - &reftitle.returnvalues; - - Devuelve el entero, recuperado desde los datos. - - - - - &reftitle.examples; - - Ejemplo con <function>radius_cvt_int</function> - -\n"; - break; - } -} -?> -]]> - - - - - - &reftitle.seealso; - - radius_cvt_addr - radius_cvt_string - - - - diff --git a/reference/radius/functions/radius-cvt-string.xml b/reference/radius/functions/radius-cvt-string.xml deleted file mode 100644 index 44a62a7719..0000000000 --- a/reference/radius/functions/radius-cvt-string.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - radius_cvt_string - Convierte datos brutos en string - - - - &reftitle.description; - - stringradius_cvt_string - stringdata - - - Convierte datos brutos en string - - - - - &reftitle.parameters; - - - data - - - Datos de entrada - - - - - - - - &reftitle.returnvalues; - - Devuelve el string, recuperado desde los datos. - - - - - &reftitle.examples; - - Ejemplo con <function>radius_cvt_string</function> - -\n"; - break; - } -} -?> -]]> - - - - - - &reftitle.seealso; - - radius_cvt_addr - radius_cvt_int - - - - diff --git a/reference/radius/functions/radius-demangle-mppe-key.xml b/reference/radius/functions/radius-demangle-mppe-key.xml deleted file mode 100644 index 8abc6922fb..0000000000 --- a/reference/radius/functions/radius-demangle-mppe-key.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - radius_demangle_mppe_key - Deriva las claves mppe desde datos - - - - &reftitle.description; - - stringradius_demangle_mppe_key - resourceradius_handle - stringmangled - - - Al utilizar MPPE con MS-CHAPv2, las claves recibidas y enviadas - son "secadas" (ver la RFC 2548), - sin embargo, esta función es útil, ya que no se sabe si existe o no una - implementación de PPTP-MPPE en PHP. - - - - - &reftitle.parameters; - - &radius.parameter.handle; - - mangled - - - Los datos deformados a descifrar - - - - - - - - &reftitle.returnvalues; - - Devuelve el string o &false; si ocurre un error. - - - - diff --git a/reference/radius/functions/radius-demangle.xml b/reference/radius/functions/radius-demangle.xml deleted file mode 100644 index 2f1755d92a..0000000000 --- a/reference/radius/functions/radius-demangle.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - radius_demangle - Deshidrata datos - - - - &reftitle.description; - - stringradius_demangle - resourceradius_handle - stringmangled - - - Algunos datos (contraseñas, claves MS-CHAPv1 MPPE) son "deshidratados" por - razones de seguridad y deben ser "deshidratados" antes de poder utilizarlos. - - - - - &reftitle.parameters; - - &radius.parameter.handle; - - mangled - - - Los datos deformados a descifrar - - - - - - - - &reftitle.returnvalues; - - Devuelve la cadena "deshidratada" o &false; si ocurre un error. - - - - diff --git a/reference/radius/functions/radius-get-attr.xml b/reference/radius/functions/radius-get-attr.xml deleted file mode 100644 index 31f00c2f8f..0000000000 --- a/reference/radius/functions/radius-get-attr.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - radius_get_attr - Extrae un atributo - - - - &reftitle.description; - - mixedradius_get_attr - resourceradius_handle - - - Al igual que las solicitudes Radius, cada respuesta debe contener cero o varios atributos. - Tras recibir una respuesta con éxito mediante la función - radius_send_request, estos atributos pueden ser - extraídos uno a uno utilizando la función radius_get_attr. - En cada llamada a radius_get_attr, se recupera el siguiente atributo - desde la respuesta actual. - - - - - &reftitle.parameters; - - &radius.parameter.handle; - - - - - &reftitle.returnvalues; - - Devuelve un array asociativo que contiene el tipo de atributo junto con los datos - o un número de error <= 0. - - - - - &reftitle.examples; - - Ejemplo con <function>radius_get_attr</function> - - -]]> - - - - - - &reftitle.seealso; - - radius_put_attr - radius_get_vendor_attr - radius_put_vendor_attr - radius_send_request - - - - diff --git a/reference/radius/functions/radius-get-tagged-attr-data.xml b/reference/radius/functions/radius-get-tagged-attr-data.xml deleted file mode 100644 index 0a16d3a72c..0000000000 --- a/reference/radius/functions/radius-get-tagged-attr-data.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - radius_get_tagged_attr_data - Extrae los datos de un atributo - - - - &reftitle.description; - - stringfalseradius_get_tagged_attr_data - stringdata - - - Si un atributo que contiene un tag ha sido devuelto por la - función radius_get_attr, - radius_get_tagged_attr_data devuelve los - datos desde este atributo. - - - - - &reftitle.parameters; - - - data - - - El atributo que contiene un tag a decodificar. - - - - - - - - &reftitle.returnvalues; - - Devuelve los datos del atributo&return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo con <function>radius_get_tagged_attr_data</function> - - -]]> - - - - - - &reftitle.seealso; - - radius_get_attr - radius_get_tagged_attr_tag - - - - diff --git a/reference/radius/functions/radius-get-tagged-attr-tag.xml b/reference/radius/functions/radius-get-tagged-attr-tag.xml deleted file mode 100644 index 31b26acb0f..0000000000 --- a/reference/radius/functions/radius-get-tagged-attr-tag.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - radius_get_tagged_attr_tag - Extrae la etiqueta desde un atributo - - - - &reftitle.description; - - intfalseradius_get_tagged_attr_tag - stringdata - - - Si un atributo que contiene una etiqueta ha sido devuelto por la función - radius_get_attr, - radius_get_tagged_attr_data va devolver la etiqueta - desde el atributo. - - - - - &reftitle.parameters; - - - data - - - El atributo a decodificar. - - - - - - - - &reftitle.returnvalues; - - Devuelve la etiqueta desde el atributo &return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo con <function>radius_get_tagged_attr_tag</function> - - -]]> - - - - - - &reftitle.seealso; - - radius_get_attr - radius_get_tagged_attr_data - - - - diff --git a/reference/radius/functions/radius-get-vendor-attr.xml b/reference/radius/functions/radius-get-vendor-attr.xml deleted file mode 100644 index ffc922bb5e..0000000000 --- a/reference/radius/functions/radius-get-vendor-attr.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - radius_get_vendor_attr - Extrae un atributo específico del proveedor - - - - &reftitle.description; - - arrayfalseradius_get_vendor_attr - stringdata - - - Si radius_get_attr devuelve - RADIUS_VENDOR_SPECIFIC, - radius_get_vendor_attr puede ser llamado para - determinar el proveedor. - - - - - &reftitle.parameters; - - - data - - - Datos de entrada. - - - - - - - - &reftitle.returnvalues; - - Devuelve un array asociativo que contiene el tipo de atributo, el proveedor así - como los datos, o &false; si ocurre un error. - - - - - &reftitle.examples; - - Ejemplo con <function>radius_get_vendor_attr</function> - - -]]> - - - - - - &reftitle.seealso; - - radius_get_attr - radius_put_vendor_attr - - - - diff --git a/reference/radius/functions/radius-put-addr.xml b/reference/radius/functions/radius-put-addr.xml deleted file mode 100644 index a1dc03f090..0000000000 --- a/reference/radius/functions/radius-put-addr.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - radius_put_addr - Adjunta una dirección IP como atributo - - - - &reftitle.description; - - boolradius_put_addr - resourceradius_handle - inttype - stringaddr - intoptions0 - inttag - - - Adjunta una dirección IP a la solicitud RADIUS actual. - - &radius.request.required; - - - - &reftitle.parameters; - - &radius.parameter.handle; - &radius.parameter.attribute-type; - - addr - - - Una dirección IPv4; por ejemplo 10.0.0.1. - - - - &radius.parameter.options; - &radius.parameter.tag; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL radius 1.3.0 - - Los parámetros options y tag - fueron añadidos. - - - - - - - - - diff --git a/reference/radius/functions/radius-put-attr.xml b/reference/radius/functions/radius-put-attr.xml deleted file mode 100644 index 4a189cf860..0000000000 --- a/reference/radius/functions/radius-put-attr.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - - radius_put_attr - Adjunta un atributo binario - - - - &reftitle.description; - - boolradius_put_attr - resourceradius_handle - inttype - stringvalue - intoptions0 - inttag - - - Adjunta un atributo binario a la petición RADIUS actual. - - &radius.request.required; - - - - &reftitle.parameters; - - &radius.parameter.handle; - &radius.parameter.attribute-type; - - value - - - El valor del atributo, que será tratado como un string sin tratar. - - - - &radius.parameter.options; - &radius.parameter.tag; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL radius 1.3.0 - - Los parámetros options y tag - han sido añadidos. - - - - - - - - - &reftitle.examples; - - Ejemplo con <function>radius_put_attr</function> - - "; - exit; -} -?> -]]> - - - - - - &reftitle.seealso; - - radius_get_attr - radius_get_vendor_attr - radius_put_vendor_attr - - - - diff --git a/reference/radius/functions/radius-put-int.xml b/reference/radius/functions/radius-put-int.xml deleted file mode 100644 index b7298c84c3..0000000000 --- a/reference/radius/functions/radius-put-int.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - radius_put_int - Adjunta un atributo entero - - - - &reftitle.description; - - boolradius_put_int - resourceradius_handle - inttype - intvalue - intoptions0 - inttag - - - Adjunta un atributo entero a la petición RADIUS actual. - - &radius.request.required; - - - - &reftitle.parameters; - - &radius.parameter.handle; - &radius.parameter.attribute-type; - - value - - - El valor del atributo. - - - - &radius.parameter.options; - &radius.parameter.tag; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL radius 1.3.0 - - Los parámetros options y tag - han sido añadidos. - - - - - - - - - &reftitle.examples; - - Ejemplo con <function>radius_put_int</function> - -"; - exit; -} -?> -]]> - - - - - - &reftitle.seealso; - - radius_put_string - radius_put_vendor_int - radius_put_vendor_string - - - - diff --git a/reference/radius/functions/radius-put-string.xml b/reference/radius/functions/radius-put-string.xml deleted file mode 100644 index eb02216180..0000000000 --- a/reference/radius/functions/radius-put-string.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - - radius_put_string - Adjunta un atributo de tipo string - - - - &reftitle.description; - - boolradius_put_string - resourceradius_handle - inttype - stringvalue - intoptions0 - inttag - - - Adjunta un atributo en forma de string a la petición RADIUS actual. - Generalmente, la función radius_put_attr es más - útil para esto, ya que es segura a nivel de bits. - - &radius.request.required; - - - - &reftitle.parameters; - - &radius.parameter.handle; - &radius.parameter.attribute-type; - - value - - - El valor del atributo. Este valor es esperado por la biblioteca - subyacente como terminado por &null; ; por lo tanto, este parámetro - no es seguro a nivel de bits. - - - - &radius.parameter.options; - &radius.parameter.tag; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL radius 1.3.0 - - Los parámetros options y tag - fueron añadidos. - - - - - - - - - &reftitle.examples; - - Ejemplo con <function>radius_put_string</function> - -"; - exit; -} -?> -]]> - - - - - - &reftitle.seealso; - - radius_put_int - radius_put_vendor_int - radius_put_vendor_string - - - - diff --git a/reference/radius/functions/radius-put-vendor-addr.xml b/reference/radius/functions/radius-put-vendor-addr.xml deleted file mode 100644 index 0bf1f0a7aa..0000000000 --- a/reference/radius/functions/radius-put-vendor-addr.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - radius_put_vendor_addr - Asocia una dirección IP específica a un proveedor - - - - &reftitle.description; - - boolradius_put_vendor_addr - resourceradius_handle - intvendor - inttype - stringaddr - - - Asocia una dirección IP específica al proveedor para la solicitud RADIUS actual. - - &radius.request.required; - - - - &reftitle.parameters; - - &radius.parameter.handle; - &radius.parameter.vendor; - &radius.parameter.attribute-type; - - addr - - - Una dirección IPv4; por ejemplo 10.0.0.1. - - - - &radius.parameter.options; - &radius.parameter.tag; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL radius 1.3.0 - - Se han añadido los parámetros options y tag. - - - - - - - - - diff --git a/reference/radius/functions/radius-put-vendor-attr.xml b/reference/radius/functions/radius-put-vendor-attr.xml deleted file mode 100644 index 43527f9569..0000000000 --- a/reference/radius/functions/radius-put-vendor-attr.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - radius_put_vendor_attr - Adjunta un atributo binario a un proveedor específico - - - - &reftitle.description; - - boolradius_put_vendor_attr - resourceradius_handle - intvendor - inttype - stringvalue - intoptions0 - inttag - - - Adjunta un atributo binario específico al proveedor para la petición RADIUS actual. - - &radius.request.required; - - - - &reftitle.parameters; - - &radius.parameter.handle; - &radius.parameter.vendor; - &radius.parameter.attribute-type; - - value - - - El valor del atributo, que será tratado como un string sin tratar. - - - - &radius.parameter.options; - &radius.parameter.tag; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL radius 1.3.0 - - Los parámetros options y tag - fueron añadidos. - - - - - - - - - &reftitle.examples; - - Ejemplo con <function>radius_put_vendor_attr</function> - -"; - exit; -} -?> -]]> - - - - - - &reftitle.seealso; - - radius_get_vendor_attr - - - - diff --git a/reference/radius/functions/radius-put-vendor-int.xml b/reference/radius/functions/radius-put-vendor-int.xml deleted file mode 100644 index 2e63ba362f..0000000000 --- a/reference/radius/functions/radius-put-vendor-int.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - radius_put_vendor_int - Adjunta un atributo entero a un proveedor específico - - - - &reftitle.description; - - boolradius_put_vendor_int - resourceradius_handle - intvendor - inttype - intvalue - intoptions0 - inttag - - - Adjunta un atributo específico al proveedor en la petición RADIUS actual. - - - - - &reftitle.parameters; - - &radius.parameter.handle; - &radius.parameter.vendor; - &radius.parameter.attribute-type; - - value - - - El valor del atributo. - - - - &radius.parameter.options; - &radius.parameter.tag; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL radius 1.3.0 - - Se han añadido los argumentos options y tag. - - - - - - - - - &reftitle.seealso; - - radius_put_vendor_string - - - - diff --git a/reference/radius/functions/radius-put-vendor-string.xml b/reference/radius/functions/radius-put-vendor-string.xml deleted file mode 100644 index 029f4da9f9..0000000000 --- a/reference/radius/functions/radius-put-vendor-string.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - radius_put_vendor_string - Adjunta un atributo en forma de string a un vendedor específico - - - - &reftitle.description; - - boolradius_put_vendor_string - resourceradius_handle - intvendor - inttype - stringvalue - intoptions0 - inttag - - - Adjunta un atributo específico al vendedor a la petición actual RADIUS. - En general, radius_put_vendor_attr es una función más - práctica para adjuntar atributos, siendo segura a nivel de bits. - - - - - &reftitle.parameters; - - &radius.parameter.handle; - &radius.parameter.vendor; - &radius.parameter.attribute-type; - - value - - - El valor del atributo. Este valor es esperado por la biblioteca - subyacente como terminado por &null; ; por lo tanto, este parámetro - no es seguro a nivel de bits. - - - - &radius.parameter.options; - &radius.parameter.tag; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL radius 1.3.0 - - Los parámetros options y tag - fueron añadidos. - - - - - - - - - &reftitle.seealso; - - radius_put_vendor_int - - - - diff --git a/reference/radius/functions/radius-request-authenticator.xml b/reference/radius/functions/radius-request-authenticator.xml deleted file mode 100644 index 302eb0174b..0000000000 --- a/reference/radius/functions/radius-request-authenticator.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - radius_request_authenticator - Devuelve el identificador solicitado - - - - &reftitle.description; - - stringradius_request_authenticator - resourceradius_handle - - - El identificador solicitado es necesario para la recuperación de datos - como contraseñas y claves de cifrado. - - - - - &reftitle.parameters; - - &radius.parameter.handle; - - - - - &reftitle.returnvalues; - - Devuelve el identificador solicitado como string o - &false; en caso de error. - - - - - &reftitle.seealso; - - radius_demangle - - - - diff --git a/reference/radius/functions/radius-salt-encrypt-attr.xml b/reference/radius/functions/radius-salt-encrypt-attr.xml deleted file mode 100644 index a8e9990fc5..0000000000 --- a/reference/radius/functions/radius-salt-encrypt-attr.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - radius_salt_encrypt_attr - Cifra un valor utilizando un Salt - - - - &reftitle.description; - - stringfalseradius_salt_encrypt_attr - resourceradius_handle - stringdata - - - Se aplica el algoritmo RADIUS salt al valor proporcionado. - - - Generalmente, esto se realiza automáticamente al proporcionar - la opción RADIUS_OPTION_SALT a la función - que define el atributo, pero esta función puede ser utilizada - si se requiere una construcción de consulta a bajo nivel. - - - - - &reftitle.parameters; - - - data - - - Los datos a cifrar con un salt. - - - - - - - - &reftitle.returnvalues; - - Devuelve los datos cifrados utilizando un salt - &return.falseforfailure;. - - - - - &reftitle.seealso; - - radius_put_addr - radius_put_attr - radius_put_int - radius_put_string - - - - diff --git a/reference/radius/functions/radius-send-request.xml b/reference/radius/functions/radius-send-request.xml deleted file mode 100644 index 2137d7e3aa..0000000000 --- a/reference/radius/functions/radius-send-request.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - radius_send_request - Envía una solicitud y espera una respuesta - - - - &reftitle.description; - - intradius_send_request - resourceradius_handle - - - Una vez que se ha construido una solicitud Radius, esta es enviada mediante - la función radius_send_request. - - - La función radius_send_request envía la solicitud - y espera una respuesta válida, intentando de nuevo, según el método - round-robin siempre que sea necesario. - - - - - &reftitle.parameters; - - &radius.parameter.handle; - - - - - &reftitle.returnvalues; - - Si se recibe una respuesta válida, radius_send_request - devuelve el código Radius que especifica el tipo de respuesta. Esto es, típicamente, - RADIUS_ACCESS_ACCEPT, - RADIUS_ACCESS_REJECT o - RADIUS_ACCESS_CHALLENGE. Si no se recibe - ninguna respuesta válida, radius_send_request devolverá &false;. - - - - - &reftitle.seealso; - - radius_create_request - - - - diff --git a/reference/radius/functions/radius-server-secret.xml b/reference/radius/functions/radius-server-secret.xml deleted file mode 100644 index ebdf6a4ca5..0000000000 --- a/reference/radius/functions/radius-server-secret.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - radius_server_secret - Devuelve el secreto compartido - - - - &reftitle.description; - - stringradius_server_secret - resourceradius_handle - - - El secreto compartido es necesario para el restablecimiento de los datos - como las contraseñas y las claves de cifrado. - - - - - &reftitle.parameters; - - &radius.parameter.handle; - - - - - &reftitle.returnvalues; - - Devuelve el secreto compartido del servidor como un string - o &false; en caso de error. - - - - diff --git a/reference/radius/functions/radius-strerror.xml b/reference/radius/functions/radius-strerror.xml deleted file mode 100644 index 7bd2e5fecd..0000000000 --- a/reference/radius/functions/radius-strerror.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - radius_strerror - Devuelve un mensaje de error - - - - &reftitle.description; - - stringradius_strerror - resourceradius_handle - - - Si las funciones radio fallan entonces guardan un mensaje de error. Este mensaje de error - puede ser obtenido con esta función. - - - - - &reftitle.parameters; - - &radius.parameter.handle; - - - - - &reftitle.returnvalues; - - Devuelve mensajes de error como string de funciones radio fallidas. - - - - diff --git a/reference/radius/reference.xml b/reference/radius/reference.xml deleted file mode 100644 index b324281792..0000000000 --- a/reference/radius/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - - - &Functions; Radius - - &reference.radius.entities.functions; - - - diff --git a/reference/radius/setup.xml b/reference/radius/setup.xml deleted file mode 100644 index 4dc04c496a..0000000000 --- a/reference/radius/setup.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - - - - - &reftitle.setup; - - - &reference.radius.configure; - - - - - diff --git a/reference/rar/book.xml b/reference/rar/book.xml deleted file mode 100644 index 91c7beb11d..0000000000 --- a/reference/rar/book.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - Archivos Rar - Rar - - - - &reftitle.intro; - - Rar es un potente y eficaz archivador creado por Eugene Roshal. - Esta extensión proporciona la posibilidad de leer archivos Rar, pero - no soporta la escritura de los mismos, ya que no es compatible con - la biblioteca UnRar y está directamente prohibido por su licencia. - - - Se puede encontrar más información sobre Rar y UnRar en &url.rar;. - - - - - &reference.rar.setup; - &reference.rar.constants; - &reference.rar.examples; - &reference.rar.reference; - &reference.rar.rararchive; - &reference.rar.rarentry; - &reference.rar.rarexception; - - - diff --git a/reference/rar/constants.xml b/reference/rar/constants.xml deleted file mode 100644 index 5072c1d2fd..0000000000 --- a/reference/rar/constants.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - &reftitle.constants; - &extension.constants; - - - - RAR_HOST_MSDOS - (int) - - - - Use RarEntry::HOST_MSDOS en su lugar. - - - - - - RAR_HOST_OS2 - (int) - - - - Use RarEntry::HOST_OS2 en su lugar. - - - - - - RAR_HOST_WIN32 - (int) - - - - Use RarEntry::HOST_WIN32 en su lugar. - - - - - - RAR_HOST_UNIX - (int) - - - - Use RarEntry::HOST_UNIX en su lugar. - - - - - - RAR_HOST_BEOS - (int) - - - - Use RarEntry::HOST_BEOS en su lugar. - - - - - - - - diff --git a/reference/rar/examples.xml b/reference/rar/examples.xml deleted file mode 100644 index 67c6662e8d..0000000000 --- a/reference/rar/examples.xml +++ /dev/null @@ -1,171 +0,0 @@ - - - - - &reftitle.examples; - - - Ver también rar://. - - - - Descompresión "al vuelo" - -getEntries(); -if ($entries === FALSE) - die("Cannot retrieve entries"); - -if (!array_key_exists($index, $entries)) - die("No such index: $index"); - -$orfilename = $entries[$index]->getName(); //UTF-8 encoded - -$filesize = $entries[$index]->getUnpackedSize(); - -/* you could check HTTP_IF_MODIFIED_SINCE here and compare with - * $entries[$index]->getFileTime(). You could also send a - * "Last modified" header */ - -$fp = $entries[$index]->getStream(); -if ($fp === FALSE) - die("Cannot open file with index $index insided the archive."); - -$arch->close(); //no longer needed; stream is independent - -function detectUserAgent() { - if (!array_key_exists('HTTP_USER_AGENT', $_SERVER)) - return "Other"; - - $uas = $_SERVER['HTTP_USER_AGENT']; - if (preg_match("@Opera/@", $uas)) - return "Opera"; - if (preg_match("@Firefox/@", $uas)) - return "Firefox"; - if (preg_match("@Chrome/@", $uas)) - return "Chrome"; - if (preg_match("@MSIE ([0-9.]+);@", $uas, $matches)) { - if (((float) $matches[1]) >= 7.0) - return "IE"; - } - - return "Other"; -} - -/* - * We have 3 options: - * - For FF and Opera, which support RFC 2231, use that format. - * - For IE and Chrome, use attwithfnrawpctenclong - * (http://greenbytes.de/tech/tc2231/#attwithfnrawpctenclong) - * - For the others, convert to ISO-8859-1, if possible - */ -$formatRFC2231 = 'Content-Disposition: attachment; filename*=UTF-8\'\'%s'; -$formatDef = 'Content-Disposition: attachment; filename="%s"'; - -switch (detectUserAgent()) { - case "Opera": - case "Firefox": - $orfilename = rawurlencode($orfilename); - $format = $formatRFC2231; - break; - - case "IE": - case "Chrome": - $orfilename = rawurlencode($orfilename); - $format = $formatDef; - break; - default: - if (function_exists('iconv')) - $orfilename = - @iconv("UTF-8", "ISO-8859-1//TRANSLIT", $orfilename); - $format = $formatDef; -} - -header(sprintf($format, $orfilename)); -//cannot send error messages from now on (headers already sent) - -//replace by real content type, perhaps infering from the file extension -$contentType = "application/octet-stream"; -header("Content-Type: $contentType"); - -header("Content-Transfer-Encoding: binary"); - -header("Content-Length: $filesize"); - -if ($_SERVER['REQUEST_METHOD'] == "HEAD") - die(); - -while (!feof($fp)) { - $s = @fread($fp, 8192); - if ($s === false) - break; //useless to send error messages - - echo $s; -} -?> -]]> - - - - En este ejemplo se obtiene el archivo que contiene el archivo RAR y se ofrece para descargar. - - - - Ejemplo de sistema de extracción de archivos Rar - -getName() . "\n"; - echo 'Packed size: ' . $entry->getPackedSize() . "\n"; - echo 'Unpacked size: ' . $entry->getUnpackedSize() . "\n"; - - $entry->extract('/dir/extract/to/'); -} - -rar_close($rar_file); - -?> -]]> - - - - Este ejemplo extrae cada archivo del archivo Rar en el directorio especificado. - - - - diff --git a/reference/rar/functions/rar-wrapper-cache-stats.xml b/reference/rar/functions/rar-wrapper-cache-stats.xml deleted file mode 100644 index 678b0472af..0000000000 --- a/reference/rar/functions/rar-wrapper-cache-stats.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - rar_wrapper_cache_stats - Caché de aciertos y errores del URL wrapper - - - - &reftitle.description; - - stringrar_wrapper_cache_stats - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/rar/rararchive.xml b/reference/rar/rararchive.xml deleted file mode 100644 index 6c4c9debfb..0000000000 --- a/reference/rar/rararchive.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - La clase RarArchive - RarArchive - - - - -
    - &reftitle.intro; - - Esta clase representa un archivo RAR que puede estar formado por varios volúmenes (partes) y que contiene - una serie de entradas RAR (por ejemplo: archivos, directorios y otros objetos especiales, como enlaces simbólicos). - - - Los objetos de esta clase puede ser atravesado, dando las entradas almacenadas en el archivo RAR respectivamente. - Estas entradas también pueden ser obtenidas mediante RarArchive::getEntry y - RarArchive::getEntries. - -
    - - -
    - &reftitle.classsynopsis; - - - - RarArchive - - - - - final - RarArchive - - - - Traversable - - - - - &Methods; - - - - -
    - -
    - - &reference.rar.entities.rararchive; - -
    - diff --git a/reference/rar/rararchive/close.xml b/reference/rar/rararchive/close.xml deleted file mode 100644 index 13e6c20c3f..0000000000 --- a/reference/rar/rararchive/close.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - - RarArchive::close - rar_close - Cerrar archivo RAR y liberar todos los recursos - - - - &reftitle.description; - &style.oop; (método): - - public boolRarArchive::close - - - &style.procedural;: - - boolrar_close - RarArchiverarfile - - - Cerar archivo RAR y liberar todos los recursos asignados. - - - - - &reftitle.parameters; - - - rarfile - - - Un objeto RarArchive, abierto con rar_open. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL rar 2.0.0 - - Las entradas RAR devueltas por RarArchive::getEntry - y RarArchive::getEntries son ahora invalidadas cuando - se llama a este método. Esto significa que todos los métodos de instancia llamados por - tales entradas y no garantizan el éxito. - - - - - - - - - &reftitle.examples; - - &style.oop; - -close(); -echo $rar_arch."\n"; -?> -]]> - - &example.outputs.similar; - - - - - - &style.procedural; - - -]]> - - - - - - - diff --git a/reference/rar/rararchive/getcomment.xml b/reference/rar/rararchive/getcomment.xml deleted file mode 100644 index c8dc6bd040..0000000000 --- a/reference/rar/rararchive/getcomment.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - - RarArchive::getComment - rar_comment_get - Obtener comentarios de texto desde el archivo RAR - - - - &reftitle.description; - &style.oop; (method): - - public stringRarArchive::getComment - - - &style.procedural;: - - stringrar_comment_get - RarArchiverarfile - - - Obtener (global) comentario almacenado en el archivo RAR. Este puede ser de hasta 64 KiB de longitud. - - - - Esta extensión no es compatible con los comentarios en el nivel de entrada. - - - - - - &reftitle.parameters; - - - rarfile - - - Un objeto RarArchive, abierto con rar_open. - - - - - - - - &reftitle.returnvalues; - - Devuelve el comentario o &null; si no hay ninguno. - - - - RAR no tiene actualmente soporte para comentarios unicode. La codificación de los - resultados de esta función no es especificado, pero esta debe ser probablemente - Windows-1252. - - - - - - &reftitle.examples; - - &style.oop; - -getComment(); -?> -]]> - - &example.outputs.similar; - - - - - - &style.procedural; - - -]]> - - - - - - - diff --git a/reference/rar/rararchive/getentries.xml b/reference/rar/rararchive/getentries.xml deleted file mode 100644 index 67c1af8408..0000000000 --- a/reference/rar/rararchive/getentries.xml +++ /dev/null @@ -1,171 +0,0 @@ - - - - - - - RarArchive::getEntries - rar_list - Obtener la lista completa de entradas del archivo RAR - - - - &reftitle.description; - &style.oop; (método): - - public arrayfalseRarArchive::getEntries - - - &style.procedural;: - - arrayfalserar_list - RarArchiverarfile - - - Obtener la lista de entradas (archivos y directorios) de el archivo RAR. - - - - Si el archivo tiene - entradas con el mismo nombre, este método, junto con RarArchive - foreach iteraciona y otorga un acceso array-like con índices numéricos, - únicos para acceder a todas las entradas (por ejemplo, - RarArchive::getEntry y el - rar:// wrapper son insuficientes). - - - - - - &reftitle.parameters; - - - rarfile - - - Un objeto RarArchive, abierto con rar_open. - - - - - - - - &reftitle.returnvalues; - - rar_list devuelve array de objetos RarEntry - &return.falseforfailure;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL rar 3.0.0 - - Soporte para archivos RAR con nombres entrada repetidos que ya no produce deficiencias. - - - - - - - - - &reftitle.examples; - - &style.oop; - -getEntries(); -if ($rar_entries === FALSE) - die("Could retrieve entries."); - -echo "Found " . count($rar_entries) . " entries.\n"; - -foreach ($rar_entries as $e) { - echo $e; - echo "\n"; -} -$rar_arch->close(); -?> -]]> - - &example.outputs.similar; - - - - - - &style.procedural; - - -]]> - - - - - - &reftitle.seealso; - - RarArchive::getEntry - rar:// wrapper - - - - - diff --git a/reference/rar/rararchive/getentry.xml b/reference/rar/rararchive/getentry.xml deleted file mode 100644 index 35f101050f..0000000000 --- a/reference/rar/rararchive/getentry.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - - RarArchive::getEntry - rar_entry_get - Obtener el objeto entrada desde el archivo RAR - - - - &reftitle.description; - &style.oop; (método): - - public RarEntryfalseRarArchive::getEntry - stringentryname - - &style.procedural;: - - RarEntryfalserar_entry_get - RarArchiverarfile - stringentryname - - - Obtener el objeto entrada (archivo o directorio) desde el archivo RAR. - - - También puede obtener objetos de entrada utilizando RarArchive::getEntries. - Tenga en cuenta que un archivo RAR puede tener varias entradas con el mismo nombre; este método - recuperará sólo el primero. - - - - - &reftitle.parameters; - - - rarfile - - - Un objeto RarArchive, abierto con rar_open. - - - - - entryname - - - Ruta a la entrada dentro del archivo RAR. - - - La ruta debe ser la misma devuelta por - RarEntry::getName. - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto RarEntry encontrado &return.falseforfailure;. - - - - - &reftitle.examples; - - &style.oop; - -getEntry('tese.txt'); -if ($rar_entry === FALSE) - die("Could not get such entry"); -echo get_class($rar_entry)."\n"; -echo $rar_entry; -$rar_arch->close(); -?> -]]> - - &example.outputs.similar; - - - - - - &style.procedural; - - -]]> - - - - - - &reftitle.seealso; - - RarArchive::getEntries - rar:// wrapper - - - - - diff --git a/reference/rar/rararchive/isbroken.xml b/reference/rar/rararchive/isbroken.xml deleted file mode 100644 index 9b00d0bd76..0000000000 --- a/reference/rar/rararchive/isbroken.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - - RarArchive::isBroken - rar_broken_is - Comprobar si un archivo está dañado (incompleto) - - - - &reftitle.description; - &style.oop; (método): - - public boolRarArchive::isBroken - - - &style.procedural;: - - boolrar_broken_is - RarArchiverarfile - - - Esta función determina si un archivo está incompleto, por ejemplo, Si un volumen no se encuentra o un volumen está truncado. - - - - - &reftitle.parameters; - - - rarfile - - - Un objeto RarArchive, abierto con rar_open. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si el archivo está dañado, &false; en caso contrario. Esta función puede también - devolver &false; si el archivo pasado fue cerrado. La única manera - para poder distinguir aparte ambos casos es habilitando y permitiendo - excepciones con RarException::setUsingExceptions; sin embargo, - esto debería ser innecesario, ya que un programa no debe funcionar con archivos cerrados. - - - - - &reftitle.examples; - - &style.oop; - -isBroken()); -?> -]]> - - &example.outputs.similar; - - - - - - &style.procedural; - - -]]> - - - - - - &reftitle.seealso; - - RarArchive::setAllowBroken - - - - - diff --git a/reference/rar/rararchive/issolid.xml b/reference/rar/rararchive/issolid.xml deleted file mode 100644 index f997e033ff..0000000000 --- a/reference/rar/rararchive/issolid.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - RarArchive::isSolid - rar_solid_is - Comprueba si el archivo RAR es sólido - - - - &reftitle.description; - &style.oop; (método): - - public boolRarArchive::isSolid - - - &style.procedural;: - - boolrar_solid_is - RarArchiverarfile - - - Comprueba si el archivo RAR es sólido. La extracción individual de ficheros es más lenta en archivos sólidos. - - - - - &reftitle.parameters; - - - rarfile - - - La instancia del RarArchive, abierto con rar_open. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si el archivo es sólido, de lo contrario retorna &false;. - - - - - &reftitle.examples; - - &style.oop; - -isSolid()?'yes':'no') ."\n"; -echo "$arch2: " . ($arch2->isSolid()?'yes':'no') . "\n"; -?> -]]> - - &example.outputs.similar; - - - - - - &style.procedural; - - -]]> - - - - - - diff --git a/reference/rar/rararchive/open.xml b/reference/rar/rararchive/open.xml deleted file mode 100644 index 16966ff6be..0000000000 --- a/reference/rar/rararchive/open.xml +++ /dev/null @@ -1,237 +0,0 @@ - - - - - - - RarArchive::open - rar_open - Abre un archivo RAR - - - - &reftitle.description; - &style.oop; (método): - - public static RarArchivefalseRarArchive::open - stringfilename - stringpasswordNULL - callablevolume_callbackNULL - - &style.procedural;: - - RarArchivefalserar_open - stringfilename - stringpasswordNULL - callablevolume_callbackNULL - - - Abre un archivo RAR especificado y devuelve la instancia RarArchive que lo representa. - - - - Si el archivo a abrir esta dividido en volúmenes, se deberá pasar la ruta del primer volúmen como parámetro de la función. - De lo contrario, no todos los archivos se mostraran. - - - - - - &reftitle.parameters; - - - filename - - - Ruta del archivo Rar. - - - - - password - - - Contraseña en texto plano, si fuera necesario descifrar la cabecera del archivo. También se utilizará por defecto si - hay archivos encriptados encontrados. Tenga en cuenta que los archivos pueden poseer diferentes contraseñas en cuanto - a las cabeceras y entre ellos. - - - - - volume_callback - - - Una función que recibe como parámetro la ruta del volúmen que no fue encontrado - y retorna una cadena con la ruta correcta para dicho archivo o &null; - si el volúmen no existe o no es conocido. - El programador debería asegurar que la función pasada no cause bucles, ya que esta función es - llamada repetidas veces si la ruta devuelta en una llamada previa no corresponde - con el volúmen solicitado. Especificando este parámetro se omite - la notice que se emitiría cuando un volúmen no es encontrado; una implementación que solo devuelva &null; - puede, por lo tanto, utilizarce para omitir dichos notices. - - - - - - - En versiones menores a 2.0.0 de PHP, ­esta función no manejaria rutas - relativas correctamente. Use realpath como una solución. - - - - - - &reftitle.returnvalues; - - Devuelve una instancia del RarArchive solicitado &return.falseforfailure;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL rar 3.0.0 - - volume_callback fue agregada. - - - - - - - - - &reftitle.examples; - - &style.oop; - -getEntries(); -if ($entries === FALSE) - die("Failed fetching entries"); - -echo "Found " . count($entries) . " files.\n"; - -if (empty($entries)) - die("No valid entries found."); - -$stream = reset($entries)->getStream(); -if ($stream === FALSE) - die("Failed opening first file"); - -$rar_arch->close(); - -echo "Content of first one follows:\n"; -echo stream_get_contents($stream); - -fclose($stream); -?> -]]> - - &example.outputs.similar; - - - - - - &style.procedural; - -getStream(); -if ($stream === FALSE) - die("Failed opening first file"); - -rar_close($rar_arch); - -echo "Content of first one follows:\n"; -echo stream_get_contents($stream); - -fclose($stream); -?> -]]> - - - - Volume Callback - -getEntry('file2.txt'); -$entry->extract(null, dirname(__FILE__) . "/temp_file2.txt"); -?> -]]> - - - - - - &reftitle.seealso; - - rar:// wrapper - - - - - - diff --git a/reference/rar/rararchive/setallowbroken.xml b/reference/rar/rararchive/setallowbroken.xml deleted file mode 100644 index 581646aa14..0000000000 --- a/reference/rar/rararchive/setallowbroken.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - - RarArchive::setAllowBroken - Determina si la apertura de archivos dañados se permite - - - - &reftitle.description; - &style.oop; (method): - - public boolRarArchive::setAllowBroken - boolallow_broken - - &style.procedural;: - - boolrar_allow_broken_set - RarArchiverarfile - boolallow_broken - - - Este método determina si los archivos dañados pueden ser leidos o todas las operaciones que - intenten extraer el archivo de las entradas producirán un error. Los archivos rotos son archivos para - los cuales ningún error es detectado cuando el archivo es abierto pero un error se produce cuando leemos - las entradas. - - - - - &reftitle.parameters; - - - rarfile - - - Un objeto RarArchive, abierto con rar_open. - - - - - allow_broken - - - Determina si se permite la lectura de archivos dañados (&true;) o no (&false;). - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; &return.falseforfailure;. Sólo se producirá un error si el archivo - ya fue cerrado. - - - - - &reftitle.examples; - - &style.oop; - -setAllowBroken(true); -foreach ($a->getEntries() as $e) { - echo "$e\n"; -} -var_dump(count($a)); -?> -]]> - - &example.outputs.similar; - - - - - - &style.procedural; - - -]]> - - - - - - &reftitle.seealso; - - RarArchive::isBroken - - - - - diff --git a/reference/rar/rararchive/tostring.xml b/reference/rar/rararchive/tostring.xml deleted file mode 100644 index b061b62944..0000000000 --- a/reference/rar/rararchive/tostring.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - RarArchive::__toString - Obtener representación de texto - - - - &reftitle.description; - - public stringRarArchive::__toString - - - - Proporciona una representación de cadena para este objeto RarArchive. Esta actualmente muestra - la ruta completa del volumen de archivo que fue abierto y si el recurso es válido - o ya estaba cerrado a través de una llamada a RarArchive::close. - - - Este método debe ser utilizado sólo para propósitos de depuración, ya que no existen garantías en cuanto a la - información que contiene el resultado o cómo esta es formateada. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Una representación textual de este objeto RarArchive. - El contenido de esta representación no es especificado. - - - - - &reftitle.examples; - - Ejemplo de <methodname>RarArchive::__toString</methodname> - -close(); -echo $rar_arch."\n"; -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/rar/rarentry.xml b/reference/rar/rarentry.xml deleted file mode 100644 index e70345c7d4..0000000000 --- a/reference/rar/rarentry.xml +++ /dev/null @@ -1,681 +0,0 @@ - - - - - - La clase <classname>RarEntry</classname> - RarEntry - - - - -
    - &reftitle.intro; - - Una entrada RAR, representa un directorio o un archivo comprimido dentro de un archivo RAR. - -
    - - -
    - &reftitle.classsynopsis; - - - - RarEntry - - - - - final - RarEntry - - - - &Constants; - - const - int - RarEntry::HOST_MSDOS - 0 - - - const - int - RarEntry::HOST_OS2 - 1 - - - const - int - RarEntry::HOST_WIN32 - 2 - - - const - int - RarEntry::HOST_UNIX - 3 - - - const - int - RarEntry::HOST_MACOS - 4 - - - const - int - RarEntry::HOST_BEOS - 5 - - - const - int - RarEntry::ATTRIBUTE_WIN_READONLY - 1 - - - const - int - RarEntry::ATTRIBUTE_WIN_HIDDEN - 2 - - - const - int - RarEntry::ATTRIBUTE_WIN_SYSTEM - 4 - - - const - int - RarEntry::ATTRIBUTE_WIN_DIRECTORY - 16 - - - const - int - RarEntry::ATTRIBUTE_WIN_ARCHIVE - 32 - - - const - int - RarEntry::ATTRIBUTE_WIN_DEVICE - 64 - - - const - int - RarEntry::ATTRIBUTE_WIN_NORMAL - 128 - - - const - int - RarEntry::ATTRIBUTE_WIN_TEMPORARY - 256 - - - const - int - RarEntry::ATTRIBUTE_WIN_SPARSE_FILE - 512 - - - const - int - RarEntry::ATTRIBUTE_WIN_REPARSE_POINT - 1024 - - - const - int - RarEntry::ATTRIBUTE_WIN_COMPRESSED - 2048 - - - const - int - RarEntry::ATTRIBUTE_WIN_OFFLINE - 4096 - - - const - int - RarEntry::ATTRIBUTE_WIN_NOT_CONTENT_INDEXED - 8192 - - - const - int - RarEntry::ATTRIBUTE_WIN_ENCRYPTED - 16384 - - - const - int - RarEntry::ATTRIBUTE_WIN_VIRTUAL - 65536 - - - const - int - RarEntry::ATTRIBUTE_UNIX_WORLD_EXECUTE - 1 - - - const - int - RarEntry::ATTRIBUTE_UNIX_WORLD_WRITE - 2 - - - const - int - RarEntry::ATTRIBUTE_UNIX_WORLD_READ - 4 - - - const - int - RarEntry::ATTRIBUTE_UNIX_GROUP_EXECUTE - 8 - - - const - int - RarEntry::ATTRIBUTE_UNIX_GROUP_WRITE - 16 - - - const - int - RarEntry::ATTRIBUTE_UNIX_GROUP_READ - 32 - - - const - int - RarEntry::ATTRIBUTE_UNIX_OWNER_EXECUTE - 64 - - - const - int - RarEntry::ATTRIBUTE_UNIX_OWNER_WRITE - 128 - - - const - int - RarEntry::ATTRIBUTE_UNIX_OWNER_READ - 256 - - - const - int - RarEntry::ATTRIBUTE_UNIX_STICKY - 512 - - - const - int - RarEntry::ATTRIBUTE_UNIX_SETGID - 1024 - - - const - int - RarEntry::ATTRIBUTE_UNIX_SETUID - 2048 - - - const - int - RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET - 61440 - - - const - int - RarEntry::ATTRIBUTE_UNIX_FIFO - 4096 - - - const - int - RarEntry::ATTRIBUTE_UNIX_CHAR_DEV - 8192 - - - const - int - RarEntry::ATTRIBUTE_UNIX_DIRECTORY - 16384 - - - const - int - RarEntry::ATTRIBUTE_UNIX_BLOCK_DEV - 24576 - - - const - int - RarEntry::ATTRIBUTE_UNIX_REGULAR_FILE - 32768 - - - const - int - RarEntry::ATTRIBUTE_UNIX_SYM_LINK - 40960 - - - const - int - RarEntry::ATTRIBUTE_UNIX_SOCKET - 49152 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - RarEntry::HOST_MSDOS - - Si el valor devuelto por RarEntry::getHostOs es igual a esta constante, MS-DOS fue utilizado para - añadir esta entrada. Utilizar en lugar de RAR_HOST_MSDOS. - - - - - RarEntry::HOST_OS2 - - Si el valor devuelto por RarEntry::getHostOs es igual a esta constante, OS/2 fue utilizado para - añadir esta entrada. Destinado para sustituir a RAR_HOST_OS2. - - - - - RarEntry::HOST_WIN32 - - Si el valor devuelto por RarEntry::getHostOs es igual a esta constante, Microsoft Windows fue utilizado para - añadir esta entrada. Destinado para sustituir a RAR_HOST_WIN32. - - - - - RarEntry::HOST_UNIX - - Si el valor devuelto por RarEntry::getHostOs es igual a esta constante, un Sistema Operativo UNIX no especificado fue utilizado para - añadir esta entrada. Destinado para sustituir a RAR_HOST_UNIX. - - - - - RarEntry::HOST_MACOS - - Si el valor devuelto por RarEntry::getHostOs es igual a esta constante, un Sistema Operativo Mac fue utilizado para - añadir esta entrada. - - - - - RarEntry::HOST_BEOS - - Si el valor devuelto por RarEntry::getHostOs es igual a esta constante, un Sistema Operativo BeOS fue utilizado para - añadir esta entrada. Destinado para sustituir a RAR_HOST_BEOS. - - - - - RarEntry::ATTRIBUTE_WIN_READONLY - - Bit que representa una entrada de Windows con un atributo de sólo lectura. Para ser utilizado con - RarEntry::getAttr en entradas cuyo sistema operativo anfitrión es Microsoft Windows. - - - - - RarEntry::ATTRIBUTE_WIN_HIDDEN - - Bit que representa una entrada de Windows con un atributo oculto. Para ser utilizado con - RarEntry::getAttr en entradas cuyo sistema operativo anfitrión es Microsoft Windows. - - - - - RarEntry::ATTRIBUTE_WIN_SYSTEM - - Bits que representa una entrada de Windows con un atributo del sistema. Para ser utilizado con - RarEntry::getAttr en entradas cuyo sistema operativo anfitrión es Microsoft Windows. - - - - - RarEntry::ATTRIBUTE_WIN_DIRECTORY - - Bit que representa una entrada de Windows con un atributo de directorio (entrada es un directorio). Para ser utilizado con - RarEntry::getAttr en entradas cuyo sistema operativo anfitrión es Microsoft Windows. Véase también - RarEntry::isDirectory, que también trabaja con entradas que no fueron añadidas en WinRAR. - - - - - RarEntry::ATTRIBUTE_WIN_ARCHIVE - - Bit que representa una entrada de Windows con un atributo de archivo. Para ser utilizado con - RarEntry::getAttr en entradas cuyo sistema operativo anfitrión es Microsoft Windows. - - - - - RarEntry::ATTRIBUTE_WIN_DEVICE - - Bit que representa una entrada de Windows con un atributo de dispositivo. Para ser utilizado con - RarEntry::getAttr en entradas cuyo sistema operativo anfitrión es Microsoft Windows. - - - - - RarEntry::ATTRIBUTE_WIN_NORMAL - - Bit que representa una entrada de Windows con un atributo de archivo normal (entrada NO es un directorio). Para ser utilizado con - RarEntry::getAttr en entradas cuyo sistema operativo anfitrión es Microsoft Windows. Véase también - RarEntry::isDirectory, que también trabaja con entradas que no fueron añadidas en WinRAR. - - - - - RarEntry::ATTRIBUTE_WIN_TEMPORARY - - Bit que representa una entrada de Windows con un atributo temporal. Para ser utilizado con - RarEntry::getAttr en entradas cuyo sistema operativo anfitrión es Microsoft Windows. - - - - - RarEntry::ATTRIBUTE_WIN_SPARSE_FILE - - Bit que representa una entrada de Windows con un atributo de archivo disperso (archivo es un archivo disperso NTFS). Para ser utilizado con - RarEntry::getAttr en entradas cuyo sistema operativo anfitrión es Microsoft Windows. - - - - - RarEntry::ATTRIBUTE_WIN_REPARSE_POINT - - Bit que representa una entrada de Windows con un atributo punto de re-análisis (entrada es un punto de re-análisis NTFS, por ejemplo, un - directorio enlace o un sistema de montaje de archivos). Para ser utilizado con - RarEntry::getAttr en entradas cuyo sistema operativo anfitrión es Microsoft Windows. - - - - - RarEntry::ATTRIBUTE_WIN_COMPRESSED - - Bit que representa una entrada de Windows con un atributo comprimido (sólo NTFS). Para ser utilizado con - RarEntry::getAttr en entradas cuyo sistema operativo anfitrión es Microsoft Windows. - - - - - RarEntry::ATTRIBUTE_WIN_OFFLINE - - Bit que representa una entrada de Windows con un atributo fuera de línea (entrada es desconectada y no accesible). Para ser utilizado con - RarEntry::getAttr en entradas cuyo sistema operativo anfitrión es Microsoft Windows. - - - - - RarEntry::ATTRIBUTE_WIN_NOT_CONTENT_INDEXED - - Bit que representa una entrada de Windows con un atributo de contenido no indexado (entrada deberá ser indexada). Para ser utilizado con - RarEntry::getAttr en entradas cuyo sistema operativo anfitrión es Microsoft Windows. - - - - - RarEntry::ATTRIBUTE_WIN_ENCRYPTED - - Bit que representa una entrada de Windows con un atributo cifrado (sólo NTFS). Para ser utilizado con - RarEntry::getAttr en entradas cuyo sistema operativo anfitrión es Microsoft Windows. - - - - - RarEntry::ATTRIBUTE_WIN_VIRTUAL - - Bit que representa una entrada de Windows con un atributo virtual. Para ser utilizado con - RarEntry::getAttr en entradas cuyo sistema operativo anfitrión es Microsoft Windows. - - - - - RarEntry::ATTRIBUTE_UNIX_WORLD_EXECUTE - - Bit que representa una entrada que es ejecutable en el mundo UNIX. Para ser utilizado con - RarEntry::getAttr en entradas cuyo sistema operativo anfitrión es UNIX. - - - - - RarEntry::ATTRIBUTE_UNIX_WORLD_WRITE - - Bit que representa una entrada que es escribible en el mundo UNIX. Para ser utilizado con - RarEntry::getAttr en entradas cuyo sistema operativo anfitrión es UNIX. - - - - - RarEntry::ATTRIBUTE_UNIX_WORLD_READ - - Bit que representa una entrada que es leible en el mundo UNIX. Para ser utilizado con - RarEntry::getAttr en entradas cuyo sistema operativo anfitrión es UNIX. - - - - - RarEntry::ATTRIBUTE_UNIX_GROUP_EXECUTE - - Bit que representa una entrada UNIX que es grupo ejecutable. Para ser utilizado con - RarEntry::getAttr en entradas cuyo sistema operativo anfitrión es UNIX. - - - - - RarEntry::ATTRIBUTE_UNIX_GROUP_WRITE - - Bit que representa una entrada UNIX que es grupo escribible. Para ser utilizado con - RarEntry::getAttr en entradas cuyo sistema operativo anfitrión es UNIX. - - - - - RarEntry::ATTRIBUTE_UNIX_GROUP_READ - - Bit que representa una entrada UNIX que es grupo leible. Para ser utilizado con - RarEntry::getAttr en entradas cuyo sistema operativo anfitrión es UNIX. - - - - - RarEntry::ATTRIBUTE_UNIX_OWNER_EXECUTE - - Bit que representa una entrada UNIX que es propietario ejecutable. Para ser utilizado con - RarEntry::getAttr en entradas cuyo sistema operativo anfitrión es UNIX. - - - - - RarEntry::ATTRIBUTE_UNIX_OWNER_WRITE - - Bit que representa una entrada UNIX que es propietario escribible. Para ser utilizado con - RarEntry::getAttr en entradas cuyo sistema operativo anfitrión es UNIX. - - - - - RarEntry::ATTRIBUTE_UNIX_OWNER_READ - - Bit que representa una entrada UNIX que es propietario leible. Para ser utilizado con - RarEntry::getAttr en entradas cuyo sistema operativo anfitrión es UNIX. - - - - - RarEntry::ATTRIBUTE_UNIX_STICKY - - Bit que representa el sticky bit UNIX. Para ser utilizado con - RarEntry::getAttr en entradas cuyo sistema operativo anfitrión es UNIX. - - - - - RarEntry::ATTRIBUTE_UNIX_SETGID - - Bit que representa el atributo UNIX setgid. Para ser utilizado con - RarEntry::getAttr en entradas cuyo sistema operativo anfitrión es UNIX. - - - - - RarEntry::ATTRIBUTE_UNIX_SETUID - - Bit que representa el atributo UNIX setuid. Para ser utilizado con - RarEntry::getAttr en entradas cuyo sistema operativo anfitrión es UNIX. - - - - - RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET - - Máscara para aislar a los últimos cuatro bits (nibble) de atributos UNIX - (_S_IFMT, el tipo de máscara de archivo). Para ser utilizado con - RarEntry::getAttr en entradas cuyo sistema operativo anfitrión es UNIX y con las - constantes RarEntry::ATTRIBUTE_UNIX_FIFO, - RarEntry::ATTRIBUTE_UNIX_CHAR_DEV, - RarEntry::ATTRIBUTE_UNIX_DIRECTORY, - RarEntry::ATTRIBUTE_UNIX_BLOCK_DEV, - RarEntry::ATTRIBUTE_UNIX_REGULAR_FILE, - RarEntry::ATTRIBUTE_UNIX_SYM_LINK and - RarEntry::ATTRIBUTE_UNIX_SOCKET. - - - - - RarEntry::ATTRIBUTE_UNIX_FIFO - - FIFOs Unix tendrá atributos cuyos últimos cuatro bits tienen este valor. Para ser utilizado con - RarEntry::getAttr en entradas cuyo sistema operativo anfitrión es UNIX y con la - constante - RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET. - - - - - RarEntry::ATTRIBUTE_UNIX_CHAR_DEV - - Dispositivo de tipo carácter Unix tendrá atributos cuyos últimos cuatro bits tienen este valor. Para ser utilizado con - RarEntry::getAttr en entradas cuyo sistema operativo anfitrión es UNIX y con la - constante - RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET. - - - - - RarEntry::ATTRIBUTE_UNIX_DIRECTORY - - Directorios Unix tendrá atributos cuyos últimos cuatro bits tienen este valor. Para ser utilizado con - RarEntry::getAttr en entradas cuyo sistema operativo anfitrión es UNIX y con la - constante - RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET. Véase también - RarEntry::isDirectory, que también trabaja con entradas que - fueron añadidas en otros sistemas operativos. - - - - - RarEntry::ATTRIBUTE_UNIX_BLOCK_DEV - - Dispositivo de tipo bloque Unix tendrá atributos cuyos últimos cuatro bits tienen este valor. Para ser utilizado con - RarEntry::getAttr en entradas cuyo sistema operativo anfitrión es UNIX y con la - constante - RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET. - - - - - RarEntry::ATTRIBUTE_UNIX_REGULAR_FILE - - Archivos regular Unix (no directorios) tendrá atributos cuyos últimos cuatro bits tienen este valor. Para ser utilizado con - RarEntry::getAttr en entradas cuyo sistema operativo anfitrión es UNIX y con la - constante - RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET. Véase también - RarEntry::isDirectory, ue también trabaja con entradas que - fueron añadidas en otros sistemas operativos. - - - - - RarEntry::ATTRIBUTE_UNIX_SYM_LINK - - Enlace simbólico Unix tendrá atributos cuyos últimos cuatro bits tienen este valor. Para ser utilizado con - RarEntry::getAttr en entradas cuyo sistema operativo anfitrión es UNIX y con la - constante - RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET. - - - - - RarEntry::ATTRIBUTE_UNIX_SOCKET - - Sockets Unix will tendrá atributos cuyos últimos cuatro bits tienen este valor. Para ser utilizado con - RarEntry::getAttr en entradas cuyo sistema operativo anfitrión es UNIX y con la - constante - RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET. - - - - -
    - - - -
    - - &reference.rar.entities.rarentry; - -
    - diff --git a/reference/rar/rarentry/extract.xml b/reference/rar/rarentry/extract.xml deleted file mode 100644 index 56bf5f8af8..0000000000 --- a/reference/rar/rarentry/extract.xml +++ /dev/null @@ -1,192 +0,0 @@ - - - - - - - RarEntry::extract - Extraer entrada del archivo - - - - &reftitle.description; - - public boolRarEntry::extract - stringdir - stringfilepath"" - stringpasswordNULL - boolextended_data&false; - - - RarEntry::extract extrae los datos de entrada. - Esto creará un nuevo archivo en el - dir especificado con el mismo nombre que el nombre de la entrada, - a menos que el segundo argumento sea especificado. Siga leyendo más abajo para obtener mayor información. - - - - - &reftitle.parameters; - - - dir - - - Ruta al directorio donde los archivos deben ser extraídos. Este parámetro es - considerado si y sólo si no es filepath. Si ambos - parámetros están vacíos se intentará una extracción en el directorio actual. - - - - - - filepath - - - Ruta (relativa o absoluta) que contiene el directorio y el nombre del - archivo extraído. Este parámetro anula los parámetros - dir y el nombre del archivo original. - - - - - - password - - - La contraseña utilizada para cifrar esta entrada. Si la entrada no está cifrada, este valor no se utilizará y puede - ser omitido. Si se omite este parámetro y la entrada está cifrada, la contraseña dada a - rar_open, será utlizada. Si una contraseña incorrecta es dada, de forma explicita - o implicita via rar_open, la comprobación CRC fallará y este método fallará y devolverá &false;. - Si no se da la contraseña y se requiere una, este método fallará y devolverá &false;. - Puede comprobar si una entrada está cifrada con RarEntry::isEncrypted. - - - - - - extended_data - - - Si &true;, información extendida tales como NTFS ACLs e información propietaria Unix será establecida en los archivos - extraidos, siempre que esta esté presente en el archivo. - - - - - - Antes de la versión 2.0.0, esta función no manejaba las rutas - relativas correctamente. Utilice realpath como una solución. - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL rar 3.0.0 - - extended_data fue añadido. - - - - PECL rar 3.0.0 - - Soporte para archivos RAR con nombres de entrada que se repiten ya no es defectuoso - - - - - - - - - &reftitle.examples; - - - Ejemplo de <methodname>RarEntry::extract</methodname> - -extract('/dir/to'); // crear /dir/to/Dir/file.txt -$entry->extract(false, '/dir/to/new_name.txt'); // crear /dir/to/new_name.txt - -?> -]]> - - - - ¿Cómo extraer todos los archivos en archivo?: - -extract("."); // extraer el directorio actual -} -rar_close($rar_file); - -?> -]]> - - - - - - - &reftitle.seealso; - - RarEntry::getStream - rar:// wrapper - - - - - diff --git a/reference/rar/rarentry/getattr.xml b/reference/rar/rarentry/getattr.xml deleted file mode 100644 index c4b6470e21..0000000000 --- a/reference/rar/rarentry/getattr.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - RarEntry::getAttr - Obtener los atributos de la entrada - - - - &reftitle.description; - - public intRarEntry::getAttr - - - - Devuelve los atributos dependientes del SO del archivo de entrada. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve los atributos o &false; en caso de error. - - - - - &reftitle.examples; - - Ejemplo de <methodname>RarEntry::getAttr</methodname> - -getHostOs(); -$attr = $entry->getAttr(); - -switch($host_os) { - case RAR_HOST_MSDOS: - case RAR_HOST_OS2: - case RAR_HOST_WIN32: - case RAR_HOST_MACOS: - printf("%c%c%c%c%c%c\n", - ($attr & 0x08) ? 'V' : '.', - ($attr & 0x10) ? 'D' : '.', - ($attr & 0x01) ? 'R' : '.', - ($attr & 0x02) ? 'H' : '.', - ($attr & 0x04) ? 'S' : '.', - ($attr & 0x20) ? 'A' : '.'); - break; - case RAR_HOST_UNIX: - case RAR_HOST_BEOS: - switch ($attr & 0xF000) - { - case 0x4000: - printf("d"); - break; - case 0xA000: - printf("l"); - break; - default: - printf("-"); - break; - } - printf("%c%c%c%c%c%c%c%c%c\n", - ($attr & 0x0100) ? 'r' : '-', - ($attr & 0x0080) ? 'w' : '-', - ($attr & 0x0040) ? (($attr & 0x0800) ? 's':'x'):(($attr & 0x0800) ? 'S':'-'), - ($attr & 0x0020) ? 'r' : '-', - ($attr & 0x0010) ? 'w' : '-', - ($attr & 0x0008) ? (($attr & 0x0400) ? 's':'x'):(($attr & 0x0400) ? 'S':'-'), - ($attr & 0x0004) ? 'r' : '-', - ($attr & 0x0002) ? 'w' : '-', - ($attr & 0x0001) ? 'x' : '-'); - break; -} - -rar_close($rar_file); - -?> -]]> - - - - - - - &reftitle.seealso; - - RarEntry::getHostOs - Las constantes de RarEntry - - - - - diff --git a/reference/rar/rarentry/getcrc.xml b/reference/rar/rarentry/getcrc.xml deleted file mode 100644 index abb69f7738..0000000000 --- a/reference/rar/rarentry/getcrc.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - RarEntry::getCrc - Obtener el CRC de la entrada - - - - &reftitle.description; - - public stringRarEntry::getCrc - - - - Devuelve una cadena hexadecimal representación de el CRC del archivo de entrada. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el CRC del archivo de entrada o &false; en caso de error. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL rar 2.0.0 - - Este método devuelve ahora valores correctos para archivos de varios volúmenes. - - - - - - - - - diff --git a/reference/rar/rarentry/getfiletime.xml b/reference/rar/rarentry/getfiletime.xml deleted file mode 100644 index 1fce936fbc..0000000000 --- a/reference/rar/rarentry/getfiletime.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - RarEntry::getFileTime - Devolver entrada última fecha de modificación - - - - &reftitle.description; - - public stringRarEntry::getFileTime - - - - Devuelve entrada última fecha modificación. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve entrada última fecha de modificación como una cadena en formato - YYYY-MM-DD HH:II:SS, o &false; en caso de error. - - - - - diff --git a/reference/rar/rarentry/gethostos.xml b/reference/rar/rarentry/gethostos.xml deleted file mode 100644 index b05424aac2..0000000000 --- a/reference/rar/rarentry/gethostos.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - - RarEntry::getHostOs - Obtener sistema operativo anfitrión del archivo de entrada - - - - &reftitle.description; - - public intRarEntry::getHostOs - - - - Devuelve el código del sistema operativo anfitrión del archivo de entrada. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el código del sistema operativo anfitrión, o &false; en caso de error. - - - - - &reftitle.examples; - - - Ejemplo de <methodname>RarEntry::getHostOs</methodname> (version >= 2.0.0) - -getHostOs()) { - case RarEntry::HOST_MSDOS: - echo "MS-DOS\n"; - break; - case RarEntry::HOST_OS2: - echo "OS2\n"; - break; - case RarEntry::HOST_WIN32: - echo "Win32\n"; - break; - case RarEntry::HOST_MACOS: - echo "MacOS\n"; - break; - case RarEntry::HOST_UNIX: - echo "Unix/Linux\n"; - break; - case RarEntry::HOST_BEOS: - echo "BeOS\n"; - break; -} - -?> -]]> - - - - - <methodname>RarEntry::getHostOs</methodname> example (version <= 1.0.0) - -getHostOs()) { - case RAR_HOST_MSDOS: - echo "MS-DOS\n"; - break; - case RAR_HOST_OS2: - echo "OS2\n"; - break; - case RAR_HOST_WIN32: - echo "Win32\n"; - break; - case RAR_HOST_MACOS: - echo "MacOS\n"; - break; - case RAR_HOST_UNIX: - echo "Unix/Linux\n"; - break; - case RAR_HOST_BEOS: - echo "BeOS\n"; - break; -} - -?> -]]> - - - - - - - &reftitle.seealso; - - RarEntry::extract - - - - - diff --git a/reference/rar/rarentry/getmethod.xml b/reference/rar/rarentry/getmethod.xml deleted file mode 100644 index 6d358ab3e9..0000000000 --- a/reference/rar/rarentry/getmethod.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - RarEntry::getMethod - Obtener método pack de la entrada - - - - &reftitle.description; - - public intRarEntry::getMethod - - - - RarEntry::getMethod devuelve el número del método utilizado cuando añadimos - archivo actual de entrada. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el número de método o &false; en caso de error. - - - - - &reftitle.examples; - - Ejemplo de <methodname>RarEntry::getMethod</methodname> - -getMethod(); - -?> -]]> - - - - - - diff --git a/reference/rar/rarentry/getname.xml b/reference/rar/rarentry/getname.xml deleted file mode 100644 index 47ff90d064..0000000000 --- a/reference/rar/rarentry/getname.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - RarEntry::getName - Obtener el nombre de la entrada - - - - &reftitle.description; - - public stringRarEntry::getName - - - - Devuelve el nombre (con la ruta) de el archivo entrada. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el nombre de la entrada como una cadena, o &false; en caso de error. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL rar 2.0.0 - - Desde la versión 2.0.0, la cadena devuelta está codificada en Unicode/UTF-8. - - - - - - - - - &reftitle.examples; - - Ejemplo de <methodname>RarEntry::getName</methodname> - -getName(), - ENT_COMPAT, - "UTF-8" - ), - "HTML-ENTITIES", - "UTF-8" -); - -?> -]]> - - - - - - diff --git a/reference/rar/rarentry/getpackedsize.xml b/reference/rar/rarentry/getpackedsize.xml deleted file mode 100644 index 525a228c6d..0000000000 --- a/reference/rar/rarentry/getpackedsize.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - RarEntry::getPackedSize - Obtiene el tamaño empaquetado de la entrada - - - - &reftitle.description; - - public intRarEntry::getPackedSize - - - - Obtiene el tamaño empaquetado del archivo entrada. - - - Tenga en cuenta que en las plataformas de 32 bits de longitud (que incluye Windows - x64), el tamaño máximo devuelto está limitado a 2 GB. Compruebe la constante - PHP_INT_MAX. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el tamaño empaquetado, o &false; en caso de error. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL rar 2.0.0 - - Este método devuelve ahora los valores correctos de empaquetado mayores a 2 GB - en plataformas de 64-bit ints y nunca - devuelve valores negativos en otras plataformas. - - - - - - - - - &reftitle.examples; - - Ejemplo de <methodname>RarEntry::getPackedSize</methodname> - -getName() . " = " . $entry->getPackedSize() . " bytes"; - -?> -]]> - - - - - - diff --git a/reference/rar/rarentry/getstream.xml b/reference/rar/rarentry/getstream.xml deleted file mode 100644 index a90a6b720a..0000000000 --- a/reference/rar/rarentry/getstream.xml +++ /dev/null @@ -1,147 +0,0 @@ - - - - - - - RarEntry::getStream - Obtener manejador de archivo para entrada - - - - &reftitle.description; - - public resourcefalseRarEntry::getStream - stringpassword - - - Devuelve un manejador de archivo que - soporta operaciones de lectura. Este manejador proporciona descompresión al vuelo - para esta entrada. - - - El manejador no es invalidado por llamar a - rar_close. - - - El flujo resultante no tiene verificación de integridad. En particular, archivo corrupto y - descifrado con una clave errónea, no será detectado. Es responsabilidad del programador utilizar la entrada CRC - para comprobar la integridad, si así lo desea. - - - - - &reftitle.parameters; - - - password - - - La contraseña utilizada para cifrar esta entrada. Si la entrada no está cifrada, este valor no se utilizará y puede - ser omitido. Si el parámetro es omitido y la entrada está cifrada, la contraseña dada a - rar_open, será utilizada. Si una contraseña incorrecta es dada, ya sea explícita - o implícitamente via rar_open, teste método resultante de flujo producirá error de - salida. Si no se especifica la contraseña y se requiere una, este método fallará y devolverá &false;. - Puede comprobar si una entrada está cifrada con RarEntry::isEncrypted. - - - - - - - - &reftitle.returnvalues; - - El manejador de archivo &return.falseforfailure;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL rar 3.0.0 - - Soporte para archivos RAR con nombres de entrada que se repiten ya no es defectuoso. - - - - - - - - - &reftitle.examples; - - Ejemplo de <methodname>RarEntry::getStream</methodname> - -getStream(); -if ($stream === false) - die("Failed to obtain stream."); - -rar_close($rar_file); //flujo es independiente de archivo - -while (!feof($stream)) { - $buff = fread($stream, 8192); - if ($buff !== false) - echo $buff; - else - break; //error fread -} - -fclose($stream); - -?> -]]> - - - - - - &reftitle.seealso; - - RarEntry::extract - rar:// wrapper - - - - - diff --git a/reference/rar/rarentry/getunpackedsize.xml b/reference/rar/rarentry/getunpackedsize.xml deleted file mode 100644 index 4ad0ac1ee8..0000000000 --- a/reference/rar/rarentry/getunpackedsize.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - RarEntry::getUnpackedSize - Obtener el tamaño descomprimido de la entrada - - - - &reftitle.description; - - public intRarEntry::getUnpackedSize - - - - Obtiene el tamaño descomprimido del archivo entrada. - - - Tenga en cuenta que en las plataformas de 32 bits de longitud (que incluye Windows - x64), el tamaño máximo devueltos está limitado a 2 GB. Compruebe la constante - PHP_INT_MAX. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el tamaño descomprimido, o &false; en caso de error. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL rar 2.0.0 - - Este método devuelve ahora valores correctos de tamaño descomprimido superiores a - 2 GB en plataformas con 64-bit ints y nunca - devuelve valores negativos en otras plataformas. - - - - - - - - - &reftitle.returnvalues; - - Ejemplo de <methodname>RarEntry::getUnpackedSize</methodname> - -getName() . " = " . $entry->getUnpackedSize() . " bytes"; - -?> -]]> - - - - - - diff --git a/reference/rar/rarentry/getversion.xml b/reference/rar/rarentry/getversion.xml deleted file mode 100644 index 3ce458d611..0000000000 --- a/reference/rar/rarentry/getversion.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - RarEntry::getVersion - Obtener la versión mínima del programa RAR requerida para desempaquetar la entrada - - - - &reftitle.description; - - public intRarEntry::getVersion - - - - Devuelve la versión mínima del programa RAR (por ejemplo WinRAR) requerida para desempaquetar la entrada. - Esta es codificada como 10 * version mayor + versión menor. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la versión o &false; en caso de error. - - - - - &reftitle.examples; - - Ejemplo de <methodname>RarEntry::getVersion</methodname> - -getVersion(); - -?> -]]> - - - - - - diff --git a/reference/rar/rarentry/isdirectory.xml b/reference/rar/rarentry/isdirectory.xml deleted file mode 100644 index a769e5588f..0000000000 --- a/reference/rar/rarentry/isdirectory.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - RarEntry::isDirectory - Comprobar si una entrada representa un directorio - - - - &reftitle.description; - - public boolRarEntry::isDirectory - - - - Comprueba si una entrada representa un directorio. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si la entrada es un directorio y &false; en caso contrario. - - - - - &reftitle.notes; - - Esta función sólo está disponible desde la versión 2.0.0, pero también puede - comprobarse si una entrada es un directorio mediante la comprobación de los atributos de entrada, - así (sólo funciona para los archivos comprimidos en RAR por Windows o Unix): - -getHostOs() == RAR_HOST_WIN32) && ($e->getAttr() & 0x10)) || - (($e->getHostOs() == RAR_HOST_UNIX) && (($e->getAttr() & 0xf000) == 0x4000))); -?> -]]> - - - - - - diff --git a/reference/rar/rarentry/isencrypted.xml b/reference/rar/rarentry/isencrypted.xml deleted file mode 100644 index 8cf8b4e517..0000000000 --- a/reference/rar/rarentry/isencrypted.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - RarEntry::isEncrypted - Comprobar si una entrada está cifrada - - - - &reftitle.description; - - public boolRarEntry::isEncrypted - - - - Comprueba si el contenido de la entrada actual está cifrado. - - - La contraseña utilizada puede variar entre los archivos dentro del mismo archivo RAR. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si la entrada actual se encuentra cifrada y &false; en caso contrario. - - - - - - diff --git a/reference/rar/rarentry/tostring.xml b/reference/rar/rarentry/tostring.xml deleted file mode 100644 index d25c83e689..0000000000 --- a/reference/rar/rarentry/tostring.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - RarEntry::__toString - Obtener texto representación de entrada - - - - &reftitle.description; - - public stringRarEntry::__toString - - - - RarEntry::__toString devuelve una representación textual de esta entrada. Esta incluye si - la entrada es un archivo o un directorio (enlaces simbólicos y otros objetos especiales serán tratados como archivos), - el nombre UTF-8 de la entrada y su CRC. La forma y el contenido de esta representación puede cambiar en el futuro, - así que no son fiables. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Una representación textual de la entrada. - - - - - - diff --git a/reference/rar/rarexception.xml b/reference/rar/rarexception.xml deleted file mode 100644 index 888e9afa2d..0000000000 --- a/reference/rar/rarexception.xml +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - - La clase RarException - RarException - - - - -
    - &reftitle.intro; - - Esta clase sirve para dos propósitos: estas son el tipo de las excepciones lanzadas por la extensión RAR - funciones y métodos y esto permite, a través de métodos estáticos consultar y definir el error y - el comportamiento de la extensión, por ejemplo, si las excepciones son lanzadas o solamente se emiten advertencias. - - - Los códigos de error que se utilizan los siguientes: - - - - - -1 - error fuera de biblioteca UnRAR - - - - - 11 - memoria insuficiente - - - - - - 12 - datos dañados - - - - - - 13 - archivo dañado - - - - - - 14 - formato desconocido - - - - - - 15 - error de apertura de archivo - - - - - - 16 - error al crear archivo - - - - - - 17 - error al cerrar archivo - - - - - - 18 - error de lectura - - - - - 19 - error de escritura - - - - - - 20 - búfer demasiado pequeño - - - - - - 21 - error RAR desconocido - - - - - - 22 - contraseña requerida pero no especificada - - - -
    - - -
    - &reftitle.classsynopsis; - - - - RarException - - - - - final - RarException - - - - extends - Exception - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.rar.entities.rarexception; - -
    - diff --git a/reference/rar/rarexception/isusingexceptions.xml b/reference/rar/rarexception/isusingexceptions.xml deleted file mode 100644 index b65ba92b1a..0000000000 --- a/reference/rar/rarexception/isusingexceptions.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - RarException::isUsingExceptions - Comprobar si el manejador de errores con excepciones está en uso - - - - &reftitle.description; - - public static boolRarException::isUsingExceptions - - - - Comprueba si las funciones RAR emitirán avisos y devolverán valores de error o si ellas - lanzarán excepciones en la mayoría de las circunstancias (no incluye algunos errores de programación - tales como pasar el tipo incorrecto de argumento). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si las excepciones estan siendo utilizadas, &false; en caso contrario. - - - - - &reftitle.examples; - - Ejemplo de <function>RarException::isUsingExceptions</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - RarException::setUsingExceptions - - - - - diff --git a/reference/rar/rarexception/setusingexceptions.xml b/reference/rar/rarexception/setusingexceptions.xml deleted file mode 100644 index 7ae96a0470..0000000000 --- a/reference/rar/rarexception/setusingexceptions.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - RarException::setUsingExceptions - Activar y desactivar el manejador de errores con excepciones - - - - &reftitle.description; - - public static voidRarException::setUsingExceptions - boolusing_exceptions - - - Si y sólo si el argumento es &true;, entonces, en lugar de emitir advertencias y devolver un valor especial indicando error cuando la biblioteca UnRAR encuentre un error, una excepción de tipo RarException será lanzada. - - - Las excepciones también será lanzado para los siguientes errores, que se producen fuera de la biblioteca (su código de error será -1): - - - - - intentar algunas operaciones en un objeto RarArchive cerrado o un objeto RarEntry relativo al primero; - - - - - - intentar obtener una entrada que no existe con RarArchive::getEntry. - - - - - - - - &reftitle.parameters; - - - using_exceptions - - - Debe ser &true; para activar lanzamiento de excepciones, &false; para descativarlo (el valor por defecto). - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>RarException::setUsingExceptions</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - RarException::isUsingExceptions - - - - - diff --git a/reference/rar/reference.xml b/reference/rar/reference.xml deleted file mode 100644 index bf8ca710a5..0000000000 --- a/reference/rar/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - - &Functions; Rar - - &reference.rar.entities.functions; - - - diff --git a/reference/rar/setup.xml b/reference/rar/setup.xml deleted file mode 100644 index 4812903af3..0000000000 --- a/reference/rar/setup.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - &reftitle.setup; - - -
    - &reftitle.install; - - Rar está actualmente disponible a través de PECL - &url.pecl.package;rar. - - - Puede utilizarse el asistente de instalación PECL para instalar la extensión - Rar, utilizando el siguiente comando: pecl -v install rar. - - - Asimismo, puede descargarse el paquete tar.gz e instalarse - Rar manualmente: - - Instalación de Rar - - - - - - - Los usuarios de Windows deben activar la biblioteca - php_rar.dll en el archivo &php.ini; - para utilizar estas funciones. - -
    - - - -
    - &reftitle.resources; - - Esta extensión registra 3 clases internas: - La representación del archivo retornada por la función - rar_open – RarArchive, - la representación de las entradas retornadas por - las funciones rar_list y - rar_entry_get – RarEntry - y las excepciones de tipo RarException. - - - Esta extensión registra también un flujo de recurso llamado "rar" - y un gestor de url llamado "rar wrapper", registrado bajo el prefijo - "rar". - -
    - - -
    - diff --git a/reference/recode/book.xml b/reference/recode/book.xml deleted file mode 100644 index 50cfbb99ad..0000000000 --- a/reference/recode/book.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - GNU Recode - Recode - - - - &reftitle.intro; - &warn.pecl.unmaintained; - - Este módulo contiene una interfaz a la biblioteca GNU Recode. La - biblioteca GNU Recode convierte los ficheros entre diversas codificaciones. - Cuando esta conversión no ha podido ser efectuada de manera precisa, - se realizan aproximaciones. La biblioteca reconoce alrededor de - 150 juegos de caracteres diferentes y es capaz de convertir ficheros utilizándolos. La mayoría de los juegos de caracteres - RFC 1345 son soportados. - - - - Esta extensión ha sido desligada y movida a - PECL a partir de PHP 7.4.0. - Considere el uso de las extensiones - Cadenas Multioctetos o - iconv en su lugar. - - - ¬e.no-windows.extension; - - - - &reference.recode.setup; - &reference.recode.reference; - - - diff --git a/reference/recode/configure.xml b/reference/recode/configure.xml deleted file mode 100644 index 0284f6c877..0000000000 --- a/reference/recode/configure.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - -
    - &reftitle.install; - -
    - PHP 7.4 - - &pecl.moved-ver;7.4.0 - - - &pecl.info; - &url.pecl.package;recode. - -
    - -
    - PHP < 7.4 - - Para utilizar las funciones definidas en este módulo, PHP debe ser compilado - con la opción. - - - - Pueden encontrarse fallos y problemas de inicio de PHP - cuando la extensión recode es cargada - después de las extensiones - MySQL o - imap. - Cargar la extensión recode antes de estas dos extensiones corrige - el problema. Esto se debe a un problema técnico ya que la biblioteca - c-client de IMAP y recode tienen ambas su propia función - hash_lookup() y las extensiones mysql y recode - tienen ambas su función hash_insert. - - - &warn.imaprecodeyaz; -
    -
    - diff --git a/reference/recode/functions/recode-file.xml b/reference/recode/functions/recode-file.xml deleted file mode 100644 index 47d0ea4d2e..0000000000 --- a/reference/recode/functions/recode-file.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - - recode_file - Recodificación de fichero a fichero, según la solicitud - - - - &reftitle.description; - - boolrecode_file - stringrequest - resourceinput - resourceoutput - - - Recodifica el fichero identificado por input - en el fichero identificado por output - según la solicitud de recodificación request. - - - - - &reftitle.parameters; - - - request - - - El tipo de solicitud de recodificación deseada - - - - - input - - - Un gestor de fichero local para el argumento - input - - - - - output - - - Un gestor de fichero local para el argumento - output - - - - - - - - &reftitle.returnvalues; - - Retorna &false; en caso de fallo, y &true; en caso contrario. - - - - - &reftitle.examples; - - Ejemplo con <function>recode_file</function> - - -]]> - - - - - - &reftitle.notes; - - Esta función aún no maneja ficheros remotos (URL). Ambos ficheros deben hacer referencia a ficheros locales. - - - - - &reftitle.seealso; - - fopen - - - - - diff --git a/reference/recode/functions/recode-string.xml b/reference/recode/functions/recode-string.xml deleted file mode 100644 index 83eccd67b9..0000000000 --- a/reference/recode/functions/recode-string.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - recode_string - Recodifica una string según la petición - - - - &reftitle.description; - - stringrecode_string - stringrequest - stringstring - - - Recodifica la string string según - la petición request. - - - - - &reftitle.parameters; - - - request - - - El tipo de petición de recodificación deseado - - - - - string - - - La string a recodificar - - - - - - - - &reftitle.returnvalues; - - Devuelve la string recodificada en caso de éxito y false en caso contrario. - - - - - &reftitle.examples; - - Ejemplo con <function>recode_string</function> - - - -]]> - - - - - - &reftitle.notes; - - Una petición simple de recodificación puede ser "lat1..iso646-de". - - - - - &reftitle.seealso; - - - Consulte la documentación GNU Recode de su instalación - para más detalles sobre las peticiones. - - mb_convert_encoding - UConverter::transcode - iconv - - - - - diff --git a/reference/recode/functions/recode.xml b/reference/recode/functions/recode.xml deleted file mode 100644 index 5504ee72dc..0000000000 --- a/reference/recode/functions/recode.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - - - recode - &Alias; recode_string - - - - &reftitle.description; - - &info.function.alias; - recode_string. - - - - - diff --git a/reference/recode/reference.xml b/reference/recode/reference.xml deleted file mode 100644 index 0ca121da13..0000000000 --- a/reference/recode/reference.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - Recode &Functions; - - &reference.recode.entities.functions; - - - - diff --git a/reference/recode/setup.xml b/reference/recode/setup.xml deleted file mode 100644 index 64d521cc49..0000000000 --- a/reference/recode/setup.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - Se debe tener GNU Recode 3.5 o superior instalado en el sistema. - El paquete puede ser descargado desde - &url.recode;. - - - - La versión 3.6 de la biblioteca Recode añade caracteres extraños - al final de las strings convertidas en ciertas circunstancias. Por lo tanto, - es preferible utilizar Recode v3.5 o una biblioteca alternativa disponible, - como la extensión - iconv o la extensión - mbstring. - - -
    - - - - &reference.recode.configure; - - -
    - diff --git a/reference/rnp/book.xml b/reference/rnp/book.xml deleted file mode 100644 index fbc47e81cd..0000000000 --- a/reference/rnp/book.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - - Rnp - Rnp - - - &reftitle.intro; - &warn.experimental; - - Este módulo permite utilizar la biblioteca RNP. - RNP es una biblioteca OpenPGP C++ de alto rendimiento utilizada por Mozilla Thunderbird. - - - - &reference.rnp.setup; - &reference.rnp.constants; - &reference.rnp.examples; - &reference.rnp.reference; - - &reference.rnp.rnpffi; - - - diff --git a/reference/rnp/configure.xml b/reference/rnp/configure.xml deleted file mode 100644 index af7ced634c..0000000000 --- a/reference/rnp/configure.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;rnp - - -
    - diff --git a/reference/rnp/constants.xml b/reference/rnp/constants.xml deleted file mode 100644 index 2764b2c996..0000000000 --- a/reference/rnp/constants.xml +++ /dev/null @@ -1,363 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - RNP_KEYSTORE_GPG - (string) - - - - Formato del almacén de claves "GPG". - - - - - - RNP_KEYSTORE_KBX - (string) - - - - Formato del almacén de claves "KBX". Solo para claves públicas. - Una caja de claves (keybox) es un formato de fichero utilizado para almacenar claves públicas con metadatos e índices. - - - - - - RNP_KEYSTORE_G10 - (string) - - - - Formato del almacén de claves "G10". Para claves privadas. - - - - - - RNP_LOAD_SAVE_PUBLIC_KEYS - (integer) - - - - Carga o guarda solo las claves públicas. Puede ser combinado con RNP_LOAD_SAVE_SECRET_KEYS - para cargar tanto las claves públicas como privadas en el contexto FFI o guardarlas del contexto. - - - - - - RNP_LOAD_SAVE_SECRET_KEYS - (integer) - - - - Carga o guarda solo las claves secretas. Puede ser combinado con RNP_LOAD_SAVE_PUBLIC_KEYS - para cargar tanto las claves públicas como privadas en el contexto FFI o guardarlas del contexto. - - - - - - RNP_LOAD_SAVE_PERMISSIVE - (integer) - - - - Permite ignorar los paquetes de firma/clave/subclave incorrectos durante la importación de claves. - - - - - - RNP_LOAD_SAVE_SINGLE - (integer) - - - - Si se define, solo la primera clave será cargada. - - - - - - RNP_LOAD_SAVE_BASE64 - (integer) - - - - Permite la importación de claves codificadas en base64 (claves autocrypt). - - - - - - RNP_FEATURE_SYMM_ALG - (string) - - - - Lista los algoritmos de cifrado simétrico disponibles. - - - - - - RNP_FEATURE_AEAD_ALG - (string) - - - - Lista los algoritmos AEAD disponibles. - - - - - - RNP_FEATURE_PROT_MODE - (string) - - - - Lista los modos de protección disponibles. - - - - - - RNP_FEATURE_PK_ALG - (string) - - - - Lista los algoritmos de clave pública disponibles. - - - - - - RNP_FEATURE_HASH_ALG - (string) - - - - Lista los algoritmos de hash disponibles. - - - - - - RNP_FEATURE_COMP_ALG - (string) - - - - Lista los algoritmos de compresión disponibles. - - - - - - RNP_FEATURE_CURVE - (string) - - - - Lista las curvas elípticas disponibles. - - - - - - RNP_DUMP_MPI - (integer) - - - - Muestra los valores MPI (enteros multi-precisión). - - - - - - RNP_DUMP_RAW - (integer) - - - - Muestra también el contenido sin tratar del paquete. - - - - - - RNP_DUMP_GRIP - (integer) - - - - Muestra las huellas y los identificadores de clave. - - - - - - RNP_JSON_DUMP_MPI - (integer) - - - - Muestra los valores MPI (enteros multi-precisión). - - - - - - RNP_JSON_DUMP_RAW - (integer) - - - - Muestra también el contenido sin tratar del paquete. - - - - - - RNP_JSON_DUMP_GRIP - (integer) - - - - Muestra las huellas y los identificadores de clave. - - - - - - RNP_ENCRYPT_NOWRAP - (integer) - - - - Permite el cifrado del mensaje firmado. El mensaje no está envuelto - en un paquete de datos literales. - - - - - - RNP_KEY_EXPORT_ARMORED - (integer) - - - - Activa la armadura ASCII de los datos exportados. - - - - - - RNP_KEY_EXPORT_PUBLIC - (integer) - - - - Exporta la clave pública. - - - - - - RNP_KEY_EXPORT_SECRET - (integer) - - - - Exporta la clave secreta. - - - - - - RNP_KEY_EXPORT_SUBKEYS - (integer) - - - - Si la clave principal es exportada, todas las subclaves lo serán también. - - - - - - RNP_KEY_EXPORT_BASE64 - (integer) - - - - Exporta la clave autocrypt codificada en base64 en lugar de binaria. - - - - - - RNP_KEY_REMOVE_PUBLIC - (integer) - - - - Elimina la clave pública. - - - - - - RNP_KEY_REMOVE_SECRET - (integer) - - - - Elimina la clave secreta. - - - - - - RNP_KEY_REMOVE_SUBKEYS - (integer) - - - - Si la clave principal es eliminada, todas las subclaves lo serán también. - - - - - - diff --git a/reference/rnp/examples.xml b/reference/rnp/examples.xml deleted file mode 100644 index 43ac0a8a05..0000000000 --- a/reference/rnp/examples.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - &reftitle.examples; -
    - Texto firmado en claro - - Este ejemplo va a firmar en claro un texto dado. - - - Ejemplo de firma RNP en claro - - -]]> - - -
    -
    - diff --git a/reference/rnp/functions/rnp-backend-string.xml b/reference/rnp/functions/rnp-backend-string.xml deleted file mode 100644 index 69c9f8e024..0000000000 --- a/reference/rnp/functions/rnp-backend-string.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - rnp_backend_string - Devuelve el nombre de la biblioteca back-end de criptografía - - - - &reftitle.description; - - stringrnp_backend_string - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El nombre de la biblioteca back-end de criptografía. Las bibliotecas de criptografía - soportadas son "Botan" y "OpenSSL". - - - - - diff --git a/reference/rnp/functions/rnp-backend-version.xml b/reference/rnp/functions/rnp-backend-version.xml deleted file mode 100644 index 864fcfe101..0000000000 --- a/reference/rnp/functions/rnp-backend-version.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - rnp_backend_version - Devuelve la versión de la biblioteca back-end de criptografía - - - - &reftitle.description; - - stringrnp_backend_version - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La versión en forma de string. - - - - - diff --git a/reference/rnp/functions/rnp-decrypt.xml b/reference/rnp/functions/rnp-decrypt.xml deleted file mode 100644 index 1f641cde71..0000000000 --- a/reference/rnp/functions/rnp-decrypt.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - rnp_decrypt - Desencripta un mensaje PGP - - - - &reftitle.description; - - stringfalsernp_decrypt - RnpFFIffi - stringinput - - - Las claves privadas utilizadas para el desencriptado deben ser cargadas en el objeto FFI antes de llamar a esta función. - Si se ha utilizado el cifrado por contraseña, el proveedor de contraseña debe ser definido llamando a - rnp_ffi_set_pass_provider. - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - input - - - El mensaje cifrado. - - - - - - - - &reftitle.returnvalues; - - El mensaje desencriptado en caso de éxito&return.falseforfailure;. - - - - - diff --git a/reference/rnp/functions/rnp-dump-packets-to-json.xml b/reference/rnp/functions/rnp-dump-packets-to-json.xml deleted file mode 100644 index aeba25cca6..0000000000 --- a/reference/rnp/functions/rnp-dump-packets-to-json.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - rnp_dump_packets_to_json - Muestra la información del flujo de paquetes OpenPGP en un string JSON - - - - &reftitle.description; - - stringfalsernp_dump_packets_to_json - stringinput - intflags - - - - - - - - - &reftitle.parameters; - - - input - - - El string de entrada que contiene los datos OpenPGP, ya sea en formato binario o en formato ASCII-armored. - - - - - flags - - - Ver las constantes predefinidas RNP_JSON_DUMP_*. - - - - - - - - &reftitle.returnvalues; - - Un string JSON con la información&return.falseforfailure; - - - - - diff --git a/reference/rnp/functions/rnp-dump-packets.xml b/reference/rnp/functions/rnp-dump-packets.xml deleted file mode 100644 index 9503b57d86..0000000000 --- a/reference/rnp/functions/rnp-dump-packets.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - rnp_dump_packets - Muestra la información del flujo de paquetes OpenPGP en un formato legible por el ser humano - - - - &reftitle.description; - - stringfalsernp_dump_packets - stringinput - intflags - - - - - - - - - &reftitle.parameters; - - - input - - - La cadena de entrada que contiene los datos OpenPGP, ya sea en formato binario o en formato ASCII-armored. - - - - - flags - - - Ver las constantes predefinidas RNP_DUMP_*. - - - - - - - - &reftitle.returnvalues; - - Un texto que describe la secuencia de paquetes&return.falseforfailure;. - - - - - diff --git a/reference/rnp/functions/rnp-ffi-create.xml b/reference/rnp/functions/rnp-ffi-create.xml deleted file mode 100644 index db23552852..0000000000 --- a/reference/rnp/functions/rnp-ffi-create.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - rnp_ffi_create - Crear un objeto de nivel superior utilizado para interactuar con la biblioteca - - - - &reftitle.description; - - RnpFFIfalsernp_ffi_create - stringpub_format - stringsec_format - - - - - - - - - &reftitle.parameters; - - - pub_format - - - El formato del llavero de claves públicas, RNP_KEYSTORE_GPG o - otra constante RNP_KEYSTORE_*. - - - - - sec_format - - - El formato del llavero de claves secretas, RNP_KEYSTORE_GPG o - otra constante RNP_KEYSTORE_*. - - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto RnpFFI en caso de éxito&return.falseforfailure;. - - - - - diff --git a/reference/rnp/functions/rnp-ffi-destroy.xml b/reference/rnp/functions/rnp-ffi-destroy.xml deleted file mode 100644 index 055f71f2db..0000000000 --- a/reference/rnp/functions/rnp-ffi-destroy.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - rnp_ffi_destroy - Destruye el objeto de nivel superior utilizado para interactuar con la biblioteca - - - - &reftitle.description; - - voidrnp_ffi_destroy - RnpFFIffi - - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - - - - &reftitle.returnvalues; - - - - - - - diff --git a/reference/rnp/functions/rnp-ffi-set-pass-provider.xml b/reference/rnp/functions/rnp-ffi-set-pass-provider.xml deleted file mode 100644 index 901c4b9cc7..0000000000 --- a/reference/rnp/functions/rnp-ffi-set-pass-provider.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - rnp_ffi_set_pass_provider - Define la función de retrollamada del proveedor de contraseña - - - - &reftitle.description; - - boolrnp_ffi_set_pass_provider - RnpFFIffi - callablepassword_callback - - - Define la función de retrollamada del proveedor de contraseña. Esta función puede solicitar la contraseña en una entrada estándar - (si el script PHP se ejecuta en un entorno de línea de comandos), mostrar un cuadro de diálogo GUI o proporcionar - la contraseña de todas las maneras posibles. Las contraseñas solicitadas se utilizan para cifrar o descifrar - las claves secretas o realizar operaciones de cifrado/descifrado simétricas. - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - password_callback - - - La función que debe ser llamada para cada solicitud de contraseña. Tiene la siguiente firma: - - boolpassword_callback - stringkey_fp - stringpgp_context - stringpassword - - - $key_fp - La huella de la clave, si corresponde. Puede estar vacío. - $pgp_context - Cadena que describe por qué se solicita la clave. - $password - Referencia de cadena donde debe almacenarse la contraseña proporcionada. - - La función de retrollamada debe devolver &true; si la contraseña se ha establecido correctamente&return.falseforfailure;. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; en caso de éxito&return.falseforfailure;. - - - - - &reftitle.examples; - - Ejemplo de una función de retrollamada simple - - - - - - - - diff --git a/reference/rnp/functions/rnp-import-keys.xml b/reference/rnp/functions/rnp-import-keys.xml deleted file mode 100644 index 1cad6e3542..0000000000 --- a/reference/rnp/functions/rnp-import-keys.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - rnp_import_keys - Importa claves desde una string PHP hacia el llavero de claves y devuelve un JSON describiendo las claves nuevas o actualizadas - - - - &reftitle.description; - - stringfalsernp_import_keys - RnpFFIffi - stringinput - intflags - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - input - - - Los paquetes OpenPGP que contienen la o las claves a cargar. Puede ser binario o ASCII armored. - - - - - flags - - - Ver las constantes predefinidas RNP_LOAD_SAVE_*. - - - - - - - - &reftitle.returnvalues; - - Una string JSON con la información sobre las claves nuevas y actualizadas en caso de éxito&return.falseforfailure;. - - - - - diff --git a/reference/rnp/functions/rnp-import-signatures.xml b/reference/rnp/functions/rnp-import-signatures.xml deleted file mode 100644 index a35d960e3a..0000000000 --- a/reference/rnp/functions/rnp-import-signatures.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - rnp_import_signatures - Importa firmas autónomas en el llavero de claves y devuelve un JSON que describe las claves actualizadas - - - - &reftitle.description; - - stringfalsernp_import_signatures - RnpFFIffi - stringinput - intflags - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - input - - - Los paquetes OpenPGP que contienen las firmas a importar. Puede ser binario o ASCII armado. - - - - - flags - - - Actualmente debe ser 0. - - - - - - - - &reftitle.returnvalues; - - La cadena JSON con información sobre las claves actualizadas en caso de éxito&return.falseforfailure;. - - - - - diff --git a/reference/rnp/functions/rnp-key-export-autocrypt.xml b/reference/rnp/functions/rnp-key-export-autocrypt.xml deleted file mode 100644 index f7f43205f6..0000000000 --- a/reference/rnp/functions/rnp-key-export-autocrypt.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - rnp_key_export_autocrypt - - Exporta la clave mínima para la funcionalidad autocrypt (solo 5 paquetes: clave, uid, firma, - subclave de cifrado, firma) - - - - - &reftitle.description; - - stringfalsernp_key_export_autocrypt - RnpFFIffi - stringkey_fp - stringsubkey_fp - stringuid - intflags - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - key_fp - - - La huella de la clave primaria. - - - - - subkey_fp - - - La subclave a exportar. Puede ser una string vacía - para elegir la primera subclave apropiada. - - - - - uid - - - El identificador del usuario a exportar. Puede ser una string vacía - si la clave exportada solo tiene un identificador. - - - - - flags - - - Solo RNP_KEY_EXPORT_BASE64 es actualmente soportado. Activarlo - exportará los datos de la clave codificados en base64 en lugar de binario. - - - - - - - - &reftitle.returnvalues; - - Los paquetes OpenPGP de la clave exportada en caso de éxito&return.falseforfailure;. - - - - - diff --git a/reference/rnp/functions/rnp-key-export-revocation.xml b/reference/rnp/functions/rnp-key-export-revocation.xml deleted file mode 100644 index c49f507eb6..0000000000 --- a/reference/rnp/functions/rnp-key-export-revocation.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - rnp_key_export_revocation - Genera y exporta una firma de revocación de clave primaria - - - - &reftitle.description; - - stringfalsernp_key_export_revocation - RnpFFIffi - stringkey_fp - intflags - arrayoptions - - - Notas: para revocar una clave, será necesario importar esta firma en el llavero de claves o utilizar - la función rnp_key_revoke. - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - key_fp - - - La huella de la clave primaria a revocar. - - - - - flags - - - RNP_KEY_EXPORT_ARMORED o 0. - - - - - options - - - Un array asociativo con opciones. - - - - - - Clave - Tipo de datos - &Description; - - - - - "hash" - string - Define el algoritmo de hash utilizado en el cálculo de la firma. - - - "code" - string - Código de razón de la revocación. Valores posibles: 'no', 'superseded', 'compromised', - 'retired'. Si no se define, se utilizará el valor 'no' por omisión. - - - "reason" - string - Representación textual de la razón de la revocación. - - - - - - - - - - - &reftitle.returnvalues; - - Revocación exportada en caso de éxito&return.falseforfailure;. - - - - - diff --git a/reference/rnp/functions/rnp-key-export.xml b/reference/rnp/functions/rnp-key-export.xml deleted file mode 100644 index 472ab331d2..0000000000 --- a/reference/rnp/functions/rnp-key-export.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - rnp_key_export - Exporta una clave - - - - &reftitle.description; - - stringfalsernp_key_export - RnpFFIffi - stringkey_fp - intflags - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - key_fp - - - La huella de la clave. - - - - - flags - - - Ver RNP_KEY_EXPORT_* constantes predefinidas - (excepto RNP_KEY_EXPORT_BASE64). - - - - - - - - &reftitle.returnvalues; - - El paquete OpenPGP exportado de la clave (binario o ASCII-armored) en caso de éxito&return.falseforfailure;. - - - - - diff --git a/reference/rnp/functions/rnp-key-get-info.xml b/reference/rnp/functions/rnp-key-get-info.xml deleted file mode 100644 index e956100a1d..0000000000 --- a/reference/rnp/functions/rnp-key-get-info.xml +++ /dev/null @@ -1,212 +0,0 @@ - - - - - - rnp_key_get_info - Devuelve información sobre la clave - - - - &reftitle.description; - - arrayfalsernp_key_get_info - RnpFFIffi - stringkey_fp - - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - key_fp - - - La huella de la clave. - - - - - - - - &reftitle.returnvalues; - - Un array asociativo con información sobre la clave&return.falseforfailure;. - - - - - - Clave - Tipo de datos - &Description; - - - - - "is_primary" - boolean - - &true; si esta clave es la clave primaria. - - - - "is_sub" - boolean - - &true; si esta clave es una subclave. - - - - "is_valid" - boolean - - &true; si la clave pública es válida. - Esto incluye las verificaciones de auto-firmas, - las fechas de expiración, las revocaciones, etc. - - - - "is_revoked" - boolean - - &true; si esta clave está revocada. - - - - "is_superseded" - boolean - - &true; si esta clave está obsoleta. Presente solo si la clave está revocada. - - - - "is_compromised" - boolean - - &true; si esta clave está comprometida. Presente solo si la clave está revocada. - - - - "is_retired" - boolean - - &true; si esta clave está retirada. Presente solo si la clave está revocada. - - - - "is_expired" - boolean - - &true; si esta clave está expirada. - - - - "have_secret" - boolean - - &true; si esta clave tiene una parte secreta. - - - - "is_locked" - boolean - - &true; si esta clave está actualmente bloqueada. Presente solo para claves secretas. - - - - "is_protected" - boolean - - &true; si esta clave está protegida. Presente solo para claves secretas. - Una clave protegida es una clave que está cifrada y puede ser almacenada de manera segura en memoria - y bloqueada/desbloqueada según sea necesario. - - - - "have_public" - boolean - - &true; si esta clave tiene una parte pública. En general, todas las claves tienen una parte pública. - - - - "valid_till" - integer - - El timestamp hasta el cual la clave puede ser considerada válida. - Nota: esto tendrá en cuenta no solo la expiración de la clave, sino también las revocaciones. - Para la subclave primaria, el tiempo de validez de la clave pública también será verificado. - - - - "bits" - integer - - El número de bits en la clave. Para las claves basadas en EC, esto contendrá el tamaño de la curva. - - - - "alg" - string - - El algoritmo de nombre de clave. - - - - "subkeys" - array - - Un array indexado que contiene información sobre las subclaves. - Puede estar vacío si la clave primaria no tiene subclaves. - - - - "uids" - array - - Un array indexado que contiene información sobre los identificadores de usuario. - Puede estar vacío si la clave primaria no tiene identificadores de usuario. - - - - - - - - - diff --git a/reference/rnp/functions/rnp-key-remove.xml b/reference/rnp/functions/rnp-key-remove.xml deleted file mode 100644 index 1cc85a469b..0000000000 --- a/reference/rnp/functions/rnp-key-remove.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - rnp_key_remove - Elimina una clave de los llaveros - - - - &reftitle.description; - - boolrnp_key_remove - RnpFFIffi - stringkey_fp - intflags - - - Nota: es necesario llamar a rnp_save_keys para escribir los llaveros actualizados. - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - key_fp - - - La huella de la clave. - - - - - flags - - - Ver RNP_KEY_REMOVE_* constantes predefinidas. El flag - RNP_KEY_REMOVE_SUBKEYS solo funcionará para - la clave principal y eliminará también todas sus subclaves. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; en caso de éxito&return.falseforfailure;. - - - - - diff --git a/reference/rnp/functions/rnp-key-revoke.xml b/reference/rnp/functions/rnp-key-revoke.xml deleted file mode 100644 index f72988b649..0000000000 --- a/reference/rnp/functions/rnp-key-revoke.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - rnp_key_revoke - Elimina una clave o una subclave generando y añadiendo una firma de revocación - - - - &reftitle.description; - - boolrnp_key_revoke - RnpFFIffi - stringkey_fp - intflags - arrayoptions - - - Nota: es necesario llamar a rnp_save_keys para escribir los ficheros de claves actualizados. - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - key_fp - - - La huella de la clave. - - - - - flags - - - Actualmente debe ser 0. - - - - - options - - - Un array asociativo con opciones. - - - - - - Clave - Tipo de datos - &Description; - - - - - "hash" - string - Define el algoritmo de hash utilizado durante el cálculo de la firma. - - - "code" - string - El código de revocación de la clave. Los valores posibles son 'no', 'superseded', 'compromised', 'retired'. - Si no se define, se utilizará el valor 'no' por omisión. - - - "reason" - string - Representación textual de la razón de la revocación. - - - - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; en caso de éxito&return.falseforfailure;. - - - - - diff --git a/reference/rnp/functions/rnp-list-keys.xml b/reference/rnp/functions/rnp-list-keys.xml deleted file mode 100644 index c8d4981de5..0000000000 --- a/reference/rnp/functions/rnp-list-keys.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - rnp_list_keys - Enumera todas las claves presentes en un llavero de claves por tipo de identificador especificado - - - - &reftitle.description; - - arrayfalsernp_list_keys - RnpFFIffi - stringidentifier_type - - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - identifier_type - - - La clave de tipo de identificador ("userid", "keyid", "grip", "fingerprint"). - - - - - - - - &reftitle.returnvalues; - - Un array asociativo donde la clave es un string de identificador y el valor es una huella de clave PGP&return.falseforfailure;. - - - - - diff --git a/reference/rnp/functions/rnp-load-keys-from-path.xml b/reference/rnp/functions/rnp-load-keys-from-path.xml deleted file mode 100644 index 046d4b27b0..0000000000 --- a/reference/rnp/functions/rnp-load-keys-from-path.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - rnp_load_keys_from_path - Carga claves a partir de la ruta especificada - - - - &reftitle.description; - - boolrnp_load_keys_from_path - RnpFFIffi - stringformat - stringinput_path - intflags - - - Es importante señalar que para G10, la entrada debe ser un directorio (que ya debe existir). - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - format - - - &rnp.parameter.key-format; - - - - - input_path - - - El fichero o directorio que contiene las claves. - - - - - flags - - - &rnp.parameter.loadsave-flags; - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; en caso de éxito&return.falseforfailure;. - - - - - diff --git a/reference/rnp/functions/rnp-load-keys.xml b/reference/rnp/functions/rnp-load-keys.xml deleted file mode 100644 index 359ae31c48..0000000000 --- a/reference/rnp/functions/rnp-load-keys.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - rnp_load_keys - Carga las claves a partir de un string PHP - - - - &reftitle.description; - - boolrnp_load_keys - RnpFFIffi - stringformat - stringinput - intflags - - - Se debe tener en cuenta que para G10, la entrada debe ser un directorio (que ya debe existir). - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - format - - - &rnp.parameter.key-format; - - - - - input - - - Los paquetes OpenPGP que contienen la o las claves a cargar. Puede ser binario o ASCII armored. - - - - - flags - - - &rnp.parameter.loadsave-flags; - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; en caso de éxito&return.falseforfailure; - - - - - diff --git a/reference/rnp/functions/rnp-locate-key.xml b/reference/rnp/functions/rnp-locate-key.xml deleted file mode 100644 index 74de83bf49..0000000000 --- a/reference/rnp/functions/rnp-locate-key.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - rnp_locate_key - Búsqueda de la clave - - - - &reftitle.description; - - stringfalsernp_locate_key - RnpFFIffi - stringidentifier_type - stringidentifier - - - Nota: los identificadores válidos se verifican durante la búsqueda por identificador. - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - identifier_type - - - Cadena de tipo de identificador: "userid", "keyid", "fingerprint", "grip". - - - - - identifier - - - El identificador del usuario OpenPGP (nombre y correo electrónico) para el tipo "userid", cadena hexadecimal - que representa el identificador de clave, la huella digital o el grip de clave correspondiente. - - - - - - - - &reftitle.returnvalues; - - Devuelve la huella digital hexadecimal de la clave encontrada en caso de éxito&return.falseforfailure;. - - - - - diff --git a/reference/rnp/functions/rnp-op-encrypt.xml b/reference/rnp/functions/rnp-op-encrypt.xml deleted file mode 100644 index 3559d87b44..0000000000 --- a/reference/rnp/functions/rnp-op-encrypt.xml +++ /dev/null @@ -1,188 +0,0 @@ - - - - - - rnp_op_encrypt - Cifra un mensaje - - - - &reftitle.description; - - stringfalsernp_op_encrypt - RnpFFIffi - stringmessage - arrayrecipient_keys_fp - arrayoptions - - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - message - - - El mensaje a cifrar. - - - - - recipient_keys_fp - - - Un array con las huellas de las claves del destinatario. Al menos una clave debe estar presente. - - - - - options - - - Un array asociativo con opciones. - - - - - - Clave - Tipo de dato - &Description; - - - - - "compression_alg" - string - Algoritmo de compresión. Las opciones - "compression_alg" y "compression_level" deben estar ambas definidas - para activar la compresión de los datos. - - - - "compression_level" - integer - El nivel de compresión, de 0 a 9. 0 desactiva la compresión. - - - "armor" - boolean - Activa la salida ASCII armada. Desactivada por omisión. - - - "add_signature" - boolean - El mensaje cifrado será también firmado. - - - "hash" - string - Define el algoritmo de hash utilizado en el cálculo de la firma. La opción "add_signature" debe estar definida a &true;. - - - "creation_time" - integer - Define la hora de creación de la firma en segundos desde el 1 de enero de 1970 UTC. Por omisión, se utiliza la hora actual. - - - "expiration_time" - integer - Define el tiempo de expiración de la firma en segundos desde la hora de creación. El valor 0 se utiliza para marcar - la firma como no expirante (valor por omisión). - - - "password" - string - Añade una contraseña utilizada para cifrar los datos. - - - "cipher" - string - - Define el algoritmo de cifrado simétrico. Los valores posibles son "IDEA", "TRIPLEDES", - "CAST5", "BLOWFISH", "AES128", "AES192", "AES256", "TWOFISH", "CAMELLIA128", - "CAMELLIA192", "CAMELLIA256", "SM4". - - - - "aead" - string - - Define el algoritmo de modo AEAD. Los valores posibles son "None" para desactivar AEAD, "EAX", "OCB". - - - - "aead_bits" - integer - Define la longitud del chunk para el modo AEAD en número de bits de tamaño de chunk. Debe estar comprendido entre 0 y 56. - - - "flags" - integer - - Define indicadores de cifrado adicionales. Los indicadores soportados son: RNP_ENCRYPT_NOWRAP - no envolver - los datos en un paquete de datos literales. Esto permitiría cifrar datos ya firmados. - - - - "file_name" - string - Define el nombre de fichero almacenado internamente para los datos cifrados. El valor especial _CONSOLE puede ser utilizado para marcar - el mensaje como "para sus ojos solamente", es decir, que no debe ser almacenado en ningún lugar sino solo mostrado - al destinatario. Por omisión, es una cadena vacía. - - - "file_mtime" - integer - Define la fecha de modificación del fichero de entrada en segundos desde el 1 de enero de 1970 UTC. - - - - - - - - - - - &reftitle.returnvalues; - - Los datos cifrados en caso de éxito&return.falseforfailure;. - - - - - diff --git a/reference/rnp/functions/rnp-op-generate-key.xml b/reference/rnp/functions/rnp-op-generate-key.xml deleted file mode 100644 index f798a79cf1..0000000000 --- a/reference/rnp/functions/rnp-op-generate-key.xml +++ /dev/null @@ -1,171 +0,0 @@ - - - - - - rnp_op_generate_key - Genera una clave - - - - &reftitle.description; - - stringfalsernp_op_generate_key - RnpFFIffi - stringuserid - stringkey_alg - stringsub_alg - arrayoptions - - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - userid - - - El identificador del usuario PGP - texto que debe representar - el nombre y la dirección de correo electrónico del titular de la clave. - - - - - key_alg - - - La clave del algoritmo (es decir, 'RSA', 'DSA', etc). - - - - - sub_alg - - - El algoritmo de subclave. Si no está definido, la subclave no será generada. - - - - - options - - - Un array asociativo con opciones. - - - - - - Clave - Tipo de datos - &Description; - - - - - "bits" - integer - El tamaño de la clave principal en bits. Aplicable únicamente a las claves RSA, DSA y El-Gamal. - - - "hash" - string - Algoritmo de hash utilizado en la firma de la clave o la firma de ligadura de subclave. - - - "dsa_qbits" - integer - Define el tamaño de un parámetro q para la clave DSA. - Nota: se definirá un valor predeterminado adecuado, según el número de bits de la clave. Sin embargo, puede - ser reemplazado si es necesario. - - - "curve" - string - Define la curva utilizada para la clave ECC. Nota: esto se aplica únicamente a las claves ECDSA, ECDH y SM2. - - - "request_password" - boolean - Activa la solicitud de contraseña a través del proveedor de contraseñas. Esta contraseña - será utilizada para el cifrado de la clave. La función de retrollamada del proveedor de contraseñas debe ser definida previamente - llamando a rnp_ffi_set_pass_provider. - Nota: este parámetro será ignorado si la contraseña ha sido definida a través de "password" - - - "password" - string - Define la contraseña utilizada para cifrar los datos de la clave secreta. - - - "expiration" - integer - Define el tiempo de expiración de la clave principal y la subclave en segundos. - - - "sub_bits" - integer - El tamaño de la subclave en bits. Aplicable únicamente a las claves RSA, DSA y El-Gamal. - - - "sub_hash" - string - Algoritmo de hash utilizado en la firma de la subclave o la firma de ligadura de subclave. - - - "sub_curve" - string - Define la curva utilizada para la subclave ECC. Nota: esto se aplica únicamente a las claves ECDSA, ECDH y SM2. - - - - - - - - - - - &reftitle.returnvalues; - - La huella de la clave principal generada&return.falseforfailure;. Esta huella puede ser utilizada - más tarde para referenciar la clave en las operaciones de firma y cifrado. Los datos de la clave se almacenan en el contexto de memoria - FFI y pueden ser guardados utilizando - rnp_save_keys o rnp_save_keys_to_path. - - - - - diff --git a/reference/rnp/functions/rnp-op-sign-cleartext.xml b/reference/rnp/functions/rnp-op-sign-cleartext.xml deleted file mode 100644 index 4f72e1564d..0000000000 --- a/reference/rnp/functions/rnp-op-sign-cleartext.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - rnp_op_sign_cleartext - Realiza una operación de firma sobre datos textuales, devuelve el mensaje firmado en claro - - - - &reftitle.description; - - stringfalsernp_op_sign_cleartext - RnpFFIffi - stringdata - arraykeys_fp - arrayoptions - - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - data - - - Los datos a firmar. - - - - - keys_fp - - - El array con las huellas de las claves. Al menos una clave debe ser proporcionada. - Las claves deben estar presentes en ffi. - - - - - options - - - Un array asociativo con opciones. - - - - - - Clave - Tipo de dato - &Description; - - - - - "armor" - boolean - Activa la salida ASCII armada. Desactivado por omisión. - - - "hash" - string - Define el algoritmo de hash utilizado durante el cálculo de la firma. - - - "creation_time" - integer - Define la hora de creación de la firma en segundos desde el 1 de enero de 1970 UTC. Por omisión, se utiliza la hora actual. - - - "expiration_time" - integer - Define el tiempo de expiración de la firma en segundos desde la hora de creación. El valor 0 se utiliza para marcar - la firma como no expirada (valor por omisión). - - - - - - - - - - - &reftitle.returnvalues; - - El mensaje firmado en claro que contiene los datos fuente con - encabezados adicionales y la firma ASCII-armored en caso de éxito&return.falseforfailure;. - - - - - diff --git a/reference/rnp/functions/rnp-op-sign-detached.xml b/reference/rnp/functions/rnp-op-sign-detached.xml deleted file mode 100644 index 7f673235c1..0000000000 --- a/reference/rnp/functions/rnp-op-sign-detached.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - rnp_op_sign_detached - Realiza una operación de firma, devuelve la firma desvinculada - - - - &reftitle.description; - - stringfalsernp_op_sign_detached - RnpFFIffi - stringdata - arraykeys_fp - arrayoptions - - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - data - - - Los datos a firmar. - - - - - keys_fp - - - Un array con las huellas de las claves. Al menos una clave debe ser proporcionada. - Las claves deben estar presentes en ffi. - - - - - options - - - Un array asociativo con opciones. - - - - - - Clave - Tipo de dato - &Description; - - - - - "armor" - boolean - Activa la salida ASCII-armored. Desactivado por omisión. - - - "hash" - string - Define el algoritmo de hash utilizado durante el cálculo de la firma. - - - "creation_time" - integer - Define la hora de creación de la firma en segundos desde el 1 de enero de 1970 UTC. Por omisión, se utiliza la hora actual. - - - "expiration_time" - integer - Define el tiempo de expiración de la firma en segundos desde la hora de creación. El valor 0 se utiliza - para marcar la firma como no expirada (valor por omisión). - - - - - - - - - - - &reftitle.returnvalues; - - Los datos de firma(s) desvinculados en caso de éxito&return.falseforfailure;. - - - - - diff --git a/reference/rnp/functions/rnp-op-sign.xml b/reference/rnp/functions/rnp-op-sign.xml deleted file mode 100644 index fd95f9c0d5..0000000000 --- a/reference/rnp/functions/rnp-op-sign.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - rnp_op_sign - Realiza una operación de firma sobre datos binarios, devuelve la o las firmas integradas - - - - &reftitle.description; - - stringfalsernp_op_sign - RnpFFIffi - stringdata - arraykeys_fp - arrayoptions - - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - data - - - Datos a firmar. - - - - - keys_fp - - - Un array con las huellas de las claves. Al menos una clave debe ser proporcionada. - Las claves deben estar presentes en ffi. - - - - - options - - - Un array asociativo con opciones. - - - - - - Clave - Tipo de datos - &Description; - - - - - "compression_alg" - string - Algoritmo de compresión. Las opciones - "compression_alg" y "compression_level" - deben ser ambas definidas para activar la compresión de datos. - - - - "compression_level" - integer - Nivel de compresión, 0-9. 0 desactiva la compresión. - - - "armor" - boolean - Activa la salida ASCII armada. Desactivado por omisión. - - - "hash" - string - Define el algoritmo de hash utilizado en el cálculo de la firma. - - - "creation_time" - integer - Define la hora de creación de la firma en segundos desde el 1 de enero de 1970 UTC. Por omisión, se utiliza la hora actual. - - - "expiration_time" - integer - Define el tiempo de expiración de la firma en segundos desde la hora de creación. El valor 0 se utiliza - para marcar la firma como no expirante (valor por omisión). - - - "file_name" - string - Define el nombre del fichero de entrada. El valor especial _CONSOLE puede ser utilizado para marcar el mensaje - como 'para sus ojos solamente', es decir, que no debe ser almacenado en ningún lugar sino solo mostrado - al destinatario. Por omisión, es una cadena vacía. - - - "file_mtime" - integer - Define la fecha de modificación del fichero de entrada en segundos desde el 1 de enero de 1970 UTC. - - - - - - - - - - - &reftitle.returnvalues; - - Los datos firmados con la(s) firma(s) integrada en caso de éxito&return.falseforfailure;. - - - - - diff --git a/reference/rnp/functions/rnp-op-verify-detached.xml b/reference/rnp/functions/rnp-op-verify-detached.xml deleted file mode 100644 index f03f3e8822..0000000000 --- a/reference/rnp/functions/rnp-op-verify-detached.xml +++ /dev/null @@ -1,189 +0,0 @@ - - - - - - rnp_op_verify_detached - Verifica las firmas desvinculadas - - - - &reftitle.description; - - arrayfalsernp_op_verify_detached - RnpFFIffi - stringdata - stringsignature - - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - data - - - Los datos fuente. - - - - - signature - - - Los datos de firma desvinculada. - - - - - - - - &reftitle.returnvalues; - - Un array asociativo con información sobre los resultados de la verificación&return.falseforfailure;. - - - - - - Clave - Tipo de datos - &Description; - - - - - "verification_status" - string - - Los resultados de la verificación global, ya sea la cadena "Success" o un mensaje de error apropiado. - El resultado "Success" se define cuando al menos una firma es válida y verificada con éxito. - Los resultados de verificación individuales para cada firma pueden ser verificados en el array "signatures". - - - - "file_name" - string - Nombre del fichero. - - - "file_mtime" - integer - Hora de modificación del fichero. - - - "mode" - string - Modo de protección de los datos (cifrado) utilizado en el mensaje procesado. - Los valores actualmente definidos son "none", "cfb", "cfb-mdc", "aead-ocb", "aead-eax". - - - - "cipher" - string - Algoritmo de cifrado simétrico utilizado para el cifrado de los datos. - - - "valid_integrity" - boolean - &true; si la protección de la integridad del mensaje ha sido utilizada (es decir, MDC o AEAD) y ha sido - validada con éxito. - - - - "signatures" - array - - Un array asociativo que describe cada firma encontrada. Ver la descripción a continuación. - - - - - - - Un subarray "signatures". - - - - - - Clave - Tipo de datos - &Description; - - - - - "verification_status" - string - Estado de verificación de la firma, ya sea la cadena "Success" o un mensaje de error apropiado. - - - "creation_time" - integer - Hora de creación de la firma en segundos desde el 1 de enero de 1970 UTC. - - - "expiration_time" - integer - Tiempo de expiración de la firma en segundos desde la hora de creación o 0 si la firma no expira nunca. - - - "hash" - string - Algoritmo de hash utilizado para calcular la firma. - - - "signing_key" - string - La huella de la clave utilizada para firmar. Puede ser "Not found" si la clave pública correspondiente no está cargada en el objeto FFI. - - - "signature_type" - string - - El tipo de firma. Los valores actualmente definidos son "binary", "text", "standalone", "certification (generic)", "certification (persona)", - "certification (casual)", "certification (positive)", "subkey binding", "primary key binding", "direct", "key revocation", - "subkey revocation", "certification revocation", "timestamp", "unknown: 0..255". - - - - - - - - - diff --git a/reference/rnp/functions/rnp-op-verify.xml b/reference/rnp/functions/rnp-op-verify.xml deleted file mode 100644 index bb95c14ccc..0000000000 --- a/reference/rnp/functions/rnp-op-verify.xml +++ /dev/null @@ -1,180 +0,0 @@ - - - - - - rnp_op_verify - Verifica las firmas integradas o en claro - - - - &reftitle.description; - - arrayfalsernp_op_verify - RnpFFIffi - stringdata - - - - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - data - - - Los datos firmados. - - - - - - - - &reftitle.returnvalues; - - Un array asociativo con información sobre los resultados de la verificación&return.falseforfailure;. - - - - - - Clave - Tipo de datos - &Description; - - - - - "verification_status" - string - - Resultados de la verificación global, ya sea la cadena "Success" o un mensaje de error apropiado. - El resultado "Success" se define cuando al menos una firma es válida y se verifica con éxito. - El resultado de la verificación individual para cada firma puede ser verificado en el array "signatures". - - - - "file_name" - string - El nombre del fichero. - - - "file_mtime" - integer - Hora de modificación del fichero. - - - "mode" - string - Modo de protección de los datos (cifrado) utilizado en el mensaje procesado. - Los valores actualmente definidos son "none", "cfb", "cfb-mdc", "aead-ocb", "aead-eax". - - - - "cipher" - string - Cifrado simétrico utilizado para el cifrado de los datos. - - - "valid_integrity" - boolean - &true; si la protección de la integridad del mensaje ha sido utilizada (es decir, MDC o AEAD) y ha sido - validada con éxito. - - - - "signatures" - array - - Un array asociativo que describe cada firma encontrada. Ver la descripción a continuación. - - - - - - - El subarray "signatures". - - - - - - Clave - Tipo de datos - &Description; - - - - - "verification_status" - string - Estado de verificación de la firma, ya sea la cadena "Success" o un mensaje de error apropiado. - - - "creation_time" - integer - Hora de creación de la firma en segundos desde el 1 de enero de 1970 UTC. - - - "expiration_time" - integer - El tiempo de expiración de la firma en segundos desde el tiempo de creación o 0 si la firma no expira nunca. - - - "hash" - string - Algoritmo de hash utilizado para calcular la firma. - - - "signing_key" - string - La huella de la clave utilizada para firmar. Puede ser "Not found" si la clave pública correspondiente no está cargada en el objeto FFI. - - - "signature_type" - string - - El tipo de firma. Los valores actualmente definidos son "binary", "text", "standalone", "certification (generic)", "certification (persona)", - "certification (casual)", "certification (positive)", "subkey binding", "primary key binding", "direct", "key revocation", - "subkey revocation", "certification revocation", "timestamp", "uknown: 0..255". - - - - - - - - - diff --git a/reference/rnp/functions/rnp-save-keys-to-path.xml b/reference/rnp/functions/rnp-save-keys-to-path.xml deleted file mode 100644 index a6cb19a060..0000000000 --- a/reference/rnp/functions/rnp-save-keys-to-path.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - rnp_save_keys_to_path - Guarda las claves en la ruta especificada - - - - &reftitle.description; - - boolrnp_save_keys_to_path - RnpFFIffi - stringformat - stringoutput_path - intflags - - - Guarda las claves presentes en el objeto FFI (cargadas o generadas) en el fichero o directorio especificado. - - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - format - - - &rnp.parameter.key-format; - - - - - output_path - - - La ruta del fichero o directorio donde las claves deben ser guardadas. - - - - - flags - - - &rnp.parameter.loadsave-flags; - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; en caso de éxito&return.falseforfailure;. - - - - - diff --git a/reference/rnp/functions/rnp-save-keys.xml b/reference/rnp/functions/rnp-save-keys.xml deleted file mode 100644 index 4ecdf12ca4..0000000000 --- a/reference/rnp/functions/rnp-save-keys.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - rnp_save_keys - Guarda las claves en una string PHP - - - - &reftitle.description; - - boolrnp_save_keys - RnpFFIffi - stringformat - stringoutput - intflags - - - Se debe tener en cuenta que para G10, la salida debe ser un directorio (que ya debe existir). - - - - - &reftitle.parameters; - - - ffi - - - &rnp.parameter.ffi-description; - - - - - format - - - &rnp.parameter.key-format; - - - - - output - - - Los paquetes de claves se guardarán en la string referenciada por output. - - - - - flags - - - &rnp.parameter.loadsave-flags; - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; en caso de éxito&return.falseforfailure;. - - - - - diff --git a/reference/rnp/functions/rnp-supported-features.xml b/reference/rnp/functions/rnp-supported-features.xml deleted file mode 100644 index 1ef423d7d2..0000000000 --- a/reference/rnp/functions/rnp-supported-features.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - rnp_supported_features - Devuelve las funcionalidades soportadas en formato JSON - - - - &reftitle.description; - - stringfalsernp_supported_features - stringtype - - - Devuelve el formato JSON que contiene un array de los valores de funcionalidades rnp soportadas (algoritmos, curvas, etc.) por tipo. - - - - - - &reftitle.parameters; - - - type - - - Ver las constantes RNP_FEATURE_* para los valores soportados. - - - - - - - - &reftitle.returnvalues; - - Un string que contiene un array formateado en JSON de los algoritmos, curvas, etc. soportados&return.falseforfailure;. - - - - - diff --git a/reference/rnp/functions/rnp-version-string-full.xml b/reference/rnp/functions/rnp-version-string-full.xml deleted file mode 100644 index f39e4cbe49..0000000000 --- a/reference/rnp/functions/rnp-version-string-full.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - rnp_version_string_full - La cadena de versión completa de la biblioteca RNP - - - - &reftitle.description; - - stringrnp_version_string_full - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la cadena de versión completa de la biblioteca RNP. - - - - - diff --git a/reference/rnp/functions/rnp-version-string.xml b/reference/rnp/functions/rnp-version-string.xml deleted file mode 100644 index d3eb4796b0..0000000000 --- a/reference/rnp/functions/rnp-version-string.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - rnp_version_string - La versión de la biblioteca RNP - - - - &reftitle.description; - - stringrnp_version_string - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el string de versión de la biblioteca RNP. - - - - - diff --git a/reference/rnp/reference.xml b/reference/rnp/reference.xml deleted file mode 100644 index 711736e375..0000000000 --- a/reference/rnp/reference.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - &Functions; de Rnp - - &reference.rnp.entities.functions; - - - diff --git a/reference/rnp/rnpffi.xml b/reference/rnp/rnpffi.xml deleted file mode 100644 index 657fc440c0..0000000000 --- a/reference/rnp/rnpffi.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - La clase RnpFFI - RnpFFI - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - RnpFFI - - - - - RnpFFI - - - - - - - -
    - -
    - -
    - diff --git a/reference/rnp/setup.xml b/reference/rnp/setup.xml deleted file mode 100644 index f965b28f6d..0000000000 --- a/reference/rnp/setup.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Para utilizar las funciones de la biblioteca RNP, es necesario instalar la - biblioteca RNP. La versión de la - biblioteca RNP debe ser >= 0.16.2. - -
    - - &reference.rnp.configure; - -
    - diff --git a/reference/rpminfo/book.xml b/reference/rpminfo/book.xml deleted file mode 100644 index 728e41b656..0000000000 --- a/reference/rpminfo/book.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - RpmInfo - RpmInfo - - - &reftitle.intro; - - Esta extensión permite recuperar información a partir de ficheros RPM - o de la base de datos de los RPM instalados. - - - Asimismo proporciona una envoltura de flujo rpm para recuperar el contenido de los RPM - (desde la versión 1.0.0 con librpm >= 4.13). - - - - &reference.rpminfo.setup; - &reference.rpminfo.constants; - &reference.rpminfo.reference; - - - - diff --git a/reference/rpminfo/constants.xml b/reference/rpminfo/constants.xml deleted file mode 100644 index 6ccbc19296..0000000000 --- a/reference/rpminfo/constants.xml +++ /dev/null @@ -1,2938 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - Constantes diversas - - - RPMVERSION - (string) - - - - La versión de la biblioteca RPM. - - - - - - - RPM Senses - - - RPMSENSE_ANY - (int) - - - - - - - - - RPMSENSE_LESS - (int) - - - - - - - - - RPMSENSE_GREATER - (int) - - - - - - - - - RPMSENSE_EQUAL - (int) - - - - - - - - - RPMSENSE_POSTTRANS - (int) - - - - - - - - - RPMSENSE_PREREQ - (int) - - - - - - - - - RPMSENSE_PRETRANS - (int) - - - - - - - - - RPMSENSE_INTERP - (int) - - - - - - - - - RPMSENSE_SCRIPT_PRE - (int) - - - - - - - - - RPMSENSE_SCRIPT_POST - (int) - - - - - - - - - RPMSENSE_SCRIPT_PREUN - (int) - - - - - - - - - RPMSENSE_SCRIPT_POSTUN - (int) - - - - - - - - - RPMSENSE_SCRIPT_VERIFY - (int) - - - - - - - - - RPMSENSE_FIND_REQUIRES - (int) - - - - - - - - - RPMSENSE_FIND_PROVIDES - (int) - - - - - - - - - RPMSENSE_TRIGGERIN - (int) - - - - - - - - - RPMSENSE_TRIGGERUN - (int) - - - - - - - - - RPMSENSE_TRIGGERPOSTUN - (int) - - - - - - - - - RPMSENSE_MISSINGOK - (int) - - - - - - - - - RPMSENSE_RPMLIB - (int) - - - - - - - - - RPMSENSE_TRIGGERPREIN - (int) - - - - - - - - - RPMSENSE_KEYRING - (int) - - - - - - - - - RPMSENSE_CONFIG - (int) - - - - - - - - - - RPM Mire - - - RPMMIRE_DEFAULT - (int) - - - - Modelo de búsqueda en una expresión regular con - \., .*, - y ^...$ añadidos. - - - - - - RPMMIRE_STRCMP - (int) - - - - El modelo de búsqueda es una string, - utilizando strcmp(3). - - - - - - RPMMIRE_REGEX - (int) - - - - El modelo de búsqueda es una expresión regular, - utilizando regcomp(3). - - - - - - RPMMIRE_GLOB - (int) - - - - El modelo de búsqueda es una expresión global, - utilizando fnmatch(3). - - - - - - - RPM tags - - - RPMTAG_ARCH - (int) - - - - - - - - - RPMTAG_ARCHSUFFIX - (int) - - - - Requiere librpm >= 4.18 - - - - - - RPMTAG_ARCHIVESIZE - (int) - - - - - - - - - RPMTAG_BASENAMES - (int) - - - - El nombre (no la ruta) de los ficheros, con el índice de la base de datos. - - - - - - RPMTAG_BUGURL - (int) - - - - - - - - - RPMTAG_BUILDARCHS - (int) - - - - - - - - - RPMTAG_BUILDHOST - (int) - - - - - - - - - RPMTAG_BUILDTIME - (int) - - - - - - - - - RPMTAG_C - (int) - - - - - - - - - RPMTAG_CHANGELOGNAME - (int) - - - - - - - - - RPMTAG_CHANGELOGTEXT - (int) - - - - - - - - - RPMTAG_CHANGELOGTIME - (int) - - - - - - - - - RPMTAG_CLASSDICT - (int) - - - - - - - - - RPMTAG_CONFLICTFLAGS - (int) - - - - - - - - - RPMTAG_CONFLICTNAME - (int) - - - - Dependencias conflictivas, con el índice de la base de datos. - - - - - - RPMTAG_CONFLICTNEVRS - (int) - - - - - - - - - RPMTAG_CONFLICTS - (int) - - - - - - - - - RPMTAG_CONFLICTVERSION - (int) - - - - - - - - - RPMTAG_COOKIE - (int) - - - - - - - - - RPMTAG_DBINSTANCE - (int) - - - - - - - - - RPMTAG_DEPENDSDICT - (int) - - - - - - - - - RPMTAG_DESCRIPTION - (int) - - - - - - - - - RPMTAG_DIRINDEXES - (int) - - - - - - - - - RPMTAG_DIRNAMES - (int) - - - - El directorio de los ficheros, con el índice de la base de datos. - - - - - - RPMTAG_DISTRIBUTION - (int) - - - - - - - - - RPMTAG_DISTTAG - (int) - - - - - - - - - RPMTAG_DISTURL - (int) - - - - - - - - - RPMTAG_DSAHEADER - (int) - - - - - - - - - RPMTAG_E - (int) - - - - - - - - - RPMTAG_ENCODING - (int) - - - - - - - - - RPMTAG_ENHANCEFLAGS - (int) - - - - - - - - - RPMTAG_ENHANCENAME - (int) - - - - Dependencia débil, con el índice de la base de datos, requiere librpm >= 4.13. - - - - - - RPMTAG_ENHANCENEVRS - (int) - - - - - - - - - RPMTAG_ENHANCES - (int) - - - - - - - - - RPMTAG_ENHANCEVERSION - (int) - - - - - - - - - RPMTAG_EPOCH - (int) - - - - - - - - - RPMTAG_EPOCHNUM - (int) - - - - - - - - - RPMTAG_EVR - (int) - - - - - - - - - RPMTAG_EXCLUDEARCH - (int) - - - - - - - - - RPMTAG_EXCLUDEOS - (int) - - - - - - - - - RPMTAG_EXCLUSIVEARCH - (int) - - - - - - - - - RPMTAG_EXCLUSIVEOS - (int) - - - - - - - - - RPMTAG_FILECAPS - (int) - - - - - - - - - RPMTAG_FILECLASS - (int) - - - - - - - - - RPMTAG_FILECOLORS - (int) - - - - - - - - - RPMTAG_FILECONTEXTS - (int) - - - - - - - - - RPMTAG_FILEDEPENDSN - (int) - - - - - - - - - RPMTAG_FILEDEPENDSX - (int) - - - - - - - - - RPMTAG_FILEDEVICES - (int) - - - - - - - - - RPMTAG_FILEDIGESTALGO - (int) - - - - - - - - - RPMTAG_FILEDIGESTS - (int) - - - - - - - - - RPMTAG_FILEFLAGS - (int) - - - - - - - - - RPMTAG_FILEGROUPNAME - (int) - - - - - - - - - RPMTAG_FILEINODES - (int) - - - - - - - - - RPMTAG_FILELANGS - (int) - - - - - - - - - RPMTAG_FILELINKTOS - (int) - - - - - - - - - RPMTAG_FILEMD5S - (int) - - - - - - - - - RPMTAG_FILEMODES - (int) - - - - - - - - - RPMTAG_FILEMTIMES - (int) - - - - - - - - - RPMTAG_FILENAMES - (int) - - - - - - - - - RPMTAG_FILENLINKS - (int) - - - - - - - - - RPMTAG_FILEPROVIDE - (int) - - - - - - - - - RPMTAG_FILERDEVS - (int) - - - - - - - - - RPMTAG_FILEREQUIRE - (int) - - - - - - - - - RPMTAG_FILESIGNATURELENGTH - (int) - - - - - - - - - RPMTAG_FILESIGNATURES - (int) - - - - - - - - - RPMTAG_FILESIZES - (int) - - - - - - - - - RPMTAG_FILESTATES - (int) - - - - - - - - - RPMTAG_FILETRIGGERCONDS - (int) - - - - - - - - - RPMTAG_FILETRIGGERFLAGS - (int) - - - - - - - - - RPMTAG_FILETRIGGERINDEX - (int) - - - - - - - - - RPMTAG_FILETRIGGERNAME - (int) - - - - El nombre del fichero desencadenante, con el índice de la base de datos, requiere librpm >= 4.13. - - - - - - RPMTAG_FILETRIGGERPRIORITIES - (int) - - - - - - - - - RPMTAG_FILETRIGGERSCRIPTFLAGS - (int) - - - - - - - - - RPMTAG_FILETRIGGERSCRIPTPROG - (int) - - - - - - - - - RPMTAG_FILETRIGGERSCRIPTS - (int) - - - - - - - - - RPMTAG_FILETRIGGERTYPE - (int) - - - - - - - - - RPMTAG_FILETRIGGERVERSION - (int) - - - - - - - - - RPMTAG_FILEUSERNAME - (int) - - - - - - - - - RPMTAG_FILEVERIFYFLAGS - (int) - - - - - - - - - RPMTAG_FSCONTEXTS - (int) - - - - - - - - - RPMTAG_GIF - (int) - - - - - - - - - RPMTAG_GROUP - (int) - - - - El grupo de paquete, con el índice de la base de datos. - - - - - - RPMTAG_HDRID - (int) - - - - Obsoleto, utilizar RPMTAG_SHA1HEADER en su lugar. Eliminado en librpm 6. - - - - - - RPMTAG_HEADERCOLOR - (int) - - - - - - - - - RPMTAG_HEADERI18NTABLE - (int) - - - - - - - - - RPMTAG_HEADERIMAGE - (int) - - - - - - - - - RPMTAG_HEADERIMMUTABLE - (int) - - - - - - - - - RPMTAG_HEADERREGIONS - (int) - - - - - - - - - RPMTAG_HEADERSIGNATURES - (int) - - - - - - - - - RPMTAG_ICON - (int) - - - - - - - - - RPMTAG_INSTALLCOLOR - (int) - - - - - - - - - RPMTAG_INSTALLTID - (int) - - - - El identificador de transacción de instalación, con el índice de la base de datos. - - - - - - RPMTAG_INSTALLTIME - (int) - - - - - - - - - RPMTAG_INSTFILENAMES - (int) - - - - La ruta de los ficheros, con el índice de la base de datos. - - - - - - RPMTAG_INSTPREFIXES - (int) - - - - - - - - - RPMTAG_LICENSE - (int) - - - - - - - - - RPMTAG_LONGARCHIVESIZE - (int) - - - - - - - - - RPMTAG_LONGFILESIZES - (int) - - - - - - - - - RPMTAG_LONGSIGSIZE - (int) - - - - - - - - - RPMTAG_LONGSIZE - (int) - - - - - - - - - RPMTAG_MODULARITYLABEL - (int) - - - - - - - - - RPMTAG_N - (int) - - - - - - - - - RPMTAG_NAME - (int) - - - - El nombre del paquete, con el índice de la base de datos. - - - - - - RPMTAG_NEVR - (int) - - - - - - - - - RPMTAG_NEVRA - (int) - - - - - - - - - RPMTAG_NOPATCH - (int) - - - - - - - - - RPMTAG_NOSOURCE - (int) - - - - - - - - - RPMTAG_NVR - (int) - - - - - - - - - RPMTAG_NVRA - (int) - - - - - - - - - RPMTAG_O - (int) - - - - - - - - - RPMTAG_OBSOLETEFLAGS - (int) - - - - - - - - - RPMTAG_OBSOLETENAME - (int) - - - - Paquete obsoleto, con el índice de la base de datos. - - - - - - RPMTAG_OBSOLETENEVRS - (int) - - - - - - - - - RPMTAG_OBSOLETES - (int) - - - - - - - - - RPMTAG_OBSOLETEVERSION - (int) - - - - - - - - - RPMTAG_OLDENHANCES - (int) - - - - - - - - - RPMTAG_OLDENHANCESFLAGS - (int) - - - - - - - - - RPMTAG_OLDENHANCESNAME - (int) - - - - - - - - - RPMTAG_OLDENHANCESVERSION - (int) - - - - - - - - - RPMTAG_OLDFILENAMES - (int) - - - - - - - - - RPMTAG_OLDSUGGESTS - (int) - - - - - - - - - RPMTAG_OLDSUGGESTSFLAGS - (int) - - - - - - - - - RPMTAG_OLDSUGGESTSNAME - (int) - - - - - - - - - RPMTAG_OLDSUGGESTSVERSION - (int) - - - - - - - - - RPMTAG_OPTFLAGS - (int) - - - - - - - - - RPMTAG_ORDERFLAGS - (int) - - - - - - - - - RPMTAG_ORDERNAME - (int) - - - - - - - - - RPMTAG_ORDERVERSION - (int) - - - - - - - - - RPMTAG_ORIGBASENAMES - (int) - - - - - - - - - RPMTAG_ORIGDIRINDEXES - (int) - - - - - - - - - RPMTAG_ORIGDIRNAMES - (int) - - - - - - - - - RPMTAG_ORIGFILENAMES - (int) - - - - - - - - - RPMTAG_OS - (int) - - - - - - - - - RPMTAG_P - (int) - - - - - - - - - RPMTAG_PACKAGER - (int) - - - - - - - - - RPMTAG_PATCH - (int) - - - - - - - - - RPMTAG_PATCHESFLAGS - (int) - - - - - - - - - RPMTAG_PATCHESNAME - (int) - - - - - - - - - RPMTAG_PATCHESVERSION - (int) - - - - - - - - - RPMTAG_PAYLOADCOMPRESSOR - (int) - - - - - - - - - RPMTAG_PAYLOADDIGEST - (int) - - - - - - - - - RPMTAG_PAYLOADDIGESTALT - (int) - - - - Con librpm >= 4.16. - - - - - - RPMTAG_PAYLOADDIGESTALGO - (int) - - - - - - - - - RPMTAG_PAYLOADFLAGS - (int) - - - - - - - - - RPMTAG_PAYLOADFORMAT - (int) - - - - - - - - - RPMTAG_PKGID - (int) - - - - Obsoleto, utilizar RPMTAG_SIGMD5 en su lugar. Eliminado en librpm 6. - - - - - - RPMTAG_PLATFORM - (int) - - - - - - - - - RPMTAG_POLICIES - (int) - - - - - - - - - RPMTAG_POLICYFLAGS - (int) - - - - - - - - - RPMTAG_POLICYNAMES - (int) - - - - - - - - - RPMTAG_POLICYTYPES - (int) - - - - - - - - - RPMTAG_POLICYTYPESINDEXES - (int) - - - - - - - - - RPMTAG_POSTIN - (int) - - - - - - - - - RPMTAG_POSTINFLAGS - (int) - - - - - - - - - RPMTAG_POSTINPROG - (int) - - - - - - - - - RPMTAG_POSTTRANS - (int) - - - - - - - - - RPMTAG_POSTTRANSFLAGS - (int) - - - - - - - - - RPMTAG_POSTTRANSPROG - (int) - - - - - - - - - RPMTAG_POSTUN - (int) - - - - - - - - - RPMTAG_POSTUNFLAGS - (int) - - - - - - - - - RPMTAG_POSTUNPROG - (int) - - - - - - - - - RPMTAG_POSTUNTRANS - (int) - - - - Requiere librpm >= 4.19 - - - - - - RPMTAG_POSTUNTRANSFLAGS - (int) - - - - Requiere librpm >= 4.19 - - - - - - RPMTAG_POSTUNTRANSPROG - (int) - - - - Requiere librpm >= 4.19 - - - - - - RPMTAG_PREFIXES - (int) - - - - - - - - - RPMTAG_PREIN - (int) - - - - - - - - - RPMTAG_PREINFLAGS - (int) - - - - - - - - - RPMTAG_PREINPROG - (int) - - - - - - - - - RPMTAG_PRETRANS - (int) - - - - - - - - - RPMTAG_PRETRANSFLAGS - (int) - - - - - - - - - RPMTAG_PRETRANSPROG - (int) - - - - - - - - - RPMTAG_PREUN - (int) - - - - - - - - - RPMTAG_PREUNFLAGS - (int) - - - - - - - - - RPMTAG_PREUNPROG - (int) - - - - - - - - - RPMTAG_PREUNTRANS - (int) - - - - Requiere librpm >= 4.19 - - - - - - RPMTAG_PREUNTRANSFLAGS - (int) - - - - Requiere librpm >= 4.19 - - - - - - RPMTAG_PREUNTRANSPROG - (int) - - - - Requiere librpm >= 4.19 - - - - - - RPMTAG_PROVIDEFLAGS - (int) - - - - - - - - - RPMTAG_PROVIDENAME - (int) - - - - Las dependencias proporcionadas, con el índice de la base de datos. - - - - - - RPMTAG_PROVIDENEVRS - (int) - - - - - - - - - RPMTAG_PROVIDES - (int) - - - - - - - - - RPMTAG_PROVIDEVERSION - (int) - - - - - - - - - RPMTAG_PUBKEYS - (int) - - - - - - - - - RPMTAG_R - (int) - - - - - - - - - RPMTAG_RECOMMENDFLAGS - (int) - - - - - - - - - RPMTAG_RECOMMENDNAME - (int) - - - - Las dependencias débiles recomendadas, con el índice de la base de datos, requiere librpm >= 4.13. - - - - - - RPMTAG_RECOMMENDNEVRS - (int) - - - - - - - - - RPMTAG_RECOMMENDS - (int) - - - - - - - - - RPMTAG_RECOMMENDVERSION - (int) - - - - - - - - - RPMTAG_RECONTEXTS - (int) - - - - - - - - - RPMTAG_RELEASE - (int) - - - - - - - - - RPMTAG_REMOVETID - (int) - - - - - - - - - RPMTAG_REQUIREFLAGS - (int) - - - - - - - - - RPMTAG_REQUIRENAME - (int) - - - - Las dependencias requeridas, con el índice de la base de datos. - - - - - - RPMTAG_REQUIRENEVRS - (int) - - - - - - - - - RPMTAG_REQUIRES - (int) - - - - - - - - - RPMTAG_REQUIREVERSION - (int) - - - - - - - - - RPMTAG_RPMVERSION - (int) - - - - - - - - - RPMTAG_RSAHEADER - (int) - - - - - - - - - RPMTAG_SHA1HEADER - (int) - - - - La firma SHA1, con el índice de la base de datos. - - - - - - RPMTAG_SHA256HEADER - (int) - - - - - - - - - RPMTAG_SIGGPG - (int) - - - - - - - - - RPMTAG_SIGMD5 - (int) - - - - La firma MD5, con el índice de la base de datos. - - - - - - RPMTAG_SIGPGP - (int) - - - - - - - - - RPMTAG_SIGSIZE - (int) - - - - - - - - - RPMTAG_SIZE - (int) - - - - - - - - - RPMTAG_SOURCE - (int) - - - - - - - - - RPMTAG_SOURCEPACKAGE - (int) - - - - - - - - - RPMTAG_SOURCEPKGID - (int) - - - - - - - - - RPMTAG_SOURCERPM - (int) - - - - - - - - - RPMTAG_SPEC - (int) - - - - Requiere librpm >= 4.18 - - - - - - RPMTAG_SUGGESTFLAGS - (int) - - - - - - - - - RPMTAG_SUGGESTNAME - (int) - - - - El directorio de los ficheros, con el índice de la base de datos. - - - - - - RPMTAG_SUGGESTNEVRS - (int) - - - - - - - - - RPMTAG_SUGGESTS - (int) - - - - - - - - - RPMTAG_SUGGESTVERSION - (int) - - - - - - - - - RPMTAG_SUMMARY - (int) - - - - - - - - - RPMTAG_SUPPLEMENTFLAGS - (int) - - - - - - - - - RPMTAG_SUPPLEMENTNAME - (int) - - - - Las dependencias débiles, con el índice de la base de datos, requiere librpm >= 4.13. - - - - - - RPMTAG_SUPPLEMENTNEVRS - (int) - - - - - - - - - RPMTAG_SUPPLEMENTS - (int) - - - - - - - - - RPMTAG_SUPPLEMENTVERSION - (int) - - - - - - - - - RPMTAG_SYSUSERS - (int) - - - - Requiere librpm >= 4.19 - - - - - - RPMTAG_TRANSFILETRIGGERCONDS - (int) - - - - - - - - - RPMTAG_TRANSFILETRIGGERFLAGS - (int) - - - - - - - - - RPMTAG_TRANSFILETRIGGERINDEX - (int) - - - - - - - - - RPMTAG_TRANSFILETRIGGERNAME - (int) - - - - El nombre del desencadenador de fichero de transacción, con el índice de la base de datos, requiere librpm >= 4.13. - - - - - - RPMTAG_TRANSFILETRIGGERPRIORITIES - (int) - - - - - - - - - RPMTAG_TRANSFILETRIGGERSCRIPTFLAGS - (int) - - - - - - - - - RPMTAG_TRANSFILETRIGGERSCRIPTPROG - (int) - - - - - - - - - RPMTAG_TRANSFILETRIGGERSCRIPTS - (int) - - - - - - - - - RPMTAG_TRANSFILETRIGGERTYPE - (int) - - - - - - - - - RPMTAG_TRANSFILETRIGGERVERSION - (int) - - - - - - - - - RPMTAG_TRANSLATIONURL - (int) - - - - Requiere librpm >= 4.18 - - - - - - RPMTAG_TRIGGERCONDS - (int) - - - - - - - - - RPMTAG_TRIGGERFLAGS - (int) - - - - - - - - - RPMTAG_TRIGGERINDEX - (int) - - - - - - - - - RPMTAG_TRIGGERNAME - (int) - - - - El nombre del desencadenador, con el índice de la base de datos. - - - - - - RPMTAG_TRIGGERSCRIPTFLAGS - (int) - - - - - - - - - RPMTAG_TRIGGERSCRIPTPROG - (int) - - - - - - - - - RPMTAG_TRIGGERSCRIPTS - (int) - - - - - - - - - RPMTAG_TRIGGERTYPE - (int) - - - - - - - - - RPMTAG_TRIGGERVERSION - (int) - - - - - - - - - RPMTAG_UPSTREAMRELEASES - (int) - - - - Requiere librpm >= 4.18 - - - - - - RPMTAG_URL - (int) - - - - - - - - - RPMTAG_V - (int) - - - - - - - - - RPMTAG_VCS - (int) - - - - - - - - - RPMTAG_VENDOR - (int) - - - - - - - - - RPMTAG_VERBOSE - (int) - - - - - - - - - RPMTAG_VERIFYSCRIPT - (int) - - - - - - - - - RPMTAG_VERIFYSCRIPTFLAGS - (int) - - - - - - - - - RPMTAG_VERIFYSCRIPTPROG - (int) - - - - - - - - - RPMTAG_VERITYSIGNATUREALGO - (int) - - - - Con librpm >= 4.17. - - - - - - RPMTAG_VERITYSIGNATURES - (int) - - - - Con librpm >= 4.17. - - - - - - RPMTAG_VERSION - (int) - - - - - - - - - RPMTAG_XPM - (int) - - - - - - - - - diff --git a/reference/rpminfo/functions/rpmaddtag.xml b/reference/rpminfo/functions/rpmaddtag.xml deleted file mode 100644 index 162f69c981..0000000000 --- a/reference/rpminfo/functions/rpmaddtag.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - rpmaddtag - Añade un tag recuperado en una consulta - - - - &reftitle.description; - - boolrpmaddtag - inttag - - - Añade un tag recuperado en una consulta previa. - - - - - &reftitle.parameters; - - - tag - - - Una de las constantes RPMTAG_*, ver la página de las constantes rpminfo. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - rpminfo - rpmdbinfo - rpmdbsearch - - - - - diff --git a/reference/rpminfo/functions/rpmdbinfo.xml b/reference/rpminfo/functions/rpmdbinfo.xml deleted file mode 100644 index d2314ac07f..0000000000 --- a/reference/rpminfo/functions/rpmdbinfo.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - rpmdbinfo - Devuelve la información de un RPM instalado - - - - &reftitle.description; - - arraynullrpmdbinfo - stringnevr - boolfull&false; - - - Recupera la información sobre un paquete instalado, desde la base de datos RPM del sistema. - - - - - &reftitle.parameters; - - - nevr - - - El nombre con opcionalmente el epoch, la versión y la release. - - - - - full - - - Si es &true;, se recupera toda la información de cabecera del fichero, de lo contrario, solo un conjunto mínimo. - - - - - - - - &reftitle.returnvalues; - - Un array de array de información o NULL en caso de error. - - - - - &reftitle.examples; - - Un ejemplo de <function>rpmdbinfo</function> - - -]]> - - &example.outputs; - - Array - ( - [Name] => php-pecl-rpminfo - [Version] => 0.4.2 - [Release] => 1.fc31 - [Summary] => RPM information - [Installtime] => 1586244687 - [Arch] => x86_64 - ) -) -]]> - - - - - - &reftitle.seealso; - - rpmaddtag - - - - - diff --git a/reference/rpminfo/functions/rpmdbsearch.xml b/reference/rpminfo/functions/rpmdbsearch.xml deleted file mode 100644 index 1389366e8e..0000000000 --- a/reference/rpminfo/functions/rpmdbsearch.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - rpmdbsearch - Busca paquetes RPM - - - - &reftitle.description; - - arraynullrpmdbsearch - stringpattern - intrpmtagRPMTAG_NAME - intrpmmire-1 - boolfull&false; - - - Busca paquetes en la base de datos RPM del sistema. - - - - - &reftitle.parameters; - - - pattern - - - El valor a buscar. - - - - - rpmtag - - - El criterio de búsqueda, una de las constantes - RPMTAG_*. - - - - - rpmmire - - - El tipo de patrón, una de las constantes - RPMMIRE_*. - Cuando < 0 el criterio debe ser igual al valor, y el índice de la base de datos es utilizado si es posible. - - - - - full - - - Si &true; toda la información de encabezado para el fichero es recuperada, de lo contrario solo un conjunto mínimo. - - - - - - - - &reftitle.returnvalues; - - Un array de array de información o &null; en caso de error. - - - - - &reftitle.examples; - - Búsqueda del paquete que posee un fichero - - -]]> - - &example.outputs; - - Array - ( - [Name] => php-cli - [Version] => 7.4.4 - [Release] => 1.fc32 - [Summary] => Interfaz de línea de comandos para PHP - [Arch] => x86_64 - ) - -) -]]> - - - - - - &reftitle.seealso; - - rpmaddtag - - - - - diff --git a/reference/rpminfo/functions/rpmdefine.xml b/reference/rpminfo/functions/rpmdefine.xml deleted file mode 100644 index 731c452813..0000000000 --- a/reference/rpminfo/functions/rpmdefine.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - rpmdefine - Define o cambia el valor de una macro RPM - - - - &reftitle.description; - - boolrpmdefine - stringtext - - - Define o cambia el valor de una macro RPM. - - - Puede ser utilizado para seleccionar la ruta de acceso de la base de datos y el motor a utilizar - en lugar del predeterminado del sistema. - - - - - - &reftitle.parameters; - - - text - - - El nombre de la macro, las opciones, el cuerpo. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Un ejemplo de <function>rpmdefine</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - rpmexpand - rpmdbinfo - - - - - - diff --git a/reference/rpminfo/functions/rpmexpand.xml b/reference/rpminfo/functions/rpmexpand.xml deleted file mode 100644 index 75e771c2e6..0000000000 --- a/reference/rpminfo/functions/rpmexpand.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - rpmexpand - Obtiene el valor expandido de una macro RPM - - - - &reftitle.description; - - stringrpmexpand - stringtext - - - Obtiene el valor expandido de una macro RPM. - - - - - &reftitle.parameters; - - - text - - - El texto con las macros RPM a expandir. - - - - - - - - &reftitle.returnvalues; - - Un string con la(s) macro(s) expandida(s) concatenada(s). - - - - - &reftitle.examples; - - Un ejemplo de <function>rpmexpand</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - rpmexpandnumeric - - - - - diff --git a/reference/rpminfo/functions/rpmexpandnumeric.xml b/reference/rpminfo/functions/rpmexpandnumeric.xml deleted file mode 100644 index e2c103810c..0000000000 --- a/reference/rpminfo/functions/rpmexpandnumeric.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - rpmexpandnumeric - Obtiene el valor numérico de una macro RPM - - - - &reftitle.description; - - intrpmexpandnumeric - stringtext - - - Obtiene el valor numérico de una macro RPM. - - - - - &reftitle.parameters; - - - text - - - El texto con las macros RPM a expandir. - - - - - - - - &reftitle.returnvalues; - - La expansión de la macro como int. - Los valores booleanos (Y o y retorna 1, - N o n retorna 0) - también están permitidos. - Una macro no definida retorna 0. - - - - - &reftitle.examples; - - Un ejemplo <function>rpmexpandnumeric</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - rpmexpand - - - - - diff --git a/reference/rpminfo/functions/rpmgetsymlink.xml b/reference/rpminfo/functions/rpmgetsymlink.xml deleted file mode 100644 index 9485af9c91..0000000000 --- a/reference/rpminfo/functions/rpmgetsymlink.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - rpmgetsymlink - Devuelve el destino de un enlace simbólico - - - - &reftitle.description; - - stringnullrpmgetsymlink - stringpath - stringname - - - Devuelve el destino de un enlace simbólico. - - - - - - &reftitle.parameters; - - - path - - - La ruta de acceso del fichero RPM. - - - - - name - - - El nombre del fichero enlace simbólico. - - - - - - - - &reftitle.returnvalues; - - Un string con el destino del enlace simbólico, - &null; en caso de error, o una cadena vacía si no es un enlace simbólico. - - - - - diff --git a/reference/rpminfo/functions/rpminfo.xml b/reference/rpminfo/functions/rpminfo.xml deleted file mode 100644 index eca85befec..0000000000 --- a/reference/rpminfo/functions/rpminfo.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - rpminfo - Devuelve información de un fichero RPM - - - - &reftitle.description; - - arraynullrpminfo - stringpath - boolfull&false; - stringerror - - - Devuelve información sobre un fichero local, un paquete RPM. - - - - - - &reftitle.parameters; - - - path - - - La ruta de acceso del fichero RPM. - - - - - full - - - Si &true;, se recupera toda la información de cabecera del fichero, - de lo contrario, solo un conjunto mínimo. - - - - - error - - - Si se proporciona, recibirá el mensaje de error posible, - y evitará una advertencia de ejecución. - - - - - - - - &reftitle.returnvalues; - - Un array de información, o &null; en caso de error. - - - - - &reftitle.examples; - - Un ejemplo de <function>rpminfo</function> - - -]]> - - &example.outputs; - - php-pecl-rpminfo - [Version] => 0.4.2 - [Release] => 1.el8 - [Summary] => RPM information - [Buildtime] => 1586244821 - [Arch] => x86_64 -) -]]> - - - - - - &reftitle.seealso; - - rpmaddtag - - - - - diff --git a/reference/rpminfo/functions/rpmvercmp.xml b/reference/rpminfo/functions/rpmvercmp.xml deleted file mode 100644 index 80062b732e..0000000000 --- a/reference/rpminfo/functions/rpmvercmp.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - rpmvercmp - Comparación de versiones RPM - - - - &reftitle.description; - - intboolrpmvercmp - stringevr1 - stringevr2 - stringnulloperator&null; - - - Compara dos versiones de paquetes RPM. - - - - - &reftitle.parameters; - - - evr1 - - - La primera cadena epoch:version-release. - - - - - evr2 - - - La segunda cadena epoch:version-release. - - - - - operator - - - Un operador opcional. - Los operadores posibles son: - - < - lt - <= - le - > - gt - >= - ge - == - = - eq - != - <> - ne - . - - - Este parámetro distingue mayúsculas y minúsculas, los valores deben estar en minúsculas. - - - - - - - - &reftitle.returnvalues; - - Devuelve -1 si evr1 es inferior a - evr2, 1 si evr1 es - superior a evr2, y 0 si son iguales. - - - Cuando se utiliza el argumento opcional operator, la función - devolverá &true; si la relación es la especificada por - el operador, en caso contrario &false;. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL rpminfo 0.7.0 - - El operator opcional ha sido añadido. - - - - - - - - - diff --git a/reference/rpminfo/reference.xml b/reference/rpminfo/reference.xml deleted file mode 100644 index 08abddc33a..0000000000 --- a/reference/rpminfo/reference.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - &Functions; de RpmInfo - - &reference.rpminfo.entities.functions; - - - diff --git a/reference/rpminfo/setup.xml b/reference/rpminfo/setup.xml deleted file mode 100644 index ec052727aa..0000000000 --- a/reference/rpminfo/setup.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Esta extensión requiere la versión 4.11.3 o superior de librpm. - -
    - -
    - Instalación mediante PECL - - &pecl.info; - &url.pecl.package;rpminfo. - -
    - -
    - diff --git a/reference/rrd/book.xml b/reference/rrd/book.xml deleted file mode 100644 index 4d5b492b18..0000000000 --- a/reference/rrd/book.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - RRDtool - RRD - - - &reftitle.intro; - - La extensión PECL/rrd proporciona enlaces a la biblioteca en C RRDtool. - RRDtool es el estándar de código abierto de la industria, datos de registro de alto rendimiento - y la representación gráfica del sistema para datos de series de tiempo. - - - La página principal de RRDtool es &url.rrd;. - - - - &reference.rrd.setup; - &reference.rrd.examples; - &reference.rrd.reference; - - &reference.rrd.rrdcreator; - &reference.rrd.rrdgraph; - &reference.rrd.rrdupdater; - - diff --git a/reference/rrd/configure.xml b/reference/rrd/configure.xml deleted file mode 100644 index 89ded4f58e..0000000000 --- a/reference/rrd/configure.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;rrd - - -
    - diff --git a/reference/rrd/examples.xml b/reference/rrd/examples.xml deleted file mode 100644 index ab377d41a3..0000000000 --- a/reference/rrd/examples.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - &reftitle.examples; -
    - Ejemplo procedural PECL/rrd - - Procedimiento de utilización de rrd - - -]]> - - -
    - -
    - Ejemplo OOP PECL/rrd - - Procedimiento de utilización de OOP rrd - -addDataSource("speed:COUNTER:600:U:U"); -$creator->addArchive("AVERAGE:0.5:1:24"); -$creator->addArchive("AVERAGE:0.5:6:10"); -$creator->save(); - -$updater = new RRDUpdater($rrdFile); -$updater->update(array("speed" => "12345"), "920804700"); -$updater->update(array("speed" => "12357"), "920805000"); - -$graphObj = new RRDGraph($outputPngFile); -$graphObj->setOptions( - array( - "--start" => "920804400", - "--end" => 920808000, - "--vertical-label" => "m/s", - "DEF:myspeed=$rrdFile:speed:AVERAGE", - "CDEF:realspeed=myspeed,1000,*", - "LINE2:realspeed#FF0000" - ) -); -$graphObj->save(); -?> -]]> - - -
    - -
    - diff --git a/reference/rrd/functions/rrd-create.xml b/reference/rrd/functions/rrd-create.xml deleted file mode 100644 index 7edd417fa2..0000000000 --- a/reference/rrd/functions/rrd-create.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - rrd_create - Crea un archivo de base de datos rrd - - - - &reftitle.description; - - boolrrd_create - stringfilename - arrayoptions - - - Crea el archivo de base de datos RDD. - - - - - &reftitle.parameters; - - - filename - - - Nombre de archivo para el nuevo archivo de base de datos rrd. - - - - - options - - - Opciones para la creación del archivo de base de datos rrd - lista de cadenas. Ver página de manual de creación de archivos de base de datos rrd - para obtener una lista completa de opciones. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/rrd/functions/rrd-error.xml b/reference/rrd/functions/rrd-error.xml deleted file mode 100644 index bab84c696a..0000000000 --- a/reference/rrd/functions/rrd-error.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - rrd_error - Obtener el último mensaje de error - - - - &reftitle.description; - - stringrrd_error - - - - Devuelve el último mensaje de error global rrd. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Último mensaje de error. - - - - - diff --git a/reference/rrd/functions/rrd-fetch.xml b/reference/rrd/functions/rrd-fetch.xml deleted file mode 100644 index adf9267cd4..0000000000 --- a/reference/rrd/functions/rrd-fetch.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - rrd_fetch - Recuperar los datos de gráfico como un array - - - - &reftitle.description; - - arrayrrd_fetch - stringfilename - arrayoptions - - - Obtiene datos para la salida gráfica del archivo desde la base de datos RRD como un array. Esta función - tiene el mismo resultado que rrd_graph, pero los datos obtenidos son - devueltos como una matriz, no se crea el archivo de imagen. - - - - - &reftitle.parameters; - - - filename - - - Nombre de archivo de la base de datos RRD. - - - - - options - - - Array de opciones para la resolución solicitada. - - - - - - - - &reftitle.returnvalues; - - Devuelve información acerca de los datos del gráfico recuperados. - - - - - diff --git a/reference/rrd/functions/rrd-first.xml b/reference/rrd/functions/rrd-first.xml deleted file mode 100644 index 977f798d54..0000000000 --- a/reference/rrd/functions/rrd-first.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - rrd_first - Obtiene la marca de tiempo UNIX de la primera muestra desde el archivo rrd - - - - &reftitle.description; - - intrrd_first - stringfile - intraaindex0 - - - Devuelve la primera muestra de datos desde la especificada RRA del archivo RRD. - - - - - &reftitle.parameters; - - - file - - - Nombre del archivo de la base de datos RRD. - - - - - raaindex - - - El índice numérico de la RRA que se va a examinar. El valor por defecto es 0. - - - - - - - - &reftitle.returnvalues; - - Número entero de timestamp Unix,&return.falseforfailure;. - - - - - diff --git a/reference/rrd/functions/rrd-graph.xml b/reference/rrd/functions/rrd-graph.xml deleted file mode 100644 index 5c0430a68c..0000000000 --- a/reference/rrd/functions/rrd-graph.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - rrd_graph - Crea la imagen de un conjunto de datos - - - - &reftitle.description; - - arrayrrd_graph - stringfilename - arrayoptions - - - Crea la imagen de un conjunto de datos particulares desde el archivo de RRD. - - - - - &reftitle.parameters; - - - filename - - - El nombre del archivo de salida del gráfico. Este generalmente tiene una terminación - .png, .svg o - .eps, dependiendo del formato de salida que desee. - - - - - options - - - Las opciones para la generación de la imagen. Consulte la página del manual de gráficos rrd para conocer todas - las posibles opciones. Todas las opciones (definiciones de datos, definiciones de variables, etc.) - son permitidas. - - - - - - - - &reftitle.returnvalues; - - Array con información sobre la imagen generada es devuelto,&return.falseforfailure;. - - - - diff --git a/reference/rrd/functions/rrd-info.xml b/reference/rrd/functions/rrd-info.xml deleted file mode 100644 index 6d57bd220a..0000000000 --- a/reference/rrd/functions/rrd-info.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - rrd_info - Obtiene información sobre el archivo rrd - - - - &reftitle.description; - - arrayrrd_info - stringfilename - - - Devuelve información acerca sobre determinado archivo de base de datos RRD. - - - - - &reftitle.parameters; - - - file - - - Nombre del archivo de base de datos RRD. - - - - - - - - &reftitle.returnvalues; - - Array con información sobre el fichero RRD solicitado,&return.falseforfailure;. - - - - - - diff --git a/reference/rrd/functions/rrd-last.xml b/reference/rrd/functions/rrd-last.xml deleted file mode 100644 index 8ad37113c1..0000000000 --- a/reference/rrd/functions/rrd-last.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - rrd_last - Obtiene la marca de tiempo UNIX de la última muestra - - - - &reftitle.description; - - intrrd_last - stringfilename - - - Devuelve la marca de tiempo UNIX (UNIX timestamp) de la actualización más reciente de la base de datos RRD. - - - - - &reftitle.parameters; - - - filename - - - Nombre de archivo de la base de datos RRD. - - - - - - - - &reftitle.returnvalues; - - Devuelve un número entero como marca de tiempo Unix de los datos más recientes de la base de datos RRD. - - - - - diff --git a/reference/rrd/functions/rrd-lastupdate.xml b/reference/rrd/functions/rrd-lastupdate.xml deleted file mode 100644 index 13889a93af..0000000000 --- a/reference/rrd/functions/rrd-lastupdate.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - rrd_lastupdate - Obtiene información sobre los últimos datos actualizados - - - - &reftitle.description; - - arrayrrd_lastupdate - stringfilename - - - Obtiene un array de la marca de tiempo UNIX y de los valores almacenados para cada fecha en la actualización - más reciente del archivo de base de datos RRD. - - - - - &reftitle.parameters; - - - file - - - Nombre del archivo de la base de datos RRD. - - - - - - - - &reftitle.returnvalues; - - Array de información sobre la última actualización,&return.falseforfailure;. - - - - diff --git a/reference/rrd/functions/rrd-restore.xml b/reference/rrd/functions/rrd-restore.xml deleted file mode 100644 index aebaca9edb..0000000000 --- a/reference/rrd/functions/rrd-restore.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - rrd_restore - Restaura el archivo RRD desde el XML dump - - - - &reftitle.description; - - boolrrd_restore - stringxml_file - stringrrd_file - arrayoptions - - - Restaura el archivo RRD desde el XML dump. - - - - - &reftitle.parameters; - - - xml_file - - - Nombre del archivo XML con el dump del archivo de la base de datos RRD original. - - - - - rrd_file - - - Nombre del archivo de la base de datos RRD restaurada. - - - - - options - - - Array de opciones para la restauración. Consulte la página de manual de restauración rrd. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/rrd/functions/rrd-tune.xml b/reference/rrd/functions/rrd-tune.xml deleted file mode 100644 index 7ffa200ad6..0000000000 --- a/reference/rrd/functions/rrd-tune.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - rrd_tune - Cambia algunas opciones de cabecera del archivo de base de datos RRD database - - - - &reftitle.description; - - boolrrd_tune - stringfilename - arrayoptions - - - Cambia algunas opciones de cabecera del archivo de base de datos RRD. Por ejemplo, cambia el nombre de la fuente - de los datos, etc - - - - - &reftitle.parameters; - - - filename - - - Nombre de archivo de la base de datos RRD. - - - - - options - - - Opciones con las propiedades del archivo de la base de datos RDD que serán cambiadas. Consulte la página - del manual rrd tune para mayor detalle. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/rrd/functions/rrd-update.xml b/reference/rrd/functions/rrd-update.xml deleted file mode 100644 index 64f050489a..0000000000 --- a/reference/rrd/functions/rrd-update.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - rrd_update - Actualizar la base de datos RRD - - - - &reftitle.description; - - boolrrd_update - stringfilename - arrayoptions - - - Actualiza el archivo de base de datos RRD. Los datos de entrada es el tiempo interpolado de acuerdo - con las propiedades del archivo de base de datos RRD. - - - - - &reftitle.parameters; - - - filename - - - Nombre de archivo de la base de datos RRD. Esta base de datos será actualizada. - - - - - options - - - Opciones para actualizar la base de datos RRD. Esta es una lista de cadenas. Ver página del manual - de actualización rrd para conocer el listado de opciones. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/rrd/functions/rrd-version.xml b/reference/rrd/functions/rrd-version.xml deleted file mode 100644 index e3678897e1..0000000000 --- a/reference/rrd/functions/rrd-version.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - rrd_version - Obtiene información acerca de la biblioteca subyacente rrdtool - - - - &reftitle.description; - - stringrrd_version - - - - Devuelve información acerca de la biblioteca subyacente rrdtool. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - String con el número de versión, por ejemplo, rrdtool "1.4.3". - - - - - diff --git a/reference/rrd/functions/rrd-xport.xml b/reference/rrd/functions/rrd-xport.xml deleted file mode 100644 index 3334201be4..0000000000 --- a/reference/rrd/functions/rrd-xport.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - rrd_xport - Exporta la información acerca de la base de datos RRD - - - - &reftitle.description; - - arrayrrd_xport - arrayoptions - - - Exporta la información sobre el archivo de base de datos RRD. Estos datos se pueden convertir - a archivo XML a través del espacio de usuario PHP script y posteriormente restaurarlo de nuevo como un - archivo de base de datos RRD. - - - - - &reftitle.parameters; - - - options - - - Array de opciones para la exportación, consulte la página del manual rrd xport. - - - - - - - - &reftitle.returnvalues; - - Array con información sobre el fichero de base de datos RRD,&return.falseforfailure;. - - - - - diff --git a/reference/rrd/functions/rrdc-disconnect.xml b/reference/rrd/functions/rrdc-disconnect.xml deleted file mode 100644 index 078fee2838..0000000000 --- a/reference/rrd/functions/rrdc-disconnect.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - rrdc_disconnect - Cierra todas las conexiones al demonio de caché rrd - - - - &reftitle.description; - - voidrrdc_disconnect - - - - Cierra todas las conexiones al demonio de caché rrd. - - - Esta función es llamada automáticamente cuando el proceso - global PHP finaliza. Esto depende de la API utilizada. Por ejemplo, - esta función es llamada automáticamente al final de un script - de línea de comandos. - - - Depende del usuario decidir si llamar a esta función al final de - cada petición o no. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/rrd/reference.xml b/reference/rrd/reference.xml deleted file mode 100644 index 3aa2868d60..0000000000 --- a/reference/rrd/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - &Functions; RRD - - &reference.rrd.entities.functions; - - - - diff --git a/reference/rrd/rrdcreator.xml b/reference/rrd/rrdcreator.xml deleted file mode 100644 index 0cab32b319..0000000000 --- a/reference/rrd/rrdcreator.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - La clase RRDCreator - RRDCreator - - - - -
    - &reftitle.intro; - - Clase para crear archivos de base de datos - RRD. - -
    - - -
    - &reftitle.classsynopsis; - - - - RRDCreator - - - - - RRDCreator - - - - - &Methods; - - - - - - - - - -
    - -
    - - &reference.rrd.entities.rrdcreator; - -
    - diff --git a/reference/rrd/rrdcreator/addarchive.xml b/reference/rrd/rrdcreator/addarchive.xml deleted file mode 100644 index 072eaadec6..0000000000 --- a/reference/rrd/rrdcreator/addarchive.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - RRDCreator::addArchive - Añade RRA - archivo de valores de datos para cada fuente de datos - - - - &reftitle.description; - - public voidRRDCreator::addArchive - stringdescription - - - Añade definición RRA por descripción de archivo. Archivo consta de un - número de valores de datos o estadísticas para cada una de las fuentes de datos definidas (DS). - Las fuentes de datos son definidos a través del método RRDCreator::addDataSource. - Es necesario llamar a este método para cada archivo solicitado. - - - - - &reftitle.parameters; - - - description - - - Definición del archivo - RRA. Esta tiene el mismo formato que la definición RRA en el - comando rrd create. Ver página de manual de rrd create para obtener más detalles. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/rrd/rrdcreator/adddatasource.xml b/reference/rrd/rrdcreator/adddatasource.xml deleted file mode 100644 index 137d952ccf..0000000000 --- a/reference/rrd/rrdcreator/adddatasource.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - RRDCreator::addDataSource - Añade una definición de fuente de datos para la base de datos RRD - - - - &reftitle.description; - - public voidRRDCreator::addDataSource - stringdescription - - - RRD puede aceptar entradas desde diversas fuentes de datos (DS), es decir, - tráfico entrante y saliente. Este método añade una fuente de datos - mediante su descripción. Debe llamarse a este método para cada - fuente de datos. - - - - - &reftitle.parameters; - - - description - - - Definición de la fuente de datos (DS). El formato es idéntico a la - definición de un DS en el comando de creación RRD. Consúltese la página - del manual de creación RRD para más detalles. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - diff --git a/reference/rrd/rrdcreator/construct.xml b/reference/rrd/rrdcreator/construct.xml deleted file mode 100644 index b2f8e4aaea..0000000000 --- a/reference/rrd/rrdcreator/construct.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - RRDCreator::__construct - Crea una nueva instancia RRDCreator - - - - &reftitle.description; - - public RRDCreator::__construct - stringpath - stringstartTime - intstep0 - - - Crea una nueva instancia RRDCreator. - - - - - &reftitle.parameters; - - - path - - - Ruta de acceso al nuevo fichero de base de datos RRD creado. - - - - - startTime - - - Fecha/hora para el primer valor de la base de datos RRD. - Este argumento admite todos los formatos que son admitidos por la llamada - de creación RRD. - - - - - intstep - - - Intervalo base, en segundos, de inserción de datos en la base de datos - RRD. - - - - - - - - diff --git a/reference/rrd/rrdcreator/save.xml b/reference/rrd/rrdcreator/save.xml deleted file mode 100644 index 2d2c0a5599..0000000000 --- a/reference/rrd/rrdcreator/save.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - RRDCreator::save - Guarda la base de datos RRD en un archivo - - - - &reftitle.description; - - public boolRRDCreator::save - - - - Guarda la base de datos RRD en un archivo, cuyo nombre es definido por RRDCreator::__construct. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - diff --git a/reference/rrd/rrdgraph.xml b/reference/rrd/rrdgraph.xml deleted file mode 100644 index f9ca6e2c14..0000000000 --- a/reference/rrd/rrdgraph.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - La clase RRDGraph - RRDGraph - - - - -
    - &reftitle.intro; - - Clase para exportar los datos desde una base de datos - RRD hacia un fichero de imagen. - -
    - - -
    - &reftitle.classsynopsis; - - - - RRDGraph - - - - - RRDGraph - - - - - &Methods; - - - - - - - - - -
    - -
    - - &reference.rrd.entities.rrdgraph; - -
    - diff --git a/reference/rrd/rrdgraph/construct.xml b/reference/rrd/rrdgraph/construct.xml deleted file mode 100644 index 026c0d34fd..0000000000 --- a/reference/rrd/rrdgraph/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - RRDGraph::__construct - Crea una nueva instancia RRDGraph - - - - &reftitle.description; - - public RRDGraph::__construct - stringpath - - - Crea una nueva instancia RRDGraph. Esta instancia es responsable - de la representación del resultado de la consulta a la base de datos RRD en la imagen. - - - - - &reftitle.parameters; - - - path - - - Ruta completa para la nueva imagen creada. - - - - - - - - diff --git a/reference/rrd/rrdgraph/save.xml b/reference/rrd/rrdgraph/save.xml deleted file mode 100644 index dd0285c6b9..0000000000 --- a/reference/rrd/rrdgraph/save.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - RRDGraph::save - Guarda el resultado de una consulta en una imagen - - - - &reftitle.description; - - public arrayRRDGraph::save - - - - Guarda el resultado de una consulta de base de datos RRD en una - imagen definida por el método - RRDGraph::__construct. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un array que contiene información sobre la imagen generada,&return.falseforfailure;. - - - - diff --git a/reference/rrd/rrdgraph/saveverbose.xml b/reference/rrd/rrdgraph/saveverbose.xml deleted file mode 100644 index 2e272c27ba..0000000000 --- a/reference/rrd/rrdgraph/saveverbose.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - RRDGraph::saveVerbose - Guarda una consulta de base de datos RRD en la imagen y devuelve - las informaciones verbosas sobre el gráfico generado. - - - - - &reftitle.description; - - public arrayRRDGraph::saveVerbose - - - - Guarda la consulta de base de datos RRD en el fichero de imagen definido - por el método RRDGraph::__construct y devuelve - las informaciones verbosas sobre el gráfico generado; si "-" es utilizado - como nombre de fichero de imagen, los datos de la imagen - serán también devueltos en el array resultante. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un array que contiene las informaciones detalladas sobre la imagen - generada,&return.falseforfailure;. - - - - diff --git a/reference/rrd/rrdgraph/setoptions.xml b/reference/rrd/rrdgraph/setoptions.xml deleted file mode 100644 index 1c212c4d60..0000000000 --- a/reference/rrd/rrdgraph/setoptions.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - - RRDGraph::setOptions - Establece las opciones para la exportación gráfica rrd - - - - &reftitle.description; - - public voidRRDGraph::setOptions - arrayoptions - - - - - - - - &reftitle.parameters; - - - options - - - Lista de las opciones para la generación de imágenes a partir del archivo de base de datos RRD. Esta puede - ser una lista de cadenas o lista de cadenas con claves para una mejor legibilidad. Consulte - las páginas del manual rrd graph para conocer la lista de opciones disponibles. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo de <methodname>RRDGraph::setOptions</methodname> - -setOptions(array( - "--start" => "920804400", - "--end" => 920808000, - "--vertical-label" => "m/s", - "DEF:myspeed=$rrdFile:speed:AVERAGE", - "CDEF:realspeed=myspeed,1000,*", - "LINE2:realspeed#FF0000" -)); -?> -]]> - - - - - Establecer varias opciones de color - -setOptions(array( - "--start" => "920804400", - "--end" => 920808000, - "--vertical-label" => "m/s", - "--color=BACK#00000000", - "--color=GRID#00000000", - "--color=MGRID#00000000", - "DEF:myspeed=$rrdFile:speed:AVERAGE", - "CDEF:realspeed=myspeed,1000,*", - "LINE2:realspeed#FF0000" -)); -?> -]]> - - - No emplee la sintaxis de valor de clave para la misma opción rrd. Es más legible, pero - no fucniona. - - -setOptions(array( - "--color" => "BACK#00000000", - "--color" => "GRID#00000000", - "--color" => "MGRID#00000000" -)); -?> -]]> - - - En PHP es lo mismo que - - -setOptions(array( - "--color" => "MGRID#00000000" -)); -?> -]]> - - - - - - diff --git a/reference/rrd/rrdupdater.xml b/reference/rrd/rrdupdater.xml deleted file mode 100644 index 31a94675a5..0000000000 --- a/reference/rrd/rrdupdater.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - La clase RRDUpdater - RRDUpdater - - - - -
    - &reftitle.intro; - - Clase para actualizar un archivo de base de datos - RRD. - -
    - - -
    - &reftitle.classsynopsis; - - - - RRDUpdater - - - - - RRDUpdater - - - - - &Methods; - - - - - - - - - -
    - -
    - - &reference.rrd.entities.rrdupdater; - -
    - diff --git a/reference/rrd/rrdupdater/construct.xml b/reference/rrd/rrdupdater/construct.xml deleted file mode 100644 index dd89993e5c..0000000000 --- a/reference/rrd/rrdupdater/construct.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - RRDUpdater::__construct - Crea una nueva instancia RRDUpdater - - - - &reftitle.description; - - public RRDUpdater::__construct - stringpath - - - Crea una nueva instancia RRDUpdater. Esta instancia se encarga - de la actualización del archivo de base de datos RRD. - - - - - &reftitle.parameters; - - - path - - - Ruta del sistema de archivos hacia el archivo de - base de datos RRD a actualizar. - - - - - - - - diff --git a/reference/rrd/rrdupdater/update.xml b/reference/rrd/rrdupdater/update.xml deleted file mode 100644 index cf81883091..0000000000 --- a/reference/rrd/rrdupdater/update.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - RRDUpdater::update - Actualiza el archivo de base de datos RRD - - - - &reftitle.description; - - public boolRRDUpdater::update - arrayvalues - stringtime - time() - - - - Actualiza el archivo RRD definido a través de RRDUpdater::__construct. - El archivo se actualiza con un valor específico. - - - - - &reftitle.parameters; - - - values - - - Los datos de actualización. Key del array es el nombre del origen de datos. - - - - - time - - - Valor del tiempo para la actualización del RRD con unos datos particulares. El valor predeterminado - es la hora actual. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - Lanza una Exception en caso de error. - - - - - &reftitle.examples; - - Ejemplos de <methodname>RRDUpdater::update</methodname> - -update(array("speed" => "12411"), "920807700"); -?> -]]> - - - - - diff --git a/reference/rrd/setup.xml b/reference/rrd/setup.xml deleted file mode 100644 index 238f5ced55..0000000000 --- a/reference/rrd/setup.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Es necesario instalar primero la biblioteca librrd para - utilizar la extensión PECL/rrd. Verifique si su distribución - favorita de Linux ofrece el paquete librrd-dev. - PECL/rrd ha sido probado con librrd 1.4.3, las versiones anteriores o más recientes - pueden o no funcionar. - - - - Librrd y, por lo tanto, la extensión misma no son, en la mayoría de los casos, seguras para hilos. - Existen muchos estados globales y compartidos en librrd. Puede ser - peligroso utilizar esta extensión en entornos multihilo como - Apache 2 mpm worker. Si existen varias peticiones en paralelo, una de ellas - puede modificar el estado global de la biblioteca librrd, afectando así - a las otras peticiones en ejecución. - - -
    - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;rrd. - -
    - -
    - diff --git a/reference/runkit7/book.xml b/reference/runkit7/book.xml deleted file mode 100644 index 0e50860198..0000000000 --- a/reference/runkit7/book.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - runkit7 - runkit7 - - - &reftitle.intro; - - La extensión runkit7 proporciona medios para modificar las constantes, - las funciones definidas por el usuario y las clases definidas por el usuario. - Asimismo, proporciona variables superglobales personalizadas. - - - - Este paquete es un fork del - paquete runkit que proporciona soporte para PHP 7. - - - - &reference.runkit7.setup; - &reference.runkit7.constants; - &reference.runkit7.reference; - - - - diff --git a/reference/runkit7/constants.xml b/reference/runkit7/constants.xml deleted file mode 100644 index 181918837d..0000000000 --- a/reference/runkit7/constants.xml +++ /dev/null @@ -1,209 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - RUNKIT7_IMPORT_FUNCTIONS - (int) - - - - El flag runkit7_import indica - que las funciones normales deben ser importadas del - archivo especificado. - - - - - - RUNKIT7_IMPORT_CLASS_METHODS - (int) - - - - El flag runkit7_import indica - que los métodos de clase deben ser importados del - archivo especificado. - - - - - - RUNKIT7_IMPORT_CLASS_CONSTS - (int) - - - - El flag runkit7_import indica - que las constantes de clase deben ser importadas del - archivo especificado. - - - - - - RUNKIT7_IMPORT_CLASS_PROPS - (int) - - - - El flag runkit7_import indica - que las propiedades de clase estándar deben ser importadas - del archivo especificado. - - - - - - RUNKIT7_IMPORT_CLASS_STATIC_PROPS - (int) - - - - El flag runkit7_import indica - que las propiedades estáticas de clase deben ser importadas - del archivo especificado. Disponible a partir de Runkit 1.0.1. - - - - - - RUNKIT7_IMPORT_CLASSES - (int) - - - - El flag runkit7_import representa - un OU a nivel de bits de las constantes RUNKIT7_IMPORT_CLASS_*. - - - - - - RUNKIT7_IMPORT_OVERRIDE - (int) - - - - El flag runkit7_import indica que - si alguna de las funciones, métodos, constantes o propiedades - importados ya existen, deben ser sobrescritos por las nuevas definiciones. Si este flag no está definido, - entonces todas las definiciones importadas que ya existan - serán ignoradas. - - - - - - RUNKIT7_ACC_RETURN_REFERENCE - (int) - - - - Incluir este flag para hacer que la función o método creado o redefinido devuelva una referencia. - - - - - - RUNKIT7_ACC_PUBLIC - (int) - - - - El flag para runkit7_method_add y runkit7_method_redefine para hacer que el método sea público. - - - - - - RUNKIT7_ACC_PROTECTED - (int) - - - - El flag para runkit7_method_add y runkit7_method_redefine para hacer que el método sea protegido. - - - - - - RUNKIT7_ACC_PRIVATE - (int) - - - - El flag para runkit7_method_add y runkit7_method_redefine para hacer que el método sea privado. - - - - - - RUNKIT7_ACC_STATIC - (int) - - - - El flag para runkit7_method_add y runkit7_method_redefine para hacer que el método sea estático. - - - - - - RUNKIT7_FEATURE_MANIPULATION - (int) - - - - Igual a 1 si la manipulación en tiempo de ejecución está activada, y 0 en caso contrario. - - - - - - RUNKIT7_FEATURE_SUPERGLOBALS - (int) - - - - Igual a 1 si las superglobales personalizadas están activadas, y 0 en caso contrario. - - - - - - RUNKIT7_FEATURE_SANDBOX - (int) - - - - Siempre 0, es impracticable implementar la funcionalidad de entorno de pruebas en php 7. - - - - - - diff --git a/reference/runkit7/functions/runkit7-constant-add.xml b/reference/runkit7/functions/runkit7-constant-add.xml deleted file mode 100644 index 81c9e67346..0000000000 --- a/reference/runkit7/functions/runkit7-constant-add.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - runkit7_constant_add - - Similar a define(), pero permite definir constantes en las definiciones de clase también - - - - - &reftitle.description; - - boolrunkit7_constant_add - stringconstant_name - mixedvalue - intnewVisibility - - - - - &reftitle.parameters; - - - constant_name - - - El nombre de la constante a declarar. Puede ser un string para indicar una constante global, - o classname::constname para indicar una constante de clase. - - - - - value - - - NULL, Bool, Long, Double, String, Array, o Resource a almacenar en la nueva constante. - - - - - newVisibility - - - La visibilidad de la constante, para las constantes de clase. Público por omisión. - Una de las constantes RUNKIT7_ACC_*. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - define - runkit7_constant_redefine - runkit7_constant_remove - - - - - diff --git a/reference/runkit7/functions/runkit7-constant-redefine.xml b/reference/runkit7/functions/runkit7-constant-redefine.xml deleted file mode 100644 index 9b1e735c7c..0000000000 --- a/reference/runkit7/functions/runkit7-constant-redefine.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - runkit7_constant_redefine - Redefine una constante ya definida - - - - &reftitle.description; - - boolrunkit7_constant_redefine - stringconstant_name - mixedvalue - intnew_visibility - - - - - - - - &reftitle.parameters; - - - constant_name - - - La constante a redefinir. Puede ser el nombre de una constante global, - o classname::constname indicando una constante de clase. - - - - - value - - - El valor a asignar a la constante. - - - - - new_visibility - - - La nueva visibilidad de la constante, para constantes de clase. - Por omisión, permanece sin cambios. - Una de las constantes RUNKIT7_ACC_*. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - runkit7_constant_add - runkit7_constant_remove - - - - - diff --git a/reference/runkit7/functions/runkit7-constant-remove.xml b/reference/runkit7/functions/runkit7-constant-remove.xml deleted file mode 100644 index 738153255c..0000000000 --- a/reference/runkit7/functions/runkit7-constant-remove.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - runkit7_constant_remove - - Elimina una constante ya definida - - - - - &reftitle.description; - - boolrunkit7_constant_remove - stringconstant_name - - - - - &reftitle.parameters; - - - constant_name - - - El nombre de la constante a eliminar. Puede ser el nombre de una constante global, - o classname::constname indicando una constante de clase. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - define - runkit7_constant_add - runkit7_constant_redefine - - - - - diff --git a/reference/runkit7/functions/runkit7-function-add.xml b/reference/runkit7/functions/runkit7-function-add.xml deleted file mode 100644 index 7d910c9de1..0000000000 --- a/reference/runkit7/functions/runkit7-function-add.xml +++ /dev/null @@ -1,165 +0,0 @@ - - - - - - runkit7_function_add - - Añade una nueva función, similar a create_function - - - - - &reftitle.description; - - boolrunkit7_function_add - stringfunction_name - stringargument_list - stringcode - boolreturn_by_reference&null; - stringdoc_comment&null; - stringreturn_type - boolis_strict - - - boolrunkit7_function_add - stringfunction_name - Closureclosure - stringdoc_comment&null; - stringreturn_type - boolis_strict - - - - - &reftitle.parameters; - - - function_name - - - El nombre de la función a crear - - - - - argument_list - - - La lista de argumentos separados por comas - - - - - code - - - El código que compone la función - - - - - closure - - - Una closure que define la función - - - - - return_by_reference - - - Si la función debe devolver por referencia - - - - - doc_comment - - - El comentario de documentación de la función - - - - - return_type - - - El tipo de retorno de la función - - - - - is_strict - - - Si la función debe comportarse como si fuera declarada en un archivo con strict_types=1 - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Un ejemplo de <function>runkit7_function_add</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - create_function - runkit7_function_redefine - runkit7_function_copy - runkit7_function_rename - runkit7_function_remove - runkit7_method_add - - - - - diff --git a/reference/runkit7/functions/runkit7-function-copy.xml b/reference/runkit7/functions/runkit7-function-copy.xml deleted file mode 100644 index 0e034f2320..0000000000 --- a/reference/runkit7/functions/runkit7-function-copy.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - runkit7_function_copy - - Copia una función hacia un nuevo nombre de función - - - - - &reftitle.description; - - boolrunkit7_function_copy - stringsource_name - stringtarget_name - - - - - &reftitle.parameters; - - - source_name - - - El nombre de la función existente - - - - - target_name - - - El nombre de la nueva función hacia la cual copiar la definición - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Un ejemplo de <function>runkit7_function_copy</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - runkit7_function_add - runkit7_function_redefine - runkit7_function_rename - runkit7_function_remove - - - - - diff --git a/reference/runkit7/functions/runkit7-function-redefine.xml b/reference/runkit7/functions/runkit7-function-redefine.xml deleted file mode 100644 index 816548631a..0000000000 --- a/reference/runkit7/functions/runkit7-function-redefine.xml +++ /dev/null @@ -1,171 +0,0 @@ - - - - - - runkit7_function_redefine - - Sustituye una definición de función por una nueva implementación - - - - - &reftitle.description; - - boolrunkit7_function_redefine - stringfunction_name - stringargument_list - stringcode - boolreturn_by_reference&null; - stringdoc_comment&null; - stringreturn_type - boolis_strict - - - boolrunkit7_function_redefine - stringfunction_name - Closureclosure - stringdoc_comment&null; - stringreturn_type - boolis_strict - - - ¬e.runkit.internal-override; - - - - - &reftitle.parameters; - - - function_name - - - El nombre de la función a redefinir - - - - - argument_list - - - La nueva lista de argumentos a aceptar por la función - - - - - code - - - El código de la nueva implementación - - - - - closure - - - Una closure que define la función - - - - - return_by_reference - - - Si la función debe devolver por referencia - - - - - doc_comment - - - El comentario de documentación de la función - - - - - return_type - - - El tipo de retorno de la función - - - - - is_strict - - - Si la función se comporta como si estuviera declarada en un fichero con strict_types=1 - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Un ejemplo de <function>runkit7_function_redefine</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - runkit7_function_add - runkit7_function_copy - runkit7_function_rename - runkit7_function_remove - runkit7_method_redefine - - - - - diff --git a/reference/runkit7/functions/runkit7-function-remove.xml b/reference/runkit7/functions/runkit7-function-remove.xml deleted file mode 100644 index d4a7cc301d..0000000000 --- a/reference/runkit7/functions/runkit7-function-remove.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - runkit7_function_remove - - Elimina una definición de función - - - - - &reftitle.description; - - boolrunkit7_function_remove - stringfunction_name - - - ¬e.runkit.internal-override; - - - - - &reftitle.parameters; - - - function_name - - - El nombre de la función a eliminar - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - runkit7_function_add - runkit7_function_copy - runkit7_function_redefine - runkit7_function_rename - - - - - diff --git a/reference/runkit7/functions/runkit7-function-rename.xml b/reference/runkit7/functions/runkit7-function-rename.xml deleted file mode 100644 index 4e8be2e341..0000000000 --- a/reference/runkit7/functions/runkit7-function-rename.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - runkit7_function_rename - - Cambiar un nombre de función - - - - - &reftitle.description; - - boolrunkit7_function_rename - stringsource_name - stringtarget_name - - - ¬e.runkit.internal-override; - - - - - &reftitle.parameters; - - - source_name - - - El nombre de la función existente - - - - - target_name - - - El nuevo nombre de la función - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - runkit7_function_add - runkit7_function_copy - runkit7_function_redefine - runkit7_function_remove - - - - - diff --git a/reference/runkit7/functions/runkit7-import.xml b/reference/runkit7/functions/runkit7-import.xml deleted file mode 100644 index c09cce1ad0..0000000000 --- a/reference/runkit7/functions/runkit7-import.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - runkit7_import - - Realiza la importación de un fichero PHP importando las definiciones de funciones y clases, sobrescribiéndolas si es necesario - - - - - - Esta característica ha sido eliminada en PECL runkit7 4.0.0. - - - - - &reftitle.description; - - boolrunkit7_import - stringfilename - intflags - - - Similar a include. Sin embargo, todo código que se encuentre - fuera de una función o clase es simplemente ignorado. - Además, en función del valor de flags, - toda función o clase ya existente en el entorno de ejecución actual - puede ser automáticamente sobrescrita por sus nuevas definiciones. - - - - - &reftitle.parameters; - - - filename - - - El nombre del fichero a partir del cual importar las definiciones de funciones y clases - - - - - flags - - - Una operación a nivel de bits de la familia de constantes - RUNKIT7_IMPORT_*. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/runkit7/functions/runkit7-method-add.xml b/reference/runkit7/functions/runkit7-method-add.xml deleted file mode 100644 index 6b34de270b..0000000000 --- a/reference/runkit7/functions/runkit7-method-add.xml +++ /dev/null @@ -1,193 +0,0 @@ - - - - - - runkit7_method_add - Añade dinámicamente un nuevo método a una clase dada - - - - &reftitle.description; - - boolrunkit7_method_add - stringclass_name - stringmethod_name - stringargument_list - stringcode - intflagsRUNKIT7_ACC_PUBLIC - stringdoc_comment&null; - stringreturn_type - boolis_strict - - - boolrunkit7_method_add - stringclass_name - stringmethod_name - Closureclosure - intflagsRUNKIT7_ACC_PUBLIC - stringdoc_comment&null; - stringreturn_type - boolis_strict - - - - &reftitle.parameters; - - - class_name - - - La clase a la cual se añadirá este método - - - - - method_name - - - El nombre del método a añadir - - - - - argument_list - - - La lista de argumentos separados por comas para el nuevo método - - - - - code - - - El código a evaluar cuando method_name - es llamado - - - - - closure - - - Una closure que define el método. - - - - - flags - - - El tipo de método a crear, puede ser - RUNKIT7_ACC_PUBLIC, - RUNKIT7_ACC_PROTECTED o - RUNKIT7_ACC_PRIVATE opcionalmente combinado mediante una operación bit a bit OU con - RUNKIT7_ACC_STATIC - - - - - doc_comment - - - El comentario de documentación del método. - - - - - return_type - - - El tipo de retorno del método. - - - - - - is_strict - - - Si el método se comporta como si fuera declarado en un fichero con strict_types=1 - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo de <function>runkit7_method_add</function> - -add(12, 4); -?> -]]> - - &example.outputs; - - - - - - - &reftitle.seealso; - - runkit7_method_copy - runkit7_method_redefine - runkit7_method_remove - runkit7_method_rename - runkit7_function_add - - - - diff --git a/reference/runkit7/functions/runkit7-method-copy.xml b/reference/runkit7/functions/runkit7-method-copy.xml deleted file mode 100644 index 8d0e6837fb..0000000000 --- a/reference/runkit7/functions/runkit7-method-copy.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - runkit7_method_copy - Copia un método de una clase a otra - - - - &reftitle.description; - - boolrunkit7_method_copy - stringdestination_class - stringdestination_method_name - stringsource_class - stringsource_method_name - - - - - &reftitle.parameters; - - - destination_class - - - La clase de destino para el método copiado - - - - - destination_method_name - - - El nombre del método de destino - - - - - source_class - - - La clase fuente del método a copiar - - - - - source_method_name - - - El nombre del método a copiar de la clase fuente. Si este argumento es - omitido, se asume el valor de destination_method_name. - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo de <function>runkit7_method_copy</function> - - -]]> - - &example.outputs; - - - - - - - &reftitle.seealso; - - runkit7_method_add - runkit7_method_redefine - runkit7_method_remove - runkit7_method_rename - runkit7_function_copy - - - - - diff --git a/reference/runkit7/functions/runkit7-method-redefine.xml b/reference/runkit7/functions/runkit7-method-redefine.xml deleted file mode 100644 index 5d78a573b2..0000000000 --- a/reference/runkit7/functions/runkit7-method-redefine.xml +++ /dev/null @@ -1,198 +0,0 @@ - - - - - - runkit7_method_redefine - Cambiar dinámicamente el código del método dado - - - - &reftitle.description; - - boolrunkit7_method_redefine - stringclass_name - stringmethod_name - stringargument_list - stringcode - intflagsRUNKIT7_ACC_PUBLIC - stringdoc_comment&null; - stringreturn_type - boolis_strict - - - boolrunkit7_method_redefine - stringclass_name - stringmethod_name - Closureclosure - intflagsRUNKIT7_ACC_PUBLIC - stringdoc_comment&null; - stringreturn_type - boolis_strict - - - - - &reftitle.parameters; - - - class_name - - - La clase en la que redefinir el método - - - - - method_name - - - El nombre del método a redefinir - - - - - argument_list - - - La lista de argumentos separados por comas para el método redefinido - - - - - code - - - El nuevo código a evaluar cuando method_name - es llamado - - - - - closure - - - Una closure que define el método. - - - - - flags - - - El método redefinido puede ser - RUNKIT7_ACC_PUBLIC, - RUNKIT7_ACC_PROTECTED o - RUNKIT7_ACC_PRIVATE opcionalmente combinado mediante una operación bit a bit OU con - RUNKIT7_ACC_STATIC - - - - - doc_comment - - - El comentario de documentación del método. - - - - - return_type - - - El tipo de retorno del método. - - - - - is_strict - - - Si el método se comporta como si fuera declarado en un archivo con strict_types=1 - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo de <function>runkit7_method_redefine</function> - -foo(); - -// Redefine el método 'foo' -runkit7_method_redefine( - 'Example', - 'foo', - '', - 'return "bar!\n";', - RUNKIT7_ACC_PUBLIC -); - -// muestra Example::foo() (después de la redefinición) -echo "After: " . $e->foo(); -?> -]]> - - &example.outputs; - - - - - - - &reftitle.seealso; - - runkit7_method_add - runkit7_method_copy - runkit7_method_remove - runkit7_method_rename - runkit7_function_redefine - - - - - diff --git a/reference/runkit7/functions/runkit7-method-remove.xml b/reference/runkit7/functions/runkit7-method-remove.xml deleted file mode 100644 index 47cc2e9798..0000000000 --- a/reference/runkit7/functions/runkit7-method-remove.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - runkit7_method_remove - Elimina dinámicamente el método especificado - - - - &reftitle.description; - - boolrunkit7_method_remove - stringclass_name - stringmethod_name - - ¬e.runkit.selfmanipulation; - - - - &reftitle.parameters; - - - class_name - - - La clase de la cual eliminar el método - - - - - method_name - - - El nombre del método a eliminar - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - Ejemplo de <function>runkit7_method_remove</function> - - -]]> - - &example.outputs; - - - - - - - &reftitle.seealso; - - runkit7_method_add - runkit7_method_copy - runkit7_method_redefine - runkit7_method_rename - runkit7_function_remove - - - - - diff --git a/reference/runkit7/functions/runkit7-method-rename.xml b/reference/runkit7/functions/runkit7-method-rename.xml deleted file mode 100644 index 138b206b4e..0000000000 --- a/reference/runkit7/functions/runkit7-method-rename.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - runkit7_method_rename - Cambiar dinámicamente el nombre del método dado - - - - &reftitle.description; - - boolrunkit7_method_rename - stringclass_name - stringsource_method_name - stringtarget_method_name - - ¬e.runkit.selfmanipulation; - - - - &reftitle.parameters; - - - class_name - - - La clase en la que renombrar el método - - - - - source_method_name - - - El nombre del método a renombrar - - - - - target_method_name - - - El nuevo nombre a dar al método renombrado - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - Ejemplo de <function>runkit7_method_rename</function> - -bar(); -?> -]]> - - &example.outputs; - - - - - - - &reftitle.seealso; - - runkit7_method_add - runkit7_method_copy - runkit7_method_redefine - runkit7_method_remove - runkit7_function_rename - - - - diff --git a/reference/runkit7/functions/runkit7-object-id.xml b/reference/runkit7/functions/runkit7-object-id.xml deleted file mode 100644 index 71fa1e78f4..0000000000 --- a/reference/runkit7/functions/runkit7-object-id.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - runkit7_object_id - - Devuelve el identificador de objeto para un objeto dado - - - - - &reftitle.description; - - intrunkit7_object_id - objectobj - - - Esta función es equivalente a spl_object_id. - - - Esta función devuelve un identificador único para el objeto. El identificador - de objeto es único durante la vida del objeto. Una vez destruido el objeto, - su identificador puede ser reutilizado para otros objetos. Este comportamiento - es similar a spl_object_hash. - - - - - &reftitle.parameters; - - - obj - - - Un objeto cualquiera. - - - - - - - - &reftitle.returnvalues; - - Un identificador entero que es único para cada objeto actualmente existente - y siempre es el mismo para cada objeto. - - - - - &reftitle.notes; - - - Cuando un objeto es destruido, su identificador puede ser reutilizado para otros objetos. - - - - - &reftitle.seealso; - - spl_object_id - - - - diff --git a/reference/runkit7/functions/runkit7-superglobals.xml b/reference/runkit7/functions/runkit7-superglobals.xml deleted file mode 100644 index 639f11f5a1..0000000000 --- a/reference/runkit7/functions/runkit7-superglobals.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - runkit7_superglobals - - Devuelve un array indexado numéricamente de las superglobales registradas - - - - - &reftitle.description; - - arrayrunkit7_superglobals - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un array indexado numéricamente de las superglobales registradas. - Es decir, _GET, _POST, _REQUEST, _COOKIE, _SESSION, _SERVER, _ENV, _FILES - - - - - &reftitle.seealso; - - Ámbito de las variables - - - - - diff --git a/reference/runkit7/functions/runkit7-zval-inspect.xml b/reference/runkit7/functions/runkit7-zval-inspect.xml deleted file mode 100644 index 4ab452a7e2..0000000000 --- a/reference/runkit7/functions/runkit7-zval-inspect.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - runkit7_zval_inspect - Proporciona información sobre el valor pasado con los tipos de datos, los conteos de referencia, etc - - - - &reftitle.description; - - arrayrunkit7_zval_inspect - stringvalue - - - - - &reftitle.parameters; - - - value - - - El valor para el cual se devuelve la representación - - - - - - - - &reftitle.returnvalues; - - El array devuelto por esta función contiene los siguientes elementos: - - address - refcount (opcional) - is_ref (opcional) - type - - - - - - &reftitle.examples; - - Ejemplo de <function>runkit7_zval_inspect</function> - - -]]> - - &example.outputs; - - - string(14) "0x7f45ab21b1e0" - ["refcount"]=> - int(2) - ["is_ref"]=> - bool(false) - ["type"]=> - int(8) -} - -array(2) { - ["address"]=> - string(14) "0x7f45ab21b1e0" - ["type"]=> - int(4) -} -]]> - - - - - - &reftitle.seealso; - - References Explained - References Explained (by Derick Rethans) - - - - diff --git a/reference/runkit7/ini.xml b/reference/runkit7/ini.xml deleted file mode 100644 index b8dc96a8f4..0000000000 --- a/reference/runkit7/ini.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - -
    - &reftitle.runtime; - &extension.runtime; - - - Opciones de Configuración de Runkit - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - runkit.superglobal - "" - INI_PERDIR - - - - runkit.internal_override - "0" - INI_SYSTEM - - - - -
    - &ini.php.constants; -
    - -&ini.descriptions.title; - - - - - runkit.superglobal - string - - - - Una lista separada por comas de nombres de variables que van a ser tratadas como superglobales. - Este valor debería estar establecido a través del archivo php.ini, pero puede funcionar - en contextos de configuración por directorio dependiendo de su SAPI. - - - Superglobales personalizadas con runkit.superglobal=_FOO,_BAR en php.ini - - -]]> - - - - - - - - runkit.internal_override - boolean - - - - Habilita la capacidad de modificar/renombrar/eliminar funciones internas. - - - - - -
    - diff --git a/reference/runkit7/reference.xml b/reference/runkit7/reference.xml deleted file mode 100644 index 4c9bffb1ec..0000000000 --- a/reference/runkit7/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - &Functions; de runkit7 - - &reference.runkit7.entities.functions; - - - - diff --git a/reference/runkit7/setup.xml b/reference/runkit7/setup.xml deleted file mode 100644 index 359c6c076e..0000000000 --- a/reference/runkit7/setup.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Modificar constantes, funciones, clases y métodos - así como las superglobales personalizadas - funciona con todas las versiones de PHP 7. No se requieren - exigencias especiales. - -
    - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;runkit7. - - - &pecl.windows.download.avail; - -
    - - &reference.runkit7.ini; - -
    - diff --git a/reference/scoutapm/book.xml b/reference/scoutapm/book.xml deleted file mode 100644 index 520aa73829..0000000000 --- a/reference/scoutapm/book.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - ScoutAPM - ScoutAPM - - - &reftitle.intro; - ¬e.no-windows.extension; - - La extensión ScoutAPM proporciona funcionalidades adicionales para la supervisión de aplicaciones en comparación con el uso de la biblioteca del espacio de usuario PHP básica. - - - - &reference.scoutapm.setup; - &reference.scoutapm.reference; - - - diff --git a/reference/scoutapm/configure.xml b/reference/scoutapm/configure.xml deleted file mode 100644 index b1d907ad13..0000000000 --- a/reference/scoutapm/configure.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;scoutapm - - -
    - diff --git a/reference/scoutapm/functions/scoutapm-get-calls.xml b/reference/scoutapm/functions/scoutapm-get-calls.xml deleted file mode 100644 index e65bc51355..0000000000 --- a/reference/scoutapm/functions/scoutapm-get-calls.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - scoutapm_get_calls - Devuelve una lista de llamadas instrumentadas que se han producido - - - - &reftitle.description; - - arrayscoutapm_get_calls - - - Devuelve una lista de todas las llamadas a funciones instrumentadas registradas desde la última vez que la función scoutapm_get_calls fue llamada. La lista se borra cada vez que la función es llamada. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - scoutapm_get_calls devuelve un array que contiene una lista - de todas las llamadas registradas a funciones instrumentadas. - - - - - &reftitle.examples; - Obtener las llamadas instrumentadas - - -]]> - - &example.outputs.similar; - - Array - ( - [function] => file_get_contents - [entered] => 1576839727.7934 - [exited] => 1576839727.7935 - [time_taken] => 2.7894973754883E-5 - [argv] => Array - ( - [0] => a.txt - ) - - ) - - [1] => Array - ( - [function] => file_get_contents - [entered] => 1576839727.7935 - [exited] => 1576839727.7935 - [time_taken] => 7.8678131103516E-6 - [argv] => Array - ( - [0] => b.txt - ) - - ) - -) -]]> - - - - - - diff --git a/reference/scoutapm/functions/scoutapm-list-instrumented-functions.xml b/reference/scoutapm/functions/scoutapm-list-instrumented-functions.xml deleted file mode 100644 index 1e782fe47c..0000000000 --- a/reference/scoutapm/functions/scoutapm-list-instrumented-functions.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - scoutapm_list_instrumented_functions - Lista las funciones que scoutapm va a instrumentar. - - - - &reftitle.description; - - arrayscoutapm_list_instrumented_functions - - - Devuelve una lista de las funciones que la extensión va a instrumentar. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - scoutapm_list_instrumented_functions devuelve un array - que contiene una lista de todas las funciones que la extensión scoutapm es capaz - de instrumentar en la instalación actual. - - - - - &reftitle.examples; - Obtener la lista de funciones que scoutapm va a instrumentar - - -]]> - - &example.outputs.similar; - - file_get_contents - [1] => file_put_contents - [2] => fopen - [3] => fread - [4] => fwrite - [5] => pdo->exec - [6] => pdo->query - [7] => pdo->prepare - [8] => pdostatement->execute -) -]]> - - - - - - diff --git a/reference/scoutapm/reference.xml b/reference/scoutapm/reference.xml deleted file mode 100644 index 320e703158..0000000000 --- a/reference/scoutapm/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - &Functions; de Scoutapm - - &reference.scoutapm.entities.functions; - - - - diff --git a/reference/scoutapm/setup.xml b/reference/scoutapm/setup.xml deleted file mode 100644 index c86bbfe154..0000000000 --- a/reference/scoutapm/setup.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - - PHP >= 7.1.0 - - - Windows no es actualmente soportado - - -
    - -
    - &reftitle.install; - - Esta extensión está disponible en PECL. Ejecute: - - - - Puede que sea necesario añadir Scout a su php.ini, por ejemplo: - - - - -
    - -
    - diff --git a/reference/seaslog/book.xml b/reference/seaslog/book.xml deleted file mode 100644 index 5cfca15905..0000000000 --- a/reference/seaslog/book.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - Seaslog - Seaslog - - - &reftitle.intro; - - Seaslog es una extensión de registro eficiente, rápida y estable para PHP. - - - El registro, que generalmente es el registro de operaciones del sistema, - del software y de la aplicación. - A través del análisis del registro, puede facilitar a los usuarios comprender el funcionamiento del sistema, - del software y de la aplicación. - Si el registro de la aplicación es lo suficientemente rico, - también puede analizar el comportamiento operativo del usuario anterior, el tipo, - la distribución regional u otra información adicional. El registro de la aplicación también indica múltiples niveles al mismo tiempo, - puede obtener fácilmente el análisis del estado de salud de la aplicación, - encontrar rápidamente los problemas y localizarlos rápidamente, y resolver el problema, remediar la pérdida. - - - La función error_log, syslog que está integrada en PHP es potente y tiene un excelente rendimiento, - pero debido a varios defectos (error_log no tiene nivel de error, no tiene formato fijo, syslog independientemente del módulo, - y se mezcla con el registro del sistema), reduce mucho la flexibilidad y no puede satisfacer los requisitos de la aplicación. - - - La buena noticia es que existen varias bibliotecas de clases de registro de terceros establecidas - para compensar los defectos, como log4php, plog, monolog (por supuesto, - hay muchas aplicaciones en el desarrollo de proyectos de la clase de registro). - - - Por lo tanto, hay una biblioteca de registro que cumple con los siguientes requisitos: - - Módulos, clasificación - Configuración simple (preferiblemente sin configuración) - Formato de registro claro y fácil de entender - Aplicación simple y buen rendimiento - - Seaslog cumple con estas demandas. - - - Lo que se proporciona actualmente: - - En el proyecto PHP, registrar la especificación del registro y repidly. - Configurar el directorio de registro predeterminado y el módulo - Directorio de registro especificado y captura de la configuración actual - Análisis preliminar del marco de alerta temprana - Tampon de registro eficiente y depuración de tampon práctica - Seguir la especificación de la interfaz de registro PSR-3 - Registrar automáticamente la información de error - Registrar automáticamente la información anormal - Soporte Conectar el puerto TCP, enviar con RFC5424 - Soporte Conectar el puerto UDP, enviar con RFC5424 - Soporte RequestId diferencia las solicitudes - Soporte para las personalizaciones de plantilla de registro - - - - Ver más Document SeasLog en Github. - - - - &reference.seaslog.setup; - &reference.seaslog.constants; - &reference.seaslog.examples; - &reference.seaslog.reference; - &reference.seaslog.seaslog; - - - diff --git a/reference/seaslog/configure.xml b/reference/seaslog/configure.xml deleted file mode 100644 index d729bfea46..0000000000 --- a/reference/seaslog/configure.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;seaslog - - -
    - diff --git a/reference/seaslog/constants.xml b/reference/seaslog/constants.xml deleted file mode 100644 index c2b891554b..0000000000 --- a/reference/seaslog/constants.xml +++ /dev/null @@ -1,269 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - SEASLOG_VERSION - (string) - - - - - - - - - SEASLOG_AUTHOR - (string) - - - - - - - - - SEASLOG_ALL - (string) - - - - "ALL" - - - - - - SEASLOG_DEBUG - (string) - - - - "DEBUG" - Información detallada de depuración. Información detallada sobre los eventos. - - - - - - SEASLOG_INFO - (string) - - - - "INFO" - Eventos interesantes. Énfasis en el proceso de ejecución de la aplicación. - - - - - - SEASLOG_NOTICE - (string) - - - - "NOTICE" - Eventos normales pero significativos. Información más importante que el nivel INFO durante la ejecución. - - - - - - SEASLOG_WARNING - (string) - - - - "WARNING" - Ocurrencias excepcionales que no son errores. Información aberrante potencial que requiere atención y debe ser reparada. - - - - - - SEASLOG_ERROR - (string) - - - - "ERROR" - Errores de funcionamiento que no requieren acción inmediata pero que deberían necesitarla típicamente. - - - - - - SEASLOG_CRITICAL - (string) - - - - "CRITICAL" - Condiciones críticas. Requiere reparación inmediata, y el componente del programa está indisponible. - - - - - - SEASLOG_ALERT - (string) - - - - "ALERT" - Acción debe ser tomada inmediatamente. Atención inmediata debe ser prestada al personal concernido para las reparaciones de emergencia. - - - - - - SEASLOG_EMERGENCY - (string) - - - - "EMERGENCY" - Sistema inutilizable. - - - - - - SEASLOG_DETAIL_ORDER_ASC - (int) - - - - 1 - - - - - - SEASLOG_DETAIL_ORDER_DESC - (int) - - - - 2 - - - - - - SEASLOG_APPENDER_FILE - (int) - - - - 1 - - - - - - SEASLOG_APPENDER_TCP - (int) - - - - 2 - - - - - - SEASLOG_APPENDER_UDP - (int) - - - - 3 - - - - - - SEASLOG_CLOSE_LOGGER_STREAM_MOD_ALL - (int) - - - - 1 - - - - - - SEASLOG_CLOSE_LOGGER_STREAM_MOD_ASSIGN - (int) - - - - 2 - - - - - - SEASLOG_REQUEST_VARIABLE_DOMAIN_PORT - (int) - - - - 1 - - - - - - SEASLOG_REQUEST_VARIABLE_REQUEST_URI - (int) - - - - 2 - - - - - - SEASLOG_REQUEST_VARIABLE_REQUEST_METHOD - (int) - - - - 3 - - - - - - SEASLOG_REQUEST_VARIABLE_CLIENT_IP - (int) - - - - 4 - - - - - - diff --git a/reference/seaslog/examples.xml b/reference/seaslog/examples.xml deleted file mode 100644 index 527230ace2..0000000000 --- a/reference/seaslog/examples.xml +++ /dev/null @@ -1,213 +0,0 @@ - - - - - &reftitle.examples; - - - Obtener y definir la ruta de base - - -]]> - - &example.outputs.similar; - - - - - - - Obtener y definir el registro - - -]]> - - &example.outputs.similar; - - - - - - - Registro de escritura rápida - - 'neeke')); -SeasLog::info('this is a info log'); -SeasLog::notice('this is a notice log'); -SeasLog::warning('your {website} was down,please {action} it ASAP!',array('{website}' => 'github.com','{action}' => 'rboot')); -SeasLog::error('a error log'); -SeasLog::critical('some thing was critical'); -SeasLog::alert('yes this is a {messageName}',array('{messageName}' => 'alertMSG')); -SeasLog::emergency('Just now, the house next door was completely burnt out! {note}',array('{note}' => 'it`s a joke')); -?> -]]> - - - Por omisión, seaslog.default_template = "%T | %L | %P | %Q | %t | %M". - Esto significa que, por omisión, el estilo del registro es: `{dateTime} | {level} | {pid} | {uniqid} | {timeStamp} | {logInfo}`. - - &example.outputs.similar; - - seaslog.appender = 1 - - - - - &example.outputs.similar; - - seaslog.appender = 2 or seaslog.appender = 3 - - -1 2017-08-27T01:24:59+08:00 vagrant-ubuntu-trusty test/logger[27171]: 2016-06-25 00:59:43 | DEBUG | 21423 | 599157af4e937 | 1466787583.322 | this is a neeke debug -<14>1 2017-08-27T01:24:59+08:00 vagrant-ubuntu-trusty test/logger[27171]: 2016-06-25 00:59:43 | INFO | 21423 | 599157af4e937 | 1466787583.323 | this is a info log -<13>1 2017-08-27T01:24:59+08:00 vagrant-ubuntu-trusty test/logger[27171]: 2016-06-25 00:59:43 | NOTICE | 21423 | 599157af4e937 | 1466787583.324 | this is a notice log -]]> - - - - - Contar rápidamente ciertos tipos de valores de registro - - SeasLog recupera el conteo del valor `grep -wc` utilizando el tubo del sistema y lo devuelve a PHP (array o integer). - - - -]]> - - &example.outputs.similar; - - - int(3) - ["INFO"]=> - int(3) - ["NOTICE"]=> - int(3) - ["WARNING"]=> - int(3) - ["ERROR"]=> - int(6) - ["CRITICAL"]=> - int(3) - ["ALERT"]=> - int(3) - ["EMERGENCY"]=> - int(3) -} -int(7) -int(1) -]]> - - - - - Obtener algunos tipos de lista de registros - - SeasLog recupera la lista de valores de `grep -w` utilizando el tubo del sistema y la devuelve a PHP. - - - -]]> - - &example.outputs.similar; - - - string(83) "2014-02-24 00:14:02 | ERROR | 8568 | 599157af4e937 | 1393172042.717 | test error 3 " - [1] => - string(83) "2014-02-24 00:14:04 | ERROR | 8594 | 5991576584446 | 1393172044.104 | test error 3 " - [2] => - string(83) "2014-02-24 00:14:04 | ERROR | 8620 | 1502697015147 | 1393172044.862 | test error 3 " - [3] => - string(83) "2014-02-24 00:14:05 | ERROR | 8646 | 599159975a9ff | 1393172045.989 | test error 3 " - [4] => - string(83) "2014-02-24 00:14:07 | ERROR | 8672 | 599159986ec28 | 1393172047.882 | test error 3 " - [5] => - string(83) "2014-02-24 00:14:08 | ERROR | 8698 | 5991599981cec | 1393172048.736 | test error 3 " -} - -array(2) { - [0] => - string(83) "2014-02-24 00:14:02 | ERROR | 8568 | 599157af4e937 | 1393172042.717 | test error 3 " - [1] => - string(83) "2014-02-24 00:14:04 | ERROR | 8594 | 5991576584446 | 1393172044.104 | test error 3 " -} -]]> - - - - - diff --git a/reference/seaslog/functions/seaslog-get-author.xml b/reference/seaslog/functions/seaslog-get-author.xml deleted file mode 100644 index 91fb15d035..0000000000 --- a/reference/seaslog/functions/seaslog-get-author.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - seaslog_get_author - Devuelve el autor de SeasLog. - - - - &reftitle.description; - - stringseaslog_get_author - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el autor de SeasLog como string. - - - - - &reftitle.examples; - - Ejemplo de <function>seaslog_get_author</function> - - -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/seaslog/functions/seaslog-get-version.xml b/reference/seaslog/functions/seaslog-get-version.xml deleted file mode 100644 index 4e88796d40..0000000000 --- a/reference/seaslog/functions/seaslog-get-version.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - seaslog_get_version - Devuelve la versión de SeasLog. - - - - &reftitle.description; - - stringseaslog_get_version - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la versión de SeasLog (SEASLOG_VERSION) como string. - - - - - &reftitle.examples; - - Ejemplo de <function>seaslog_get_version</function> - - -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/seaslog/ini.xml b/reference/seaslog/ini.xml deleted file mode 100644 index 7d2aafebca..0000000000 --- a/reference/seaslog/ini.xml +++ /dev/null @@ -1,629 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - &ConfigureOptions; de Seaslog - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - seaslog.appender - 1 - INI_SYSTEM - - - - seaslog.appender_retry - 0 - INI_ALL - - - - seaslog.level - 8 - INI_ALL - - - - seaslog.remote_host - 127.0.0.1 - INI_ALL - - - - seaslog.remote_port - 514 - INI_ALL - - - - seaslog.remote_timeout - 1 - INI_SYSTEM - - - - seaslog.default_basepath - /var/log/www - INI_SYSTEM - - - - seaslog.default_logger - default - INI_SYSTEM - - - - seaslog.default_template - %T | %L | %P | %Q | %t | %M - INI_SYSTEM - - - - seaslog.default_datetime_format - Y-m-d H:i:s - INI_SYSTEM - - - - seaslog.trace_error - 1 - INI_ALL - - - - seaslog.trace_exception - 0 - INI_SYSTEM - - - - seaslog.trace_notice - 0 - INI_ALL - - - - seaslog.trace_warning - 0 - INI_ALL - - - - seaslog.use_buffer - 0 - INI_SYSTEM - - - - seaslog.buffer_size - 0 - INI_ALL - - - - seaslog.buffer_disabled_in_cli - 0 - INI_SYSTEM - - - - seaslog.disting_type - 0 - INI_SYSTEM - - - - seaslog.disting_folder - 1 - INI_SYSTEM - - - - seaslog.disting_by_hour - 0 - INI_SYSTEM - - - - seaslog.recall_depth - 0 - INI_ALL - - - - seaslog.trim_wrap - 0 - INI_ALL - - - - seaslog.ignore_warning - 1 - INI_ALL - - - - seaslog.throw_exception - 1 - INI_ALL - - - - -
    - - &ini.descriptions.title; - - - - - seaslog.appender - int - - - - Cambia el almacén de datos del registro. 1Fichero 2TCP 3UDP (Cambiar por omisión 1) - - - Seaslog enviará el registro al servidor tcp://remote_host:remote_port o udp://remote_host:remote_port, - cuando seaslog.appender está configurado a 2 (TCP) o 3 (UDP). - - - Cuando SeasLog envía un registro a TCP/UDP, el estilo sigue la RFC5424. - El {logInfo} es afectado por seaslog.default_template. - - - 1 2017-08-27T01:24:59+08:00 vagrant-ubuntu-trusty test/logger[27171]: 2016-06-25 00:59:43 | DEBUG | 21423 | 599157af4e937 | 1466787583.322 | this is a neeke debug -<14>1 2017-08-27T01:24:59+08:00 vagrant-ubuntu-trusty test/logger[27171]: 2016-06-25 00:59:43 | INFO | 21423 | 599157af4e937 | 1466787583.323 | this is a info log -<13>1 2017-08-27T01:24:59+08:00 vagrant-ubuntu-trusty test/logger[27171]: 2016-06-25 00:59:43 | NOTICE | 21423 | 599157af4e937 | 1466787583.324 | this is a notice log - ]]> - - - - - - seaslog.appender_retry - int - - - - El conteo de reintentos del registro. - 0 (No reintentar) - - - - - - seaslog.buffer_disabled_in_cli - int - - - - Desactiva el búfer en el CLI. 1-Y 0-N (Por omisión) - - - Activar el conmutador buffer_disabled_in_cli. - El conmutador buffer_disabled_in_cli por omisión está desactivado. - Si el conmutador buffer_disabled_in_cli está activado y se ejecuta en CLI, - el parámetro seaslog.use_buffer será ignorado, - Seaslog escribirá INMEDIATAMENTE en el almacén de datos. - - - - - - seaslog.buffer_size - int - - - - Configura el tamaño del búfer con 100. - El tamaño del búfer por omisión 0, esto significa no usar búfer. - Si buffer_size > 0, SeasLog reescribirá hacia abajo en el almacén de datos - cuando el registro pregrabado en memoria es >= a este buffer_size, luego refrescará el grupo de memoria. - - - - - - seaslog.default_basepath - string - - - - La ruta base del registro por omisión. Por omisión "/var/log/www". - - - - - - seaslog.default_datetime_format - string - - - - El formato de la fecha y la hora. Por omisión "Y-m-d H:i:s". - - - - - - seaslog.default_logger - string - - - - La ruta del registro por omisión. Por omisión "default". - - - - - - seaslog.disting_by_hour - int - - - - El conmutador usa el registro con la hora. 1-Y 0-N (Por omisión) - - - - seaslog.disting_by_hour = 1 El conmutador usa Logger DisTing por hora. - Esto significa que SeasLog creará el fichero cada hora. - - - - - - - seaslog.disting_folder - int - - - - El conmutador usa el registro con la carpeta. 1-Y (Por omisión) 0-N - - - - seaslog.disting_folder = 1 El conmutador usa Logger DisTing por carpeta. - Esto significa que SeasLog creará el fichero deistic por carpeta, - y cuando esta configuración está desactivada, SeasLog creará el fichero - utilice el conector de subrayado Logger y Time como default_20180211.log. - - - - - - - seaslog.disting_type - int - - - - El conmutador usa el registro con el tipo. 1-Y 0-N (Por omisión) - - - - seaslog.disting_type = 1 El conmutador usa Logger DisTing por tipo, - esto significa que SeasLog creará el fichero deistic info\warn\error y otro tipo. - - - - - - - seaslog.ignore_warning - int - - - - El conmutador ignora las advertencias de SeasLog. 1-On (Por omisión) 0-Off - - - - seaslog.ignore_warning = 1 Abrir una advertencia para ignorar SeasLog mismo. - Cuando los permisos de directorio o los puertos del servidor de recepción están bloqueados, son ignorados; - cuando están cerrados, se lanza una advertencia. - - - - - - - seaslog.level - int - - - - El nivel de registro. Por omisión 8 (Todos). - 0-EMERGENCY 1-ALERT 2-CRITICAL 3-ERROR 4-WARNING 5-NOTICE 6-INFO 7-DEBUG 8-TODOS - - - - Consejo: El elemento de configuración ha cambiado desde la versión 1.7.0. - Antes de la versión 1.7.0, cuanto más pequeño es el valor, más registros se toman según el nivel: - 0-todos 1-depuración 2-info 3-avisos 4-advertencia 5-error 6-crítico 7-alerta 8-emergencia - Antes de la versión 1.7.0, por omisión 0 (Todos). - - - - - - - seaslog.recall_depth - int - - - - La profundidad de llamada de la función. Esto afectará la variable LineNo en %F. - Por omisión 0 - - - - - - seaslog.remote_host - string - - - - Si se utiliza Record TCP o UDP, configure este host remoto. Por omisión "127.0.0.1" - - - - - - seaslog.remote_port - int - - - - Si se utiliza Record TCP o UDP, configure este puerto remoto. Por omisión 514 - - - - - - seaslog.remote_timeout - int - - - - Si se utiliza Record TCP o UDP, configure este tiempo de espera remoto. Por omisión 1 segundo - - - - - - seaslog.throw_exception - int - - - - El conmutador lanza la excepción SeasLog. 1-On (Por omisión) 0-Off - - - - seaslog.throw_exception = 1 Abrir una excepción que lanza el SeasLog para lanzarse a sí mismo. - Cuando los permisos de directorio o los puertos del servidor de recepción están bloqueados, - lance una excepción; no lance una excepción cuando están cerrados. - - - - - - - seaslog.trace_error - int - - - - Registrar automáticamente el error final con el registro por omisión. 1-Y (Por omisión) 0-N - - - - - - seaslog.trace_exception - int - - - - Registrar automáticamente la excepción con el registro por omisión. 1-Y 0-N (Por omisión) - - - - - - seaslog.trace_notice - int - - - - Registrar automáticamente el aviso con el registro por omisión. 1-Y 0-N (Por omisión) - - - - - - seaslog.trace_warning - int - - - - Registrar automáticamente la advertencia con el registro por omisión. 1-Y 0-N (Por omisión) - - - - - - seaslog.trim_wrap - int - - - - Recortar los \n y \r en el mensaje del registro. 1-On 0-Off (Por omisión) - - - - - - seaslog.use_buffer - int - - - - El conmutador usa el búfer del registro con la memoria. 1-Y 0-N (Por omisión) - - - - seaslog.use_buffer = 1 Activa el conmutador use_buffer. - El conmutador use_buffer por omisión está desactivado. - Si el conmutador use_buffer está activado, SeasLog pregraba el registro con la memoria, - y serán reescritos en el almacén de datos por solicitud de parada - o salida del proceso php (PHP RSHUTDOWN o PHP MSHUTDOWN). - - - - - - - seaslog.default_template - string - - - - La plantilla de registro por omisión. - Por omisión "%T | %L | %P | %Q | %t | %M". - - - - Las siguientes variables por omisión se proporcionan, - que pueden ser usadas directamente en la plantilla de registro y reemplazadas por un valor correspondiente - cuando el registro es finalmente generado. - - - La plantilla de registro por omisión es: seaslog.default_template = "%T | %L | %P | %Q | %t | %M", - esto significa que el estilo de registro por omisión es: {dateTime} | {level} | {pid} | {uniqid} | {timeStamp} | {logInfo} - - - Si se tiene una plantilla de registro personalizada, como: seaslog.default_template = "[%T]:%L %P %Q %t %M", - esto significará que el estilo de registro ha sido personalizado como: [{dateTime}]:{level} {pid} {uniqid} {timeStamp} {logInfo} - - - Tabla de variables por omisión de Seaslog - - - - Nombre de variable - Descripción - - - - - %L - Nivel. - - - %M - Mensaje. - - - %T - Fecha y hora. Como 2017-08-16 19:15:02, afectado por seaslog.default_datetime_format. - - - %t - Marca de tiempo. Como 1502882102.862, preciso a la milésima de segundo. - - - %Q - El identificador de solicitud. Para distinguir una sola solicitud, - no invocar la función SeasLog::setRequestId($string), - el valor único generado por la función integrada static char *get_uniqid() - cuando la solicitud es inicializada es usado. - - - %H - El nombre de host. - - - %P - El identificador del proceso. - - - %D - Dominio:Puerto. Como www.cloudwise.com:80; Con la Cli, como cli. - - - %R - El URI de la solicitud. Como /app/user/signin; - Con la Cli, es el script de índice, como CliIndex.php. - - - %m - El método de la solicitud. Como Get; Con la Cli, es el script de comando, como /bin/bash. - - - %I - La IP del Cliente; Con la Cli es local. - El valor de prioridad: HTTP_X_REAL_IP > HTTP_X_FORWARDED_FOR > REMOTE_ADDR - - - %F - Nombre del Fichero:Número de línea. Como UserService.php:118. - - - %U - Uso de la memoria. byte. Llamada zend_memory_usage. - - - %u - Uso máximo de la memoria. byte. Llamada zend_memory_peak_usage. - - - %C - TODO Clase::Acción. Como UserService::getUserInfo - - - -
    -
    -
    -
    -
    -
    - diff --git a/reference/seaslog/reference.xml b/reference/seaslog/reference.xml deleted file mode 100644 index c0693b2bf1..0000000000 --- a/reference/seaslog/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - &Functions; de Seaslog - - &reference.seaslog.entities.functions; - - - - diff --git a/reference/seaslog/seaslog.xml b/reference/seaslog/seaslog.xml deleted file mode 100644 index 53c24d1fd2..0000000000 --- a/reference/seaslog/seaslog.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - La clase SeasLog - SeasLog - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - SeasLog - - - - - SeasLog - - - - - &Methods; - - - - -
    - -
    - - &reference.seaslog.entities.seaslog; - -
    - diff --git a/reference/seaslog/seaslog/alert.xml b/reference/seaslog/seaslog/alert.xml deleted file mode 100644 index 637c786668..0000000000 --- a/reference/seaslog/seaslog/alert.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - SeasLog::alert - Registra la información del registro de alerta - - - - &reftitle.description; - - public static boolSeasLog::alert - stringmessage - arraycontent - stringlogger - - - Registra la información del registro de alerta. - - - "ALERT" - Se debe tomar una acción inmediatamente. - Se debe prestar atención inmediata al personal concernido para reparaciones de emergencia. - - - - - - - - &reftitle.parameters; - - - message - - - El mensaje del registro. - - - - - content - - - El `message` contiene marcadores de posición que los implementadores reemplazan con valores del array de contenido. - Por ejemplo, si el `message` es 'log info desde {NAME}' y el 'content' es 'array('NAME' => neeke)', - la información del registro será 'log info desde neeke'. - - - - - logger - - - El `logger` causado por el tercer argumento sería utilizado a partir de ahora, - como un registro temporal, cuando la función SeasLog::setLogger() es llamada en el contenido anterior. - Si `logger` es NULL o "", SeasLog utilizará el último registro definido por SeasLog::setLogger. - - - - - - - - &reftitle.returnvalues; - - Retorna TRUE en caso de éxito en el registro de la información del registro, FALSE en caso de fallo. - - - - - &reftitle.examples; - - Ejemplo de <function>SeasLog::alert</function> - - 'neeke'))); - -//con registro temporal -var_dump(SeasLog::alert('log message from {NAME}',array('NAME' => 'neeke'),'tmp_logger')); - -var_dump(SeasLog::getBuffer()); - -?> -]]> - - &example.outputs.similar; - - - array(2) { - [0]=> - string(81) "2018-07-07 11:45:49 | ALERT | 73263 | 5b40376d1067c | 1530935149.68 | log message -" - [1]=> - string(92) "2018-07-07 11:45:49 | ALERT | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } - ["/var/log/www/tmp_logger/20180707.log"]=> - array(1) { - [0]=> - string(92) "2018-07-07 11:45:49 | ALERT | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } -} -]]> - - - - - - &reftitle.seealso; - - seaslog.default_template - SeasLog::debug - SeasLog::info - SeasLog::notice - SeasLog::warning - SeasLog::error - SeasLog::critical - SeasLog::emergency - SeasLog::log - - - - - diff --git a/reference/seaslog/seaslog/analyzercount.xml b/reference/seaslog/seaslog/analyzercount.xml deleted file mode 100644 index b49f4c0342..0000000000 --- a/reference/seaslog/seaslog/analyzercount.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - SeasLog::analyzerCount - Devuelve el número de registros por nivel, ruta de acceso del registro y palabra clave - - - - &reftitle.description; - - public static mixedSeasLog::analyzerCount - stringlevel - stringlog_path - stringkey_word - - - `SeasLog` obtiene el valor del contador de `grep -ai '{level}' | grep -aic '{key_word}'` - utiliza el pipe del sistema y devuelve a PHP (array o integer). - - - - - - &reftitle.parameters; - - - level - - - String. El nivel de información del registro. - - - - - log_path - - - String. La ruta de acceso de la información del registro. - - - - - key_word - - - String. La palabra clave de búsqueda para la información del registro. - - - - - - - - &reftitle.returnvalues; - - Si `level` es SEASLOG_ALL o está vacío, devuelve todos los niveles contados como `array`. - Si `level` es SEASLOG_INFO o cualquier otro nivel, devuelve el contador como `integer`. - - - - - &reftitle.examples; - - Ejemplo de <function>SeasLog::analyzerCount</function> - - -]]> - - &example.outputs.similar; - - - int(180) - ["INFO"]=> - int(214) - ["NOTICE"]=> - int(0) - ["WARNING"]=> - int(0) - ["ERROR"]=> - int(228) - ["CRITICAL"]=> - int(244) - ["ALERT"]=> - int(1) - ["EMERGENCY"]=> - int(0) -} - -int(180) - -int(228) - -int(29) -]]> - - - - - - &reftitle.seealso; - - SeasLog::analyzerDetail - - - - - diff --git a/reference/seaslog/seaslog/analyzerdetail.xml b/reference/seaslog/seaslog/analyzerdetail.xml deleted file mode 100644 index 313759a40e..0000000000 --- a/reference/seaslog/seaslog/analyzerdetail.xml +++ /dev/null @@ -1,183 +0,0 @@ - - - - - - SeasLog::analyzerDetail - Devuelve los detalles del registro por nivel, ruta de registro, palabra clave, inicio, límite, orden - - - - &reftitle.description; - - public static mixedSeasLog::analyzerDetail - stringlevel - stringlog_path - stringkey_word - intstart - intlimit - intorder - - - `SeasLog` obtiene los resultados - `grep -ai '{level}' | grep -ai '{key_word}' | sed -n '{start},{limit}'p` - utiliza el pipe del sistema y devuelve un array a PHP. - - - - - - &reftitle.parameters; - - - level - - - String. El nivel de información del registro. - - - - - log_path - - - String. La ruta de la información del registro. - - - - - key_word - - - String. La palabra clave de búsqueda para la información del registro. - - - - - start - - - Integer. Por omisión, `1`. - - - - - limit - - - Integer. Por omisión, `20`. - - - - - order - - - Integer. Por omisión, SEASLOG_DETAIL_ORDER_ASC. - Ver también: - - SEASLOG_DETAIL_ORDER_ASC - SEASLOG_DETAIL_ORDER_DESC - - - - - - - - - &reftitle.returnvalues; - - Devuelve los resultados en forma de array. - - - Cuando `start`,`limit` no es NULL y en Windows, - SeasLog lanzará una excepción con el mensaje 'Param start and limit don't support Windows'. - - - - - - - &reftitle.examples; - - Ejemplo de <function>SeasLog::analyzerDetail</function> - - -]]> - - &example.outputs.similar; - - - string(93) "2018-07-09 12:52:53 | ERROR | 12247 | 5b42ea2580e51 | 1531111973.528 | log message from neeke" - [1]=> - string(93) "2018-07-09 12:52:54 | ERROR | 12256 | 5b42ea26d6657 | 1531111974.878 | log message from neeke" - [2]=> - string(93) "2018-07-09 12:52:55 | ERROR | 12265 | 5b42ea277b8d4 | 1531111975.506 | log message from neeke" - [3]=> - string(104) "2018-07-09 12:52:55 | ERROR | 12274 | 5b42ea27db5dc | 1531111975.898 | log message from the other people" -... -} - -array(3) { - [0]=> - string(93) "2018-07-09 12:52:53 | ERROR | 12247 | 5b42ea2580e51 | 1531111973.528 | log message from neeke" - [1]=> - string(93) "2018-07-09 12:52:54 | ERROR | 12256 | 5b42ea26d6657 | 1531111974.878 | log message from neeke" - [2]=> - string(93) "2018-07-09 12:52:55 | ERROR | 12265 | 5b42ea277b8d4 | 1531111975.506 | log message from neeke" -} - -array(2) { - [0]=> - string(93) "2018-07-09 12:52:53 | ERROR | 12247 | 5b42ea2580e51 | 1531111973.528 | log message from neeke" - [1]=> - string(93) "2018-07-09 12:52:54 | ERROR | 12256 | 5b42ea26d6657 | 1531111974.878 | log message from neeke" -} -]]> - - - - - - &reftitle.seealso; - - SeasLog::analyzerCount - - - - - diff --git a/reference/seaslog/seaslog/closeloggerstream.xml b/reference/seaslog/seaslog/closeloggerstream.xml deleted file mode 100644 index aaedbd8a0d..0000000000 --- a/reference/seaslog/seaslog/closeloggerstream.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - SeasLog::closeLoggerStream - Libera manualmente el flujo de registro del registro - - - - &reftitle.description; - - public static boolSeasLog::closeLoggerStream - intmodel - stringlogger - - - Libera manualmente el flujo de registro del registro. - SeasLog almacena en caché el gestor de flujo abierto por el registro para ahorrar en la carga adicional de la creación de un flujo. El gestor será liberado automáticamente al final de la petición. - Si en modo CLI, el proceso también liberará automáticamente cuando termine. O se pueden utilizar las siguientes funciones para liberar manualmente (la función de liberación manual debe actualizar SeasLog 1.8.6 o versión posterior). - - - - - - &reftitle.parameters; - - - model - - - Una constante de entero. - - SEASLOG_CLOSE_LOGGER_STREAM_MOD_ALL - SEASLOG_CLOSE_LOGGER_STREAM_MOD_ASSIGN - - - - - - logger - - - El nombre del registro. - - - - - - - - &reftitle.returnvalues; - - Devuelve TRUE en caso de éxito del flujo de registro liberado, FALSE en caso de fallo. - - - - - &reftitle.examples; - - Ejemplo de <methodname>SeasLog::closeLoggerStream</methodname> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SeasLog::setLogger - SeasLog::getLastLogger - - - - - diff --git a/reference/seaslog/seaslog/construct.xml b/reference/seaslog/seaslog/construct.xml deleted file mode 100644 index 9c4768bed0..0000000000 --- a/reference/seaslog/seaslog/construct.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - SeasLog::__construct - Descripción - - - - &reftitle.description; - - public SeasLog::__construct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - &reftitle.examples; - - Ejemplo de <function>SeasLog::__construct</function> - - -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/seaslog/seaslog/critical.xml b/reference/seaslog/seaslog/critical.xml deleted file mode 100644 index 0fbe10e6ea..0000000000 --- a/reference/seaslog/seaslog/critical.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - SeasLog::critical - Registra la información de registro crítica - - - - &reftitle.description; - - public static boolSeasLog::critical - stringmessage - arraycontent - stringlogger - - - Registra la información de registro crítica. - - - "CRITICAL" - Condiciones críticas. Deben ser reparadas de inmediato, y el componente del programa no está disponible. - - - - - - - - &reftitle.parameters; - - - message - - - El mensaje de registro. - - - - - content - - - El `message` contiene marcadores de posición que los implementadores reemplazan con valores del array de contenido. - Por ejemplo, si `message` es `log info from {NAME}` y `content` es `array('NAME' => neeke)`, - la información de registro será `log info from neeke`. - - - - - logger - - - El `registro` pasado por el tercer parámetro sería utilizado ahora, - como un registro temporal, cuando la función SeasLog::setLogger() es llamada en el contenido anterior. - Si `logger` es NULL o "", SeasLog utilizará el último registro definido por SeasLog::setLogger. - - - - - - - - &reftitle.returnvalues; - - Devuelve TRUE en caso de éxito en el registro de la información de registro, FALSE en caso de fallo. - - - - - &reftitle.examples; - - Ejemplo de <function>SeasLog::critical</function> - - 'neeke'))); - -//con registro temporal -var_dump(SeasLog::critical('log message from {NAME}',array('NAME' => 'neeke'),'tmp_logger')); - -var_dump(SeasLog::getBuffer()); - -?> -]]> - - &example.outputs.similar; - - - array(2) { - [0]=> - string(81) "2018-07-07 11:45:49 | CRITICAL | 73263 | 5b40376d1067c | 1530935149.68 | log message -" - [1]=> - string(92) "2018-07-07 11:45:49 | CRITICAL | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } - ["/var/log/www/tmp_logger/20180707.log"]=> - array(1) { - [0]=> - string(92) "2018-07-07 11:45:49 | CRITICAL | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } -} -]]> - - - - - - &reftitle.seealso; - - seaslog.default_template - SeasLog::debug - SeasLog::info - SeasLog::notice - SeasLog::warning - SeasLog::error - SeasLog::alert - SeasLog::emergency - SeasLog::log - - - - - diff --git a/reference/seaslog/seaslog/debug.xml b/reference/seaslog/seaslog/debug.xml deleted file mode 100644 index 9940d5d7d3..0000000000 --- a/reference/seaslog/seaslog/debug.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - SeasLog::debug - Registra la información de depuración - - - - &reftitle.description; - - public static boolSeasLog::debug - stringmessage - arraycontent - stringlogger - - - Registra la información de depuración. - - - "DEBUG" - Información de depuración detallada. Eventos de información detallados. - - - - - - - - &reftitle.parameters; - - - message - - - El mensaje del registro. - - - - - content - - - El `message` contiene espacios reservados que los implementadores reemplazan por valores del array de contenido. - Por ejemplo, si `message` es `log info from {NAME}` y `content` es `array('NAME' => neeke)`, - la información de registro será `log info from neeke`. - - - - - logger - - - El `registro` pasado como tercer argumento sería utilizado a partir de ahora, - como un registro temporal, cuando la función SeasLog::setLogger() es llamada en el contenido anterior. - Si `logger` es NULL o "", SeasLog utilizará el último registro definido por SeasLog::setLogger. - - - - - - - - &reftitle.returnvalues; - - Devuelve TRUE en caso de éxito en el registro de la información de depuración, FALSE en caso de fallo. - - - - - &reftitle.examples; - - Ejemplo de <function>SeasLog::debug</function> - - 'neeke'))); - -//con registro temporal -var_dump(SeasLog::debug('log message from {NAME}',array('NAME' => 'neeke'),'tmp_logger')); - -var_dump(SeasLog::getBuffer()); - -?> -]]> - - &example.outputs.similar; - - - array(2) { - [0]=> - string(81) "2018-07-07 11:45:49 | DEBUG | 73263 | 5b40376d1067c | 1530935149.68 | log message -" - [1]=> - string(92) "2018-07-07 11:45:49 | DEBUG | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } - ["/var/log/www/tmp_logger/20180707.log"]=> - array(1) { - [0]=> - string(92) "2018-07-07 11:45:49 | DEBUG | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } -} -]]> - - - - - - &reftitle.seealso; - - seaslog.default_template - SeasLog::info - SeasLog::notice - SeasLog::warning - SeasLog::error - SeasLog::critical - SeasLog::alert - SeasLog::emergency - SeasLog::log - - - - - diff --git a/reference/seaslog/seaslog/destruct.xml b/reference/seaslog/seaslog/destruct.xml deleted file mode 100644 index 9e4c26cf15..0000000000 --- a/reference/seaslog/seaslog/destruct.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - SeasLog::__destruct - Descripción - - - - &reftitle.description; - - public SeasLog::__destruct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo de <function>SeasLog::__destruct</function> - - -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/seaslog/seaslog/emergency.xml b/reference/seaslog/seaslog/emergency.xml deleted file mode 100644 index 7caf409a9a..0000000000 --- a/reference/seaslog/seaslog/emergency.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - SeasLog::emergency - Registra la información del registro de emergencia - - - - &reftitle.description; - - public static boolSeasLog::emergency - stringmessage - arraycontent - stringlogger - - - Registra la información del registro de emergencia. - - - "EMERGENCY" - El sistema es inutilizable. - - - - - - - - &reftitle.parameters; - - - message - - - El mensaje del registro. - - - - - content - - - El `message` contiene espacios reservados que los implementadores reemplazan por valores del array de contenido. - Por ejemplo, si `message` es `log info from {NAME}` y `content` es `array('NAME' => neeke)`, - la información de registro será `log info from neeke`. - - - - - logger - - - El `registro` pasado por el tercer parámetro sería utilizado a partir de ahora, - como un registro temporal, cuando la función SeasLog::setLogger() es llamada en el contenido anterior. - Si `logger` es NULL o "", SeasLog utilizará el último registro definido por SeasLog::setLogger. - - - - - - - - &reftitle.returnvalues; - - Devuelve TRUE en caso de éxito en el registro de la información del registro, FALSE en caso de fallo. - - - - - &reftitle.examples; - - Ejemplo de <function>SeasLog::emergency</function> - - 'neeke'))); - -//con registro temporal -var_dump(SeasLog::emergency('log message from {NAME}',array('NAME' => 'neeke'),'tmp_logger')); - -var_dump(SeasLog::getBuffer()); - -?> -]]> - - &example.outputs.similar; - - - array(2) { - [0]=> - string(81) "2018-07-07 11:45:49 | EMERGENCY | 73263 | 5b40376d1067c | 1530935149.68 | log message -" - [1]=> - string(92) "2018-07-07 11:45:49 | EMERGENCY | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } - ["/var/log/www/tmp_logger/20180707.log"]=> - array(1) { - [0]=> - string(92) "2018-07-07 11:45:49 | EMERGENCY | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } -} -]]> - - - - - - &reftitle.seealso; - - seaslog.default_template - SeasLog::debug - SeasLog::info - SeasLog::notice - SeasLog::warning - SeasLog::error - SeasLog::critical - SeasLog::alert - SeasLog::log - - - - - diff --git a/reference/seaslog/seaslog/error.xml b/reference/seaslog/seaslog/error.xml deleted file mode 100644 index 18383fa1d3..0000000000 --- a/reference/seaslog/seaslog/error.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - SeasLog::error - Registra la información del registro de errores - - - - &reftitle.description; - - public static boolSeasLog::error - stringmessage - arraycontent - stringlogger - - - Registra la información del registro de errores. - - - "ERROR" - Errores de ejecución que no requieren acción inmediata pero que generalmente deberían ser tratados. - - - - - - - - &reftitle.parameters; - - - message - - - El mensaje del registro. - - - - - content - - - El `message` contiene espacios reservados que los implementadores reemplazan con valores del array de contenido. - Por ejemplo, si `message` es `log info from {NAME}` y `content` es `array('NAME' => neeke)`, - la información de registro será `log info from neeke`. - - - - - logger - - - El `registro` pasado como tercer parámetro sería utilizado ahora, - como un registro temporal, cuando la función SeasLog::setLogger() es llamada en el contenido anterior. - Si `logger` es NULL o "", SeasLog utilizará el último registro definido por SeasLog::setLogger. - - - - - - - - &reftitle.returnvalues; - - Devuelve TRUE en caso de éxito en el registro de la información del registro, FALSE en caso de fallo. - - - - - &reftitle.examples; - - Ejemplo de <function>SeasLog::error</function> - - 'neeke'))); - -//con registro temporal -var_dump(SeasLog::error('log message from {NAME}',array('NAME' => 'neeke'),'tmp_logger')); - -var_dump(SeasLog::getBuffer()); - -?> -]]> - - &example.outputs.similar; - - - array(2) { - [0]=> - string(81) "2018-07-07 11:45:49 | ERROR | 73263 | 5b40376d1067c | 1530935149.68 | log message -" - [1]=> - string(92) "2018-07-07 11:45:49 | ERROR | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } - ["/var/log/www/tmp_logger/20180707.log"]=> - array(1) { - [0]=> - string(92) "2018-07-07 11:45:49 | ERROR | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } -} -]]> - - - - - - &reftitle.seealso; - - seaslog.default_template - SeasLog::debug - SeasLog::info - SeasLog::notice - SeasLog::warning - SeasLog::critical - SeasLog::alert - SeasLog::emergency - SeasLog::log - - - - - diff --git a/reference/seaslog/seaslog/flushbuffer.xml b/reference/seaslog/seaslog/flushbuffer.xml deleted file mode 100644 index 95df311312..0000000000 --- a/reference/seaslog/seaslog/flushbuffer.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - SeasLog::flushBuffer - Vacía el buffer de registros, lo vierte en el fichero del appender o lo envía a la API remota con TCP/UDP - - - - &reftitle.description; - - public static boolSeasLog::flushBuffer - - - - Vacía el buffer de registros por seaslog.appender: - vierte en el fichero, o envía a la API remota con TCP/UDP. - - - Ver también: - seaslog.appender_retry - seaslog.remote_host - seaslog.remote_port - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve TRUE en caso de éxito del vaciado del buffer, FALSE en caso de fallo. - - - - - &reftitle.examples; - - Ejemplo de <function>SeasLog::flushBuffer</function> - - -]]> - - &example.outputs.similar; - - - array(2) { - [0]=> - string(79) "2018-07-07 10:47:58 | INFO | 71910 | 5b4029ded6009 | 1530931678.877 | info log -" - [1]=> - string(81) "2018-07-07 10:47:58 | DEBUG | 71910 | 5b4029ded6009 | 1530931678.877 | debug log -" - } -} -bool(true) -array(0) { -} -]]> - - - - - - &reftitle.seealso; - - seaslog.use_buffer - seaslog.buffer_size - seaslog.buffer_disabled_in_cli - SeasLog::getBufferEnabled - SeasLog::getBuffer - - - - - diff --git a/reference/seaslog/seaslog/getbasepath.xml b/reference/seaslog/seaslog/getbasepath.xml deleted file mode 100644 index 74fef1c110..0000000000 --- a/reference/seaslog/seaslog/getbasepath.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - SeasLog::getBasePath - Devuelve la ruta base de SeasLog - - - - &reftitle.description; - - public static stringSeaslog::getBasePath - - - - Utilizar la función SeasLog::getBasePath - para obtener el valor de seaslog.default_basepath - configurado en php.ini (seaslog.ini). - - - Si se utiliza Seaslog::setBasePath, el resultado será modificado. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve seaslog.default_basepath como string. - - - - - &reftitle.examples; - - Ejemplo de <methodname>SeasLog::getBasePath</methodname> - - -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/seaslog/seaslog/getbuffer.xml b/reference/seaslog/seaslog/getbuffer.xml deleted file mode 100644 index bb09027e35..0000000000 --- a/reference/seaslog/seaslog/getbuffer.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - SeasLog::getBuffer - Devuelve el búfer de registros en memoria como un array - - - - &reftitle.description; - - public static arraySeasLog::getBuffer - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un array del búfer de registros en memoria. - - - - - &reftitle.examples; - - Ejemplo de <function>SeasLog::getBuffer</function> - - -]]> - - &example.outputs.similar; - - - array(2) { - [0]=> - string(79) "2018-07-07 10:43:32 | INFO | 71785 | 5b4028d4c58d5 | 1530931412.810 | info log -" - [1]=> - string(81) "2018-07-07 10:43:32 | DEBUG | 71785 | 5b4028d4c58d5 | 1530931412.810 | debug log -" - } -} -]]> - - - - - - &reftitle.seealso; - - seaslog.use_buffer - seaslog.buffer_size - seaslog.buffer_disabled_in_cli - SeasLog::getBufferEnabled - SeasLog::flushBuffer - - - - - diff --git a/reference/seaslog/seaslog/getbufferenabled.xml b/reference/seaslog/seaslog/getbufferenabled.xml deleted file mode 100644 index a54a13f645..0000000000 --- a/reference/seaslog/seaslog/getbufferenabled.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - SeasLog::getBufferEnabled - Determina si el búfer está activado - - - - &reftitle.description; - - public static boolSeasLog::getBufferEnabled - - - - Resulta de la combinación de seaslog.use_buffer - y seaslog.buffer_disabled_in_cli. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve TRUE si seaslog.use_buffer está activado. - Si seaslog.buffer_disabled_in_cli está activado, y el script se ejecuta en CLI, - el parámetro seaslog.use_buffer será ignorado, Seaslog escribirá en el almacén de datos INMEDIATAMENTE. - - - - - &reftitle.examples; - - Ejemplo de <function>SeasLog::getBufferEnabled</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - seaslog.use_buffer - seaslog.buffer_size - seaslog.buffer_disabled_in_cli - SeasLog::getBuffer - SeasLog::flushBuffer - - - - - diff --git a/reference/seaslog/seaslog/getdatetimeformat.xml b/reference/seaslog/seaslog/getdatetimeformat.xml deleted file mode 100644 index a82dfc1c2d..0000000000 --- a/reference/seaslog/seaslog/getdatetimeformat.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - SeasLog::getDatetimeFormat - Devuelve el formato de fecha y hora de SeasLog - - - - &reftitle.description; - - public static stringSeasLog::getDatetimeFormat - - - - Devuelve el formato de fecha y hora de SeasLog. - Utilice la función SeasLog::getDatetimeFormat para obtener el valor de - seaslog.default_datetime_format - configurado en php.ini (seaslog.ini). - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el formato de fecha y hora de SeasLog - seaslog.default_datetime_format. - Utilice la función SeasLog::setDatetimeFormat - para modificar este valor. - - - - - &reftitle.examples; - - Ejemplo de <function>SeasLog::getDatetimeFormat</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SeasLog::setDatetimeFormat - - - - - diff --git a/reference/seaslog/seaslog/getlastlogger.xml b/reference/seaslog/seaslog/getlastlogger.xml deleted file mode 100644 index 2cc712360c..0000000000 --- a/reference/seaslog/seaslog/getlastlogger.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - SeasLog::getLastLogger - Define el último registrador de SeasLog - - - - &reftitle.description; - - public static stringSeasLog::getLastLogger - - - - Utiliza la función SeasLog::getLastLogger - para obtener el valor de seaslog.default_logger - configurado en php.ini (seaslog.ini). - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Utiliza la función SeasLog::setLogger - para modificar el valor de la función SeasLog::getLastLogger. - - - - - &reftitle.examples; - - Ejemplo de <function>SeasLog::getLastLogger</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SeasLog::setLogger - - - - - diff --git a/reference/seaslog/seaslog/getrequestid.xml b/reference/seaslog/seaslog/getrequestid.xml deleted file mode 100644 index 9163b7c691..0000000000 --- a/reference/seaslog/seaslog/getrequestid.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - SeasLog::getRequestID - Devuelve las solicitudes diferenciadas por request_id de SeasLog - - - - &reftitle.description; - - public static stringSeasLog::getRequestID - - - - Para diferenciar una sola solicitud, sin invocar la función - SeasLog::setRequestId, - el valor único generado por la función interna `static char *get_uniqid ()` - se utiliza durante la inicialización de la solicitud. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la cadena generada por la función interna `static char *get_uniqid ()`, - o definida por la función SeasLog::setRequestId. - - - - - &reftitle.examples; - - Ejemplo de <function>SeasLog::getRequestID</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SeasLog::setRequestID - La variable `%Q` en - Tabla de Variables Predeterminadas de Seaslog. - - - - - diff --git a/reference/seaslog/seaslog/getrequestvariable.xml b/reference/seaslog/seaslog/getrequestvariable.xml deleted file mode 100644 index fe0fdf30f9..0000000000 --- a/reference/seaslog/seaslog/getrequestvariable.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - SeasLog::getRequestVariable - Devuelve la variable de petición de SeasLog - - - - &reftitle.description; - - public static boolSeasLog::getRequestVariable - intkey - - - Devuelve la variable de petición de SeasLog. - - - - - - &reftitle.parameters; - - - key - - - Un entero de constante. - - SEASLOG_REQUEST_VARIABLE_DOMAIN_PORT - SEASLOG_REQUEST_VARIABLE_REQUEST_URI - SEASLOG_REQUEST_VARIABLE_REQUEST_METHOD - SEASLOG_REQUEST_VARIABLE_CLIENT_IP - - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor de la variable de petición en caso de éxito. - - - - - &reftitle.examples; - - Ejemplo de <methodname>SeasLog::getRequestVariable</methodname> - -setRequestVariable(SEASLOG_REQUEST_VARIABLE_DOMAIN_PORT, $sDomainPort)); -var_dump($oSeasLog->setRequestVariable(SEASLOG_REQUEST_VARIABLE_REQUEST_URI, $sRequestUri)); -var_dump($oSeasLog->setRequestVariable(SEASLOG_REQUEST_VARIABLE_REQUEST_METHOD, $sRequestMethod)); -var_dump($oSeasLog->setRequestVariable(SEASLOG_REQUEST_VARIABLE_CLIENT_IP, $sClientIp)); - -var_dump($oSeasLog->setRequestVariable($iErrorKey,NULL)); - -var_dump($oSeasLog->getRequestVariable(SEASLOG_REQUEST_VARIABLE_DOMAIN_PORT) == $sDomainPort); -var_dump($oSeasLog->getRequestVariable(SEASLOG_REQUEST_VARIABLE_REQUEST_URI) == $sRequestUri); -var_dump($oSeasLog->getRequestVariable(SEASLOG_REQUEST_VARIABLE_REQUEST_METHOD) == $sRequestMethod); -var_dump($oSeasLog->getRequestVariable(SEASLOG_REQUEST_VARIABLE_CLIENT_IP) == $sClientIp); - -var_dump($oSeasLog->getRequestVariable($iErrorKey)); - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SeasLog::setRequestVariable - - - - - diff --git a/reference/seaslog/seaslog/info.xml b/reference/seaslog/seaslog/info.xml deleted file mode 100644 index d190acc6b4..0000000000 --- a/reference/seaslog/seaslog/info.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - SeasLog::info - Registra la información de registro de nivel info - - - - &reftitle.description; - - public static boolSeasLog::info - stringmessage - arraycontent - stringlogger - - - Registra la información de registro de nivel info. - - - "INFO" - Eventos interesantes. Destaca el proceso en curso de la aplicación. - - - - - - - - &reftitle.parameters; - - - message - - - El mensaje de registro. - - - - - content - - - El `message` contiene espacios reservados que los implementadores reemplazan por valores del array de contenido. - Por ejemplo, si `message` es `log info from {NAME}` y `content` es `array('NAME' => neeke)`, - la información de registro será `log info from neeke`. - - - - - logger - - - El `journal` pasado por el tercer parámetro sería utilizado ahora, - como un journal temporal, cuando la función SeasLog::setLogger() es llamada en el contenido previo. - Si `logger` es NULL o "", SeasLog utilizará el último journal definido por SeasLog::setLogger. - - - - - - - - &reftitle.returnvalues; - - Devuelve TRUE en caso de éxito del registro de la información de registro, FALSE en caso de fallo. - - - - - &reftitle.examples; - - Ejemplo de <function>SeasLog::info</function> - - 'neeke'))); - -//con journal temporal -var_dump(SeasLog::info('log message from {NAME}',array('NAME' => 'neeke'),'tmp_logger')); - -var_dump(SeasLog::getBuffer()); - -?> -]]> - - &example.outputs.similar; - - - array(2) { - [0]=> - string(81) "2018-07-07 11:45:49 | INFO | 73263 | 5b40376d1067c | 1530935149.68 | log message -" - [1]=> - string(92) "2018-07-07 11:45:49 | INFO | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } - ["/var/log/www/tmp_logger/20180707.log"]=> - array(1) { - [0]=> - string(92) "2018-07-07 11:45:49 | INFO | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } -} -]]> - - - - - - &reftitle.seealso; - - seaslog.default_template - SeasLog::debug - SeasLog::notice - SeasLog::warning - SeasLog::error - SeasLog::critical - SeasLog::alert - SeasLog::emergency - SeasLog::log - - - - - diff --git a/reference/seaslog/seaslog/log.xml b/reference/seaslog/seaslog/log.xml deleted file mode 100644 index 174b39b421..0000000000 --- a/reference/seaslog/seaslog/log.xml +++ /dev/null @@ -1,193 +0,0 @@ - - - - - - SeasLog::log - La función de registro de la grabación común - - - - &reftitle.description; - - public static boolSeasLog::log - stringlevel - stringmessage - arraycontent - stringlogger - - - La función de registro de la grabación común. - - - - - - &reftitle.parameters; - - - level - - - Utilizar los niveles en: - - SEASLOG_DEBUG - SEASLOG_INFO - SEASLOG_NOTICE - SEASLOG_WARNING - SEASLOG_ERROR - SEASLOG_CRITICAL - SEASLOG_ALERT - SEASLOG_EMERGENCY - - O se puede crear un nuevo nivel de autoayuda. - - - - - message - - - El mensaje del registro. - - - - - content - - - El `message` contiene marcadores de posición que los implementadores reemplazan con valores del array de contenido. - Por ejemplo, si `message` es `log info from {NAME}` y `content` es `array('NAME' => neeke)`, - la información de registro será `log info from neeke`. - - - - - logger - - - El `registro` pasado por el tercer argumento sería utilizado a partir de ahora, - como un registro temporal, cuando la función SeasLog::setLogger() es llamada en el contenido anterior. - Si `logger` es NULL o "", SeasLog utilizará el último registro definido por SeasLog::setLogger. - - - - - - - - &reftitle.returnvalues; - - Devuelve TRUE en caso de éxito en el registro de la información de registro, FALSE en caso de fallo. - - - - - &reftitle.examples; - - Ejemplo de <function>SeasLog::log</function> - - 'neeke'))); -var_dump(SeasLog::getBuffer()); - -//con `logger` -var_dump(SeasLog::log('MySelfLevel','info log {NAME}',array('NAME' => 'neeke'),'tmp_logger')); -var_dump(SeasLog::getBuffer()); - -?> -]]> - - &example.outputs.similar; - - - array(1) { - [0]=> - string(79) "2018-07-07 11:12:37 | INFO | 72427 | 5b402fa56a2ea | 1530933157.436 | info log -" - } -} - -bool(true) -array(1) { - ["/var/log/www/default/20180707.log"]=> - array(1) { - [0]=> - string(86) "2018-07-07 11:13:59 | MySelfLevel | 72470 | 5b402ff781c5e | 1530933239.532 | info log -" - } -} - -bool(true) -array(1) { - ["/var/log/www/tmp_logger/20180707.log"]=> - array(1) { - [0]=> - string(92) "2018-07-07 11:28:12 | MySelfLevel | 72833 | 5b40334ce6a2f | 1530934092.946 | info log neeke -" - } -} - -bool(true) -array(1) { - ["/var/log/www/default/20180707.log"]=> - array(1) { - [0]=> - string(86) "2018-07-07 11:20:12 | INFO | 72616 | 5b40316c3641e | 1530933612.222 | info log neeke -" - } -} -]]> - - - - - - &reftitle.seealso; - - seaslog.default_template - SeasLog::debug - SeasLog::info - SeasLog::notice - SeasLog::warning - SeasLog::error - SeasLog::critical - SeasLog::alert - SeasLog::emergency - - - - - diff --git a/reference/seaslog/seaslog/notice.xml b/reference/seaslog/seaslog/notice.xml deleted file mode 100644 index 7bd9c97f84..0000000000 --- a/reference/seaslog/seaslog/notice.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - SeasLog::notice - Registra la información de registro de notificación - - - - &reftitle.description; - - public static boolSeasLog::notice - stringmessage - arraycontent - stringlogger - - - Registra la información de registro de notificación. - - - "NOTICE" - Eventos normales pero significativos. La información que es más importante que el nivel INFO durante la ejecución. - - - - - - - - &reftitle.parameters; - - - message - - - El mensaje del registro. - - - - - content - - - El `message` contiene marcadores de posición que los implementadores reemplazan por valores del array de contenido. - Por ejemplo, si `message` es `log info from {NAME}` y `content` es `array('NAME' => neeke)`, - la información de registro será `log info from neeke`. - - - - - logger - - - El `registro` pasado por el tercer parámetro sería utilizado a partir de ahora, - como un registro temporal, cuando la función SeasLog::setLogger() es llamada en el contenido anterior. - Si `logger` es NULL o "", SeasLog utilizará el último registro definido por SeasLog::setLogger. - - - - - - - - &reftitle.returnvalues; - - Devuelve TRUE en caso de éxito en el registro de la información del registro, FALSE en caso de fallo. - - - - - &reftitle.examples; - - Ejemplo de <function>SeasLog::notice</function> - - 'neeke'))); - -//con registro temporal -var_dump(SeasLog::notice('log message from {NAME}',array('NAME' => 'neeke'),'tmp_logger')); - -var_dump(SeasLog::getBuffer()); - -?> -]]> - - &example.outputs.similar; - - - array(2) { - [0]=> - string(81) "2018-07-07 11:45:49 | NOTICE | 73263 | 5b40376d1067c | 1530935149.68 | log message -" - [1]=> - string(92) "2018-07-07 11:45:49 | NOTICE | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } - ["/var/log/www/tmp_logger/20180707.log"]=> - array(1) { - [0]=> - string(92) "2018-07-07 11:45:49 | NOTICE | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } -} -]]> - - - - - - &reftitle.seealso; - - seaslog.default_template - SeasLog::debug - SeasLog::info - SeasLog::warning - SeasLog::error - SeasLog::critical - SeasLog::alert - SeasLog::emergency - SeasLog::log - - - - - diff --git a/reference/seaslog/seaslog/setbasepath.xml b/reference/seaslog/seaslog/setbasepath.xml deleted file mode 100644 index c33a080992..0000000000 --- a/reference/seaslog/seaslog/setbasepath.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - SeasLog::setBasePath - Define la ruta de base de SeasLog - - - - &reftitle.description; - - public static boolSeasLog::setBasePath - stringbase_path - - - Define la ruta de base de SeasLog. - - - - - - &reftitle.parameters; - - - base_path - - - Una string. - - - - - - - - &reftitle.returnvalues; - - Devuelve TRUE en caso de éxito al definir la ruta de base, FALSE en caso de fallo. - - - - - &reftitle.examples; - - Ejemplo de <methodname>SeasLog::setBasePath</methodname> - - -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/seaslog/seaslog/setdatetimeformat.xml b/reference/seaslog/seaslog/setdatetimeformat.xml deleted file mode 100644 index 70ebb60f1c..0000000000 --- a/reference/seaslog/seaslog/setdatetimeformat.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - SeasLog::setDatetimeFormat - Define el formato de fecha y hora de SeasLog - - - - &reftitle.description; - - public static boolSeasLog::setDatetimeFormat - stringformat - - - Define el estilo de formato de fecha y hora de SeasLog. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - format - - - String. Como `Y-m-d H:i:s` o `Ymd His`. Ver también el primer argumento `format` en date. - - - - - - - - &reftitle.returnvalues; - - Devuelve TRUE en caso de éxito al definir el formato de fecha y hora, FALSE en caso de fallo. - - - - - &reftitle.examples; - - Ejemplo de <function>SeasLog::setDatetimeFormat</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SeasLog::getDateTimeFormat - - - - - diff --git a/reference/seaslog/seaslog/setlogger.xml b/reference/seaslog/seaslog/setlogger.xml deleted file mode 100644 index ed85eca232..0000000000 --- a/reference/seaslog/seaslog/setlogger.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - SeasLog::setLogger - Define el nombre del registrador de SeasLog - - - - &reftitle.description; - - public static boolSeasLog::setLogger - stringlogger - - - Utilizar la función SeasLog::setLogger - para definir el valor de la función SeasLog::getLastLogger. - Esto significa que SeasLog registrará la información del registro en el directorio del registrador. - - - - - - &reftitle.parameters; - - - logger - - - El nombre del registrador. - - - - - - - - &reftitle.returnvalues; - - Devuelve TRUE en caso de éxito en la creación del directorio del registrador, FALSE en caso de fallo. - - - - - &reftitle.examples; - - Ejemplo de <function>SeasLog::setLogger</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SeasLog::getLastLogger - SeasLog::closeLoggerStream - - - - - diff --git a/reference/seaslog/seaslog/setrequestid.xml b/reference/seaslog/seaslog/setrequestid.xml deleted file mode 100644 index f052fcd65b..0000000000 --- a/reference/seaslog/seaslog/setrequestid.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - SeasLog::setRequestID - Define los request_id de las peticiones diferenciadas de SeasLog - - - - &reftitle.description; - - public static boolSeasLog::setRequestID - stringrequest_id - - - Para distinguir una sola petición, sin invocar la función - SeasLog::setRequestId, - el valor único generado por la función interna `static char *get_uniqid () - se utiliza durante la inicialización de la petición. - - - - - &reftitle.parameters; - - - request_id - - - String. - - - - - - - - &reftitle.returnvalues; - - Devuelve TRUE en caso de éxito en la definición, FALSE en caso de fallo. - - - - - &reftitle.examples; - - Ejemplo de <function>SeasLog::setRequestID</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SeasLog::getRequestID - - - - - diff --git a/reference/seaslog/seaslog/setrequestvariable.xml b/reference/seaslog/seaslog/setrequestvariable.xml deleted file mode 100644 index d45aedf0bf..0000000000 --- a/reference/seaslog/seaslog/setrequestvariable.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - SeasLog::setRequestVariable - Define manualmente la variable de petición de SeasLog - - - - &reftitle.description; - - public static boolSeasLog::setRequestVariable - intkey - stringvalue - - - Define manualmente la variable de petición de SeasLog. - - - - - - &reftitle.parameters; - - - key - - - Constante int. - - SEASLOG_REQUEST_VARIABLE_DOMAIN_PORT - SEASLOG_REQUEST_VARIABLE_REQUEST_URI - SEASLOG_REQUEST_VARIABLE_REQUEST_METHOD - SEASLOG_REQUEST_VARIABLE_CLIENT_IP - - - - - - value - - - El valor de la variable de petición. - - - - - - - - &reftitle.returnvalues; - - Devuelve TRUE en caso de éxito de la definición, FALSE en caso de fallo. - - - - - &reftitle.examples; - - Ejemplo de <methodname>SeasLog::setRequestVariable</methodname> - -setRequestVariable(SEASLOG_REQUEST_VARIABLE_DOMAIN_PORT, $sDomainPort)); -var_dump($oSeasLog->setRequestVariable(SEASLOG_REQUEST_VARIABLE_REQUEST_URI, $sRequestUri)); -var_dump($oSeasLog->setRequestVariable(SEASLOG_REQUEST_VARIABLE_REQUEST_METHOD, $sRequestMethod)); -var_dump($oSeasLog->setRequestVariable(SEASLOG_REQUEST_VARIABLE_CLIENT_IP, $sClientIp)); - -var_dump($oSeasLog->setRequestVariable($iErrorKey,NULL)); - -var_dump($oSeasLog->getRequestVariable(SEASLOG_REQUEST_VARIABLE_DOMAIN_PORT) == $sDomainPort); -var_dump($oSeasLog->getRequestVariable(SEASLOG_REQUEST_VARIABLE_REQUEST_URI) == $sRequestUri); -var_dump($oSeasLog->getRequestVariable(SEASLOG_REQUEST_VARIABLE_REQUEST_METHOD) == $sRequestMethod); -var_dump($oSeasLog->getRequestVariable(SEASLOG_REQUEST_VARIABLE_CLIENT_IP) == $sClientIp); - -var_dump($oSeasLog->getRequestVariable($iErrorKey)); - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SeasLog::getRequestVariable - - - - - diff --git a/reference/seaslog/seaslog/warning.xml b/reference/seaslog/seaslog/warning.xml deleted file mode 100644 index 0922cce8c1..0000000000 --- a/reference/seaslog/seaslog/warning.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - SeasLog::warning - Registra la información de registro de advertencia - - - - &reftitle.description; - - public static boolSeasLog::warning - stringmessage - arraycontent - stringlogger - - - Registra la información de registro de advertencia. - - - "WARNING" - Ocurrencias excepcionales que no son errores. - Información potencialmente aberrante que requiere atención y debe ser reparada. - - - - - - - - &reftitle.parameters; - - - message - - - El mensaje del registro. - - - - - content - - - El `message` contiene marcadores de posición que los implementadores reemplazan con valores del array de contenido. - Por ejemplo, si `message` es `log info from {NAME}` y `content` es `array('NAME' => neeke)`, - la información de registro será `log info from neeke`. - - - - - logger - - - El `registro` pasado como tercer argumento sería utilizado ahora, - como un registro temporal, cuando la función SeasLog::setLogger() es llamada en el contenido anterior. - Si `logger` es NULL o "", SeasLog utilizará el último registro definido por SeasLog::setLogger. - - - - - - - - &reftitle.returnvalues; - - Devuelve TRUE en caso de éxito en el registro de la información de registro, FALSE en caso de fallo. - - - - - &reftitle.examples; - - Ejemplo de <function>SeasLog::warning</function> - - 'neeke'))); - -//con registro temporal -var_dump(SeasLog::warning('log message from {NAME}',array('NAME' => 'neeke'),'tmp_logger')); - -var_dump(SeasLog::getBuffer()); - -?> -]]> - - &example.outputs.similar; - - - array(2) { - [0]=> - string(81) "2018-07-07 11:45:49 | WARNING | 73263 | 5b40376d1067c | 1530935149.68 | log message -" - [1]=> - string(92) "2018-07-07 11:45:49 | WARNING | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } - ["/var/log/www/tmp_logger/20180707.log"]=> - array(1) { - [0]=> - string(92) "2018-07-07 11:45:49 | WARNING | 73263 | 5b40376d1067c | 1530935149.68 | log message from neeke -" - } -} -]]> - - - - - - &reftitle.seealso; - - seaslog.default_template - SeasLog::debug - SeasLog::info - SeasLog::notice - SeasLog::error - SeasLog::critical - SeasLog::alert - SeasLog::emergency - SeasLog::log - - - - - diff --git a/reference/seaslog/setup.xml b/reference/seaslog/setup.xml deleted file mode 100644 index 1502cfa92c..0000000000 --- a/reference/seaslog/setup.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - - -
    - - - &reference.seaslog.configure; - - - - &reference.seaslog.ini; - - -
    - &reftitle.resources; - - - -
    - -
    - diff --git a/reference/session/ini.xml b/reference/session/ini.xml index 6b34864a37..2a1c1330d5 100644 --- a/reference/session/ini.xml +++ b/reference/session/ini.xml @@ -1,7 +1,7 @@ -
    +
    &reftitle.runtime; &extension.runtime; @@ -390,7 +390,7 @@ (llamados php y php_binary) y WDDX (llamado wddx) son soportados. WDDX solo está disponible, si PHP ha sido compilado con la opción - WDDX. php_serialize + WDDX. php_serialize utiliza las funciones de serialización/deserialización en interno, y no tiene las limitaciones que php y php_binary tienen. Los antiguos controladores de serialización no pueden almacenar diff --git a/reference/simdjson/book.xml b/reference/simdjson/book.xml deleted file mode 100644 index 216cc10ee9..0000000000 --- a/reference/simdjson/book.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - Simdjson - Simdjson - - - &reftitle.intro; - - Proporciona un decodificado JSON más rápido gracias a las ligaduras simdjson para PHP (Single Instruction, Multiple Data) - - - - &reference.simdjson.setup; - &reference.simdjson.constants; - &reference.simdjson.reference; - - &reference.simdjson.simdjsonexception; - &reference.simdjson.simdjsonvalueerror; - - diff --git a/reference/simdjson/constants.xml b/reference/simdjson/constants.xml deleted file mode 100644 index 0da743e382..0000000000 --- a/reference/simdjson/constants.xml +++ /dev/null @@ -1,358 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - SIMDJSON_ERR_CAPACITY - (&integer;) - - - - Este analizador no puede manejar un documento tan voluminoso. - Se lanza al analizar una cadena JSON de más de 4 GiB. - - - - - - SIMDJSON_ERR_TAPE_ERROR - (&integer;) - - - - El documento JSON tiene una estructura incorrecta: comas faltantes o superfluas, llaves, claves faltantes, etc. - - - - - - SIMDJSON_ERR_DEPTH_ERROR - (&integer;) - - - - El documento JSON era demasiado profundo (demasiados objetos y arrays anidados) - - - - - - SIMDJSON_ERR_STRING_ERROR - (&integer;) - - - Problema al analizar una cadena - - - - - - SIMDJSON_ERR_T_ATOM_ERROR - (&integer;) - - - Problema al analizar un átomo que comienza con la letra 't' - - - - - - SIMDJSON_ERR_F_ATOM_ERROR - (&integer;) - - - - Problema al analizar un átomo que comienza con la letra 'f' - - - - - - SIMDJSON_ERR_N_ATOM_ERROR - (&integer;) - - - - Problema al analizar un átomo que comienza con la letra 'n' - - - - - - SIMDJSON_ERR_NUMBER_ERROR - (&integer;) - - - - Problema al analizar un número - - - - - - SIMDJSON_ERR_UTF8_ERROR - (&integer;) - - - - La entrada no es un UTF-8 válido - - - - - - SIMDJSON_ERR_UNINITIALIZED - (&integer;) - - - - El analizador utilizado por simdjson no está inicializado. No debería ocurrir. - - - - - - SIMDJSON_ERR_EMPTY - (&integer;) - - - Vacío: no se encontró JSON - - - - - - SIMDJSON_ERR_UNESCAPED_CHARS - (&integer;) - - - Con las cadenas, algunos caracteres deben ser escapados, se encontraron caracteres no escapados - - - - - - SIMDJSON_ERR_UNCLOSED_STRING - (&integer;) - - - - Una cadena está abierta, pero nunca cerrada. - - - - - - SIMDJSON_ERR_UNSUPPORTED_ARCHITECTURE - (&integer;) - - - - simdjson no tiene una implementación compatible con esta arquitectura CPU (¿tal vez un CPU no-SIMD?). - - - - - - SIMDJSON_ERR_INCORRECT_TYPE - (&integer;) - - - - No debería ocurrir. - - - - - - SIMDJSON_ERR_NUMBER_OUT_OF_RANGE - (&integer;) - - - - El número JSON es demasiado grande o demasiado pequeño para caber en el tipo solicitado. - Es importante señalar que la biblioteca C simdjson es un fork y que este error es ignorado para coincidir con la gestión de PHP - de los números JSON que son demasiado grandes o demasiado pequeños. - - - - - - SIMDJSON_ERR_INDEX_OUT_OF_BOUNDS - (&integer;) - - - - No debería ocurrir. - - - - - - SIMDJSON_ERR_NO_SUCH_FIELD - (&integer;) - - - No debería ocurrir. - - - - - - SIMDJSON_ERR_IO_ERROR - (&integer;) - - - No debería ocurrir. - - - - - - SIMDJSON_ERR_INVALID_JSON_POINTER - (&integer;) - - - - Sintaxis de puntero JSON inválida en simdjson_key_value - y otras funciones que aceptan un puntero JSON $key. - - - - - - SIMDJSON_ERR_INVALID_URI_FRAGMENT - (&integer;) - - - Sintaxis de fragmento URI inválida. - - - - - - SIMDJSON_ERR_UNEXPECTED_ERROR - (&integer;) - - - Error inesperado, considere reportar este problema ya que puede haber encontrado un bug en el PECL simdjson - - - - - - SIMDJSON_ERR_PARSER_IN_USE - (&integer;) - - - No debería ocurrir. - - - - - - SIMDJSON_ERR_OUT_OF_ORDER_ITERATION - (&integer;) - - - No debería ocurrir. - - - - - - SIMDJSON_ERR_INSUFFICIENT_PADDING - (&integer;) - - - No debería ocurrir. - - - - - - SIMDJSON_ERR_INCOMPLETE_ARRAY_OR_OBJECT - (&integer;) - - - El documento JSON terminó prematuramente en medio de un objeto o un array. - - - - - - SIMDJSON_ERR_SCALAR_DOCUMENT_AS_VALUE - (&integer;) - - - No debería ocurrir. - - - - - - SIMDJSON_ERR_OUT_OF_BOUNDS - (&integer;) - - - Intento de acceder a una ubicación fuera del documento. - - - - - - SIMDJSON_ERR_TRAILING_CONTENT - (&integer;) - - - - - - - - - SIMDJSON_ERR_KEY_COUNT_NOT_COUNTABLE - (&integer;) - - - - - - - - - SIMDJSON_ERR_INVALID_PROPERTY - (&integer;) - - - Nombre de propiedad inválido para un stdClass al decodificar un valor - con simdjson_decode o simdjson_key_value - - - - - - diff --git a/reference/simdjson/functions/simdjson-decode.xml b/reference/simdjson/functions/simdjson-decode.xml deleted file mode 100644 index cf6f7e31fa..0000000000 --- a/reference/simdjson/functions/simdjson-decode.xml +++ /dev/null @@ -1,303 +0,0 @@ - - - - - - simdjson_decode - Decodifica una cadena JSON - - - - &reftitle.description; - - mixedsimdjson_decode - stringjson - boolassociative&false; - intdepth512 - - - Toma una cadena codificada en JSON y la convierte en un valor PHP. - Esto utiliza una Instrucción Simultánea más Rápida, Datos Múltiples (Simultaneous Instruction, Multiple Data - SIMD) - que json_decode cuando es soportada por la arquitectura del ordenador. - - - - - &reftitle.parameters; - - - json - - - El string json a decodificar. - - - Esta función solo funciona con cadenas codificadas en UTF-8. - - - Esta función analiza las entradas válidas que - json_decode puede decodificar, - siempre que sean inferiores a 4 GB de longitud. - - - - - associative - - - Cuando &true;, los objetos JSON serán devueltos como - &array; asociativos; cuando sean &false;, los objetos JSON serán devueltos como &object;s. - - - - - depth - - - La profundidad máxima de la estructura a decodificar. - El valor debe ser superior a 0, - e inferior o igual a 2147483647. - - Aquellos que llamen a esta función deberían utilizar valores razonablemente pequeños, - ya que profundidades mayores requieren más espacio de búfer y aumentarán - la profundidad de recursión, a diferencia de la implementación actual de json_decode. - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor codificado en json en el - tipo PHP apropiado. Los valores true, false y - null son devueltos respectivamente como &true;, &false; y &null;. - - - - - &reftitle.errors; - - Si json es inválido, una SimdJsonException es lanzada a partir de PECL simdjson 2.1.0, - mientras que anteriormente, una RuntimeException era lanzada. - - - Si depth está fuera del rango permitido, - una SimdJsonValueError es lanzada a partir de PECL simdjson 3.0.0, - mientras que anteriormente, un error de nivel E_WARNING era lanzado. - - - - - &reftitle.examples; - - - Ejemplos de <function>simdjson_decode</function> - - -]]> - - &example.outputs; - - - int(1) - ["b"]=> - int(2) - ["c"]=> - int(3) -} -array(3) { - ["a"]=> - int(1) - ["b"]=> - int(2) - ["c"]=> - int(3) -} -]]> - - - - Acceder a propiedades de objeto no válidas - - Acceder a elementos en un objeto que contienen caracteres no - permitidos por la convención de nomenclatura de PHP (por ejemplo, el guion) puede ser - logrado encapsulando el nombre del elemento entre llaves y comillas. - - -{'foo-bar'}; // 12345 - -?> -]]> - - - - Errores comunes al usar <function>simdjson_decode</function> - - -]]> - - - - Errores de <parameter>depth</parameter> - - array -> array -> string) -$json = json_encode( - [ - 1 => [ - 'English' => [ - 'One', - 'January' - ], - 'French' => [ - 'Une', - 'Janvier' - ] - ] - ] -); - -// Mostrar errores para diferentes profundidades. -var_dump(simdjson_decode($json, true, 4)); -try { - var_dump(simdjson_decode($json, true, 3)); -} catch (SimdJsonException $e) { - echo "Capturado: ", $e->getMessage(), "\n"; -} -?> -]]> - - &example.outputs; - - - array(2) { - ["English"]=> - array(2) { - [0]=> - string(3) "One" - [1]=> - string(7) "January" - } - ["French"]=> - array(2) { - [0]=> - string(3) "Une" - [1]=> - string(7) "Janvier" - } - } -} -Capturado: El documento JSON era demasiado profundo (demasiados objetos y arrays anidados) -]]> - - - - <function>simdjson_decode</function> de grandes enteros - - -]]> - - &example.outputs; - - - float(1.2345678901235E+19) -} -]]> - - - - - - - &reftitle.notes; - - - La especificación JSON no es JavaScript, sino un subconjunto de JavaScript. - - - - - En el caso de que la decodificación falle, - una SimdJsonException es lanzada - y SimdJsonException::getCode y - SimdJsonException::getMessage pueden ser utilizados - para determinar la naturaleza exacta del error. - - - - - - &reftitle.seealso; - - json_encode - json_decode - - - - diff --git a/reference/simdjson/functions/simdjson-is-valid.xml b/reference/simdjson/functions/simdjson-is-valid.xml deleted file mode 100644 index 4aa6337bb8..0000000000 --- a/reference/simdjson/functions/simdjson-is-valid.xml +++ /dev/null @@ -1,188 +0,0 @@ - - - - - - simdjson_is_valid - Verifica si un string JSON es válido - - - - &reftitle.description; - - boolsimdjson_is_valid - stringjson - intdepth512 - - - Toma un string codificado en JSON y devuelve true si es válido. - - - - - &reftitle.parameters; - - - json - - - El string json a validar. - - - Esta función solo funciona con strings codificados en UTF-8. - - - Esta función valida las entradas que - json_decode puede decodificar, - siempre que sean inferiores a 4 GB de longitud. - - - - - depth - - - La profundidad máxima de la estructura a decodificar. - El valor debe ser superior a 0, - e inferior o igual a 2147483647. - - Quienes llamen a esta función deberían utilizar valores razonablemente pequeños, - ya que profundidades mayores requieren más espacio de búfer y aumentarán - la profundidad de recursión, a diferencia de la implementación actual de json_decode. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si json es un string JSON - válido, de lo contrario &false;. - - - - - &reftitle.errors; - - Si json es inválido, se lanza una SimdJsonException a partir de PECL simdjson 2.1.0, - mientras que anteriormente se lanzaba una RuntimeException. - - - Si depth está fuera del rango permitido, - se lanza una SimdJsonValueError a partir de PECL simdjson 3.0.0, - mientras que anteriormente se lanzaba un error de nivel E_WARNING. - - - - - &reftitle.examples; - - - Ejemplos de <function>simdjson_decode</function> - - -]]> - - &example.outputs; - - - - - - Errores de <parameter>depth</parameter> - - array -> array -> string) -$json = json_encode( - [ - 1 => [ - 'English' => [ - 'One', - 'January' - ], - 'French' => [ - 'Une', - 'Janvier' - ] - ] - ] -); - -// Mostrar errores para diferentes profundidades. -var_dump(simdjson_is_valid($json, 4)); -var_dump(simdjson_is_valid($json, 3)); -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.notes; - - - La especificación JSON no es JavaScript, sino un subconjunto de JavaScript. - - - - - En caso de que la decodificación falle, - se lanza una SimdJsonException - y SimdJsonException::getCode y - SimdJsonException::getMessage pueden ser utilizados - para determinar la naturaleza exacta del error. - - - - - - &reftitle.seealso; - - json_encode - json_decode - - - - diff --git a/reference/simdjson/functions/simdjson-key-count.xml b/reference/simdjson/functions/simdjson-key-count.xml deleted file mode 100644 index 5185d2e86a..0000000000 --- a/reference/simdjson/functions/simdjson-key-count.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - simdjson_key_count - Devuelve el valor a un puntero JSON. - - - - &reftitle.description; - - intsimdjson_key_count - stringjson - stringkey - intdepth512 - boolthrow_if_uncountable&false; - - - Cuenta el número de elementos del objeto/array encontrado en el puntero JSON solicitado. - - - - - &reftitle.parameters; - - - json - - - El string json a consultar. - - - - - key - - - El string del puntero JSON. - - - - - depth - - - La profundidad máxima de la estructura a decodificar. - El valor debe ser superior a 0, - e inferior o igual a 2147483647. - - Aquellos que llamen a esta función deberían utilizar valores razonablemente pequeños, - ya que profundidades mayores requieren más espacio de búfer y aumentarán - la profundidad de recursión, a diferencia de la implementación actual de json_decode. - - - - - throw_if_uncountable - - - Cuando es verdadero, se lanzará una SimdJsonException - en lugar de devolver 0 cuando el valor apuntado por el JSON no es ni - un objeto ni un array. - - - - - - - - &reftitle.returnvalues; - - Devuelve un &integer; con el número de elementos del valor en el puntero JSON dado. - - - - - diff --git a/reference/simdjson/functions/simdjson-key-exists.xml b/reference/simdjson/functions/simdjson-key-exists.xml deleted file mode 100644 index 2bc61dff38..0000000000 --- a/reference/simdjson/functions/simdjson-key-exists.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - simdjson_key_exists - Verifica si el JSON contiene el valor referenciado por un puntero JSON. - - - - &reftitle.description; - - boolsimdjson_key_exists - stringjson - stringkey - intdepth - - - Cuenta el número de elementos del objeto/array encontrado en el puntero JSON solicitado. - - - - - &reftitle.parameters; - - - json - - - El string json a consultar. - - - - - key - - - El string del puntero JSON. - - - - - depth - - - La profundidad máxima de la estructura a decodificar. - El valor debe ser superior a 0, - e inferior o igual a 2147483647. - - Los que llamen a esta función deberían utilizar valores razonablemente pequeños, - ya que profundidades mayores requieren más espacio de búfer y aumentarán - la profundidad de recursión, a diferencia de la implementación actual de json_decode. - - - - - throw_if_uncountable - - - Cuando es verdadero, se lanzará una SimdJsonException - en lugar de devolver 0 cuando el valor apuntado por el JSON no es ni - un objeto ni un array. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si el puntero JSON es válido y referencia un valor encontrado en una cadena JSON válida. - Devuelve &false; si el JSON es válido pero no contiene el puntero JSON. - - - - - diff --git a/reference/simdjson/functions/simdjson-key-value.xml b/reference/simdjson/functions/simdjson-key-value.xml deleted file mode 100644 index a9d987f963..0000000000 --- a/reference/simdjson/functions/simdjson-key-value.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - simdjson_key_value - Decodifica el valor de una cadena JSON situada en el indicador JSON solicitado. - - - - &reftitle.description; - - mixedsimdjson_key_value - stringjson - stringkey - boolassociative&false; - intdepth512 - - - Decodifica y devuelve el valor encontrado en el indicador JSON solicitado. - - - - - &reftitle.parameters; - - - json - - - El json string a interrogar y decodificar. - - - Esta función solo funciona con cadenas codificadas en UTF-8. - - - Esta función analiza las entradas válidas que - json_decode puede decodificar, - siempre que sean inferiores a 4 GB de longitud. - - - - - key - - - El string del puntero JSON. - - - - - associative - - - Cuando &true; los objetos JSON serán devueltos en forma - de &array; asociativos; cuando son &false;, los objetos JSON serán devueltos en forma de &object;s. - - - - - depth - - - La profundidad máxima de la estructura a decodificar. - El valor debe ser superior a 0, - e inferior o igual a 2147483647. - - Quienes llamen a esta función deberían utilizar valores razonablemente pequeños, - ya que profundidades mayores requieren más espacio de búfer y aumentarán - la profundidad de recursión, a diferencia de la implementación actual de json_decode. - - - - - - - - &reftitle.returnvalues; - - Devuelve la parte del valor codificado en json - que key referencia en el tipo PHP apropiado. - Los valores true, false y - null son devueltos respectivamente como &true;, &false; y &null;. - - - - &reftitle.errors; - - Si json es inválido, una SimdJsonException es lanzada a partir de PECL simdjson 2.1.0, - mientras que anteriormente, una RuntimeException era lanzada. - - - Si depth está fuera del rango permitido, - una SimdJsonValueError es lanzada a partir de PECL simdjson 3.0.0, - mientras que anteriormente, un error de nivel E_WARNING era lanzado. - - - - &reftitle.seealso; - - json_encode - simdjson_decode - - - - diff --git a/reference/simdjson/reference.xml b/reference/simdjson/reference.xml deleted file mode 100644 index caf7b1a792..0000000000 --- a/reference/simdjson/reference.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - &Functions; de Simdjson - - &reference.simdjson.entities.functions; - - - diff --git a/reference/simdjson/setup.xml b/reference/simdjson/setup.xml deleted file mode 100644 index 631aff1a4b..0000000000 --- a/reference/simdjson/setup.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;simdjson. - - - &pecl.windows.download.avail; - -
    -
    - diff --git a/reference/simdjson/simdjsonexception.xml b/reference/simdjson/simdjsonexception.xml deleted file mode 100644 index accd85253f..0000000000 --- a/reference/simdjson/simdjsonexception.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - La clase SimdJsonException - SimdJsonException - - - - -
    - &reftitle.intro; - - Excepción lanzada si simdjson_decode, - simdjson_key_count, - simdjson_key_exists, - o simdjson_key_value. - - Para obtener los valores posibles, ver las constantes de error simdjson. - -
    - - -
    - &reftitle.classsynopsis; - - - - SimdJsonException - - - - - SimdJsonException - - - - extends - RuntimeException - - - - - &InheritedProperties; - - - - - -
    - -
    -
    - diff --git a/reference/simdjson/simdjsonvalueerror.xml b/reference/simdjson/simdjsonvalueerror.xml deleted file mode 100644 index 184b6e1390..0000000000 --- a/reference/simdjson/simdjsonvalueerror.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - La clase SimdJsonValueError - SimdJsonValueError - - - - -
    - &reftitle.intro; - - Una excepción SimdJsonValueError es lanzada cuando el - tipo de un argumento de una función de simdjson es correcto pero el valor - de éste es incorrecto. - Por ejemplo, cuando la decodificación JSON $depth no es positiva o cuando $depth es demasiado grande. - -
    - - -
    - &reftitle.classsynopsis; - - - - SimdJsonValueError - - - - - SimdJsonValueError - - - - extends - ValueError - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - -
    - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PHP 8.0.0 - - SimdJsonValueError extiende ahora ValueError - en lugar de Error. - - - - - -
    -
    - -
    - diff --git a/reference/solr/book.xml b/reference/solr/book.xml deleted file mode 100644 index 15e37abd7d..0000000000 --- a/reference/solr/book.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - Solr de Apache - Solr - - - &reftitle.intro; - - La extensión Solr permite comunicarse de manera efectiva con el servidor Solr de Apache en PHP. - - - La extensión Solr es una biblioteca extremadamente rápida, de pequeño tamaño, y con abundantes características que permite a los desarrolladores de PHP comunicarse de manera efectiva con las instancias del servidor Solr. - Las versiones 1.x de la Extensión PECL soportan el Servidor Solr de Apache 1.3-3.x - Las versiones 2.x de la Extensión PECL soportan el Servidor Solr de Apache 4.0+ - Hay herramientas internas para añadir documentos y realizar actualizaciones al servidor solr. - También contiene herramientas que permiten realizar consultas avanzadas al servidor cuando se buscan documentos. - - - &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; - - - - - - diff --git a/reference/solr/constants.xml b/reference/solr/constants.xml deleted file mode 100644 index ab9f555d34..0000000000 --- a/reference/solr/constants.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - &reftitle.constants; - &extension.constants; - - - - - SOLR_MAJOR_VERSION - (int) - - - - - - - - - SOLR_MINOR_VERSION - (int) - - - - - - - - - SOLR_PATCH_VERSION - (int) - - - - - - - - - SOLR_EXTENSION_VERSION - (string) - - - - - - - - - - - - diff --git a/reference/solr/examples.xml b/reference/solr/examples.xml deleted file mode 100644 index 00be480662..0000000000 --- a/reference/solr/examples.xml +++ /dev/null @@ -1,1282 +0,0 @@ - - - - - - - &reftitle.examples; - - - Ejemplos de cómo usar la extensión Apache Solr de PHP - - - Contenido del archivo BootStrap - - - -]]> - - - - - - Añadir un documento al índice - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$cliente = new SolrClient($opciones); - -$doc = new SolrInputDocument(); - -$doc->addField('id', 334455); -$doc->addField('cat', 'Software'); -$doc->addField('cat', 'Lucene'); - -$respuestaActualización = $cliente->addDocument($doc); - -print_r($respuestaActualización->getResponse()); - -?> - -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 446 - ) - -) -]]> - - - - - Fusionar un documento con otro documento - -addField('id', 1123); - -$doc->features = "PHP Client Side"; -$doc->features = "Fast development cycles"; - -$doc['cat'] = 'Software'; -$doc['cat'] = 'Custom Search'; -$doc->cat = 'Information Technology'; - -$segundo_doc->addField('cat', 'Lucene Search'); - -$segundo_doc->merge($doc, true); - -print_r($segundo_doc->toArray()); - - -?> - -]]> - - &example.outputs.similar; - - 0 - [field_count] => 3 - [fields] => Array - ( - [0] => SolrDocumentField Object - ( - [name] => cat - [boost] => 0 - [values] => Array - ( - [0] => Software - [1] => Custom Search - [2] => Information Technology - ) - - ) - - [1] => SolrDocumentField Object - ( - [name] => id - [boost] => 0 - [values] => Array - ( - [0] => 1123 - ) - - ) - - [2] => SolrDocumentField Object - ( - [name] => features - [boost] => 0 - [values] => Array - ( - [0] => PHP Client Side - [1] => Fast development cycles - ) - - ) - - ) - -) -]]> - - - - - - Buscar documentos - respuestas de SolrObject - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$cliente = new SolrClient($opciones); - -$consulta = new SolrQuery(); - -$consulta->setQuery('lucene'); - -$consulta->setStart(0); - -$consulta->setRows(50); - -$consulta->addField('cat')->addField('features')->addField('id')->addField('timestamp'); - -$respuesta_consulta = $cliente->query($consulta); - -$respuesta = $respuesta_consulta->getResponse(); - -print_r($respuesta); - -?> - -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 1 - [params] => SolrObject Object - ( - [wt] => xml - [rows] => 50 - [start] => 0 - [indent] => on - [q] => lucene - [fl] => cat,features,id,timestamp - [version] => 2.2 - ) - - ) - - [response] => SolrObject Object - ( - [numFound] => 3 - [start] => 0 - [docs] => Array - ( - [0] => SolrObject Object - ( - [cat] => Array - ( - [0] => Software - [1] => Lucene - ) - - [id] => 334456 - ) - - [1] => SolrObject Object - ( - [cat] => Array - ( - [0] => Software - [1] => Lucene - ) - - [id] => 334455 - ) - - [2] => SolrObject Object - ( - [cat] => Array - ( - [0] => software - [1] => search - ) - - [features] => Array - ( - [0] => Advanced Full-Text Search Capabilities using Lucene - [1] => Optimized for High Volume Web Traffic - [2] => Standards Based Open Interfaces - XML and HTTP - [3] => Comprehensive HTML Administration Interfaces - [4] => Scalability - Efficient Replication to other Solr Search Servers - [5] => Flexible and Adaptable with XML configuration and Schema - [6] => Good unicode support: héllo (hello with an accent over the e) - ) - - [id] => SOLR1000 - [timestamp] => 2009-09-04T20:38:55.906 - ) - - ) - - ) - -) -]]> - - - - - Buscar documentos - respuestas de SolrDocument - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$cliente = new SolrClient($opciones); - -$consulta = new SolrQuery(); - -$consulta->setQuery('lucene'); - -$consulta->setStart(0); - -$consulta->setRows(50); - -$consulta->addField('cat')->addField('features')->addField('id')->addField('timestamp'); - -$respuesta_consulta = $cliente->query($consulta); - -$respuesta_consulta->setParseMode(SolrQueryResponse::PARSE_SOLR_DOC); - -$respuesta = $respuesta_consulta->getResponse(); - -print_r($respuesta); - -?> - -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 1 - [params] => SolrObject Object - ( - [wt] => xml - [rows] => 50 - [start] => 0 - [indent] => on - [q] => lucene - [fl] => cat,features,id,timestamp - [version] => 2.2 - ) - - ) - - [response] => SolrObject Object - ( - [numFound] => 3 - [start] => 0 - [docs] => Array - ( - [0] => SolrDocument Object - ( - [_hashtable_index:SolrDocument:private] => 19740 - ) - - [1] => SolrDocument Object - ( - [_hashtable_index:SolrDocument:private] => 25485 - ) - - [2] => SolrDocument Object - ( - [_hashtable_index:SolrDocument:private] => 25052 - ) - - ) - - ) - -) -]]> - - - - - Ejemplo sencillo de TermsComponent - básico - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$cliente = new SolrClient($opciones); - -$consulta = new SolrQuery(); - -$consulta->setTerms(true); - -$consulta->setTermsField('cat'); - -$respuestaActualización = $cliente->query($consulta); - -print_r($respuestaActualización->getResponse()); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 2 - ) - - [terms] => SolrObject Object - ( - [cat] => SolrObject Object - ( - [electronics] => 14 - [Lucene] => 4 - [Software] => 4 - [memory] => 3 - [card] => 2 - [connector] => 2 - [drive] => 2 - [graphics] => 2 - [hard] => 2 - [monitor] => 2 - ) - - ) - -) - -]]> - - - - - Ejemplo sencillo de TermsComponent - usar un prefijo - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$cliente = new SolrClient($opciones); - -$consulta = new SolrQuery(); - -$consulta->setTerms(true); - -/* Devolver sólo los términos que empiecen con $prefijo */ -$prefijo = 'c'; - -$consulta->setTermsField('cat')->setTermsPrefix($prefijo); - -$respuestaActualización = $cliente->query($consulta); - -print_r($respuestaActualización->getResponse()); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 1 - ) - - [terms] => SolrObject Object - ( - [cat] => SolrObject Object - ( - [card] => 2 - [connector] => 2 - [camera] => 1 - [copier] => 1 - ) - - ) - -) -]]> - - - - - Ejemplo sencillo de TermsComponent - especificar una frecuencia mínima - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$cliente = new SolrClient($opciones); - -$consulta = new SolrQuery(); - -$consulta->setTerms(true); - -/* Devolver sólo los términos que empiecen con $prefijo */ -$prefijo = 'c'; - -/* Devolver sólo los términos con una frecuencia de 2 o mayor */ -$frecuencia_mín = 2; - -$consulta->setTermsField('cat')->setTermsPrefix($prefijo)->setTermsMinCount($frecuencia_mín); - -$respuestaActualización = $cliente->query($consulta); - -print_r($respuestaActualización->getResponse()); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 0 - ) - - [terms] => SolrObject Object - ( - [cat] => SolrObject Object - ( - [card] => 2 - [connector] => 2 - ) - - ) - -) -]]> - - - - - Ejemplo sencillo de Facet - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$cliente = new SolrClient($opciones); - -$consulta = new SolrQuery('*:*'); - -$consulta->setFacet(true); - -$consulta->addFacetField('cat')->addFacetField('name')->setFacetMinCount(2); - -$respuestaActualización = $cliente->query($consulta); - -$array_respuesta = $respuestaActualización->getResponse(); - -$datos_faceta = $array_respuesta->facet_counts->facet_fields; - -print_r($datos_faceta); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [electronics] => 14 - [memory] => 3 - [Lucene] => 2 - [Software] => 2 - [card] => 2 - [connector] => 2 - [drive] => 2 - [graphics] => 2 - [hard] => 2 - [monitor] => 2 - [search] => 2 - [software] => 2 - ) - - [name] => SolrObject Object - ( - [gb] => 6 - [1] => 3 - [184] => 3 - [2] => 3 - [3200] => 3 - [400] => 3 - [500] => 3 - [ddr] => 3 - [i] => 3 - [ipod] => 3 - [memori] => 3 - [pc] => 3 - [pin] => 3 - [pod] => 3 - [sdram] => 3 - [system] => 3 - [unbuff] => 3 - [canon] => 2 - [corsair] => 2 - [drive] => 2 - [hard] => 2 - [mb] => 2 - [n] => 2 - [power] => 2 - [retail] => 2 - [video] => 2 - [x] => 2 - ) - -) -]]> - - - - - Ejemplo sencillo de Facet - con sobrescritura de campo opcional para mincount - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$cliente = new SolrClient($opciones); - -$consulta = new SolrQuery('*:*'); - -$consulta->setFacet(true); - -$consulta->addFacetField('cat')->addFacetField('name')->setFacetMinCount(2)->setFacetMinCount(4, 'name'); - -$respuestaActualización = $cliente->query($consulta); - -$array_respuesta = $respuestaActualización->getResponse(); - -$datos_faceta = $array_respuesta->facet_counts->facet_fields; - -print_r($datos_faceta); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [electronics] => 14 - [memory] => 3 - [Lucene] => 2 - [Software] => 2 - [card] => 2 - [connector] => 2 - [drive] => 2 - [graphics] => 2 - [hard] => 2 - [monitor] => 2 - [search] => 2 - [software] => 2 - ) - - [name] => SolrObject Object - ( - [gb] => 6 - ) - -) -]]> - - - - - Ejemplo de fecha de faceta - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($opciones); - -$consulta = new SolrQuery('*:*'); - -$consulta->setFacet(true); - -$consulta->addFacetDateField('manufacturedate_dt'); - -$consulta->setFacetDateStart('2006-02-13T00:00:00Z'); - -$consulta->setFacetDateEnd('2012-02-13T00:00:00Z'); - -$consulta->setFacetDateGap('+1YEAR'); - -$consulta->setFacetDateHardEnd(1); - -$consulta->addFacetDateOther('before'); - -$respuestaActualización = $client->query($consulta); - -$array_respuesta = $respuestaActualización->getResponse(); - -$datos_faceta = $array_respuesta->facet_counts->facet_dates; - -print_r($datos_faceta); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [2006-02-13T00:00:00Z] => 9 - [2007-02-13T00:00:00Z] => 0 - [2008-02-13T00:00:00Z] => 0 - [2009-02-13T00:00:00Z] => 0 - [2010-02-13T00:00:00Z] => 0 - [2011-02-13T00:00:00Z] => 0 - [gap] => +1YEAR - [start] => 2006-02-13T00:00:00Z - [end] => 2012-02-13T00:00:00Z - [before] => 2 - ) - -) -]]> - - - - - Conectar a un Servidor con SSL Habilitado - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, - 'timeout' => SOLR_SERVER_TIMEOUT, - 'secure' => SOLR_SECURE, - 'ssl_cert' => SOLR_SSL_CERT_ONLY, - 'ssl_key' => SOLR_SSL_KEY, - 'ssl_keypassword' => SOLR_SSL_KEYPASSWORD, - 'ssl_cainfo' => SOLR_SSL_CAINFO, -); - -$cliente = new SolrClient($opciones); - -$consulta = new SolrQuery('*:*'); - -$consulta->setFacet(true); - -$consulta->addFacetField('cat')->addFacetField('name')->setFacetMinCount(2)->setFacetMinCount(4, 'name'); - -$respuestaActualización = $cliente->query($consulta); - -$array_respuesta = $respuestaActualización->getResponse(); - -$datos_faceta = $array_respuesta->facet_counts->facet_fields; - -print_r($datos_faceta); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [electronics] => 14 - [memory] => 3 - [Lucene] => 2 - [Software] => 2 - [card] => 2 - [connector] => 2 - [drive] => 2 - [graphics] => 2 - [hard] => 2 - [monitor] => 2 - [search] => 2 - [software] => 2 - ) - - [name] => SolrObject Object - ( - [gb] => 6 - ) - -) -]]> - - - - - - Colapsar un <type>SolrQuery</type> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, - 'path' => SOLR_SERVER_PATH -); - -$client = new SolrClient($options); - -$query = new SolrQuery('*:*'); - -$collapseFunction = new SolrCollapseFunction('manu_id_s'); - -$collapseFunction -->setSize(2) -->setNullPolicy(SolrCollapseFunction::NULLPOLICY_IGNORE); - -$query -->collapse($collapseFunction) -->setRows(4); - -$queryResponse = $client->query($query); - -$response = $queryResponse->getResponse(); - -print_r($response); -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 1 - [params] => SolrObject Object - ( - [q] => *:* - [indent] => on - [fq] => {!collapse field=manu_id_s size=2 nullPolicy=ignore} - [rows] => 4 - [version] => 2.2 - [wt] => xml - ) - - ) - - [response] => SolrObject Object - ( - [numFound] => 14 - [start] => 0 - [docs] => Array - ( - [0] => SolrObject Object - ( - [id] => SP2514N - [name] => Array - ( - [0] => Samsung SpinPoint P120 SP2514N - hard drive - 250 GB - ATA-133 - ) - - [manu] => Array - ( - [0] => Samsung Electronics Co. Ltd. - ) - - [manu_id_s] => samsung - [cat] => Array - ( - [0] => electronics - [1] => hard drive - ) - - [features] => Array - ( - [0] => 7200RPM, 8MB cache, IDE Ultra ATA-133 - [1] => NoiseGuard, SilentSeek technology, Fluid Dynamic Bearing (FDB) motor - ) - - [price] => Array - ( - [0] => 92 - ) - - [popularity] => Array - ( - [0] => 6 - ) - - [inStock] => Array - ( - [0] => 1 - ) - - [manufacturedate_dt] => 2006-02-13T15:26:37Z - [store] => Array - ( - [0] => 35.0752,-97.032 - ) - - [_version_] => 1510294336412057600 - ) - - [1] => SolrObject Object - ( - [id] => 6H500F0 - [name] => Array - ( - [0] => Maxtor DiamondMax 11 - hard drive - 500 GB - SATA-300 - ) - - [manu] => Array - ( - [0] => Maxtor Corp. - ) - - [manu_id_s] => maxtor - [cat] => Array - ( - [0] => electronics - [1] => hard drive - ) - - [features] => Array - ( - [0] => SATA 3.0Gb/s, NCQ - [1] => 8.5ms seek - [2] => 16MB cache - ) - - [price] => Array - ( - [0] => 350 - ) - - [popularity] => Array - ( - [0] => 6 - ) - - [inStock] => Array - ( - [0] => 1 - ) - - [store] => Array - ( - [0] => 45.17614,-93.87341 - ) - - [manufacturedate_dt] => 2006-02-13T15:26:37Z - [_version_] => 1510294336449806336 - ) - - [2] => SolrObject Object - ( - [id] => F8V7067-APL-KIT - [name] => Array - ( - [0] => Belkin Mobile Power Cord for iPod w/ Dock - ) - - [manu] => Array - ( - [0] => Belkin - ) - - [manu_id_s] => belkin - [cat] => Array - ( - [0] => electronics - [1] => connector - ) - - [features] => Array - ( - [0] => car power adapter, white - ) - - [weight] => Array - ( - [0] => 4 - ) - - [price] => Array - ( - [0] => 19.95 - ) - - [popularity] => Array - ( - [0] => 1 - ) - - [inStock] => Array - ( - [0] => - ) - - [store] => Array - ( - [0] => 45.18014,-93.87741 - ) - - [manufacturedate_dt] => 2005-08-01T16:30:25Z - [_version_] => 1510294336458194944 - ) - - [3] => SolrObject Object - ( - [id] => MA147LL/A - [name] => Array - ( - [0] => Apple 60 GB iPod with Video Playback Black - ) - - [manu] => Array - ( - [0] => Apple Computer Inc. - ) - - [manu_id_s] => apple - [cat] => Array - ( - [0] => electronics - [1] => music - ) - - [features] => Array - ( - [0] => iTunes, Podcasts, Audiobooks - [1] => Stores up to 15,000 songs, 25,000 photos, or 150 hours of video - [2] => 2.5-inch, 320x240 color TFT LCD display with LED backlight - [3] => Up to 20 hours of battery life - [4] => Plays AAC, MP3, WAV, AIFF, Audible, Apple Lossless, H.264 video - [5] => Notes, Calendar, Phone book, Hold button, Date display, Photo wallet, Built-in games, JPEG photo playback, Upgradeable firmware, USB 2.0 compatibility, Playback speed control, Rechargeable capability, Battery level indication - ) - - [includes] => Array - ( - [0] => earbud headphones, USB cable - ) - - [weight] => Array - ( - [0] => 5.5 - ) - - [price] => Array - ( - [0] => 399 - ) - - [popularity] => Array - ( - [0] => 10 - ) - - [inStock] => Array - ( - [0] => 1 - ) - - [store] => Array - ( - [0] => 37.7752,-100.0232 - ) - - [manufacturedate_dt] => 2005-10-12T08:00:00Z - [_version_] => 1510294336562003968 - ) - - ) - - ) - -) -]]> - - - - - Ejemplo de conseguir el tiempo real Solr(RTG) <function>SolrClient::getById</function> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, - 'path' => SOLR_SERVER_PATH -); - -$client = new SolrClient($options); -$response = $client->getById('GB18030TEST'); -print_r($response->getResponse()); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [id] => GB18030TEST - [name] => Array - ( - [0] => Test with some GB18030 encoded characters - ) - - [features] => Array - ( - [0] => No accents here - [1] => 这是一个功能 - [2] => This is a feature (translated) - [3] => 这份文件是很有光泽 - [4] => This document is very shiny (translated) - ) - - [price] => Array - ( - [0] => 0 - ) - - [inStock] => Array - ( - [0] => 1 - ) - - [_version_] => 1510294336239042560 - ) - -) -]]> - - - - - - - diff --git a/reference/solr/functions/solr-get-version.xml b/reference/solr/functions/solr-get-version.xml deleted file mode 100644 index 51cd8371bd..0000000000 --- a/reference/solr/functions/solr-get-version.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - - solr_get_version - Devuelve la versión actual de la extensión Apache Solr - - - - &reftitle.description; - - stringsolr_get_version - - - - Esta función devuelve la versión actual de la extensión como una cadena. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - Devuelve una cadena en caso de éxito y &false; en caso de fallo. - - - - - &reftitle.errors; - - Esta función no lanza errores o excepciones. - - - - - &reftitle.examples; - - - Ejemplo de <function>solr_get_version</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - SolrUtils::getSolrVersion - - - - - - - diff --git a/reference/solr/reference.xml b/reference/solr/reference.xml deleted file mode 100644 index 7f945118e4..0000000000 --- a/reference/solr/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - &Functions; de Solr - - &reference.solr.entities.functions; - - - - - diff --git a/reference/solr/setup.xml b/reference/solr/setup.xml deleted file mode 100644 index 43e2645cbb..0000000000 --- a/reference/solr/setup.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - - Las extensiones libxml y curl deben activarse asimismo - para disponibilizar la extensión Apache Solr. - - - Se requiere libxml2 en versión 2.6.31 y posteriores. - - - Se requiere libcurl en versión 7.18.0 y posteriores. - - - Las versiones de biblioteca mencionadas son necesarias y - intentar modificar el código para compilar esta extensión - con bibliotecas de versión diferente no se recomienda. - Esto podría fallar con errores que podrían ser - muy difíciles de depurar. - -
    - - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;solr. - - - Para obtener ayuda y soporte, visite el grupo google de - la extensión. - Extensión Apache Solr PHP - - - &pecl.windows.download.avail; - - - - El módulo Solr puede ser compilado en modo de depuración pasando - la opción de configuración . - - - Durante una compilación manual, asegúrese de incluir el soporte - curl y libxml. - - -
    - - -
    - - diff --git a/reference/solr/solrclient.xml b/reference/solr/solrclient.xml deleted file mode 100644 index 28721ac278..0000000000 --- a/reference/solr/solrclient.xml +++ /dev/null @@ -1,239 +0,0 @@ - - - - - - - - La clase SolrClient - SolrClient - - - - -
    - &reftitle.intro; - - Usada para enviar solicitudes al servidor Solr. Actualmente no está soportado clonar y serializar instancias de SolrClient. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrClient - - - - - final - SolrClient - - - - &Constants; - - const - int - SolrClient::SEARCH_SERVLET_TYPE - 1 - - - const - int - SolrClient::UPDATE_SERVLET_TYPE - 2 - - - const - int - SolrClient::THREADS_SERVLET_TYPE - 4 - - - const - int - SolrClient::PING_SERVLET_TYPE - 8 - - - const - int - SolrClient::TERMS_SERVLET_TYPE - 16 - - - const - int - SolrClient::SYSTEM_SERVLET_TYPE - 32 - - - const - string - SolrClient::DEFAULT_SEARCH_SERVLET - select - - - const - string - SolrClient::DEFAULT_UPDATE_SERVLET - update - - - const - string - SolrClient::DEFAULT_THREADS_SERVLET - admin/threads - - - const - string - SolrClient::DEFAULT_PING_SERVLET - admin/ping - - - const - string - SolrClient::DEFAULT_TERMS_SERVLET - terms - - - const - string - SolrClient::DEFAULT_SYSTEM_SERVLET - admin/system - - - &Methods; - - - - - - -
    - - -
    - &reftitle.constants; - - - - SolrClient::SEARCH_SERVLET_TYPE - - Usado cuando se actualiza servlet de búsqueda. - - - - - SolrClient::UPDATE_SERVLET_TYPE - - Usado cuando se actualiza el servlet de actualización. - - - - - SolrClient::THREADS_SERVLET_TYPE - - Usado cuando se actualiza el servlet de hilos. - - - - - SolrClient::PING_SERVLET_TYPE - - Usado cuando se actualiza el servlet de ping. - - - - - SolrClient::TERMS_SERVLET_TYPE - - Usado cuando se actualiza el servlet de términos. - - - - - SolrClient::SYSTEM_SERVLET_TYPE - - Usado cuando se obtiene información del sistema desde el servlet de sistema. - - - - - SolrClient::DEFAULT_SEARCH_SERVLET - - Este es el valor inicial del servlet de búsqueda. - - - - - SolrClient::DEFAULT_UPDATE_SERVLET - - Este es el valor inicial del servlet de actualizacion. - - - - - SolrClient::DEFAULT_THREADS_SERVLET - - Este es el valor inicial del servlet de hilos. - - - - - SolrClient::DEFAULT_PING_SERVLET - - Este es el valor inicial del servlet de ping. - - - - - SolrClient::DEFAULT_TERMS_SERVLET - - Este es el valor inicial del servlet de términos usados por TermsComponent - - - - - SolrClient::DEFAULT_SYSTEM_SERVLET - - Este es el valor inicial del servlet del sistema usado para obtener información de Solr Server - - - - -
    - - - -
    - - &reference.solr.entities.solrclient; - -
    - - diff --git a/reference/solr/solrclient/adddocument.xml b/reference/solr/solrclient/adddocument.xml deleted file mode 100644 index 2da3b1222a..0000000000 --- a/reference/solr/solrclient/adddocument.xml +++ /dev/null @@ -1,231 +0,0 @@ - - - - - - - - SolrClient::addDocument - Añade un documento al índice - - - - &reftitle.description; - - public SolrUpdateResponseSolrClient::addDocument - SolrInputDocumentdoc - booloverwrite&true; - intcommitWithin0 - - - Este método añade un documento al índice. - - - - - - &reftitle.parameters; - - - - doc - - - La instancia de SolrInputDocument. - - - - - overwrite - - - Si sobrescribir el documento existente o no. Si es &false; existirán duplicados (varios documento con el mismo ID). - - - - - En Solr < 2.0 de PECL se usó $allowDups en lugar de $overwrite, que tiene la misma funcionalidad con la bandera booleana opuesta. - - - $allowDups = false es lo mismo que $overwrite = true - - - - - - commitWithin - - - Número de milisegundos dentro de los que autoconsignar este documento. Disponible desde Solr 1.4. El valor predeterminado (0) significa deshabilitado. - - - Cuando se especifica este valor, deja el control de cúando realizar la consignación - al mismo Solr, optimizando el número de consignaciones a un mínimo mientras aún se cumple - con los requisitos - de latencia de actualizaciones, por lo que Solr realizará automáticamente una consignación - cuando la agregación más antigua en el búfer venza. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto SolrUpdateResponse o lanza una excepción en caso de error. - - - - - &reftitle.errors; - - Lanza una SolrClientException si el cliente falló o hubo un problema de conexión. - - - Lanza una SolrServerException si el servidor de Solr falló al procesar la petición. - - - - - &reftitle.examples; - - - Ejemplo de <methodname>SolrClient::addDocument</methodname> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$cliente = new SolrClient($opciones); - -$doc = new SolrInputDocument(); - -$doc->addField('id', 334455); -$doc->addField('cat', 'Software'); -$doc->addField('cat', 'Lucene'); - -$respuestaActualización = $cliente->addDocument($doc); - -// se ha de consignar los cambios a escribir is no se usó $commitWithin -$client->commit(); - -print_r($respuestaActualización->getResponse()); - -?> - -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 1 - ) - -) - -]]> - - - - - - Ejemplo 2 de <methodname>SolrClient::addDocument</methodname> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$cliente = new SolrClient($opciones); - -$doc = new SolrInputDocument(); - -$doc->addField('id', 334455); -$doc->addField('cat', 'Software'); -$doc->addField('cat', 'Lucene'); - -// No es necesario llamar a commit() ya que se proporciona $commitWithin, por lo que Solr Server autoconsignará en 10 segundos -$respuestaActualización = $cliente->addDocument($doc, false, 10000); - -print_r($updateResponse->getResponse()); - -?> - -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 1 - ) - -) - -]]> - - - - - - - - &reftitle.seealso; - - - SolrClient::addDocuments - SolrClient::commit - - - - - - - diff --git a/reference/solr/solrclient/adddocuments.xml b/reference/solr/solrclient/adddocuments.xml deleted file mode 100644 index c6593c49cb..0000000000 --- a/reference/solr/solrclient/adddocuments.xml +++ /dev/null @@ -1,182 +0,0 @@ - - - - - - - - SolrClient::addDocuments - Añade una colección de instancias de SolrInputDocument al índice - - - - &reftitle.description; - - public voidSolrClient::addDocuments - arraydocs - booloverwrite&true; - intcommitWithin0 - - - Añade una colección de documentos al índice. - - - - - - &reftitle.parameters; - - - - docs - - - Una array que contiene la colección de instancias de SolrInputDocument. Este array debe ser una variable real. - - - - - overwrite - - - Si sobrescribir el documento existente o no. Si es &false; existirán duplicados (varios documento con el mismo ID). - - - - - En Solr < 2.0 de PECL se usó $allowDups en lugar de $overwrite, que tiene la misma funcionalidad con la bandera booleana opuesta. - - - $allowDups = false es lo mismo que $overwrite = true - - - - - - commitWithin - - - Número de milisegundos dentro de los que autoconsignar este documento. Disponible desde Solr 1.4. El valor predeterminado (0) significa deshabilitado. - - - Cuando se especifica este valor, deja el control de cúando realizar la consignación - al mismo Solr, optimizando el número de consignaciones a un mínimo mientras aún se cumple - con los requisitos - de latencia de actualizaciones, por lo que Solr realizará automáticamente una consignación - cuando la agregación más antigua en el búfer venza. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto SolrUpdateResponse o lanza una excepción en caso de error. - - - - - &reftitle.errors; - - Lanza una SolrClientException si el cliente falló o hubo un problema de conexión. - - - Lanza una SolrServerException si el Servidor de Solr falló al procesar la petición. - - - - - &reftitle.examples; - - - Ejemplo de <methodname>SolrClient::addDocuments</methodname> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$cliente = new SolrClient($opciones); - -$doc = new SolrInputDocument(); - -$doc->addField('id', 334455); -$doc->addField('cat', 'Software'); -$doc->addField('cat', 'Lucene'); - -$doc2 = clone $doc; - -$doc2->deleteField('id'); -$doc2->addField('id', 334456); - -$docs = array($doc, $doc2); - -$respuestaActualización = $cliente->addDocuments($docs); - -// no se escribirán los cambios en disco hasta que se proporcione $commitWithin o se llame a SolrClient::commit - -print_r($respuestaActualización->getResponse()); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 2 - ) - -) - -]]> - - - - - - - &reftitle.seealso; - - - SolrClient::addDocument - SolrClient::commit - - - - - - - diff --git a/reference/solr/solrclient/commit.xml b/reference/solr/solrclient/commit.xml deleted file mode 100644 index 406c508149..0000000000 --- a/reference/solr/solrclient/commit.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - - - SolrClient::commit - Finaliza todas las añadiduras/eliminaciones hechas al índice - - - - &reftitle.description; - - public SolrUpdateResponseSolrClient::commit - boolsoftCommit&false; - boolwaitSearcher&true; - boolexpungeDeletes&false; - - - Este método finaliza todas las añadiduras/eliminaciones hechas al índice. - - - - - - &reftitle.parameters; - - - - softCommit - - - Refresca la 'vista' del índice para un mayor rendimiento, pero si sin garantizar "on-disk". (Solr4.0+) - - - Una consignación suave es mucho más rápida ya que solamente hace visibles los cabios de índices y usa fsync con los ficheros de índices o escribe un nuevo descriptor de índice. - Si la JVM falla o hay una bajada de tensión, los cambios acaecidos después de la úlitma consignación dura se perderán. - Las búsquedas que tengan requisitos cercanos al tiempo real (que requieren que los cambios de índices estén rápidamente visibles para búsquedas) necesitarán más a menudo consignas suaves, y menos frecuentemente duras. - - - - - waitSearcher - - - Bloqueo hasta que un nuevo buscador sea abierto y registrado como el buscador de consultas principal, haciendo los cambios visibles. - - - - - expungeDeletes - - - Mezcla segmentos con eliminaciones para desechar. (Solr1.4+) - - - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto SolrUpdateResponse en caso de éxito o lanza una excepción en caso de error. - - - - - &reftitle.errors; - - Lanza una SolrClientException si el cliente falló o hubo un problema de conexión. - - - Lanza una SolrServerException si el Servidor de Solr falló al procesar la petición. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL solr 1.1.0, PECL solr 2.0.0 - - Se eliminó el parámetro $maxSegments. - - - - PECL solr 2.0.0b - - Cambio en la API: SolrClient::commit ([ int $maxSegments = 0 [, bool $softCommit = false [, bool $waitSearcher = true[, bool $expungeDeletes = false ]]] ) - - - - - PECL solr 0.9.2 - - Firma: SolrClient::commit ([ int $maxSegments = 1 [, bool $waitFlush = true [, bool $waitSearcher = true ]]] ). - $waitFlush: Bloquea hasta que los cambios de índices sean volcados a disco. - - - - - - - - - &reftitle.notes; - - - Solr >= 2.0 de PECL solamente soporta Solr Server >= 4.0 - - - - - - &reftitle.seealso; - - - SolrClient::optimize - SolrClient::rollback - - - - - - - diff --git a/reference/solr/solrclient/construct.xml b/reference/solr/solrclient/construct.xml deleted file mode 100644 index e8cd1aadf1..0000000000 --- a/reference/solr/solrclient/construct.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - - - SolrClient::__construct - Constructor para el objeto SolrClient - - - - &reftitle.description; - - public SolrClient::__construct - arrayclientOptions - - - Constructor para el objeto SolrClient - - - - - - &reftitle.parameters; - - - - clientOptions - - - Esto es una matriz que contiene una de las siguientes claves: - - - - - - - - - - - - - &reftitle.errors; - - Lanza una SolrIllegalArgumentException en caso de error. - - - - - &reftitle.examples; - - - Ejemplo de <methodname>SolrClient::__construct</methodname> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, - 'path' => SOLR_PATH_TO_SOLR, - 'wt' => 'xml', -); - -$cliente = new SolrClient($opciones); - -$doc = new SolrInputDocument(); - -$doc->addField('id', 334455); -$doc->addField('cat', 'Software'); -$doc->addField('cat', 'Lucene'); - -$respuestaActualización = $cliente->addDocument($doc); - -?> - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - SolrClient::getOptions - - - - - - diff --git a/reference/solr/solrclient/deletebyid.xml b/reference/solr/solrclient/deletebyid.xml deleted file mode 100644 index fe473b0da9..0000000000 --- a/reference/solr/solrclient/deletebyid.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - - SolrClient::deleteById - Eliminar por Id - - - - &reftitle.description; - - public SolrUpdateResponseSolrClient::deleteById - stringid - - - Elimina el documento con el ID especificado, donde ID es el valor del campo uniqueKey declarado en el esquema. - - - - - - &reftitle.parameters; - - - - id - - - El valor del campo uniqueKey declarado en el esquema - - - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto SolrUpdateResponse en caso de éxito y lanza una excepción en caso de error. - - - - - &reftitle.errors; - - Lanza una SolrClientException si el cliente falló o hubo un problema de conexión. - - - Lanza una SolrServerException si el Servidor de Solr falló al procesar la petición. - - - - - &reftitle.seealso; - - - SolrClient::deleteByIds - SolrClient::deleteByQuery - SolrClient::deleteByQueries - - - - - - - diff --git a/reference/solr/solrclient/deletebyids.xml b/reference/solr/solrclient/deletebyids.xml deleted file mode 100644 index 9373fcff59..0000000000 --- a/reference/solr/solrclient/deletebyids.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - - SolrClient::deleteByIds - Elimina mediante Ids - - - - &reftitle.description; - - public SolrUpdateResponseSolrClient::deleteByIds - arrayids - - - Elimina una colección de documentos con el conjunto de ids especificado. - - - - - - &reftitle.parameters; - - - - ids - - - Una matriz de IDs que representa el campo uniqueKey declarado en el esquema para cada documento a ser eliminado. Debe ser una variable de PHP real. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto SolrUpdateResponse en caso de éxito y lanza una excepción en caso de error. - - - - - &reftitle.errors; - - Lanza una SolrClientException si el cliente falló o hubo un problema de conexión. - - - Lanza una SolrServerException si el Servidor de Solr falló al procesar la petición. - - - - - &reftitle.seealso; - - - SolrClient::deleteById - SolrClient::deleteByQuery - SolrClient::deleteByQueries - - - - - - - diff --git a/reference/solr/solrclient/deletebyqueries.xml b/reference/solr/solrclient/deletebyqueries.xml deleted file mode 100644 index a8d80092cf..0000000000 --- a/reference/solr/solrclient/deletebyqueries.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - - SolrClient::deleteByQueries - Elimina todos los documentos que coincidan con cualquiera de las consultas - - - - &reftitle.description; - - public SolrUpdateResponseSolrClient::deleteByQueries - arrayqueries - - - Elimina todos los documentos que coincidan con cualquiera de las consultas - - - - - &reftitle.parameters; - - - - queries - - - La matriz de consultas. Debe ser una variable de php real. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto SolrUpdateResponse en caso de éxito y lanza una SolrClientException en caso de error. - - - - - &reftitle.errors; - - Lanza una SolrClientException si el cliente falló o hubo un problema de conexión. - - - Lanza una SolrServerException si el Servidor de Solr falló al procesar la petición. - - - - - &reftitle.seealso; - - - SolrClient::deleteById - SolrClient::deleteByIds - SolrClient::deleteByQuery - - - - - - - diff --git a/reference/solr/solrclient/deletebyquery.xml b/reference/solr/solrclient/deletebyquery.xml deleted file mode 100644 index 9eb6159677..0000000000 --- a/reference/solr/solrclient/deletebyquery.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - - - SolrClient::deleteByQuery - Elimina todos los documentos que coincidan con la consulta dada - - - - &reftitle.description; - - public SolrUpdateResponseSolrClient::deleteByQuery - stringquery - - - Elimina todos los documentos que coincidan con la consulta dada. - - - - - - &reftitle.parameters; - - - - query - - - La consulta - - - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto SolrUpdateResponse en caso de éxito y lanza una excepción en caso de error. - - - - - &reftitle.errors; - - Lanza una SolrClientException si el cliente falló o hubo un problema de conexión. - - - Lanza una SolrServerException si el Servidor de Solr falló al procesar la petición. - - - - - &reftitle.examples; - - - Ejemplo de <methodname>SolrQuery::deleteByQuery</methodname> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$cliente = new SolrClient($opciones); - -//Esto borrará el índice por completo -$cliente->deleteByQuery("*:*"); -$cliente->commit(); - -?> -]]> - - - - - - - &reftitle.seealso; - - - SolrClient::deleteById - SolrClient::deleteByIds - SolrClient::deleteByQueries - - - - - - - diff --git a/reference/solr/solrclient/destruct.xml b/reference/solr/solrclient/destruct.xml deleted file mode 100644 index 3803521b92..0000000000 --- a/reference/solr/solrclient/destruct.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - SolrClient::__destruct - Destructor para SolrClient - - - - &reftitle.description; - - public SolrClient::__destruct - - - - Destructor - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Destructor para SolrClient - - - - - &reftitle.seealso; - - - SolrClient::__construct - - - - - - - diff --git a/reference/solr/solrclient/getbyid.xml b/reference/solr/solrclient/getbyid.xml deleted file mode 100644 index 950abc3565..0000000000 --- a/reference/solr/solrclient/getbyid.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - SolrClient::getById - Devuelve un documento por su identificador. Utiliza la funcionalidad de búsqueda en tiempo real de Solr (Solr Realtime Get - RTG) - - - - &reftitle.description; - - public SolrQueryResponseSolrClient::getById - stringid - - - Devuelve un documento por su identificador. Utiliza la búsqueda en tiempo real de Solr. - - - - - &reftitle.parameters; - - - id - - - El identificador del documento. - - - - - - - - &reftitle.returnvalues; - - SolrQueryResponse - - - - - &reftitle.examples; - - Ejemplo de <function>SolrClient::getById</function> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, - 'path' => SOLR_SERVER_PATH -); - -$client = new SolrClient($options); -$response = $client->getById('GB18030TEST'); -print_r($response->getResponse()); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [id] => GB18030TEST - [name] => Array - ( - [0] => Test with some GB18030 encoded characters - ) - - [features] => Array - ( - [0] => No accents here - [1] => 这是一个功能 - [2] => This is a feature (translated) - [3] => 这份文件是很有光泽 - [4] => This document is very shiny (translated) - ) - - [price] => Array - ( - [0] => 0 - ) - - [inStock] => Array - ( - [0] => 1 - ) - - [_version_] => 1510294336239042560 - ) - -) -]]> - - - - - - &reftitle.seealso; - - SolrClient::getByIds - - - - - - diff --git a/reference/solr/solrclient/getbyids.xml b/reference/solr/solrclient/getbyids.xml deleted file mode 100644 index 874a4546dc..0000000000 --- a/reference/solr/solrclient/getbyids.xml +++ /dev/null @@ -1,200 +0,0 @@ - - - - - - SolrClient::getByIds - Devuelve documentos por sus identificadores. Utiliza la funcionalidad de búsqueda en tiempo real de Solr (Solr Realtime Get - RTG) - - - - &reftitle.description; - - public SolrQueryResponseSolrClient::getByIds - arrayids - - - Devuelve los documentos por sus identificadores. Utiliza la búsqueda en tiempo real de Solr. - - - - - - &reftitle.parameters; - - - ids - - - Los identificadores de los documentos. - - - - - - - - &reftitle.returnvalues; - - SolrQueryResponse - - - - - &reftitle.examples; - - Ejemplo de <function>SolrClient::getByIds</function> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, - 'path' => SOLR_SERVER_PATH -); - -$client = new SolrClient($options); -$response = $client->getByIds(['GB18030TEST', '6H500F0']); - -print_r($response->getResponse()); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [numFound] => 2 - [start] => 0 - [docs] => Array - ( - [0] => SolrObject Object - ( - [id] => GB18030TEST - [name] => Array - ( - [0] => Test with some GB18030 encoded characters - ) - - [features] => Array - ( - [0] => No accents here - [1] => 这是一个功能 - [2] => This is a feature (translated) - [3] => 这份文件是很有光泽 - [4] => This document is very shiny (translated) - ) - - [price] => Array - ( - [0] => 0 - ) - - [inStock] => Array - ( - [0] => 1 - ) - - [_version_] => 1510294336239042560 - ) - - [1] => SolrObject Object - ( - [id] => 6H500F0 - [name] => Array - ( - [0] => Maxtor DiamondMax 11 - hard drive - 500 GB - SATA-300 - ) - - [manu] => Array - ( - [0] => Maxtor Corp. - ) - - [manu_id_s] => maxtor - [cat] => Array - ( - [0] => electronics - [1] => hard drive - ) - - [features] => Array - ( - [0] => SATA 3.0Gb/s, NCQ - [1] => 8.5ms seek - [2] => 16MB cache - ) - - [price] => Array - ( - [0] => 350 - ) - - [popularity] => Array - ( - [0] => 6 - ) - - [inStock] => Array - ( - [0] => 1 - ) - - [store] => Array - ( - [0] => 45.17614,-93.87341 - ) - - [manufacturedate_dt] => 2006-02-13T15:26:37Z - [_version_] => 1510294336449806336 - ) - - ) - - ) - -) -]]> - - - - - - &reftitle.seealso; - - SolrClient::getById - - - - - - diff --git a/reference/solr/solrclient/getdebug.xml b/reference/solr/solrclient/getdebug.xml deleted file mode 100644 index 03b989b581..0000000000 --- a/reference/solr/solrclient/getdebug.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrClient::getDebug - Devuelve la información de depuración para el último intento de conexión - - - - &reftitle.description; - - public stringSolrClient::getDebug - - - - Devuelve la información de depuración para el último intento de conexión - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una cadena en caso de éxito y null si no hay nada que devolver. - - - - - - diff --git a/reference/solr/solrclient/getoptions.xml b/reference/solr/solrclient/getoptions.xml deleted file mode 100644 index cec46f5772..0000000000 --- a/reference/solr/solrclient/getoptions.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - SolrClient::getOptions - Devuelve las opciones de cliente establecidas internamente - - - - &reftitle.description; - - public arraySolrClient::getOptions - - - - Devuelve las opciones de cliente establecidas internamente. Muy útil para depurar. Los valores devueltos son de sólo lectura y sólo se pueden establecer cuando el objeto es instanciado. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una matriz que contiene todas las opciones para el objeto SolrClient establecido internamente. - - - - - &reftitle.seealso; - - - SolrClient::__construct - - - - - - - diff --git a/reference/solr/solrclient/optimize.xml b/reference/solr/solrclient/optimize.xml deleted file mode 100644 index 13153aa1d8..0000000000 --- a/reference/solr/solrclient/optimize.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - - SolrClient::optimize - Defragmenta el índice - - - - &reftitle.description; - - public SolrUpdateResponseSolrClient::optimize - intmaxSegments1 - boolsoftCommit&true; - boolwaitSearcher&true; - - - Defragmenta el índice para un rendimiento de búsquda más rápido. - - - - - - &reftitle.parameters; - - - - maxSegments - - - Optimiza como máximo este número de segmentos. Desde Solr 1.3 - - - - - softCommit - - - Refresca la 'vista' del índice para un mayor rendimiento, pero si sin garantizar "on-disk". (Solr4.0+) - - - - - waitSearcher - - - Bloqueo hasta que un nuevo buscador sea abierto y registrado como el buscador de consultas principal, haciendo los cambios visibles. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto SolrUpdateResponse en caso de éxito y lanza una excepción en caso de error. - - - - - &reftitle.errors; - - Lanza una SolrClientException si el cliente falló o hubo un problema de conexión. - - - Lanza una SolrServerException si el Servidor de Solr falló al procesar la petición. - - - - - &reftitle.notes; - - - Solr >= 2.0 de PECL solamente soporta Solr Server >= 4.0 - - - Antes de Solr 2.0 de PECL, este método solía aceptar estos argumentos: "int $maxSegments, bool $waitFlush, bool $waitSearcher". - - - - - - &reftitle.seealso; - - - SolrClient::commit - SolrClient::rollback - - - - - - - diff --git a/reference/solr/solrclient/ping.xml b/reference/solr/solrclient/ping.xml deleted file mode 100644 index 279e404077..0000000000 --- a/reference/solr/solrclient/ping.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - - SolrClient::ping - Comprueba si el servidor Solr está todavía activo - - - - &reftitle.description; - - public SolrPingResponseSolrClient::ping - - - - Comprueba si el servidor Solr está todavía activo. Envía una petición HEAD al servidor Apache Solr. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un objeto SolrPingResponse en caso de éxito y lanza una excepción en caso de error. - - - - - &reftitle.errors; - - Lanza una SolrClientException si el cliente falló o hubo un problema de conexión. - - - Lanza una SolrServerException si el Servidor de Solr falló al satisfacer la petición. - - - - - &reftitle.examples; - - - Ejemplo de <methodname>SolrClient::ping</methodname> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$client = new SolrClient($options); - -$pingresponse = $client->ping(); - -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/solr/solrclient/query.xml b/reference/solr/solrclient/query.xml deleted file mode 100644 index 81a1982a9f..0000000000 --- a/reference/solr/solrclient/query.xml +++ /dev/null @@ -1,177 +0,0 @@ - - - - - - - - SolrClient::query - Envía una consulta al servidor - - - - &reftitle.description; - - public SolrQueryResponseSolrClient::query - SolrParamsquery - - - Envía una consulta al servidor. - - - - - - &reftitle.parameters; - - - - query - - - Un objeto SolrParam. Se recomienda usar SolrQuery para consultas avanzadas. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto SolrUpdateResponse en caso de éxito o lanza una excepción en caso de error. - - - - - &reftitle.errors; - - Lanza una SolrClientException si el cliente falló o hubo un problema de conexión. - - - Lanza una SolrServerException si el Servidor de Solr falló al satisfacer la consulta. - - - - - &reftitle.examples; - - - Ejemplo de <methodname>SolrClient::query</methodname> - - 'localhost', - 'login' => 'username', - 'password' => 'password', - 'port' => '8983', -); - -$cliente = new SolrClient($opciones); - -$consulta = new SolrQuery(); - -$consulta->setQuery('lucene'); - -$consulta->setStart(0); - -$consulta->setRows(50); - -$consulta->addField('cat')->addField('features')->addField('id')->addField('timestamp'); - -$respuesta_consulta = $cliente->query($consulta); - -$response = $respuesta_consulta->getResponse(); - -print_r($response); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 3 - [params] => SolrObject Object - ( - [fl] => cat,features,id,timestamp - [indent] => on - [start] => 0 - [q] => lucene - [wt] => xml - [version] => 2.2 - [rows] => 50 - ) - - ) - - [response] => SolrObject Object - ( - [numFound] => 1 - [start] => 0 - [docs] => Array - ( - [0] => SolrObject Object - ( - [id] => SOLR1000 - [cat] => Array - ( - [0] => software - [1] => search - ) - - [features] => Array - ( - [0] => Advanced Full-Text Search Capabilities using Lucene - [1] => Optimized for High Volume Web Traffic - [2] => Standards Based Open Interfaces - XML and HTTP - [3] => Comprehensive HTML Administration Interfaces - [4] => Scalability - Efficient Replication to other Solr Search Servers - [5] => Flexible and Adaptable with XML configuration and Schema - [6] => Good unicode support: héllo (hello with an accent over the e) - ) - - ) - - ) - - ) - -) -]]> - - - - - - - - diff --git a/reference/solr/solrclient/request.xml b/reference/solr/solrclient/request.xml deleted file mode 100644 index be94ee892c..0000000000 --- a/reference/solr/solrclient/request.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - - SolrClient::request - Envía una petición de actualización sin formato - - - - &reftitle.description; - - public SolrUpdateResponseSolrClient::request - stringraw_request - - - Envía una petición de actualización XML sin formato al servidor - - - - - - &reftitle.parameters; - - - - raw_request - - - Una cadena XML con la solicitud sin formato al servidor. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto SolrUpdateResponse en caso de éxito. Lanza una excepción en caso de error. - - - - - &reftitle.errors; - - Lanza una SolrIllegalArgumentException si raw_request es un string vacío. - - - Lanza una SolrClientException si el cliente falló o hubo un problema de conexión. - - - Lanza una SolrServerException si el Servidor de Solr falló al satisfacer la consulta. - - - - - &reftitle.examples; - - - Ejemplo de <methodname>SolrClient::request</methodname> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$cliente = new SolrClient($opciones); - -$respuesta_actualización = $cliente->request(""); - -$respuesta = $respuesta_actualización->getResponse(); - -print_r($respuesta); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/solr/solrclient/rollback.xml b/reference/solr/solrclient/rollback.xml deleted file mode 100644 index 34cb0dcfae..0000000000 --- a/reference/solr/solrclient/rollback.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - SolrClient::rollback - Revierte todos los añadidos/eliminados hechos en el índice desde el último envío - - - - &reftitle.description; - - public SolrUpdateResponseSolrClient::rollback - - - - Revierte todos los añadidos/eliminados hechos en el índice desde el último envío. No llama a ningún escuchador de eventos ni crea un buscador nuevo. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un objeto SolrUpdateResponse en caso de éxito o lanza una excepción SolrClientException en caso de fallo. - - - - - &reftitle.seealso; - - - SolrClient::commit - SolrClient::optimize - - - - - - - diff --git a/reference/solr/solrclient/setresponsewriter.xml b/reference/solr/solrclient/setresponsewriter.xml deleted file mode 100644 index 728883985d..0000000000 --- a/reference/solr/solrclient/setresponsewriter.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - - - SolrClient::setResponseWriter - Establece el autor de la respuesta usado para preparar la respuesta de Solr - - - - &reftitle.description; - - public voidSolrClient::setResponseWriter - stringresponseWriter - - - Establece el autor de la respuesta usado para preparar la respuesta de Solr - - - - - - &reftitle.parameters; - - - - responseWriter - - Uno de los siguientes autores: - - json - phps - xml - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Ejemplo de <methodname>SolrClient::setResponseWriter</methodname> - -$nombre_propiedad; - - } else if (isset($_propiedades[$nombre_propiedad])) { - - return $_propiedades[$nombre_propiedad]; - } - - return null; - } -} - -$opciones = array -( - 'hostname' => 'localhost', - 'port' => 8983, - 'path' => '/solr/core1' -); - -$cliente = new SolrClient($opciones); - -$cliente->setResponseWriter("json"); - -//$respuesta = $cliente->ping(); - -$consulta = new SolrQuery(); - -$consulta->setQuery("*:*"); - -$consulta->set("objectClassName", "SolrClass"); - -$consulta->set("objectPropertiesStorageMode", 1); // 0 para propiedades independientes, 1 para combinadas - -try -{ - -$respuesta = $cliente->query($consulta); - -$resp = $respuesta->getResponse(); - -print_r($respuesta); - -print_r($resp); - -} catch (Exception $e) { - -print_r($e); - -} - -?> -]]> - - - - - - - - diff --git a/reference/solr/solrclient/setservlet.xml b/reference/solr/solrclient/setservlet.xml deleted file mode 100644 index 48596844e9..0000000000 --- a/reference/solr/solrclient/setservlet.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - SolrClient::setServlet - Cambia el servlet especificado a un nuevo valor - - - - &reftitle.description; - - public boolSolrClient::setServlet - inttype - stringvalue - - - Cambia el servlet especificado a un nuevo valor - - - - - - &reftitle.parameters; - - - - type - - Uno de los siguientes tipos: - - - - - - - value - - - El nuevo valor para el servlet - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrclient/system.xml b/reference/solr/solrclient/system.xml deleted file mode 100644 index 6df090259a..0000000000 --- a/reference/solr/solrclient/system.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - SolrClient::system - Obtener información del Servidor Solr - - - - &reftitle.description; - - public voidSolrClient::system - - - - Obtener información del Servidor Solr - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un objeto SolrGenericResponse en caso de éxito. - - - - - &reftitle.errors; - - Lanza una SolrClientException si el cliente falló, o si hubo un problema con la conexión. - - - Lanza una SolrServerException si el Servidor Solr falló al satisfacer la consulta. - - - - - - diff --git a/reference/solr/solrclient/threads.xml b/reference/solr/solrclient/threads.xml deleted file mode 100644 index 574b1f7594..0000000000 --- a/reference/solr/solrclient/threads.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - SolrClient::threads - Verifica el estado de los hilos - - - - &reftitle.description; - - public voidSolrClient::threads - - - - Verifica el estado de los hilos - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un objeto SolrGenericResponse. - - - - - &reftitle.errors; - - Lanza una SolrClientException si el cliente falló o hubo un problema de conexión. - - - Lanza una SolrServerException si el Servidor de Solr falló al procesar la petición. - - - - - - diff --git a/reference/solr/solrclientexception.xml b/reference/solr/solrclientexception.xml deleted file mode 100644 index 3170c1457a..0000000000 --- a/reference/solr/solrclientexception.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - - La clase SolrClientException - SolrClientException - - - - -
    - &reftitle.intro; - - Una excepción lanzada cuando existe un error al hacer una solicitud al servidor desde el cliente. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrClientException - - - - - SolrClientException - - - - extends - SolrException - - - - - &InheritedProperties; - - - - &Methods; - - - &InheritedMethods; - - - - - - -
    - - -
    - - &reference.solr.entities.solrclientexception; - -
    - - diff --git a/reference/solr/solrclientexception/getinternalinfo.xml b/reference/solr/solrclientexception/getinternalinfo.xml deleted file mode 100644 index 3dc925b66c..0000000000 --- a/reference/solr/solrclientexception/getinternalinfo.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrClientException::getInternalInfo - Devuelve información interna de donde se lanzó la excepción - - - - &reftitle.description; - - public arraySolrClientException::getInternalInfo - - - - Devuelve información interna de donde se lanzó la excepción. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una matriz que contiene información interna de donde el error fue lanzado. Usado únicamente para depurar por desarrolladores de extensiones. - - - - - - diff --git a/reference/solr/solrcollapsefunction.xml b/reference/solr/solrcollapsefunction.xml deleted file mode 100644 index 1930af6f17..0000000000 --- a/reference/solr/solrcollapsefunction.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - - - La clase SolrCollapseFunction - SolrCollapseFunction - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrCollapseFunction - - - - - SolrCollapseFunction - - - - Constantes - - const - string - SolrCollapseFunction::NULLPOLICY_IGNORE - ignore - - - const - string - SolrCollapseFunction::NULLPOLICY_EXPAND - expand - - - const - string - SolrCollapseFunction::NULLPOLICY_COLLAPSE - collapse - - - &Methods; - - - - - - - -
    - - -
    - &reftitle.constants; - - - - SolrCollapseFunction::NULLPOLICY_IGNORE - - - - - - - SolrCollapseFunction::NULLPOLICY_EXPAND - - - - - - - SolrCollapseFunction::NULLPOLICY_COLLAPSE - - - - - - -
    - - - -
    - - &reference.solr.entities.solrcollapsefunction; - -
    - - diff --git a/reference/solr/solrcollapsefunction/construct.xml b/reference/solr/solrcollapsefunction/construct.xml deleted file mode 100644 index 5068108528..0000000000 --- a/reference/solr/solrcollapsefunction/construct.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - SolrCollapseFunction::__construct - Constructor - - - - &reftitle.description; - - public SolrCollapseFunction::__construct - stringfield - - - Función de construcción de Collapse. - - - - - - &reftitle.parameters; - - - field - - - El nombre del campo a reducir. - - - Para reducir un resultado, el tipo de campo debe ser un string, un integer o un float. - - - - - - - - &reftitle.examples; - - Ejemplo de <function>SolrCollapseFunction::__construct</function> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, - 'path' => SOLR_SERVER_PATH -); - -$client = new SolrClient($options); - -$query = new SolrQuery('*:*'); - -$func = new SolrCollapseFunction('field_name'); - -$func->setMax('sum(cscore(),field(some_other_field))'); -$func->setSize(100); -$func->setNullPolicy(SolrCollapseFunction::NULLPOLICY_EXPAND); - -$query->collapse($func); - -$queryResponse = $client->query($query); - -$response = $queryResponse->getResponse(); - -print_r($response); - -?> -]]> - - - - - - &reftitle.seealso; - - SolrQuery::collapse - - - - - - diff --git a/reference/solr/solrcollapsefunction/getfield.xml b/reference/solr/solrcollapsefunction/getfield.xml deleted file mode 100644 index fb217c11f6..0000000000 --- a/reference/solr/solrcollapsefunction/getfield.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrCollapseFunction::getField - Devuelve el campo sobre el cual se realiza la reducción - - - - &reftitle.description; - - public stringSolrCollapseFunction::getField - - - - Devuelve el campo sobre el cual se realiza la reducción. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrCollapseFunction::setField - - - - - - diff --git a/reference/solr/solrcollapsefunction/gethint.xml b/reference/solr/solrcollapsefunction/gethint.xml deleted file mode 100644 index f310cff5f1..0000000000 --- a/reference/solr/solrcollapsefunction/gethint.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrCollapseFunction::getHint - Devuelve el índice de reducción - - - - &reftitle.description; - - public stringSolrCollapseFunction::getHint - - - - Devuelve el índice de reducción. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrCollapseFunction::setHint - - - - - - diff --git a/reference/solr/solrcollapsefunction/getmax.xml b/reference/solr/solrcollapsefunction/getmax.xml deleted file mode 100644 index b4eb2cda88..0000000000 --- a/reference/solr/solrcollapsefunction/getmax.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - SolrCollapseFunction::getMax - Devuelve el argumento max - - - - &reftitle.description; - - public stringSolrCollapseFunction::getMax - - - - Devuelve el argumento max. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrCollapseFunction::setMax - - - - - - diff --git a/reference/solr/solrcollapsefunction/getmin.xml b/reference/solr/solrcollapsefunction/getmin.xml deleted file mode 100644 index 4eef235144..0000000000 --- a/reference/solr/solrcollapsefunction/getmin.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrCollapseFunction::getMin - Devuelve el argumento min - - - - &reftitle.description; - - public stringSolrCollapseFunction::getMin - - - - Devuelve el argumento min. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrCollapseFunction::setMin - - - - - - diff --git a/reference/solr/solrcollapsefunction/getnullpolicy.xml b/reference/solr/solrcollapsefunction/getnullpolicy.xml deleted file mode 100644 index dac7fdf2d3..0000000000 --- a/reference/solr/solrcollapsefunction/getnullpolicy.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrCollapseFunction::getNullPolicy - Devuelve la política de null - - - - &reftitle.description; - - public stringSolrCollapseFunction::getNullPolicy - - - - Devuelve la política de null utilizada o null - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrCollapseFunction::setNullPolicy - - - - - - diff --git a/reference/solr/solrcollapsefunction/getsize.xml b/reference/solr/solrcollapsefunction/getsize.xml deleted file mode 100644 index 274a0cb94e..0000000000 --- a/reference/solr/solrcollapsefunction/getsize.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - SolrCollapseFunction::getSize - Devuelve el argumento de tamaño - - - - &reftitle.description; - - public intSolrCollapseFunction::getSize - - - - Devuelve el tamaño inicial de las estructuras de datos de reducción al reducir sobre un campo numérico únicamente - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrCollapseFunction::setSize - - - - - - diff --git a/reference/solr/solrcollapsefunction/setfield.xml b/reference/solr/solrcollapsefunction/setfield.xml deleted file mode 100644 index 507e941f85..0000000000 --- a/reference/solr/solrcollapsefunction/setfield.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - SolrCollapseFunction::setField - Define el campo sobre el cual se realiza la reducción - - - - &reftitle.description; - - public SolrCollapseFunctionSolrCollapseFunction::setField - stringfieldName - - - El campo sobre el cual se realiza la reducción. - - Para reducir un resultado, el tipo de campo debe ser un string, un integer o un float. - - - - - - &reftitle.parameters; - - - fieldName - - - - - - - - - - - &reftitle.returnvalues; - - SolrCollapseFunction - - - - - - diff --git a/reference/solr/solrcollapsefunction/sethint.xml b/reference/solr/solrcollapsefunction/sethint.xml deleted file mode 100644 index de7a4c6585..0000000000 --- a/reference/solr/solrcollapsefunction/sethint.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - SolrCollapseFunction::setHint - Define el índice de reducción - - - - &reftitle.description; - - public SolrCollapseFunctionSolrCollapseFunction::setHint - stringhint - - - Define el índice de reducción. - - - - - - &reftitle.parameters; - - - hint - - - Actualmente, solo existe un índice disponible "top_fc", que significa top level FieldCache - - - - - - - - &reftitle.returnvalues; - - SolrCollapseFunction - - - - - &reftitle.examples; - - Ejemplo de <function>SolrCollapseFunction::setHint</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/solr/solrcollapsefunction/setmax.xml b/reference/solr/solrcollapsefunction/setmax.xml deleted file mode 100644 index a5476f30b0..0000000000 --- a/reference/solr/solrcollapsefunction/setmax.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - SolrCollapseFunction::setMax - Selecciona los encabezados de grupo por el valor máximo de un campo numérico o una consulta de función - - - - &reftitle.description; - - public SolrCollapseFunctionSolrCollapseFunction::setMax - stringmax - - - Selecciona los encabezados de grupo por el valor máximo de un campo numérico o una consulta de función. - - - - - - &reftitle.parameters; - - - max - - - - - - - - - - - &reftitle.returnvalues; - - SolrCollapseFunction - - - - - &reftitle.examples; - - Ejemplo de <function>SolrCollapseFunction::setMax</function> - -setMax('sum(cscore(),field(some_field))'); - -$query = new SolrQuery('*:*'); - -$query->collapse($func); - -?> -]]> - - - - - - diff --git a/reference/solr/solrcollapsefunction/setmin.xml b/reference/solr/solrcollapsefunction/setmin.xml deleted file mode 100644 index 0b8514baae..0000000000 --- a/reference/solr/solrcollapsefunction/setmin.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - SolrCollapseFunction::setMin - Define el tamaño inicial de las estructuras de datos de reducción al reducir sobre un campo numérico únicamente - - - - &reftitle.description; - - public SolrCollapseFunctionSolrCollapseFunction::setMin - stringmin - - - Define el tamaño inicial de las estructuras de datos de reducción al reducir sobre un campo numérico únicamente - - - - - - &reftitle.parameters; - - - min - - - - - - - - - - - &reftitle.returnvalues; - - SolrCollapseFunction - - - - - - diff --git a/reference/solr/solrcollapsefunction/setnullpolicy.xml b/reference/solr/solrcollapsefunction/setnullpolicy.xml deleted file mode 100644 index eaf08cbab0..0000000000 --- a/reference/solr/solrcollapsefunction/setnullpolicy.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - SolrCollapseFunction::setNullPolicy - Define la política NULL - - - - &reftitle.description; - - public SolrCollapseFunctionSolrCollapseFunction::setNullPolicy - stringnullPolicy - - - Define la política NULL. Una de las 3 políticas definidas como constantes de clase debe ser pasada. - Acepta las políticas ignore, expand o collapse. - - - - - - &reftitle.parameters; - - - nullPolicy - - - - - - - - - - - &reftitle.returnvalues; - - SolrCollapseFunction - - - - - - diff --git a/reference/solr/solrcollapsefunction/setsize.xml b/reference/solr/solrcollapsefunction/setsize.xml deleted file mode 100644 index 8df3848839..0000000000 --- a/reference/solr/solrcollapsefunction/setsize.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - SolrCollapseFunction::setSize - Define la tamaño inicial de las estructuras de datos de reducción al reducir sobre un campo numérico únicamente - - - - &reftitle.description; - - public SolrCollapseFunctionSolrCollapseFunction::setSize - intsize - - - Define la tamaño inicial de las estructuras de datos de reducción al reducir sobre un campo numérico únicamente. - - - - - - &reftitle.parameters; - - - size - - - - - - - - - - - &reftitle.returnvalues; - - SolrCollapseFunction - - - - - - diff --git a/reference/solr/solrcollapsefunction/tostring.xml b/reference/solr/solrcollapsefunction/tostring.xml deleted file mode 100644 index 6493d0f409..0000000000 --- a/reference/solr/solrcollapsefunction/tostring.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrCollapseFunction::__toString - Devuelve un string que representa la función de reducción construida - - - - &reftitle.description; - - public stringSolrCollapseFunction::__toString - - - - Devuelve un string que representa la función de reducción construida - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/solr/solrdismaxquery.xml b/reference/solr/solrdismaxquery.xml deleted file mode 100644 index 8bdf859cbc..0000000000 --- a/reference/solr/solrdismaxquery.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - - La clase SolrDisMaxQuery - SolrDisMaxQuery - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrDisMaxQuery - - - - - SolrDisMaxQuery - - - - extends - SolrQuery - - - - Serializable - - - - - &InheritedProperties; - - - - &Methods; - - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.constants; - - - - SolrDisMaxQuery::ORDER_ASC - - Empleada para especificar que la ordenación debería ser ascendente (Duplicada para una migración sencilla) - - - - - SolrDisMaxQuery::ORDER_DESC - - Empleada para especificar que la ordenación debería ser descendente (Duplicada para una migración sencilla) - - - - - SolrDisMaxQuery::FACET_SORT_INDEX - - Empleada para especificar que la faceta debería ordenarse por índice (Duplicada para una migración sencilla) - - - - - SolrDisMaxQuery::FACET_SORT_COUNT - - Empleada para especificar que la faceta debería ordenarse por cuenta (Duplicada para una migración sencilla) - - - - - SolrDisMaxQuery::TERMS_SORT_INDEX - - Empleada en TermsComponent (Duplicada para una migración sencilla) - - - - - SolrDisMaxQuery::TERMS_SORT_COUNT - - Empleada en TermsComponent (Duplicada para una migración sencilla) - - - - -
    - - - -
    - - &reference.solr.entities.solrdismaxquery; - -
    - - diff --git a/reference/solr/solrdismaxquery/addbigramphrasefield.xml b/reference/solr/solrdismaxquery/addbigramphrasefield.xml deleted file mode 100644 index 2de0d12ec9..0000000000 --- a/reference/solr/solrdismaxquery/addbigramphrasefield.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - SolrDisMaxQuery::addBigramPhraseField - Añade un campo de bigrama de frase (argumento pf2) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::addBigramPhraseField - stringfield - stringboost - stringslop - - - Añade un campo de bigrama de frase (argumento pf2) - Formato de salida: campo~slop^boost OU campo^boost - Slop es opcional - - - - - - &reftitle.parameters; - - - field - - - - - - - - boost - - - - - - - - slop - - - - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Ejemplo de <function>SolrDisMaxQuery::addBigramPhraseField</function> - -addBigramPhraseField('cat', 2, 5.1) - ->addBigramPhraseField('feature', 4.5) -; -echo $dismaxQuery; - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::removeBigramPhraseField - SolrDisMaxQuery::setBigramPhraseFields - SolrDisMaxQuery::setBigramPhraseSlop - - - - - - diff --git a/reference/solr/solrdismaxquery/addboostquery.xml b/reference/solr/solrdismaxquery/addboostquery.xml deleted file mode 100644 index b35c8acf85..0000000000 --- a/reference/solr/solrdismaxquery/addboostquery.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - SolrDisMaxQuery::addBoostQuery - Añade un campo de consulta de boost con valor y boost opcionales (argumento bq) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::addBoostQuery - stringfield - stringvalue - stringboost - - - Añade un campo de consulta de boost con valor [y boost] (argumento bq) - - - - - - &reftitle.parameters; - - - field - - - - - - - - value - - - - - - - - boost - - - - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Ejemplo de <function>SolrDisMaxQuery::addBoostQuery</function> - -addBoostQuery('cat', 'clothing', 2) - ->addBoostQuery('cat', 'electronics', 5.1) -; -echo $dismaxQuery.PHP_EOL; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::removeBoostQuery - SolrDisMaxQuery::setBoostQuery - - - - - - diff --git a/reference/solr/solrdismaxquery/addphrasefield.xml b/reference/solr/solrdismaxquery/addphrasefield.xml deleted file mode 100644 index 0854928c5a..0000000000 --- a/reference/solr/solrdismaxquery/addphrasefield.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - SolrDisMaxQuery::addPhraseField - Añade una frase de campo (argumento pf) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::addPhraseField - stringfield - stringboost - stringslop - - - Añade una frase de campo (argumento pf) - - - - - - &reftitle.parameters; - - - field - - - El nombre del campo - - - - - boost - - - - - - - - slop - - - - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Ejemplo de <function>SolrDisMaxQuery::addPhraseField</function> - -addPhraseField('cat', 3, 1) - ->addPhraseField('third', 4, 2) - ->addPhraseField('source', 55) -; -echo $dismaxQuery; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::removePhraseField - SolrDisMaxQuery::setPhraseFields - - - - - - diff --git a/reference/solr/solrdismaxquery/addqueryfield.xml b/reference/solr/solrdismaxquery/addqueryfield.xml deleted file mode 100644 index c4d2b68d43..0000000000 --- a/reference/solr/solrdismaxquery/addqueryfield.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - SolrDisMaxQuery::addQueryField - Añade un campo de consulta con boost opcional (argumento qf) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::addQueryField - stringfield - stringboost - - - Añade un campo de consulta con boost opcional (argumento qf) - - - - - - &reftitle.parameters; - - - field - - - El nombre del campo - - - - - boost - - - El boost opcional. Aumenta la relevancia de los documentos con términos coincidentes. - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Ejemplo de <function>SolrDisMaxQuery::addQueryField</function> - -addQueryField("location", 4) - ->addQueryField("price") - ->addQueryField("sku") - ->addQueryField("title",3.4) -; -echo $dismaxQuery; - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::removeQueryField - - - - - - diff --git a/reference/solr/solrdismaxquery/addtrigramphrasefield.xml b/reference/solr/solrdismaxquery/addtrigramphrasefield.xml deleted file mode 100644 index 4cb24b67ac..0000000000 --- a/reference/solr/solrdismaxquery/addtrigramphrasefield.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - SolrDisMaxQuery::addTrigramPhraseField - Añade un campo de trigramas de frase (argumento pf3) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::addTrigramPhraseField - stringfield - stringboost - stringslop - - - Añade un campo de trigramas de frase (argumento pf3) - - - - - - &reftitle.parameters; - - - field - - - El nombre del campo - - - - - boost - - - El boost del campo - - - - - slop - - - La tolerancia del campo - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Ejemplo de <function>SolrDisMaxQuery::addTrigramPhraseField</function> - -addTrigramPhraseField('cat', 2, 5.1) -->addTrigramPhraseField('feature', 4.5) -; -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::removeTrigramPhraseField - SolrDisMaxQuery::setTrigramPhraseFields - SolrDisMaxQuery::setTrigramPhraseSlop - - - - - - diff --git a/reference/solr/solrdismaxquery/adduserfield.xml b/reference/solr/solrdismaxquery/adduserfield.xml deleted file mode 100644 index 8321fda005..0000000000 --- a/reference/solr/solrdismaxquery/adduserfield.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - SolrDisMaxQuery::addUserField - Añade un campo al parámetro de campo usuario (uf) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::addUserField - stringfield - - - Añade un campo al parámetro de campo usuario (uf) - - - - - - &reftitle.parameters; - - - field - - - El nombre del campo - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Ejemplo de <function>SolrDisMaxQuery::addUserField</function> - -addUserField('cat') -->addUserField('text') -->addUserField('*_dt'); - -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::removeUserField - SolrDisMaxQuery::setUserFields - - - - - - diff --git a/reference/solr/solrdismaxquery/construct.xml b/reference/solr/solrdismaxquery/construct.xml deleted file mode 100644 index 022a7079f7..0000000000 --- a/reference/solr/solrdismaxquery/construct.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - SolrDisMaxQuery::__construct - Constructor de clase - - - - &reftitle.description; - - public SolrDisMaxQuery::__construct - stringq - - - Constructor de clase que inicializa el objeto y define el parámetro q si se proporciona - - - - - &reftitle.parameters; - - - q - - - El parámetro de búsqueda (parámetro q) - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.errors; - - Genera una excepción SolrIllegalArgumentException si se ha pasado un parámetro inválido. - - - - - &reftitle.examples; - - Ejemplo de <function>SolrDisMaxQuery::__construct</function> - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/solr/solrdismaxquery/removebigramphrasefield.xml b/reference/solr/solrdismaxquery/removebigramphrasefield.xml deleted file mode 100644 index ffba623d75..0000000000 --- a/reference/solr/solrdismaxquery/removebigramphrasefield.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - SolrDisMaxQuery::removeBigramPhraseField - Elimina un campo de bigrama de frase (argumento pf2) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::removeBigramPhraseField - stringfield - - - Elimina un campo de bigrama de frase (argumento pf2) que fue previamente añadido utilizando SolrDisMaxQuery::addBigramPhraseField - - - - - - &reftitle.parameters; - - - field - - - El nombre del campo - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Ejemplo de <function>SolrDisMaxQuery::removeBigramPhraseField</function> - -addBigramPhraseField('cat', 2, 5.1) - ->addBigramPhraseField('feature', 4.5) -; -echo $dismaxQuery.PHP_EOL; - -// elimina el campo cat de pf2 -$dismaxQuery - ->removeBigramPhraseField('cat'); -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::addBigramPhraseField - SolrDisMaxQuery::setBigramPhraseFields - SolrDisMaxQuery::setBigramPhraseSlop - - - - - - diff --git a/reference/solr/solrdismaxquery/removeboostquery.xml b/reference/solr/solrdismaxquery/removeboostquery.xml deleted file mode 100644 index b1cc1cca6d..0000000000 --- a/reference/solr/solrdismaxquery/removeboostquery.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - SolrDisMaxQuery::removeBoostQuery - Elimina una parte de consulta de boost por nombre de campo (bq) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::removeBoostQuery - stringfield - - - Elimina una parte de consulta de boost por nombre de campo, solo si SolrDisMaxQuery::addBoostQuery ha sido utilizado. - - - - &reftitle.parameters; - - - field - - - El nombre del campo - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Ejemplo de <function>SolrDisMaxQuery::removeBoostQuery</function> - -addBoostQuery('cat', 'electronics', 5.1) - ->addBoostQuery('cat', 'hard drive') -; -echo $dismaxQuery.PHP_EOL; -// elimina la parte de consulta de boost con el campo 'cat' -$dismaxQuery -->removeBoostQuery('cat'); -echo $dismaxQuery . PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::addBoostQuery - SolrDisMaxQuery::setBoostQuery - - - - - - diff --git a/reference/solr/solrdismaxquery/removephrasefield.xml b/reference/solr/solrdismaxquery/removephrasefield.xml deleted file mode 100644 index 1d13181a49..0000000000 --- a/reference/solr/solrdismaxquery/removephrasefield.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - SolrDisMaxQuery::removePhraseField - Elimina un campo de frase (argumento pf) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::removePhraseField - stringfield - - - Elimina un campo de frase (argumento pf) que fue añadido previamente utilizando SolrDisMaxQuery::addPhraseField - - - - - - &reftitle.parameters; - - - field - - - El nombre del campo - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Ejemplo de <function>SolrDisMaxQuery::removePhraseField</function> - -addPhraseField('first', 3, 1) - ->addPhraseField('second', 4, 1) - ->addPhraseField('cat', 55); -echo $dismaxQuery . PHP_EOL; -echo $dismaxQuery->removePhraseField('second'); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::addPhraseField - SolrDisMaxQuery::setPhraseFields - - - - - - diff --git a/reference/solr/solrdismaxquery/removequeryfield.xml b/reference/solr/solrdismaxquery/removequeryfield.xml deleted file mode 100644 index 852f67932f..0000000000 --- a/reference/solr/solrdismaxquery/removequeryfield.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - SolrDisMaxQuery::removeQueryField - Elimina un campo de consulta (argumento qf) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::removeQueryField - stringfield - - - Elimina un campo de consulta (argumento qf) añadido por SolrDisMaxQuery::addQueryField - - - qf: Durante la construcción de DisjunctionMaxQueries a partir de la consulta del usuario, especifica los campos a buscar y los boosts para estos campos. - - - - - - &reftitle.parameters; - - - field - - - El nombre del campo - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Ejemplo de <function>SolrDisMaxQuery::removeQueryField</function> - -addQueryField('first', 3) - ->addQueryField('second', 0.2) - ->addQueryField('cat'); -echo $dismaxQuery . PHP_EOL; -// elimina el campo 'second' -echo $dismaxQuery->removeQueryField('second'); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::addQueryField - - - - - - diff --git a/reference/solr/solrdismaxquery/removetrigramphrasefield.xml b/reference/solr/solrdismaxquery/removetrigramphrasefield.xml deleted file mode 100644 index 2889f6bdc8..0000000000 --- a/reference/solr/solrdismaxquery/removetrigramphrasefield.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - SolrDisMaxQuery::removeTrigramPhraseField - Elimina un campo de frase de trigramas (argumento pf3) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::removeTrigramPhraseField - stringfield - - - Elimina un campo de frase de trigramas (argumento pf3) - - - - - - &reftitle.parameters; - - - field - - - El nombre del campo - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Ejemplo de <function>SolrDisMaxQuery::removeTrigramPhraseField</function> - -addTrigramPhraseField('cat', 2, 5.1) -->addTrigramPhraseField('feature', 4.5) -; -echo $dismaxQuery.PHP_EOL; -// inverso -$dismaxQuery -->removeTrigramPhraseField('cat'); -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::addTrigramPhraseField - SolrDisMaxQuery::setTrigramPhraseFields - SolrDisMaxQuery::setTrigramPhraseSlop - - - - - - diff --git a/reference/solr/solrdismaxquery/removeuserfield.xml b/reference/solr/solrdismaxquery/removeuserfield.xml deleted file mode 100644 index a1d69afabb..0000000000 --- a/reference/solr/solrdismaxquery/removeuserfield.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - SolrDisMaxQuery::removeUserField - Elimina un campo del parámetro de campo de usuario (uf) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::removeUserField - stringfield - - - Elimina un campo del parámetro de campo de usuario (uf) - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - field - - - El nombre del campo - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Ejemplo de <function>SolrDisMaxQuery::removeUserField</function> - -addUserField('cat') -->addUserField('text') -->addUserField('*_dt') -; -echo $dismaxQuery.PHP_EOL; - -// elimina el campo llamado 'text' -$dismaxQuery -->removeUserField('text'); -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::addUserField - SolrDisMaxQuery::setUserFields - - - - - - diff --git a/reference/solr/solrdismaxquery/setbigramphrasefields.xml b/reference/solr/solrdismaxquery/setbigramphrasefields.xml deleted file mode 100644 index 1123b140fd..0000000000 --- a/reference/solr/solrdismaxquery/setbigramphrasefields.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - SolrDisMaxQuery::setBigramPhraseFields - Define los campos de frase bigrama y sus boosts (y márgenes) utilizando el argumento pf2 - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setBigramPhraseFields - stringfields - - - Define los campos de frase bigrama (pf2) y sus boosts (y márgenes) - - - - - &reftitle.parameters; - - - fields - - - Los boosts de campos (los márgenes) - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Ejemplo de <function>SolrDisMaxQuery::setBigramPhraseFields</function> - -setBigramPhraseFields("cat~5.1^2 feature^4.5"); -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::setBigramPhraseSlop - SolrDisMaxQuery::addBigramPhraseFields - SolrDisMaxQuery::removeBigramPhraseField - SolrDisMaxQuery::setTrigramPhraseFields - - - - - - diff --git a/reference/solr/solrdismaxquery/setbigramphraseslop.xml b/reference/solr/solrdismaxquery/setbigramphraseslop.xml deleted file mode 100644 index 55f9cd02eb..0000000000 --- a/reference/solr/solrdismaxquery/setbigramphraseslop.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - SolrDisMaxQuery::setBigramPhraseSlop - Define el margen de Bigram Phrase (parámetro ps2) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setBigramPhraseSlop - stringslop - - - Define el margen de Bigram Phrase (parámetro ps2). Un margen por omisión para los campos de frase Bigram. - - - - - - &reftitle.parameters; - - - slop - - - - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Ejemplo de <function>SolrDisMaxQuery::setBigramPhraseSlop</function> - -setBigramPhraseSlop(5); -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/solr/solrdismaxquery/setboostfunction.xml b/reference/solr/solrdismaxquery/setboostfunction.xml deleted file mode 100644 index e117a7232b..0000000000 --- a/reference/solr/solrdismaxquery/setboostfunction.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - SolrDisMaxQuery::setBoostFunction - Define una función de Boost (argumento bf) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setBoostFunction - stringfunction - - - Define una función de Boost (argumento bf). - - - Las funciones (con boosts opcionales) que serán incluidas en la - petición del usuario para influir en el score. Cualquier función soportada - nativamente por Solr puede ser utilizada, con un valor de boost. Por ejemplo: - - - recip(rord(myfield),1,2,3)^1.5 - - - - - &reftitle.parameters; - - - function - - - - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Ejemplo de <function>SolrDisMaxQuery::setBoostFunction</function> - -setBoostFunction($boostRecentDocsFunction); - -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/solr/solrdismaxquery/setboostquery.xml b/reference/solr/solrdismaxquery/setboostquery.xml deleted file mode 100644 index 8b7684e506..0000000000 --- a/reference/solr/solrdismaxquery/setboostquery.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - SolrDisMaxQuery::setBoostQuery - Define directamente el parámetro de consulta de boost (bq) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setBoostQuery - stringq - - - Define el parámetro de consulta de boost (bq) - - - - - - &reftitle.parameters; - - - q - - - consulta - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Ejemplo de <function>SolrDisMaxQuery::setBoostQuery</function> - -setBoostQuery('cat:electronics manu:local^2'); -echo $dismaxQuery.PHP_EOL; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::addBoostQuery - SolrDisMaxQuery::removeBoostQuery - - - - - - diff --git a/reference/solr/solrdismaxquery/setminimummatch.xml b/reference/solr/solrdismaxquery/setminimummatch.xml deleted file mode 100644 index 1489b9c099..0000000000 --- a/reference/solr/solrdismaxquery/setminimummatch.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - SolrDisMaxQuery::setMinimumMatch - Define el mínimo "Should" Match (mm) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setMinimumMatch - stringvalue - - - Define el parámetro de coincidencia mínima "Should" (mm). Si el operador de consulta por omisión es AND, entonces mm=100%, si el operador de consulta por omisión (q.op) es OR, entonces mm=0%. - - - - - &reftitle.parameters; - - - value - - - El valor/expresión de coincidencia mínima - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Ejemplo de <function>SolrDisMaxQuery::setMinimumMatch</function> - -setMinimumMatch("75%"); -echo $dismaxQuery . PHP_EOL; - -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/solr/solrdismaxquery/setphrasefields.xml b/reference/solr/solrdismaxquery/setphrasefields.xml deleted file mode 100644 index 0fafcb69a3..0000000000 --- a/reference/solr/solrdismaxquery/setphrasefields.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - SolrDisMaxQuery::setPhraseFields - Define los campos de frase y sus boosts (y slops) utilizando el parámetro pf2 - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setPhraseFields - stringfields - - - Define los campos de frase (pf) y sus boosts (y slops) - - - - - &reftitle.parameters; - - - fields - - - Los campos, los boosts [, slops] - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Ejemplo de <function>SolrDisMaxQuery::setPhraseFields</function> - -setPhraseFields("cat~5.1^2 feature^4.5"); -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::addPhraseFields - SolrDisMaxQuery::removePhraseField - - - - - - diff --git a/reference/solr/solrdismaxquery/setphraseslop.xml b/reference/solr/solrdismaxquery/setphraseslop.xml deleted file mode 100644 index 6be3100b0b..0000000000 --- a/reference/solr/solrdismaxquery/setphraseslop.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - SolrDisMaxQuery::setPhraseSlop - Define el margen por defecto en las consultas de frase (parámetro ps) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setPhraseSlop - stringslop - - - Define el margen por defecto en las consultas de frase construidas con los campos "pf", "pf2" y/o "pf3" (afecta al boosting). - parámetro "ps" - - - - - - &reftitle.parameters; - - - slop - - - - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Ejemplo de <function>SolrDisMaxQuery::setPhraseSlop</function> - -setPhraseSlop(4); -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/solr/solrdismaxquery/setqueryalt.xml b/reference/solr/solrdismaxquery/setqueryalt.xml deleted file mode 100644 index 2696a19472..0000000000 --- a/reference/solr/solrdismaxquery/setqueryalt.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - SolrDisMaxQuery::setQueryAlt - Define la consulta alternativa (parámetro q.alt) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setQueryAlt - stringq - - - Define la consulta alternativa (parámetro q.alt) - - - Cuando el parámetro q principal no está especificado o está vacío, el parámetro q.alt es utilizado - - - - - - &reftitle.parameters; - - - q - - - la cadena de consulta - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Ejemplo de <function>SolrDisMaxQuery::setQueryAlt</function> - -setQueryAlt('*:*'); - -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/solr/solrdismaxquery/setqueryphraseslop.xml b/reference/solr/solrdismaxquery/setqueryphraseslop.xml deleted file mode 100644 index 67763c9412..0000000000 --- a/reference/solr/solrdismaxquery/setqueryphraseslop.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - SolrDisMaxQuery::setQueryPhraseSlop - Especifica la cantidad de tolerancia permitida en las consultas de frase explícitamente incluidas en la cadena de consulta del usuario (parámetro qf) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setQueryPhraseSlop - stringslop - - - La cantidad de tolerancia en las consultas de frase explícitamente incluidas en la cadena de consulta del usuario con el parámetro qf. - - - La tolerancia se refiere al número de posiciones que debe moverse un token respecto a otro token para coincidir con una frase especificada en una consulta. - - - - - - &reftitle.parameters; - - - slop - - - La cantidad de tolerancia - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Ejemplo de <function>SolrDisMaxQuery::setQueryPhraseSlop</function> - -setQueryPhraseSlop(3); -echo $dismaxQuery; -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/solr/solrdismaxquery/settiebreaker.xml b/reference/solr/solrdismaxquery/settiebreaker.xml deleted file mode 100644 index 52d51bce97..0000000000 --- a/reference/solr/solrdismaxquery/settiebreaker.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - SolrDisMaxQuery::setTieBreaker - Define el parámetro de Tie Breaker (parámetro tie) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setTieBreaker - stringtieBreaker - - - Define el parámetro de Tie Breaker (parámetro tie) - - - - - &reftitle.parameters; - - - tieBreaker - - - El parámetro tie especifica un valor float (que debería ser algo mucho menor que 1) para ser utilizado como criterio de desempate en las consultas DisMax. - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Ejemplo de <function>SolrDisMaxQuery::setTieBreaker</function> - -setTieBreaker(0.1); - -echo $dismaxQuery; - -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/solr/solrdismaxquery/settrigramphrasefields.xml b/reference/solr/solrdismaxquery/settrigramphrasefields.xml deleted file mode 100644 index 8bbd6d3276..0000000000 --- a/reference/solr/solrdismaxquery/settrigramphrasefields.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - SolrDisMaxQuery::setTrigramPhraseFields - Define directamente los campos de trigramas de frase (argumento pf3) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setTrigramPhraseFields - stringfields - - - Define directamente los campos de trigramas de frase (argumento pf3) - - - - - - &reftitle.parameters; - - - fields - - - Los campos de trigramas de frase - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Ejemplo de <function>SolrDisMaxQuery::setTrigramPhraseFields</function> - -setTrigramPhraseFields('cat~5.1^2 feature^4.5'); -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::addTrigramPhraseField - SolrDisMaxQuery::removeTrigramPhraseField - SolrDisMaxQuery::setTrigramPhraseSlop - - - - - - diff --git a/reference/solr/solrdismaxquery/settrigramphraseslop.xml b/reference/solr/solrdismaxquery/settrigramphraseslop.xml deleted file mode 100644 index 6207e2bae5..0000000000 --- a/reference/solr/solrdismaxquery/settrigramphraseslop.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - SolrDisMaxQuery::setTrigramPhraseSlop - Define el margen de trigramas de frase (parámetro ps3) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setTrigramPhraseSlop - stringslop - - - Define el margen de trigramas de frase (parámetro ps3) - - - - - - &reftitle.parameters; - - - slop - - - El margen de frase - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Ejemplo de <function>SolrDisMaxQuery::setTrigramPhraseSlop</function> - -setTrigramPhraseSlop(2); -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::addTrigramPhraseField - SolrDisMaxQuery::removeTrigramPhraseField - SolrDisMaxQuery::setTrigramPhraseFields - - - - - - diff --git a/reference/solr/solrdismaxquery/setuserfields.xml b/reference/solr/solrdismaxquery/setuserfields.xml deleted file mode 100644 index b5ff3fcaec..0000000000 --- a/reference/solr/solrdismaxquery/setuserfields.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - SolrDisMaxQuery::setUserFields - Define el parámetro de campos de usuario (uf) - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::setUserFields - stringfields - - - Define el parámetro de campos de usuario (uf) - - - Campos de usuario: Especifica los campos de esquema que el usuario final está autorizado a consultar. - - - - - &reftitle.parameters; - - - fields - - - Los nombres de los campos separados por un espacio - - - Este parámetro admite caracteres comodín. - - - - - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Ejemplo de <function>SolrDisMaxQuery::setUserFields</function> - -setUserFields('field1 field2 *_txt'); -echo $dismaxQuery.PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::addUserField - SolrDisMaxQuery::removeUserField - - - - - - diff --git a/reference/solr/solrdismaxquery/usedismaxqueryparser.xml b/reference/solr/solrdismaxquery/usedismaxqueryparser.xml deleted file mode 100644 index 17c26a6a65..0000000000 --- a/reference/solr/solrdismaxquery/usedismaxqueryparser.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - SolrDisMaxQuery::useDisMaxQueryParser - Cambia el QueryParser para que sea el DisMax Query Parser - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::useDisMaxQueryParser - - - - Cambia el QueryParser para que sea el DisMax Query Parser - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Ejemplo de <function>SolrDisMaxQuery::useDisMaxQueryParser</function> - -useDisMaxQueryParser(); -echo $dismaxQuery; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SolrDisMaxQuery::useDisMaxQueryParser - - - - - - diff --git a/reference/solr/solrdismaxquery/useedismaxqueryparser.xml b/reference/solr/solrdismaxquery/useedismaxqueryparser.xml deleted file mode 100644 index b32b7a6e34..0000000000 --- a/reference/solr/solrdismaxquery/useedismaxqueryparser.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - SolrDisMaxQuery::useEDisMaxQueryParser - Cambia el QueryParser para que sea el EDisMax Query Parser - - - - &reftitle.description; - - public SolrDisMaxQuerySolrDisMaxQuery::useEDisMaxQueryParser - - - - Cambia el QueryParser para que sea el EDisMax Query Parser. Por omisión, el constructor de consultas utiliza edismax. Si ha sido cambiado utilizando SolrDisMaxQuery::useDisMaxQueryParser, puede ser revertido utilizando este método. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - SolrDisMaxQuery - - - - - &reftitle.examples; - - Ejemplo de <function>SolrDisMaxQuery::useEDisMaxQueryParser</function> - -useEDisMaxQueryParser(); -echo $dismaxQuery; - -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/solr/solrdocument.xml b/reference/solr/solrdocument.xml deleted file mode 100644 index 7f5afb5447..0000000000 --- a/reference/solr/solrdocument.xml +++ /dev/null @@ -1,174 +0,0 @@ - - - - - - - - La clase SolrDocument - SolrDocument - - - - -
    - &reftitle.intro; - - Representa un documento Solr recuperado de una respuesta a una consulta. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrDocument - - - - - final - SolrDocument - - - - ArrayAccess - - - - Iterator - - - - Serializable - - - - &Constants; - - const - int - SolrDocument::SORT_DEFAULT - 1 - - - const - int - SolrDocument::SORT_ASC - 1 - - - const - int - SolrDocument::SORT_DESC - 2 - - - const - int - SolrDocument::SORT_FIELD_NAME - 1 - - - const - int - SolrDocument::SORT_FIELD_VALUE_COUNT - 2 - - - const - int - SolrDocument::SORT_FIELD_BOOST_VALUE - 4 - - - &Methods; - - - - - - -
    - - - -
    - &reftitle.constants; - - - - SolrDocument::SORT_DEFAULT - - Modo predeterminado para ordenar los campos dentro de un documento. - - - - - SolrDocument::SORT_ASC - - Ordena los campos de forma ascendente - - - - - SolrDocument::SORT_DESC - - Ordena los campos de forma descendente - - - - - SolrDocument::SORT_FIELD_NAME - - Ordena los campos por nombre de campo. - - - - - SolrDocument::SORT_FIELD_VALUE_COUNT - - Ordena los campos según el número de valores de cada campo. - - - - - SolrDocument::SORT_FIELD_BOOST_VALUE - - Ordena los campos según sus valores boost. - - - - -
    - - - -
    - - &reference.solr.entities.solrdocument; - -
    - - diff --git a/reference/solr/solrdocument/addfield.xml b/reference/solr/solrdocument/addfield.xml deleted file mode 100644 index 24feb2b47e..0000000000 --- a/reference/solr/solrdocument/addfield.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - SolrDocument::addField - añade un campo al documento - - - - &reftitle.description; - - public boolSolrDocument::addField - stringfieldName - stringfieldValue - - - Este método añade un campo a la instancia de SolrDocument. - - - - - - &reftitle.parameters; - - - - fieldName - - - El nombre del campo - - - - - fieldValue - - - El valor del campo. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrdocument/clear.xml b/reference/solr/solrdocument/clear.xml deleted file mode 100644 index fb1410f1d8..0000000000 --- a/reference/solr/solrdocument/clear.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrDocument::clear - Borra todos los campos del documento - - - - &reftitle.description; - - public boolSolrDocument::clear - - - - Reinicia el objeto actual. Deshecha todos los campos y reinicia el boost del documento a cero. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrdocument/clone.xml b/reference/solr/solrdocument/clone.xml deleted file mode 100644 index caa310db4f..0000000000 --- a/reference/solr/solrdocument/clone.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrDocument::__clone - Crea una copia de un objeto SolrDocument - - - - &reftitle.description; - - public voidSolrDocument::__clone - - - - Crea una copia de un objeto SolrDocument. No se debe llamar directamente. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Nada. - - - - - - diff --git a/reference/solr/solrdocument/construct.xml b/reference/solr/solrdocument/construct.xml deleted file mode 100644 index 5748dc294e..0000000000 --- a/reference/solr/solrdocument/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrDocument::__construct - Constructor - - - - &reftitle.description; - - public SolrDocument::__construct - - - - Constructor de SolrDocument - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/solr/solrdocument/current.xml b/reference/solr/solrdocument/current.xml deleted file mode 100644 index 7342494215..0000000000 --- a/reference/solr/solrdocument/current.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - SolrDocument::current - Recupera el campo actual - - - - &reftitle.description; - - public SolrDocumentFieldSolrDocument::current - - - - Recupera el campo actual - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el campo - - - - - - - diff --git a/reference/solr/solrdocument/deletefield.xml b/reference/solr/solrdocument/deletefield.xml deleted file mode 100644 index 7205b953ff..0000000000 --- a/reference/solr/solrdocument/deletefield.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - SolrDocument::deleteField - Elimina un campo del documento - - - - &reftitle.description; - - public boolSolrDocument::deleteField - stringfieldName - - - Elimina un campo del documento. - - - - - - - - &reftitle.parameters; - - - - fieldName - - - Nombre del campo - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrdocument/destruct.xml b/reference/solr/solrdocument/destruct.xml deleted file mode 100644 index 51719b4743..0000000000 --- a/reference/solr/solrdocument/destruct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrDocument::__destruct - Destructor - - - - &reftitle.description; - - public SolrDocument::__destruct - - - - Destructor de SolrDocument. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/solr/solrdocument/fieldexists.xml b/reference/solr/solrdocument/fieldexists.xml deleted file mode 100644 index 2d8a6c80b8..0000000000 --- a/reference/solr/solrdocument/fieldexists.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrDocument::fieldExists - Comprueba si existe un campo en el documento - - - - &reftitle.description; - - public boolSolrDocument::fieldExists - stringfieldName - - - Comprueba si el campo solicitado es un nombre de campo válido del documento. - - - - - - &reftitle.parameters; - - - - fieldName - - - El nombre del campo. - - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si el campo está presente y &false; si no lo está. - - - - - - diff --git a/reference/solr/solrdocument/get.xml b/reference/solr/solrdocument/get.xml deleted file mode 100644 index 78f96a5e8b..0000000000 --- a/reference/solr/solrdocument/get.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - SolrDocument::__get - Acceder al campo como una propiedad - - - - &reftitle.description; - - public SolrDocumentFieldSolrDocument::__get - stringfieldName - - - Método mágico para acceder al campo como si fuera una propiedad. - - - - - - - - &reftitle.parameters; - - - - fieldName - - - El nombre del campo. - - - - - - - - - &reftitle.returnvalues; - - Devuelve una instancia de SolrDocumentField. - - - - - - diff --git a/reference/solr/solrdocument/getchilddocuments.xml b/reference/solr/solrdocument/getchilddocuments.xml deleted file mode 100644 index d08b5ca4b4..0000000000 --- a/reference/solr/solrdocument/getchilddocuments.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - SolrDocument::getChildDocuments - Devuelve un array de documentos hijos (SolrDocument) - - - - &reftitle.description; - - public arraySolrDocument::getChildDocuments - - - - Devuelve un array de documentos hijos (SolrDocument) - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrDocument::hasChildDocuments - SolrDocument::getChildDocumentsCount - - - - - diff --git a/reference/solr/solrdocument/getchilddocumentscount.xml b/reference/solr/solrdocument/getchilddocumentscount.xml deleted file mode 100644 index 0e89ac154b..0000000000 --- a/reference/solr/solrdocument/getchilddocumentscount.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrDocument::getChildDocumentsCount - Devuelve el número de documentos hijos - - - - &reftitle.description; - - public intSolrDocument::getChildDocumentsCount - - - - Devuelve el número de documentos hijos - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrDocument::hasChildDocuments - SolrDocument::getChildDocuments - - - - - - diff --git a/reference/solr/solrdocument/getfield.xml b/reference/solr/solrdocument/getfield.xml deleted file mode 100644 index 9a68f694db..0000000000 --- a/reference/solr/solrdocument/getfield.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrDocument::getField - Recupera un campo según su nombre - - - - &reftitle.description; - - public SolrDocumentFieldSolrDocument::getField - stringfieldName - - - Recupera un campo según su nombre. - - - - - - &reftitle.parameters; - - - - fieldName - - - Nombre del campo. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto SolrDocumentField en caso de éxito y &false; en caso de fallo. - - - - - - diff --git a/reference/solr/solrdocument/getfieldcount.xml b/reference/solr/solrdocument/getfieldcount.xml deleted file mode 100644 index 693da401e1..0000000000 --- a/reference/solr/solrdocument/getfieldcount.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - SolrDocument::getFieldCount - Devuelve el número de campos de este documento - - - - &reftitle.description; - - public intSolrDocument::getFieldCount - - - - Devuelve el número de campos de este documento. Los campo multi valor sólo se cuentan una vez. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un entero en caso de éxito y &false; en caso de fallo. - - - - - - diff --git a/reference/solr/solrdocument/getfieldnames.xml b/reference/solr/solrdocument/getfieldnames.xml deleted file mode 100644 index 11dc4c583a..0000000000 --- a/reference/solr/solrdocument/getfieldnames.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrDocument::getFieldNames - Devuelve una matriz con los nombres de campos del documento - - - - &reftitle.description; - - public arraySolrDocument::getFieldNames - - - - Devuelve una matriz con los nombres de campos del documento. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una matriz que contiene los nombres de los campos de este documento. - - - - - - diff --git a/reference/solr/solrdocument/getinputdocument.xml b/reference/solr/solrdocument/getinputdocument.xml deleted file mode 100644 index 0609317e8b..0000000000 --- a/reference/solr/solrdocument/getinputdocument.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrDocument::getInputDocument - Devuelve un SolrInputDocument equivalente al objeto - - - - &reftitle.description; - - public SolrInputDocumentSolrDocument::getInputDocument - - - - Devuelve un SolrInputDocument equivalente al objeto. Esto es útil si se desea reenviar/actualizar un documento recuperado desde una consulta. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un objeto SolrInputDocument en caso de éxito y &null; en caso de fallo. - - - - - - diff --git a/reference/solr/solrdocument/haschilddocuments.xml b/reference/solr/solrdocument/haschilddocuments.xml deleted file mode 100644 index 3ccbcbcfa0..0000000000 --- a/reference/solr/solrdocument/haschilddocuments.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrDocument::hasChildDocuments - Verifica si el documento tiene documentos hijos - - - - &reftitle.description; - - public boolSolrDocument::hasChildDocuments - - - - Indica si el documento tiene documentos hijos - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrDocument::getChildDocuments - SolrDocument::getChildDocumentsCount - - - - - - diff --git a/reference/solr/solrdocument/isset.xml b/reference/solr/solrdocument/isset.xml deleted file mode 100644 index 28f7b0ded0..0000000000 --- a/reference/solr/solrdocument/isset.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - SolrDocument::__isset - Comprueba si existe un campo - - - - &reftitle.description; - - public boolSolrDocument::__isset - stringfieldName - - - Comprueba si existe un campo - - - - - - - - &reftitle.parameters; - - - - fieldName - - - Nombre del campo. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrdocument/key.xml b/reference/solr/solrdocument/key.xml deleted file mode 100644 index e7d912e8c0..0000000000 --- a/reference/solr/solrdocument/key.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrDocument::key - Recupera la clave actual - - - - &reftitle.description; - - public stringSolrDocument::key - - - - Recupera la clave actual. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la clave actual. - - - - - - diff --git a/reference/solr/solrdocument/merge.xml b/reference/solr/solrdocument/merge.xml deleted file mode 100644 index 9be7ee8d7a..0000000000 --- a/reference/solr/solrdocument/merge.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - SolrDocument::merge - Fusiona la fuente con el objeto SolrDocument actual - - - - &reftitle.description; - - public boolSolrDocument::merge - SolrDocumentsourceDoc - booloverwrite&true; - - - Fusiona la fuente con el objeto SolrDocument actual. - - - - - - &reftitle.parameters; - - - - sourceDoc - - - El documento fuente. - - - - - overwrite - - - Si esto es &true; los campos con el mismo nombre que los del documento destino serán sobrescritos. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrdocument/next.xml b/reference/solr/solrdocument/next.xml deleted file mode 100644 index ddbe33ef54..0000000000 --- a/reference/solr/solrdocument/next.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - SolrDocument::next - Mueve el puntero interno al siguiente campo - - - - &reftitle.description; - - public voidSolrDocument::next - - - - Mueve el puntero interno al siguiente campo. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Este método no devuelve ningún valor. - - - - - - diff --git a/reference/solr/solrdocument/offsetexists.xml b/reference/solr/solrdocument/offsetexists.xml deleted file mode 100644 index 628e09e271..0000000000 --- a/reference/solr/solrdocument/offsetexists.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrDocument::offsetExists - Comprueba si existe un campo en particular - - - - &reftitle.description; - - public boolSolrDocument::offsetExists - stringfieldName - - - Comprueba si existe un campo en particular. Se usa cuando un objeto es tratado como una matriz. - - - - - - &reftitle.parameters; - - - - fieldName - - - El nombre del campo. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrdocument/offsetget.xml b/reference/solr/solrdocument/offsetget.xml deleted file mode 100644 index 5ca521146d..0000000000 --- a/reference/solr/solrdocument/offsetget.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - SolrDocument::offsetGet - Recupera un campo - - - - &reftitle.description; - - public SolrDocumentFieldSolrDocument::offsetGet - stringfieldName - - - Se usa para recuperar un campo cuando el objeto es tratado como una matriz. - - - - - - - - &reftitle.parameters; - - - - fieldName - - - El nombre del campo. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto SolrDocumentField. - - - - - - diff --git a/reference/solr/solrdocument/offsetset.xml b/reference/solr/solrdocument/offsetset.xml deleted file mode 100644 index 527eb442b2..0000000000 --- a/reference/solr/solrdocument/offsetset.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - SolrDocument::offsetSet - Añade un campo al documento - - - - &reftitle.description; - - public voidSolrDocument::offsetSet - stringfieldName - stringfieldValue - - - Se usa cuando el objeto es tratado como una matriz para añadir un campo al documento. - - - - - - &reftitle.parameters; - - - - fieldName - - - El nombre del campo. - - - - - fieldValue - - - El valor del campo. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrdocument/offsetunset.xml b/reference/solr/solrdocument/offsetunset.xml deleted file mode 100644 index 2b48204afe..0000000000 --- a/reference/solr/solrdocument/offsetunset.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - SolrDocument::offsetUnset - Elimina un campo - - - - &reftitle.description; - - public voidSolrDocument::offsetUnset - stringfieldName - - - Elimina un campo del documento. - - - - - - - - &reftitle.parameters; - - - - fieldName - - - El nombre del campo. - - - - - - - - - &reftitle.returnvalues; - - No se devuelve ningún valor. - - - - - - diff --git a/reference/solr/solrdocument/reset.xml b/reference/solr/solrdocument/reset.xml deleted file mode 100644 index fd2d59ec30..0000000000 --- a/reference/solr/solrdocument/reset.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - SolrDocument::reset - &Alias; SolrDocument::clear - - - - &reftitle.description; - - public boolSolrDocument::reset - - - - Este es un alias de SolrDocument::clear() - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrdocument/rewind.xml b/reference/solr/solrdocument/rewind.xml deleted file mode 100644 index d8d6ad6616..0000000000 --- a/reference/solr/solrdocument/rewind.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - SolrDocument::rewind - Reinicia el puntero interno al principio - - - - &reftitle.description; - - public voidSolrDocument::rewind - - - - Reinicia el puntero interno al principio. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Este método no devuelve ningún valor. - - - - - - diff --git a/reference/solr/solrdocument/serialize.xml b/reference/solr/solrdocument/serialize.xml deleted file mode 100644 index b2a1cdf8a4..0000000000 --- a/reference/solr/solrdocument/serialize.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - SolrDocument::serialize - Usado para serialización personalizada - - - - &reftitle.description; - - public stringSolrDocument::serialize - - - - Usado para serialización personalizada. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una cadena que representa el documento Solr serializado. - - - - - - diff --git a/reference/solr/solrdocument/set.xml b/reference/solr/solrdocument/set.xml deleted file mode 100644 index a5e2febcb0..0000000000 --- a/reference/solr/solrdocument/set.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - SolrDocument::__set - Añade otro campo al documento - - - - &reftitle.description; - - public boolSolrDocument::__set - stringfieldName - stringfieldValue - - - Añade otro campo al documento. Se usa para establecer el campo como propiedades nuevas. - - - - - - &reftitle.parameters; - - - - fieldName - - - Nombre del campo. - - - - - fieldValue - - - Valor del campo. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrdocument/sort.xml b/reference/solr/solrdocument/sort.xml deleted file mode 100644 index a8d9cd1fdd..0000000000 --- a/reference/solr/solrdocument/sort.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - SolrDocument::sort - Ordena los campos del documento - - - - &reftitle.description; - - public boolSolrDocument::sort - intsortOrderBy - intsortDirectionSolrDocument::SORT_ASC - - - - - - - - &reftitle.parameters; - - - - sortOrderBy - - - El criterio de ordenación. - - - - - sortDirection - - - La dirección de ordenación. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrdocument/toarray.xml b/reference/solr/solrdocument/toarray.xml deleted file mode 100644 index f8b899dc52..0000000000 --- a/reference/solr/solrdocument/toarray.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - - SolrDocument::toArray - Devuelve una matriz como representación de un documento - - - - &reftitle.description; - - public arraySolrDocument::toArray - - - - Devuelve una matriz como representación de un documento. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una matriz como representación de un documento. - - - - - &reftitle.examples; - - - Ejemplo de <methodname>SolrDocument::toArray</methodname> - -addField('id', 1123); - -$doc->features = "PHP Client Side"; -$doc->features = "Fast development cycles"; - -$doc['cat'] = 'Software'; -$doc['cat'] = 'Custom Search'; -$doc->cat = 'Information Technology'; - -print_r($doc->toArray()); - -?> -]]> - - &example.outputs.similar; - - 0 - [field_count] => 3 - [fields] => Array - ( - [0] => SolrDocumentField Object - ( - [name] => id - [boost] => 0 - [values] => Array - ( - [0] => 1123 - ) - - ) - - [1] => SolrDocumentField Object - ( - [name] => features - [boost] => 0 - [values] => Array - ( - [0] => PHP Client Side - [1] => Fast development cycles - ) - - ) - - [2] => SolrDocumentField Object - ( - [name] => cat - [boost] => 0 - [values] => Array - ( - [0] => Software - [1] => Custom Search - [2] => Information Technology - ) - - ) - - ) - -) -]]> - - - - - - - - diff --git a/reference/solr/solrdocument/unserialize.xml b/reference/solr/solrdocument/unserialize.xml deleted file mode 100644 index c17f8bf3c5..0000000000 --- a/reference/solr/solrdocument/unserialize.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - SolrDocument::unserialize - Serialización personalizada de objetos SolrDocument - - - - &reftitle.description; - - public voidSolrDocument::unserialize - stringserialized - - - Serialización personalizada de objetos SolrDocument - - - - - - - - &reftitle.parameters; - - - - serialized - - - Una representación XML del documento. - - - - - - - - - &reftitle.returnvalues; - - Nada. - - - - - - diff --git a/reference/solr/solrdocument/unset.xml b/reference/solr/solrdocument/unset.xml deleted file mode 100644 index 5e0c36c110..0000000000 --- a/reference/solr/solrdocument/unset.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - SolrDocument::__unset - Elimina un campo del documento - - - - &reftitle.description; - - public boolSolrDocument::__unset - stringfieldName - - - Elimina un campo del documento cuando al campo se accede como una propiedad del objeto. - - - - - - - - &reftitle.parameters; - - - - fieldName - - - El nombre del campo. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrdocument/valid.xml b/reference/solr/solrdocument/valid.xml deleted file mode 100644 index def9cbaf9d..0000000000 --- a/reference/solr/solrdocument/valid.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrDocument::valid - Comprueba si la posición actual del puntero interno es aún válida - - - - &reftitle.description; - - public boolSolrDocument::valid - - - - Comprueba si la posición actual del puntero interno es aún válida. Se usa durante operaciones foreach. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; en caso de éxito y &false; si la posición actual ya no es válida. - - - - - - diff --git a/reference/solr/solrdocumentfield.xml b/reference/solr/solrdocumentfield.xml deleted file mode 100644 index 2f076ed076..0000000000 --- a/reference/solr/solrdocumentfield.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - - - La clase SolrDocumentField - SolrDocumentField - - - - -
    - &reftitle.intro; - - Representa un campo de un documento Solr. Todas sus propiedades son de sólo lectura. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrDocumentField - - - - - final - SolrDocumentField - - - - &Properties; - - public - readonly - string - name - - - public - readonly - float - boost - - - public - readonly - array - values - - - - &Methods; - - - - - -
    - - - -
    - &reftitle.properties; - - - name - - El nombre del campo. - - - - boost - - El valor de boost del campo - - - - values - - Una matriz de valores para este campo - - - -
    - - - -
    - - &reference.solr.entities.solrdocumentfield; - -
    - - diff --git a/reference/solr/solrdocumentfield/construct.xml b/reference/solr/solrdocumentfield/construct.xml deleted file mode 100644 index bd8ccc639d..0000000000 --- a/reference/solr/solrdocumentfield/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrDocumentField::__construct - Constructor - - - - &reftitle.description; - - public SolrDocumentField::__construct - - - - Constructor. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Nada. - - - - - - diff --git a/reference/solr/solrdocumentfield/destruct.xml b/reference/solr/solrdocumentfield/destruct.xml deleted file mode 100644 index 47de6481c7..0000000000 --- a/reference/solr/solrdocumentfield/destruct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrDocumentField::__destruct - Destructor - - - - &reftitle.description; - - public SolrDocumentField::__destruct - - - - Destructor. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Nada. - - - - - - diff --git a/reference/solr/solrexception.xml b/reference/solr/solrexception.xml deleted file mode 100644 index aa4c5bb747..0000000000 --- a/reference/solr/solrexception.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - - La clase SolrException - SolrException - - - - -
    - &reftitle.intro; - - Esta es la clase base para todas las excepciones lanzadas por las clases de la extensión Solr. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrException - - - - - SolrException - - - - extends - Exception - - - - &Properties; - - protected - int - sourceline - - - protected - string - sourcefile - - - protected - string - zif_name - - - &InheritedProperties; - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - sourceline - - La línea del archivo del espacio c donde se generó la excepción - - - - sourcefile - - El archivo fuente del espacio c donde se generó la excepción - - - - zif_name - - La función espacio c donde se generó la excepción - - - -
    - - - -
    - - &reference.solr.entities.solrexception; - -
    - - diff --git a/reference/solr/solrexception/getinternalinfo.xml b/reference/solr/solrexception/getinternalinfo.xml deleted file mode 100644 index 5ab9193a3d..0000000000 --- a/reference/solr/solrexception/getinternalinfo.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrException::getInternalInfo - Devuelve información interna de donde se lanzó la excepción - - - - &reftitle.description; - - public arraySolrException::getInternalInfo - - - - Devuelve información interna de donde se lanzó la excepción. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una matriz que contiene información interna de donde el error fue lanzado. Usado únicamente para depurar por desarrolladores de extensiones. - - - - - - diff --git a/reference/solr/solrgenericresponse.xml b/reference/solr/solrgenericresponse.xml deleted file mode 100644 index 55e7207a7e..0000000000 --- a/reference/solr/solrgenericresponse.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - - - La clase SolrGenericResponse - SolrGenericResponse - - - - -
    - &reftitle.intro; - - Representa una respuesta del servidor Solr. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrGenericResponse - - - - - final - SolrGenericResponse - - - - extends - SolrResponse - - - - &Constants; - - const - int - SolrGenericResponse::PARSE_SOLR_OBJ - 0 - - - const - int - SolrGenericResponse::PARSE_SOLR_DOC - 1 - - - &InheritedProperties; - - - &Methods; - - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.constants; -
    - Constantes de la Clase SolrGenericResponse - - - - SolrGenericResponse::PARSE_SOLR_OBJ - - Los documentos deberían ser analizados como instancias de SolrObject - - - - - SolrGenericResponse::PARSE_SOLR_DOC - - Los documentos deberían ser analizados como instancias de SolrDocument. - - - - -
    -
    - - - -
    - - &reference.solr.entities.solrgenericresponse; - -
    - - diff --git a/reference/solr/solrgenericresponse/construct.xml b/reference/solr/solrgenericresponse/construct.xml deleted file mode 100644 index 26129a04be..0000000000 --- a/reference/solr/solrgenericresponse/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrGenericResponse::__construct - Constructor - - - - &reftitle.description; - - public SolrGenericResponse::__construct - - - - Constructor - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Nada - - - - - - diff --git a/reference/solr/solrgenericresponse/destruct.xml b/reference/solr/solrgenericresponse/destruct.xml deleted file mode 100644 index 123bf71670..0000000000 --- a/reference/solr/solrgenericresponse/destruct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - SolrGenericResponse::__destruct - Destructor - - - - &reftitle.description; - - public SolrGenericResponse::__destruct - - - - Destructor. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Nada - - - - - - diff --git a/reference/solr/solrillegalargumentexception.xml b/reference/solr/solrillegalargumentexception.xml deleted file mode 100644 index a80ffc0dc8..0000000000 --- a/reference/solr/solrillegalargumentexception.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - La clase SolrIllegalArgumentException - SolrIllegalArgumentException - - - - -
    - &reftitle.intro; - - Este objeto es lanzado cuando un argumento ilegal o no válido es pasado al método. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrIllegalArgumentException - - - - - SolrIllegalArgumentException - - - - extends - SolrException - - - - &InheritedProperties; - - - - &Methods; - - - &InheritedMethods; - - - - - - -
    - - -
    - - &reference.solr.entities.solrillegalargumentexception; - -
    - - diff --git a/reference/solr/solrillegalargumentexception/getinternalinfo.xml b/reference/solr/solrillegalargumentexception/getinternalinfo.xml deleted file mode 100644 index 65b8bee9f9..0000000000 --- a/reference/solr/solrillegalargumentexception/getinternalinfo.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - SolrIllegalArgumentException::getInternalInfo - Devuelve información interna de donde se lanzó la excepción - - - - &reftitle.description; - - public arraySolrIllegalArgumentException::getInternalInfo - - - - Devuelve información interna de donde se lanzó la excepción. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una matriz que contiene información interna de donde el error fue lanzado. Usado únicamente para depurar por desarrolladores de extensiones. - - - - - - diff --git a/reference/solr/solrillegaloperationexception.xml b/reference/solr/solrillegaloperationexception.xml deleted file mode 100644 index 5bb6ed7fca..0000000000 --- a/reference/solr/solrillegaloperationexception.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - La clase SolrIllegalOperationException - SolrIllegalOperationException - - - - -
    - &reftitle.intro; - - Este objeto es lanzado cuando una operación ilegal o no soportada es realizada sobre un objeto. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrIllegalOperationException - - - - - SolrIllegalOperationException - - - - extends - SolrException - - - - &InheritedProperties; - - - - &Methods; - - - &InheritedMethods; - - - - - - -
    - - -
    - - &reference.solr.entities.solrillegaloperationexception; - -
    - - diff --git a/reference/solr/solrillegaloperationexception/getinternalinfo.xml b/reference/solr/solrillegaloperationexception/getinternalinfo.xml deleted file mode 100644 index 7823b14111..0000000000 --- a/reference/solr/solrillegaloperationexception/getinternalinfo.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - SolrIllegalOperationException::getInternalInfo - Devuelve información interna de donde se lanzó la excepción - - - - &reftitle.description; - - public arraySolrIllegalOperationException::getInternalInfo - - - - Devuelve información interna de donde se lanzó la excepción. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una matriz que contiene información interna de donde el error fue lanzado. Usado únicamente para depurar por desarrolladores de extensiones. - - - - - - diff --git a/reference/solr/solrinputdocument.xml b/reference/solr/solrinputdocument.xml deleted file mode 100644 index 6417f0c60f..0000000000 --- a/reference/solr/solrinputdocument.xml +++ /dev/null @@ -1,163 +0,0 @@ - - - - - - - La clase SolrInputDocument - SolrInputDocument - - - - -
    - &reftitle.intro; - - Esta clase representa un documento Solr que está a punto de ser enviado al índice de Solr. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrInputDocument - - - - - final - SolrInputDocument - - - - &Constants; - - const - int - SolrInputDocument::SORT_DEFAULT - 1 - - - const - int - SolrInputDocument::SORT_ASC - 1 - - - const - int - SolrInputDocument::SORT_DESC - 2 - - - const - int - SolrInputDocument::SORT_FIELD_NAME - 1 - - - const - int - SolrInputDocument::SORT_FIELD_VALUE_COUNT - 2 - - - const - int - SolrInputDocument::SORT_FIELD_BOOST_VALUE - 4 - - - &Methods; - - - - - - -
    - - -
    - &reftitle.constants; -
    - Constantes de la Clase SolrInputDocument - - - - SolrInputDocument::SORT_DEFAULT - - Ordena los campos de forma ascendente. - - - - - SolrInputDocument::SORT_ASC - - Ordena los campos de forma ascendente. - - - - - SolrInputDocument::SORT_DESC - - Ordena los campos de forma descendente - - - - - SolrInputDocument::SORT_FIELD_NAME - - Ordena los campos por nombre - - - - - SolrInputDocument::SORT_FIELD_VALUE_COUNT - - Ordena los campos según el número de valores. - - - - - SolrInputDocument::SORT_FIELD_BOOST_VALUE - - Ordena los campos según el valor de boost. - - - - -
    -
    - - - -
    - - &reference.solr.entities.solrinputdocument; - -
    - - diff --git a/reference/solr/solrinputdocument/addchilddocument.xml b/reference/solr/solrinputdocument/addchilddocument.xml deleted file mode 100644 index 24128f62dc..0000000000 --- a/reference/solr/solrinputdocument/addchilddocument.xml +++ /dev/null @@ -1,161 +0,0 @@ - - - - - - SolrInputDocument::addChildDocument - Añade un documento hijo para la indexación de bloque - - - - &reftitle.description; - - public voidSolrInputDocument::addChildDocument - SolrInputDocumentchild - - - Añade un documento hijo para la indexación de bloque con documentos anidados. - - - - - &reftitle.parameters; - - - child - - - Un objeto SolrInputDocument. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Lanza una SolrIllegalArgumentException en caso de fallo. - - - Lanza una SolrException en caso de fallo interno. - - - - - &reftitle.examples; - - Ejemplo de <function>SolrInputDocument::addChildDocument</function> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, - 'path' => SOLR_SERVER_STORE_PATH, -); - -$client = new SolrClient($options); - -$product = new SolrInputDocument(); - -$product->addField('id', 'P-BLACK'); -$product->addField('cat', 'tshirt'); -$product->addField('cat', 'polo'); -$product->addField('content_type', 'product'); - -$small = new SolrInputDocument(); -$small->addField('id', 'TS-BLK-S'); -$small->addField('content_type', 'sku'); -$small->addField('size', 'S'); -$small->addField('inventory', 100); - -$medium = new SolrInputDocument(); -$medium->addField('id', 'TS-BLK-M'); -$medium->addField('content_type', 'sku'); -$medium->addField('size', 'M'); -$medium->addField('inventory', 200); - -$large = new SolrInputDocument(); -$large->addField('id', 'TS-BLK-L'); -$large->addField('content_type', 'sku'); -$large->addField('size', 'L'); -$large->addField('inventory', 300); - -// añade un documento hijo -$product->addChildDocument($small); -$product->addChildDocument($medium); -$product->addChildDocument($large); - -// añade el bloque de documento producto al índice -$updateResponse = $client->addDocument( - $product, - true, // sobrescribir si el documento existe - 10000 // commit en los 10 segundos -); - -print_r($updateResponse->getResponse()); - -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 5 - ) -) -]]> - - - - - - &reftitle.seealso; - - SolrInputDocument::addChildDocuments - SolrInputDocument::hasChildDocuments - SolrInputDocument::getChildDocuments - SolrInputDocument::getChildDocumentsCount - - - - - - diff --git a/reference/solr/solrinputdocument/addchilddocuments.xml b/reference/solr/solrinputdocument/addchilddocuments.xml deleted file mode 100644 index 2745761efc..0000000000 --- a/reference/solr/solrinputdocument/addchilddocuments.xml +++ /dev/null @@ -1,161 +0,0 @@ - - - - - - SolrInputDocument::addChildDocuments - Añade un array de documentos hijos - - - - &reftitle.description; - - public voidSolrInputDocument::addChildDocuments - arraydocs - - - Añade un array de documentos hijos al documento de entrada actual. - - - - - - &reftitle.parameters; - - - docs - - - Un array de objetos SolrInputDocument. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Lanza una SolrIllegalArgumentException en caso de error. - - - Lanza una SolrException en caso de error interno. - - - - - &reftitle.examples; - - Ejemplo de <function>SolrInputDocument::addChildDocuments</function> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, - 'path' => SOLR_SERVER_STORE_PATH, -); - -$client = new SolrClient($options); - -$product = new SolrInputDocument(); - -$product->addField('id', 'P-BLACK'); -$product->addField('cat', 'tshirt'); -$product->addField('cat', 'polo'); -$product->addField('content_type', 'product'); - -$small = new SolrInputDocument(); -$small->addField('id', 'TS-BLK-S'); -$small->addField('content_type', 'sku'); -$small->addField('size', 'S'); -$small->addField('inventory', 100); - -$medium = new SolrInputDocument(); -$medium->addField('id', 'TS-BLK-M'); -$medium->addField('content_type', 'sku'); -$medium->addField('size', 'M'); -$medium->addField('inventory', 200); - -$large = new SolrInputDocument(); -$large->addField('id', 'TS-BLK-L'); -$large->addField('content_type', 'sku'); -$large->addField('size', 'L'); -$large->addField('inventory', 300); - -// añade los documentos hijos -$skus = [$small, $medium, $large]; -$product->addChildDocuments($skus); - -// añade el bloque de documento producto al índice -$updateResponse = $client->addDocument( - $product, - true, // sobrescribe si el documento existe - 10000 // valida el commit en 10 segundos -); - -print_r($updateResponse->getResponse()); - -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 5 - ) -) -]]> - - - - - - &reftitle.seealso; - - SolrInputDocument::addChildDocument - SolrInputDocument::hasChildDocuments - SolrInputDocument::getChildDocuments - SolrInputDocument::getChildDocumentsCount - - - - - - diff --git a/reference/solr/solrinputdocument/addfield.xml b/reference/solr/solrinputdocument/addfield.xml deleted file mode 100644 index e84e50680a..0000000000 --- a/reference/solr/solrinputdocument/addfield.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - SolrInputDocument::addField - Añade un campo al documento - - - - &reftitle.description; - - public boolSolrInputDocument::addField - stringfieldName - stringfieldValue - floatfieldBoostValue0.0 - - - Para múltiples campos, si se especifica un valor boost válido, el valor especificado será multiplicado por el valor boost actual para este campo. - - - - - - &reftitle.parameters; - - - - fieldName - - - El nombre del campo - - - - - fieldValue - - - El valor del campo - - - - - fieldBoostValue - - - El boost de tiempo del índice. Ya que este valor no puede ser negativo, se pueden pasar aún valores menores que 1.0 pero deben ser mayores que cero. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrinputdocument/clear.xml b/reference/solr/solrinputdocument/clear.xml deleted file mode 100644 index 9de8a4e2e9..0000000000 --- a/reference/solr/solrinputdocument/clear.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrInputDocument::clear - Restablece el documento de entrada - - - - &reftitle.description; - - public boolSolrInputDocument::clear - - - - Restablece el documento borrando todos los campos y restableciendo el boost del documento a cero. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrinputdocument/clone.xml b/reference/solr/solrinputdocument/clone.xml deleted file mode 100644 index a648dfcf7c..0000000000 --- a/reference/solr/solrinputdocument/clone.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrInputDocument::__clone - Crea una copia de un objeto SolrDocument - - - - &reftitle.description; - - public voidSolrInputDocument::__clone - - - - No se debería llamar directamente. Se usa para crear una copia profunda de un objeto SolrInputDocument. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Crea una nueva instancia de SolrInputDocument. - - - - - - diff --git a/reference/solr/solrinputdocument/construct.xml b/reference/solr/solrinputdocument/construct.xml deleted file mode 100644 index 6613a54a4d..0000000000 --- a/reference/solr/solrinputdocument/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrInputDocument::__construct - Constructor - - - - &reftitle.description; - - public SolrInputDocument::__construct - - - - Constructor. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Nada. - - - - - - diff --git a/reference/solr/solrinputdocument/deletefield.xml b/reference/solr/solrinputdocument/deletefield.xml deleted file mode 100644 index b487cc1820..0000000000 --- a/reference/solr/solrinputdocument/deletefield.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrInputDocument::deleteField - Elimina un campo del documento - - - - &reftitle.description; - - public boolSolrInputDocument::deleteField - stringfieldName - - - Elimina un campo del documento. - - - - - - &reftitle.parameters; - - - - fieldName - - - El nombre del campo. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrinputdocument/destruct.xml b/reference/solr/solrinputdocument/destruct.xml deleted file mode 100644 index 41cce0e4d7..0000000000 --- a/reference/solr/solrinputdocument/destruct.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - SolrInputDocument::__destruct - Destructor - - - - &reftitle.description; - - public SolrInputDocument::__destruct - - - - Destructor - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Nada. - - - - - - diff --git a/reference/solr/solrinputdocument/fieldexists.xml b/reference/solr/solrinputdocument/fieldexists.xml deleted file mode 100644 index 51250ca0aa..0000000000 --- a/reference/solr/solrinputdocument/fieldexists.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrInputDocument::fieldExists - Comprueba si existe un campo - - - - &reftitle.description; - - public boolSolrInputDocument::fieldExists - stringfieldName - - - Comprueba si existe un campo - - - - - - &reftitle.parameters; - - - - fieldName - - - Nombre del campo. - - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si se encontró el campo y &false; si no se encontró. - - - - - - diff --git a/reference/solr/solrinputdocument/getboost.xml b/reference/solr/solrinputdocument/getboost.xml deleted file mode 100644 index 291bc3566f..0000000000 --- a/reference/solr/solrinputdocument/getboost.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - SolrInputDocument::getBoost - Recupera el valor boost actual del documento - - - - &reftitle.description; - - public floatSolrInputDocument::getBoost - - - - Recupera el valor boost actual del documento. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el valor boost en caso de éxito y &false; en caso de fallo. - - - - - - diff --git a/reference/solr/solrinputdocument/getchilddocuments.xml b/reference/solr/solrinputdocument/getchilddocuments.xml deleted file mode 100644 index 4af6f94b29..0000000000 --- a/reference/solr/solrinputdocument/getchilddocuments.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - SolrInputDocument::getChildDocuments - Devuelve un array de documentos hijos (SolrInputDocument) - - - - &reftitle.description; - - public arraySolrInputDocument::getChildDocuments - - - - Devuelve un array de documentos hijos (SolrInputDocument) - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrInputDocument::addChildDocument - SolrInputDocument::addChildDocuments - SolrInputDocument::hasChildDocuments - SolrInputDocument::getChildDocumentsCount - - - - - - diff --git a/reference/solr/solrinputdocument/getchilddocumentscount.xml b/reference/solr/solrinputdocument/getchilddocumentscount.xml deleted file mode 100644 index e144c78811..0000000000 --- a/reference/solr/solrinputdocument/getchilddocumentscount.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - SolrInputDocument::getChildDocumentsCount - Devuelve el número de documentos hijos - - - - &reftitle.description; - - public intSolrInputDocument::getChildDocumentsCount - - - - Devuelve el número de documentos hijos - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrInputDocument::addChildDocument - SolrInputDocument::addChildDocuments - SolrInputDocument::hasChildDocuments - SolrInputDocument::getChildDocuments - - - - - - diff --git a/reference/solr/solrinputdocument/getfield.xml b/reference/solr/solrinputdocument/getfield.xml deleted file mode 100644 index 25c4063d11..0000000000 --- a/reference/solr/solrinputdocument/getfield.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrInputDocument::getField - Recupera un campo por su nombre - - - - &reftitle.description; - - public SolrDocumentFieldSolrInputDocument::getField - stringfieldName - - - Recupera un campo del documento. - - - - - - &reftitle.parameters; - - - - fieldName - - - El nombre del campo. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto SolrDocumentField en caso de éxito y &false; en caso de error. - - - - - - diff --git a/reference/solr/solrinputdocument/getfieldboost.xml b/reference/solr/solrinputdocument/getfieldboost.xml deleted file mode 100644 index 294f3265a1..0000000000 --- a/reference/solr/solrinputdocument/getfieldboost.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrInputDocument::getFieldBoost - Recupera el valor boost de un campo en particular - - - - &reftitle.description; - - public floatSolrInputDocument::getFieldBoost - stringfieldName - - - Recupera el valor boost de un campo en particular. - - - - - - &reftitle.parameters; - - - - fieldName - - - El nombre del campo. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor boost del campo o &false; si hubo un error. - - - - - - diff --git a/reference/solr/solrinputdocument/getfieldcount.xml b/reference/solr/solrinputdocument/getfieldcount.xml deleted file mode 100644 index bd25469ae7..0000000000 --- a/reference/solr/solrinputdocument/getfieldcount.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrInputDocument::getFieldCount - Devuelve el número de campos del documento - - - - &reftitle.description; - - public intfalseSolrInputDocument::getFieldCount - - - - Devuelve el número de campos del documento. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un entero en caso de éxito &return.falseforfailure;. - - - - - - diff --git a/reference/solr/solrinputdocument/getfieldnames.xml b/reference/solr/solrinputdocument/getfieldnames.xml deleted file mode 100644 index 9158427820..0000000000 --- a/reference/solr/solrinputdocument/getfieldnames.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrInputDocument::getFieldNames - Devuelve una matriz que contiene todos los campos del documento - - - - &reftitle.description; - - public arraySolrInputDocument::getFieldNames - - - - Devuelve una matriz que contiene todos los campos del documento. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una matriz en caso de éxito y &false; en caso de fallo. - - - - - - diff --git a/reference/solr/solrinputdocument/haschilddocuments.xml b/reference/solr/solrinputdocument/haschilddocuments.xml deleted file mode 100644 index 10439a8039..0000000000 --- a/reference/solr/solrinputdocument/haschilddocuments.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - SolrInputDocument::hasChildDocuments - Devuelve true si el documento tiene documentos hijos - - - - &reftitle.description; - - public boolSolrInputDocument::hasChildDocuments - - - - Verifica si el documento tiene documentos hijos - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrInputDocument::addChildDocument - SolrInputDocument::addChildDocuments - SolrInputDocument::getChildDocuments - SolrInputDocument::getChildDocumentsCount - - - - - - diff --git a/reference/solr/solrinputdocument/merge.xml b/reference/solr/solrinputdocument/merge.xml deleted file mode 100644 index 099085dffc..0000000000 --- a/reference/solr/solrinputdocument/merge.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - SolrInputDocument::merge - Fusiona un documento con otro - - - - &reftitle.description; - - public boolSolrInputDocument::merge - SolrInputDocumentsourceDoc - booloverwrite&true; - - - Fusiona un documento con otro. - - - - - - &reftitle.parameters; - - - - sourceDoc - - - El documento fuente. - - - - - overwrite - - - Si esto es &true; reemplazará los campos coincidentes del documento destino. - - - - - - - - - &reftitle.returnvalues; - - &return.success; En el futuro, esto será modificado para que devuelva el número de campos del documento nuevo. - - - - - - diff --git a/reference/solr/solrinputdocument/reset.xml b/reference/solr/solrinputdocument/reset.xml deleted file mode 100644 index 89549b48e5..0000000000 --- a/reference/solr/solrinputdocument/reset.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - SolrInputDocument::reset - &Alias; SolrInputDocument::clear - - - - &reftitle.description; - - public boolSolrInputDocument::reset - - - - Este es un alias de SolrInputDocument::clear - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/solr/solrinputdocument/setboost.xml b/reference/solr/solrinputdocument/setboost.xml deleted file mode 100644 index 43bcfed136..0000000000 --- a/reference/solr/solrinputdocument/setboost.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrInputDocument::setBoost - Establece el valor boost de este documento - - - - &reftitle.description; - - public boolSolrInputDocument::setBoost - floatdocumentBoostValue - - - Establece el valor boost de este documento. - - - - - - &reftitle.parameters; - - - - documentBoostValue - - - El valor boost de tiempo del índice de este documento. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrinputdocument/setfieldboost.xml b/reference/solr/solrinputdocument/setfieldboost.xml deleted file mode 100644 index 9b6d2a4cfa..0000000000 --- a/reference/solr/solrinputdocument/setfieldboost.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - SolrInputDocument::setFieldBoost - Establece el valor boost de tiempo del índice de un campo - - - - &reftitle.description; - - public boolSolrInputDocument::setFieldBoost - stringfieldName - floatfieldBoostValue - - - Establece el valor boost de tiempo del índice de un campo. Esto reemplaza el valor boost acutal de este campo. - - - - - - &reftitle.parameters; - - - - fieldName - - - El nombre del campo. - - - - - fieldBoostValue - - - El valor boost de tiempo del índice. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrinputdocument/sort.xml b/reference/solr/solrinputdocument/sort.xml deleted file mode 100644 index 9bd7267be3..0000000000 --- a/reference/solr/solrinputdocument/sort.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - SolrInputDocument::sort - Ordena los campos dentro de un documento - - - - &reftitle.description; - - public boolSolrInputDocument::sort - intsortOrderBy - intsortDirectionSolrInputDocument::SORT_ASC - - - - - - - - - - - &reftitle.parameters; - - - - sortOrderBy - - - El criterio de ordenación - - - - - sortDirection - - - La dirección de ordenación - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrinputdocument/toarray.xml b/reference/solr/solrinputdocument/toarray.xml deleted file mode 100644 index 8f16c61ea4..0000000000 --- a/reference/solr/solrinputdocument/toarray.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrInputDocument::toArray - Devuelve una matriz como representación del documento de entrada - - - - &reftitle.description; - - public arraySolrInputDocument::toArray - - - - Devuelve una matriz como representación del documento de entrada. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una matriz que contiene los campos. Devuelve &false; en caso de error. - - - - - - diff --git a/reference/solr/solrmissingmandatoryparameterexception.xml b/reference/solr/solrmissingmandatoryparameterexception.xml deleted file mode 100644 index b87b7e0cbe..0000000000 --- a/reference/solr/solrmissingmandatoryparameterexception.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - La clase SolrMissingMandatoryParameterException - SolrMissingMandatoryParameterException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrMissingMandatoryParameterException - - - - - SolrMissingMandatoryParameterException - - - - extends - SolrException - - - - &InheritedProperties; - - - - - &InheritedMethods; - - - - - - -
    - -
    - - - -
    - - diff --git a/reference/solr/solrmodifiableparams.xml b/reference/solr/solrmodifiableparams.xml deleted file mode 100644 index 8758cdc6ce..0000000000 --- a/reference/solr/solrmodifiableparams.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - La clase SolrModifiableParams - SolrModifiableParams - - - - -
    - &reftitle.intro; - - Representa una colección de pares nombre-valore enviados al servidor Solr durante una petición. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrModifiableParams - - - - - SolrModifiableParams - - - - extends - SolrParams - - - - Serializable - - - - - &Methods; - - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.solr.entities.solrmodifiableparams; - -
    - - diff --git a/reference/solr/solrmodifiableparams/construct.xml b/reference/solr/solrmodifiableparams/construct.xml deleted file mode 100644 index ccd8021add..0000000000 --- a/reference/solr/solrmodifiableparams/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrModifiableParams::__construct - Constructor - - - - &reftitle.description; - - public SolrModifiableParams::__construct - - - - Constructor - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Nada - - - - - - diff --git a/reference/solr/solrmodifiableparams/destruct.xml b/reference/solr/solrmodifiableparams/destruct.xml deleted file mode 100644 index 8ccba26163..0000000000 --- a/reference/solr/solrmodifiableparams/destruct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrModifiableParams::__destruct - Destructor - - - - &reftitle.description; - - public SolrModifiableParams::__destruct - - - - Destructor - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Nada - - - - - - diff --git a/reference/solr/solrobject.xml b/reference/solr/solrobject.xml deleted file mode 100644 index 80cbba42ec..0000000000 --- a/reference/solr/solrobject.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - La clase SolrObject - SolrObject - - - - -
    - &reftitle.intro; - - Es un objeto a cuyas propiedades también se pueden acceder usando la sintaxis de array. Todas sus propiedades son de sólo lectura. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrObject - - - - - final - SolrObject - - - - ArrayAccess - - - - - &Methods; - - - - - - -
    - -
    - - &reference.solr.entities.solrobject; - -
    - - diff --git a/reference/solr/solrobject/construct.xml b/reference/solr/solrobject/construct.xml deleted file mode 100644 index 5ca3693f50..0000000000 --- a/reference/solr/solrobject/construct.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - SolrObject::__construct - Crea un objeto Solr - - - - &reftitle.description; - - public SolrObject::__construct - - - - Crea un objeto Solr. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Nada - - - - - &reftitle.examples; - - - Ejemplo de <methodname>SolrObject::__construct</methodname> - - -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/solr/solrobject/destruct.xml b/reference/solr/solrobject/destruct.xml deleted file mode 100644 index 42a6ea6dd9..0000000000 --- a/reference/solr/solrobject/destruct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrObject::__destruct - Destructor - - - - &reftitle.description; - - public SolrObject::__destruct - - - - El destructor - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Nada. - - - - - - diff --git a/reference/solr/solrobject/getpropertynames.xml b/reference/solr/solrobject/getpropertynames.xml deleted file mode 100644 index 5495df06b4..0000000000 --- a/reference/solr/solrobject/getpropertynames.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrObject::getPropertyNames - Devuelve una matriz de todos los nombres de las propiedades - - - - &reftitle.description; - - public arraySolrObject::getPropertyNames - - - - Devuelve una matriz de todos los nombres de las propiedades. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una matriz. - - - - - - diff --git a/reference/solr/solrobject/offsetexists.xml b/reference/solr/solrobject/offsetexists.xml deleted file mode 100644 index fe0f507fc1..0000000000 --- a/reference/solr/solrobject/offsetexists.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrObject::offsetExists - Comprueba si la propiedad existe - - - - &reftitle.description; - - public boolSolrObject::offsetExists - stringproperty_name - - - Comprueba si la propiedad existe. Se usa cuando el objeto es tratado como una matriz. - - - - - - &reftitle.parameters; - - - - property_name - - - El nombre de la propiedad. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrobject/offsetget.xml b/reference/solr/solrobject/offsetget.xml deleted file mode 100644 index f732b9e2f4..0000000000 --- a/reference/solr/solrobject/offsetget.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - SolrObject::offsetGet - Usado para recuperar una propiedad - - - - &reftitle.description; - - public mixedSolrObject::offsetGet - stringproperty_name - - - Usado para obtener el valor de una propiedad. Se utiliza cuando un objeto es tratado como una matriz. - - - - - &reftitle.parameters; - - - - property_name - - - Nombre de la propiedad. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor de la propiedad. - - - - - - diff --git a/reference/solr/solrobject/offsetset.xml b/reference/solr/solrobject/offsetset.xml deleted file mode 100644 index 08721083f6..0000000000 --- a/reference/solr/solrobject/offsetset.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - SolrObject::offsetSet - Establece el valor de una propiedad - - - - &reftitle.description; - - public voidSolrObject::offsetSet - stringproperty_name - stringproperty_value - - - Establece el valor de una propiedad. Se usa cuando el objeto es tratado como una matriz. Este objeto es de sólo lectura. Esto nunva debería intentarse. - - - - - - &reftitle.parameters; - - - - property_name - - - El nombre de la propiedad. - - - - - property_value - - - El nuevo valor. - - - - - - - - - &reftitle.returnvalues; - - Nada. - - - - - - diff --git a/reference/solr/solrobject/offsetunset.xml b/reference/solr/solrobject/offsetunset.xml deleted file mode 100644 index 942468c257..0000000000 --- a/reference/solr/solrobject/offsetunset.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - - - SolrObject::offsetUnset - Desestablece el valor de la propiedad - - - - &reftitle.description; - - public voidSolrObject::offsetUnset - stringproperty_name - - - Desestablece el valor de la propiedad. Se emplea cuando el objeto es tratado como un array. Este objeto es de sólo lectura. Esto nunca debe intentarse. - - - - - - &reftitle.parameters; - - - - property_name - - - El nombre de la propiedad. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Ejemplo de <methodname>SolrObject::offsetUnset</methodname> - - -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/solr/solrparams.xml b/reference/solr/solrparams.xml deleted file mode 100644 index c8ae393085..0000000000 --- a/reference/solr/solrparams.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - La clase SolrParams - SolrParams - - - - -
    - &reftitle.intro; - - Representa una colección de pares nombre-valor enviado al servidor Solr durante una petición. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrParams - - - - - abstract - SolrParams - - - - Serializable - - - - - - &Methods; - - - - -
    - -
    - - &reference.solr.entities.solrparams; - -
    - - diff --git a/reference/solr/solrparams/add.xml b/reference/solr/solrparams/add.xml deleted file mode 100644 index 4b68bb3cfb..0000000000 --- a/reference/solr/solrparams/add.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - SolrParams::add - &Alias; SolrParams::addParam - - - - &reftitle.description; - - final public SolrParamsSolrParams::add - stringname - stringvalue - - - Esto es un alias de SolrParams::addParam - - - - - - &reftitle.parameters; - - - - name - - - El nombre del parámetro - - - - - value - - - El valor del parámetro - - - - - - - - - &reftitle.returnvalues; - -Devuelve una instancia de SolrParams en caso de éxito - - - - - - - diff --git a/reference/solr/solrparams/addparam.xml b/reference/solr/solrparams/addparam.xml deleted file mode 100644 index 3ee1bf1eed..0000000000 --- a/reference/solr/solrparams/addparam.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - SolrParams::addParam - Añade un parámetro al objeto - - - - &reftitle.description; - - public SolrParamsSolrParams::addParam - stringname - stringvalue - - - Añade un parámetro al objeto. Se usa para parámetros que pueden ser especificados múltiples veces. - - - - - &reftitle.parameters; - - - - name - - - Nombre del parámetro - - - - - value - - - alor del parámetro - - - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto SolrParam an caso de éxito y &false; en caso de error. - - - - - - diff --git a/reference/solr/solrparams/get.xml b/reference/solr/solrparams/get.xml deleted file mode 100644 index 7d3489a6d7..0000000000 --- a/reference/solr/solrparams/get.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - SolrParams::get - &Alias; SolrParams::getParam - - - - &reftitle.description; - - final public mixedSolrParams::get - stringparam_name - - - Este es una alias de SolrParams::getParam - - - - - - &reftitle.parameters; - - - - param_name - - - El nombre del parámetro - - - - - - - - - &reftitle.returnvalues; - - Devuelve una matriz o una cadena, dependiendo del tipo de parámetro - - - - - - - diff --git a/reference/solr/solrparams/getparam.xml b/reference/solr/solrparams/getparam.xml deleted file mode 100644 index 4dc4bd269e..0000000000 --- a/reference/solr/solrparams/getparam.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - SolrParams::getParam - Devuelve el valor de un parámetro - - - - &reftitle.description; - - final public mixedSolrParams::getParam - stringparam_name - - - Devuelve el valor de un parámetro. - - - - - - &reftitle.parameters; - - - - param_name - - - Nombre del parámetro. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un &string; o un array según el tipo del parámetro. - - - - - - diff --git a/reference/solr/solrparams/getparams.xml b/reference/solr/solrparams/getparams.xml deleted file mode 100644 index c04f00e5a5..0000000000 --- a/reference/solr/solrparams/getparams.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrParams::getParams - Devuelve una matriz de parámetros URL no codificados - - - - &reftitle.description; - - final public arraySolrParams::getParams - - - - Devuelve una matriz de parámetros URL no codificados - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una matriz de parámetros URL no codificados - - - - - - diff --git a/reference/solr/solrparams/getpreparedparams.xml b/reference/solr/solrparams/getpreparedparams.xml deleted file mode 100644 index b41305e401..0000000000 --- a/reference/solr/solrparams/getpreparedparams.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrParams::getPreparedParams - Devuelve una matriz de parámetros URL codificados - - - - &reftitle.description; - - final public arraySolrParams::getPreparedParams - - - - Devuelve una matriz de parámetros URL codificados - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una matriz de parámetros URL codificados - - - - - - diff --git a/reference/solr/solrparams/serialize.xml b/reference/solr/solrparams/serialize.xml deleted file mode 100644 index 5328986ce0..0000000000 --- a/reference/solr/solrparams/serialize.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - SolrParams::serialize - Usado para serialización personalizada - - - - &reftitle.description; - - final public stringSolrParams::serialize - - - - Usado para serialización personalizada - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Usado para serialización personalizada - - - - - - diff --git a/reference/solr/solrparams/set.xml b/reference/solr/solrparams/set.xml deleted file mode 100644 index da251db57a..0000000000 --- a/reference/solr/solrparams/set.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - SolrParams::set - &Alias; SolrParams::setParam - - - - &reftitle.description; - - final public voidSolrParams::set - stringname - stringvalue - - - Un alas de SolrParams::setParam - - - - - &reftitle.parameters; - - - - name - - - El nombre del parámetro - - - - - value - - - El valor del parámatro - - - - - - - - - &reftitle.returnvalues; - - Devuelve una instancia del objeto SolrParams en caso de éxito - - - - - - - diff --git a/reference/solr/solrparams/setparam.xml b/reference/solr/solrparams/setparam.xml deleted file mode 100644 index 260ab21ec3..0000000000 --- a/reference/solr/solrparams/setparam.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - - SolrParams::setParam - Establece el parámetro al valor especificado - - - - &reftitle.description; - - public SolrParamsSolrParams::setParam - stringname - stringvalue - - - Establece el parámetro de consulta al valor especificado. Es usado para parámetros que sólo pueden ser especificados una vez. Subsiguientes llamadas con el mismo parámetro sobrescribirá el valor existente. - - - - - - &reftitle.parameters; - - - - name - - - Nomvre del parámetro - - - - - value - - - Valor del parámetro - - - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto SolrParam en caso de éxito y &false; sobre el valor. - - - - - &reftitle.examples; - - - Ejemplo de <methodname>SolrParams::setParam</methodname> - -setParam('q', 'solr')->setParam('rows', 2); - -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/solr/solrparams/tostring.xml b/reference/solr/solrparams/tostring.xml deleted file mode 100644 index 5e0f0edb6d..0000000000 --- a/reference/solr/solrparams/tostring.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - SolrParams::toString - Devuelve todos los parámetros de los pares nombre-valor del objeto - - - - &reftitle.description; - - final public stringSolrParams::toString - boolurl_encode&false; - - - Devuelve todos los parámetros de los pares nombre-valor del objeto. - - - - - - &reftitle.parameters; - - - - url_encode - - - Si devolver o no valores de URL codificados - - - - - - - - - &reftitle.returnvalues; - - Devuelve un string en caso de éxito y &false; en caso de fallo. - - - - - - - diff --git a/reference/solr/solrparams/unserialize.xml b/reference/solr/solrparams/unserialize.xml deleted file mode 100644 index d2aa07b360..0000000000 --- a/reference/solr/solrparams/unserialize.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - SolrParams::unserialize - Usado para serialización personalizada - - - - &reftitle.description; - - final public voidSolrParams::unserialize - stringserialized - - - Usado para serialización personalizada - - - - - &reftitle.parameters; - - - - serialized - - - La representación serializada del objeto - - - - - - - - - &reftitle.returnvalues; - - Nada - - - - - - diff --git a/reference/solr/solrpingresponse.xml b/reference/solr/solrpingresponse.xml deleted file mode 100644 index 6740d667c7..0000000000 --- a/reference/solr/solrpingresponse.xml +++ /dev/null @@ -1,193 +0,0 @@ - - - - - - - La clase SolrPingResponse - SolrPingResponse - - - - -
    - &reftitle.intro; - - Representa una respuesta a una petición ping al servidor - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrPingResponse - - - - - final - SolrPingResponse - - - - extends - SolrResponse - - - - &Constants; - - const - int - SolrPingResponse::PARSE_SOLR_OBJ - 0 - - - const - int - SolrPingResponse::PARSE_SOLR_DOC - 1 - - - &Properties; - - - &Methods; - - - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - http_status - - El estado http de la resupuesta. - - - - parser_mode - - Modo de analizar los documentos, si como instancias de SolrObject o de SolrDocument. - - - - success - - ¿Ocurrió un error durante la solicitud? - - - - http_status_message - - Messaje detallado del estado http - - - - http_request_url - - La URL solicitada - - - - http_raw_request_headers - - Una cadena de cabeceras en bruto enviada durante la solicitud - - - - http_raw_request - - La solicitud en bruto enviada al servidor - - - - http_raw_response_headers - - Las cabeceras de resupuesta del servidor Solr - - - - http_raw_response - - El mensaje de respuesta del servidor - - - - http_digested_response - - La respuesta en formato serializado de PHP. - - - -
    - - - - -
    - &reftitle.constants; -
    - Constantes de la Clase SolrPingResponse - - - - SolrPingResponse::PARSE_SOLR_OBJ - - Los documentos deberían ser analizados como instancias de SolrObject - - - - - SolrPingResponse::PARSE_SOLR_DOC - - Los documentos deberían ser analizados como instancias de SolrDocument. - - - - -
    -
    - - - -
    - - &reference.solr.entities.solrpingresponse; - -
    - - diff --git a/reference/solr/solrpingresponse/construct.xml b/reference/solr/solrpingresponse/construct.xml deleted file mode 100644 index 195f1f7e18..0000000000 --- a/reference/solr/solrpingresponse/construct.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - SolrPingResponse::__construct - Constructor - - - - &reftitle.description; - - public SolrPingResponse::__construct - - - - Constructor - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Nada - - - - - - diff --git a/reference/solr/solrpingresponse/destruct.xml b/reference/solr/solrpingresponse/destruct.xml deleted file mode 100644 index 73ae14bef1..0000000000 --- a/reference/solr/solrpingresponse/destruct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - SolrPingResponse::__destruct - Destructor - - - - &reftitle.description; - - public SolrPingResponse::__destruct - - - - Destructor - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Nada - - - - - - diff --git a/reference/solr/solrpingresponse/getresponse.xml b/reference/solr/solrpingresponse/getresponse.xml deleted file mode 100644 index 4d05546715..0000000000 --- a/reference/solr/solrpingresponse/getresponse.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrPingResponse::getResponse - Devuelve la respuesta del servidor - - - - &reftitle.description; - - public stringSolrPingResponse::getResponse - - - - Devuelve la respuesta del servidor. Esto debería estar vacío ya que la petición es una petición HEAD. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una cadena vacía. - - - - - - diff --git a/reference/solr/solrquery.xml b/reference/solr/solrquery.xml deleted file mode 100644 index 02edc727ab..0000000000 --- a/reference/solr/solrquery.xml +++ /dev/null @@ -1,178 +0,0 @@ - - - - - - - - La clase SolrQuery - SolrQuery - - - - -
    - &reftitle.intro; - - Representa una colección de pares nombre-valor enviados al servidor Solr durante una petición. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrQuery - - - - - SolrQuery - - - - extends - SolrModifiableParams - - - - Serializable - - - - &Constants; - - const - int - SolrQuery::ORDER_ASC - 0 - - - const - int - SolrQuery::ORDER_DESC - 1 - - - const - int - SolrQuery::FACET_SORT_INDEX - 0 - - - const - int - SolrQuery::FACET_SORT_COUNT - 1 - - - const - int - SolrQuery::TERMS_SORT_INDEX - 0 - - - const - int - SolrQuery::TERMS_SORT_COUNT - 1 - - - &Properties; - - - &Methods; - - - - - &InheritedMethods; - - - - - - -
    - - - -
    - &reftitle.constants; - - - - SolrQuery::ORDER_ASC - - Se usa para especificar la forma de ordenación debería se ascendente - - - - - SolrQuery::ORDER_DESC - - Se usa para especificar la forma de ordenación debería se descendente - - - - - SolrQuery::FACET_SORT_INDEX - - Se usa para especificar que la faceta debería ordenarse según el índice - - - - - SolrQuery::FACET_SORT_COUNT - - Se usa para especificar que la faceta debería ordenarse según la cuenta - - - - - SolrQuery::TERMS_SORT_INDEX - - Usado en TermsComponent - - - - - SolrQuery::TERMS_SORT_COUNT - - Usado en TermsComponent - - - - -
    - - - -
    - - &reference.solr.entities.solrquery; - -
    - - diff --git a/reference/solr/solrquery/addexpandfilterquery.xml b/reference/solr/solrquery/addexpandfilterquery.xml deleted file mode 100644 index 525c7b30af..0000000000 --- a/reference/solr/solrquery/addexpandfilterquery.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - SolrQuery::addExpandFilterQuery - Sobrescribe la consulta de filtro principal, determina qué documentos incluir en el grupo principal - - - - &reftitle.description; - - public SolrQuerySolrQuery::addExpandFilterQuery - stringfq - - - Sobrescribe la consulta de filtro principal, determina qué documentos incluir en el grupo principal. - - - - - - &reftitle.parameters; - - - fq - - - - - - - - - - - &reftitle.returnvalues; - - SolrQuery - - - - - &reftitle.seealso; - - SolrQuery::setExpand - SolrQuery::addExpandSortField - SolrQuery::removeExpandSortField - SolrQuery::setExpandRows - SolrQuery::setExpandQuery - SolrQuery::removeExpandFilterQuery - - - - - - diff --git a/reference/solr/solrquery/addexpandsortfield.xml b/reference/solr/solrquery/addexpandsortfield.xml deleted file mode 100644 index fc1d9b2b8b..0000000000 --- a/reference/solr/solrquery/addexpandsortfield.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - SolrQuery::addExpandSortField - Ordena los documentos en los grupos extendidos (parámetro expand.sort) - - - - &reftitle.description; - - public SolrQuerySolrQuery::addExpandSortField - stringfield - stringorder - - - Ordena los documentos en los grupos extendidos (parámetro expand.sort). - - - - - - &reftitle.parameters; - - - field - - - El nombre del campo - - - - - order - - - Orden ASC/DESC, utiliza las constantes SolrQuery::ORDER_*. - - - Valor por omisión: SolrQuery::ORDER_DESC - - - - - - - - &reftitle.returnvalues; - - SolrQuery - - - - - &reftitle.seealso; - - SolrQuery::setExpand - SolrQuery::removeExpandSortField - SolrQuery::setExpandRows - SolrQuery::setExpandQuery - SolrQuery::addExpandFilterQuery - SolrQuery::removeExpandFilterQuery - - - - - diff --git a/reference/solr/solrquery/addfacetdatefield.xml b/reference/solr/solrquery/addfacetdatefield.xml deleted file mode 100644 index 75315f518d..0000000000 --- a/reference/solr/solrquery/addfacetdatefield.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - SolrQuery::addFacetDateField - Mapea a facet.date - - - - &reftitle.description; - - public SolrQuerySolrQuery::addFacetDateField - stringdateField - - - Este método permite especificar un campo que debería ser tratado como una faceta. - - Se puede usar mútiples veces con diferentes nombres de campos para indicar mútiples campos de facetas - - - - - &reftitle.parameters; - - - - dateField - - - El nombre del campo de fecha. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto SolrQuery. - - - - - - diff --git a/reference/solr/solrquery/addfacetdateother.xml b/reference/solr/solrquery/addfacetdateother.xml deleted file mode 100644 index a53cf834b9..0000000000 --- a/reference/solr/solrquery/addfacetdateother.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - SolrQuery::addFacetDateOther - Añade otro parámetro facet.date.other - - - - &reftitle.description; - - public SolrQuerySolrQuery::addFacetDateOther - stringvalue - stringfield_override - - - Establece el parámetro facet.date.other. Acepta la sobrescritura opcional de campos - - - - - - &reftitle.parameters; - - - - value - - - El valor a usar. - - - - - field_override - - - El nombre del campo para la sobrescritura. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usa el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/addfacetfield.xml b/reference/solr/solrquery/addfacetfield.xml deleted file mode 100644 index 219c95f178..0000000000 --- a/reference/solr/solrquery/addfacetfield.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - - SolrQuery::addFacetField - Añade otro campo a la faceta - - - - &reftitle.description; - - public SolrQuerySolrQuery::addFacetField - stringfield - - - Añade otro campo a la faceta - - - - - - &reftitle.parameters; - - - - field - - - El nombre del campo - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usa el valor de retorno. - - - - - &reftitle.examples; - - - Ejemplo de <methodname>SolrQuery::addFacetField</methodname> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$cliente = new SolrClient($opciones); - -$consulta = new SolrQuery(); - -$consulta->setQuery($consulta); - -$consulta->addField('price')->addField('color'); - -$consulta->setFacet(true); - -$consulta->addFacetField('price')->addFacetField('color'); - -$respuesta_consulta = $cliente->query($consulta); - -$respuesta = $respuesta_consulta->getResponse(); - -print_r($respuesta['facet_counts']['facet_fields']); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [blue] => 20 - [green] => 100 - ) - -) -]]> - - - - - - - - diff --git a/reference/solr/solrquery/addfacetquery.xml b/reference/solr/solrquery/addfacetquery.xml deleted file mode 100644 index e51083788a..0000000000 --- a/reference/solr/solrquery/addfacetquery.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - - SolrQuery::addFacetQuery - Añade una consulta de faceta - - - - &reftitle.description; - - public SolrQuerySolrQuery::addFacetQuery - stringfacetQuery - - - Añade una consulta de faceta - - - - - - &reftitle.parameters; - - - - facetQuery - - - La consulta de faceta - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usa el valor de retorno. - - - - - &reftitle.examples; - - - Ejemplo de <methodname>SolrQuery::addFacetField</methodname> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$cliente = new SolrClient($opciones); - -$consulta = new SolrQuery('*:*'); - -$consulta->setFacet(true); - -$consulta->addFacetQuery('price:[* TO 500]')->addFacetQuery('price:[500 TO *]'); - -$respuesta_consulta = $cliente->query($consulta); - -$respuesta = $respuesta_consulta->getResponse(); - -print_r($respuesta->facet_counts->facet_queries); - -?> -]]> - - &example.outputs.similar; - - 14 - [price:[500 TO *]] => 2 -) - -]]> - - - - - - - - diff --git a/reference/solr/solrquery/addfield.xml b/reference/solr/solrquery/addfield.xml deleted file mode 100644 index dba8392e80..0000000000 --- a/reference/solr/solrquery/addfield.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - SolrQuery::addField - Especifica qué campos devolver en el resultado - - - - &reftitle.description; - - public SolrQuerySolrQuery::addField - stringfield - - - Este método se usa para especificar un conjunto de campos a devolver, restingiendo así la cantidad de información en la respuesta. - - Puede ser llamado múltiples veces, una por cada nombre de campo. - - - - - &reftitle.parameters; - - - - field - - - El nombre del campo - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual - - - - - - diff --git a/reference/solr/solrquery/addfilterquery.xml b/reference/solr/solrquery/addfilterquery.xml deleted file mode 100644 index b7dafbcd6f..0000000000 --- a/reference/solr/solrquery/addfilterquery.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - - SolrQuery::addFilterQuery - Especifica una consulta de filtro - - - - &reftitle.description; - - public SolrQuerySolrQuery::addFilterQuery - stringfq - - - Especifica una consulta de filtro - - - - - - &reftitle.parameters; - - - - fq - - - La consulta de filtro - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual. - - - - - &reftitle.examples; - - - Ejemplo de <methodname>SolrQuery::addFilterQuery</methodname> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, -); - -$cliente = new SolrClient($opciones); - -$consulta = new SolrQuery(); - -$consulta->setQuery('*:*'); - -$consulta->addFilterQuery('color:blue,green'); - -$respuesta_consulta = $cliente->query($consulta); - -$respuesta = $respuesta_consulta->getResponse(); - -print_r($respuesta['facet_counts']['facet_fields']); - -?> -]]> - - &example.outputs.similar; - - - - - - - - - - - diff --git a/reference/solr/solrquery/addgroupfield.xml b/reference/solr/solrquery/addgroupfield.xml deleted file mode 100644 index 8a406f011d..0000000000 --- a/reference/solr/solrquery/addgroupfield.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - SolrQuery::addGroupField - Añade un campo a utilizar para agrupar los resultados - - - - &reftitle.description; - - public SolrQuerySolrQuery::addGroupField - stringvalue - - - El nombre del campo por el cual agrupar los resultados. El campo debe ser de valor único, y estar - indexado o ser un tipo de campo que tenga una fuente de valor y funcione en una consulta de función, - tal como ExternalFileField. Asimismo, debe ser un campo basado en string, tal como StrField o TextField. - Utiliza el parámetro group.field. - - - - - - &reftitle.parameters; - - - value - - - El nombre del campo. - - - - - - - - &reftitle.returnvalues; - - Devuelve una instancia de SolrQuery. - - - - - &reftitle.seealso; - - SolrQuery::setGroup - SolrQuery::addGroupFunction - SolrQuery::addGroupQuery - SolrQuery::addGroupSortField - SolrQuery::setGroupFacet - SolrQuery::setGroupOffset - SolrQuery::setGroupLimit - SolrQuery::setGroupMain - SolrQuery::setGroupNGroups - SolrQuery::setGroupTruncate - SolrQuery::setGroupFormat - SolrQuery::setGroupCachePercent - - - - - diff --git a/reference/solr/solrquery/addgroupfunction.xml b/reference/solr/solrquery/addgroupfunction.xml deleted file mode 100644 index 68f3476a42..0000000000 --- a/reference/solr/solrquery/addgroupfunction.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - SolrQuery::addGroupFunction - Permite agrupar los resultados según los valores únicos de una consulta de función (argumento group.func) - - - - &reftitle.description; - - public SolrQuerySolrQuery::addGroupFunction - stringvalue - - - Añade una función de grupo (argumento group.func) - Permite agrupar los resultados según los valores únicos de una consulta de función. - - - - - - &reftitle.parameters; - - - value - - - - - - - - - - - &reftitle.returnvalues; - - SolrQuery - - - - &reftitle.seealso; - - SolrQuery::setGroup - SolrQuery::addGroupField - SolrQuery::addGroupQuery - SolrQuery::addGroupSortField - SolrQuery::setGroupFacet - SolrQuery::setGroupOffset - SolrQuery::setGroupLimit - SolrQuery::setGroupMain - SolrQuery::setGroupNGroups - SolrQuery::setGroupTruncate - SolrQuery::setGroupFormat - SolrQuery::setGroupCachePercent - - - - - diff --git a/reference/solr/solrquery/addgroupquery.xml b/reference/solr/solrquery/addgroupquery.xml deleted file mode 100644 index f3b405d1e2..0000000000 --- a/reference/solr/solrquery/addgroupquery.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - SolrQuery::addGroupQuery - Permite agrupar los documentos que coinciden con la consulta dada - - - - &reftitle.description; - - public SolrQuerySolrQuery::addGroupQuery - stringvalue - - - Permite agrupar los documentos que coinciden con la consulta dada. - Añade la consulta al parámetro group.query - - - - - &reftitle.parameters; - - - value - - - - - - - - - - - &reftitle.returnvalues; - - SolrQuery - - - - &reftitle.seealso; - - SolrQuery::setGroup - SolrQuery::addGroupField - SolrQuery::addGroupFunction - SolrQuery::addGroupSortField - SolrQuery::setGroupFacet - SolrQuery::setGroupOffset - SolrQuery::setGroupLimit - SolrQuery::setGroupMain - SolrQuery::setGroupNGroups - SolrQuery::setGroupTruncate - SolrQuery::setGroupFormat - SolrQuery::setGroupCachePercent - - - - - diff --git a/reference/solr/solrquery/addgroupsortfield.xml b/reference/solr/solrquery/addgroupsortfield.xml deleted file mode 100644 index f916cd2f4e..0000000000 --- a/reference/solr/solrquery/addgroupsortfield.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - SolrQuery::addGroupSortField - Añade un campo de ordenación de grupo (argumento group.sort) - - - - &reftitle.description; - - public SolrQuerySolrQuery::addGroupSortField - stringfield - intorder - - - Permite ordenar los documentos de grupo, utilizando el campo de ordenación de grupo (argumento group.sort). - - - - - - &reftitle.parameters; - - - field - - - El nombre del campo - - - - - order - - - Orden ASC/DESC, utiliza las constantes SolrQuery::ORDER_*. - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo de <function>SolrQuery::addGroupSortField</function> - -setGroup(true) - ->addGroupSortField('price', SolrQuery::ORDER_ASC); - -echo $solrQuery; -?> -]]> - - &example.outputs.similar; - - - - - - - &reftitle.seealso; - - SolrQuery::setGroup - SolrQuery::addGroupField - SolrQuery::addGroupFunction - SolrQuery::addGroupQuery - SolrQuery::setGroupFacet - SolrQuery::setGroupOffset - SolrQuery::setGroupLimit - SolrQuery::setGroupMain - SolrQuery::setGroupNGroups - SolrQuery::setGroupTruncate - SolrQuery::setGroupFormat - SolrQuery::setGroupCachePercent - - - - - diff --git a/reference/solr/solrquery/addhighlightfield.xml b/reference/solr/solrquery/addhighlightfield.xml deleted file mode 100644 index b73443bab6..0000000000 --- a/reference/solr/solrquery/addhighlightfield.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::addHighlightField - Mapea a hl.fl - - - - &reftitle.description; - - public SolrQuerySolrQuery::addHighlightField - stringfield - - - Mapea a hl.fl. Se usa para especificar que los trozos resaltados deberían ser generados para un campo en particular - - - - - - &reftitle.parameters; - - - - field - - - Nombre del campo - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usa el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/addmltfield.xml b/reference/solr/solrquery/addmltfield.xml deleted file mode 100644 index c2606d9079..0000000000 --- a/reference/solr/solrquery/addmltfield.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - SolrQuery::addMltField - Establece un campo para usarlo para similitud - - - - &reftitle.description; - - public SolrQuerySolrQuery::addMltField - stringfield - - - Mapea a mlt.fl. Especifica que un campo debería ser usado para similitud. - - - - - &reftitle.parameters; - - - - field - - - El nombre del campo - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usa el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/addmltqueryfield.xml b/reference/solr/solrquery/addmltqueryfield.xml deleted file mode 100644 index 5503ec0bd6..0000000000 --- a/reference/solr/solrquery/addmltqueryfield.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - SolrQuery::addMltQueryField - Mapea a mlt.qf - - - - &reftitle.description; - - public SolrQuerySolrQuery::addMltQueryField - stringfield - floatboost - - - Mapea a mlt.qf. Se usa para especificar campos de consultas y sus boosts - - - - - - &reftitle.parameters; - - - - field - - - El nombre del campo - - - - - boost - - - Su valor boost - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usa el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/addsortfield.xml b/reference/solr/solrquery/addsortfield.xml deleted file mode 100644 index a232ced51c..0000000000 --- a/reference/solr/solrquery/addsortfield.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - SolrQuery::addSortField - Usado para controlar cómo deberían ordenarse los resultados - - - - &reftitle.description; - - public SolrQuerySolrQuery::addSortField - stringfield - intorderSolrQuery::ORDER_DESC - - - Usado para controlar cómo deberían ordenarse los resultados. - - - - - - &reftitle.parameters; - - - - field - - - El nombre del campo - - - - - order - - - La dirección de ordenación. Debería ser SolrQuery::ORDER_ASC o SolrQuery::ORDER_DESC. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual. - - - - - - diff --git a/reference/solr/solrquery/addstatsfacet.xml b/reference/solr/solrquery/addstatsfacet.xml deleted file mode 100644 index 152dff5049..0000000000 --- a/reference/solr/solrquery/addstatsfacet.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::addStatsFacet - Recupera una devolución de subresultados para valores dentro de la faceta dada - - - - &reftitle.description; - - public SolrQuerySolrQuery::addStatsFacet - stringfield - - - Recupera una devolución de subresultados para valores dentro de la faceta dada. Mapea al campo stats.facet - - - - - - &reftitle.parameters; - - - - field - - - El nombre del campo - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usa el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/addstatsfield.xml b/reference/solr/solrquery/addstatsfield.xml deleted file mode 100644 index 8fd0372c09..0000000000 --- a/reference/solr/solrquery/addstatsfield.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::addStatsField - Mapea al parámetro stats.field - - - - &reftitle.description; - - public SolrQuerySolrQuery::addStatsField - stringfield - - - Mapea al parámetro stats.field. Este método añade otro parámetro stats.field. - - - - - - &reftitle.parameters; - - - - field - - - El nombre del campo - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usa el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/collapse.xml b/reference/solr/solrquery/collapse.xml deleted file mode 100644 index a0c4915094..0000000000 --- a/reference/solr/solrquery/collapse.xml +++ /dev/null @@ -1,367 +0,0 @@ - - - - - - SolrQuery::collapse - Reduce el resultado a un solo documento por grupo - - - - &reftitle.description; - - public SolrQuerySolrQuery::collapse - SolrCollapseFunctioncollapseFunction - - - Reduce el resultado a un solo documento por grupo antes de transmitirlo - a los demás componentes de búsqueda. - - - De esta manera, todos los componentes posteriores (faceteo, resaltado, etc...) - funcionarán con el resultado reducido. - - - - - - &reftitle.parameters; - - - - collapseFunction - - - - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual - - - - &reftitle.examples; - - Ejemplo de <methodname>SolrQuery::collapse</methodname> - - SOLR_SERVER_HOSTNAME, - 'login' => SOLR_SERVER_USERNAME, - 'password' => SOLR_SERVER_PASSWORD, - 'port' => SOLR_SERVER_PORT, - 'path' => SOLR_SERVER_PATH -); - -$client = new SolrClient($options); - -$query = new SolrQuery('*:*'); - -$collapseFunction = new SolrCollapseFunction('manu_id_s'); - -$collapseFunction -->setSize(2) -->setNullPolicy(SolrCollapseFunction::NULLPOLICY_IGNORE); - -$query -->collapse($collapseFunction) -->setRows(4); - -$queryResponse = $client->query($query); - -$response = $queryResponse->getResponse(); - -print_r($response); - -?> -]]> - - &example.outputs.similar; - - SolrObject Object - ( - [status] => 0 - [QTime] => 1 - [params] => SolrObject Object - ( - [q] => *:* - [indent] => on - [fq] => {!collapse field=manu_id_s size=2 nullPolicy=ignore} - [rows] => 4 - [version] => 2.2 - [wt] => xml - ) - - ) - - [response] => SolrObject Object - ( - [numFound] => 14 - [start] => 0 - [docs] => Array - ( - [0] => SolrObject Object - ( - [id] => SP2514N - [name] => Array - ( - [0] => Samsung SpinPoint P120 SP2514N - hard drive - 250 GB - ATA-133 - ) - - [manu] => Array - ( - [0] => Samsung Electronics Co. Ltd. - ) - - [manu_id_s] => samsung - [cat] => Array - ( - [0] => electronics - [1] => hard drive - ) - - [features] => Array - ( - [0] => 7200RPM, 8MB cache, IDE Ultra ATA-133 - [1] => NoiseGuard, SilentSeek technology, Fluid Dynamic Bearing (FDB) motor - ) - - [price] => Array - ( - [0] => 92 - ) - - [popularity] => Array - ( - [0] => 6 - ) - - [inStock] => Array - ( - [0] => 1 - ) - - [manufacturedate_dt] => 2006-02-13T15:26:37Z - [store] => Array - ( - [0] => 35.0752,-97.032 - ) - - [_version_] => 1510294336412057600 - ) - - [1] => SolrObject Object - ( - [id] => 6H500F0 - [name] => Array - ( - [0] => Maxtor DiamondMax 11 - hard drive - 500 GB - SATA-300 - ) - - [manu] => Array - ( - [0] => Maxtor Corp. - ) - - [manu_id_s] => maxtor - [cat] => Array - ( - [0] => electronics - [1] => hard drive - ) - - [features] => Array - ( - [0] => SATA 3.0Gb/s, NCQ - [1] => 8.5ms seek - [2] => 16MB cache - ) - - [price] => Array - ( - [0] => 350 - ) - - [popularity] => Array - ( - [0] => 6 - ) - - [inStock] => Array - ( - [0] => 1 - ) - - [store] => Array - ( - [0] => 45.17614,-93.87341 - ) - - [manufacturedate_dt] => 2006-02-13T15:26:37Z - [_version_] => 1510294336449806336 - ) - - [2] => SolrObject Object - ( - [id] => F8V7067-APL-KIT - [name] => Array - ( - [0] => Belkin Mobile Power Cord for iPod w/ Dock - ) - - [manu] => Array - ( - [0] => Belkin - ) - - [manu_id_s] => belkin - [cat] => Array - ( - [0] => electronics - [1] => connector - ) - - [features] => Array - ( - [0] => car power adapter, white - ) - - [weight] => Array - ( - [0] => 4 - ) - - [price] => Array - ( - [0] => 19.95 - ) - - [popularity] => Array - ( - [0] => 1 - ) - - [inStock] => Array - ( - [0] => - ) - - [store] => Array - ( - [0] => 45.18014,-93.87741 - ) - - [manufacturedate_dt] => 2005-08-01T16:30:25Z - [_version_] => 1510294336458194944 - ) - - [3] => SolrObject Object - ( - [id] => MA147LL/A - [name] => Array - ( - [0] => Apple 60 GB iPod with Video Playback Black - ) - - [manu] => Array - ( - [0] => Apple Computer Inc. - ) - - [manu_id_s] => apple - [cat] => Array - ( - [0] => electronics - [1] => music - ) - - [features] => Array - ( - [0] => iTunes, Podcasts, Audiobooks - [1] => Stores up to 15,000 songs, 25,000 photos, or 150 hours of video - [2] => 2.5-inch, 320x240 color TFT LCD display with LED backlight - [3] => Up to 20 hours of battery life - [4] => Plays AAC, MP3, WAV, AIFF, Audible, Apple Lossless, H.264 video - [5] => Notes, Calendar, Phone book, Hold button, Date display, Photo wallet, Built-in games, JPEG photo playback, Upgradeable firmware, USB 2.0 compatibility, Playback speed control, Rechargeable capability, Battery level indication - ) - - [includes] => Array - ( - [0] => earbud headphones, USB cable - ) - - [weight] => Array - ( - [0] => 5.5 - ) - - [price] => Array - ( - [0] => 399 - ) - - [popularity] => Array - ( - [0] => 10 - ) - - [inStock] => Array - ( - [0] => 1 - ) - - [store] => Array - ( - [0] => 37.7752,-100.0232 - ) - - [manufacturedate_dt] => 2005-10-12T08:00:00Z - [_version_] => 1510294336562003968 - ) - - ) - - ) - -) -]]> - - - - - - diff --git a/reference/solr/solrquery/construct.xml b/reference/solr/solrquery/construct.xml deleted file mode 100644 index a2cf550c13..0000000000 --- a/reference/solr/solrquery/construct.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - - SolrQuery::__construct - Constructor - - - - &reftitle.description; - - public SolrQuery::__construct - stringq - - - Constructor. - - - - - - &reftitle.parameters; - - - - q - - - Consulta de búsqueda opcional - - - - - - - - - &reftitle.returnvalues; - - Ninguno. - - - - &reftitle.errors; - - Emite una SolrIllegalArgumentException en caso de proporcionar un parámetro no válido. - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL solr 2.0.0 - - Si q fuera inválido, se lanza una - SolrIllegalArgumentException. Anteriormente se emitía un error. - - - - - - - - - - diff --git a/reference/solr/solrquery/destruct.xml b/reference/solr/solrquery/destruct.xml deleted file mode 100644 index c34212bd4b..0000000000 --- a/reference/solr/solrquery/destruct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrQuery::__destruct - Destructor - - - - &reftitle.description; - - public SolrQuery::__destruct - - - - Destructor - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Nada. - - - - - - diff --git a/reference/solr/solrquery/getexpand.xml b/reference/solr/solrquery/getexpand.xml deleted file mode 100644 index ad454a3040..0000000000 --- a/reference/solr/solrquery/getexpand.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - SolrQuery::getExpand - Devuelve true si la extensión de grupo está activada - - - - &reftitle.description; - - public boolSolrQuery::getExpand - - - - Devuelve &true; si la extensión de grupo está activada. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve si la extensión de grupo está activada. - - - - - - diff --git a/reference/solr/solrquery/getexpandfilterqueries.xml b/reference/solr/solrquery/getexpandfilterqueries.xml deleted file mode 100644 index 3215512aa9..0000000000 --- a/reference/solr/solrquery/getexpandfilterqueries.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrQuery::getExpandFilterQueries - Devuelve las consultas de filtro de expansión - - - - &reftitle.description; - - public arraySolrQuery::getExpandFilterQueries - - - - Devuelve las consultas de filtro de expansión. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve las consultas de filtro de expansión. - - - - - - diff --git a/reference/solr/solrquery/getexpandquery.xml b/reference/solr/solrquery/getexpandquery.xml deleted file mode 100644 index 8583078e50..0000000000 --- a/reference/solr/solrquery/getexpandquery.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - SolrQuery::getExpandQuery - Devuelve el parámetro de consulta de expansión expand.q - - - - &reftitle.description; - - public arraySolrQuery::getExpandQuery - - - - Devuelve el parámetro de consulta de expansión expand.q. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la consulta de expansión. - - - - - - diff --git a/reference/solr/solrquery/getexpandrows.xml b/reference/solr/solrquery/getexpandrows.xml deleted file mode 100644 index 4412ab4bef..0000000000 --- a/reference/solr/solrquery/getexpandrows.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SolrQuery::getExpandRows - Devuelve el número de filas a mostrar en cada grupo (expand.rows) - - - - &reftitle.description; - - public intSolrQuery::getExpandRows - - - - Devuelve el número de filas a mostrar en cada grupo (expand.rows). - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el número de filas. - - - - - - diff --git a/reference/solr/solrquery/getexpandsortfields.xml b/reference/solr/solrquery/getexpandsortfields.xml deleted file mode 100644 index 1a1463f038..0000000000 --- a/reference/solr/solrquery/getexpandsortfields.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - SolrQuery::getExpandSortFields - Devuelve un array de campos - - - - &reftitle.description; - - public arraySolrQuery::getExpandSortFields - - - - Devuelve un array de campos. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un array de campos. - - - - - - diff --git a/reference/solr/solrquery/getfacet.xml b/reference/solr/solrquery/getfacet.xml deleted file mode 100644 index 841813d16c..0000000000 --- a/reference/solr/solrquery/getfacet.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - SolrQuery::getFacet - Devuelve el valor del parámetro facet - - - - &reftitle.description; - - public boolSolrQuery::getFacet - - - - Devuelve el valor del parámetro facet. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve un boolean en caso de éxito y &null; si no se estableció - - - - - - - diff --git a/reference/solr/solrquery/getfacetdateend.xml b/reference/solr/solrquery/getfacetdateend.xml deleted file mode 100644 index 4f996deff5..0000000000 --- a/reference/solr/solrquery/getfacetdateend.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - SolrQuery::getFacetDateEnd - Devuelve el valor del parámetro facet.date.end - - - - &reftitle.description; - - public stringSolrQuery::getFacetDateEnd - stringfield_override - - - Devuelve el valor del parámetro facet.date.end. Este método acepta una sobrescritura opcional de campos - - - - - - &reftitle.parameters; - - - - field_override - - - El nombre del campo - - - - - - - - - &reftitle.returnvalues; - -Devuelve una cadena en caso de éxito y &null; si no se estableció - - - - - - - diff --git a/reference/solr/solrquery/getfacetdatefields.xml b/reference/solr/solrquery/getfacetdatefields.xml deleted file mode 100644 index e9af5a03cf..0000000000 --- a/reference/solr/solrquery/getfacetdatefields.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrQuery::getFacetDateFields - Devuelve todos los campos de facet.date - - - - &reftitle.description; - - public arraySolrQuery::getFacetDateFields - - - Devuelve todos los campos de facet.date - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve todos los campos de facet.date como matriz o &null; si no se estableció nada - - - - - - - diff --git a/reference/solr/solrquery/getfacetdategap.xml b/reference/solr/solrquery/getfacetdategap.xml deleted file mode 100644 index 0ec7454a4f..0000000000 --- a/reference/solr/solrquery/getfacetdategap.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - SolrQuery::getFacetDateGap - Devuelve el valor del parámetro facet.date.gap - - - - &reftitle.description; - - public stringSolrQuery::getFacetDateGap - stringfield_override - - - Devuelve el valor del parámetro facet.date.gap. Acepta una sobrescritura opcional de campos - - - - - - &reftitle.parameters; - - - - field_override - - - El nombre del campo - - - - - - - - - &reftitle.returnvalues; - -Devuelve una cadena en caso de éxito y &null; si no se estabelció - - - - - - - diff --git a/reference/solr/solrquery/getfacetdatehardend.xml b/reference/solr/solrquery/getfacetdatehardend.xml deleted file mode 100644 index e8badfc540..0000000000 --- a/reference/solr/solrquery/getfacetdatehardend.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::getFacetDateHardEnd - Devuelve el valor del parámetro facet.date.hardend - - - - &reftitle.description; - - public stringSolrQuery::getFacetDateHardEnd - stringfield_override - - - Devuelve el valor del parámetro facet.date.hardend. Acepta una sobrescritura opcional de campos - - - - - - &reftitle.parameters; - - - - field_override - - - El nombre del campo - - - - - - - - - &reftitle.returnvalues; - -Devuelve una cadena en caso de éxito y &null; si no se estableció - - - - - - diff --git a/reference/solr/solrquery/getfacetdateother.xml b/reference/solr/solrquery/getfacetdateother.xml deleted file mode 100644 index 788688d8a9..0000000000 --- a/reference/solr/solrquery/getfacetdateother.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - SolrQuery::getFacetDateOther - Devuelve el valor del parámetro facet.date.other - - - - &reftitle.description; - - public arraySolrQuery::getFacetDateOther - stringfield_override - - - Devuelve el valor del parámetro facet.date.other. Este método acepta una sobrescritura opcional de campos. - - - - - - &reftitle.parameters; - - - - field_override - - - El nombre del campo - - - - - - - - - &reftitle.returnvalues; - - Devuelve un &array; en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/getfacetdatestart.xml b/reference/solr/solrquery/getfacetdatestart.xml deleted file mode 100644 index 6b8af70823..0000000000 --- a/reference/solr/solrquery/getfacetdatestart.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - SolrQuery::getFacetDateStart - Devuelve el límite inferior del primer rango de datos para todas las facetas de fecha de este campo - - - - &reftitle.description; - - public stringSolrQuery::getFacetDateStart - stringfield_override - - - Devuelve el límite inferior del primer rango de datos para todas las facetas de fecha de este campo. Acepta una sobrescritura opcional de campos - - - - - &reftitle.parameters; - - - - field_override - - - El nombre del campo - - - - - - - - - &reftitle.returnvalues; - -Devuelve una cadena en caso de éxito y &null; si no se estableció - - - - - - diff --git a/reference/solr/solrquery/getfacetfields.xml b/reference/solr/solrquery/getfacetfields.xml deleted file mode 100644 index e147774e27..0000000000 --- a/reference/solr/solrquery/getfacetfields.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - SolrQuery::getFacetFields - Devuelve todos los campos facet - - - - &reftitle.description; - - public arraySolrQuery::getFacetFields - - - - Devuelve todos los campos facet - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve una matriz de todos los campos y &null; si no se estableció nada - - - - - diff --git a/reference/solr/solrquery/getfacetlimit.xml b/reference/solr/solrquery/getfacetlimit.xml deleted file mode 100644 index 0bce88d3d9..0000000000 --- a/reference/solr/solrquery/getfacetlimit.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::getFacetLimit - Devuelve el número máximo de restricciones que deberían ser devueltas por los campos facet - - - - &reftitle.description; - - public intSolrQuery::getFacetLimit - stringfield_override - - - Devuelve el número máximo de restricciones que deberían ser devueltas por los campos facet. Este método acepta una sobrescritura opcional de campos - - - - - - &reftitle.parameters; - - - - field_override - - - El nombre del campo a sobrescribir. - - - - - - - - - &reftitle.returnvalues; - -Devuelve un entero en caso de éxito y &null; si no se estableció - - - - - - diff --git a/reference/solr/solrquery/getfacetmethod.xml b/reference/solr/solrquery/getfacetmethod.xml deleted file mode 100644 index 9d75730365..0000000000 --- a/reference/solr/solrquery/getfacetmethod.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - SolrQuery::getFacetMethod - Devuelve el valor del parámetro facet.method - - - - &reftitle.description; - - public stringSolrQuery::getFacetMethod - stringfield_override - - - Devuelve el valor del parámetro facet.method. Acepta una sobrescritura opcional de campos. - - - - - - &reftitle.parameters; - - - - field_override - - - El nombre del campo - - - - - - - - - &reftitle.returnvalues; - - Devuelve una cadena en caso de éxito y &null; si no se establece - - - - - - - diff --git a/reference/solr/solrquery/getfacetmincount.xml b/reference/solr/solrquery/getfacetmincount.xml deleted file mode 100644 index 210c56a335..0000000000 --- a/reference/solr/solrquery/getfacetmincount.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::getFacetMinCount - Devuelve el mínimo de facetas que deberían ser incluidas en la respuesta - - - - &reftitle.description; - - public intSolrQuery::getFacetMinCount - stringfield_override - - - Devuelve el mínimo de facetas que deberían ser incluidas en la respuesta. Acepta una sobrescritura opcional de campos - - - - - - &reftitle.parameters; - - - - field_override - - - El nombre del campo - - - - - - - - - &reftitle.returnvalues; - -Devuelve un entero en caso de éxito y &null; si no se estableció - - - - - - diff --git a/reference/solr/solrquery/getfacetmissing.xml b/reference/solr/solrquery/getfacetmissing.xml deleted file mode 100644 index b9b87fe3a8..0000000000 --- a/reference/solr/solrquery/getfacetmissing.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - SolrQuery::getFacetMissing - Devuelve el estado acutual del parámetro facet.missing - - - - &reftitle.description; - - public boolSolrQuery::getFacetMissing - stringfield_override - - - Devuelve el estado acutual del parámetro facet.missing. Acepta una sobrescritura opcional de campos - - - - - - &reftitle.parameters; - - - - field_override - - - El nombre del campo - - - - - - - - - &reftitle.returnvalues; - -Devuelve un booleano en caso de éxito y &null; si no se estableció - - - - - - - diff --git a/reference/solr/solrquery/getfacetoffset.xml b/reference/solr/solrquery/getfacetoffset.xml deleted file mode 100644 index b1319a8219..0000000000 --- a/reference/solr/solrquery/getfacetoffset.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::getFacetOffset - Devuelve un índice dentro de la lista de restricciones para ser usado en paginación - - - - &reftitle.description; - - public intSolrQuery::getFacetOffset - stringfield_override - - - Devuelve un índice dentro de la lista de restricciones para ser usado en paginación. Acepta una sobrescritura opcional de campos - - - - - - &reftitle.parameters; - - - - field_override - - - El nombre del campo a sobrescribir. - - - - - - - - - &reftitle.returnvalues; - -Devuelve un entero en caso de éxito y &null; si no se estableció - - - - - - diff --git a/reference/solr/solrquery/getfacetprefix.xml b/reference/solr/solrquery/getfacetprefix.xml deleted file mode 100644 index 6bdc325802..0000000000 --- a/reference/solr/solrquery/getfacetprefix.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - SolrQuery::getFacetPrefix - Devuelve el prefijo de faceta - - - - &reftitle.description; - - public stringSolrQuery::getFacetPrefix - stringfield_override - - - Devuelve el prefijo de faceta - - - - - - &reftitle.parameters; - - - - field_override - - - El nombre del campo - - - - - - - - - &reftitle.returnvalues; - -Devuelve una cadena en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/getfacetqueries.xml b/reference/solr/solrquery/getfacetqueries.xml deleted file mode 100644 index d93b2a3724..0000000000 --- a/reference/solr/solrquery/getfacetqueries.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrQuery::getFacetQueries - Devuelve todas las consultas de facetas - - - - &reftitle.description; - - public arraySolrQuery::getFacetQueries - - - -Devuelve todas las consultas de facetas - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve una matriz en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/getfacetsort.xml b/reference/solr/solrquery/getfacetsort.xml deleted file mode 100644 index b9209e88c6..0000000000 --- a/reference/solr/solrquery/getfacetsort.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::getFacetSort - Devuelve el tipo de ordenación de la faceta - - - - &reftitle.description; - - public intSolrQuery::getFacetSort - stringfield_override - - - Devuelve un entero (SolrQuery::FACET_SORT_INDEX o SolrQuery::FACET_SORT_COUNT) - - - - - - &reftitle.parameters; - - - - field_override - - - El nombre del campo - - - - - - - - - &reftitle.returnvalues; - - Devuelve un entero (SolrQuery::FACET_SORT_INDEX o SolrQuery::FACET_SORT_COUNT) en caso de éxito o &null; si no se estableció. - - - - - - diff --git a/reference/solr/solrquery/getfields.xml b/reference/solr/solrquery/getfields.xml deleted file mode 100644 index dd393fd83a..0000000000 --- a/reference/solr/solrquery/getfields.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - SolrQuery::getFields - Devuelve la lista de campos que serán devueltos en la respuesta - - - - &reftitle.description; - - public arraySolrQuery::getFields - - - - Devuelve la lista de campos que serán devueltos en la respuesta - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve una matriz en caso de éxito y &null; si no se estableció. - - - - - diff --git a/reference/solr/solrquery/getfilterqueries.xml b/reference/solr/solrquery/getfilterqueries.xml deleted file mode 100644 index b95fa44654..0000000000 --- a/reference/solr/solrquery/getfilterqueries.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrQuery::getFilterQueries - Devuelve una matriz de consultas de filtro - - - - &reftitle.description; - - public arraySolrQuery::getFilterQueries - - - - Devuelve una matriz de consultas de filtro. Éstas son consultas que se pueden usar para restringir el superconjunto de documentos que pueden ser devueltos, sin influenciar en el resutlado - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve una matriz en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/getgroup.xml b/reference/solr/solrquery/getgroup.xml deleted file mode 100644 index e45d306cab..0000000000 --- a/reference/solr/solrquery/getgroup.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrQuery::getGroup - Indica si el agrupamiento está activado - - - - &reftitle.description; - - public boolSolrQuery::getGroup - - - - Se devuelve true si el agrupamiento está activado. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::setGroup - - - - - - diff --git a/reference/solr/solrquery/getgroupcachepercent.xml b/reference/solr/solrquery/getgroupcachepercent.xml deleted file mode 100644 index 99c16b9285..0000000000 --- a/reference/solr/solrquery/getgroupcachepercent.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrQuery::getGroupCachePercent - Devuelve el valor del porcentaje de caché de grupo - - - - &reftitle.description; - - public intSolrQuery::getGroupCachePercent - - - - Devuelve el valor del porcentaje de caché de grupo. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::setGroupCachePercent - - - - - - diff --git a/reference/solr/solrquery/getgroupfacet.xml b/reference/solr/solrquery/getgroupfacet.xml deleted file mode 100644 index 62045a9865..0000000000 --- a/reference/solr/solrquery/getgroupfacet.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrQuery::getGroupFacet - Devuelve el valor del parámetro group.facet - - - - &reftitle.description; - - public boolSolrQuery::getGroupFacet - - - - Devuelve el valor del parámetro group.facet. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::setGroupFacet - - - - - - diff --git a/reference/solr/solrquery/getgroupfields.xml b/reference/solr/solrquery/getgroupfields.xml deleted file mode 100644 index defe050184..0000000000 --- a/reference/solr/solrquery/getgroupfields.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrQuery::getGroupFields - Devuelve los campos de grupo (valores del argumento group.field) - - - - &reftitle.description; - - public arraySolrQuery::getGroupFields - - - - Devuelve los campos de grupo (valores del argumento group.field). - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::addGroupField - - - - - - diff --git a/reference/solr/solrquery/getgroupformat.xml b/reference/solr/solrquery/getgroupformat.xml deleted file mode 100644 index ddad68ca2f..0000000000 --- a/reference/solr/solrquery/getgroupformat.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrQuery::getGroupFormat - Devuelve el valor de group.format - - - - &reftitle.description; - - public stringSolrQuery::getGroupFormat - - - - Devuelve el valor de group.format. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::setGroupFormat - - - - - - diff --git a/reference/solr/solrquery/getgroupfunctions.xml b/reference/solr/solrquery/getgroupfunctions.xml deleted file mode 100644 index 6a66fe1522..0000000000 --- a/reference/solr/solrquery/getgroupfunctions.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - SolrQuery::getGroupFunctions - Devuelve las funciones de grupo (valores del argumento group.func) - - - - &reftitle.description; - - public arraySolrQuery::getGroupFunctions - - - - Devuelve las funciones de grupo (valores del argumento group.func). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::addGroupFunction - - - - - - diff --git a/reference/solr/solrquery/getgrouplimit.xml b/reference/solr/solrquery/getgrouplimit.xml deleted file mode 100644 index 8ac22e0042..0000000000 --- a/reference/solr/solrquery/getgrouplimit.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - SolrQuery::getGroupLimit - Devuelve el valor de group.limit - - - - &reftitle.description; - - public intSolrQuery::getGroupLimit - - - - Devuelve el valor de group.limit. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::setGroupLimit - - - - - - diff --git a/reference/solr/solrquery/getgroupmain.xml b/reference/solr/solrquery/getgroupmain.xml deleted file mode 100644 index 5458a71bf7..0000000000 --- a/reference/solr/solrquery/getgroupmain.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - SolrQuery::getGroupMain - Devuelve el valor de group.main - - - - &reftitle.description; - - public boolSolrQuery::getGroupMain - - - - Devuelve el valor de group.main. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::setGroupMain - - - - - - diff --git a/reference/solr/solrquery/getgroupngroups.xml b/reference/solr/solrquery/getgroupngroups.xml deleted file mode 100644 index 9de22a299d..0000000000 --- a/reference/solr/solrquery/getgroupngroups.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - SolrQuery::getGroupNGroups - Devuelve el valor de group.ngroups - - - - &reftitle.description; - - public boolSolrQuery::getGroupNGroups - - - - Devuelve el valor de group.ngroups. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::setGroupNGroups - - - - - - diff --git a/reference/solr/solrquery/getgroupoffset.xml b/reference/solr/solrquery/getgroupoffset.xml deleted file mode 100644 index 7125dacdd4..0000000000 --- a/reference/solr/solrquery/getgroupoffset.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - SolrQuery::getGroupOffset - Devuelve el valor de group.offset - - - - &reftitle.description; - - public intSolrQuery::getGroupOffset - - - - Devuelve el valor de group.offset. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::setGroupOffset - - - - - - diff --git a/reference/solr/solrquery/getgroupqueries.xml b/reference/solr/solrquery/getgroupqueries.xml deleted file mode 100644 index 4b3fd7d936..0000000000 --- a/reference/solr/solrquery/getgroupqueries.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrQuery::getGroupQueries - Devuelve todos los valores del parámetro group.query - - - - &reftitle.description; - - public arraySolrQuery::getGroupQueries - - - - Devuelve todos los valores del parámetro group.query. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - array - - - - - &reftitle.seealso; - - SolrQuery::addGroupQuery - - - - - - diff --git a/reference/solr/solrquery/getgroupsortfields.xml b/reference/solr/solrquery/getgroupsortfields.xml deleted file mode 100644 index 8ce69847e4..0000000000 --- a/reference/solr/solrquery/getgroupsortfields.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrQuery::getGroupSortFields - Devuelve el valor de group.sort - - - - &reftitle.description; - - public arraySolrQuery::getGroupSortFields - - - - Devuelve el valor de group.sort. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::addGroupSortField - - - - - - diff --git a/reference/solr/solrquery/getgrouptruncate.xml b/reference/solr/solrquery/getgrouptruncate.xml deleted file mode 100644 index ec2975fa21..0000000000 --- a/reference/solr/solrquery/getgrouptruncate.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - SolrQuery::getGroupTruncate - Devuelve el valor de group.truncate - - - - &reftitle.description; - - public boolSolrQuery::getGroupTruncate - - - - Devuelve el valor de group.truncate. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::setGroupTruncate - - - - - - diff --git a/reference/solr/solrquery/gethighlight.xml b/reference/solr/solrquery/gethighlight.xml deleted file mode 100644 index 23cd462d4b..0000000000 --- a/reference/solr/solrquery/gethighlight.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - SolrQuery::getHighlight - Devuelve el estado del parámtero hl - - - - &reftitle.description; - - public boolSolrQuery::getHighlight - - - - Devuelve un booleano que indica si se deben generar fragmentos destacados en la respuesta de la consulta. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve un booleano en caso de éxito y &null; si no se estableció - - - - - - - diff --git a/reference/solr/solrquery/gethighlightalternatefield.xml b/reference/solr/solrquery/gethighlightalternatefield.xml deleted file mode 100644 index 20990e0cbe..0000000000 --- a/reference/solr/solrquery/gethighlightalternatefield.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - SolrQuery::getHighlightAlternateField - Devuelve el campo remarcado para usarlo como copia de seguridad o como predeterminado - - - - &reftitle.description; - - public stringSolrQuery::getHighlightAlternateField - stringfield_override - - - Devuelve el campo remarcado para usarlo como copia de seguridad o como predeterminado. Acepta una sobrescritura opcional. - - - - - - &reftitle.parameters; - - - - field_override - - - El nombre del campo - - - - - - - - - &reftitle.returnvalues; - -Devuelve una cadena en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightfields.xml b/reference/solr/solrquery/gethighlightfields.xml deleted file mode 100644 index b3c051646f..0000000000 --- a/reference/solr/solrquery/gethighlightfields.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrQuery::getHighlightFields - Devuelve todos los campos que Solr debería generar para remarcación de trozos - - - - &reftitle.description; - - public arraySolrQuery::getHighlightFields - - - - Devuelve todos los campos que Solr debería generar para remarcación de trozos - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve una matriz en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightformatter.xml b/reference/solr/solrquery/gethighlightformatter.xml deleted file mode 100644 index 56feb12e34..0000000000 --- a/reference/solr/solrquery/gethighlightformatter.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::getHighlightFormatter - Devuelve el formateador de la salida remarcada - - - - &reftitle.description; - - public stringSolrQuery::getHighlightFormatter - stringfield_override - - - Devuelve el formateador de la salida remarcada - - - - - - &reftitle.parameters; - - - - field_override - - - El nombre del campo - - - - - - - - - &reftitle.returnvalues; - -Devuelve una cadena en caso de éxito y &null; si no se estableció. - - - - - - diff --git a/reference/solr/solrquery/gethighlightfragmenter.xml b/reference/solr/solrquery/gethighlightfragmenter.xml deleted file mode 100644 index 99aa333146..0000000000 --- a/reference/solr/solrquery/gethighlightfragmenter.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - SolrQuery::getHighlightFragmenter - Devuelve el generador de trozos de texto para el texto remarcado - - - - &reftitle.description; - - public stringSolrQuery::getHighlightFragmenter - stringfield_override - - - Devuelve el generador de trozos de texto para el texto remarcado. Acepta una sobrescritura opcional de campos. - - - - - - - - &reftitle.parameters; - - - - field_override - - - El nombre del campo - - - - - - - - - &reftitle.returnvalues; - -Devuelve una cadena en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightfragsize.xml b/reference/solr/solrquery/gethighlightfragsize.xml deleted file mode 100644 index 9a298419f2..0000000000 --- a/reference/solr/solrquery/gethighlightfragsize.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - SolrQuery::getHighlightFragsize - Devuelve el número de caracteres de fragmentos a considerar para remarcación - - - - &reftitle.description; - - public intSolrQuery::getHighlightFragsize - stringfield_override - - - Devuelve el número de caracteres de fragmentos a considerar para remarcación. Cero implica que no hay fragmentos. Debería usarse el camplo completo. - - - - - - &reftitle.parameters; - - - - field_override - - - El nombre del campo - - - - - - - - - &reftitle.returnvalues; - -Devuelve un entero en caso de éxito o &null; si no se estableció - - - - - diff --git a/reference/solr/solrquery/gethighlighthighlightmultiterm.xml b/reference/solr/solrquery/gethighlighthighlightmultiterm.xml deleted file mode 100644 index 08b7634de0..0000000000 --- a/reference/solr/solrquery/gethighlighthighlightmultiterm.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrQuery::getHighlightHighlightMultiTerm - Devuelve si habilitar o no la remarcación de consultas range/wildcard/fuzzy/prefix - - - - &reftitle.description; - - public boolSolrQuery::getHighlightHighlightMultiTerm - - - - Devuelve si habilitar o no la remarcación de consultas range/wildcard/fuzzy/prefix - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve un booleano en caso de éxito y &null; si no se estableció - - - - - - - diff --git a/reference/solr/solrquery/gethighlightmaxalternatefieldlength.xml b/reference/solr/solrquery/gethighlightmaxalternatefieldlength.xml deleted file mode 100644 index 82471a541b..0000000000 --- a/reference/solr/solrquery/gethighlightmaxalternatefieldlength.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - SolrQuery::getHighlightMaxAlternateFieldLength - Devuelve el número máximo de caracteres del campo a devolver - - - - &reftitle.description; - - public intSolrQuery::getHighlightMaxAlternateFieldLength - stringfield_override - - - Devuelve el número máximo de caracteres del campo a devolver - - - - - - &reftitle.parameters; - - - - field_override - - - El nombre del campo - - - - - - - - - &reftitle.returnvalues; - -Devuelve un entero en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightmaxanalyzedchars.xml b/reference/solr/solrquery/gethighlightmaxanalyzedchars.xml deleted file mode 100644 index 6e541eb5eb..0000000000 --- a/reference/solr/solrquery/gethighlightmaxanalyzedchars.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrQuery::getHighlightMaxAnalyzedChars - Devuelve el número máximo de caracteres de un documento para buscar trozos adecuados - - - - &reftitle.description; - - public intSolrQuery::getHighlightMaxAnalyzedChars - - - - Devuelve el número máximo de caracteres de un documento para buscar trozos adecuados - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve un entero en caso de éxito y &null; si no se estableció. - - - - - - diff --git a/reference/solr/solrquery/gethighlightmergecontiguous.xml b/reference/solr/solrquery/gethighlightmergecontiguous.xml deleted file mode 100644 index 858a114630..0000000000 --- a/reference/solr/solrquery/gethighlightmergecontiguous.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - SolrQuery::getHighlightMergeContiguous - Devuelve si colapsar o no fragmentos contiguos en un único fragmento - - - - &reftitle.description; - - public boolSolrQuery::getHighlightMergeContiguous - stringfield_override - - - Devuelve si colapsar o no fragmentos contiguos en un único fragmento. Acepta una sobrescritura opcional de campos. - - - - - - &reftitle.parameters; - - - - field_override - - - El nombre del campo - - - - - - - - - &reftitle.returnvalues; - -Devuelve un booleano en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightquery.xml b/reference/solr/solrquery/gethighlightquery.xml deleted file mode 100644 index 6532197aae..0000000000 --- a/reference/solr/solrquery/gethighlightquery.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - SolrQuery::getHighlightQuery - Devuelve la consulta de resaltado - - - - &reftitle.description; - - public stringnullSolrQuery::getHighlightQuery - - - - Devuelve la consulta de resaltado definida previamente mediante el parámetro - hl.q. - Este parámetro permite resaltar términos o campos diferentes de los utilizados para recuperar los documentos. - Véase la sección Highlighting - para más detalles. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una cadena que contiene la consulta de resaltado del - SolrQuery actual, o &null; si la consulta de - resaltado no está definida. - - - - - &reftitle.seealso; - - SolrQuery::setHighlightQuery - SolrQuery::getHighlightFields - SolrQuery::setHighlightFields - - - - diff --git a/reference/solr/solrquery/gethighlightregexmaxanalyzedchars.xml b/reference/solr/solrquery/gethighlightregexmaxanalyzedchars.xml deleted file mode 100644 index 1e6e0d4a9b..0000000000 --- a/reference/solr/solrquery/gethighlightregexmaxanalyzedchars.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - SolrQuery::getHighlightRegexMaxAnalyzedChars - Devuelve el número máximo de caracteres de un campo cuando se usa el fragmentador de expresiones regulares - - - - &reftitle.description; - - public intSolrQuery::getHighlightRegexMaxAnalyzedChars - - - - Devuelve el número máximo de caracteres de un campo cuando se usa el fragmentador de expresiones regulares - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve un entero en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightregexpattern.xml b/reference/solr/solrquery/gethighlightregexpattern.xml deleted file mode 100644 index b689a40198..0000000000 --- a/reference/solr/solrquery/gethighlightregexpattern.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrQuery::getHighlightRegexPattern - Devuelve la expresión regular para la fragmentación - - - - &reftitle.description; - - public stringSolrQuery::getHighlightRegexPattern - - - - Devuelve la expresión regular para la fragmentación - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve una cadena en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightregexslop.xml b/reference/solr/solrquery/gethighlightregexslop.xml deleted file mode 100644 index 4365f866da..0000000000 --- a/reference/solr/solrquery/gethighlightregexslop.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - SolrQuery::getHighlightRegexSlop - Devuelve el factor de desviación del tamaño de fragmento ideal - - - - &reftitle.description; - - public floatSolrQuery::getHighlightRegexSlop - - - - Devuelve el factor por el que el fragmentador de expresiones regulares puede desviar desde el tamaño de fragmeto ideal para acomodar la expresión regular - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un float en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightrequirefieldmatch.xml b/reference/solr/solrquery/gethighlightrequirefieldmatch.xml deleted file mode 100644 index f05b5ee638..0000000000 --- a/reference/solr/solrquery/gethighlightrequirefieldmatch.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - SolrQuery::getHighlightRequireFieldMatch - Devuelve si un campo será remarcado solamente si la consulta coincide con este campo en particular - - - - &reftitle.description; - - public boolSolrQuery::getHighlightRequireFieldMatch - - - - Devuelve si un campo será remarcado solamente si la consulta coincide con este campo en particular. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve un booleano en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightsimplepost.xml b/reference/solr/solrquery/gethighlightsimplepost.xml deleted file mode 100644 index 6ca7df3d30..0000000000 --- a/reference/solr/solrquery/gethighlightsimplepost.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::getHighlightSimplePost - Devuelve el texto que aparece después de un término remarcado - - - - &reftitle.description; - - public stringSolrQuery::getHighlightSimplePost - stringfield_override - - - Devuelve el texto que aparece después de un término remarcado. Acepta una sobrescritura opcional de campos - - - - - &reftitle.parameters; - - - - field_override - - - El nombre del campo - - - - - - - - - &reftitle.returnvalues; - -Devuelve una cadena en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightsimplepre.xml b/reference/solr/solrquery/gethighlightsimplepre.xml deleted file mode 100644 index 0fc0c34084..0000000000 --- a/reference/solr/solrquery/gethighlightsimplepre.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - SolrQuery::getHighlightSimplePre - Devuelve el texto que aparece antes de un término remarcado - - - - &reftitle.description; - - public stringSolrQuery::getHighlightSimplePre - stringfield_override - - - Devuelve el texto que aparece antes de un término remarcado. Acepta una sobrescritura opcional de campos - - - - - - - - &reftitle.parameters; - - - - field_override - - - El nombre del campo - - - - - - - - - &reftitle.returnvalues; - -Devuelve una cadena en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightsnippets.xml b/reference/solr/solrquery/gethighlightsnippets.xml deleted file mode 100644 index e17a64662a..0000000000 --- a/reference/solr/solrquery/gethighlightsnippets.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - SolrQuery::getHighlightSnippets - Devuelve el número máximo de trozos remarcados a generar por campo - - - - &reftitle.description; - - public intSolrQuery::getHighlightSnippets - stringfield_override - - - Devuelve el número máximo de trozos remarcados a generar por campo. Acepta una sobrescritura opcional de campos - - - - - - - - &reftitle.parameters; - - - - field_override - - - El nombre del campo - - - - - - - - - &reftitle.returnvalues; - -Devuelve un entero en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/gethighlightusephrasehighlighter.xml b/reference/solr/solrquery/gethighlightusephrasehighlighter.xml deleted file mode 100644 index 41955aa85c..0000000000 --- a/reference/solr/solrquery/gethighlightusephrasehighlighter.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - SolrQuery::getHighlightUsePhraseHighlighter - Devuelve el estado del parámetro hl.usePhraseHighlighter - - - - &reftitle.description; - - public boolSolrQuery::getHighlightUsePhraseHighlighter - - - - Devuelve si usar o no SpanScorer para remarcar términos de frases sólo cuando aparezcan dentro de la frase de consulta en el documento. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve un booleano en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/getmlt.xml b/reference/solr/solrquery/getmlt.xml deleted file mode 100644 index 1a41391fb5..0000000000 --- a/reference/solr/solrquery/getmlt.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - SolrQuery::getMlt - Devuelve si los resultados MoreLikeThis deberían o no ser habilitados - - - - &reftitle.description; - - public boolSolrQuery::getMlt - - - - Devuelve si los resultados MoreLikeThis deberían o no ser habilitados - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve un booleano en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/getmltboost.xml b/reference/solr/solrquery/getmltboost.xml deleted file mode 100644 index 4f9cf1746b..0000000000 --- a/reference/solr/solrquery/getmltboost.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - SolrQuery::getMltBoost - Devuelve si la consulta será impulsada (boost) o no mediante la relevancia del térmido de interés - - - - &reftitle.description; - - public boolSolrQuery::getMltBoost - - - - Devuelve si la consulta será impulsada (boost) o no mediante la relevancia del térmido de interés - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve un booleano en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/getmltcount.xml b/reference/solr/solrquery/getmltcount.xml deleted file mode 100644 index 584861bc0e..0000000000 --- a/reference/solr/solrquery/getmltcount.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - SolrQuery::getMltCount - Devuelve el número de documentos similares a devolver para cada resultado - - - - &reftitle.description; - - public intSolrQuery::getMltCount - - - - Devuelve el número de documentos similares a devolver para cada resultado - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve un entero en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/getmltfields.xml b/reference/solr/solrquery/getmltfields.xml deleted file mode 100644 index 0586f9b4c6..0000000000 --- a/reference/solr/solrquery/getmltfields.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - SolrQuery::getMltFields - Devuelve todos los campos a usar para similitud - - - - &reftitle.description; - - public arraySolrQuery::getMltFields - - - -Devuelve todos los campos a usar para similitud - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve una matriz en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/getmltmaxnumqueryterms.xml b/reference/solr/solrquery/getmltmaxnumqueryterms.xml deleted file mode 100644 index b54232eaeb..0000000000 --- a/reference/solr/solrquery/getmltmaxnumqueryterms.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrQuery::getMltMaxNumQueryTerms - Devuelve el número máximo de términos de consultas que serán incluidos en cualquier consulta generada - - - - &reftitle.description; - - public intSolrQuery::getMltMaxNumQueryTerms - - - - Devuelve el número máximo de términos de consultas que serán incluidos en cualquier consulta generada - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve un entero en caso de éxito y &null; si no se estableció. - - - - - - diff --git a/reference/solr/solrquery/getmltmaxnumtokens.xml b/reference/solr/solrquery/getmltmaxnumtokens.xml deleted file mode 100644 index deaf8b0d9f..0000000000 --- a/reference/solr/solrquery/getmltmaxnumtokens.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - SolrQuery::getMltMaxNumTokens - Devuelve el número máximo de tokens a analizar en cada campo del documento que no esté almacenado con soporte TermVector - - - - &reftitle.description; - - public intSolrQuery::getMltMaxNumTokens - - - - Devuelve el número máximo de tokens a analizar en cada campo del documento que no esté almacenado con soporte TermVector - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve un entero en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/getmltmaxwordlength.xml b/reference/solr/solrquery/getmltmaxwordlength.xml deleted file mode 100644 index 6834ebdd68..0000000000 --- a/reference/solr/solrquery/getmltmaxwordlength.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrQuery::getMltMaxWordLength - Devuelve la longitud máxima de palabra de las palabras que serán ignoradas - - - - &reftitle.description; - - public intSolrQuery::getMltMaxWordLength - - - - Devuelve la longitud máxima de palabra de las palabras que serán ignoradas - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve un entero en caso de éxito y &null; si no se estableció. - - - - - - diff --git a/reference/solr/solrquery/getmltmindocfrequency.xml b/reference/solr/solrquery/getmltmindocfrequency.xml deleted file mode 100644 index ba5896d0b0..0000000000 --- a/reference/solr/solrquery/getmltmindocfrequency.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - SolrQuery::getMltMinDocFrequency - Devuelve el umbral de frecuencia en el que las palabras que no ocurran en por lo menos tantos documentos como este serán ignoradas - - - - &reftitle.description; - - public intSolrQuery::getMltMinDocFrequency - - - - Devuelve el umbral de frecuencia en el que las palabras que no ocurran en por lo menos tantos documentos como este serán ignoradas - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve un entero en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/getmltmintermfrequency.xml b/reference/solr/solrquery/getmltmintermfrequency.xml deleted file mode 100644 index 524e08cd29..0000000000 --- a/reference/solr/solrquery/getmltmintermfrequency.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - SolrQuery::getMltMinTermFrequency - Devuelve la frecuencia bajo la cual los términos serán ignorados en el documento fuente - - - - &reftitle.description; - - public intSolrQuery::getMltMinTermFrequency - - - - Devuelve la frecuencia bajo la cual los términos serán ignorados en el documento fuente - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve un entero en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/getmltminwordlength.xml b/reference/solr/solrquery/getmltminwordlength.xml deleted file mode 100644 index 2bab2bda50..0000000000 --- a/reference/solr/solrquery/getmltminwordlength.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - SolrQuery::getMltMinWordLength - Devuelve la longitud máxima de palabra bajo la cual las palabras serán ignoradas - - - - &reftitle.description; - - public intSolrQuery::getMltMinWordLength - - - - Devuelve la longitud máxima de palabra bajo la cual las palabras serán ignoradas - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve un entero en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/getmltqueryfields.xml b/reference/solr/solrquery/getmltqueryfields.xml deleted file mode 100644 index 61dfced0c9..0000000000 --- a/reference/solr/solrquery/getmltqueryfields.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - SolrQuery::getMltQueryFields - Devuelve los campos de consultas y sus boosts - - - - &reftitle.description; - - public arraySolrQuery::getMltQueryFields - - - - Devuelve los campos de consultas y sus boosts - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve una matriz en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/getquery.xml b/reference/solr/solrquery/getquery.xml deleted file mode 100644 index 4cf2343537..0000000000 --- a/reference/solr/solrquery/getquery.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - SolrQuery::getQuery - Devuelve la consulta principal - - - - &reftitle.description; - - public stringSolrQuery::getQuery - - - -Devuelve la consulta de búsqueda principal - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve una cadena en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/getrows.xml b/reference/solr/solrquery/getrows.xml deleted file mode 100644 index 2b4758c8e2..0000000000 --- a/reference/solr/solrquery/getrows.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - SolrQuery::getRows - Devuelve el número máximo de documentos - - - - &reftitle.description; - - public intSolrQuery::getRows - - - - Devuelve el número máximo de documentos del conjunto de resultados completo del cliente para cada consulta - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve un entero en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/getsortfields.xml b/reference/solr/solrquery/getsortfields.xml deleted file mode 100644 index d88711801c..0000000000 --- a/reference/solr/solrquery/getsortfields.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - SolrQuery::getSortFields - Devuelve todos los campos de ordenación - - - - &reftitle.description; - - public arraySolrQuery::getSortFields - - - -Devuelve todos los campos de ordenación - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve una matriz en caso de éxito y &null; si no se estableció ningún parámetro. - - - - - diff --git a/reference/solr/solrquery/getstart.xml b/reference/solr/solrquery/getstart.xml deleted file mode 100644 index 0a81a40c4c..0000000000 --- a/reference/solr/solrquery/getstart.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - SolrQuery::getStart - Devuelve el índice del conjunto de resultados completo - - - - &reftitle.description; - - public intSolrQuery::getStart - - - - Devuelve el índice del conjunto de resultados completo para las consultas donde el conjunto de documentos devueltos debería comenzar. - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve un entero en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/getstats.xml b/reference/solr/solrquery/getstats.xml deleted file mode 100644 index 896f6aadd0..0000000000 --- a/reference/solr/solrquery/getstats.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - SolrQuery::getStats - Devuelve si están habilitadas o no las estadísticas - - - - &reftitle.description; - - public boolSolrQuery::getStats - - - - Devuelve si están habilitadas o no las estadísticas - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve un booleano en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/getstatsfacets.xml b/reference/solr/solrquery/getstatsfacets.xml deleted file mode 100644 index 2c4d467fbb..0000000000 --- a/reference/solr/solrquery/getstatsfacets.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrQuery::getStatsFacets - Devuelve todas las estadísticas de las facetas que fueron establecidas - - - - &reftitle.description; - - public arraySolrQuery::getStatsFacets - - - - Devuelve todas las estadísticas de las facetas que fueron establecidas - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve una matriz en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/getstatsfields.xml b/reference/solr/solrquery/getstatsfields.xml deleted file mode 100644 index db6cf24dc5..0000000000 --- a/reference/solr/solrquery/getstatsfields.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - SolrQuery::getStatsFields - Devuelve todas las estadísticas de los campos - - - - &reftitle.description; - - public arraySolrQuery::getStatsFields - - - - Devuelve todas las estadísticas de los campos - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve una matriz en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/getterms.xml b/reference/solr/solrquery/getterms.xml deleted file mode 100644 index a2fd8d0f1e..0000000000 --- a/reference/solr/solrquery/getterms.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - SolrQuery::getTerms - Devuelve si está habilitado o no TermsComponent - - - - &reftitle.description; - - public boolSolrQuery::getTerms - - - - Devuelve si está habilitado o no TermsComponent - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve un booleano en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/gettermsfield.xml b/reference/solr/solrquery/gettermsfield.xml deleted file mode 100644 index dbeee31cce..0000000000 --- a/reference/solr/solrquery/gettermsfield.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - SolrQuery::getTermsField - Devuelve el campo desde el cuál los términos son recuperados - - - - &reftitle.description; - - public stringSolrQuery::getTermsField - - - - Devuelve el campo desde el cuál los términos son recuperados - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve una cadena en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/gettermsincludelowerbound.xml b/reference/solr/solrquery/gettermsincludelowerbound.xml deleted file mode 100644 index 9d5a844d49..0000000000 --- a/reference/solr/solrquery/gettermsincludelowerbound.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrQuery::getTermsIncludeLowerBound - Devuelve si incluir o no el límite inferior en el conjunto de resultados - - - - &reftitle.description; - - public boolSolrQuery::getTermsIncludeLowerBound - - - - Devuelve si incluir o no el límite inferior en el conjunto de resultados - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve un booleano en caso de éxito y &null; si no se estableció. - - - - - - diff --git a/reference/solr/solrquery/gettermsincludeupperbound.xml b/reference/solr/solrquery/gettermsincludeupperbound.xml deleted file mode 100644 index 8a2eac1ba6..0000000000 --- a/reference/solr/solrquery/gettermsincludeupperbound.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - SolrQuery::getTermsIncludeUpperBound - Devuelve si incluir o no el término de límite superior en el conjunto de resultados - - - - &reftitle.description; - - public boolSolrQuery::getTermsIncludeUpperBound - - - - Devuelve si incluir o no el término de límite superior en el conjunto de resultados - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve un booleano en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/gettermslimit.xml b/reference/solr/solrquery/gettermslimit.xml deleted file mode 100644 index 9a220c07d9..0000000000 --- a/reference/solr/solrquery/gettermslimit.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - SolrQuery::getTermsLimit - Devuelve el número máximo de términos que debería devolver Solr - - - - &reftitle.description; - - public intSolrQuery::getTermsLimit - - - - Devuelve el número máximo de términos que debería devolver Solr - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve un entero en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/gettermslowerbound.xml b/reference/solr/solrquery/gettermslowerbound.xml deleted file mode 100644 index 433823b3e6..0000000000 --- a/reference/solr/solrquery/gettermslowerbound.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - SolrQuery::getTermsLowerBound - Devuelve el término en el que comenzar - - - - &reftitle.description; - - public stringSolrQuery::getTermsLowerBound - - - - Devuelve el término en el que comenzar - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve una cadena en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/gettermsmaxcount.xml b/reference/solr/solrquery/gettermsmaxcount.xml deleted file mode 100644 index e54a451af8..0000000000 --- a/reference/solr/solrquery/gettermsmaxcount.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - SolrQuery::getTermsMaxCount - Devuelve la frecuencia de documento máxima - - - - &reftitle.description; - - public intSolrQuery::getTermsMaxCount - - - - Devuelve la frecuencia de documento máxima - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve un entero en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/gettermsmincount.xml b/reference/solr/solrquery/gettermsmincount.xml deleted file mode 100644 index 0290e17855..0000000000 --- a/reference/solr/solrquery/gettermsmincount.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - SolrQuery::getTermsMinCount - Devuelve la frecuencia de documento mínima a devolver para ser incluido - - - - &reftitle.description; - - public intSolrQuery::getTermsMinCount - - - - Devuelve la frecuencia de documento mínima a devolver para ser incluido - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve un entero en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/gettermsprefix.xml b/reference/solr/solrquery/gettermsprefix.xml deleted file mode 100644 index 8a9ff7f2ff..0000000000 --- a/reference/solr/solrquery/gettermsprefix.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - SolrQuery::getTermsPrefix - Devuelve el prefijo del término - - - - &reftitle.description; - - public stringSolrQuery::getTermsPrefix - - - - Devuelve el prefijo por el que los términos coincedentes deben ser restringidos. Restringirá las coincidencias sólo de los términos que empiecen con el prefijo - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve una cadena en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/gettermsreturnraw.xml b/reference/solr/solrquery/gettermsreturnraw.xml deleted file mode 100644 index 4a56b6123d..0000000000 --- a/reference/solr/solrquery/gettermsreturnraw.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - SolrQuery::getTermsReturnRaw - Si devolver o no caracteres en bruto - - - - &reftitle.description; - - public boolSolrQuery::getTermsReturnRaw - - - - Devuelve un booleano indicando si devolver o no caracteres en bruto del término indexado, sin tener en cuenta si es legible por humanos - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve un booleano en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/gettermssort.xml b/reference/solr/solrquery/gettermssort.xml deleted file mode 100644 index 9d0e9acb43..0000000000 --- a/reference/solr/solrquery/gettermssort.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrQuery::getTermsSort - Devuelve un entero indicando cómo son ordenados los términos - - - - &reftitle.description; - - public intSolrQuery::getTermsSort - - - - SolrQuery::TERMS_SORT_INDEX indica que los términos son devueltos por orden de índice. SolrQuery::TERMS_SORT_COUNT implica que los términos son ordenados según la frecuencia del término (la más alta cuenta como la primera) - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve un entero en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/gettermsupperbound.xml b/reference/solr/solrquery/gettermsupperbound.xml deleted file mode 100644 index 7774c59e88..0000000000 --- a/reference/solr/solrquery/gettermsupperbound.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrQuery::getTermsUpperBound - Devuelve el término en donde parar - - - - &reftitle.description; - - public stringSolrQuery::getTermsUpperBound - - - - Devuelve el término en donde parar - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve una cadena en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/gettimeallowed.xml b/reference/solr/solrquery/gettimeallowed.xml deleted file mode 100644 index 2a26fac212..0000000000 --- a/reference/solr/solrquery/gettimeallowed.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - SolrQuery::getTimeAllowed - Devuelve el tiempo en milisegundos permitido para que la consulta finalice - - - - &reftitle.description; - - public intSolrQuery::getTimeAllowed - - - -Devuelve el tiempo en milisegundos permitido para que la consulta finalice. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - -Devuelve un entero en caso de éxito y &null; si no se estableció. - - - - - - - diff --git a/reference/solr/solrquery/removeexpandfilterquery.xml b/reference/solr/solrquery/removeexpandfilterquery.xml deleted file mode 100644 index 1f9dbf9467..0000000000 --- a/reference/solr/solrquery/removeexpandfilterquery.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - SolrQuery::removeExpandFilterQuery - Elimina una consulta de filtro de extensión - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeExpandFilterQuery - stringfq - - - Elimina una consulta de filtro de extensión. - - - - - - &reftitle.parameters; - - - fq - - - - - - - - - - - &reftitle.returnvalues; - - SolrQuery - - - - - &reftitle.seealso; - - SolrQuery::setExpand - SolrQuery::addExpandSortField - SolrQuery::removeExpandSortField - SolrQuery::setExpandRows - SolrQuery::setExpandQuery - SolrQuery::addExpandFilterQuery - - - - - diff --git a/reference/solr/solrquery/removeexpandsortfield.xml b/reference/solr/solrquery/removeexpandsortfield.xml deleted file mode 100644 index b0a8591624..0000000000 --- a/reference/solr/solrquery/removeexpandsortfield.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - SolrQuery::removeExpandSortField - Elimina un campo de ordenación de expansión del parámetro expand.sort - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeExpandSortField - stringfield - - - Se elimina un campo de ordenación de expansión del parámetro expand.sort. - - - - - &reftitle.parameters; - - - field - - - El nombre del campo - - - - - - - - &reftitle.returnvalues; - - SolrQuery - - - - &reftitle.seealso; - - SolrQuery::setExpand - SolrQuery::addExpandSortField - SolrQuery::setExpandRows - SolrQuery::setExpandQuery - SolrQuery::addExpandFilterQuery - SolrQuery::removeExpandFilterQuery - - - - - diff --git a/reference/solr/solrquery/removefacetdatefield.xml b/reference/solr/solrquery/removefacetdatefield.xml deleted file mode 100644 index bb28b8edc9..0000000000 --- a/reference/solr/solrquery/removefacetdatefield.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::removeFacetDateField - Elimina uno de los campos de faceta de fecha - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeFacetDateField - stringfield - - - El nombre del campo - - - - - - &reftitle.parameters; - - - - field - - - El nombre del campo de fecha a eliminar - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/removefacetdateother.xml b/reference/solr/solrquery/removefacetdateother.xml deleted file mode 100644 index 0e99676f1a..0000000000 --- a/reference/solr/solrquery/removefacetdateother.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - SolrQuery::removeFacetDateOther - Elimina uno de los parámetros facet.date.other - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeFacetDateOther - stringvalue - stringfield_override - - - Elimina uno de los parámetros facet.date.other. - - - - - - &reftitle.parameters; - - - - value - - - El valor - - - - - field_override - - - El nombre del campo. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - - diff --git a/reference/solr/solrquery/removefacetfield.xml b/reference/solr/solrquery/removefacetfield.xml deleted file mode 100644 index 9d93587789..0000000000 --- a/reference/solr/solrquery/removefacetfield.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::removeFacetField - Elimina uno de los parámetros facet.date - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeFacetField - stringfield - - - Elimina uno de los parámetros facet.date. - - - - - - &reftitle.parameters; - - - - field - - - El nombre del campo - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/removefacetquery.xml b/reference/solr/solrquery/removefacetquery.xml deleted file mode 100644 index f0241732bd..0000000000 --- a/reference/solr/solrquery/removefacetquery.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::removeFacetQuery - Elimina uno de los parámetros facet.query - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeFacetQuery - stringvalue - - - Elimina uno de los parámetros facet.query. - - - - - - &reftitle.parameters; - - - - value - - - El valor - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/removefield.xml b/reference/solr/solrquery/removefield.xml deleted file mode 100644 index b976e8cf65..0000000000 --- a/reference/solr/solrquery/removefield.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::removeField - Elimina un campo de la lista de campos - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeField - stringfield - - - Elimina un campo de la lista de campos - - - - - - &reftitle.parameters; - - - - field - - - Nombre del campo. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/removefilterquery.xml b/reference/solr/solrquery/removefilterquery.xml deleted file mode 100644 index e33b93dc7c..0000000000 --- a/reference/solr/solrquery/removefilterquery.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::removeFilterQuery - Elimina una consulta de filtro - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeFilterQuery - stringfq - - - Elimina una consulta de filtro. - - - - - - &reftitle.parameters; - - - - fq - - - La consulta de filtro a eliminar - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/removehighlightfield.xml b/reference/solr/solrquery/removehighlightfield.xml deleted file mode 100644 index 9ca523c7e7..0000000000 --- a/reference/solr/solrquery/removehighlightfield.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::removeHighlightField - Elimina uno de los campos usados para remarcación - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeHighlightField - stringfield - - - Elimina uno de los campos usados para remarcación. - - - - - - &reftitle.parameters; - - - - field - - - El nombre del campo - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/removemltfield.xml b/reference/solr/solrquery/removemltfield.xml deleted file mode 100644 index 77c6c39f84..0000000000 --- a/reference/solr/solrquery/removemltfield.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::removeMltField - Elimina uno de los campos moreLikeThis - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeMltField - stringfield - - - Elimina uno de los campos moreLikeThis. - - - - - - &reftitle.parameters; - - - - field - - - Nombre del campo - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/removemltqueryfield.xml b/reference/solr/solrquery/removemltqueryfield.xml deleted file mode 100644 index 5a9527ffb6..0000000000 --- a/reference/solr/solrquery/removemltqueryfield.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::removeMltQueryField - Elimina uno de los campos de consulta moreLikeThis - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeMltQueryField - stringqueryField - - - Elimina uno de los campos de consulta moreLikeThis. - - - - - - &reftitle.parameters; - - - - queryField - - - El campo de consulta - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/removesortfield.xml b/reference/solr/solrquery/removesortfield.xml deleted file mode 100644 index 53a6712f31..0000000000 --- a/reference/solr/solrquery/removesortfield.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::removeSortField - Elimina uno de los campos de ordenación - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeSortField - stringfield - - - Elimina uno de los campos de ordenación. - - - - - - &reftitle.parameters; - - - - field - - - El nombre del campo - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/removestatsfacet.xml b/reference/solr/solrquery/removestatsfacet.xml deleted file mode 100644 index 5af7961a22..0000000000 --- a/reference/solr/solrquery/removestatsfacet.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::removeStatsFacet - Elimina uno de los parámetros stats.facet - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeStatsFacet - stringvalue - - - Elimina uno de los parámetros stats.facet - - - - - - &reftitle.parameters; - - - - value - - - El valor - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/removestatsfield.xml b/reference/solr/solrquery/removestatsfield.xml deleted file mode 100644 index 5a340b31ac..0000000000 --- a/reference/solr/solrquery/removestatsfield.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::removeStatsField - Elimina uno de los parámetros stats.field - - - - &reftitle.description; - - public SolrQuerySolrQuery::removeStatsField - stringfield - - - Elimina uno de los parámetros stats.field - - - - - - &reftitle.parameters; - - - - field - - - El nombre del campo. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/setechohandler.xml b/reference/solr/solrquery/setechohandler.xml deleted file mode 100644 index df2f6906df..0000000000 --- a/reference/solr/solrquery/setechohandler.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - SolrQuery::setEchoHandler - Conmuta el parámetro echoHandler - - - - &reftitle.description; - - public SolrQuerySolrQuery::setEchoHandler - boolflag - - - Si está establecido a true, Solr coloca los nombres de los gestores usados en la respuesta al cliente para propósitos de depuración. - - - - - &reftitle.parameters; - - - - flag - - - &true; o &false; - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/setechoparams.xml b/reference/solr/solrquery/setechoparams.xml deleted file mode 100644 index 888870f04e..0000000000 --- a/reference/solr/solrquery/setechoparams.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - SolrQuery::setEchoParams - Determina qué tipo de parámetros incluir en la respuesta - - - - &reftitle.description; - - public SolrQuerySolrQuery::setEchoParams - stringtype - - - Ordena a Solr qué tipos de parámetros de solicitud deberían ser incluidos en la respuesta para propósitos de depuración, valores legales incluidos: - - - - - - - - - - - &reftitle.parameters; - - - - type - - - El tipo de parámetros a incluir - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/setexpand.xml b/reference/solr/solrquery/setexpand.xml deleted file mode 100644 index 6c7079296d..0000000000 --- a/reference/solr/solrquery/setexpand.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - SolrQuery::setExpand - Activa/desactiva el componente Expand - - - - &reftitle.description; - - public SolrQuerySolrQuery::setExpand - boolvalue - - - Activa/desactiva el componente Expand. - - - - - - &reftitle.parameters; - - - value - - - Un flag booleano - - - - - - - - &reftitle.returnvalues; - - SolrQuery - - - - - &reftitle.examples; - - Ejemplo de <function>SolrQuery::setExpand</function> - -setExpand(true) - ->setExpandRows(50) - ->setExpandQuery('text:product') - ->addExpandFilterQuery('manu:apple') - ->addExpandFilterQuery('inStock:true') - ->addExpandSortField('score', SolrQuery::ORDER_DESC) - ->addExpandSortField('title', SolrQuery::ORDER_ASC); - -echo $query.PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SolrQuery::addExpandSortField - SolrQuery::removeExpandSortField - SolrQuery::setExpandRows - SolrQuery::setExpandQuery - SolrQuery::addExpandFilterQuery - SolrQuery::removeExpandFilterQuery - - - - - - diff --git a/reference/solr/solrquery/setexpandquery.xml b/reference/solr/solrquery/setexpandquery.xml deleted file mode 100644 index 440fb42281..0000000000 --- a/reference/solr/solrquery/setexpandquery.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - SolrQuery::setExpandQuery - Define el parámetro expand.q - - - - &reftitle.description; - - public SolrQuerySolrQuery::setExpandQuery - stringq - - - Define el parámetro expand.q. - - - Sobrescribe el parámetro principal q, - determina qué documentos incluir en el grupo principal. - - - - - &reftitle.parameters; - - - q - - - - - - - - - - - &reftitle.returnvalues; - - SolrQuery - - - - &reftitle.seealso; - - SolrQuery::setExpand - SolrQuery::addExpandSortField - SolrQuery::removeExpandSortField - SolrQuery::setExpandRows - SolrQuery::addExpandFilterQuery - SolrQuery::removeExpandFilterQuery - - - - - diff --git a/reference/solr/solrquery/setexpandrows.xml b/reference/solr/solrquery/setexpandrows.xml deleted file mode 100644 index 75bb9f58ad..0000000000 --- a/reference/solr/solrquery/setexpandrows.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - SolrQuery::setExpandRows - Define el número de filas a mostrar en cada grupo (expand.rows). Valor por omisión del servidor 5 - - - - &reftitle.description; - - public SolrQuerySolrQuery::setExpandRows - intvalue - - - Define el número de filas a mostrar en cada grupo (expand.rows). Valor por omisión del servidor 5 - - - - - &reftitle.parameters; - - - value - - - - - - - - - - - &reftitle.returnvalues; - - SolrQuery - - - - &reftitle.seealso; - - SolrQuery::setExpand - SolrQuery::addExpandSortField - SolrQuery::removeExpandSortField - SolrQuery::setExpandQuery - SolrQuery::addExpandFilterQuery - SolrQuery::removeExpandFilterQuery - - - - - diff --git a/reference/solr/solrquery/setexplainother.xml b/reference/solr/solrquery/setexplainother.xml deleted file mode 100644 index 16a9b9414b..0000000000 --- a/reference/solr/solrquery/setexplainother.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - SolrQuery::setExplainOther - Establece el parámetro de consulta común explainOther - - - - &reftitle.description; - - public SolrQuerySolrQuery::setExplainOther - stringquery - - - Establece el parámetro de consulta común explainOther - - - - - &reftitle.parameters; - - - - query - - - La consulta Lucene para identificar un conjuntos de documentos - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/setfacet.xml b/reference/solr/solrquery/setfacet.xml deleted file mode 100644 index 76fa6b8ca0..0000000000 --- a/reference/solr/solrquery/setfacet.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::setFacet - Mapea al parámetro facet. Habilita o deshabilta las facetas - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacet - boolflag - - - Habilita o deshabilta las facetas. - - - - - - &reftitle.parameters; - - - - value - - - &true; habilita las facetas y &false; las deshabilita. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/setfacetdateend.xml b/reference/solr/solrquery/setfacetdateend.xml deleted file mode 100644 index cc155179c7..0000000000 --- a/reference/solr/solrquery/setfacetdateend.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - SolrQuery::setFacetDateEnd - Mapea a facet.date.end - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacetDateEnd - stringvalue - stringfield_override - - - Mapea a facet.date.end - - - - - - &reftitle.parameters; - - - - value - - - Véase facet.date.end - - - - - field_override - - - Nombre del campo - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/setfacetdategap.xml b/reference/solr/solrquery/setfacetdategap.xml deleted file mode 100644 index b24e81e0d3..0000000000 --- a/reference/solr/solrquery/setfacetdategap.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - SolrQuery::setFacetDateGap - Mapea a facet.date.gap - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacetDateGap - stringvalue - stringfield_override - - - Mapea a facet.date.gap - - - - - - &reftitle.parameters; - - - - value - - - Véase facet.date.gap - - - - - field_override - - - El nombre del campo - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/setfacetdatehardend.xml b/reference/solr/solrquery/setfacetdatehardend.xml deleted file mode 100644 index 7ce9c2e885..0000000000 --- a/reference/solr/solrquery/setfacetdatehardend.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - SolrQuery::setFacetDateHardEnd - Mapea a facet.date.hardend - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacetDateHardEnd - boolvalue - stringfield_override - - - Mapea a facet.date.hardend - - - - - - &reftitle.parameters; - - - - value - - - Véase facet.date.hardend - - - - - field_override - - - El nombre del campo - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/setfacetdatestart.xml b/reference/solr/solrquery/setfacetdatestart.xml deleted file mode 100644 index 9be2cad0da..0000000000 --- a/reference/solr/solrquery/setfacetdatestart.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - SolrQuery::setFacetDateStart - Mapea a facet.date.start - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacetDateStart - stringvalue - stringfield_override - - - Mapea a facet.date.start - - - - - &reftitle.parameters; - - - - value - - - Véase facet.date.start - - - - - field_override - - - El nombre del campo. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/setfacetenumcachemindefaultfrequency.xml b/reference/solr/solrquery/setfacetenumcachemindefaultfrequency.xml deleted file mode 100644 index 2fc4edd42f..0000000000 --- a/reference/solr/solrquery/setfacetenumcachemindefaultfrequency.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - SolrQuery::setFacetEnumCacheMinDefaultFrequency - Establece la frecuencia de documento mínima usada para determinar la cuenta de términos - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacetEnumCacheMinDefaultFrequency - intfrequency - stringfield_override - - - Establece la frecuencia de documento mínima usada para determinar la cuenta de términos - - - - - &reftitle.parameters; - - - - value - - - La frecuencia mínima - - - - - field_override - - - El nombre del campo. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/setfacetlimit.xml b/reference/solr/solrquery/setfacetlimit.xml deleted file mode 100644 index f37cc5dc8b..0000000000 --- a/reference/solr/solrquery/setfacetlimit.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - SolrQuery::setFacetLimit - Mapea a facet.limit - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacetLimit - intlimit - stringfield_override - - - Mapea a facet.limit. Establece el número máximo de restricciones que deberían ser devueltas por los campos de facetas. - - - - - - &reftitle.parameters; - - - - limit - - - El número máximo de restricciones - - - - - field_override - - - El nombre del campo. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/setfacetmethod.xml b/reference/solr/solrquery/setfacetmethod.xml deleted file mode 100644 index 5dbcb44105..0000000000 --- a/reference/solr/solrquery/setfacetmethod.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - SolrQuery::setFacetMethod - Especifica el tipo de algoritmo a usar cuando se hace una faceta a un campo - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacetMethod - stringmethod - stringfield_override - - - Especifica el tipo de algoritmo a usar cuando se hace una faceta a un campo. Este método acepta la sobrescritura opcional de campos. - - - - - - &reftitle.parameters; - - - - method - - - El método a usar. - - - - - field_override - - - El nombre del campo. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/setfacetmincount.xml b/reference/solr/solrquery/setfacetmincount.xml deleted file mode 100644 index eebdfd7e81..0000000000 --- a/reference/solr/solrquery/setfacetmincount.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - SolrQuery::setFacetMinCount - Mapea a facet.mincount - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacetMinCount - intmincount - stringfield_override - - - Establece el mínimo de campos de faceta que deberían ser incluidos en la respuesta - - - - - - &reftitle.parameters; - - - - mincount - - - El mínimo - - - - - field_override - - - El nombre del campo. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/setfacetmissing.xml b/reference/solr/solrquery/setfacetmissing.xml deleted file mode 100644 index ac6ff2ba9e..0000000000 --- a/reference/solr/solrquery/setfacetmissing.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - SolrQuery::setFacetMissing - Mapea a facet.missing - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacetMissing - boolflag - stringfield_override - - - Usado para indicar que además de las restricciones basdas en términos de un campo de faceta, debería ser computada una cuenta de todos los resultados coincidentes que no tienen valor para el campo - - - - - - &reftitle.parameters; - - - - flag - - - &true; activa esta característica. &false; la desactiva. - - - - - field_override - - - El nombre del campo. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/setfacetoffset.xml b/reference/solr/solrquery/setfacetoffset.xml deleted file mode 100644 index 84ff072566..0000000000 --- a/reference/solr/solrquery/setfacetoffset.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - SolrQuery::setFacetOffset - Establece el índice de la lista de restricciones para tener en cuenta la paginación - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacetOffset - intoffset - stringfield_override - - - Establece el índice de la lista de restricciones para tener en cuenta la paginación. - - - - - - &reftitle.parameters; - - - - offset - - - El índice - - - - - field_override - - - El nombre del campo. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/setfacetprefix.xml b/reference/solr/solrquery/setfacetprefix.xml deleted file mode 100644 index 579ee627e2..0000000000 --- a/reference/solr/solrquery/setfacetprefix.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - SolrQuery::setFacetPrefix - Especifica un prefijo de cadena con el que limitar los términos a los que hacer una faceta - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacetPrefix - stringprefix - stringfield_override - - - Especifica un prefijo de cadena con el que limitar los términos a los que hacer una faceta. - - - - - - &reftitle.parameters; - - - - prefix - - - La cadena de prefijo - - - - - field_override - - - El nombre del campo. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/setfacetsort.xml b/reference/solr/solrquery/setfacetsort.xml deleted file mode 100644 index d32c3404f8..0000000000 --- a/reference/solr/solrquery/setfacetsort.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - SolrQuery::setFacetSort - Determina el orden de las restricciones de campos de faceta - - - - &reftitle.description; - - public SolrQuerySolrQuery::setFacetSort - intfacetSort - stringfield_override - - - Determina el orden de las restricciones de campos de faceta - - - - - - &reftitle.parameters; - - - - facetSort - - - Use SolrQuery::FACET_SORT_INDEX para ordenar por índice o SolrQuery::FACET_SORT_COUNT para ordenar por cuenta. - - - - - field_override - - - El nombre del campo. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/setgroup.xml b/reference/solr/solrquery/setgroup.xml deleted file mode 100644 index efaaa3f6b4..0000000000 --- a/reference/solr/solrquery/setgroup.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - SolrQuery::setGroup - Activa/desactiva el agrupamiento de resultados (parámetro group) - - - - &reftitle.description; - - public SolrQuerySolrQuery::setGroup - boolvalue - - - Activa/desactiva el agrupamiento de resultados (parámetro group). - - - - - &reftitle.parameters; - - - value - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - SolrQuery::getGroup - SolrQuery::addGroupField - SolrQuery::addGroupFunction - SolrQuery::addGroupQuery - SolrQuery::addGroupSortField - SolrQuery::setGroupFacet - SolrQuery::setGroupOffset - SolrQuery::setGroupLimit - SolrQuery::setGroupMain - SolrQuery::setGroupNGroups - SolrQuery::setGroupTruncate - SolrQuery::setGroupFormat - SolrQuery::setGroupCachePercent - - - - - - diff --git a/reference/solr/solrquery/setgroupcachepercent.xml b/reference/solr/solrquery/setgroupcachepercent.xml deleted file mode 100644 index 2144e2a6ac..0000000000 --- a/reference/solr/solrquery/setgroupcachepercent.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - SolrQuery::setGroupCachePercent - Define el porcentaje de caché para el agrupamiento de resultados - - - - &reftitle.description; - - public SolrQuerySolrQuery::setGroupCachePercent - intpercent - - - Definir este parámetro con un número mayor que 0 activa la caché para el agrupamiento de resultados. - El agrupamiento de resultados ejecuta dos búsquedas; esta opción almacena en caché la segunda búsqueda. El valor por omisión del servidor es 0. - - Las pruebas han demostrado que la caché de grupo solo mejora el tiempo de búsqueda con consultas booleanas, genéricas y difusas. Para consultas simples como las consultas de término o "match all", - la caché de grupo degrada el rendimiento. - Parámetro group.cache.percent - - - - - &reftitle.parameters; - - - percent - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.errors; - - Genera una SolrIllegalArgumentException si se ha pasado un argumento inválido. - - - - - &reftitle.seealso; - - SolrQuery::setGroup - SolrQuery::addGroupField - SolrQuery::addGroupFunction - SolrQuery::addGroupQuery - SolrQuery::addGroupSortField - SolrQuery::setGroupFacet - SolrQuery::setGroupOffset - SolrQuery::setGroupLimit - SolrQuery::setGroupMain - SolrQuery::setGroupNGroups - SolrQuery::setGroupTruncate - SolrQuery::setGroupFormat - - - - - - diff --git a/reference/solr/solrquery/setgroupfacet.xml b/reference/solr/solrquery/setgroupfacet.xml deleted file mode 100644 index 547ac094db..0000000000 --- a/reference/solr/solrquery/setgroupfacet.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - SolrQuery::setGroupFacet - Define el parámetro group.facet - - - - &reftitle.description; - - public SolrQuerySolrQuery::setGroupFacet - boolvalue - - - Determina si las facetas agrupadas deben ser calculadas para los campos facetados especificados en los parámetros facet.field. - Las facetas agrupadas se calculan en función del primer grupo especificado. - - - - - &reftitle.parameters; - - - value - - - - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.seealso; - - SolrQuery::setGroup - SolrQuery::addGroupField - SolrQuery::addGroupFunction - SolrQuery::addGroupQuery - SolrQuery::addGroupSortField - SolrQuery::setGroupOffset - SolrQuery::setGroupLimit - SolrQuery::setGroupMain - SolrQuery::setGroupNGroups - SolrQuery::setGroupTruncate - SolrQuery::setGroupFormat - SolrQuery::setGroupCachePercent - - - - - diff --git a/reference/solr/solrquery/setgroupformat.xml b/reference/solr/solrquery/setgroupformat.xml deleted file mode 100644 index 9d5e390bb2..0000000000 --- a/reference/solr/solrquery/setgroupformat.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - SolrQuery::setGroupFormat - Define el formato de grupo, la estructura de resultado (argumento group.format) - - - - &reftitle.description; - - public SolrQuerySolrQuery::setGroupFormat - stringvalue - - - Define el argumento group.format. - Si este argumento se establece en simple, los documentos agrupados se presentan en una sola lista plana, y los argumentos start y rows afectan al número de documentos en lugar de los grupos. - Valores aceptados: grouped/simple - - - - - &reftitle.parameters; - - - value - - - - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.seealso; - - SolrQuery::setGroup - SolrQuery::addGroupField - SolrQuery::addGroupFunction - SolrQuery::addGroupQuery - SolrQuery::addGroupSortField - SolrQuery::setGroupFacet - SolrQuery::setGroupOffset - SolrQuery::setGroupLimit - SolrQuery::setGroupMain - SolrQuery::setGroupNGroups - SolrQuery::setGroupTruncate - SolrQuery::setGroupCachePercent - - - - - diff --git a/reference/solr/solrquery/setgrouplimit.xml b/reference/solr/solrquery/setgrouplimit.xml deleted file mode 100644 index 28b9c4d015..0000000000 --- a/reference/solr/solrquery/setgrouplimit.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - SolrQuery::setGroupLimit - Especifica el número de resultados a devolver para cada grupo. Valor por omisión del servidor 1 - - - - &reftitle.description; - - public SolrQuerySolrQuery::setGroupLimit - intvalue - - - Especifica el número de resultados a devolver para cada grupo. Valor por omisión del servidor 1 - - - - - &reftitle.parameters; - - - value - - - - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.seealso; - - SolrQuery::setGroup - SolrQuery::addGroupField - SolrQuery::addGroupFunction - SolrQuery::addGroupQuery - SolrQuery::addGroupSortField - SolrQuery::setGroupFacet - SolrQuery::setGroupOffset - SolrQuery::setGroupMain - SolrQuery::setGroupNGroups - SolrQuery::setGroupTruncate - SolrQuery::setGroupFormat - SolrQuery::setGroupCachePercent - - - - - diff --git a/reference/solr/solrquery/setgroupmain.xml b/reference/solr/solrquery/setgroupmain.xml deleted file mode 100644 index b6e5ab37cb..0000000000 --- a/reference/solr/solrquery/setgroupmain.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - SolrQuery::setGroupMain - Si es verdadero, el resultado del primer comando de agrupación de campo se utiliza como lista de resultados principal en la respuesta, utilizando group.format=simple - - - - &reftitle.description; - - public SolrQuerySolrQuery::setGroupMain - stringvalue - - - Si &true;, el resultado del primer comando de agrupación de campo se utiliza como lista de resultados principal en la respuesta, utilizando group.format=simple. - - - - - - &reftitle.parameters; - - - value - - - Si &true;, el resultado del primer comando de agrupación de campo se utiliza como lista de resultados principal en la respuesta. - - - - - - - - &reftitle.returnvalues; - - Devuelve una instancia de SolrQuery. - - - - - &reftitle.seealso; - - SolrQuery::setGroup - SolrQuery::addGroupField - SolrQuery::addGroupFunction - SolrQuery::addGroupQuery - SolrQuery::addGroupSortField - SolrQuery::setGroupFacet - SolrQuery::setGroupOffset - SolrQuery::setGroupMain - SolrQuery::setGroupNGroups - SolrQuery::setGroupTruncate - SolrQuery::setGroupFormat - SolrQuery::setGroupCachePercent - - - - - diff --git a/reference/solr/solrquery/setgroupngroups.xml b/reference/solr/solrquery/setgroupngroups.xml deleted file mode 100644 index 0a749bcbc3..0000000000 --- a/reference/solr/solrquery/setgroupngroups.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - SolrQuery::setGroupNGroups - Si es verdadero, Solr incluye el número de grupos que han coincidido con la consulta en los resultados - - - - &reftitle.description; - - public SolrQuerySolrQuery::setGroupNGroups - boolvalue - - - Si es verdadero, Solr incluye el número de grupos que han coincidido con la consulta en los resultados. - - - - - - &reftitle.parameters; - - - value - - - - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.seealso; - - SolrQuery::setGroup - SolrQuery::addGroupField - SolrQuery::addGroupFunction - SolrQuery::addGroupQuery - SolrQuery::addGroupSortField - SolrQuery::setGroupFacet - SolrQuery::setGroupOffset - SolrQuery::setGroupLimit - SolrQuery::setGroupMain - SolrQuery::setGroupTruncate - SolrQuery::setGroupFormat - SolrQuery::setGroupCachePercent - - - - - diff --git a/reference/solr/solrquery/setgroupoffset.xml b/reference/solr/solrquery/setgroupoffset.xml deleted file mode 100644 index 67a13f5f78..0000000000 --- a/reference/solr/solrquery/setgroupoffset.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - SolrQuery::setGroupOffset - Define el parámetro group.offset - - - - &reftitle.description; - - public SolrQuerySolrQuery::setGroupOffset - intvalue - - - Define el parámetro group.offset. - - - - - - &reftitle.parameters; - - - value - - - - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.seealso; - - SolrQuery::setGroup - SolrQuery::addGroupField - SolrQuery::addGroupFunction - SolrQuery::addGroupQuery - SolrQuery::addGroupSortField - SolrQuery::setGroupFacet - SolrQuery::setGroupLimit - SolrQuery::setGroupMain - SolrQuery::setGroupNGroups - SolrQuery::setGroupTruncate - SolrQuery::setGroupFormat - SolrQuery::setGroupCachePercent - - - - - diff --git a/reference/solr/solrquery/setgrouptruncate.xml b/reference/solr/solrquery/setgrouptruncate.xml deleted file mode 100644 index f1d0d4c3f7..0000000000 --- a/reference/solr/solrquery/setgrouptruncate.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - SolrQuery::setGroupTruncate - Si es verdadero, los conteos de facetas se basan en el documento más relevante de cada grupo correspondiente a la consulta - - - - &reftitle.description; - - public SolrQuerySolrQuery::setGroupTruncate - boolvalue - - - Si es verdadero, los conteos de facetas se basan en el documento más relevante de cada grupo correspondiente a la consulta. - El valor por omisión del servidor es false. - Parámetro group.truncate - - - - - - &reftitle.parameters; - - - value - - - - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.seealso; - - SolrQuery::setGroup - SolrQuery::addGroupField - SolrQuery::addGroupFunction - SolrQuery::addGroupQuery - SolrQuery::addGroupSortField - SolrQuery::setGroupFacet - SolrQuery::setGroupOffset - SolrQuery::setGroupLimit - SolrQuery::setGroupMain - SolrQuery::setGroupNGroups - SolrQuery::setGroupFormat - SolrQuery::setGroupCachePercent - - - - - diff --git a/reference/solr/solrquery/sethighlight.xml b/reference/solr/solrquery/sethighlight.xml deleted file mode 100644 index f9d3994b97..0000000000 --- a/reference/solr/solrquery/sethighlight.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - SolrQuery::setHighlight - Habilita o deshabilita la remarcación - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlight - boolflag - - - Establecerlo a &true; habilita los trozos remarcados para ser generados en la respuesta de consulta. - - - Establecerlo a &false; deshabilita la remarcación - - - - &reftitle.parameters; - - - - flag - - - Habilita o deshabilita la remarcación - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/sethighlightalternatefield.xml b/reference/solr/solrquery/sethighlightalternatefield.xml deleted file mode 100644 index 95520729a1..0000000000 --- a/reference/solr/solrquery/sethighlightalternatefield.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - SolrQuery::setHighlightAlternateField - Especifica el campo de copia de seguridad a usar - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightAlternateField - stringfield - stringfield_override - - - Si un trozo no se puede generar debido a que no hay términos coincidentes, se puede especificar un campo para usarlo como copia de seguridad del sumario predeterminado - - - - - - &reftitle.parameters; - - - - field - - - El nombre del campo de copia de seguridad - - - - - field_override - - - El nombre del campo que se va a sobrescribir. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/sethighlightformatter.xml b/reference/solr/solrquery/sethighlightformatter.xml deleted file mode 100644 index 2b6944a21f..0000000000 --- a/reference/solr/solrquery/sethighlightformatter.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - SolrQuery::setHighlightFormatter - Especifica un formateador para la salida resaltada - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightFormatter - stringformatter - stringfield_override - - - Especifica un formateador para la salida resaltada. - - - - - &reftitle.parameters; - - - - formatter - - - Actualmente, el único valor es "simple". - - - - - field_override - - - El nombre del campo. - - - - - - - - - &reftitle.returnvalues; - - Devuelve una instancia de SolrQuery. - - - - - diff --git a/reference/solr/solrquery/sethighlightfragmenter.xml b/reference/solr/solrquery/sethighlightfragmenter.xml deleted file mode 100644 index 804ffd0c9c..0000000000 --- a/reference/solr/solrquery/sethighlightfragmenter.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - SolrQuery::setHighlightFragmenter - Establece el generador de trozos de código para texto remarcado - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightFragmenter - stringfragmenter - stringfield_override - - - Especifica un generador de trozos de código para texto remarcado. - - - - - &reftitle.parameters; - - - - fragmenter - - - El fragmentador estándar es el hueco. Otra opción son las expresiones regulares, que intentan crear fragmentos que se parecen a ciertas expresiones regulares - - - - - field_override - - - El nombre del campo. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/sethighlightfragsize.xml b/reference/solr/solrquery/sethighlightfragsize.xml deleted file mode 100644 index aa225d1791..0000000000 --- a/reference/solr/solrquery/sethighlightfragsize.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - SolrQuery::setHighlightFragsize - El tamaño de los fragmentos a considerara para remarcación - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightFragsize - intsize - stringfield_override - - - Establece el tamaño, en caracteres, de los fragmentos a considerara para remarcación. "0" indica que debería usarse el campo completo (sin fragmentación). - - - - - &reftitle.parameters; - - - - size - - - El tamaño, en caracteres, de los fragmentos a considerara para remarcación - - - - - field_override - - - El nombre del campo. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/sethighlighthighlightmultiterm.xml b/reference/solr/solrquery/sethighlighthighlightmultiterm.xml deleted file mode 100644 index f62f706ff3..0000000000 --- a/reference/solr/solrquery/sethighlighthighlightmultiterm.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - SolrQuery::setHighlightHighlightMultiTerm - Usa SpanScorer para remarcar términos de frases - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightHighlightMultiTerm - boolflag - - - Usa SpanScorer para remarcar términos de frases sólo cuando aparecen dentro de la frase de consulta del documento. - - - - - &reftitle.parameters; - - - - flag - - - Si usar o no SpanScorer para remarcar términos de frases sólo cuando aparecen dentro de la frase de consulta del documento. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/sethighlightmaxalternatefieldlength.xml b/reference/solr/solrquery/sethighlightmaxalternatefieldlength.xml deleted file mode 100644 index 0e233a272f..0000000000 --- a/reference/solr/solrquery/sethighlightmaxalternatefieldlength.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - SolrQuery::setHighlightMaxAlternateFieldLength - Establece el número máximo de caracteres del campo a devolver - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightMaxAlternateFieldLength - intfieldLength - stringfield_override - - - Si SolrQuery::setHighlightAlternateField() se le pasó el valor &true;, este parámetro especifica el número máximo de caracteres del campo a devolver - - - Cualquier valor menor o igual que 0 significa ilimitado. - - - - - &reftitle.parameters; - - - - fieldLength - - - La longitud del campo - - - - - field_override - - - El nombre del campo. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/sethighlightmaxanalyzedchars.xml b/reference/solr/solrquery/sethighlightmaxanalyzedchars.xml deleted file mode 100644 index a04b238eca..0000000000 --- a/reference/solr/solrquery/sethighlightmaxanalyzedchars.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::setHighlightMaxAnalyzedChars - Especifica el número de caracteres de un documento para buscar trozos apropiados - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightMaxAnalyzedChars - intvalue - - - Especifica el número de caracteres de un documento para buscar trozos apropiados - - - - - - &reftitle.parameters; - - - - value - - - El número de caracteres de un documento para buscar trozos apropiados - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/sethighlightmergecontiguous.xml b/reference/solr/solrquery/sethighlightmergecontiguous.xml deleted file mode 100644 index 876e6d94a4..0000000000 --- a/reference/solr/solrquery/sethighlightmergecontiguous.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - SolrQuery::setHighlightMergeContiguous - Si colapsar o no fragmentos contiguos en un único fragmento - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightMergeContiguous - boolflag - stringfield_override - - - Si colapsar o no fragmentos contiguos en un único fragmento. - - - - - - &reftitle.parameters; - - - - value - - - Si colapsar o no fragmentos contiguos en un único fragmento - - - - - field_override - - - El nombre del campo. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/sethighlightquery.xml b/reference/solr/solrquery/sethighlightquery.xml deleted file mode 100644 index b34cc78df2..0000000000 --- a/reference/solr/solrquery/sethighlightquery.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - SolrQuery::setHighlightQuery - Una consulta designada para el resaltado - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightQuery - stringq - - - Una consulta a utilizar para el resaltado, que se asignará como valor del - parámetro Solr hl.q. - Este parámetro permite resaltar términos o campos diferentes de los utilizados para recuperar los documentos. - - - - El valor predeterminado si no está definido: el valor del parámetro - q de la petición. - - - - Véase la sección Highlighting - para más detalles sobre el parámetro Solr hl.q. - - - - - &reftitle.parameters; - - - - q - - - La consulta de resaltado. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual. - - - - - &reftitle.seealso; - - SolrQuery::getHighlightQuery - SolrQuery::setHighlightFields - SolrQuery::getHighlightFields - - - - - diff --git a/reference/solr/solrquery/sethighlightregexmaxanalyzedchars.xml b/reference/solr/solrquery/sethighlightregexmaxanalyzedchars.xml deleted file mode 100644 index 6f4a250195..0000000000 --- a/reference/solr/solrquery/sethighlightregexmaxanalyzedchars.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::setHighlightRegexMaxAnalyzedChars - Especifica el número máximo de caracteres a analizar - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightRegexMaxAnalyzedChars - intmaxAnalyzedChars - - - Especifica el número máximo de caracteres a analizar de un campo cuando se usa el fragmentador de expresiones regulares - - - - - - &reftitle.parameters; - - - - maxAnalyzedChars - - - El número máximo de caracteres a analizar de un campo cuando se usa el fragmentador de expresiones regulares - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/sethighlightregexpattern.xml b/reference/solr/solrquery/sethighlightregexpattern.xml deleted file mode 100644 index e4a437a081..0000000000 --- a/reference/solr/solrquery/sethighlightregexpattern.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::setHighlightRegexPattern - Especifica la expresión regular para la fragmentación - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightRegexPattern - stringvalue - - - Especifica la expresión regular para la fragmentación. Esto podría usarse para extraer sentencias - - - - - - &reftitle.parameters; - - - - value - - - La expresión regular para la fragmentación. Esto podría usarse para extraer sentencias - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/sethighlightregexslop.xml b/reference/solr/solrquery/sethighlightregexslop.xml deleted file mode 100644 index 80d4b8cadb..0000000000 --- a/reference/solr/solrquery/sethighlightregexslop.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - SolrQuery::setHighlightRegexSlop - Establece el factor por el cual el fragmentador de expresiones regulares puede desviarse del tamaño de fragmento ideal - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightRegexSlop - floatfactor - - - El factor por el cual el fragmentador de expresiones regulares puede desviarse del tamaño de fragmento ideal (especificado por SolrQuery::setHighlightFragsize) para acomodar la expresión regular - - - - - - &reftitle.parameters; - - - - factor - - - El factor por el cual el fragmentador de expresiones regulares puede desviarse del tamaño de fragmento ideal - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/sethighlightrequirefieldmatch.xml b/reference/solr/solrquery/sethighlightrequirefieldmatch.xml deleted file mode 100644 index bdec640663..0000000000 --- a/reference/solr/solrquery/sethighlightrequirefieldmatch.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - SolrQuery::setHighlightRequireFieldMatch - Requerir la coincicencia de campos durante el remarcado - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightRequireFieldMatch - boolflag - - - Si es &true;, un campo sólo será remarcado si la consulta coincide con este campo en particular. - - - Esto sólo funciona si SolrQuery::setHighlightUsePhraseHighlighter() se estableció a &true; - - - - - &reftitle.parameters; - - - - flag - - - &true; o &false; - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/sethighlightsimplepost.xml b/reference/solr/solrquery/sethighlightsimplepost.xml deleted file mode 100644 index 8f8bc93a09..0000000000 --- a/reference/solr/solrquery/sethighlightsimplepost.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - SolrQuery::setHighlightSimplePost - Define el texto que debe aparecer después de un término resaltado - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightSimplePost - stringsimplePost - stringfield_override - - - Define el texto que debe aparecer después de un término resaltado. - - - - - - &reftitle.parameters; - - - - simplePost - - - Define el texto que debe aparecer después de un término resaltado. - - ]]> - - - - field_override - - - El nombre del campo. - - - - - - - - - &reftitle.returnvalues; - - Devuelve una instancia de SolrQuery. - - - - - - diff --git a/reference/solr/solrquery/sethighlightsimplepre.xml b/reference/solr/solrquery/sethighlightsimplepre.xml deleted file mode 100644 index 24e0ae11f9..0000000000 --- a/reference/solr/solrquery/sethighlightsimplepre.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - SolrQuery::setHighlightSimplePre - Establece el texto que aparece antes de un término remarcado - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightSimplePre - stringsimplePre - stringfield_override - - - Establece el texto que aparece antes de un término remarcado. - - ]]> - - - - &reftitle.parameters; - - - - simplePre - - - El texto que aparece antes de un término remarcado - - - - - field_override - - - El nombre del campo. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/sethighlightsnippets.xml b/reference/solr/solrquery/sethighlightsnippets.xml deleted file mode 100644 index c1f0aecf01..0000000000 --- a/reference/solr/solrquery/sethighlightsnippets.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - SolrQuery::setHighlightSnippets - Establece el número máximo de trozos remarcados para generar por campo - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightSnippets - intvalue - stringfield_override - - - Establece el número máximo de trozos remarcados para generar por campo - - - - - - &reftitle.parameters; - - - - value - - - El número máximo de trozos remarcados para generar por campo - - - - - field_override - - - El nombre del campo. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/sethighlightusephrasehighlighter.xml b/reference/solr/solrquery/sethighlightusephrasehighlighter.xml deleted file mode 100644 index 96f745e20b..0000000000 --- a/reference/solr/solrquery/sethighlightusephrasehighlighter.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::setHighlightUsePhraseHighlighter - Si remarcar o no términos de frases sólo cuando aparecen en la frase de consulta - - - - &reftitle.description; - - public SolrQuerySolrQuery::setHighlightUsePhraseHighlighter - boolflag - - - Establece si usar o no SpanScorer para remarcar o no términos de frases sólo cuando aparecen en la frase de consulta del documento - - - - - - &reftitle.parameters; - - - - value - - - Si usar o no SpanScorer para remarcar o no términos de frases sólo cuando aparecen en la frase de consulta del documento - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/setmlt.xml b/reference/solr/solrquery/setmlt.xml deleted file mode 100644 index 0a84c2cf6b..0000000000 --- a/reference/solr/solrquery/setmlt.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::setMlt - Habilita o deshabilita moreLikeThis - - - - &reftitle.description; - - public SolrQuerySolrQuery::setMlt - boolflag - - - Habilita o deshabilita moreLikeThis - - - - - - &reftitle.parameters; - - - - flag - - - &true; lo habilita y &false; lo desactiva. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/setmltboost.xml b/reference/solr/solrquery/setmltboost.xml deleted file mode 100644 index cad95e29df..0000000000 --- a/reference/solr/solrquery/setmltboost.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::setMltBoost - Establecer si la consulta será impulsada (boost) por la relevancia del término de interés - - - - &reftitle.description; - - public SolrQuerySolrQuery::setMltBoost - boolflag - - - Establecer si la consulta será impulsada (boost) por la relevancia del término de interés - - - - - - &reftitle.parameters; - - - - value - - - Establece a &true; o &false; - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/setmltcount.xml b/reference/solr/solrquery/setmltcount.xml deleted file mode 100644 index bce440d6b3..0000000000 --- a/reference/solr/solrquery/setmltcount.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::setMltCount - Establece el número de documentos similares a devolver en cada resultado - - - - &reftitle.description; - - public SolrQuerySolrQuery::setMltCount - intcount - - - Establece el número de documentos similares a devolver en cada resultado - - - - - - &reftitle.parameters; - - - - count - - - El número de documentos similares a devolver en cada resultado - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/setmltmaxnumqueryterms.xml b/reference/solr/solrquery/setmltmaxnumqueryterms.xml deleted file mode 100644 index 42129c6e91..0000000000 --- a/reference/solr/solrquery/setmltmaxnumqueryterms.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::setMltMaxNumQueryTerms - Establece el número máximo de términos de consulta incluidos - - - - &reftitle.description; - - public SolrQuerySolrQuery::setMltMaxNumQueryTerms - intvalue - - - Establece el número máximo de términos de consulta que serán incluidos en cualquier consulta generada. - - - - - - &reftitle.parameters; - - - - value - - - El número máximo de términos de consulta que serán incluidos en cualquier consulta generada - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/setmltmaxnumtokens.xml b/reference/solr/solrquery/setmltmaxnumtokens.xml deleted file mode 100644 index 66db1caafe..0000000000 --- a/reference/solr/solrquery/setmltmaxnumtokens.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - SolrQuery::setMltMaxNumTokens - Especifica el número máximo de tokens a analizar - - - - &reftitle.description; - - public SolrQuerySolrQuery::setMltMaxNumTokens - intvalue - - - Especifica el número máximo de tokens a analizar en cada campo de documento de ejemplo que no esté almacenado con soporte TermVector. - - - - - &reftitle.parameters; - - - - value - - - El número máximo de tokens a analizar - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/setmltmaxwordlength.xml b/reference/solr/solrquery/setmltmaxwordlength.xml deleted file mode 100644 index 04ec7c2d05..0000000000 --- a/reference/solr/solrquery/setmltmaxwordlength.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::setMltMaxWordLength - Establece la longitud de palabra máxima - - - - &reftitle.description; - - public SolrQuerySolrQuery::setMltMaxWordLength - intmaxWordLength - - - Establece la longitud de palabra máxima sobre la que las palabras serán ignoradas. - - - - - - &reftitle.parameters; - - - - maxWordLength - - - La longitud de palabra máxima sobre la que las palabras serán ignoradas - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/setmltmindocfrequency.xml b/reference/solr/solrquery/setmltmindocfrequency.xml deleted file mode 100644 index 1faacc25f9..0000000000 --- a/reference/solr/solrquery/setmltmindocfrequency.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::setMltMinDocFrequency - Establece la frecuencia de mltMinDoc - - - - &reftitle.description; - - public SolrQuerySolrQuery::setMltMinDocFrequency - intminDocFrequency - - - La frecuencia en la que las palabras que no ocurran en por lo menos tantos documentos como este serán ignoradas. - - - - - - &reftitle.parameters; - - - - minDocFrequency - - - Establece la frecuencia en la que las palabras que no ocurran en por lo menos tantos documentos como este serán ignoradas. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/setmltmintermfrequency.xml b/reference/solr/solrquery/setmltmintermfrequency.xml deleted file mode 100644 index 551aece6d7..0000000000 --- a/reference/solr/solrquery/setmltmintermfrequency.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::setMltMinTermFrequency - Establece la frecuencia bajo la cual los términos serán ignorados en los documentos fuente - - - - &reftitle.description; - - public SolrQuerySolrQuery::setMltMinTermFrequency - intminTermFrequency - - - Establece la frecuencia bajo la cual los términos serán ignorados en los documentos fuente - - - - - - &reftitle.parameters; - - - - minTermFrequency - - - La frecuencia bajo la cual los términos serán ignorados en los documentos fuente - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/setmltminwordlength.xml b/reference/solr/solrquery/setmltminwordlength.xml deleted file mode 100644 index b7ec289793..0000000000 --- a/reference/solr/solrquery/setmltminwordlength.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::setMltMinWordLength - Establece la longitud de palabra mínima - - - - &reftitle.description; - - public SolrQuerySolrQuery::setMltMinWordLength - intminWordLength - - - Establece la longitud de palabra mínima bajo la cual las palabras serán ignoradas. - - - - - - &reftitle.parameters; - - - - minWordLength - - - La longitud de palabra mínima bajo la cual las palabras serán ignoradas. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/setomitheader.xml b/reference/solr/solrquery/setomitheader.xml deleted file mode 100644 index 6665184beb..0000000000 --- a/reference/solr/solrquery/setomitheader.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::setOmitHeader - Excluye la cabecera de los resultados devueltos - - - - &reftitle.description; - - public SolrQuerySolrQuery::setOmitHeader - boolflag - - - Excluye la cabecera de los resultados devueltos. - - - - - - &reftitle.parameters; - - - - flag - - - &true; excluye la cabecera del resultado - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/setquery.xml b/reference/solr/solrquery/setquery.xml deleted file mode 100644 index 8e66b229a5..0000000000 --- a/reference/solr/solrquery/setquery.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::setQuery - Establece la consulta de búsqueda - - - - &reftitle.description; - - public SolrQuerySolrQuery::setQuery - stringquery - - - Establece la consulta de búsqueda. - - - - - - &reftitle.parameters; - - - - query - - - La consulta de búsqueda - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual - - - - - - diff --git a/reference/solr/solrquery/setrows.xml b/reference/solr/solrquery/setrows.xml deleted file mode 100644 index eb1d9e2bd2..0000000000 --- a/reference/solr/solrquery/setrows.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::setRows - Especifica el número máximo de filas a devolver en el resultado - - - - &reftitle.description; - - public SolrQuerySolrQuery::setRows - introws - - - Especifica el número máximo de filas a devolver en el resultado - - - - - - &reftitle.parameters; - - - - rows - - - El número máximo de filas a devolver - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual. - - - - - - diff --git a/reference/solr/solrquery/setshowdebuginfo.xml b/reference/solr/solrquery/setshowdebuginfo.xml deleted file mode 100644 index 5276b524a5..0000000000 --- a/reference/solr/solrquery/setshowdebuginfo.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::setShowDebugInfo - Bandera para mostrar información de depuración - - - - &reftitle.description; - - public SolrQuerySolrQuery::setShowDebugInfo - boolflag - - - Si mostrar o no información de depuración - - - - - - &reftitle.parameters; - - - - flag - - - Si mostrar o no información de depuración. &true; o &false; - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/setstart.xml b/reference/solr/solrquery/setstart.xml deleted file mode 100644 index 8f3455daf5..0000000000 --- a/reference/solr/solrquery/setstart.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::setStart - Especifica el número de filas que se van a saltar - - - - &reftitle.description; - - public SolrQuerySolrQuery::setStart - intstart - - - Especifica el número de filas que se van a saltar. Útil en paginación de resultados. - - - - - - &reftitle.parameters; - - - - start - - - El número de filas a saltar. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual. - - - - - - diff --git a/reference/solr/solrquery/setstats.xml b/reference/solr/solrquery/setstats.xml deleted file mode 100644 index 3386db3617..0000000000 --- a/reference/solr/solrquery/setstats.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::setStats - Habilita o deshablita el componente de estadísticas - - - - &reftitle.description; - - public SolrQuerySolrQuery::setStats - boolflag - - - Habilita o deshablita el componente de estadísticas. - - - - - - &reftitle.parameters; - - - - flag - - - &true; habilita el componente de estadísticas y &false; lo deshabilita. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/setterms.xml b/reference/solr/solrquery/setterms.xml deleted file mode 100644 index d0beb417c0..0000000000 --- a/reference/solr/solrquery/setterms.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::setTerms - Habilita o deshablita TermsComponent - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTerms - boolflag - - - Habilita o deshablita TermsComponent - - - - - - &reftitle.parameters; - - - - flag - - - &true; lo habilita. &false; lo desactiva - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/settermsfield.xml b/reference/solr/solrquery/settermsfield.xml deleted file mode 100644 index 059f390646..0000000000 --- a/reference/solr/solrquery/settermsfield.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - SolrQuery::setTermsField - Establece el nombre del campo del que obtener los términos - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTermsField - stringfieldname - - - Establece el nombre del campo del que obtener los términos - - - - - &reftitle.parameters; - - - - fieldname - - - El nombre del campo - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/settermsincludelowerbound.xml b/reference/solr/solrquery/settermsincludelowerbound.xml deleted file mode 100644 index 12063970f9..0000000000 --- a/reference/solr/solrquery/settermsincludelowerbound.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::setTermsIncludeLowerBound - Incluir el término de límite inferior en el conjunto de resultados - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTermsIncludeLowerBound - boolflag - - - Incluir el término de límite inferior en el conjunto de resultados. - - - - - - &reftitle.parameters; - - - - flag - - - Incluir el término de límite inferior en el conjunto de resultados - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/settermsincludeupperbound.xml b/reference/solr/solrquery/settermsincludeupperbound.xml deleted file mode 100644 index 4c5dd11402..0000000000 --- a/reference/solr/solrquery/settermsincludeupperbound.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::setTermsIncludeUpperBound - Incluir el término de límite superior en el conjunto de resultados - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTermsIncludeUpperBound - boolflag - - - Incluir el término de límite superior en el conjunto de resultados. - - - - - - &reftitle.parameters; - - - - flag - - - &true; o &false; - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/settermslimit.xml b/reference/solr/solrquery/settermslimit.xml deleted file mode 100644 index cc0ee86f01..0000000000 --- a/reference/solr/solrquery/settermslimit.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::setTermsLimit - Establece el número máximo de términos a devolver - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTermsLimit - intlimit - - - Establece el número máximo de términos a devolver - - - - - - &reftitle.parameters; - - - - limit - - - El número máximo de términos a devolver. Si el límite es negativo se devolverán todos los términos. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/settermslowerbound.xml b/reference/solr/solrquery/settermslowerbound.xml deleted file mode 100644 index 085416baff..0000000000 --- a/reference/solr/solrquery/settermslowerbound.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::setTermsLowerBound - Especifica el término de donde empezar - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTermsLowerBound - stringlowerBound - - - Especifica el término de donde empezar - - - - - - &reftitle.parameters; - - - - lowerBound - - - El término límite inferior - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/settermsmaxcount.xml b/reference/solr/solrquery/settermsmaxcount.xml deleted file mode 100644 index 7561447099..0000000000 --- a/reference/solr/solrquery/settermsmaxcount.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - SolrQuery::setTermsMaxCount - Establece la frecuencia máxima de documentos - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTermsMaxCount - intfrequency - - - Establece la frecuencia máxima de documentos. - - - - - &reftitle.parameters; - - - - frequency - - - La frecuencia máxima de documentos. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/settermsmincount.xml b/reference/solr/solrquery/settermsmincount.xml deleted file mode 100644 index b8670a7036..0000000000 --- a/reference/solr/solrquery/settermsmincount.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::setTermsMinCount - Establece la frecuencia mínima de documentos - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTermsMinCount - intfrequency - - - Establece la frecuencia mínima de documentos a devolver para ser incluidos - - - - - - &reftitle.parameters; - - - - frequency - - - La frecuencia mínima - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/settermsprefix.xml b/reference/solr/solrquery/settermsprefix.xml deleted file mode 100644 index ea1948483b..0000000000 --- a/reference/solr/solrquery/settermsprefix.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::setTermsPrefix - Restringe las coincidencias de términos que comienzan con el prefijo - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTermsPrefix - stringprefix - - - Restringe las coincidencias de términos que comienzan con el prefijo - - - - - - &reftitle.parameters; - - - - prefix - - - Restringe las coincidencias de términos que comienzan con el prefijo - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/settermsreturnraw.xml b/reference/solr/solrquery/settermsreturnraw.xml deleted file mode 100644 index f07b51886a..0000000000 --- a/reference/solr/solrquery/settermsreturnraw.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::setTermsReturnRaw - Devuelve los caracteres en bruto del término indexado - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTermsReturnRaw - boolflag - - - Si es true, devuelve los caracteres en bruto del término indexado, sin tener en cuenta si es legible por humanos. - - - - - - &reftitle.parameters; - - - - value - - - &true; o &false; - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/settermssort.xml b/reference/solr/solrquery/settermssort.xml deleted file mode 100644 index 0cba8b5e66..0000000000 --- a/reference/solr/solrquery/settermssort.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::setTermsSort - Especifica cómo ordenar los términos devueltos - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTermsSort - intsortType - - - Si se usa SolrQuery::TERMS_SORT_COUNT, ordena los términos según la frecuencia del término (la mayor primero). Si se usa SolrQuery::TERMS_SORT_INDEX, devuelve los términos ordenados por índice - - - - - - &reftitle.parameters; - - - - sortType - - - SolrQuery::TERMS_SORT_INDEX o SolrQuery::TERMS_SORT_COUNT - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/settermsupperbound.xml b/reference/solr/solrquery/settermsupperbound.xml deleted file mode 100644 index 81f67b2212..0000000000 --- a/reference/solr/solrquery/settermsupperbound.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::setTermsUpperBound - Establece el término en el que parar - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTermsUpperBound - stringupperBound - - - Establece el término en el que parar - - - - - - &reftitle.parameters; - - - - upperBound - - - El término en el que parar - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrquery/settimeallowed.xml b/reference/solr/solrquery/settimeallowed.xml deleted file mode 100644 index 0eb1037339..0000000000 --- a/reference/solr/solrquery/settimeallowed.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrQuery::setTimeAllowed - El tiempo permitido para que la búsqueda finalice - - - - &reftitle.description; - - public SolrQuerySolrQuery::setTimeAllowed - inttimeAllowed - - - El tiempo permitido para que la búsqueda finalice. Este valor sólo se aplica a la búsqueda y no a las solicitudes en general. Se mide en milisegundos. Los valores menores o iguales a cero implican la no restricción de tiempo. Se pueden devolver resultados parciales, si los hubiera. - - - - - - &reftitle.parameters; - - - - timeAllowed - - - El tiempo permitido para que la búsqueda finalice. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrQuery actual, si se usó el valor de retorno. - - - - - - diff --git a/reference/solr/solrqueryresponse.xml b/reference/solr/solrqueryresponse.xml deleted file mode 100644 index bfc5e250df..0000000000 --- a/reference/solr/solrqueryresponse.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - - - La clase SolrQueryResponse - SolrQueryResponse - - - - -
    - &reftitle.intro; - - Representa una respuesta a una solicitud de consulta. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrQueryResponse - - - - - final - SolrQueryResponse - - - - extends - SolrResponse - - - - &Constants; - - const - int - SolrQueryResponse::PARSE_SOLR_OBJ - 0 - - - const - int - SolrQueryResponse::PARSE_SOLR_DOC - 1 - - - &InheritedProperties; - - - &Methods; - - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.constants; -
    - Constantes de la Clase SolrQueryResponse - - - - SolrQueryResponse::PARSE_SOLR_OBJ - - Los documentos deberían ser analizados como instancias de SolrObject - - - - - SolrQueryResponse::PARSE_SOLR_DOC - - Los documentos deberían ser analizados como instancias de SolrDocument. - - - - -
    -
    - - - -
    - - &reference.solr.entities.solrqueryresponse; - -
    - - diff --git a/reference/solr/solrqueryresponse/construct.xml b/reference/solr/solrqueryresponse/construct.xml deleted file mode 100644 index 98e5402cf9..0000000000 --- a/reference/solr/solrqueryresponse/construct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - SolrQueryResponse::__construct - Constructor - - - - &reftitle.description; - - public SolrQueryResponse::__construct - - - - Constructor - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Nada - - - - - - diff --git a/reference/solr/solrqueryresponse/destruct.xml b/reference/solr/solrqueryresponse/destruct.xml deleted file mode 100644 index 28094873e0..0000000000 --- a/reference/solr/solrqueryresponse/destruct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrQueryResponse::__destruct - Destructor - - - - &reftitle.description; - - public SolrQueryResponse::__destruct - - - - Destructor. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Nada - - - - - - diff --git a/reference/solr/solrresponse.xml b/reference/solr/solrresponse.xml deleted file mode 100644 index 6bedae04f8..0000000000 --- a/reference/solr/solrresponse.xml +++ /dev/null @@ -1,232 +0,0 @@ - - - - - - - La clase SolrResponse - SolrResponse - - - - -
    - &reftitle.intro; - - Representa una respuesta del servidor Solr. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrResponse - - - - - abstract - SolrResponse - - - - &Constants; - - const - int - SolrResponse::PARSE_SOLR_OBJ - 0 - - - const - int - SolrResponse::PARSE_SOLR_DOC - 1 - - - &Properties; - - protected - int - http_status - - - protected - int - parser_mode - - - protected - bool - success - - - protected - string - http_status_message - - - protected - string - http_request_url - - - protected - string - http_raw_request_headers - - - protected - string - http_raw_request - - - protected - string - http_raw_response_headers - - - protected - string - http_raw_response - - - protected - string - http_digested_response - - - - &Methods; - - - - -
    - - - -
    - &reftitle.properties; - - - http_status - - El estado http de la resupuesta. - - - - parser_mode - - Modo de analizar los documentos, si como instancias de SolrObject o de SolrDocument. - - - - success - - ¿Ocurrió un error durante la solicitud? - - - - http_status_message - - Messaje detallado del estado http - - - - http_request_url - - La URL solicitada - - - - http_raw_request_headers - - Una cadena de cabeceras en bruto enviada durante la solicitud - - - - http_raw_request - - La solicitud en bruto enviada al servidor - - - - http_raw_response_headers - - Las cabeceras de resupuesta del servidor Solr - - - - http_raw_response - - El mensaje de respuesta del servidor - - - - http_digested_response - - La respuesta en formato serializado de PHP. - - - -
    - - - - -
    - &reftitle.constants; -
    - Constantes de la Clase SolrResponse - - - - SolrResponse::PARSE_SOLR_OBJ - - Los documentos deberían ser analizados como instancias de SolrObject - - - - - SolrResponse::PARSE_SOLR_DOC - - Los documentos deberían ser analizados como instancias de SolrDocument. - - - - -
    -
    - - - -
    - - &reference.solr.entities.solrresponse; - -
    - - diff --git a/reference/solr/solrresponse/getdigestedresponse.xml b/reference/solr/solrresponse/getdigestedresponse.xml deleted file mode 100644 index 1eec430ab5..0000000000 --- a/reference/solr/solrresponse/getdigestedresponse.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - SolrResponse::getDigestedResponse - Devuelve la respueste XML como información de PHP serializada - - - - &reftitle.description; - - public stringSolrResponse::getDigestedResponse - - - - Devuelve la respueste XML como información de PHP serializada - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la respueste XML como información de PHP serializada - - - - - - diff --git a/reference/solr/solrresponse/gethttpstatus.xml b/reference/solr/solrresponse/gethttpstatus.xml deleted file mode 100644 index 2d721de202..0000000000 --- a/reference/solr/solrresponse/gethttpstatus.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrResponse::getHttpStatus - Devuelve el estado HTTP de la respuesta - - - - &reftitle.description; - - public intSolrResponse::getHttpStatus - - - - Devuelve el estado HTTP de la respuesta. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el estado HTTP de la respuesta. - - - - - - diff --git a/reference/solr/solrresponse/gethttpstatusmessage.xml b/reference/solr/solrresponse/gethttpstatusmessage.xml deleted file mode 100644 index 86e9cd1c8f..0000000000 --- a/reference/solr/solrresponse/gethttpstatusmessage.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrResponse::getHttpStatusMessage - Devuelve más detalles del estado HTTP - - - - &reftitle.description; - - public stringSolrResponse::getHttpStatusMessage - - - - Devuelve más detalles del estado HTTP. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve más detalles del estado HTTP - - - - - - diff --git a/reference/solr/solrresponse/getrawrequest.xml b/reference/solr/solrresponse/getrawrequest.xml deleted file mode 100644 index 74253037be..0000000000 --- a/reference/solr/solrresponse/getrawrequest.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrResponse::getRawRequest - Devuelve la respuesta en bruto enviada al servidor Solr - - - - &reftitle.description; - - public stringSolrResponse::getRawRequest - - - - Devuelve la respuesta en bruto enviada al servidor Solr. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la respuesta en bruto enviada al servidor Solr - - - - - - diff --git a/reference/solr/solrresponse/getrawrequestheaders.xml b/reference/solr/solrresponse/getrawrequestheaders.xml deleted file mode 100644 index eb0dbfca11..0000000000 --- a/reference/solr/solrresponse/getrawrequestheaders.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrResponse::getRawRequestHeaders - Devuelve las cabeceras de respuesta sin tratar enviadas al servidor Solr - - - - &reftitle.description; - - public stringSolrResponse::getRawRequestHeaders - - - - Devuelve las cabeceras de respuesta sin tratar enviadas al servidor Solr, - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve las cabeceras de respuesta sin tratar enviadas al servidor Solr - - - - - - diff --git a/reference/solr/solrresponse/getrawresponse.xml b/reference/solr/solrresponse/getrawresponse.xml deleted file mode 100644 index 2299bc214b..0000000000 --- a/reference/solr/solrresponse/getrawresponse.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrResponse::getRawResponse - Devuelve la respuesta sin tratar del servidor - - - - &reftitle.description; - - public stringSolrResponse::getRawResponse - - - - Devuelve la respuesta sin tratar del servidor. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la respuesta sin tratar del servidor. - - - - - - diff --git a/reference/solr/solrresponse/getrawresponseheaders.xml b/reference/solr/solrresponse/getrawresponseheaders.xml deleted file mode 100644 index 94cc422c0e..0000000000 --- a/reference/solr/solrresponse/getrawresponseheaders.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrResponse::getRawResponseHeaders - Devuelve las cabeceras de respuesta sin tratar del servidor - - - - &reftitle.description; - - public stringSolrResponse::getRawResponseHeaders - - - - Devuelve las cabeceras de respuesta sin tratar del servidor. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve las cabeceras de respuesta sin tratar del servidor. - - - - - - diff --git a/reference/solr/solrresponse/getrequesturl.xml b/reference/solr/solrresponse/getrequesturl.xml deleted file mode 100644 index d780021498..0000000000 --- a/reference/solr/solrresponse/getrequesturl.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - SolrResponse::getRequestUrl - Devuelve la URL completa a la que se envió la respuesta - - - - &reftitle.description; - - public stringSolrResponse::getRequestUrl - - - - Devuelve la URL completa a la que se envió la respuesta. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la URL completa a la que se envió la respuesta - - - - - - diff --git a/reference/solr/solrresponse/getresponse.xml b/reference/solr/solrresponse/getresponse.xml deleted file mode 100644 index 1116019a27..0000000000 --- a/reference/solr/solrresponse/getresponse.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - SolrResponse::getResponse - Devuelve un objeto SolrObject que representa la respuesta XML del servidor - - - - &reftitle.description; - - public SolrObjectSolrResponse::getResponse - - - - Devuelve un objeto SolrObject que representa la respuesta XML del servidor. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un objeto SolrObject que representa la respuesta XML del servidor - - - - - - diff --git a/reference/solr/solrresponse/setparsemode.xml b/reference/solr/solrresponse/setparsemode.xml deleted file mode 100644 index 0e421a9e34..0000000000 --- a/reference/solr/solrresponse/setparsemode.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrResponse::setParseMode - Establece el modo de análisis - - - - &reftitle.description; - - public boolSolrResponse::setParseMode - intparser_mode0 - - - Establece el modo de análisis. - - - - - - &reftitle.parameters; - - - - parser_mode - - - SolrResponse::PARSE_SOLR_DOC analiza los documentos en instancias de SolrDocument. SolrResponse::PARSE_SOLR_OBJ convierte un documento a un objeto SolrObjects. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/solr/solrresponse/success.xml b/reference/solr/solrresponse/success.xml deleted file mode 100644 index ba6a33e8ee..0000000000 --- a/reference/solr/solrresponse/success.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrResponse::success - ¿Tuvo éxito la petición? - - - - &reftitle.description; - - public boolSolrResponse::success - - - - Se usa para verificar si la petición al servidor tuvo éxito. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si se tuvo éxito y &false; si no lo tuvo. - - - - - - diff --git a/reference/solr/solrserverexception.xml b/reference/solr/solrserverexception.xml deleted file mode 100644 index 815bdaf4a4..0000000000 --- a/reference/solr/solrserverexception.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - - La clase SolrServerException - SolrServerException - - - - -
    - &reftitle.intro; - - Una excepción lanzada cuando hay un error producido por el propio servidor Solr. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrServerException - - - - - SolrServerException - - - - extends - SolrException - - - - - &InheritedProperties; - - - - &Methods; - - - &InheritedMethods; - - - - - - -
    - - -
    - - &reference.solr.entities.solrserverexception; - -
    - - diff --git a/reference/solr/solrserverexception/getinternalinfo.xml b/reference/solr/solrserverexception/getinternalinfo.xml deleted file mode 100644 index f84dfc944b..0000000000 --- a/reference/solr/solrserverexception/getinternalinfo.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrServerException::getInternalInfo - Devuelve información interna de dónde fue lanzada la excepción - - - - &reftitle.description; - - public arraySolrServerException::getInternalInfo - - - - Devuelve información interna de dónde fue lanzada la excepción. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un array que contiene información interna de dónde se lanzó la excepción. Utilizado solamente con propósitos de depuración para desarrolladores de extensiones. - - - - - - diff --git a/reference/solr/solrupdateresponse.xml b/reference/solr/solrupdateresponse.xml deleted file mode 100644 index 6bd2102e22..0000000000 --- a/reference/solr/solrupdateresponse.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - - - La clase SolrUpdateResponse - SolrUpdateResponse - - - - -
    - &reftitle.intro; - - Representa una respuesta de una solicitud de actualización. - -
    - - -
    - &reftitle.classsynopsis; - - - - SolrUpdateResponse - - - - - final - SolrUpdateResponse - - - - extends - SolrResponse - - - - &Constants; - - const - int - SolrUpdateResponse::PARSE_SOLR_OBJ - 0 - - - const - int - SolrUpdateResponse::PARSE_SOLR_DOC - 1 - - - &InheritedProperties; - - - &Methods; - - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.constants; -
    - Constantes de la Clase SolrUpdateResponse - - - - SolrUpdateResponse::PARSE_SOLR_OBJ - - Los documentos deberían ser analizados como instancias de SolrObject - - - - - SolrUpdateResponse::PARSE_SOLR_DOC - - Los documentos deberían ser analizados como instancias de SolrDocument. - - - - -
    -
    - - - -
    - - &reference.solr.entities.solrupdateresponse; - -
    - - diff --git a/reference/solr/solrupdateresponse/construct.xml b/reference/solr/solrupdateresponse/construct.xml deleted file mode 100644 index 4df4806696..0000000000 --- a/reference/solr/solrupdateresponse/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - SolrUpdateResponse::__construct - Constructor - - - - &reftitle.description; - - public SolrUpdateResponse::__construct - - - - Constructor - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Nada - - - - - - diff --git a/reference/solr/solrupdateresponse/destruct.xml b/reference/solr/solrupdateresponse/destruct.xml deleted file mode 100644 index edfe3e7ff0..0000000000 --- a/reference/solr/solrupdateresponse/destruct.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - SolrUpdateResponse::__destruct - Destructor - - - - &reftitle.description; - - public SolrUpdateResponse::__destruct - - - - Destructor - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Nada - - - - - - diff --git a/reference/solr/solrutils.xml b/reference/solr/solrutils.xml deleted file mode 100644 index c8d2bc7fb7..0000000000 --- a/reference/solr/solrutils.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - La clase SolrUtils - SolrUtils - - - - -
    - &reftitle.intro; - - Contiene métodos de utilidad para recuperar la versión de la extensión actual y preparar frases de consultas. - - También contiene métodos para escapar cadenas de consultas y analizar respuestas XML. -
    - - -
    - &reftitle.classsynopsis; - - - - SolrUtils - - - - - abstract - SolrUtils - - - - - &Methods; - - - - -
    - -
    - - &reference.solr.entities.solrutils; - -
    - - diff --git a/reference/solr/solrutils/digestxmlresponse.xml b/reference/solr/solrutils/digestxmlresponse.xml deleted file mode 100644 index e9c1c736d1..0000000000 --- a/reference/solr/solrutils/digestxmlresponse.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - SolrUtils::digestXmlResponse - Convierte una cadena de respuesta XML a un objeto SolrObject - - - - &reftitle.description; - - public static SolrObjectSolrUtils::digestXmlResponse - stringxmlresponse - intparse_mode0 - - - Este método convierte una cadena de respuesta XML del servidor Apache Solr a un objeto SolrObject. Lanza una excepción SolrException si hubo un error. - - - - - - &reftitle.parameters; - - - - xmlresponse - - - La cadena de respuesta XML del servidor Solr. - - - - - parse_mode - - - Use SolrResponse::PARSE_SOLR_OBJ o SolrResponse::PARSE_SOLR_DOC - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto SolrObject que representa la respuesta XML. - - - Si el parámetro parse_mode setá establecido a SolrResponse::PARSE_SOLR_OBJ Solr los documentos serán analizados como instancias de SolrObject. - - si está establecido a SolrResponse::PARSE_SOLR_DOC, serán analizados como instancias de SolrDocument. - - - - - - diff --git a/reference/solr/solrutils/escapequerychars.xml b/reference/solr/solrutils/escapequerychars.xml deleted file mode 100644 index 24d7e7eb61..0000000000 --- a/reference/solr/solrutils/escapequerychars.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - SolrUtils::escapeQueryChars - Escapa un string de consulta lucene - - - - &reftitle.description; - - public static stringfalseSolrUtils::escapeQueryChars - stringstr - - - Lucene soporta el escape de caracteres especiales que son parte de la sintaxis de la consulta. - - - La lista actual de caracteres especiales es: - - - Estos caracteres son parte de la sintaxis de la consulta y deben ser escapados - - - - - &reftitle.parameters; - - - - str - - - Este es el string de consulta a ser escapda. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el string escapado &return.falseforfailure;. - - - - - - diff --git a/reference/solr/solrutils/getsolrversion.xml b/reference/solr/solrutils/getsolrversion.xml deleted file mode 100644 index 50c1ece566..0000000000 --- a/reference/solr/solrutils/getsolrversion.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SolrUtils::getSolrVersion - Devuelve la versión actual de la extensión Solr - - - - &reftitle.description; - - public static stringSolrUtils::getSolrVersion - - - - Devuelve la versión actual de Solr. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La versión actual de la extensión Apache Solr. - - - - - - diff --git a/reference/solr/solrutils/queryphrase.xml b/reference/solr/solrutils/queryphrase.xml deleted file mode 100644 index 49be24229b..0000000000 --- a/reference/solr/solrutils/queryphrase.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - SolrUtils::queryPhrase - Prepara una frase desde una cadena lucene sin escapar - - - - &reftitle.description; - - public static stringSolrUtils::queryPhrase - stringstr - - - Prepara una frase desde una cadena lucene sin escapar. - - - - - - &reftitle.parameters; - - - - str - - - La frase lucene. - - - - - - - - - &reftitle.returnvalues; - - Devuelve la frase entre comillas dobles. - - - - - - diff --git a/reference/sqlsrv/book.xml b/reference/sqlsrv/book.xml deleted file mode 100644 index 9d9b8de1ed..0000000000 --- a/reference/sqlsrv/book.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - Controlador Microsoft SQL Server para PHP - SQLSRV - - - - &reftitle.intro; - - La extensión SQLSRV permite acceder a un servidor de base de datos - Microsoft SQL y SQL Azure. La versión 3.0 del controlador soporta SQL Server, - comenzando por SQL Server 2005, e incluyendo SQL Server 2012 y SQL - Server 2012 LocalDB (para más información acerca de LocalDB, ver - el controlador PHP para el soporte de SQL Server para LocalDB - y SQL Server 2012 Express LocalDB.) - - - La extensión SQLSRV es soportada por Microsoft y está disponible para - descargar aquí : &url.sqlsrv;. - SQL Server 2012 LocalDB puede ser descargado aquí : - &url.sqlsrv.localdbdownload;. - - - - - &reference.sqlsrv.setup; - &reference.sqlsrv.constants; - &reference.sqlsrv.reference; - - - diff --git a/reference/sqlsrv/configure.xml b/reference/sqlsrv/configure.xml deleted file mode 100644 index 02a5ea79bc..0000000000 --- a/reference/sqlsrv/configure.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - -
    - &reftitle.install; - - La extensión SQLSRV se activa añadiendo la biblioteca DLL correspondiente - en el directorio de extensiones de PHP y añadiendo la entrada correspondiente - en el archivo &php.ini;. La descarga de SQLSRV incluye - 8 controladores, de los cuales 4 están dedicados al soporte de PDO. - - - La versión más reciente del controlador está disponible para su descarga aquí : - descarga de SQLSRV. - - - Para obtener más información sobre los requisitos previos de SQLSRV, consúltese el - capítulo sobre los - requisitos del sistema SQLSRV. - - - A partir de la versión 4.0, la extensión SQLSRV solo es compatible cuando PHP 7.0 funciona en Linux o Windows. - -
    - diff --git a/reference/sqlsrv/constants.xml b/reference/sqlsrv/constants.xml deleted file mode 100644 index 3e609c57a9..0000000000 --- a/reference/sqlsrv/constants.xml +++ /dev/null @@ -1,1017 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - - - SQLSRV_FETCH_ASSOC - (int) - - - - Obliga a sqlsrv_fetch_array a devolver un array - asociativo cuando se le pasa como argumento. - - - - - - SQLSRV_FETCH_NUMERIC - (int) - - - - Obliga a sqlsrv_fetch_array a devolver un array - indexado numéricamente cuando se le pasa como argumento. - - - - - - SQLSRV_FETCH_BOTH - (int) - - - - Obliga a sqlsrv_fetch_array a devolver un array - asociativo y un array indexado numéricamente cuando se le pasa como - argumento (comportamiento por defecto). - - - - - - SQLSRV_ERR_ALL - (int) - - - - Obliga a sqlsrv_errors a devolver los errores - y advertencias cuando se le pasa como argumento (comportamiento por - defecto). - - - - - - SQLSRV_ERR_ERRORS - (int) - - - - Obliga a sqlsrv_errors a devolver solo - los errores (no las advertencias) cuando se le pasa como argumento. - - - - - - SQLSRV_ERR_WARNINGS - (int) - - - - Obliga a sqlsrv_errors a devolver solo - las advertencias (no los errores) cuando se le pasa como argumento. - - - - - - SQLSRV_LOG_SYSTEM_ALL - (int) - - - - Activa los logs de todos los subsistemas cuando se le pasa a la función - sqlsrv_configure como argumento. - - - - - - SQLSRV_LOG_SYSTEM_CONN - (int) - - - - Activa los logs de toda la actividad de las conexiones cuando se le pasa - a la función sqlsrv_configure como argumento. - - - - - - SQLSRV_LOG_SYSTEM_INIT - (int) - - - - Activa los logs de toda la actividad de las inicializaciones cuando se le - pasa a la función sqlsrv_configure como argumento. - - - - - - SQLSRV_LOG_SYSTEM_OFF - (int) - - - - Desactiva los logs de todos los subsistemas cuando se le pasa a la función - sqlsrv_configure como argumento. - - - - - - SQLSRV_LOG_SYSTEM_STMT - (int) - - - - Activa los logs de las consultas cuando se le pasa a la función - sqlsrv_configure como argumento. - - - - - - SQLSRV_LOG_SYSTEM_UTIL - (int) - - - - Activa los logs de los errores de función cuando se le pasa a la función - sqlsrv_configure como argumento. - - - - - - SQLSRV_LOG_SEVERITY_ALL - (int) - - - - Activa los logs de los errores, advertencias y notas cuando se le - pasa a la función sqlsrv_configure como argumento. - - - - - - SQLSRV_LOG_SEVERITY_ERROR - (int) - - - - Especifica que los errores serán registrados cuando se le pasa a la función - sqlsrv_configure como argumento. - - - - - - SQLSRV_LOG_SEVERITY_NOTICE - (int) - - - - Especifica que las notas serán registradas cuando se le pasa a la función - sqlsrv_configure como argumento. - - - - - - SQLSRV_LOG_SEVERITY_WARNING - (int) - - - - Especifica que las advertencias serán registradas cuando se le pasa a - la función sqlsrv_configure como argumento. - - - - - - SQLSRV_NULLABLE_YES - (int) - - - - Indica que una columna puede ser nula. - - - - - - SQLSRV_NULLABLE_NO - (int) - - - - Indica que una columna no puede ser nula. - - - - - - SQLSRV_NULLABLE_UNKNOWN - (int) - - - - Indica si se conoce que una columna es nula. - - - - - - SQLSRV_PARAM_IN - (int) - - - - Indica un parámetro de entrada cuando se le pasa a la función - sqlsrv_query o a la función - sqlsrv_prepare. - - - - - - SQLSRV_PARAM_INOUT - (int) - - - - Indica un parámetro de entrada o salida cuando se le pasa a la - función sqlsrv_query o a la función - sqlsrv_prepare. - - - - - - SQLSRV_PARAM_OUT - (int) - - - - Indica un parámetro de salida cuando se le pasa a la función - sqlsrv_query o a la función - sqlsrv_prepare. - - - - - - SQLSRV_PHPTYPE_INT - (int) - - - - Especifica un dato de tipo entero PHP. Para más información, ver - Cómo especificar los tipos PHP. - - - - - - SQLSRV_PHPTYPE_DATETIME - (int) - - - - Especifica un dato de tipo datetime (fecha y hora) PHP. Para más información, ver - Cómo especificar los tipos PHP. - - - - - - SQLSRV_PHPTYPE_FLOAT - (int) - - - - Especifica un dato de tipo número de punto flotante PHP. Para más información, ver - Cómo especificar los tipos PHP. - - - - - - SQLSRV_PHPTYPE_STREAM - (int) - - - - Especifica un dato de tipo flujo de PHP. Esta constante funciona como una función - y acepta una constante codificada. Ver las constantes SQLSRV_ENC_*. Para más información, - reportez-vous a Cómo especificar los tipos PHP. - - - - - - SQLSRV_PHPTYPE_STRING - (int) - - - - Especifica un dato de tipo string PHP. Esta constante funciona como una función - y acepta una constante codificada. Ver las constantes SQLSRV_ENC_*. Para más información, - reportez-vous a Cómo especificar los tipos PHP. - - - - - - SQLSRV_ENC_BINARY - (int) - - - - Especifica que el dato es devuelto en forma de flujo bruto de bytes - desde el servidor sin realizar un codificación o transformación. Para más - información, reportez-vous a Cómo especificar - los tipos PHP. - - - - - - SQLSRV_ENC_CHAR - (int) - - - - El dato es devuelto en forma de caracteres de 8 bits, tal como - se especifica en la página de códigos Windows local, definida en el sistema. Cualquier - carácter multibyte o caracteres que no correspondan a esta página de código serán sustituidos - con un signo de interrogación de un byte (?). Es la codificación por defecto. Para más - información, reportez-vous a Cómo especificar los tipos PHP. - - - - - - SQLSRV_SQLTYPE_BIGINT - (int) - - - - Describe el tipo de datos bigint de SQL Server. Para más información, reportez-vous a - Cómo especificar los tipos SQL. - - - - - - SQLSRV_SQLTYPE_BINARY - (int) - - - - Describe el tipo de datos binario de SQL Server. Para más información, reportez-vous a - Cómo especificar los tipos SQL. - - - - - - SQLSRV_SQLTYPE_BIT - (int) - - - - Describe el tipo de datos bit de SQL Server. Para más información, reportez-vous a - Cómo especificar los tipos SQL. - - - - - - SQLSRV_SQLTYPE_CHAR - (int) - - - - Describe el tipo de datos carácter de SQL Server. Esta constante funciona como - una función y acepta un argumento indicando el número de caracteres. Para más - información, reportez-vous a - Cómo especificar los tipos SQL. - - - - - - SQLSRV_SQLTYPE_DATE - (int) - - - - Describe el tipo de datos date de SQL Server. Para más información, reportez-vous a - Cómo especificar los tipos SQL. - - - - - - SQLSRV_SQLTYPE_DATETIME - (int) - - - - Describe el tipo de datos datetime de SQL Server. Para más información, - reportez-vous a - Cómo especificar los tipos SQL. - - - - - - SQLSRV_SQLTYPE_DATETIME2 - (int) - - - - Describe el tipo de datos datetime2 de SQL Server. Para más información, reportez-vous - a Cómo especificar los tipos SQL. - - - - - - SQLSRV_SQLTYPE_DATETIMEOFFSET - (int) - - - - Describe el tipo de datos datetimeoffset de SQL Server. Para más información, reportez-vous - a Cómo especificar los tipos SQL. - - - - - - SQLSRV_SQLTYPE_DECIMAL - (int) - - - - Describe el tipo de datos decimal. Esta constante funciona como una función - y acepta 2 argumentos indicando (en orden) la precisión y la escala. - Para más información, reportez-vous - a Cómo especificar los tipos SQL. - - - - - - SQLSRV_SQLTYPE_FLOAT - (int) - - - - Describe el tipo de datos número de punto flotante de SQL Server. Para más información, reportez-vous - a Cómo especificar los tipos SQL. - - - - - - SQLSRV_SQLTYPE_IMAGE - (int) - - - - Describe el tipo de datos image de SQL Server. Para más información, reportez-vous - a Cómo especificar los tipos SQL. - - - - - - SQLSRV_SQLTYPE_INT - (int) - - - - Describe el tipo de datos entero de SQL Server. Para más información, reportez-vous - a Cómo especificar los tipos SQL. - - - - - - SQLSRV_SQLTYPE_MONEY - (int) - - - - Describe el tipo de datos moneda de SQL Server. Para más información, reportez-vous - a Cómo especificar los tipos SQL. - - - - - - SQLSRV_SQLTYPE_NCHAR - (int) - - - - Describe el tipo de datos nchar de SQL Server. Esta constante funciona como una - función y acepta un solo argumento indicando el número de caracteres. - Para más información, reportez-vous a - Cómo especificar los tipos SQL. - - - - - - SQLSRV_SQLTYPE_NUMERIC - (int) - - - - Describe el tipo de datos numérico de SQL Server. Esta constante funciona como - una función y acepta 2 argumentos (en orden), la precisión y la escala. - Para más información, reportez-vous a - Cómo especificar los tipos SQL. - - - - - - SQLSRV_SQLTYPE_NVARCHAR - (int) - - - - Describe el tipo de datos nvarchar de SQL Server. Esta constante funciona como una - función y acepta un solo argumento indicando el número de caracteres. - Para más información, reportez-vous a - Cómo especificar los tipos SQL. - - - - - - SQLSRV_SQLTYPE_NVARCHAR('max') - (int) - - - - Describe el tipo de datos nvarchar(MAX) de SQL Server. Para más información, reportez-vous - a Cómo especificar los tipos SQL. - - - - - - SQLSRV_SQLTYPE_NTEXT - (int) - - - - Describe el tipo de datos ntext de SQL Server. Para más información, reportez-vous - a Cómo especificar los tipos SQL. - - - - - - SQLSRV_SQLTYPE_REAL - (int) - - - - Describe el tipo de datos real de SQL Server. Para más información, reportez-vous - a Cómo especificar los tipos SQL. - - - - - - SQLSRV_SQLTYPE_SMALLDATETIME - (int) - - - - Describe el tipo de datos smalldatetime de SQL Server. Para más información, reportez-vous - a Cómo especificar los tipos SQL. - - - - - - SQLSRV_SQLTYPE_SMALLINT - (int) - - - - Describe el tipo de datos smallint de SQL Server. Para más información, reportez-vous - a Cómo especificar los tipos SQL. - - - - - - SQLSRV_SQLTYPE_SMALLMONEY - (int) - - - - Describe el tipo de datos smallmoney de SQL Server. Para más información, reportez-vous - a Cómo especificar los tipos SQL. - - - - - - SQLSRV_SQLTYPE_TEXT - (int) - - - - Describe el tipo de datos texto de SQL Server. Para más información, reportez-vous - a Cómo especificar los tipos SQL. - - - - - - SQLSRV_SQLTYPE_TIME - (int) - - - - Describe el tipo de datos time de SQL Server. Para más información, reportez-vous - a Cómo especificar los tipos SQL. - - - - - - SQLSRV_SQLTYPE_TIMESTAMP - (int) - - - - Describe el tipo de datos timestamp de SQL Server. Para más información, reportez-vous - a Cómo especificar los tipos SQL. - - - - - - SQLSRV_SQLTYPE_TINYINT - (int) - - - - Describe el tipo de datos tinyint de SQL Server. Para más información, reportez-vous - a Cómo especificar los tipos SQL. - - - - - - SQLSRV_SQLTYPE_UNIQUEIDENTIFIER - (int) - - - - Describe el tipo de datos uniqueidentifier de SQL Server. Para más información, reportez-vous - a Cómo especificar los tipos SQL. - - - - - - SQLSRV_SQLTYPE_UDT - (int) - - - - Describe el tipo de datos UDT de SQL Server. Para más información, reportez-vous - a Cómo especificar los tipos SQL. - - - - - - SQLSRV_SQLTYPE_VARBINARY - (int) - - - - Describe el tipo de datos varbinary de SQL Server. Esta constante funciona - como una función y acepta un solo argumento indicando el número de bytes. - Para más información, reportez-vous a - Cómo especificar los tipos SQL. - - - - - - SQLSRV_SQLTYPE_VARBINARY('max') - (int) - - - - Describe el tipo de datos varbinary(MAX) de SQL Server. Para más información, reportez-vous - a Cómo especificar los tipos SQL. - - - - - - SQLSRV_SQLTYPE_VARCHAR - (int) - - - - Describe el tipo de datos varchar de SQL Server. Esta constante funciona como - una función y acepta un solo argumento indicando el número de caracteres. - Para más información, reportez-vous a - Cómo especificar los tipos SQL. - - - - - - SQLSRV_SQLTYPE_VARCHAR('max') - (int) - - - - Describe el tipo de datos varchar(MAX) de SQL Server. Para más información, reportez-vous - a Cómo especificar los tipos SQL. - - - - - - SQLSRV_SQLTYPE_XML - (int) - - - - Describe el tipo de datos XML de SQL Server. Para más información, reportez-vous - a Cómo especificar los tipos SQL. - - - - - - SQLSRV_TXN_READ_UNCOMMITTED - (int) - - - - Indica un nivel de aislamiento de la transacción a READ UNCOMMITTED. - Este valor se utiliza para definir el nivel de aislamiento de la - transacción en el array $connectionOptions pasado a la función - sqlsrv_connect. - - - - - - SQLSRV_TXN_READ_COMMITTED - (int) - - - - Indica un nivel de aislamiento de la transacción a READ COMMITTED. - Este valor se utiliza para definir el nivel de aislamiento de la - transacción en el array $connectionOptions pasado a la función - sqlsrv_connect. - - - - - - SQLSRV_TXN_REPEATABLE_READ - (int) - - - - Indica un nivel de aislamiento de la transacción a REPEATABLE READ. - Este valor se utiliza para definir el nivel de aislamiento de la - transacción en el array $connectionOptions pasado a la función - sqlsrv_connect. - - - - - - SQLSRV_TXN_SNAPSHOT - (int) - - - - Indica un nivel de aislamiento de la transacción a SNAPSHOT. - Este valor se utiliza para definir el nivel de aislamiento de la - transacción en el array $connectionOptions pasado a la función - sqlsrv_connect. - - - - - - SQLSRV_TXN_READ_SERIALIZABLE - (int) - - - - Indica un nivel de aislamiento de la transacción a SERIALIZABLE. - Este valor se utiliza para definir el nivel de aislamiento de la - transacción en el array $connectionOptions pasado a la función - sqlsrv_connect. - - - - - - SQLSRV_CURSOR_FORWARD - (int) - - - - Indica un cursor de tipo "solo hacia adelante". Para más información, - reportez-vous a la sección sobre - la especificación de un tipo - de cursor y la selección de filas. - - - - - - SQLSRV_CURSOR_STATIC - (int) - - - - Indica un cursor de tipo "estático". Para más información, - reportez-vous a la sección sobre - la especificación de un tipo - de cursor y la selección de filas. - - - - - - SQLSRV_CURSOR_DYNAMIC - (int) - - - - Indica un cursor de tipo "dinámico". Para más información, - reportez-vous a la sección sobre - la especificación de un tipo - de cursor y la selección de filas. - - - - - - SQLSRV_CURSOR_KEYSET - (int) - - - - Indica un cursor de tipo "keyset". Para más información, - reportez-vous a la sección sobre - la especificación de un tipo - de cursor y la selección de filas. - - - - - - SQLSRV_CURSOR_BUFFERED - (int) - - - - Crea una consulta de cursor del lado del cliente. Esto permite acceder a - las filas en cualquier orden. Para más información sobre su uso, - reportez-vous a la sección sobre - la especificación de un tipo - de cursor y la selección de filas. - - - - - - SQLSRV_SCROLL_NEXT - (int) - - - - Especifica la fila a seleccionar en un conjunto de resultados. Para más información, - reportez-vous a la sección sobre - la especificación de un tipo - de cursor y la selección de filas. - - - - - - SQLSRV_SCROLL_PRIOR - (int) - - - - Especifica la fila a seleccionar en un conjunto de resultados. Para más información, - reportez-vous a la sección sobre - la especificación de un tipo - de cursor y la selección de filas. - - - - - - SQLSRV_SCROLL_FIRST - (int) - - - - Especifica la fila a seleccionar en un conjunto de resultados. Para más información, - reportez-vous a la sección sobre la - especificación de un tipo de cursor y la selección de filas. - - - - - - SQLSRV_SCROLL_LAST - (int) - - - - Especifica la fila a seleccionar en un conjunto de resultados. Para más información, - reportez-vous a la sección sobre la - especificación de un tipo de cursor y la selección de filas. - - - - - - SQLSRV_SCROLL_ABSOLUTE - (int) - - - - Especifica la fila a seleccionar en un conjunto de resultados. Para más información, - reportez-vous a la sección sobre la - especificación de un tipo de cursor y la selección de filas. - - - - - - SQLSRV_SCROLL_RELATIVE - (int) - - - - Especifica la fila a seleccionar en un conjunto de resultados. Para más información, - reportez-vous a la sección sobre la - especificación de un tipo de cursor y la selección de filas. - - - - - - diff --git a/reference/sqlsrv/functions/sqlsrv-begin-transaction.xml b/reference/sqlsrv/functions/sqlsrv-begin-transaction.xml deleted file mode 100644 index 4aabc1f654..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-begin-transaction.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - - sqlsrv_begin_transaction - Inicia una transacción de base de datos - - - &reftitle.description; - - boolsqlsrv_begin_transaction - resourceconn - - - La transacción iniciada por sqlsrv_begin_transaction incluye - todas las sentencias que fueron ejecutadas después de la llamada a - sqlsrv_begin_transaction y antes de llamar a - sqlsrv_rollback o sqlsrv_commit. - Las transacciones explícitas deben empezar y ser consolidadas (commit) o revertidas utilizando - estas funciones en vez de ejecutar sentencias SQL que empiecen y consoliden/reviertan - transacciones. Para más información, ver - SQLSRV Transactions. - - - - &reftitle.parameters; - - - conn - - - El recurso de la conexión devuelta por una llamada a sqlsrv_connect. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo de <function>sqlsrv_begin_transaction</function> - - El siguiente ejemplo demuestra cómo utilizar - sqlsrv_begin_transaction junto con - sqlsrv_commit y sqlsrv_rollback. - - -"dbName", "UID"=>"userName", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true )); -} - -/* Iniciar la transacción. */ -if ( sqlsrv_begin_transaction( $conn ) === false ) { - die( print_r( sqlsrv_errors(), true )); -} - -/* Inicializar los parámetros. */ -$orderId = 1; $qty = 10; $productId = 100; - -/* Preprar y ejecutar la primera sentencia . */ -$sql1 = "INSERT INTO OrdersTable (ID, Quantity, ProductID) - VALUES (?, ?, ?)"; -$params1 = array( $orderId, $qty, $productId ); -$stmt1 = sqlsrv_query( $conn, $sql1, $params1 ); - -/* Preparar y ejecutar la segunda sentencia. */ -$sql2 = "UPDATE InventoryTable - SET Quantity = (Quantity - ?) - WHERE ProductID = ?"; -$params2 = array($qty, $productId); -$stmt2 = sqlsrv_query( $conn, $sql2, $params2 ); - -/* Si ambas sentencias finalizaran con éxito, consolidar la transacción. */ -/* En caso contrario, revertirla. */ -if( $stmt1 && $stmt2 ) { - sqlsrv_commit( $conn ); - echo "Transaccion consolidada.
    "; -} else { - sqlsrv_rollback( $conn ); - echo "Transaccion revertida.
    "; -} -?> -]]> -
    - &example.outputs.similar; -
    -
    - - - &reftitle.seealso; - - sqlsrv_commit - sqlsrv_rollback - - -
    - diff --git a/reference/sqlsrv/functions/sqlsrv-cancel.xml b/reference/sqlsrv/functions/sqlsrv-cancel.xml deleted file mode 100644 index 2957d2c6eb..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-cancel.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - sqlsrv_cancel - Cancela una sentencia de base de datos - - - &reftitle.description; - - boolsqlsrv_cancel - resourcestmt - - - Cancela una sentencia de base de datos. Cualquier resultado asociado con la sentencia que no haya sido - utilizado será eliminado. Después de llamar a sqlsrv_cancel - , la sentencia especificada puede ser reejecutada si fue creada con - sqlsrv_prepare. No es necesario llamar a - sqlsrv_cancel si todos los resultados asociados se han - utilizado. - - - - - &reftitle.parameters; - - - stmt - - - El recurso de la sentencia que se va a cancelar. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo de <function>sqlsrv_cancel</function> - -"dbName", "UID"=>"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "SELECT Sales FROM Table_1"; - -$stmt = sqlsrv_prepare( $conn, $sql); - -if( $stmt === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -if( sqlsrv_execute( $stmt ) === false) { - die( print_r( sqlsrv_errors(), true)); -} - -$salesTotal = 0; -$count = 0; - -while( ($row = sqlsrv_fetch_array( $stmt)) && $salesTotal <=100000) -{ - $qty = $row[0]; - $price = $row[1]; - $salesTotal += ( $price * $qty); - $count++; -} - -echo "$count ventas suman los primeros $$salesTotal en ingresos.
    "; - -// Cancela los resultados pendientes. La sentencia se puede reutilizar. -sqlsrv_cancel( $stmt); -?> -]]> -
    -
    -
    - - - &reftitle.notes; - - La principal diferencia entre sqlsrv_cancel y - sqlsrv_free_stmt es que una sentencia cancelada con - sqlsrv_cancel puede ser reejecutada si fue creada con - sqlsrv_prepare. Una sentencia cancelada con - sqlsrv_free_statement no puede ser reejecutada. - - - - - &reftitle.seealso; - - sqlsrv_free_stmt - sqlsrv_prepare - - -
    - diff --git a/reference/sqlsrv/functions/sqlsrv-client-info.xml b/reference/sqlsrv/functions/sqlsrv-client-info.xml deleted file mode 100644 index b35cb43d29..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-client-info.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - sqlsrv_client_info - Devuelve información sobre el cliente y la conexión especificada - - - &reftitle.description; - - arraysqlsrv_client_info - resourceconn - - - Devuelve información sobre el cliente y la conexión especificada - - - - - &reftitle.parameters; - - - conn - - - La conexión sobre la que se va a retornar información. - - - - - - - - &reftitle.returnvalues; - - Devuelve un array asociativo con las claves que se describen en la tabla siguiente. - Devuelve &false; en caso constrario. - - Array devuelto por sqlsrv_client_info - - - - Clave - Descripción - - - - - DriverDllName - SQLNCLI10.DLL - - - DriverODBCVer - Versión ODBC (xx.yy) - - - DriverVer - Versión de la DLL del cliente nativo SQL Server (10.5.xxx) - - - ExtensionVer - Versión de la biblioteca php_sqlsrv.dll (2.0.xxx.x) - - - -
    -
    -
    - - - &reftitle.examples; - - Ejemplo de <function>sqlsrv_client_info</function> - -"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connOptions ); - -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -if( $client_info = sqlsrv_client_info( $conn)) { - foreach( $client_info as $key => $value) { - echo $key.": ".$value."
    "; - } -} else { - echo "Error al recuperar la información del cliente.
    "; -} -?> -]]> -
    -
    -
    - - - &reftitle.seealso; - - sqlsrv_server_info - - -
    - diff --git a/reference/sqlsrv/functions/sqlsrv-close.xml b/reference/sqlsrv/functions/sqlsrv-close.xml deleted file mode 100644 index 02dc0e039b..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-close.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - sqlsrv_close - Cierra una conexión abierta y libera los recursos asociados a la conexión - - - &reftitle.description; - - boolsqlsrv_close - resourceconn - - - Cierra una conexión abierta y libera los recursos asociados a la conexión. - - - - - &reftitle.parameters; - - - conn - - - La conexión que se va a cerrar. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo de <function>sqlsrv_close</function> - -"username", "PWD"=>"password", "Database"=>"dbname"); -$conn = sqlsrv_connect( $serverName, $connOptions ); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -//------------------------------------- -// Realizar aquí las operaciones contra la base de datos. -//------------------------------------- - -// Cerrar la conexión. -sqlsrv_close( $conn ); -?> -]]> - - - - - - &reftitle.seealso; - - sqlsrv_connect - - - - diff --git a/reference/sqlsrv/functions/sqlsrv-commit.xml b/reference/sqlsrv/functions/sqlsrv-commit.xml deleted file mode 100644 index d93ba9ada7..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-commit.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - - sqlsrv_commit - Consolida una transacción que se inició con sqlsrv_begin_transaction - - - &reftitle.description; - - boolsqlsrv_commit - resourceconn - - - Consolida una transacción que se inició con sqlsrv_begin_transaction. - La conexión retorna al modo auto-commit después de que se llame a sqlsrv_commit. - La transacción que se consolida incluye todas las sentencias que fueron - ejecutadas después de la llamada a sqlsrv_begin_transaction. - Las transacciones explícitas deben iniciarse y consolidarse o revertirse utilizando estas - funciones en vez de ejecutar las sentencias SQL que empiezan y consolidan/revierten - transacciones. Para más información, ver - SQLSRV Transactions. - - - - - &reftitle.parameters; - - - conn - - - La conexión en la que se va a consolidar la transacción. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo de <function>sqlsrv_commit</function> - - El siguiente ejemplo demuestra cómo utilizar sqlsrv_commit - junto con sqlsrv_begin_transaction y - sqlsrv_rollback. - - -"dbName", "UID"=>"userName", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true )); -} - -/* Empezar la transacción. */ -if ( sqlsrv_begin_transaction( $conn ) === false ) { - die( print_r( sqlsrv_errors(), true )); -} - -/* Inicializar los parámetros. */ -$orderId = 1; $qty = 10; $productId = 100; - -/* Preparar y ejecutar la primera sentencia. */ -$sql1 = "INSERT INTO OrdersTable (ID, Quantity, ProductID) - VALUES (?, ?, ?)"; -$params1 = array( $orderId, $qty, $productId ); -$stmt1 = sqlsrv_query( $conn, $sql1, $params1 ); - -/* Preparar y ejecutar la segunda sentencia. */ -$sql2 = "UPDATE InventoryTable - SET Quantity = (Quantity - ?) - WHERE ProductID = ?"; -$params2 = array($qty, $productId); -$stmt2 = sqlsrv_query( $conn, $sql2, $params2 ); - -/* Si ambas sentencias finalizan con éxito, consolidar la transacción. */ -/* En caso contrario, revertir la transacción. */ -if( $stmt1 && $stmt2 ) { - sqlsrv_commit( $conn ); - echo "Transacción consolidada.
    "; -} else { - sqlsrv_rollback( $conn ); - echo "Transacción revertida.
    "; -} -?> -]]> -
    -
    -
    - - - &reftitle.seealso; - - sqlsrv_begin_transaction - sqlsrv_rollback - - -
    - diff --git a/reference/sqlsrv/functions/sqlsrv-configure.xml b/reference/sqlsrv/functions/sqlsrv-configure.xml deleted file mode 100644 index dca9a8ab37..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-configure.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - sqlsrv_configure - Cambia la configuración de los drivers del gestionador de errores y de log - - - &reftitle.description; - - boolsqlsrv_configure - stringsetting - mixedvalue - - - Cambia la configuración de los drivers del gestionador de errores y de log. - - - - - &reftitle.parameters; - - - setting - - - El nombre de la propiedad a configurar. Los valores posibles son - "WarningsReturnAsErrors", "LogSubsystems", and "LogSeverity". - - - - - value - - - El valor de la propiedad especificada. La tabla siguiente muestra los valores posibles: - - Opciones de configuración de la gestión de errores y log - - - - Propiedades - Opciones - - - - - WarningsReturnAsErrors - 1 (&true;) o 0 (&false;) - - - LogSubsystems - SQLSRV_LOG_SYSTEM_ALL (-1) - SQLSRV_LOG_SYSTEM_CONN (2) - SQLSRV_LOG_SYSTEM_INIT (1) - SQLSRV_LOG_SYSTEM_OFF (0) - SQLSRV_LOG_SYSTEM_STMT (4) - SQLSRV_LOG_SYSTEM_UTIL (8) - - - LogSeverity - SQLSRV_LOG_SEVERITY_ALL (-1) - SQLSRV_LOG_SEVERITY_ERROR (1) - SQLSRV_LOG_SEVERITY_NOTICE (4) - SQLSRV_LOG_SEVERITY_WARNING (2) - - - -
    -
    -
    -
    -
    -
    - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - Gestionador de errores SQLSRV. - Actividad de log de SQLSRV. - - -
    - diff --git a/reference/sqlsrv/functions/sqlsrv-connect.xml b/reference/sqlsrv/functions/sqlsrv-connect.xml deleted file mode 100644 index af78e5476f..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-connect.xml +++ /dev/null @@ -1,171 +0,0 @@ - - - - - - - sqlsrv_connect - Establece una conexión con una base de datos Microsoft SQL Server - - - &reftitle.description; - - resourcesqlsrv_connect - stringserverName - arrayconnectionInfo - - - Establece una conexión con una base de datos Microsoft SQL Server. Por omisión, - la conexión intenta utilizar la autenticación Windows. Para conectarse - utilizando la autenticación SQL Server, se deben añadir los argumentos "UID" y "PWD" en el array de opciones de conexión. - - - - - &reftitle.parameters; - - - serverName - - - El nombre del servidor con el que se desea establecer la conexión. - Para conectarse a una instancia particular, se debe especificar el nombre - del servidor, seguido de un backslash, y luego el nombre de la instancia - (i.e. serverName\sqlexpress). - - - - - connectionInfo - - - Un array asociativo que especifica las opciones para la conexión al servidor. - Si los valores de las claves UID y PWD no están especificados, la conexión - intentará utilizar la autenticación Windows. Para una lista completa - de las claves soportadas, consulte las - opciones de conexión SQLSRV. - - - - - - - - &reftitle.returnvalues; - - Un recurso de conexión. Si la conexión no pudo ser abierta, se retornará &false;. - - - - - &reftitle.examples; - - Conexión utilizando la autenticación Windows. - -"dbName"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); - -if( $conn ) { - echo "Conexión establecida.
    "; -}else{ - echo "La conexión no pudo ser establecida.
    "; - die( print_r( sqlsrv_errors(), true)); -} -?> -]]> -
    -
    - - Conexión especificando un nombre de usuario y una contraseña. - -"dbName", "UID"=>"userName", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); - -if( $conn ) { - echo "Conexión establecida.
    "; -}else{ - echo "La conexión no pudo ser establecida.
    "; - die( print_r( sqlsrv_errors(), true)); -} -?> -]]> -
    -
    - - Conexión a un puerto específico. - -"dbName", "UID"=>"userName", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); - -if( $conn ) { - echo "Conexión establecida.
    "; -}else{ - echo "La conexión no pudo ser establecida.
    "; - die( print_r( sqlsrv_errors(), true)); -} -?> -]]> -
    -
    -
    - - - &reftitle.notes; - - Por omisión, la función sqlsrv_connect utiliza la cola de conexiones - para aumentar el rendimiento. Para desactivar esta cola de conexiones - (i.e. y así, forzar una nueva conexión en cada llamada a la función), se debe definir - la opción "ConnectionPooling" en el array $connectionOptions a 0 (o &false;). - Para más información, consulte el capítulo sobre la - cola de conexiones SQLSRV. - - - La extensión SQLSRV no tiene una función dedicada para modificar la base de datos - a la que está conectada. La base de datos objetivo se especifica - en el array $connectionOptions pasado a la función sqlsrv_connect. - Para cambiar la base de datos en una conexión abierta, se debe ejecutar la siguiente consulta: - "USE dbName" (i.e. sqlsrv_query($conn, "USE dbName")). - - - - - &reftitle.seealso; - - sqlsrv_close - sqlsrv_errors - sqlsrv_query - - -
    - diff --git a/reference/sqlsrv/functions/sqlsrv-errors.xml b/reference/sqlsrv/functions/sqlsrv-errors.xml deleted file mode 100644 index 32d4d69da2..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-errors.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - - sqlsrv_errors - Devuelve información de errores y alertas (warnings) de la última operación SQLSRV realizada - - - &reftitle.description; - - - mixedsqlsrv_errors - interrorsOrWarnings - - - Devuelve información de errores y alertas de la última operación SQLSRV realizada. - - - - - &reftitle.parameters; - - - errorsOrWarnings - - - Determina si se ha de retornar información de error, alertas, o - ambas. Si este parámetro no se informa, se devolverá tanto información de error como - de alerta. Este parámetro puede tomar los - siguientes valores: SQLSRV_ERR_ALL, SQLSRV_ERR_ERRORS, SQLSRV_ERR_WARNINGS. - - - - - - - - &reftitle.returnvalues; - - Si se produjeron errores y/o warnings en la última operación sqlsrv, se devolverá un array de - arrays conteniendo información de error. Si no se produjeron errores y/o alertas - en la última operación sqlsrv, se devolverá &null;. La siguiente tabla - describe la estructura de los arrays devueltos: - - Array devuelto por sqlsrv_errors - - - - Clave - Descripción - - - - - SQLSTATE - Para errores que se originan en el driver ODBC driver, el SQLSTATE devuelto - por ODBC. Para errores que se originan en los drivers de Microsoft para PHP para - SQL Server, un SQLSTATE de IMSSP. Para alertas que se originan en los drivers de - Microsoft para PHP para SQL Server, un SQLSTATE de 01SSP. - - - - code - Para errores que se originan en SQL Server, el código de error SQL Server - nativo. Para errores que se originan en el driver ODBC, el código - de error devuelto por ODBC. Para errores que se originan en los Drivers de Microsoft - para PHP para SQL Server, los códigos de error de SQL Server para los Drivers de Microsoft para PHP. - - - - message - Una descripción del error. - - - -
    -
    -
    - - - &reftitle.examples; - - ejemplo de <function>functionname</function> - -"dbName", "UID"=>"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -/* Query que selecciona un nombre de columna inválida. */ -$sql = "SELECT BadColumnName FROM Table_1"; - -/* Ejecución de la query que fallará debido al nombre de columna incorrecto. */ -$stmt = sqlsrv_query( $conn, $sql ); -if( $stmt === false ) { - if( ($errors = sqlsrv_errors() ) != null) { - foreach( $errors as $error ) { - echo "SQLSTATE: ".$error[ 'SQLSTATE']."
    "; - echo "code: ".$error[ 'code']."
    "; - echo "message: ".$error[ 'message']."
    "; - } - } -} -?> -]]> -
    -
    -
    - - - &reftitle.notes; - - Por defecto, las alertas generadas en una llamada a cualquier función SQLSRV se tratarán - como errores. Esto significa que si una alerta ocurre en una llamada a una función SQLSRV, - la función devolverá &false;. Sin embargo, las alertas correspondientes a los valores de - SQLSTATE 01000, 01001, 01003, y 01S02 nunca se tratarán como errores. Para - obtener información sobre cómo cambiar este comportamiento, ver sqlsrv_configure - y la configuración de WarningsReturnAsErrors. - - - - - &reftitle.seealso; - - sqlsrv_configure - - -
    - diff --git a/reference/sqlsrv/functions/sqlsrv-execute.xml b/reference/sqlsrv/functions/sqlsrv-execute.xml deleted file mode 100644 index 1da1ab8551..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-execute.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - - sqlsrv_execute - Ejecuta una sentencia preparada con sqlsrv_prepare - - - &reftitle.description; - - boolsqlsrv_execute - resourcestmt - - - Ejecuta una sentencia preparada con sqlsrv_prepare. Esta - función es ideal para ser ejecutar múltiples veces una sentencia preparada - con diferentes valores de parámetros. - - - - - &reftitle.parameters; - - - stmt - - - Un recurso de sentencia devuelto por sqlsrv_prepare. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - ejemplo de <function>sqlsrv_execute</function> - - Este ejemplo muestra como preparar una sentencia con - sqlsrv_prepare y reejecutarla múltiples veces (con - diferentes valores de parámetros) utilizando sqlsrv_execute. - - -"dbName", "UID"=>"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "UPDATE Table_1 - SET OrderQty = ? - WHERE SalesOrderID = ?"; - -// Inicializar los parámetros y preparar la sentencia. -// Las variables $qty y $id se pasan como parámetro a la sentencia $stmt. -$qty = 0; $id = 0; -$stmt = sqlsrv_prepare( $conn, $sql, array( &$qty, &$id)); -if( !$stmt ) { - die( print_r( sqlsrv_errors(), true)); -} - -// Configurar la información de SalesOrderDetailID y OrderQty. -// Este array liga el orden ID al orden de cantidad en las parejas key=>value. -$orders = array( 1=>10, 2=>20, 3=>30); - -// Ejecuta la sentencia para cada orden. -foreach( $orders as $id => $qty) { - // Como $id y $qty se pasan como parámetro a $stmt1, sus valores - // actualizados se utilizan en cada ejecución de la sentencia. - if( sqlsrv_execute( $stmt ) === false ) { - die( print_r( sqlsrv_errors(), true)); - } -} -?> -]]> - - - - - - &reftitle.notes; - - Cuando se prepara una sentencia que utiliza variables como parámetros, las variables - se pasan como parámetros a la sentencia. Esto significa que si se actualizan los valores de las - variables, la próxima vez que se ejecute la sentencia lo hará con los nuevos valores - de los parámetros. Para las sentencias que se quieran ejecutar únicamente una vez, utilizar - sqlsrv_query. - - - - - &reftitle.seealso; - - sqlsrv_prepare - sqlsrv_query - - - - diff --git a/reference/sqlsrv/functions/sqlsrv-fetch-array.xml b/reference/sqlsrv/functions/sqlsrv-fetch-array.xml deleted file mode 100644 index 3d30d4258c..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-fetch-array.xml +++ /dev/null @@ -1,190 +0,0 @@ - - - - - - - sqlsrv_fetch_array - Devuelve una fila como un array - - - &reftitle.description; - - arraysqlsrv_fetch_array - resourcestmt - intfetchType - introw - intoffset - - - Devuelve la siguiente fila de datos disponible como un array asociativo, un array - numérico, o ambos (por defecto). - - - - - &reftitle.parameters; - - - stmt - - - Un recurso de sentencia devuelta por sqlsrv_query o sqlsrv_prepare. - - - - - fetchType - - - Una constante predefinida con el tipo de array a devolver. Los valores - posibles son SQLSRV_FETCH_ASSOC, - SQLSRV_FETCH_NUMERIC, y - SQLSRV_FETCH_BOTH (por defecto). - - - El tipo de objeto devuelto SQLSRV_FETCH_ASSOC no debe utilizarse cuando se trate un - conjunto de resultados con múltiples columnas con el mismo nombre. - - - - - row - - - Especifica la fila para acceder a un conjunto de resultados que utiliza un cursor con scroll. - Los valores posibles son SQLSRV_SCROLL_NEXT, - SQLSRV_SCROLL_PRIOR, SQLSRV_SCROLL_FIRST, - SQLSRV_SCROLL_LAST, SQLSRV_SCROLL_ABSOLUTE y, - SQLSRV_SCROLL_RELATIVE (por defecto). Cuando se especifica - este parámetro, el parámetro fetchType debe ser definido explícitamente. - - - - - offset - - - Especifica la fila a la que se desea acceder si el parámetro de fila se define como - SQLSRV_SCROLL_ABSOLUTE o - SQLSRV_SCROLL_RELATIVE. Notar que la primera fila - en un conjunto de resultado tiene el índice 0. - - - - - - - - &reftitle.returnvalues; - - Devuelve un array en caso de éxito, &null; si no hay más filas a devolver, y - &false; si se produce un error. - - - - - &reftitle.examples; - - Devolver un array asociativo. - -"dbName", "UID"=>"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo ); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "SELECT FirstName, LastName FROM SomeTable"; -$stmt = sqlsrv_query( $conn, $sql ); -if( $stmt === false) { - die( print_r( sqlsrv_errors(), true) ); -} - -while( $row = sqlsrv_fetch_array( $stmt, SQLSRV_FETCH_ASSOC) ) { - echo $row['LastName'].", ".$row['FirstName']."
    "; -} - -sqlsrv_free_stmt( $stmt); -?> -]]> -
    -
    - - Devolver un array numérico. - -"dbName", "UID"=>"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo ); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "SELECT FirstName, LastName FROM SomeTable"; -$stmt = sqlsrv_query( $conn, $sql ); -if( $stmt === false) { - die( print_r( sqlsrv_errors(), true) ); -} - -while( $row = sqlsrv_fetch_array( $stmt, SQLSRV_FETCH_NUMERIC) ) { - echo $row[0].", ".$row[1]."
    "; -} - -sqlsrv_free_stmt( $stmt); -?> -]]> -
    -
    -
    - - - &reftitle.notes; - - Cuando no se especifica el parámetro fetchType o se utiliza explícitamente la constante - SQLSRV_FETCH_TYPE en los ejemplos anteriores, se - devolverá un array que tiene tanto claves asociativas como claves nuéricas. - - - Si se devuelve más de una columna con el mismo nombre, la última columna - tendrá prioridad para tomar el nombre. Para evitar colisiones de nombre de campo, utilizar alias. - - - Si se devuelve una columna sin nombre, la clave asociativa para ese elemento del array - será un string vacío (""). - - - - - &reftitle.seealso; - - sqlsrv_connect - sqlsrv_query - sqlsrv_errors - sqlsrv_fetch - - -
    - diff --git a/reference/sqlsrv/functions/sqlsrv-fetch-object.xml b/reference/sqlsrv/functions/sqlsrv-fetch-object.xml deleted file mode 100644 index 6ab6be1714..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-fetch-object.xml +++ /dev/null @@ -1,186 +0,0 @@ - - - - - - - sqlsrv_fetch_object - Devuelve la siguiente fila de datos de un conjunto resultado como un objeto - - - &reftitle.description; - - mixedsqlsrv_fetch_object - resourcestmt - stringclassName - arrayctorParams - introw - intoffset - - - Devuelve la siguiente fila de datos de un conjunto resultado como una instancia de la clase - especificada, donde las propiedades correspondientes a los nombres de los campos de la fila recuperada y los valores, se corresponden con - los valores de la fila recuperada. - - - - - &reftitle.parameters; - - - stmt - - - Un recurso de consulta creado por sqlsrv_query o - sqlsrv_execute. - - - - - className - - - El nombre de la clase a instanciar. Si no se especifica el nombre de la clase, - se instanciará la clase stdClass. - - - - - ctorParams - - - Los valores pasados al constructor de la clase especificada. Si el constructor - de la clase especificada tiene parámetros, se proporcionará el array - ctorParams. - - - - - row - - - La fila a la que se accederá. Este parámetro únicamente puede utilizarse si la consulta - especificada se preparó con un cursor con scroll. En ese caso, este parámetro - puede tomar uno de los siguientes valores: - - SQLSRV_SCROLL_NEXT - SQLSRV_SCROLL_PRIOR - SQLSRV_SCROLL_FIRST - SQLSRV_SCROLL_LAST - SQLSRV_SCROLL_ABSOLUTE - SQLSRV_SCROLL_RELATIVE - - - - - - offset - - - Especifica la fila a la que se accederá si el parámetro de fila se ha especificado como - SQLSRV_SCROLL_ABSOLUTE o - SQLSRV_SCROLL_RELATIVE. Notar que la primera fila en un - conjunto de resultado tiene el índice 0. - - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto en caso de éxito, &null; si no hay más filas a devolver, - y &false; si se produce un error o si la clase especificada no existe. - - - - - &reftitle.examples; - - Ejemplo con <function>sqlsrv_fetch_object</function> - - El siguiente ejemplo demuestra cómo devolver una columna como un objeto stdClass. - - -"dbName", "UID"=>"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "SELECT fName, lName FROM Table_1"; -$stmt = sqlsrv_query( $conn, $sql); -if( $stmt === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -// Devolver cada fila como un objeto. -// Puesto que no se especifica ninguna clase, cada fila devolverá un objeto stdClass. -// Los nombres de propiedades corresponden a nombres de campo. -while( $obj = sqlsrv_fetch_object( $stmt)) { - echo $obj->fName.", ".$obj->lName."
    "; -} -?> -]]> -
    -
    -
    - - - &reftitle.notes; - - Si se especifica un nombre de clase con el parámetro opcional $className y la - clase tiene propiedades cuyos nombres coinciden con los nombres de campos del conjunto de resultado, los valores correspondientes - del conjunto de resultado se aplicarán a las propiedades. Si un nombre de campo del conjunto resultado - no coincide con ninguna propiedad de clase, una propiedad con el nombre de campo se añadirá al - objeto del conjunto resultado y el valor del resultado se aplicará a la propiedad. Se aplican las - reglas siguientes cuando se utiliza el parámetro $className: - - El nombre de propiedad de campo coincidente es sensible al uso de mayúsculas y minúsculas (es case sensitive). - La coincidencia con la propiedad de campo se da aunque se utilicen modificadores de acceso. - Los tipos de datos de la propiedad de clase se ignoran cuando se aplica un valor de campo a la propiedad. - Si la clase no existe, la función devuelve &false; y añade un error a la colección de errores. - - A pesar de que se defina el parámetro $className, si se devuelve un campo sin - nombre, el valor de campo será ignorado y se añadirá una alerta - a la colección de errores. - - - Cuando se trate un conjunto de resultado que tenga varias columnas con el mismo nombre, podría - ser mejor utilizar sqlsrv_fetch_array o la combinación de - sqlsrv_fetch y sqlsrv_get_field. - - - - - &reftitle.seealso; - - sqlsrv_fetch - sqlsrv_fetch_array - - -
    - diff --git a/reference/sqlsrv/functions/sqlsrv-fetch.xml b/reference/sqlsrv/functions/sqlsrv-fetch.xml deleted file mode 100644 index 495d725a47..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-fetch.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - - - sqlsrv_fetch - Hace que esté disponible para ser leída la siguiente fila del conjunto de resultado - - - &reftitle.description; - - - mixedsqlsrv_fetch - resourcestmt - introw - intoffset - - - Hace que esté disponible para ser leída la siguiente fila del conjunto de resultado. Utilizar - sqlsrv_get_field para leer los campos de la fila. - - - - - &reftitle.parameters; - - - stmt - - - Un recurso de consulta creado por la ejecución de sqlsrv_query - o sqlsrv_execute. - - - - - row - - - La fila que será accedida. Este parámetro puede utilizarse si la consulta - especificada se preparó con un cursor con scroll. En ese caso, el parámetro - puede tomar uno de los siguientes valores: - - SQLSRV_SCROLL_NEXT - SQLSRV_SCROLL_PRIOR - SQLSRV_SCROLL_FIRST - SQLSRV_SCROLL_LAST - SQLSRV_SCROLL_ABSOLUTE - SQLSRV_SCROLL_RELATIVE - - - - - - offset - - - Especifica la fila que será accedida si el parámetro de fila se configura como - SQLSRV_SCROLL_ABSOLUTE o - SQLSRV_SCROLL_RELATIVE. Notar que la primera fila en el - conjunto resultado tiene el índice 0. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si la fila siguiente del conjunto de resultado se obtuvo satisfactoriamente, - &false; si se produce un error, y &null; si no hay más filas en el conjunto de resultado. - - - - - &reftitle.examples; - - Ejemplo con <function>sqlsrv_fetch</function> - - El ejemplo siguiente demuestra como obtener una fila con - sqlsrv_fetch y los campos de la fila con - sqlsrv_get_field. - - -"dbName", "UID"=>"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "SELECT Name, Comment - FROM Table_1 - WHERE ReviewID=1"; -$stmt = sqlsrv_query( $conn, $sql); -if( $stmt === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -// Hacer que sea disponible para su lectura la primera (y en este caso única) fila del conjunto resultado. -if( sqlsrv_fetch( $stmt ) === false) { - die( print_r( sqlsrv_errors(), true)); -} - -// Obtener los campos de la fila. Los índices de campo empiezan desde 0 y se deben obtener en orden. -// Recuperar los nombres de campo por su nombre no está soportado por sqlsrv_get_field. -$name = sqlsrv_get_field( $stmt, 0); -echo "$name: "; - -$comment = sqlsrv_get_field( $stmt, 1); -echo $comment; -?> -]]> - - - - - - - &reftitle.seealso; - - sqlsrv_get_field - sqlsrv_fetch_array - sqlsrv_fetch_object - - - - diff --git a/reference/sqlsrv/functions/sqlsrv-field-metadata.xml b/reference/sqlsrv/functions/sqlsrv-field-metadata.xml deleted file mode 100644 index a1309a151f..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-field-metadata.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - - sqlsrv_field_metadata - Recupera los datos meta para los campos de una consulta preparada por la función - sqlsrv_prepare o la función sqlsrv_query - - - - &reftitle.description; - - mixedsqlsrv_field_metadata - resourcestmt - - - Recupera los datos meta para los campos de una consulta preparada por la función - sqlsrv_prepare o la función sqlsrv_query. - La función sqlsrv_field_metadata puede ser llamada sobre una - consulta antes o después de su ejecución. - - - - - &reftitle.parameters; - - - stmt - - - Un recurso de consulta desde el cual los datos meta serán - recuperados. - - - - - - - - &reftitle.returnvalues; - - Devuelve un array de arrays en caso de éxito. De lo contrario, &false; es devuelto. - Cada array devuelto es descrito en la tabla siguiente: - - Array devuelto por la función sqlsrv_field_metadata - - - - Clave - Descripción - - - - - Name - El nombre del campo. - - - Type - El valor numérico para el tipo SQL. - - - Size - El número de caracteres para los campos de tipo caracteres, - el número de bytes para los campos de tipo binario, o &null; para - los otros tipos. - - - Precision - La precisión para las variables de tipo precisión, &null; para los - otros tipos. - - - Scale - - La escala para las variables de tipo scale, &null; para los otros tipos. - - - Nullable - Una enumeración indicando si la columna puede ser nula, no puede serlo, - o si esta información no es conocida. - - - -
    - Para más información, consulte la documentación sobre la función - sqlsrv_field_metadata de la - documentación Microsoft SQLSRV. -
    -
    - - - &reftitle.examples; - - Ejemplo con <function>sqlsrv_field_metadata</function> - -"AdventureWorks", "UID"=>"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "SELECT * FROM Table_1"; -$stmt = sqlsrv_prepare( $conn, $sql ); - -foreach( sqlsrv_field_metadata( $stmt ) as $fieldMetadata ) { - foreach( $fieldMetadata as $name => $value) { - echo "$name: $value
    "; - } - echo "
    "; -} -?> -]]> -
    -
    -
    - - - &reftitle.seealso; - - sqlsrv_client_info - - -
    - diff --git a/reference/sqlsrv/functions/sqlsrv-free-stmt.xml b/reference/sqlsrv/functions/sqlsrv-free-stmt.xml deleted file mode 100644 index 105dc219b8..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-free-stmt.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - sqlsrv_free_stmt - Libera todos los recursos de la consulta especificada - - - &reftitle.description; - - boolsqlsrv_free_stmt - resourcestmt - - - Libera todos los recursos para la consulta especificada. La consulta no podrá - ser utilizada después de pasar a la función sqlsrv_free_stmt. - Si la función sqlsrv_free_stmt es llamada mientras la - consulta está en ejecución, la ejecución de la consulta es interrumpida - y la consulta es cancelada. - - - - - &reftitle.parameters; - - - stmt - - - La consulta cuyos recursos serán liberados. - Tenga en cuenta que &null; es un valor de argumento válido. Este valor - permite que la función sea llamada varias veces en un script. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>sqlsrv_free_stmt</function> - -"dbName", "UID"=>"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -$stmt = sqlsrv_query( $conn, "SELECT * FROM Table_1"); -if( $stmt === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -/*------------------------------- - Uso de la consulta aquí. --------------------------------*/ - -/* Liberación de los recursos asociados a la consulta. */ -sqlsrv_free_stmt( $stmt); - -?> -]]> - - - - - - &reftitle.notes; - - La principal diferencia entre la función sqlsrv_free_stmt y - la función sqlsrv_cancel es que un recurso de consulta - cancelado con la función sqlsrv_cancel puede ser re-ejecutado - si ha sido creado con la función sqlsrv_prepare. - Un recurso de consulta cancelado con la función - sqlsrv_free_statement no puede ser re-ejecutado. - - - - - &reftitle.seealso; - - sqlsrv_cancel - - - - diff --git a/reference/sqlsrv/functions/sqlsrv-get-config.xml b/reference/sqlsrv/functions/sqlsrv-get-config.xml deleted file mode 100644 index 11c9873f3c..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-get-config.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - sqlsrv_get_config - Devuelve el valor de la configuración especificada - - - &reftitle.description; - - mixedsqlsrv_get_config - stringsetting - - - Devuelve el valor de la configuración especificada. - - - - - &reftitle.parameters; - - - setting - - - El nombre de la configuración para la cual se devolverá el valor. Para una lista de las configuraciones, ver la función sqlsrv_configure. - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor de la configuración solicitada. Si se proporciona una configuración no válida, se devolverá &false;. - - - - - &reftitle.seealso; - - sqlsrv_configure - - - - diff --git a/reference/sqlsrv/functions/sqlsrv-get-field.xml b/reference/sqlsrv/functions/sqlsrv-get-field.xml deleted file mode 100644 index b23664ea92..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-get-field.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - - sqlsrv_get_field - Recupera los datos del campo desde la línea actualmente seleccionada - - - &reftitle.description; - - mixedsqlsrv_get_field - resourcestmt - intfieldIndex - intgetAsType - - - Recupera los datos del campo desde la línea actualmente seleccionada. - Los campos deben ser leídos en orden. Sus índices comienzan en 0. - - - - - &reftitle.parameters; - - - stmt - - - Un recurso de consulta devuelto por la función - sqlsrv_query o la función - sqlsrv_execute. - - - - - fieldIndex - - - El índice del campo a recuperar. Los índices de los campos comienzan en 0. - Los campos deben ser leídos en orden, es decir, si se accede al campo - con índice 1, el campo con índice 0 ya no estará disponible. - - - - - getAsType - - - El tipo de datos PHP para los datos del campo devuelto. Si este argumento - no está definido, los datos del campo serán devueltos en forma de un tipo de datos PHP por omisión. Para más información sobre los - tipos de datos PHP por omisión, consulte la sección sobre - los tipos de datos PHP por omisión - de la documentación Microsoft SQLSRV. - - - - - - - - &reftitle.returnvalues; - - Devuelve los datos desde el campo especificado en caso de éxito. - Devuelve &false; si ocurre un error. - - - - - &reftitle.examples; - - <function>sqlsrv_get_field</function> example - - El siguiente ejemplo muestra cómo recuperar una línea con la - función sqlsrv_fetch y recupera - los campos de la línea con la función sqlsrv_get_field. - - -"dbName", "UID"=>"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "SELECT Name, Comment - FROM Table_1 - WHERE ReviewID=1"; -$stmt = sqlsrv_query( $conn, $sql); -if( $stmt === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -// Hace disponible la primera (y en este caso, la única) línea del conjunto de resultados para lectura. -if( sqlsrv_fetch( $stmt ) === false) { - die( print_r( sqlsrv_errors(), true)); -} - -// Recupera los campos de la línea. Los índices comienzan en 0 y deben ser recuperados en orden. -// La recuperación de los campos de la línea por sus nombres no es soportada por la función sqlsrv_get_field. -$name = sqlsrv_get_field( $stmt, 0); -echo "$name: "; - -$comment = sqlsrv_get_field( $stmt, 1); -echo $comment; -?> -]]> - - - - - - &reftitle.seealso; - - sqlsrv_fetch - sqlsrv_fetch_array - sqlsrv_fetch_object - - - - diff --git a/reference/sqlsrv/functions/sqlsrv-has-rows.xml b/reference/sqlsrv/functions/sqlsrv-has-rows.xml deleted file mode 100644 index 217ea9b686..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-has-rows.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - sqlsrv_has_rows - Indica si la consulta especificada contiene filas - - - &reftitle.description; - - boolsqlsrv_has_rows - resourcestmt - - - Indica si la consulta especificada contiene filas. - - - - - &reftitle.parameters; - - - stmt - - - Un recurso de consulta devuelto por la función - sqlsrv_query o la función - sqlsrv_execute. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si la consulta especificada contiene filas, - &false; si no contiene ninguna o si ocurre un error. - - - - - &reftitle.examples; - - Ejemplo con <function>sqlsrv_has_rows</function> - -"dbName", "UID"=>"username", "PWD"=>"password" ); -$conn = sqlsrv_connect( $server, $connectionInfo ); - -$stmt = sqlsrv_query( $conn, "SELECT * FROM Table_1"); - -if ($stmt) { - $rows = sqlsrv_has_rows( $stmt ); - if ($rows === true) - echo "Hay filas.
    "; - else - echo "No hay filas.
    "; -} -?> -]]> -
    -
    -
    - - - &reftitle.seealso; - - sqlsrv_num_rows - sqlsrv_query - - -
    - diff --git a/reference/sqlsrv/functions/sqlsrv-next-result.xml b/reference/sqlsrv/functions/sqlsrv-next-result.xml deleted file mode 100644 index 50c5a2eaad..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-next-result.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - sqlsrv_next_result - Activa el siguiente resultado de la consulta especificada - - - &reftitle.description; - - mixedsqlsrv_next_result - - resourcestmt - - - Activa el siguiente resultado de la consulta especificada. Los resultados - incluyen los conjuntos de resultados, el número de filas y los parámetros - de salida. - - - - - &reftitle.parameters; - - - stmt - - - La consulta sobre la cual se llamará el siguiente resultado. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si el siguiente resultado ha sido recuperado con éxito, - &false; si ocurre un error, y &null; si no hay más - resultados para recuperar. - - - - - &reftitle.examples; - - Ejemplo con <function>sqlsrv_next_result</function> - - El siguiente ejemplo ejecuta una consulta batch que realiza inserciones - en una tabla y luego realiza una selección de la tabla. Esto produce - 2 resultados en la consulta: uno para las filas afectadas por el INSERT, - y otro para las filas devueltas por el SELECT. Para recuperar las filas - devueltas por el SELECT, la función sqlsrv_next_result - debe ser llamada para pasar el primer resultado. - - -"dbName", "UID"=>"userName", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); - -$query = "INSERT INTO Table_1 (id, data) VALUES (?,?); SELECT * FROM TABLE_1;"; -$params = array(1, "some data"); -$stmt = sqlsrv_query($conn, $query, $params); - -// Consume el primer resultado (filas afectadas por el INSERT) sin llamar a la función sqlsrv_next_result. -echo "Filas afectadas : ".sqlsrv_rows_affected($stmt)."
    "; - -// Se mueve al siguiente resultado y muestra los resultados. -$next_result = sqlsrv_next_result($stmt); -if( $next_result ) { - while( $row = sqlsrv_fetch_array( $stmt, SQLSRV_FETCH_ASSOC)){ - echo $row['id']." : ".$row['data']."
    "; - } -} elseif( is_null($next_result)) { - echo "No hay más resultados.
    "; -} else { - die(print_r(sqlsrv_errors(), true)); -} -?> -]]> -
    -
    -
    - - - &reftitle.seealso; - - sqlsrv_query - sqlsrv_fetch_array - sqlsrv_rows_affected - - -
    - diff --git a/reference/sqlsrv/functions/sqlsrv-num-fields.xml b/reference/sqlsrv/functions/sqlsrv-num-fields.xml deleted file mode 100644 index d74cb6d2b0..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-num-fields.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - sqlsrv_num_fields - Recupera el número de campos (columnas) en una consulta - - - &reftitle.description; - - mixedsqlsrv_num_fields - resourcestmt - - - Recupera el número de campos (columnas) en una consulta. - - - - - &reftitle.parameters; - - - stmt - - - La consulta desde la cual se devuelve el número de campos. - La función sqlsrv_num_fields puede ser - llamada sobre una consulta antes o después de la ejecución de - la consulta. - - - - - - - - &reftitle.returnvalues; - - Devuelve el número de campos en caso de éxito. - Devuelve &false; en caso contrario. - - - - - &reftitle.examples; - - Ejemplo con <function>sqlsrv_num_fields</function> - -"dbName", "UID"=>"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "SELECT * FROM Table_1"; -$stmt = sqlsrv_query($conn, $sql); -if( $stmt === false) { - die( print_r( sqlsrv_errors(), true)); -} - -$numFields = sqlsrv_num_fields( $stmt ); - -while( sqlsrv_fetch( $stmt )) { - // Iteración sobre los campos de cada fila. - for($i = 0; $i < $numFields; $i++) { - echo sqlsrv_get_field($stmt, $i)." "; - } - echo "
    "; -} -?> -]]> -
    -
    -
    - - - &reftitle.seealso; - - sqlsrv_field_metadata - sqlsrv_fetch - sqlsrv_get_field - - -
    - diff --git a/reference/sqlsrv/functions/sqlsrv-num-rows.xml b/reference/sqlsrv/functions/sqlsrv-num-rows.xml deleted file mode 100644 index 876ecf3a10..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-num-rows.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - sqlsrv_num_rows - Recupera el número de filas de un conjunto de resultados - - - &reftitle.description; - - mixedsqlsrv_num_rows - resourcestmt - - - Recupera el número de filas de un conjunto de resultados. Esta función - requiere que el recurso de consulta haya sido creado con un cursor - estático o keyset. Para más información, consulte las funciones - sqlsrv_query, sqlsrv_prepare, - o el capítulo - Especificar un tipo de cursor y seleccionar filas - en la documentación de Microsoft SQLSRV. - - - - - &reftitle.parameters; - - - stmt - - - La consulta desde la cual se devuelve el número total de filas. - El recurso de consulta debe haber sido creado con un cursor estático - o keyset. Para más información, consulte las funciones - sqlsrv_query, sqlsrv_prepare, - o el capítulo - Especificar un tipo de cursor y seleccionar filas - en la documentación de Microsoft SQLSRV. - - - - - - - - &reftitle.returnvalues; - - Devuelve el número total de filas recuperadas en caso de éxito, y - &false; si ocurre un error. Si se utiliza un cursor anterior (por omisión), - o un cursor dinámico, se devolverá &false;. - - - - - &reftitle.examples; - - Ejemplo con <function>sqlsrv_num_rows</function> - -"dbName", "UID"=>"username", "PWD"=>"password" ); -$conn = sqlsrv_connect( $server, $connectionInfo ); - -$sql = "SELECT * FROM Table_1"; -$params = array(); -$options = array( "Scrollable" => SQLSRV_CURSOR_KEYSET ); -$stmt = sqlsrv_query( $conn, $sql , $params, $options ); - -$row_count = sqlsrv_num_rows( $stmt ); - -if ($row_count === false) - echo "Error al recuperar el número de filas."; -else - echo $row_count; -?> -]]> - - - - - - &reftitle.seealso; - - sqlsrv_has_rows - sqlsrv_rows_affected - - - - diff --git a/reference/sqlsrv/functions/sqlsrv-prepare.xml b/reference/sqlsrv/functions/sqlsrv-prepare.xml deleted file mode 100644 index 32d127b353..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-prepare.xml +++ /dev/null @@ -1,242 +0,0 @@ - - - - - - - sqlsrv_prepare - Prepara una consulta para su ejecución - - - &reftitle.description; - - mixedsqlsrv_prepare - resourceconn - stringsql - arrayparams - arrayoptions - - - Prepara una consulta para su ejecución. Esta función es ideal para - preparar una consulta que será ejecutada varias veces con diferentes - valores de argumentos. - - - - - &reftitle.parameters; - - - conn - - - Un recurso de conexión devuelto por la función - sqlsrv_connect. - - - - - sql - - - La cadena que define la consulta a preparar y ejecutar. - - - - - params - - - Un array especificando la información de los argumentos al ejecutar - una consulta que contiene argumentos. Los elementos del array pueden - ser cualquiera de los siguientes: - - Un valor literal - Una variable PHP - Un array con la siguiente estructura: - array($value [, $direction [, $phpType [, $sqlType]]]) - - La tabla siguiente describe los elementos de la estructura del array anterior: - - - Estructura del array - - - - Elemento - Descripción - - - - - $value - Un valor literal, una variable PHP o una variable PHP pasada por referencia. - - - $direction (opcional) - Una de las constantes SQLSRV siguientes, utilizadas para indicar la - dirección del argumento: SQLSRV_PARAM_IN, SQLSRV_PARAM_OUT, SQLSRV_PARAM_INOUT. - El valor por defecto es SQLSRV_PARAM_IN. - - - - $phpType (opcional) - Una constante SQLSRV_PHPTYPE_* que especifica el tipo de datos PHP - del valor devuelto. - - - $sqlType (opcional) - Una constante SQLSRV_SQLTYPE_* que especifica el tipo de datos - del servidor SQL del valor de entrada. - - - -
    -
    -
    - - options - - - Un array especificando las opciones de propiedades de la consulta. - Las claves soportadas se describen en la tabla siguiente: - - - Opciones de la consulta - - - - Clave - Valores - Descripción - - - - - QueryTimeout - Un valor entero positivo. - Define el tiempo máximo de ejecución de la consulta, en segundos. - Por defecto, el controlador esperará indefinidamente los resultados. - - - SendStreamParamsAtExec - &true; o &false; (por defecto, &true;) - Configura el controlador para enviar los datos del flujo a la ejecución (&true;), - o enviar los datos del flujo por partes (&false;). Por defecto, el valor - está definido a &true;. Para más información, consulte la función - sqlsrv_send_stream_data. - - - Scrollable - SQLSRV_CURSOR_FORWARD, SQLSRV_CURSOR_STATIC, SQLSRV_CURSOR_DYNAMIC, - o SQLSRV_CURSOR_KEYSET - Ver la sección sobre la - especificación de un tipo de cursor y la selección de filas de la documentación - Microsoft SQLSRV. - - - -
    -
    -
    -
    -
    - - - &reftitle.returnvalues; - - Devuelve un recurso de consulta en caso de éxito, o &false; si ocurre un error. - - - - - &reftitle.examples; - - Ejemplo con <function>sqlsrv_prepare</function> - - Este ejemplo muestra cómo preparar una consulta con la función - sqlsrv_prepare y su re-ejecución varias veces - (con diferentes valores de argumentos) utilizando la función - sqlsrv_execute. - - -"dbName", "UID"=>"username", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "UPDATE Table_1 - SET OrderQty = ? - WHERE SalesOrderID = ?"; - -// Inicializa los argumentos y prepara la consulta. -// Las variables $qty y $id están ligadas a la consulta $stmt. -$qty = 0; $id = 0; -$stmt = sqlsrv_prepare( $conn, $sql, array( &$qty, &$id)); -if( !$stmt ) { - die( print_r( sqlsrv_errors(), true)); -} - -// Define la información SalesOrderDetailID y OrderQty. -// Este array liga el orden de los IDs con el orden de las cantidades con pares clave=>valor. -$orders = array( 1=>10, 2=>20, 3=>30); - -// Ejecuta la consulta para cada orden. -foreach( $orders as $id => $qty) { - // Debido a que $id y $qty están ligados a $stmt1, - // sus valores actualizados se utilizan en cada ejecución - // de la consulta. - if( sqlsrv_execute( $stmt ) === false ) { - die( print_r( sqlsrv_errors(), true)); - } -} -?> -]]> - - - - - - &reftitle.notes; - - Cuando se prepara una consulta que utiliza variables como argumentos, - las variables están ligadas a la consulta. Esto significa que si se actualizan - los valores de estas variables, la próxima ejecución de la consulta tomará - en cuenta estos nuevos valores. Para las consultas que se prevé ejecutar - solo una vez, utilice la función - sqlsrv_query. - - - - - &reftitle.seealso; - - sqlsrv_execute - sqlsrv_query - - -
    - diff --git a/reference/sqlsrv/functions/sqlsrv-query.xml b/reference/sqlsrv/functions/sqlsrv-query.xml deleted file mode 100644 index 6687ad0c38..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-query.xml +++ /dev/null @@ -1,214 +0,0 @@ - - - - - - - sqlsrv_query - Prepara y ejecuta una consulta - - - &reftitle.description; - - mixedsqlsrv_query - resourceconn - stringsql - arrayparams - arrayoptions - - - Prepara y ejecuta una consulta. - - - - - &reftitle.parameters; - - - conn - - - Un recurso de conexión devuelto por la función - sqlsrv_connect. - - - - - sql - - - El string que define la consulta a preparar y ejecutar. - - - - - params - - - Un array especificando los parámetros al ejecutar - una consulta que los permita. - Los elementos del array pueden ser cualquiera de los siguientes: - - Un valor literal - Una variable PHP - Un array con esta estructura: - array($value [, $direction [, $phpType [, $sqlType]]]) - - La tabla siguiente describe los elementos en la estructura del array anterior: - - - Estructura del array - - - - Elemento - Descripción - - - - - $value - Un valor literal, una variable PHP o una variable PHP por referencia. - - - $direction (opcional) - Una de las constantes SQLSRV siguientes utilizadas para indicar la - dirección del parámetro: SQLSRV_PARAM_IN, SQLSRV_PARAM_OUT, SQLSRV_PARAM_INOUT. - El valor por defecto es SQLSRV_PARAM_IN. - - - $phpType (opcional) - Una constante SQLSRV_PHPTYPE_* que especifica el tipo de datos PHP - del valor devuelto. - - - $sqlType (opcional) - Una constante SQLSRV_SQLTYPE_* que especifica el tipo de datos - del servidor SQL para el valor de entrada. - - - -
    -
    -
    - - options - - - Un array especificando las opciones de la consulta. Las claves soportadas son - descritas en la tabla siguiente: - - - Opciones de consulta - - - - Clave - Valor - Descripción - - - - - QueryTimeout - Un valor entero positivo. - Define el tiempo máximo de ejecución de la consulta en segundos. - Por defecto, el controlador esperará indefinidamente los resultados. - - - SendStreamParamsAtExec - &true; o &false; (por defecto, vale &true;) - Configura el controlador para enviar todos los flujos de datos - a la ejecución (&true;) o enviar los flujos de datos en fragmentos - (&false;). Para más información, ver la función - sqlsrv_send_stream_data. - - - Scrollable - SQLSRV_CURSOR_FORWARD, SQLSRV_CURSOR_STATIC, SQLSRV_CURSOR_DYNAMIC, - o SQLSRV_CURSOR_KEYSET - Ver el capítulo sobre la - especificación de un tipo de cursor y la selección de filas - en la documentación Microsoft SQLSRV. - - - -
    -
    -
    -
    -
    - - - &reftitle.returnvalues; - - Devuelve un recurso de consulta en caso de éxito, y &false; si ocurre un error. - - - - - &reftitle.examples; - - <function>sqlsrv_query</function> ejemplo - -"dbName", "UID"=>"username", "PWD"=>"password" ); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "INSERT INTO Table_1 (id, data) VALUES (?, ?)"; -$params = array(1, "some data"); - -$stmt = sqlsrv_query( $conn, $sql, $params); -if( $stmt === false ) { - die( print_r( sqlsrv_errors(), true)); -} -?> -]]> - - - - - - &reftitle.notes; - - Para las consultas que no se prevé ejecutar más de una vez, - utilice la función sqlsrv_query. - Si se desea re-ejecutar una consulta con diferentes valores para sus - parámetros, utilice la combinación de la función - sqlsrv_prepare y la función sqlsrv_execute. - - - - - &reftitle.seealso; - - sqlsrv_prepare - sqlsrv_execute - - -
    - diff --git a/reference/sqlsrv/functions/sqlsrv-rollback.xml b/reference/sqlsrv/functions/sqlsrv-rollback.xml deleted file mode 100644 index fe791a7471..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-rollback.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - - sqlsrv_rollback - Anula una transacción que ha sido iniciada gracias a la función - sqlsrv_begin_transaction - - - &reftitle.description; - - boolsqlsrv_rollback - resourceconn - - - Anula una transacción que ha sido iniciada gracias a la función - sqlsrv_begin_transaction y devuelve - la conexión en modo auto-validación. - - - - - &reftitle.parameters; - - - conn - - - El recurso de conexión devuelto por una llamada - a la función sqlsrv_connect. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>sqlsrv_rollback</function> - - El siguiente ejemplo muestra la forma de utilizar la función - sqlsrv_begin_transaction con las funciones - sqlsrv_commit y sqlsrv_rollback. - - -"dbName", "UID"=>"userName", "PWD"=>"password"); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true )); -} - -/* Inicia la transacción. */ -if ( sqlsrv_begin_transaction( $conn ) === false ) { - die( print_r( sqlsrv_errors(), true )); -} - -/* Inicializa los valores de los argumentos. */ -$orderId = 1; $qty = 10; $productId = 100; - -/* Ejecución de la primera consulta. */ -$sql1 = "INSERT INTO OrdersTable (ID, Quantity, ProductID) - VALUES (?, ?, ?)"; -$params1 = array( $orderId, $qty, $productId ); -$stmt1 = sqlsrv_query( $conn, $sql1, $params1 ); - -/* Ejecuta la segunda consulta. */ -$sql2 = "UPDATE InventoryTable - SET Quantity = (Quantity - ?) - WHERE ProductID = ?"; -$params2 = array($qty, $productId); -$stmt2 = sqlsrv_query( $conn, $sql2, $params2 ); - -/* Si las dos consultas han sido ejecutadas con éxito, -se valida la transacción */ -/* De lo contrario, se anula la transacción. */ -if( $stmt1 && $stmt2 ) { - sqlsrv_commit( $conn ); - echo "Transacción validada.
    "; -} else { - sqlsrv_rollback( $conn ); - echo "Transacción anulada.
    "; -} -?> -]]> -
    -
    -
    - - - &reftitle.seealso; - - sqlsrv_begin_transaction - sqlsrv_commit - - -
    - diff --git a/reference/sqlsrv/functions/sqlsrv-rows-affected.xml b/reference/sqlsrv/functions/sqlsrv-rows-affected.xml deleted file mode 100644 index fd4c657b10..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-rows-affected.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - sqlsrv_rows_affected - Devuelve el número de filas modificadas por la última consulta de tipo - INSERT, UPDATE, o DELETE - - - &reftitle.description; - - intfalsesqlsrv_rows_affected - resourcestmt - - - Devuelve el número de filas modificadas por la última consulta de tipo - INSERT, UPDATE, o DELETE. Para más información sobre el número - de filas devueltas por una consulta SELECT, consulte la función - sqlsrv_num_rows. - - - - - &reftitle.parameters; - - - stmt - - - El recurso de la consulta ejecutada. - - - - - - - - &reftitle.returnvalues; - - Devuelve el número de filas afectadas por la última consulta - INSERT, UPDATE, o DELETE. Si ninguna fila es afectada, se devolverá 0. - Si el número de filas afectadas no puede ser determinado, se devolverá -1. - Si ocurre un error, se devolverá &false;. - - - - - &reftitle.examples; - - Ejemplo con <function>sqlsrv_rows_affected</function> - -"dbName", "UID"=>"username", "PWD"=>"password" ); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "UPDATE Table_1 SET data = ? WHERE id = ?"; - -$params = array("updated data", 1); - -$stmt = sqlsrv_query( $conn, $sql, $params); - -$rows_affected = sqlsrv_rows_affected( $stmt); -if( $rows_affected === false) { - die( print_r( sqlsrv_errors(), true)); -} elseif( $rows_affected == -1) { - echo "No hay información disponible.
    "; -} else { - echo $rows_affected." filas han sido actualizadas.
    "; -} -?> -]]> -
    -
    -
    - - - &reftitle.seealso; - - sqlsrv_num_rows - - -
    - diff --git a/reference/sqlsrv/functions/sqlsrv-send-stream-data.xml b/reference/sqlsrv/functions/sqlsrv-send-stream-data.xml deleted file mode 100644 index 1e7956e070..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-send-stream-data.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - - sqlsrv_send_stream_data - Envía datos desde el flujo al servidor - - - &reftitle.description; - - boolsqlsrv_send_stream_data - resourcestmt - - - Envía datos desde el flujo al servidor. Hasta 8 Ko - de datos son enviados en cada llamada. - - - - - &reftitle.parameters; - - - stmt - - - Un recurso de petición devuelto por la - función sqlsrv_query o - por la función sqlsrv_execute. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si aún hay datos por - enviar, y &false; si no hay más. - - - - - &reftitle.examples; - - Ejemplo con <function>sqlsrv_send_stream_data</function> - -"dbName", "UID"=>"username", "PWD"=>"password" ); -$conn = sqlsrv_connect( $serverName, $connectionInfo); -if( $conn === false ) { - die( print_r( sqlsrv_errors(), true)); -} - -$sql = "UPDATE Table_1 SET data = ( ?) WHERE id = 100"; - -// Abre los datos como flujo y los coloca en el array $params. -$data = fopen( "data://text/plain,[ Contenido largo aquí. ]", "r"); -$params = array( &$data); - -// Prepara la petición. Uso del array $options para desactivar -// el comportamiento por omisión, que es enviar todos los datos del flujo -// al momento de la ejecución de la petición. -$options = array("SendStreamParamsAtExec"=>0); -$stmt = sqlsrv_prepare( $conn, $sql, $params, $options); - -sqlsrv_execute( $stmt); - -// Envía hasta 8 Ko de datos al servidor -// en cada llamada a la función sqlsrv_send_stream_data. -$i = 1; -while( sqlsrv_send_stream_data( $stmt)) { - $i++; -} -echo "$i llamadas fueron realizadas."; -?> -]]> - - - - - - &reftitle.seealso; - - sqlsrv_prepare - sqlsrv_query - - - - diff --git a/reference/sqlsrv/functions/sqlsrv-server-info.xml b/reference/sqlsrv/functions/sqlsrv-server-info.xml deleted file mode 100644 index b84d0d2aee..0000000000 --- a/reference/sqlsrv/functions/sqlsrv-server-info.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - sqlsrv_server_info - Devuelve información sobre el servidor - - - &reftitle.description; - - arraysqlsrv_server_info - resourceconn - - - Devuelve información sobre el servidor. - - - - - &reftitle.parameters; - - - conn - - - El recurso de conexión que conecta el cliente y el servidor. - - - - - - - - &reftitle.returnvalues; - - Devuelve un array como se describe en la tabla siguiente: - - Array devuelto - - - - CurrentDatabase - La base de datos conectada - - - - - SQLServerVersion - La versión del servidor SQL - - - SQLServerName - El nombre del servidor - - - -
    -
    -
    - - - &reftitle.examples; - - Ejemplo con <function>sqlsrv_server_info</function> - - $value) { - echo $key.": ".$value."
    "; - } -} else { - die( print_r( sqlsrv_errors(), true)); -} -?> -]]> -
    -
    -
    - - - &reftitle.seealso; - - sqlsrv_client_info - - -
    - diff --git a/reference/sqlsrv/ini.xml b/reference/sqlsrv/ini.xml deleted file mode 100644 index c6ff3efdd8..0000000000 --- a/reference/sqlsrv/ini.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - -
    - &reftitle.runtime; - &extension.runtime; - - La tabla siguiente lista las opciones de configuración disponibles - para la extensión. Para más información sobre estas opciones, - consúltese el capítulo sobre la - gestión de errores - y alertas SQLSRV. - - - &ConfigureOptions; SQLSRV - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - sqlsrv.WarningsReturnAsErrors - 1 (&true;) - INI_ALL - Disponible a partir de SQLSRV 1.0 - - - sqlsrv.LogSubsystems - 0 - INI_ALL - Disponible a partir de SQLSRV 1.0 - - - sqlsrv.LogSeverity - 1 - INI_ALL - Disponible a partir de SQLSRV 1.0 - - - -
    - - -
    - diff --git a/reference/sqlsrv/reference.xml b/reference/sqlsrv/reference.xml deleted file mode 100644 index 08f7aaa3f7..0000000000 --- a/reference/sqlsrv/reference.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - - - SQLSRV &Functions; - - - - &reference.sqlsrv.entities.functions; - - - - diff --git a/reference/sqlsrv/setup.xml b/reference/sqlsrv/setup.xml deleted file mode 100644 index 5e519f04d8..0000000000 --- a/reference/sqlsrv/setup.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - La extensión SQLSRV puede ser utilizada en los siguientes sistemas operativos: - - Windows Vista Service Pack 2 o superior - Windows Server 2008 Service Pack 2 o superior - Windows Server 2008 R2 - Windows 7 - - - - La extensión SQLSRV requiere que el cliente nativo Microsoft SQL Server 2012 - esté instalado en la misma máquina que la que ejecuta PHP. Si el cliente nativo - Microsoft SQL Server 2012 no está instalado, haga clic en el enlace apropiado - a continuación para descargarlo: - - Descarga del paquete x86 - Descarga del paquete x64 - - - - La descarga SQLSRV viene con 8 controladores, de los cuales 4 están dedicados al soporte de PDO. - - - La versión más reciente del controlador está disponible para descargar aquí: - descarga de SQLSRV. - - - Para más información sobre los requisitos previos de SQLSRV, consulte el - capítulo sobre los - requisitos del sistema SQLSRV. - -
    - - - - &reference.sqlsrv.configure; - - - - &reference.sqlsrv.ini; - - - -
    - &reftitle.resources; -
    - Recurso de conexión - - Un recurso de conexión devuelto por la función - sqlsrv_connect. - -
    -
    - Recurso de consulta - - Un recurso de consulta devuelto por la función - sqlsrv_query o la función - sqlsrv_prepare. - -
    -
    - - -
    - diff --git a/reference/ssdeep/book.xml b/reference/ssdeep/book.xml deleted file mode 100644 index b7aebaa6ec..0000000000 --- a/reference/ssdeep/book.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - Hash difuso ssdeep - ssdeep - - - &reftitle.intro; - - ssdeep es una utilidad para crear y comparar hashes difusos - llamados también - contexto desencadenado por fragmentos - de hash. - - - El hashing difuso puede hacer coincidir firmas que tienen "...secuencias de bytes idénticas, en el mismo orden, a pesar de que los bytes entre las secuencias pueden ser diferentes tanto en contenido como en longitud" ( - página del proyecto ssdeep). - - - Esta extensión proporciona las funciones para crear y comparar hashes difusos - - - - &reference.ssdeep.setup; - - &reference.ssdeep.reference; - - - diff --git a/reference/ssdeep/configure.xml b/reference/ssdeep/configure.xml deleted file mode 100644 index acef71d3ad..0000000000 --- a/reference/ssdeep/configure.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;ssdeep - - -
    - diff --git a/reference/ssdeep/functions/ssdeep-fuzzy-compare.xml b/reference/ssdeep/functions/ssdeep-fuzzy-compare.xml deleted file mode 100644 index 4398bf2f20..0000000000 --- a/reference/ssdeep/functions/ssdeep-fuzzy-compare.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - ssdeep_fuzzy_compare - Calcula el puntaje de coincidencia entre 2 firmas de hash difuso - - - - &reftitle.description; - - intssdeep_fuzzy_compare - stringsignature1 - stringsignature2 - - - Calcula el puntaje de coincidencia entre la - signature1 y la - signature2 utilizando el - contexto desencadenado por fragmentos de hashing, y devuelve - el puntaje de coincidencia. - - - - - - &reftitle.parameters; - - - signature1 - - - La cadena que representa la primera firma de hash difuso. - - - - - signature2 - - - La cadena que representa la segunda firma de hash difuso. - - - - - - - - &reftitle.returnvalues; - - Devuelve un entero entre 0 y 100 en caso de éxito, - o &false; si ocurre un error. - - - - - diff --git a/reference/ssdeep/functions/ssdeep-fuzzy-hash-filename.xml b/reference/ssdeep/functions/ssdeep-fuzzy-hash-filename.xml deleted file mode 100644 index 347dba1f91..0000000000 --- a/reference/ssdeep/functions/ssdeep-fuzzy-hash-filename.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - ssdeep_fuzzy_hash_filename - Crea un hash difuso de un fichero - - - - &reftitle.description; - - stringssdeep_fuzzy_hash_filename - stringfile_name - - - ssdeep_fuzzy_hash_filename calcula el hash - del fichero especificado por file_name - utilizando el contexto - desencadenado por trozos de hashing, y devuelve el - hash correspondiente. - - - - - - &reftitle.parameters; - - - file_name - - - El nombre del fichero a calcular el hash. - - - - - - - - &reftitle.returnvalues; - - Devuelve un &string; si tiene éxito, o &false; en caso contrario. - - - - - diff --git a/reference/ssdeep/functions/ssdeep-fuzzy-hash.xml b/reference/ssdeep/functions/ssdeep-fuzzy-hash.xml deleted file mode 100644 index 6e5cf62853..0000000000 --- a/reference/ssdeep/functions/ssdeep-fuzzy-hash.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - ssdeep_fuzzy_hash - Crea un hash difuso desde un &string; - - - - &reftitle.description; - - stringssdeep_fuzzy_hash - stringto_hash - - - ssdeep_fuzzy_hash calcula el hash de - to_hash utilizando el - contexto desencadenado por - fragmentos de hashing, y devuelve el hash correspondiente. - - - - - &reftitle.parameters; - - - to_hash - - - El &string; de entrada - - - - - - - - &reftitle.returnvalues; - - Devuelve un &string; si tiene éxito, &false; en caso contrario. - - - - - diff --git a/reference/ssdeep/reference.xml b/reference/ssdeep/reference.xml deleted file mode 100644 index 7192d7387c..0000000000 --- a/reference/ssdeep/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - &Functions; ssdeep - - &reference.ssdeep.entities.functions; - - - - diff --git a/reference/ssdeep/setup.xml b/reference/ssdeep/setup.xml deleted file mode 100644 index 641cc3f940..0000000000 --- a/reference/ssdeep/setup.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Esta extensión requiere la biblioteca - ssdeep. - -
    - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;ssdeep. - -
    - -
    - diff --git a/reference/ssh2/book.xml b/reference/ssh2/book.xml deleted file mode 100644 index 012383b07e..0000000000 --- a/reference/ssh2/book.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - - Secure Shell2 - SSH2 - - - - &reftitle.intro; - - Se enlaza a la biblioteca libssh2 que - provee acceso a recursos (shell, ejecución remota, tunneling, transferencia de - archivos) sobre una máquina remota utilizando una vía de transporte criptográfica - segura. - - - - - &reference.ssh2.setup; - &reference.ssh2.constants; - &reference.ssh2.reference; - - - diff --git a/reference/ssh2/constants.xml b/reference/ssh2/constants.xml deleted file mode 100644 index 5cdae7ab96..0000000000 --- a/reference/ssh2/constants.xml +++ /dev/null @@ -1,253 +0,0 @@ - - - - - - &reftitle.constants; - &extension.constants; - - - - SSH2_FINGERPRINT_MD5 - (int) - - - - Flag que permite a la función ssh2_fingerprint solicitar la huella de la clave del host como hash MD5. - - - - - - SSH2_FINGERPRINT_SHA1 - (int) - - - - Flag que permite a la función ssh2_fingerprint solicitar la huella de la clave del host como hash SHA1. - - - - - - SSH2_FINGERPRINT_HEX - (int) - - - - Flag que permite a la función ssh2_fingerprint solicitar la huella de la clave del host como string hexits. - - - - - - SSH2_FINGERPRINT_RAW - (int) - - - - Flag que permite a la función ssh2_fingerprint solicitar la huella de la clave del host como string de caracteres 8-bit. - - - - - - SSH2_TERM_UNIT_CHARS - (int) - - - - Flag que especifica a la función ssh2_shell que los parámetros width y height se proporcionan en forma de tamaño de caracteres. - - - - - - SSH2_TERM_UNIT_PIXELS - (int) - - - - Flag que especifica a la función ssh2_shell que los parámetros width y height se proporcionan en forma de píxeles. - - - - - - SSH2_DEFAULT_TERM_WIDTH - (int) - - - - Ancho por defecto del terminal solicitado por la función ssh2_shell. - - - - - - SSH2_DEFAULT_TERM_HEIGHT - (int) - - - - Altura por defecto del terminal solicitado por la función ssh2_shell. - - - - - - SSH2_DEFAULT_TERM_UNIT - (int) - - - - Unidad por defecto del terminal solicitado por la función ssh2_shell. - - - - - - SSH2_STREAM_STDIO - (int) - - - - Flag para que la función ssh2_fetch_stream solicite un subcanal STDIO. - - - - - - SSH2_STREAM_STDERR - (int) - - - - Flag para que la función ssh2_fetch_stream solicite un subcanal STDERR. - - - - - - SSH2_DEFAULT_TERMINAL - (string) - - - - Tipo por defecto del terminal (e.g. "vt102", "ansi", "xterm", "vanilla") solicitado por la función ssh2_shell. - - - - - - SSH2_POLLIN - (int) - - - - - - - - - SSH2_POLLEXT - (int) - - - - - - - - - SSH2_POLLOUT - (int) - - - - - - - - - SSH2_POLLERR - (int) - - - - - - - - - SSH2_POLLHUP - (int) - - - - - - - - - SSH2_POLLNVAL - (int) - - - - - - - - - SSH2_POLL_SESSION_CLOSED - (int) - - - - - - - - - SSH2_POLL_CHANNEL_CLOSED - (int) - - - - - - - - - SSH2_POLL_LISTENER_CLOSED - (int) - - - - - - - - - - diff --git a/reference/ssh2/functions/ssh2-auth-agent.xml b/reference/ssh2/functions/ssh2-auth-agent.xml deleted file mode 100644 index 5fd01a5289..0000000000 --- a/reference/ssh2/functions/ssh2-auth-agent.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - ssh2_auth_agent - Autenticación SSH utilizando el agente ssh - - - - &reftitle.description; - - boolssh2_auth_agent - resourcesession - stringusername - - - Autenticación SSH utilizando el agente ssh. - - - - La función ssh2_auth_agent solo está disponible - cuando la extensión ssh2 ha sido compilada con libssh2 >= 1.2.3. - - - - - - &reftitle.parameters; - - - session - - - Un identificador de conexión SSH, obtenido desde una llamada a la función - ssh2_connect. - - - - - username - - - Nombre de usuario remoto. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Autenticación utilizando un agente ssh - - -]]> - - - - - - diff --git a/reference/ssh2/functions/ssh2-auth-hostbased-file.xml b/reference/ssh2/functions/ssh2-auth-hostbased-file.xml deleted file mode 100644 index d5fd5a49a6..0000000000 --- a/reference/ssh2/functions/ssh2-auth-hostbased-file.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - - ssh2_auth_hostbased_file - Identificación utilizando una clave de host pública - - - - &reftitle.description; - - boolssh2_auth_hostbased_file - resourcesession - stringusername - stringhostname - stringpubkeyfile - stringprivkeyfile - stringpassphrase - stringlocal_username - - - Identificación utilizando una clave de host pública leída desde un fichero. - - - - - &reftitle.parameters; - - - session - - - Un identificador de conexión SSH, obtenido a través de la función - ssh2_connect. - - - - - username - - - - - - - hostname - - - - - - - pubkeyfile - - - - - - - privkeyfile - - - - - - - passphrase - - - Si privkeyfile está cifrado (y debe estarlo), la frase secreta debe - ser proporcionada. - - - - - local_username - - - Si local_username es omitido, entonces el valor de - username será utilizado para ello. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Identificación utilizando una clave de host pública - -'ssh-rsa')); - -if (ssh2_auth_hostbased_file($connection, 'remoteusername', 'myhost.example.com', - '/usr/local/etc/hostkey_rsa.pub', - '/usr/local/etc/hostkey_rsa', 'secret', - 'localusername')) { - echo "Identificación utilizando una clave de host pública con éxito\n"; -} else { - die('Fallo en la identificación utilizando una clave de host pública con éxito'); -} -?> -]]> - - - - - - &reftitle.notes; - - - ssh2_auth_hostbased_file requiere libssh2 >= 0.7 y PHP/SSH2 >= 0.7. - - - - - - diff --git a/reference/ssh2/functions/ssh2-auth-none.xml b/reference/ssh2/functions/ssh2-auth-none.xml deleted file mode 100644 index b4d6682b36..0000000000 --- a/reference/ssh2/functions/ssh2-auth-none.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - ssh2_auth_none - Identificación como "none" - - - - &reftitle.description; - - mixedssh2_auth_none - resourcesession - stringusername - - - Intenta una identificación como "none", que, habitualmente, falla - (y debe fallar). Aparte del fallo, esta función debe devolver un - array que contiene los métodos de identificación aceptables. - - - - - &reftitle.parameters; - - - session - - - Un identificador de conexión SSH, obtenido con la función - ssh2_connect. - - - - - username - - - Nombre de usuario remoto. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si el servidor acepta "none" como método de identificación, - o un array de métodos de identificación aceptables en caso de fallo. - - - - - &reftitle.examples; - - Recuperación de la lista de métodos de identificación - - -]]> - - - - - - diff --git a/reference/ssh2/functions/ssh2-auth-password.xml b/reference/ssh2/functions/ssh2-auth-password.xml deleted file mode 100644 index 9e11557ee7..0000000000 --- a/reference/ssh2/functions/ssh2-auth-password.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - ssh2_auth_password - Autenticación vía SSH utilizando una contraseña en texto claro - - - - &reftitle.description; - - boolssh2_auth_password - resourcesession - stringusername - stringpassword - - - Autenticación vía SSH utilizando una contraseña en texto claro. - Desde la versión 0.12, esta función también soporta el método - keyboard_interactive. - - - - - &reftitle.parameters; - - - session - - - Un identificador de conexión SSH, obtenido desde la función - ssh2_connect. - - - - - username - - - Nombre de usuario remoto. - - - - - password - - - Contraseña para el usuario username. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Autenticación con una contraseña - - -]]> - - - - - - diff --git a/reference/ssh2/functions/ssh2-auth-pubkey-file.xml b/reference/ssh2/functions/ssh2-auth-pubkey-file.xml deleted file mode 100644 index 31268f775d..0000000000 --- a/reference/ssh2/functions/ssh2-auth-pubkey-file.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - ssh2_auth_pubkey_file - Identificación utilizando una clave pública - - - - &reftitle.description; - - boolssh2_auth_pubkey_file - resourcesession - stringusername - stringpubkeyfile - stringprivkeyfile - stringpassphrase - - - Identificación utilizando una clave pública, leída desde un fichero. - - - - - &reftitle.parameters; - - - session - - - Un identificador de conexión SSH, obtenido desde la función - ssh2_connect. - - - - - username - - - Nombre del usuario para autenticarse en el servidor remoto. - - - - - pubkeyfile - - - El fichero que contiene la clave pública debe estar en formato - OpenSSH. Debe parecerse a esto: - - - ssh-rsa AAAAB3NzaC1yc2EAAA....NX6sqSnHA8= rsa-key-20121110 - - - - - privkeyfile - - - - - - - passphrase - - - Si privkeyfile está cifrado (y debe estarlo), - la frase de paso debe ser proporcionada. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Identificación utilizando una clave pública - -'ssh-rsa')); - -if (ssh2_auth_pubkey_file($connection, 'username', - '/home/username/.ssh/id_rsa.pub', - '/home/username/.ssh/id_rsa', 'secret')) { - echo "Identificación exitosa utilizando una clave pública\n"; -} else { - die('Fallo en la identificación utilizando una clave pública'); -} -?> -]]> - - - - - &reftitle.notes; - - - La biblioteca libssh2 subyacente no soporta muy limpiamente las - autenticaciones parciales. Es decir, que si debe proporcionar a la - vez una clave pública y una contraseña, entonces parecerá como si - la función estuviera en error. En este caso particular, un error en esta - llamada puede simplemente significar que la autenticación no está aún terminada. - Debe ignorar este error y continuar con la llamada - ssh2_auth_password para terminar la autenticación. - - - - - - &reftitle.seealso; - - ssh2_auth_pubkey - - - - - diff --git a/reference/ssh2/functions/ssh2-auth-pubkey.xml b/reference/ssh2/functions/ssh2-auth-pubkey.xml deleted file mode 100644 index 4cde411fc9..0000000000 --- a/reference/ssh2/functions/ssh2-auth-pubkey.xml +++ /dev/null @@ -1,147 +0,0 @@ - - - - - ssh2_auth_pubkey - Identificación utilizando una clave pública en una variable - - - - &reftitle.description; - - boolssh2_auth_pubkey - resourcesession - stringusername - stringpubkey - stringprivkey - stringpassphrase - - - Identificación utilizando una clave pública en una variable. - - - - - &reftitle.parameters; - - - session - - - Un identificador de conexión SSH, obtenido desde la función - ssh2_connect. - - - - - username - - - Nombre del usuario para autenticarse en el servidor remoto. - - - - - pubkey - - - Clave pública en formato OpenSSH. Debe parecerse a esto: - ssh-rsa AAAAB3NzaC1yc2EAAA....NX6sqSnHA8= rsa-key-20121110 - - - - - privkey - - - Clave privada OpenSSH. Debe comenzar con: - -----BEGIN RSA PRIVATE KEY----- - - - - - passphrase - - - Si privkey está cifrado (y debe estarlo), - la frase de paso debe ser proporcionada. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Identificación utilizando una clave pública - -'ssh-rsa')); -$publicKey = file_get_contents('/home/username/.ssh/id_rsa.pub'); -$privateKey = file_get_contents('/home/username/.ssh/id_rsa'); - -if (ssh2_auth_pubkey($connection, 'username', - $publicKey, - $privateKey, 'secret')) { - echo "Public Key Authentication Successful\n"; -} else { - die('Public Key Authentication Failed'); -} -?> -]]> - - - - - - &reftitle.notes; - - - La biblioteca libssh2 subyacente no soporta muy limpiamente las - autenticaciones parciales. Es decir, que si debe proporcionar a la - vez una clave pública y una contraseña, entonces parecerá como si - la función estuviera en error. En este caso particular, un error en esta - llamada puede simplemente significar que la autenticación no está aún terminada. - Debe ignorar este error y continuar con la llamada - ssh2_auth_password para terminar la autenticación. - - - - - - &reftitle.seealso; - - ssh2_auth_pubkey_file - - - - - diff --git a/reference/ssh2/functions/ssh2-connect.xml b/reference/ssh2/functions/ssh2-connect.xml deleted file mode 100644 index 0e2e4fd8f3..0000000000 --- a/reference/ssh2/functions/ssh2-connect.xml +++ /dev/null @@ -1,325 +0,0 @@ - - - - - - - ssh2_connect - Conexión a un servidor SSH - - - - &reftitle.description; - - resourcefalsessh2_connect - stringhost - intport22 - arraymethods - arraycallbacks - - - Establece una conexión a un servidor SSH remoto. - - - Una vez conectado, el cliente debe verificar la clave de host del servidor - utilizando la función ssh2_fingerprint, - luego identificarse utilizando un password o una clave pública. - - - - - &reftitle.parameters; - - - host - - - - - - - port - - - - - - - methods - - - methods puede ser un array asociativo de hasta - cuatro parámetros, como se describe a continuación. - - - <parameter>methods</parameter> puede ser un array asociativo - con cualquiera o todos los parámetros siguientes. - - - - Índice - Significado - Valores soportados * - - - - - kex - - La lista de métodos de intercambio a anunciar, separados por una coma, - por orden de preferencia. - - - diffie-hellman-group1-sha1, - diffie-hellman-group14-sha1, y - diffie-hellman-group-exchange-sha1 - - - - hostkey - - La lista de métodos de claves de host a anunciar, separados por - una coma, por orden de preferencia. - - - ssh-rsa y - ssh-dss - - - - client_to_server - - Array asociativo que contiene los códigos de los métodos de cifrado, - compresión y mensajes de autenticación (MAC) preferidos - para el envío de mensajes desde el cliente al servidor. - - - - - server_to_client - - Array asociativo que contiene los códigos de los métodos de cifrado, - compresión y mensajes de autenticación (MAC) preferidos - para el envío de mensajes desde el servidor al cliente. - - - - - -
    - - * - Los valores soportados dependen de los métodos soportados por - la biblioteca. Consulte la documentación libssh2 - para más información. - - - - <parameter>client_to_server</parameter> y - <parameter>server_to_client</parameter> deben ser un array asociativo - con cualquiera o todos los parámetros siguientes. - - - - - Índice - Significado - Valores soportados * - - - - - crypt - - Lista de métodos de cifrado a anunciar, separados por una coma, - por orden de preferencia. - - - rijndael-cbc@lysator.liu.se, - aes256-cbc, - aes192-cbc, - aes128-cbc, - 3des-cbc, - blowfish-cbc, - cast128-cbc, - arcfour, y - none** - - - - comp - - Lista de métodos de compresión a anunciar, separados por una coma, - por orden de preferencia. - - - zlib y - none - - - - mac - - Lista de métodos MAC a anunciar, separados por una coma, - por orden de preferencia. - - - hmac-sha1, - hmac-sha1-96, - hmac-ripemd160, - hmac-ripemd160@openssh.com, y - none** - - - - -
    - - Cifrado y método MAC "<literal>none</literal>" - - Por razones de seguridad, none está desactivado por la - biblioteca libssh2 a menos que se - active explícitamente durante la compilación utilizando las opciones - apropiadas de ./configure. Consulte la documentación de la biblioteca - para más información. - - -
    -
    - - callbacks - - - callbacks debe ser un array asociativo - que contiene cualquiera o todos los parámetros siguientes. - - - Parámetros de retrollamada - - - - - Índice - Significado - Prototipo - - - - - ignore - - Nombre de la función a llamar cuando se recibe un paquete - SSH2_MSG_IGNORE - - void ignore_cb($message) - - - debug - - Nombre de la función a llamar cuando se recibe un paquete - SSH2_MSG_DEBUG - - void debug_cb($message, $language, $always_display) - - - macerror - - Nombre de la función a llamar cuando se recibe un paquete pero el - código de mensaje de autenticación falla. Si la función de retrollamada - devuelve &true;, el error será ignorado, de lo contrario, la conexión terminará. - - bool macerror_cb($packet) - - - disconnect - - Nombre de la función a llamar cuando se recibe un paquete - SSH2_MSG_DISCONNECT - - void disconnect_cb($reason, $message, $language) - - - -
    -
    -
    -
    -
    -
    - - - &reftitle.returnvalues; - - Devuelve un recurso en caso de éxito, o &false; en caso de error. - - - - - &reftitle.examples; - - Ejemplo con <function>ssh2_connect</function> - - Apertura de una conexión forzando 3des-cbc al enviar paquetes, - cualquier cifrado AES al recibir paquetes, - ninguna compresión en ambas direcciones, y un intercambio de claves Group1. - - - 'diffie-hellman-group1-sha1', - 'client_to_server' => array( - 'crypt' => '3des-cbc', - 'comp' => 'none'), - 'server_to_client' => array( - 'crypt' => 'aes256-cbc,aes192-cbc,aes128-cbc', - 'comp' => 'none')); - -$callbacks = array('disconnect' => 'my_ssh_disconnect'); - -$connection = ssh2_connect('shell.example.com', 22, $methods, $callbacks); -if (!$connection) die('Fallo en la conexión'); -?> -]]> - - - - - - &reftitle.seealso; - - ssh2_fingerprint - ssh2_auth_none - ssh2_auth_password - ssh2_auth_pubkey - ssh2_auth_pubkey_file - ssh2_disconnect - - - -
    - diff --git a/reference/ssh2/functions/ssh2-disconnect.xml b/reference/ssh2/functions/ssh2-disconnect.xml deleted file mode 100644 index 770673f343..0000000000 --- a/reference/ssh2/functions/ssh2-disconnect.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - ssh2_disconnect - Cierra una conexión a un servidor SSH remoto - - - - &reftitle.description; - - boolssh2_disconnect - resourcesession - - - Cierra una conexión a un servidor SSH remoto. - - - - - &reftitle.parameters; - - - session - - - Un identificador de enlace de conexión SSH, obtenido desde una llamada - a ssh2_connect. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - ssh2_connect - - - - - diff --git a/reference/ssh2/functions/ssh2-exec.xml b/reference/ssh2/functions/ssh2-exec.xml deleted file mode 100644 index 76ebc4c283..0000000000 --- a/reference/ssh2/functions/ssh2-exec.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - - ssh2_exec - Ejecuta un comando en un servidor remoto - - - - &reftitle.description; - - resourcefalsessh2_exec - resourcesession - stringcommand - stringpty - arrayenv - intwidth80 - intheight25 - intwidth_height_typeSSH2_TERM_UNIT_CHARS - - - Ejecuta un comando en un servidor remoto. - - - - - &reftitle.parameters; - - - session - - - Un identificador de conexión SSH, obtenido desde la función - ssh2_connect. - - - - - command - - - - - - - pty - - - - - - - env - - - env puede ser pasado bajo la forma de un - array asociativo de pares nombre/valor, a definir en el - entorno objetivo. - - - - - width - - - Ancho del terminal virtual. - - - - - height - - - Altura del terminal virtual. - - - - - width_height_type - - - width_height_type puede valer - SSH2_TERM_UNIT_CHARS o - SSH2_TERM_UNIT_PIXELS. - - - - - - - - &reftitle.returnvalues; - - Devuelve un flujo en caso de éxito&return.falseforfailure;. - - - - - &reftitle.examples; - - Ejecución de un comando - - -]]> - - - - - - &reftitle.seealso; - - ssh2_connect - ssh2_shell - ssh2_tunnel - - - - - diff --git a/reference/ssh2/functions/ssh2-fetch-stream.xml b/reference/ssh2/functions/ssh2-fetch-stream.xml deleted file mode 100644 index ba7b177eb0..0000000000 --- a/reference/ssh2/functions/ssh2-fetch-stream.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - ssh2_fetch_stream - Recorre un flujo extendido de datos - - - - &reftitle.description; - - resourcessh2_fetch_stream - resourcechannel - intstreamid - - - Recorre un subflujo alternativo asociado a un flujo de canal SSH2. - El protocolo SSH2 define actualmente un solo subflujo, STDERR, que tiene - un identificador de subflujo de SSH2_STREAM_STDERR (definido a 1). - - - - - &reftitle.parameters; - - - channel - - - - - - - streamid - - - Un canal de flujo SSH2. - - - - - - - - &reftitle.returnvalues; - - Devuelve el recurso, representando el flujo solicitado. - - - - - &reftitle.examples; - - Apertura de un shell y recuperación del flujo stderr que le está asociado - - -]]> - - - - - - &reftitle.seealso; - - ssh2_shell - ssh2_exec - ssh2_connect - - - - - diff --git a/reference/ssh2/functions/ssh2-fingerprint.xml b/reference/ssh2/functions/ssh2-fingerprint.xml deleted file mode 100644 index 450c78e0d4..0000000000 --- a/reference/ssh2/functions/ssh2-fingerprint.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - ssh2_fingerprint - Recupera la huella de un servidor remoto - - - - &reftitle.description; - - stringssh2_fingerprint - resourcesession - intflagsSSH2_FINGERPRINT_MD5 | SSH2_FINGERPRINT_HEX - - - Recupera la huella de un servidor remoto. - - - - - &reftitle.parameters; - - - session - - - Un identificador de conexión SSH, obtenido desde la función - ssh2_connect. - - - - - flags - - - flags puede ser - SSH2_FINGERPRINT_MD5 o - SSH2_FINGERPRINT_SHA1 asociado lógicamente con - SSH2_FINGERPRINT_HEX o - SSH2_FINGERPRINT_RAW. - - - - - - - - &reftitle.returnvalues; - - Devuelve la huella, en forma de &string;. - - - - - &reftitle.examples; - - Comparación de una huella con un valor conocido - - -]]> - - - - - - diff --git a/reference/ssh2/functions/ssh2-forward-accept.xml b/reference/ssh2/functions/ssh2-forward-accept.xml deleted file mode 100644 index f9d511fb94..0000000000 --- a/reference/ssh2/functions/ssh2-forward-accept.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - ssh2_forward_accept - Acepta una conexión creada por un observador - - - - &reftitle.description; - - resourcefalsessh2_forward_accept - resourcelistener - - - Acepta una conexión creada por un observador. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - desc - - - Un observador SSH2, obtenido por una llamada a ssh2_forward_listen. - - - - - - - - &reftitle.returnvalues; - - Devuelve un recurso de flujo, &return.falseforfailure;. - - - - - diff --git a/reference/ssh2/functions/ssh2-forward-listen.xml b/reference/ssh2/functions/ssh2-forward-listen.xml deleted file mode 100644 index f22be8290b..0000000000 --- a/reference/ssh2/functions/ssh2-forward-listen.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - ssh2_forward_listen - Enlaza un puerto en el servidor remoto y observa las conexiones - - - - &reftitle.description; - - resourcefalsessh2_forward_listen - resourcesession - intport - stringhost - intmax_connections16 - - - Enlaza un puerto en el servidor remoto y observa las conexiones. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - session - - - Un recurso de sesión SSH, obtenido mediante una llamada a ssh2_connect. - - - - - port - - - Un puerto del servidor remoto. - - - - - host - - - - - - - - max_connections - - - - - - - - - - - &reftitle.returnvalues; - - Devuelve un observador SSH2, &return.falseforfailure;. - - - - - &reftitle.seealso; - - ssh2_forward_accept - - - - diff --git a/reference/ssh2/functions/ssh2-keepalive-config.xml b/reference/ssh2/functions/ssh2-keepalive-config.xml deleted file mode 100644 index 471f15d965..0000000000 --- a/reference/ssh2/functions/ssh2-keepalive-config.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - ssh2_keepalive_config - Configura la frecuencia de envío de los mensajes de mantenimiento de conexión - - - - &reftitle.description; - - voidssh2_keepalive_config - resourcesession - boolwant_reply - intinterval - - - Configura con qué frecuencia se envían los mensajes de mantenimiento de - conexión en la session indicada, y si se solicita al - servidor que responda a ellos. - - - Los mensajes de mantenimiento de conexión no se envían automáticamente. Una - vez configurados, se debe llamar a ssh2_keepalive_send - para enviar realmente un mensaje de mantenimiento de conexión. - - - - Esta función solo está disponible cuando la extensión se compila con una - versión de libssh2 que proporciona soporte de mantenimiento de conexión. - - - - - - &reftitle.parameters; - - - session - - - Un identificador de enlace de conexión SSH, obtenido de una llamada a - ssh2_connect. - - - - - want_reply - - - Indica si se solicita al servidor que responda a los mensajes de - mantenimiento de conexión. Solicitar una respuesta permite detectar un - servidor que no responde, a costa de algo de tráfico adicional. - - - - - interval - - - El número de segundos que pueden transcurrir sin ningún tráfico antes de - que deba enviarse un mensaje de mantenimiento de conexión. El valor - 0 deshabilita los mensajes de mantenimiento de - conexión, y el valor 1 es tratado como - 2 por la biblioteca subyacente. - - - Los valores aceptados van de 0 a - 4294967295. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Se emite un error de nivel E_WARNING cuando - interval queda fuera del rango aceptado; en ese caso - la configuración del mantenimiento de conexión permanece sin cambios. - - - - - &reftitle.examples; - - Envío de mensajes de mantenimiento de conexión - - -]]> - - - - - - &reftitle.seealso; - - ssh2_keepalive_send - ssh2_connect - - - - - - diff --git a/reference/ssh2/functions/ssh2-keepalive-send.xml b/reference/ssh2/functions/ssh2-keepalive-send.xml deleted file mode 100644 index 60399c2242..0000000000 --- a/reference/ssh2/functions/ssh2-keepalive-send.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - ssh2_keepalive_send - Envía un mensaje de mantenimiento de conexión - - - - &reftitle.description; - - intfalsessh2_keepalive_send - resourcesession - - - Envía un mensaje de mantenimiento de conexión en la - session indicada, de acuerdo con la configuración - establecida con ssh2_keepalive_config. - - - - Esta función solo está disponible cuando la extensión se compila con una - versión de libssh2 que proporciona soporte de mantenimiento de conexión. - - - - - - &reftitle.parameters; - - - session - - - Un identificador de enlace de conexión SSH, obtenido de una llamada a - ssh2_connect. - - - - - - - - &reftitle.returnvalues; - - Devuelve el número de segundos que pueden transcurrir antes de que deba - enviarse otro mensaje de mantenimiento de conexión, o &false; en caso de - error. Devuelve 0 cuando los mensajes de mantenimiento de - conexión están deshabilitados. - - - Puesto que tanto 0 como &false; se evalúan como falso, - debe utilizarse el operador === para distinguirlos. - - - - - &reftitle.examples; - - Envío de un mensaje de mantenimiento de conexión - - -]]> - - - - - - &reftitle.seealso; - - ssh2_keepalive_config - ssh2_connect - - - - - - diff --git a/reference/ssh2/functions/ssh2-methods-negotiated.xml b/reference/ssh2/functions/ssh2-methods-negotiated.xml deleted file mode 100644 index 8cfbb777ff..0000000000 --- a/reference/ssh2/functions/ssh2-methods-negotiated.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - ssh2_methods_negotiated - Devuelve una lista de métodos negociados - - - - &reftitle.description; - - arrayssh2_methods_negotiated - resourcesession - - - Devuelve una lista de métodos negociados. - - - - - &reftitle.parameters; - - - session - - - Un identificador de conexión SSH, obtenido desde la función - ssh2_connect. - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.examples; - - Determina qué métodos han sido negociados - - -]]> - - - - - - &reftitle.seealso; - - ssh2_connect - - - - - diff --git a/reference/ssh2/functions/ssh2-poll.xml b/reference/ssh2/functions/ssh2-poll.xml deleted file mode 100644 index f72f269726..0000000000 --- a/reference/ssh2/functions/ssh2-poll.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - ssh2_poll - Consulta los canales/observadores/flujos para eventos - - - - &reftitle.description; - - intssh2_poll - arraydesc - inttimeout30 - - - Consulta los canales/observadores/flujos para eventos, - y devuelve el número de descriptores que han devuelto eventos no nulos. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - desc - - - Un array indexado de sub-arrays con las claves - 'resource' y 'events'. - El valor de la ressource es un flujo (de canal) o una ressource de tipo SSH2 Listener. - El valor del evento es un máscara de bits SSH2_POLL*. - Cada sub-array será poblado con un elemento 'revents' al final, - cuyos valores son máscaras de bits SSH2_POLL* de los eventos que han ocurrido. - - - - - timeout - - - El tiempo de espera en segundos. - - - - - - - - &reftitle.returnvalues; - - Devuelve el número de descriptores que han devuelto eventos no nulos. - - - - - diff --git a/reference/ssh2/functions/ssh2-publickey-add.xml b/reference/ssh2/functions/ssh2-publickey-add.xml deleted file mode 100644 index 531e76d8d0..0000000000 --- a/reference/ssh2/functions/ssh2-publickey-add.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - - ssh2_publickey_add - Añade una clave pública autorizada - - - - &reftitle.description; - - boolssh2_publickey_add - resourcepkey - stringalgoname - stringblob - booloverwrite&false; - arrayattributes - - - ¬e.ssh2.subsystem.publickey; - - - - - &reftitle.parameters; - - - pkey - - - Recurso Publickey Subsystem creado por - ssh2_publickey_init. - - - - - algoname - - - Algoritmo de clave pública (ejemplo): ssh-dss, ssh-rsa - - - - - blob - - - Blob de clave pública como datos binarios sin tratar - - - - - overwrite - - - Si la clave especificada ya existe, ¿debería ser sobrescrita? - - - - - attributes - - - Array asociativo de atributos para asignar a esta clave pública. - Consulte ietf-secsh-publickey-subsystem para una lista de los - atributos soportados. Para marcar un atributo como obligatorio, - anteponga un asterisco a su nombre. Si el servidor no es capaz de - soportar un atributo marcado como obligatorio, abandonará el - proceso de adición. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Adición de una clave pública con <function>ssh2_publickey_add</function> - -"John's Key")); -?> -]]> - - - - - - &reftitle.seealso; - - ssh2_publickey_init - ssh2_publickey_remove - ssh2_publickey_list - - - - - diff --git a/reference/ssh2/functions/ssh2-publickey-init.xml b/reference/ssh2/functions/ssh2-publickey-init.xml deleted file mode 100644 index f0f3392c40..0000000000 --- a/reference/ssh2/functions/ssh2-publickey-init.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - ssh2_publickey_init - Inicializa un Publickey Subsystem (subsistema de clave pública) - - - - &reftitle.description; - - resourcefalsessh2_publickey_init - resourcesession - - - Solicita el subsistema de clave pública desde un servidor SSH2 ya conectado. - - - El subsistema de clave pública permite a un cliente ya conectado e identificado gestionar la lista de claves públicas autorizadas registradas en el servidor objetivo de manera agnóstica a la implementación. Si el servidor no soporta el subsistema de clave pública, la función - ssh2_publickey_init devolverá &false;. - - - - - &reftitle.parameters; - - - session - - - - - - - - - - &reftitle.returnvalues; - - Devuelve un recurso SSH2 Publickey Subsystem - para usar con todos los otros métodos ssh2_publickey_*()&return.falseforfailure;. - - - - - &reftitle.notes; - ¬e.ssh2.subsystem.publickey; - - - - &reftitle.seealso; - - ssh2_publickey_add - ssh2_publickey_remove - ssh2_publickey_list - - - - - diff --git a/reference/ssh2/functions/ssh2-publickey-list.xml b/reference/ssh2/functions/ssh2-publickey-list.xml deleted file mode 100644 index 79958caa94..0000000000 --- a/reference/ssh2/functions/ssh2-publickey-list.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - - ssh2_publickey_list - Lista las claves públicas actualmente autorizadas - - - - &reftitle.description; - - arrayssh2_publickey_list - resourcepkey - - - Lista las claves públicas actualmente autorizadas. - - - - - &reftitle.parameters; - - - pkey - - - Recurso Publickey Subsystem. - - - - - - - - &reftitle.returnvalues; - - Devuelve un array de claves indexadas numéricamente, cada una de ellas es un - array asociativo que contiene: nombre, blob y elementos attrs. - - - Elemento de clave pública - - - - Clave Array - Significado - - - - - name - Nombre del algoritmo utilizado por esta clave pública, por ejemplo: - ssh-dss o ssh-rsa. - - - blob - Blob de clave pública como datos binarios sin tratar. - - - attrs - - Atributos asignados a esta clave pública. - El atributo más común y el único soportado por la clave - pública versión 1 de los servidores es comment, - que puede ser cualquier forma de string. - - - - -
    -
    - - - &reftitle.examples; - - Lista de claves autorizadas con <function>ssh2_publickey_list</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.notes; - ¬e.ssh2.subsystem.publickey; - - - - &reftitle.seealso; - - ssh2_publickey_init - ssh2_publickey_add - ssh2_publickey_remove - - - -
    - diff --git a/reference/ssh2/functions/ssh2-publickey-remove.xml b/reference/ssh2/functions/ssh2-publickey-remove.xml deleted file mode 100644 index 9056c8e7bc..0000000000 --- a/reference/ssh2/functions/ssh2-publickey-remove.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - ssh2_publickey_remove - Elimina una clave pública autorizada - - - - &reftitle.description; - - boolssh2_publickey_remove - resourcepkey - stringalgoname - stringblob - - - Elimina una clave pública autorizada. - - - - - &reftitle.parameters; - - - pkey - - - Recurso Publickey Subsystem - - - - - algoname - - - Algoritmo de clave pública (ejemplo): ssh-dss, ssh-rsa - - - - - blob - - - Blob de clave pública como datos binarios sin tratar - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.notes; - ¬e.ssh2.subsystem.publickey; - - - - &reftitle.seealso; - - ssh2_publickey_init - ssh2_publickey_add - ssh2_publickey_list - - - - diff --git a/reference/ssh2/functions/ssh2-scp-recv.xml b/reference/ssh2/functions/ssh2-scp-recv.xml deleted file mode 100644 index ca91e5087f..0000000000 --- a/reference/ssh2/functions/ssh2-scp-recv.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - ssh2_scp_recv - Solicita un fichero mediante SCP - - - - &reftitle.description; - - boolssh2_scp_recv - resourcesession - stringremote_file - stringlocal_file - - - Copia un fichero desde el servidor remoto al sistema de ficheros local usando el protocolo SCP. - - - - - &reftitle.parameters; - - - session - - - Un identificador de enlace de conexión a SSH, obtenido desde una llamada a - ssh2_connect. - - - - - remote_file - - - Ruta del fichero remoto. - - - - - local_file - - - Ruta del fichero local. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Descargar un fichero mediante SCP - - -]]> - - - - - - &reftitle.seealso; - - ssh2_scp_send - copy - - - - - diff --git a/reference/ssh2/functions/ssh2-scp-send.xml b/reference/ssh2/functions/ssh2-scp-send.xml deleted file mode 100644 index 0e8c34a22c..0000000000 --- a/reference/ssh2/functions/ssh2-scp-send.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - ssh2_scp_send - Envía un fichero mediante SCP - - - - &reftitle.description; - - boolssh2_scp_send - resourcesession - stringlocal_file - stringremote_file - intcreate_mode0644 - - - Copia un fichero desde el sistema de ficheros local a un servidor remoto usando el protocolo SCP. - - - - - &reftitle.parameters; - - - session - - - Un identificador de enlace de conexión a SSH, obtenido desde una llamada a - ssh2_connect. - - - - - local_file - - - Ruta del fichero local. - - - - - remote_file - - - Ruta del fichero remoto. - - - - - create_mode - - - El fichero debe ser creado con el modo especificado por - create_mode. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Cargar un fichero via SCP - - -]]> - - - - - - &reftitle.seealso; - - ssh2_scp_recv - copy - - - - - diff --git a/reference/ssh2/functions/ssh2-send-eof.xml b/reference/ssh2/functions/ssh2-send-eof.xml deleted file mode 100644 index 5d54e73890..0000000000 --- a/reference/ssh2/functions/ssh2-send-eof.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - ssh2_send_eof - Envía un EOF al flujo - - - - &reftitle.description; - - boolssh2_send_eof - resourcechannel - - - Envía un EOF al flujo; esto se utiliza típicamente para cerrar la entrada estándar, - manteniendo abiertas la salida y los errores. Por ejemplo, se pueden enviar datos a un proceso remoto en la entrada estándar, cerrarla para comenzar el procesamiento, y aún ser capaz de leer los resultados sin crear ficheros adicionales. - - - - - &reftitle.parameters; - - - channel - - - Un flujo SSH; puede ser adquirido por funciones como ssh2_fetch_stream - o ssh2_connect. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - ssh2_fetch_stream - - - - - diff --git a/reference/ssh2/functions/ssh2-send-signal.xml b/reference/ssh2/functions/ssh2-send-signal.xml deleted file mode 100644 index 3aec51749f..0000000000 --- a/reference/ssh2/functions/ssh2-send-signal.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - ssh2_send_signal - Envía una señal a un proceso remoto - - - - &reftitle.description; - - boolssh2_send_signal - resourcechannel - stringsignal - - - Envía una señal al proceso que se ejecuta en el extremo remoto del - channel indicado. - - - - Esta función solo está disponible cuando la extensión se compila con - libssh2 >= 1.9.0. - - - - - - &reftitle.parameters; - - - channel - - - Un flujo de canal SSH, tal como el devuelto por - ssh2_exec o ssh2_shell. - - - - - signal - - - El nombre de la señal a enviar, sin el prefijo SIG, - tal como lo define el protocolo de conexión SSH - (RFC 4254); por ejemplo - TERM, KILL o - INT. - - - El valor se transmite al servidor tal cual; no se valida contra los - nombres enumerados por el protocolo. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - Se emite un error de nivel E_WARNING cuando - channel no es un flujo de canal SSH, y cuando no se - ha podido enviar la señal. - - - - - &reftitle.examples; - - Interrupción de un comando remoto - - -]]> - - - - - - &reftitle.seealso; - - ssh2_exec - ssh2_shell - ssh2_send_eof - - - - - - diff --git a/reference/ssh2/functions/ssh2-set-timeout.xml b/reference/ssh2/functions/ssh2-set-timeout.xml deleted file mode 100644 index 2bdab9e346..0000000000 --- a/reference/ssh2/functions/ssh2-set-timeout.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - ssh2_set_timeout - Define el tiempo límite de las operaciones bloqueantes de una sesión - - - - &reftitle.description; - - voidssh2_set_timeout - resourcesession - intseconds - intmicroseconds0 - - - Define cuánto tiempo puede esperar una operación bloqueante en la - session indicada antes de considerarse expirada. - - - Cuando el tiempo límite resultante es 0, que es el valor - por omisión, no se aplica ningún tiempo límite y las operaciones bloqueantes - pueden esperar indefinidamente. - - - - - &reftitle.parameters; - - - session - - - Un identificador de enlace de conexión SSH, obtenido de una llamada a - ssh2_connect. - - - - - seconds - - - El tiempo límite, en segundos. - - - - - microseconds - - - Un número adicional de microsegundos que se añade al tiempo límite. La - biblioteca subyacente solo soporta precisión de milisegundos, por lo que - este valor se redondea al milisegundo entero superior. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Limitación del tiempo de espera de las operaciones bloqueantes - - -]]> - - - - - - &reftitle.seealso; - - ssh2_connect - ssh2_keepalive_config - stream_set_timeout - - - - - - diff --git a/reference/ssh2/functions/ssh2-sftp-chmod.xml b/reference/ssh2/functions/ssh2-sftp-chmod.xml deleted file mode 100644 index 55b37af512..0000000000 --- a/reference/ssh2/functions/ssh2-sftp-chmod.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - ssh2_sftp_chmod - Modifica el modo de un fichero - - - - &reftitle.description; - - boolssh2_sftp_chmod - resourcesftp - stringfilename - intmode - - - Intenta modificar el modo del fichero especificado, utilizando el - mode proporcionado. - - - - - &reftitle.parameters; - - - sftp - - - Un recurso SSH2 SFTP, abierto con la función - ssh2_sftp. - - - - - filename - - - Ruta hacia el fichero. - - - - - mode - - - Permisos sobre el fichero. Ver la función - chmod para más detalles concernientes - a este parámetro. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Cambio del modo del fichero en el servidor remoto - - -]]> - - - - - - &reftitle.seealso; - - chmod - ssh2_sftp - ssh2_connect - - - - - diff --git a/reference/ssh2/functions/ssh2-sftp-lstat.xml b/reference/ssh2/functions/ssh2-sftp-lstat.xml deleted file mode 100644 index 855281f5d3..0000000000 --- a/reference/ssh2/functions/ssh2-sftp-lstat.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - - ssh2_sftp_lstat - Estado de un enlace simbólico - - - - &reftitle.description; - - arrayfalsessh2_sftp_lstat - resourcesftp - stringpath - - - Estado de un enlace simbólico en el sistema - de ficheros remoto sin seguir el enlace. - - - Esta función es similar a la utilización de la función - lstat con el gestor - ssh2.sftp:// y devuelve los - mismos valores. - - - - - &reftitle.parameters; - - - sftp - - - Un recurso SSH2 SFTP abierto por ssh2_sftp. - - - - - path - - - Ruta hacia el enlace simbólico remoto. - - - - - - - - &reftitle.returnvalues; - - Devuelve un array de estadísticas del enlace simbólico dado en caso de éxito&return.falseforfailure;. - Ver la documentación de la función stat - para los detalles concernientes a los valores devueltos. - - - - - &reftitle.examples; - - Estado de un enlace simbólico vía SFTP - - -]]> - - - - - - &reftitle.seealso; - - ssh2_sftp_stat - lstat - stat - - - - - diff --git a/reference/ssh2/functions/ssh2-sftp-mkdir.xml b/reference/ssh2/functions/ssh2-sftp-mkdir.xml deleted file mode 100644 index ff75e2237c..0000000000 --- a/reference/ssh2/functions/ssh2-sftp-mkdir.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - ssh2_sftp_mkdir - Crea un directorio - - - - &reftitle.description; - - boolssh2_sftp_mkdir - resourcesftp - stringdirname - intmode0777 - boolrecursive&false; - - - Crea un directorio en el sistema de ficheros remoto. - - - Esta función es similar a la función mkdir - con el gestor ssh2.sftp://. - - - - - &reftitle.parameters; - - - sftp - - - Un recurso SSH2 SFTP, abierto con la función - ssh2_sftp. - - - - - dirname - - - Ruta del nuevo directorio. - - - - - mode - - - Permisos del nuevo directorio. - El modo actual es afectado por la umask actual. - - - - - recursive - - - Si recursive vale &true;, todos los directorios requeridos - para dirname serán también automáticamente - creados. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Creación de un directorio en un servidor remoto - - -]]> - - - - - - &reftitle.seealso; - - mkdir - ssh2_sftp_rmdir - - - - - diff --git a/reference/ssh2/functions/ssh2-sftp-readlink.xml b/reference/ssh2/functions/ssh2-sftp-readlink.xml deleted file mode 100644 index e0eb34c531..0000000000 --- a/reference/ssh2/functions/ssh2-sftp-readlink.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - ssh2_sftp_readlink - Devuelve el destino de un enlace simbólico - - - - &reftitle.description; - - stringfalsessh2_sftp_readlink - resourcesftp - stringlink - - - Devuelve el destino de un enlace simbólico. - - - - - &reftitle.parameters; - - - sftp - - - Un recurso SSH2 SFTP, abierto por la función ssh2_sftp. - - - - - link - - - Ruta hacia el enlace simbólico. - - - - - - - - &reftitle.returnvalues; - - Devuelve el destino del enlace simbólico link&return.falseforfailure;. - - - - - &reftitle.examples; - - Lectura de un enlace simbólico - - -]]> - - - - - - &reftitle.seealso; - - readlink - ssh2_sftp_symlink - - - - - diff --git a/reference/ssh2/functions/ssh2-sftp-realpath.xml b/reference/ssh2/functions/ssh2-sftp-realpath.xml deleted file mode 100644 index c9a14fb146..0000000000 --- a/reference/ssh2/functions/ssh2-sftp-realpath.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - ssh2_sftp_realpath - Resuelve la ruta real de una ruta proporcionada - - - - &reftitle.description; - - stringfalsessh2_sftp_realpath - resourcesftp - stringfilename - - - Traduce un nombre de fichero filename en su ruta - realmente efectiva en el sistema de ficheros remoto. - - - - - &reftitle.parameters; - - - sftp - - - Un recurso SSH2 SFTP, abierto por la función ssh2_sftp. - - - - - filename - - - - - - - - - - &reftitle.returnvalues; - - Devuelve la ruta real, en forma de &string;&return.falseforfailure;. - - - - - &reftitle.examples; - - Resolver un nombre de ruta - - -]]> - - - - - - &reftitle.seealso; - - realpath - ssh2_sftp_symlink - ssh2_sftp_readlink - - - - - diff --git a/reference/ssh2/functions/ssh2-sftp-rename.xml b/reference/ssh2/functions/ssh2-sftp-rename.xml deleted file mode 100644 index 888caae0b3..0000000000 --- a/reference/ssh2/functions/ssh2-sftp-rename.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - ssh2_sftp_rename - Renombra un fichero remoto - - - - &reftitle.description; - - boolssh2_sftp_rename - resourcesftp - stringfrom - stringto - - - Renombra un fichero remoto. - - - - - &reftitle.parameters; - - - sftp - - - Un recurso SSH2 SFTP, abierto por la función ssh2_sftp. - - - - - from - - - El fichero actual a renombrar. - - - - - to - - - El nuevo nombre del fichero. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Renombrar un fichero vía sftp - - -]]> - - - - - - &reftitle.seealso; - - rename - - - - - diff --git a/reference/ssh2/functions/ssh2-sftp-rmdir.xml b/reference/ssh2/functions/ssh2-sftp-rmdir.xml deleted file mode 100644 index e5df522815..0000000000 --- a/reference/ssh2/functions/ssh2-sftp-rmdir.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - ssh2_sftp_rmdir - Elimina un directorio - - - - &reftitle.description; - - boolssh2_sftp_rmdir - resourcesftp - stringdirname - - - Elimina un directorio del sistema de ficheros remoto. - - - Esta función es similar al uso de la función - rmdir con el gestor - ssh2.sftp://. - - - - - &reftitle.parameters; - - - sftp - - - Un recurso SSH2 SFTP, abierto por la función ssh2_sftp. - - - - - dirname - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Eliminación de un directorio en un servidor remoto - - -]]> - - - - - - &reftitle.seealso; - - rmdir - ssh2_sftp_mkdir - - - - - diff --git a/reference/ssh2/functions/ssh2-sftp-stat.xml b/reference/ssh2/functions/ssh2-sftp-stat.xml deleted file mode 100644 index db283fa5f4..0000000000 --- a/reference/ssh2/functions/ssh2-sftp-stat.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - ssh2_sftp_stat - Obtiene el estado de un fichero en un sistema de ficheros remoto - - - - &reftitle.description; - - arrayfalsessh2_sftp_stat - resourcesftp - stringpath - - - Obtiene el estado de un fichero en un sistema de ficheros remoto, siguiendo los enlaces simbólicos. - - - Esta función es similar al uso de la función - stat con el gestor - ssh2.sftp:// y devuelve los mismos valores. - - - - - &reftitle.parameters; - - - sftp - - - Un recurso SSH2 SFTP, abierto por la función ssh2_sftp. - - - - - path - - - - - - - - - - &reftitle.returnvalues; - - Devuelve un array de estadísticas del fichero dado en caso de éxito&return.falseforfailure;. - Ver la documentación de la función - stat para los detalles sobre los valores devueltos. - - - - - &reftitle.examples; - - Estado de un fichero vía SFTP - - -]]> - - - - - - &reftitle.seealso; - - ssh2_sftp_lstat - lstat - stat - - - - - diff --git a/reference/ssh2/functions/ssh2-sftp-symlink.xml b/reference/ssh2/functions/ssh2-sftp-symlink.xml deleted file mode 100644 index 956bbf9e2b..0000000000 --- a/reference/ssh2/functions/ssh2-sftp-symlink.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - ssh2_sftp_symlink - Crea un enlace simbólico - - - - &reftitle.description; - - boolssh2_sftp_symlink - resourcesftp - stringtarget - stringlink - - - Crea un enlace simbólico en el sistema de ficheros remoto. - - - - - &reftitle.parameters; - - - sftp - - - Un recurso SSH2 SFTP, abierto por la función ssh2_sftp. - - - - - target - - - Objetivo del enlace simbólico. - - - - - link - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Creación de un enlace simbólico - - -]]> - - - - - - &reftitle.seealso; - - ssh2_sftp_readlink - symlink - - - - - diff --git a/reference/ssh2/functions/ssh2-sftp-unlink.xml b/reference/ssh2/functions/ssh2-sftp-unlink.xml deleted file mode 100644 index 001e47ae0e..0000000000 --- a/reference/ssh2/functions/ssh2-sftp-unlink.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - ssh2_sftp_unlink - Borra un fichero - - - - &reftitle.description; - - boolssh2_sftp_unlink - resourcesftp - stringfilename - - - Borra un fichero en el sistema de ficheros remoto. - - - - - &reftitle.parameters; - - - sftp - - - Un recurso SSH2 SFTP, abierto por la función ssh2_sftp. - - - - - filename - - - El nombre del fichero a borrar. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Borrado de un fichero - - -]]> - - - - - - &reftitle.seealso; - - unlink - - - - - diff --git a/reference/ssh2/functions/ssh2-sftp.xml b/reference/ssh2/functions/ssh2-sftp.xml deleted file mode 100644 index 1a77528ee8..0000000000 --- a/reference/ssh2/functions/ssh2-sftp.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - ssh2_sftp - Inicializa un subsistema SFTP - - - - &reftitle.description; - - resourcefalsessh2_sftp - resourcesession - - - Solicita un subsistema SFTP desde un servidor ya conectado mediante SSH2. - - - - - &reftitle.parameters; - - - session - - - Un identificador de conexión SSH, obtenido desde la función - ssh2_connect. - - - - - - - - &reftitle.returnvalues; - - Este método devuelve un recurso SSH2 SFTP - para su uso con todos los métodos ssh2_sftp_*() - así como el gestor abierto - ssh2.sftp://, - &return.falseforfailure;. - - - - - &reftitle.examples; - - Apertura de un fichero mediante SFTP - - -]]> - - - - - - &reftitle.seealso; - - ssh2_scp_recv - ssh2_scp_send - - - - - diff --git a/reference/ssh2/functions/ssh2-shell-resize.xml b/reference/ssh2/functions/ssh2-shell-resize.xml deleted file mode 100644 index 30e9e07845..0000000000 --- a/reference/ssh2/functions/ssh2-shell-resize.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - ssh2_shell_resize - Cambia las dimensiones del pseudoterminal de un canal - - - - &reftitle.description; - - boolssh2_shell_resize - resourcechannel - intwidth - intheight - intwidth_px0 - intheight_px0 - - - Solicita que el pseudoterminal (PTY) asociado al - channel indicado se redimensione a las dimensiones - dadas. - - - - La extensión solo declara los tres primeros parámetros, con el nombre - session para channel. Por - consiguiente, width_px y - height_px solo pueden pasarse posicionalmente. - - - - - - &reftitle.parameters; - - - channel - - - Un flujo de canal SSH, tal como el devuelto por - ssh2_exec o ssh2_shell. - - - - - width - - - El ancho del terminal, en caracteres. - - - - - height - - - La altura del terminal, en caracteres. - - - - - width_px - - - El ancho del terminal en píxeles, o 0 para dejar sin - especificar las dimensiones en píxeles. - - - - - height_px - - - La altura del terminal en píxeles, o 0 para dejar sin - especificar las dimensiones en píxeles. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true;, o &false; cuando channel no es un - flujo de canal SSH. - - - El resultado de la propia solicitud de redimensionado no se informa: se - devuelve &true; incluso cuando el extremo remoto no la atiende. - - - - - &reftitle.errors; - - Se emite un error de nivel E_WARNING cuando - channel no es un flujo de canal SSH. - - - - - &reftitle.examples; - - Redimensionado del pseudoterminal de un shell - - -]]> - - - - - - &reftitle.seealso; - - ssh2_shell - ssh2_exec - - - - - - diff --git a/reference/ssh2/functions/ssh2-shell.xml b/reference/ssh2/functions/ssh2-shell.xml deleted file mode 100644 index 41e57cef40..0000000000 --- a/reference/ssh2/functions/ssh2-shell.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - ssh2_shell - Solicita un shell interactivo - - - - &reftitle.description; - - resourcefalsessh2_shell - resourcesession - stringtermtype"vanilla" - arraynullenv&null; - intwidth80 - intheight25 - intwidth_height_typeSSH2_TERM_UNIT_CHARS - - - Abre un shell en el servidor remoto y le asigna un flujo. - - - - - &reftitle.parameters; - - - session - - - Un identificador de conexión SSH, obtenido desde la función - ssh2_connect. - - - - - termtype - - - termtype debe corresponder a una - de las entradas del fichero /etc/termcap del sistema objetivo. - - - - - env - - - env debe ser pasado como un array asociativo - de pares nombre/valor a definir en el entorno objetivo. - - - - - width - - - Ancho del terminal virtual. - - - - - height - - - Altura del terminal virtual. - - - - - width_height_type - - - width_height_type debe ser o bien - SSH2_TERM_UNIT_CHARS, o bien - SSH2_TERM_UNIT_PIXELS. - - - - - - - - &reftitle.returnvalues; - - Devuelve un flujo de &resource; en caso de éxito, &return.falseforfailure;. - - - - - &reftitle.examples; - - Ejecución de un comando - - -]]> - - - - - - &reftitle.seealso; - - ssh2_exec - ssh2_tunnel - ssh2_fetch_stream - - - - - diff --git a/reference/ssh2/functions/ssh2-tunnel.xml b/reference/ssh2/functions/ssh2-tunnel.xml deleted file mode 100644 index f2c2aff58d..0000000000 --- a/reference/ssh2/functions/ssh2-tunnel.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - ssh2_tunnel - Abre un túnel a través de un servidor remoto - - - - &reftitle.description; - - resourcessh2_tunnel - resourcesession - stringhost - intport - - - Abre un socket hacia un host/puerto arbitrario - a través de un servidor SSH conectado. - - - - - &reftitle.parameters; - - - session - - - Un identificador de conexión SSH, obtenido desde la función - ssh2_connect. - - - - - host - - - - - - - port - - - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.examples; - - Apertura de un túnel en un host arbitrario - - -]]> - - - - - - &reftitle.seealso; - - ssh2_connect - fsockopen - - - - - diff --git a/reference/ssh2/installation.xml b/reference/ssh2/installation.xml deleted file mode 100644 index e935f3d684..0000000000 --- a/reference/ssh2/installation.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;ssh2. - - - &pecl.windows.download.avail; - - -
    - diff --git a/reference/ssh2/reference.xml b/reference/ssh2/reference.xml deleted file mode 100644 index 4a1da8df6e..0000000000 --- a/reference/ssh2/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - &Functions; de SSH2 - - &reference.ssh2.entities.functions; - - - - diff --git a/reference/ssh2/setup.xml b/reference/ssh2/setup.xml deleted file mode 100644 index 021fb8bbeb..0000000000 --- a/reference/ssh2/setup.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - &reftitle.setup; - - -
    - &reftitle.required; - - Las librerías - OpenSSL y - libssh2 son obligatorias. - Asegúrese que las librerías de desarrollo estan instaladas, - donde el nombre típico del paquete podría ser openssl-dev. - - - Es necesaria la versión 1.2 o posterior de libssh2 , aunque - es posible que nuevos lanzamientos de pecl/ssh2 pueden requerir versiones - posteriores (consultar las notas de lanzamiento) - - - La función ssh2_auth_agent estará disponible únicamente - con libssh2 >= 1.2.3. - - - El soporte para stream_set_timeout para canalizar secuencias - sólo estará disponible con libssh2 >= 1.2.9. - - - libssh2 viene en dos versiones: gcrypt y openssl. Algunas distribuciones - de Linux compilan libssh2 contra la librería gcrypt, y otras utilizan openssl. - libssh2 tiene algunos problemas cuando se compila contra gcrypt, por favor, utilice openssl. - -
    - - - - &reference.ssh2.installation; - - - -
    - &reftitle.resources; - - Esta extensión define los siguientes tipos de recursos: - - SSH2 Session - SSH2 Listener - SSH2 SFTP - SSH2 Publickey Subsystem (disponible a partir de ssh2 0.10) - - - -
    - - -
    - diff --git a/reference/stats/book.xml b/reference/stats/book.xml deleted file mode 100644 index 3d477bc01b..0000000000 --- a/reference/stats/book.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - Estadísticas - - - - &reftitle.intro; - - &warn.pecl.unmaintained; - Esta es la extensión estadística. Contiene algunas decenas de funciones - útiles para los cálculos estadísticos. Es una envoltura alrededor de 2 bibliotecas - científicas, a saber, DCDFLIB (Library of C routines for Cumulative - Distributions Functions, Inverses, and Other parameters) por B. Brown & - J. Lavato y RANDLIB por Barry Brown, James Lavato & Kathy Russell. - Incluye las funciones CD y PD. - - - - - &reference.stats.setup; - &reference.stats.reference; - - - - diff --git a/reference/stats/functions/stats-absolute-deviation.xml b/reference/stats/functions/stats-absolute-deviation.xml deleted file mode 100644 index 64a4ac2acb..0000000000 --- a/reference/stats/functions/stats-absolute-deviation.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - stats_absolute_deviation - Devuelve la desviación absoluta de un array de valores - - - &reftitle.description; - - floatstats_absolute_deviation - arraya - - - Devuelve la desviación absoluta de los valores en a. - - - - &reftitle.parameters; - - - - a - - - El array de entrada - - - - - - - - - &reftitle.returnvalues; - - Devuelve la desviación absoluta de los valores en a, - o &false; si a está vacío o no es un array. - - - - - - diff --git a/reference/stats/functions/stats-cdf-beta.xml b/reference/stats/functions/stats-cdf-beta.xml deleted file mode 100644 index 76b85dd4fe..0000000000 --- a/reference/stats/functions/stats-cdf-beta.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - stats_cdf_beta - Calcula un parámetro de la distribución beta en función de otros valores - - - &reftitle.description; - - floatstats_cdf_beta - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Devuelve la función de distribución acumulativa, su inversa, o uno de los parámetros, - de la distribución beta. El tipo del valor de retorno y los parámetros (par1, - par2, y par3) son determinados por - which. - - - La siguiente tabla lista el valor de retorno y los parámetros por which. - CDF, x, alpha, y beta designan la función de distribución acumulativa, el valor de la variable aleatoria, - y los parámetros de forma de la distribución beta, respectivamente. - - Valor de retorno y parámetros - - - - which - Valor de retorno - par1 - par2 - par3 - - - - - 1 - CDF - x - alpha - beta - - - 2 - x - CDF - alpha - beta - - - 3 - alpha - x - CDF - beta - - - 4 - beta - x - CDF - alpha - - - -
    -
    -
    - - &reftitle.parameters; - - - - par1 - - - El primer parámetro - - - - - par2 - - - El segundo parámetro - - - - - par3 - - - El tercer parámetro - - - - - which - - - El flag para determinar qué debe ser calculado - - - - - - - - - &reftitle.returnvalues; - - Devuelve CDF, x, alpha, o beta, determinado por which. - - - -
    - - diff --git a/reference/stats/functions/stats-cdf-binomial.xml b/reference/stats/functions/stats-cdf-binomial.xml deleted file mode 100644 index e16d7d052f..0000000000 --- a/reference/stats/functions/stats-cdf-binomial.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - stats_cdf_binomial - Calcula un argumento de la distribución binomial en función de los otros valores - - - &reftitle.description; - - floatstats_cdf_binomial - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Devuelve la función de distribución acumulativa, su inversa, o uno de los argumentos, - de la distribución binomial. El tipo del valor de retorno y los parámetros (par1, - par2, y par3) son determinados por - which. - - - La siguiente tabla lista el valor de retorno y los parámetros por which. - CDF, x, n, y p designan la función de distribución acumulativa, el número de éxitos, - el número de intentos, y la tasa de éxito para cada intento, respectivamente. - - Valor de retorno y parámetros - - - - which - Valor de retorno - par1 - par2 - par3 - - - - - 1 - CDF - x - n - p - - - 2 - x - CDF - n - p - - - 3 - n - x - CDF - p - - - 4 - p - x - CDF - n - - - -
    -
    -
    - - &reftitle.parameters; - - - - par1 - - - El primer parámetro - - - - - par2 - - - El segundo parámetro - - - - - par3 - - - El tercer parámetro - - - - - which - - - El flag para determinar qué debe ser calculado - - - - - - - - - &reftitle.returnvalues; - - Devuelve CDF, x, n, o p, determinado por which. - - - -
    - - diff --git a/reference/stats/functions/stats-cdf-cauchy.xml b/reference/stats/functions/stats-cdf-cauchy.xml deleted file mode 100644 index 3ab34dfe2b..0000000000 --- a/reference/stats/functions/stats-cdf-cauchy.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - stats_cdf_cauchy - Calcula un parámetro de la distribución de Cauchy en función de otros valores - - - &reftitle.description; - - floatstats_cdf_cauchy - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Devuelve la función de distribución acumulativa, su inversa, o uno de los parámetros, - de la distribución de Cauchy. El tipo del valor de retorno y los parámetros (par1, - par2, y par3) son determinados por - which. - - - La tabla siguiente lista el valor de retorno y los parámetros por which. - CDF, x, x0, y gamma designan la función de distribución acumulativa, el valor de la variable aleatoria, - el parámetro de localización y el parámetro de escala de la distribución de Cauchy, respectivamente. - - Valor de retorno y parámetros - - - - which - Valor de retorno - par1 - par2 - par3 - - - - - 1 - CDF - x - x0 - gamma - - - 2 - x - CDF - x0 - gamma - - - 3 - x0 - x - CDF - gamma - - - 4 - gamma - x - CDF - x0 - - - -
    -
    -
    - - &reftitle.parameters; - - - - par1 - - - El primer parámetro - - - - - par2 - - - El segundo parámetro - - - - - par3 - - - El tercer parámetro - - - - - which - - - El flag para determinar qué debe ser calculado - - - - - - - - - &reftitle.returnvalues; - - Devuelve CDF, x, x0, o gamma, determinado por which. - - - -
    - - diff --git a/reference/stats/functions/stats-cdf-chisquare.xml b/reference/stats/functions/stats-cdf-chisquare.xml deleted file mode 100644 index e1020a5bdd..0000000000 --- a/reference/stats/functions/stats-cdf-chisquare.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - stats_cdf_chisquare - Calcula un parámetro de la distribución del chi-cuadrado en función de los otros valores - - - &reftitle.description; - - floatstats_cdf_chisquare - floatpar1 - floatpar2 - intwhich - - - Devuelve la función de distribución acumulativa, su inversa, o uno de los parámetros, - de la distribución del chi-cuadrado. El tipo del valor de retorno y los parámetros (par1 - y par2) son determinados por - which. - - - La tabla siguiente lista el valor de retorno y los parámetros por which. - CDF, x, y k designan la función de distribución acumulativa, el valor de la variable aleatoria, - y el grado de libertad de la distribución del chi-cuadrado, respectivamente. - - Valor de retorno y parámetros - - - - which - Valor de retorno - par1 - par2 - - - - - 1 - CDF - x - k - - - 2 - x - CDF - k - - - 3 - k - x - CDF - - - -
    -
    -
    - - &reftitle.parameters; - - - - par1 - - - El primer parámetro - - - - - par2 - - - El segundo parámetro - - - - - which - - - El flag para determinar qué debe ser calculado - - - - - - - - - &reftitle.returnvalues; - - Devuelve CDF, x, o k, determinado por which. - - - -
    - - diff --git a/reference/stats/functions/stats-cdf-exponential.xml b/reference/stats/functions/stats-cdf-exponential.xml deleted file mode 100644 index 74a3530c0d..0000000000 --- a/reference/stats/functions/stats-cdf-exponential.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - stats_cdf_exponential - Calcula un parámetro de la distribución exponencial en función de otros valores - - - &reftitle.description; - - floatstats_cdf_exponential - floatpar1 - floatpar2 - intwhich - - - Devuelve la función de distribución acumulativa, su inversa, o uno de los parámetros, - de la distribución exponencial. El tipo del valor de retorno y los parámetros (par1 - y par2) son determinados por - which. - - - La siguiente tabla lista el valor de retorno y los parámetros por which. - CDF, x, y lambda designan la función de distribución acumulativa, el valor de la variable aleatoria, - y el parámetro de tasa de la distribución exponencial, respectivamente. - - Valor de retorno y parámetros - - - - which - Valor de retorno - par1 - par2 - - - - - 1 - CDF - x - lambda - - - 2 - x - CDF - lambda - - - 3 - lambda - x - CDF - - - -
    -
    -
    - - &reftitle.parameters; - - - - par1 - - - El primer parámetro - - - - - par2 - - - El segundo parámetro - - - - - which - - - El flag para determinar qué debe ser calculado - - - - - - - - - &reftitle.returnvalues; - - Devuelve CDF, x, o lambda, determinado por which. - - - -
    - - diff --git a/reference/stats/functions/stats-cdf-f.xml b/reference/stats/functions/stats-cdf-f.xml deleted file mode 100644 index 2ceee0719a..0000000000 --- a/reference/stats/functions/stats-cdf-f.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - stats_cdf_f - Calcula un parámetro de la distribución F en función de otros valores - - - &reftitle.description; - - floatstats_cdf_f - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Devuelve la función de distribución acumulativa, su inversa, o uno de los parámetros, - de la distribución F. El tipo de la valor de retorno y los parámetros (par1, - par2, y par3) son determinados por - which. - - - La tabla siguiente lista el valor de retorno y los parámetros por which. - CDF, x, d1, y d2 designan la función de distribución acumulativa, el valor de la variable aleatoria, - y los grados de libertad de la distribución F, respectivamente. - - Valor de retorno y parámetros - - - - which - Valor de retorno - par1 - par2 - par3 - - - - - 1 - CDF - x - d1 - d2 - - - 2 - x - CDF - d1 - d2 - - - 3 - d1 - x - CDF - d2 - - - 4 - d2 - x - CDF - d1 - - - -
    -
    -
    - - &reftitle.parameters; - - - - par1 - - - El primer parámetro - - - - - par2 - - - El segundo parámetro - - - - - par3 - - - El tercer parámetro - - - - - which - - - El flag para determinar qué debe ser calculado - - - - - - - - - &reftitle.returnvalues; - - Devuelve CDF, x, d1, o d2, determinado por which. - - - -
    - - diff --git a/reference/stats/functions/stats-cdf-gamma.xml b/reference/stats/functions/stats-cdf-gamma.xml deleted file mode 100644 index a78287e24d..0000000000 --- a/reference/stats/functions/stats-cdf-gamma.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - stats_cdf_gamma - Calcula un parámetro de la distribución gamma en función de los otros valores - - - &reftitle.description; - - floatstats_cdf_gamma - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Devuelve la función de distribución acumulativa, su inversa, o uno de los parámetros, - de la distribución gamma. El tipo del valor de retorno y los parámetros (par1, - par2, y par3) son determinados por - which. - - - La tabla siguiente lista el valor de retorno y los parámetros por which. - CDF, x, k, y theta designan la función de distribución acumulativa, el valor de la variable aleatoria, - y los parámetros de forma y escala de la distribución gamma, respectivamente. - - Valor de retorno y parámetros - - - - which - Valor de retorno - par1 - par2 - par3 - - - - - 1 - CDF - x - k - theta - - - 2 - x - CDF - k - theta - - - 3 - k - x - CDF - theta - - - 4 - theta - x - CDF - k - - - -
    -
    -
    - - &reftitle.parameters; - - - - par1 - - - El primer parámetro - - - - - par2 - - - El segundo parámetro - - - - - par3 - - - El tercer parámetro - - - - - which - - - El flag para determinar qué debe ser calculado - - - - - - - - - &reftitle.returnvalues; - - Devuelve CDF, x, k, o theta, determinado por which. - - - -
    - - diff --git a/reference/stats/functions/stats-cdf-laplace.xml b/reference/stats/functions/stats-cdf-laplace.xml deleted file mode 100644 index 8baa3027ed..0000000000 --- a/reference/stats/functions/stats-cdf-laplace.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - stats_cdf_laplace - Calcula un parámetro de la distribución de Laplace en función de los otros valores - - - &reftitle.description; - - floatstats_cdf_laplace - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Devuelve la función de distribución acumulativa, su inversa, o uno de los parámetros, - de la distribución de Laplace. El tipo del valor de retorno y los parámetros (par1, - par2, y par3) son determinados por - which. - - - La tabla siguiente lista el valor de retorno y los parámetros por which. - CDF, x, mu, y b designan la función de distribución acumulativa, el valor de la variable aleatoria, - y los parámetros de localización y escala de la distribución de Laplace, respectivamente. - - Valor de retorno y parámetros - - - - which - Valor de retorno - par1 - par2 - par3 - - - - - 1 - CDF - x - mu - b - - - 2 - x - CDF - mu - b - - - 3 - mu - x - CDF - b - - - 4 - b - x - CDF - mu - - - -
    -
    -
    - - &reftitle.parameters; - - - - par1 - - - El primer parámetro - - - - - par2 - - - El segundo parámetro - - - - - par3 - - - El tercer parámetro - - - - - which - - - El flag para determinar qué debe ser calculado - - - - - - - - - &reftitle.returnvalues; - - Devuelve CDF, x, mu, o b, determinado por which. - - - -
    - - diff --git a/reference/stats/functions/stats-cdf-logistic.xml b/reference/stats/functions/stats-cdf-logistic.xml deleted file mode 100644 index b9b68c4949..0000000000 --- a/reference/stats/functions/stats-cdf-logistic.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - stats_cdf_logistic - Calcula un parámetro de la distribución logística en función de otros valores - - - &reftitle.description; - - floatstats_cdf_logistic - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Devuelve la función de distribución acumulativa, su inversa, o uno de los parámetros, - de la distribución logística. El tipo del valor de retorno y los parámetros (par1, - par2, y par3) son determinados por - which. - - - La siguiente tabla lista el valor de retorno y los parámetros por which. - CDF, x, mu, y s designan la función de distribución acumulativa, el valor de la variable aleatoria, - y los parámetros de localización y escala de la distribución logística, respectivamente. - - Valor de retorno y parámetros - - - - which - Valor de retorno - par1 - par2 - par3 - - - - - 1 - CDF - x - mu - s - - - 2 - x - CDF - mu - s - - - 3 - mu - x - CDF - s - - - 4 - s - x - CDF - mu - - - -
    -
    -
    - - &reftitle.parameters; - - - - par1 - - - El primer parámetro - - - - - par2 - - - El segundo parámetro - - - - - par3 - - - El tercer parámetro - - - - - which - - - El flag para determinar qué debe ser calculado - - - - - - - - - &reftitle.returnvalues; - - Devuelve CDF, x, mu, o s, determinado por which. - - - -
    - - diff --git a/reference/stats/functions/stats-cdf-negative-binomial.xml b/reference/stats/functions/stats-cdf-negative-binomial.xml deleted file mode 100644 index 6dffeb6335..0000000000 --- a/reference/stats/functions/stats-cdf-negative-binomial.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - stats_cdf_negative_binomial - Calcula un parámetro de la distribución binomial negativa en función de los otros valores - - - &reftitle.description; - - floatstats_cdf_negative_binomial - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Devuelve la función de distribución acumulativa, su inversa, o uno de los parámetros, - de la distribución binomial negativa. El tipo del valor de retorno y los parámetros (par1, - par2, y par3) son determinados por - which. - - - La tabla siguiente lista el valor de retorno y los parámetros por which. - CDF, x, r, y p designan la función de distribución acumulativa, el número de fallos, el número de éxitos, - y la tasa de éxito para cada intento, respectivamente. - - Valor de retorno y parámetros - - - - which - Valor de retorno - par1 - par2 - par3 - - - - - 1 - CDF - x - r - p - - - 2 - x - CDF - r - p - - - 3 - r - x - CDF - p - - - 4 - p - x - CDF - r - - - -
    -
    -
    - - &reftitle.parameters; - - - - par1 - - - El primer parámetro - - - - - par2 - - - El segundo parámetro - - - - - par3 - - - El tercer parámetro - - - - - which - - - El flag para determinar qué debe ser calculado - - - - - - - - - &reftitle.returnvalues; - - Devuelve CDF, x, r, o p, determinado por which. - - - -
    - - diff --git a/reference/stats/functions/stats-cdf-noncentral-chisquare.xml b/reference/stats/functions/stats-cdf-noncentral-chisquare.xml deleted file mode 100644 index 7d9a7d51be..0000000000 --- a/reference/stats/functions/stats-cdf-noncentral-chisquare.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - stats_cdf_noncentral_chisquare - Calcula un argumento de la distribución del chi-cuadrado no central en función de otros valores - - - &reftitle.description; - - floatstats_cdf_noncentral_chisquare - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Devuelve la función de distribución acumulativa, su inversa, o uno de los parámetros, - de la distribución binomial. El tipo del valor de retorno y los parámetros (par1, - par2, y par3) son determinados por - which. - - - La tabla siguiente lista el valor de retorno y los parámetros por which. - CDF, x, k, y lambda designan la función de distribución acumulativa, el valor de la variable aleatoria, - el grado de libertad y el argumento de no centralidad de la distribución del chi-cuadrado no central, respectivamente. - - Valor de retorno y parámetros - - - - which - Valor de retorno - par1 - par2 - par3 - - - - - 1 - CDF - x - k - lambda - - - 2 - x - CDF - k - lambda - - - 3 - k - x - CDF - lambda - - - 4 - lambda - x - CDF - k - - - -
    -
    -
    - - &reftitle.parameters; - - - - par1 - - - El primer parámetro - - - - - par2 - - - El segundo parámetro - - - - - par3 - - - El tercer parámetro - - - - - which - - - El flag para determinar qué debe ser calculado - - - - - - - - - &reftitle.returnvalues; - - Devuelve CDF, x, k, o lambda, determinado por which. - - - -
    - - diff --git a/reference/stats/functions/stats-cdf-noncentral-f.xml b/reference/stats/functions/stats-cdf-noncentral-f.xml deleted file mode 100644 index bdc71a92e7..0000000000 --- a/reference/stats/functions/stats-cdf-noncentral-f.xml +++ /dev/null @@ -1,164 +0,0 @@ - - - - - - stats_cdf_noncentral_f - Calcula un parámetro de la distribución F no central en función de los otros valores - - - &reftitle.description; - - floatstats_cdf_noncentral_f - floatpar1 - floatpar2 - floatpar3 - floatpar4 - intwhich - - - Devuelve la función de distribución acumulativa, su inversa, o uno de los parámetros, - de la distribución F no central. El tipo de la valor de retorno y los parámetros (par1, - par2, par3, y par4) son determinados por - which. - - - La tabla siguiente lista el valor de retorno y los parámetros por which. - CDF, x, nu1, nu2, y lambda designan la función de distribución acumulativa, el valor de la variable aleatoria, - los grados de libertad y el parámetro de no centralidad de la distribución F no central, respectivamente. - - Valor de retorno y parámetros - - - - which - Valor de retorno - par1 - par2 - par3 - par4 - - - - - 1 - CDF - x - nu1 - nu2 - lambda - - - 2 - x - CDF - nu1 - nu2 - lambda - - - 3 - nu1 - x - CDF - nu2 - lambda - - - 4 - nu2 - x - CDF - nu1 - lambda - - - 5 - lambda - x - CDF - nu1 - nu2 - - - -
    -
    -
    - - &reftitle.parameters; - - - - par1 - - - El primer parámetro - - - - - par2 - - - El segundo parámetro - - - - - par3 - - - El tercer parámetro - - - - - par4 - - - El cuarto parámetro - - - - - which - - - El flag para determinar qué debe ser calculado - - - - - - - - - &reftitle.returnvalues; - - Devuelve CDF, x, nu1, nu2, o lambda, determinado por which. - - - -
    - - diff --git a/reference/stats/functions/stats-cdf-noncentral-t.xml b/reference/stats/functions/stats-cdf-noncentral-t.xml deleted file mode 100644 index 3eda72abcb..0000000000 --- a/reference/stats/functions/stats-cdf-noncentral-t.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - stats_cdf_noncentral_t - Calcula un parámetro de la distribución t no central en función de los otros valores - - - - &reftitle.description; - - floatstats_cdf_noncentral_t - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Devuelve la función de distribución acumulativa, su inversa, o uno de los parámetros, - de la distribución t no central. El tipo del valor de retorno y los parámetros (par1, - par2, y par3) son determinados por - which. - - - La siguiente tabla lista el valor de retorno y los parámetros por which. - CDF, x, nu, y mu designan la función de distribución acumulativa, el valor de la variable aleatoria, - los grados de libertad y el parámetro de no centralidad de la distribución, respectivamente. - - Valor de retorno y parámetros - - - - which - Valor de retorno - par1 - par2 - par3 - - - - - 1 - CDF - x - nu - mu - - - 2 - x - CDF - nu - mu - - - 3 - nu - x - CDF - mu - - - 4 - mu - x - CDF - nu - - - -
    -
    -
    - - - &reftitle.parameters; - - - - par1 - - - El primer parámetro - - - - - par2 - - - El segundo parámetro - - - - - par3 - - - El tercer parámetro - - - - - which - - - El flag para determinar qué debe ser calculado - - - - - - - - - &reftitle.returnvalues; - - Devuelve CDF, x, nu, o mu, determinado por which. - - - -
    - - diff --git a/reference/stats/functions/stats-cdf-normal.xml b/reference/stats/functions/stats-cdf-normal.xml deleted file mode 100644 index 6d1e0f7222..0000000000 --- a/reference/stats/functions/stats-cdf-normal.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - - stats_cdf_normal - Calcule un parámetro de la distribución normal en función de los otros valores - - - - &reftitle.description; - - floatstats_cdf_normal - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Devuelve la función de distribución acumulativa, su inversa, o uno de los parámetros, - de la distribución normal. El tipo del valor de retorno y los parámetros (par1, - par2, y par3) son determinados por - which. - - - La tabla siguiente lista el valor de retorno y los parámetros por which. - CDF, x, mu, y sigma designan la función de distribución acumulativa, el valor de la variable aleatoria, - la media y la desviación estándar de la distribución normal, respectivamente. - - Valor de retorno y parámetros - - - - which - Valor de retorno - par1 - par2 - par3 - - - - - 1 - CDF - x - mu - sigma - - - 2 - x - CDF - mu - sigma - - - 3 - mu - x - CDF - sigma - - - 4 - sigma - x - CDF - mu - - - -
    -
    -
    - - - &reftitle.parameters; - - - - par1 - - - El primer parámetro - - - - - par2 - - - El segundo parámetro - - - - - par3 - - - El tercer parámetro - - - - - which - - - El flag para determinar qué debe ser calculado - - - - - - - - - &reftitle.returnvalues; - - Devuelve CDF, x, mu, o sigma, determinado por which. - - - -
    - - diff --git a/reference/stats/functions/stats-cdf-poisson.xml b/reference/stats/functions/stats-cdf-poisson.xml deleted file mode 100644 index f98ed41fdd..0000000000 --- a/reference/stats/functions/stats-cdf-poisson.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - stats_cdf_poisson - Calcula un parámetro de la distribución de Poisson en función de los otros valores - - - &reftitle.description; - - floatstats_cdf_poisson - floatpar1 - floatpar2 - intwhich - - - Devuelve la función de distribución acumulativa, su inversa, o uno de los parámetros, de la distribución de Poisson. - El tipo del valor de retorno y los parámetros (par1 y par2) son - determinados por which. - - - La tabla siguiente lista el valor de retorno y los parámetros por which. - CDF, x, y lambda designan la función de distribución acumulativa, el valor de la variable aleatoria, - y el parámetro de la distribución de Poisson, respectivamente. - - Valor de retorno y parámetros - - - - which - Valor de retorno - par1 - par2 - - - - - 1 - CDF - x - lambda - - - 2 - x - CDF - lambda - - - 3 - lambda - x - CDF - - - -
    -
    -
    - - &reftitle.parameters; - - - - par1 - - - El primer parámetro - - - - - par2 - - - El segundo parámetro - - - - - which - - - El flag para determinar qué debe ser calculado - - - - - - - - - &reftitle.returnvalues; - - Devuelve CDF, x, o lambda, determinado por which. - - - -
    - - diff --git a/reference/stats/functions/stats-cdf-t.xml b/reference/stats/functions/stats-cdf-t.xml deleted file mode 100644 index 1e82e45cfe..0000000000 --- a/reference/stats/functions/stats-cdf-t.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - stats_cdf_t - Calcula un parámetro de la distribución t en función de los otros valores - - - &reftitle.description; - - floatstats_cdf_t - floatpar1 - floatpar2 - intwhich - - - Devuelve la función de distribución acumulativa, su inversa, o uno de los parámetros, - de la distribución t. El tipo del valor de retorno y los parámetros (par1 - y par2) son determinados por which. - - - La siguiente tabla lista el valor de retorno y los parámetros por which. - CDF, x, y nu designan la función de distribución acumulativa, el valor de la variable aleatoria, - y los grados de libertad de la distribución t, respectivamente. - - Valor de retorno y parámetros - - - - which - Valor de retorno - par1 - par2 - - - - - 1 - CDF - x - nu - - - 2 - x - CDF - nu - - - 3 - nu - x - CDF - - - -
    -
    -
    - - &reftitle.parameters; - - - - par1 - - - El primer parámetro - - - - - par2 - - - El segundo parámetro - - - - - which - - - El flag para determinar qué debe ser calculado - - - - - - - - - &reftitle.returnvalues; - - Devuelve CDF, x, o nu, determinado por which. - - - -
    - - diff --git a/reference/stats/functions/stats-cdf-uniform.xml b/reference/stats/functions/stats-cdf-uniform.xml deleted file mode 100644 index 45ad99e5a5..0000000000 --- a/reference/stats/functions/stats-cdf-uniform.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - stats_cdf_uniform - Calcula un parámetro de la distribución uniforme en función de otros valores - - - &reftitle.description; - - floatstats_cdf_uniform - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Devuelve la función de distribución acumulativa, su inversa, o uno de los parámetros, - de la distribución uniforme. El tipo del valor de retorno y los parámetros (par1, - par2, y par3) son determinados por - which. - - - La tabla siguiente lista el valor de retorno y los parámetros por which. - CDF, x, a, y b designan la función de distribución acumulativa, el valor de la variable aleatoria, - y los límites inferior y superior de la distribución uniforme, respectivamente. - - Valor de retorno y parámetros - - - - which - Valor de retorno - par1 - par2 - par3 - - - - - 1 - CDF - x - a - b - - - 2 - x - CDF - a - b - - - 3 - a - x - CDF - b - - - 4 - b - x - CDF - a - - - -
    -
    -
    - - &reftitle.parameters; - - - - par1 - - - El primer parámetro - - - - - par2 - - - El segundo parámetro - - - - - par3 - - - El tercer parámetro - - - - - which - - - El flag para determinar qué debe ser calculado - - - - - - - - - &reftitle.returnvalues; - - Devuelve CDF, x, a, o b, determinado por which. - - - -
    - - diff --git a/reference/stats/functions/stats-cdf-weibull.xml b/reference/stats/functions/stats-cdf-weibull.xml deleted file mode 100644 index b3719048d0..0000000000 --- a/reference/stats/functions/stats-cdf-weibull.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - stats_cdf_weibull - Calcula un parámetro de la distribución de Weibull en función de otros valores - - - &reftitle.description; - - floatstats_cdf_weibull - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Devuelve la función de distribución acumulativa, su inversa, o uno de los parámetros, - de la distribución de Weibull. El tipo de la valor de retorno y los parámetros - (par1, par2, y par3) - son determinados por which. - - - La siguiente tabla lista el valor de retorno y los parámetros por which. - CDF, x, k, y lambda designan la función de distribución acumulativa, el valor de la variable aleatoria, - y los parámetros de forma y escala de la distribución de Weibull, respectivamente. - - Valor de retorno y parámetros - - - - which - Valor de retorno - par1 - par2 - par3 - - - - - 1 - CDF - x - k - lambda - - - 2 - x - CDF - k - lambda - - - 3 - k - x - CDF - lambda - - - 4 - lambda - x - CDF - k - - - -
    -
    -
    - - &reftitle.parameters; - - - - par1 - - - El primer parámetro - - - - - par2 - - - El segundo parámetro - - - - - par3 - - - El tercer parámetro - - - - - which - - - El flag para determinar qué debe ser calculado - - - - - - - - - &reftitle.returnvalues; - - Devuelve CDF, x, k, o lambda, determinado por which. - - - -
    - - diff --git a/reference/stats/functions/stats-covariance.xml b/reference/stats/functions/stats-covariance.xml deleted file mode 100644 index bef4a3c0b0..0000000000 --- a/reference/stats/functions/stats-covariance.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - stats_covariance - Calcula la covarianza de dos conjuntos de datos - - - &reftitle.description; - - floatstats_covariance - arraya - arrayb - - - Devuelve la covarianza de a y b. - - - - &reftitle.parameters; - - - - a - - - El primer array - - - - - b - - - El segundo array - - - - - - - - - &reftitle.returnvalues; - - Devuelve la covarianza de a y b, - o &false; en caso de fallo. - - - - - - diff --git a/reference/stats/functions/stats-dens-beta.xml b/reference/stats/functions/stats-dens-beta.xml deleted file mode 100644 index a3d91e9412..0000000000 --- a/reference/stats/functions/stats-dens-beta.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - stats_dens_beta - La función de densidad de probabilidad de la distribución beta - - - &reftitle.description; - - floatstats_dens_beta - floatx - floata - floatb - - - Devuelve la densidad de probabilidad en x, donde - la variable aleatoria sigue la distribución beta cuyos parámetros de forma - son a y b. - - - - &reftitle.parameters; - - - - x - - - El valor en el cual se calcula la densidad de probabilidad - - - - - a - - - El parámetro de forma de la distribución - - - - - b - - - El parámetro de forma de la distribución - - - - - - - - - &reftitle.returnvalues; - - La densidad de probabilidad en x o &false; en caso de error. - - - - - - diff --git a/reference/stats/functions/stats-dens-cauchy.xml b/reference/stats/functions/stats-dens-cauchy.xml deleted file mode 100644 index 52dcd30892..0000000000 --- a/reference/stats/functions/stats-dens-cauchy.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - stats_dens_cauchy - La función de densidad de probabilidad de la distribución de Cauchy - - - &reftitle.description; - - floatstats_dens_cauchy - floatx - floatave - floatstdev - - - Devuelve la densidad de probabilidad en x, donde - la variable aleatoria sigue la distribución de Cauchy cuyos parámetros de - ubicación y escala son ave y stdev. - - - - &reftitle.parameters; - - - - x - - - El valor en el cual se calcula la densidad de probabilidad - - - - - ave - - - El parámetro de ubicación de la distribución - - - - - stdev - - - El parámetro de escala de la distribución - - - - - - - - - &reftitle.returnvalues; - - La densidad de probabilidad en x o &false; en caso de error. - - - - - - diff --git a/reference/stats/functions/stats-dens-chisquare.xml b/reference/stats/functions/stats-dens-chisquare.xml deleted file mode 100644 index d9cca203aa..0000000000 --- a/reference/stats/functions/stats-dens-chisquare.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - stats_dens_chisquare - La función de densidad de probabilidad de la distribución chi-cuadrado - - - &reftitle.description; - - floatstats_dens_chisquare - floatx - floatdfr - - - Devuelve la densidad de probabilidad en x, donde - la variable aleatoria sigue la distribución chi-cuadrado con grados de - libertad dfr. - - - - &reftitle.parameters; - - - - x - - - El valor en el cual se calcula la densidad de probabilidad - - - - - dfr - - - Los grados de libertad de la distribución - - - - - - - - - &reftitle.returnvalues; - - La densidad de probabilidad en x o &false; en caso de error. - - - - - - diff --git a/reference/stats/functions/stats-dens-exponential.xml b/reference/stats/functions/stats-dens-exponential.xml deleted file mode 100644 index eae4ba5b30..0000000000 --- a/reference/stats/functions/stats-dens-exponential.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - stats_dens_exponential - La función de densidad de probabilidad de la distribución exponencial - - - &reftitle.description; - - floatstats_dens_exponential - floatx - floatscale - - - Devuelve la densidad de probabilidad en x, donde - la variable aleatoria sigue la distribución exponencial cuya escala es - scale. - - - - &reftitle.parameters; - - - - x - - - El valor en el cual se calcula la densidad de probabilidad - - - - - scale - - - La escala de la distribución - - - - - - - - - &reftitle.returnvalues; - - La densidad de probabilidad en x o &false; en caso de error. - - - - - - diff --git a/reference/stats/functions/stats-dens-f.xml b/reference/stats/functions/stats-dens-f.xml deleted file mode 100644 index 7bdaa312af..0000000000 --- a/reference/stats/functions/stats-dens-f.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - stats_dens_f - La función de densidad de probabilidad de la distribución F - - - &reftitle.description; - - floatstats_dens_f - floatx - floatdfr1 - floatdfr2 - - - Devuelve la densidad de probabilidad en x, donde - la variable aleatoria sigue la distribución F cuyos grados de libertad son - dfr1 y dfr2. - - - - &reftitle.parameters; - - - - x - - - El valor en el cual se calcula la densidad de probabilidad - - - - - dfr1 - - - El grado de libertad de la distribución - - - - - dfr2 - - - El grado de libertad de la distribución - - - - - - - - - &reftitle.returnvalues; - - La densidad de probabilidad en x o &false; en caso de error. - - - - - - diff --git a/reference/stats/functions/stats-dens-gamma.xml b/reference/stats/functions/stats-dens-gamma.xml deleted file mode 100644 index f4f0c869ac..0000000000 --- a/reference/stats/functions/stats-dens-gamma.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - stats_dens_gamma - La función de densidad de probabilidad de la distribución gamma - - - &reftitle.description; - - floatstats_dens_gamma - floatx - floatshape - floatscale - - - Devuelve la densidad de probabilidad en x, donde - la variable aleatoria sigue la distribución gamma cuyo parámetro de forma - es shape y el parámetro de escala es scale. - - - - &reftitle.parameters; - - - - x - - - El valor en el cual se calcula la densidad de probabilidad - - - - - shape - - - El parámetro de forma de la distribución - - - - - scale - - - El parámetro de escala de la distribución - - - - - - - - - &reftitle.returnvalues; - - La densidad de probabilidad en x o &false; en caso de error. - - - - - - diff --git a/reference/stats/functions/stats-dens-laplace.xml b/reference/stats/functions/stats-dens-laplace.xml deleted file mode 100644 index 21bb2ab6ba..0000000000 --- a/reference/stats/functions/stats-dens-laplace.xml +++ /dev/null @@ -1,160 +0,0 @@ - - - - - - stats_dens_laplace - La función de densidad de probabilidad de la distribución de Laplace - - - &reftitle.description; - - floatstats_dens_laplace - floatx - floatave - floatstdev - - - Devuelve la densidad de probabilidad en x, donde - la variable aleatoria sigue la distribución de Laplace cuyo parámetro de - localización es ave y el parámetro de escala es - stdev. - - - - &reftitle.parameters; - - - - x - - - El valor en el cual se calcula la densidad de probabilidad - - - - - ave - - - El parámetro de localización de la distribución - - - - - stdev - - - El parámetro de escala de la distribución - - - - - - - - - &reftitle.returnvalues; - - La densidad de probabilidad en x o &false; en caso de fallo. - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-dens-logistic.xml b/reference/stats/functions/stats-dens-logistic.xml deleted file mode 100644 index f830f6fb0b..0000000000 --- a/reference/stats/functions/stats-dens-logistic.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - stats_dens_logistic - La función de densidad de probabilidad de la distribución logística - - - &reftitle.description; - - floatstats_dens_logistic - floatx - floatave - floatstdev - - - Devuelve la densidad de probabilidad en x, donde - la variable aleatoria sigue la distribución logística cuyo parámetro de - localización es ave y el parámetro de escala es - stdev. - - - - &reftitle.parameters; - - - - x - - - El valor en el cual se calcula la densidad de probabilidad - - - - - ave - - - El parámetro de localización de la distribución - - - - - stdev - - - El parámetro de escala de la distribución - - - - - - - - - &reftitle.returnvalues; - - La densidad de probabilidad en x o &false; en caso de error. - - - - - - diff --git a/reference/stats/functions/stats-dens-normal.xml b/reference/stats/functions/stats-dens-normal.xml deleted file mode 100644 index ee5cd0a427..0000000000 --- a/reference/stats/functions/stats-dens-normal.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - stats_dens_normal - La función de densidad de probabilidad de la distribución normal - - - &reftitle.description; - - floatstats_dens_normal - floatx - floatave - floatstdev - - - Devuelve la densidad de probabilidad en x, donde - la variable aleatoria sigue la distribución normal con media - ave y desviación estándar - stdev. - - - - &reftitle.parameters; - - - - x - - - El valor en el que se calcula la densidad de probabilidad - - - - - ave - - - La media de la distribución - - - - - stdev - - - La desviación estándar de la distribución - - - - - - - - - &reftitle.returnvalues; - - La densidad de probabilidad en x o &false; en caso de error. - - - - - - diff --git a/reference/stats/functions/stats-dens-pmf-binomial.xml b/reference/stats/functions/stats-dens-pmf-binomial.xml deleted file mode 100644 index 1f7960d862..0000000000 --- a/reference/stats/functions/stats-dens-pmf-binomial.xml +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - stats_dens_pmf_binomial - La función de masa de probabilidad de la distribución binomial - - - &reftitle.description; - - floatstats_dens_pmf_binomial - floatx - floatn - floatpi - - - Devuelve la masa de probabilidad en x, donde la variable aleatoria - sigue la distribución binomial cuyo número de ensayos es n - y la tasa de éxito es pi. - - - - &reftitle.parameters; - - - - x - - - El valor en el cual se calcula la masa de probabilidad - - - - - n - - - El número de ensayos de la distribución - - - - - pi - - - La tasa de éxito de la distribución - - - - - - - - - &reftitle.returnvalues; - - La masa de probabilidad en x o &false; en caso de fallo. - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-dens-pmf-hypergeometric.xml b/reference/stats/functions/stats-dens-pmf-hypergeometric.xml deleted file mode 100644 index 7a92416322..0000000000 --- a/reference/stats/functions/stats-dens-pmf-hypergeometric.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - stats_dens_pmf_hypergeometric - La función de masa de probabilidad de la distribución hipergeométrica - - - &reftitle.description; - - floatstats_dens_pmf_hypergeometric - floatn1 - floatn2 - floatN1 - floatN2 - - - Devuelve la masa de probabilidad en n1, donde la variable aleatoria - sigue la distribución hipergeométrica cuyo número de fallos es - n2, el número de muestras de éxito es N1, - y el número de muestras de fallos es N2. - - - - &reftitle.parameters; - - - - n1 - - - El número de éxitos, a partir del cual se calcula la masa de probabilidad - - - - - n2 - - - El número de fallos de la distribución - - - - - N1 - - - El número de muestras de éxito de la distribución - - - - - N2 - - - El número de muestras de fallos de la distribución - - - - - - - - - &reftitle.returnvalues; - - La masa de probabilidad en n1 o &false; en caso de error. - - - - - - diff --git a/reference/stats/functions/stats-dens-pmf-negative-binomial.xml b/reference/stats/functions/stats-dens-pmf-negative-binomial.xml deleted file mode 100644 index 033e47a6fc..0000000000 --- a/reference/stats/functions/stats-dens-pmf-negative-binomial.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - stats_dens_pmf_negative_binomial - La función de masa de probabilidad de la distribución binomial negativa - - - - &reftitle.description; - - floatstats_dens_pmf_negative_binomial - floatx - floatn - floatpi - - - Devuelve la masa de probabilidad en x, donde - la variable aleatoria sigue la distribución binomial negativa cuyo - número de éxitos es n y la tasa de éxito es - pi. - - - - - &reftitle.parameters; - - - - x - - - El valor en el cual se calcula la masa de probabilidad - - - - - n - - - El número de éxitos de la distribución - - - - - pi - - - La tasa de éxito de la distribución - - - - - - - - - &reftitle.returnvalues; - - La masa de probabilidad en x o &false; en caso de error. - - - - - - diff --git a/reference/stats/functions/stats-dens-pmf-poisson.xml b/reference/stats/functions/stats-dens-pmf-poisson.xml deleted file mode 100644 index 497afef966..0000000000 --- a/reference/stats/functions/stats-dens-pmf-poisson.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - stats_dens_pmf_poisson - La función de masa de probabilidad de la distribución de Poisson - - - &reftitle.description; - - floatstats_dens_pmf_poisson - floatx - floatlb - - - Devuelve la masa de probabilidad en x, donde la variable aleatoria - sigue la distribución de Poisson cuyo parámetro es lb. - - - - &reftitle.parameters; - - - - x - - - El valor en el cual se calcula la masa de probabilidad - - - - - lb - - - El parámetro de la distribución de Poisson - - - - - - - - - &reftitle.returnvalues; - - La masa de probabilidad en x o &false; en caso de error. - - - - - - diff --git a/reference/stats/functions/stats-dens-t.xml b/reference/stats/functions/stats-dens-t.xml deleted file mode 100644 index 85418feed6..0000000000 --- a/reference/stats/functions/stats-dens-t.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - stats_dens_t - La función de densidad de probabilidad de la distribución t - - - &reftitle.description; - - floatstats_dens_t - floatx - floatdfr - - - Devuelve la densidad de probabilidad en x, donde la variable - aleatoria sigue la distribución t cuyo grado de libertad es dfr. - - - - &reftitle.parameters; - - - - x - - - El valor en el cual se calcula la densidad de probabilidad - - - - - dfr - - - El grado de libertad de la distribución - - - - - - - - - &reftitle.returnvalues; - - La densidad de probabilidad en x o &false; en caso de error. - - - - - - diff --git a/reference/stats/functions/stats-dens-uniform.xml b/reference/stats/functions/stats-dens-uniform.xml deleted file mode 100644 index a6c183d96b..0000000000 --- a/reference/stats/functions/stats-dens-uniform.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - stats_dens_uniform - La función de densidad de probabilidad de la distribución uniforme - - - - &reftitle.description; - - floatstats_dens_uniform - floatx - floata - floatb - - - Devuelve la densidad de probabilidad en x, donde la variable - aleatoria sigue la distribución uniforme cuyo límite inferior es - a y el límite superior es b. - - - - - &reftitle.parameters; - - - - x - - - El valor en el cual se calcula la densidad de probabilidad - - - - - a - - - El límite inferior de la distribución - - - - - b - - - El límite superior de la distribución - - - - - - - - - &reftitle.returnvalues; - - La densidad de probabilidad en x o &false; en caso de error. - - - - - - diff --git a/reference/stats/functions/stats-dens-weibull.xml b/reference/stats/functions/stats-dens-weibull.xml deleted file mode 100644 index 455cc86fe0..0000000000 --- a/reference/stats/functions/stats-dens-weibull.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - stats_dens_weibull - La función de densidad de probabilidad de la distribución de Weibull - - - &reftitle.description; - - floatstats_dens_weibull - floatx - floata - floatb - - - Devuelve la densidad de probabilidad en x, donde la variable - aleatoria sigue la distribución de Weibull cuyo parámetro de forma es - a y el parámetro de escala es b. - - - - &reftitle.parameters; - - - - x - - - El valor en el cual se calcula la densidad de probabilidad - - - - - a - - - El parámetro de forma de la distribución - - - - - b - - - El parámetro de escala de la distribución - - - - - - - - - &reftitle.returnvalues; - - La densidad de probabilidad en x o &false; en caso de error. - - - - - - diff --git a/reference/stats/functions/stats-harmonic-mean.xml b/reference/stats/functions/stats-harmonic-mean.xml deleted file mode 100644 index 0e5aaf86fc..0000000000 --- a/reference/stats/functions/stats-harmonic-mean.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - stats_harmonic_mean - Devuelve la media armónica de un array de valores - - - &reftitle.description; - - numberstats_harmonic_mean - arraya - - - Devuelve la media armónica de los valores de a. - - - - &reftitle.parameters; - - - - a - - - El array de entrada - - - - - - - - - &reftitle.returnvalues; - - Devuelve la media armónica de los valores de a, - o &false; si a está vacío o no es un array. - - - - - - diff --git a/reference/stats/functions/stats-kurtosis.xml b/reference/stats/functions/stats-kurtosis.xml deleted file mode 100644 index 9212150f10..0000000000 --- a/reference/stats/functions/stats-kurtosis.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - stats_kurtosis - Calcula el kurtosis de los datos en el array - - - &reftitle.description; - - floatstats_kurtosis - arraya - - - Devuelve el kurtosis de los valores en a. - - - - &reftitle.parameters; - - - - a - - - El array de entrada - - - - - - - - - &reftitle.returnvalues; - - Devuelve el kurtosis de los valores en a, - o &false; si a está vacío o no es un array. - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-beta.xml b/reference/stats/functions/stats-rand-gen-beta.xml deleted file mode 100644 index cd6465ca57..0000000000 --- a/reference/stats/functions/stats-rand-gen-beta.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - stats_rand_gen_beta - Genera una desviación aleatoria de la distribución beta - - - &reftitle.description; - - floatstats_rand_gen_beta - floata - floatb - - - Devuelve una desviación aleatoria de la distribución beta con los parámetros A y - B. La densidad de la beta es x^(a-1) * (1-x)^(b-1) / B(a, b) para 0 < x - <. Método R. C. H. Cheng. - - - - - &reftitle.parameters; - - - - a - - - El parámetro de forma de la distribución beta - - - - - b - - - El parámetro de forma de la distribución beta - - - - - - - - - &reftitle.returnvalues; - - Una desviación aleatoria - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-chisquare.xml b/reference/stats/functions/stats-rand-gen-chisquare.xml deleted file mode 100644 index dc86aa4f5d..0000000000 --- a/reference/stats/functions/stats-rand-gen-chisquare.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - stats_rand_gen_chisquare - Genera una desviación aleatoria de la distribución chi-cuadrado - - - &reftitle.description; - - floatstats_rand_gen_chisquare - floatdf - - - Devuelve una desviación aleatoria de la distribución chi-cuadrado donde los grados de - libertad son df. - - - - &reftitle.parameters; - - - - df - - - Los grados de libertad - - - - - - - - - &reftitle.returnvalues; - - Una desviación aleatoria - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-exponential.xml b/reference/stats/functions/stats-rand-gen-exponential.xml deleted file mode 100644 index 6e027d8d0f..0000000000 --- a/reference/stats/functions/stats-rand-gen-exponential.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - stats_rand_gen_exponential - Genera una desviación aleatoria de la distribución exponencial - - - &reftitle.description; - - floatstats_rand_gen_exponential - floatav - - - Devuelve una desviación aleatoria de la distribución exponencial cuya escala es - av. - - - - &reftitle.parameters; - - - - av - - - El parámetro de escala - - - - - - - - - &reftitle.returnvalues; - - Una desviación aleatoria - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-f.xml b/reference/stats/functions/stats-rand-gen-f.xml deleted file mode 100644 index df12c4c554..0000000000 --- a/reference/stats/functions/stats-rand-gen-f.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - stats_rand_gen_f - Genera una desviación aleatoria de la distribución F - - - &reftitle.description; - - floatstats_rand_gen_f - floatdfn - floatdfd - - - Genera una desviación aleatoria de la distribución F (ratio de varianza) con - "dfn" grados de libertad en el numerador y "dfd" grados de libertad en - el denominador. Método: genera directamente el ratio de variables chi-cuadrado. - - - - &reftitle.parameters; - - - - dfn - - - El grado de libertad en el numerador - - - - - dfd - - - El grado de libertad en el denominador - - - - - - - - - &reftitle.returnvalues; - - Una desviación aleatoria - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-funiform.xml b/reference/stats/functions/stats-rand-gen-funiform.xml deleted file mode 100644 index ff572016d2..0000000000 --- a/reference/stats/functions/stats-rand-gen-funiform.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - stats_rand_gen_funiform - Genera un flotante uniforme entre low (exclusivo) y high (exclusivo) - - - &reftitle.description; - - floatstats_rand_gen_funiform - floatlow - floathigh - - - Devuelve una desviación aleatoria de la distribución uniforme entre - low y high. - - - - &reftitle.parameters; - - - - low - - - El umbral inferior (exclusivo) - - - - - high - - - El umbral superior (exclusivo) - - - - - - - - - &reftitle.returnvalues; - - Una desviación aleatoria - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-gamma.xml b/reference/stats/functions/stats-rand-gen-gamma.xml deleted file mode 100644 index 1fcef5d749..0000000000 --- a/reference/stats/functions/stats-rand-gen-gamma.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - stats_rand_gen_gamma - Genera una desviación aleatoria de la distribución gamma - - - &reftitle.description; - - floatstats_rand_gen_gamma - floata - floatr - - - Genera una desviación aleatoria de la distribución gamma cuya densidad es - (A**R)/Gamma(R) * X**(R-1) * Exp(-A*X). - - - - - &reftitle.parameters; - - - - a - - - El parámetro de localización de la distribución gamma (a - > 0). - - - - - r - - - El parámetro de forma de la distribución gamma (r > - 0). - - - - - - - - &reftitle.returnvalues; - - Una desviación aleatoria - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-ibinomial-negative.xml b/reference/stats/functions/stats-rand-gen-ibinomial-negative.xml deleted file mode 100644 index 53f25ab7e5..0000000000 --- a/reference/stats/functions/stats-rand-gen-ibinomial-negative.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - stats_rand_gen_ibinomial_negative - Genera una desviación aleatoria de la distribución binomial negativa - - - &reftitle.description; - - intstats_rand_gen_ibinomial_negative - intn - floatp - - - Devuelve una desviación aleatoria de la distribución binomial negativa donde el número de éxitos es - n y la tasa de éxito es p. - - - - &reftitle.parameters; - - - - n - - - El número de éxitos. - - - - - p - - - La tasa de éxito. - - - - - - - - - &reftitle.returnvalues; - - Una desviación aleatoria, que es el número de fracasos. - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-ibinomial.xml b/reference/stats/functions/stats-rand-gen-ibinomial.xml deleted file mode 100644 index b6d6576e67..0000000000 --- a/reference/stats/functions/stats-rand-gen-ibinomial.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - stats_rand_gen_ibinomial - Genera una desviación aleatoria de la distribución binomial - - - &reftitle.description; - - intstats_rand_gen_ibinomial - intn - floatpp - - - Devuelve una desviación aleatoria de la distribución binomial donde el número de ensayos es n - y la probabilidad de evento en cada ensayo es pp. - - - - &reftitle.parameters; - - - - n - - - El número de ensayos - - - - - pp - - - La probabilidad de un evento en cada ensayo - - - - - - - - - &reftitle.returnvalues; - - Una desviación aleatoria - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-int.xml b/reference/stats/functions/stats-rand-gen-int.xml deleted file mode 100644 index 4edc4ee202..0000000000 --- a/reference/stats/functions/stats-rand-gen-int.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - stats_rand_gen_int - Genera un integer aleatorio entre 1 y 2147483562 - - - &reftitle.description; - - intstats_rand_gen_int - - - - Devuelve un integer aleatorio entre 1 y 2147483562 - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un integer aleatorio - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-ipoisson.xml b/reference/stats/functions/stats-rand-gen-ipoisson.xml deleted file mode 100644 index b57750e0d8..0000000000 --- a/reference/stats/functions/stats-rand-gen-ipoisson.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - stats_rand_gen_ipoisson - Genera una sola desviación aleatoria de la distribución de Poisson - - - &reftitle.description; - - intstats_rand_gen_ipoisson - floatmu - - - Devuelve una desviación aleatoria de la distribución de Poisson con el argumento mu. - - - - &reftitle.parameters; - - - - mu - - - El argumento de la distribución de Poisson - - - - - - - - - &reftitle.returnvalues; - - Una desviación aleatoria - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-iuniform.xml b/reference/stats/functions/stats-rand-gen-iuniform.xml deleted file mode 100644 index fdea665d56..0000000000 --- a/reference/stats/functions/stats-rand-gen-iuniform.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - stats_rand_gen_iuniform - Devuelve un integer aleatorio uniformemente distribuido entre LOW (incluido) y HIGH (incluido) - - - &reftitle.description; - - intstats_rand_gen_iuniform - intlow - inthigh - - - Devuelve un integer aleatorio uniformemente distribuido entre low (incluido) y - high (incluido). - - - - &reftitle.parameters; - - - - low - - - El umbral inferior - - - - - high - - - El umbral superior - - - - - - - - - &reftitle.returnvalues; - - Un integer aleatorio - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-noncentral-chisquare.xml b/reference/stats/functions/stats-rand-gen-noncentral-chisquare.xml deleted file mode 100644 index 5f1654d831..0000000000 --- a/reference/stats/functions/stats-rand-gen-noncentral-chisquare.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - stats_rand_gen_noncentral_chisquare - Genera una desviación aleatoria de la distribución chi-cuadrado no central - - - - &reftitle.description; - - floatstats_rand_gen_noncentral_chisquare - floatdf - floatxnonc - - - Devuelve una desviación aleatoria de la distribución chi-cuadrado no central con los grados de libertad, - df, y el parámetro de no centralidad, xnonc. - - - - - &reftitle.parameters; - - - - df - - - Los grados de libertad - - - - - xnonc - - - El parámetro de no centralidad - - - - - - - - - &reftitle.returnvalues; - - Un valor aleatorio - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-noncentral-f.xml b/reference/stats/functions/stats-rand-gen-noncentral-f.xml deleted file mode 100644 index 44adfd5cf5..0000000000 --- a/reference/stats/functions/stats-rand-gen-noncentral-f.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - stats_rand_gen_noncentral_f - Genera una desviación aleatoria de la distribución F no central - - - &reftitle.description; - - floatstats_rand_gen_noncentral_f - floatdfn - floatdfd - floatxnonc - - - Devuelve una desviación aleatoria de la distribución F no central con los grados de libertad, - dfn (numerador) y dfd (denominador), y el parámetro de no centralidad, - xnonc. - - - - &reftitle.parameters; - - - - dfn - - - Los grados de libertad del numerador - - - - - dfd - - - Los grados de libertad del denominador - - - - - xnonc - - - El parámetro de no centralidad - - - - - - - - - &reftitle.returnvalues; - - Una desviación aleatoria - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-noncentral-t.xml b/reference/stats/functions/stats-rand-gen-noncentral-t.xml deleted file mode 100644 index c3678dc4cf..0000000000 --- a/reference/stats/functions/stats-rand-gen-noncentral-t.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - stats_rand_gen_noncentral_t - Genera una única desviación aleatoria de la distribución t no central - - - &reftitle.description; - - floatstats_rand_gen_noncentral_t - floatdf - floatxnonc - - - Devuelve una desviación aleatoria de la distribución t no central con los grados de libertad, - df, y el parámetro de no centralidad, xnonc. - - - - &reftitle.parameters; - - - - df - - - Los grados de libertad - - - - - xnonc - - - El parámetro de no centralidad - - - - - - - - - &reftitle.returnvalues; - - Una desviación aleatoria - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-normal.xml b/reference/stats/functions/stats-rand-gen-normal.xml deleted file mode 100644 index 8c7542a3da..0000000000 --- a/reference/stats/functions/stats-rand-gen-normal.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - stats_rand_gen_normal - Genera una desviación aleatoria de la distribución normal - - - &reftitle.description; - - floatstats_rand_gen_normal - floatav - floatsd - - - Devuelve una desviación aleatoria de la distribución normal con la media, av, y la desviación estándar, - sd. - - - - &reftitle.parameters; - - - - av - - - La media de la distribución normal - - - - - sd - - - La desviación estándar de la distribución normal - - - - - - - - - &reftitle.returnvalues; - - Una desviación aleatoria - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-t.xml b/reference/stats/functions/stats-rand-gen-t.xml deleted file mode 100644 index aa8794137d..0000000000 --- a/reference/stats/functions/stats-rand-gen-t.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - stats_rand_gen_t - Genera una sola desviación aleatoria de la distribución t - - - &reftitle.description; - - floatstats_rand_gen_t - floatdf - - - Devuelve una desviación aleatoria de la distribución t con los grados de libertad, df. - - - - &reftitle.parameters; - - - - df - - - Los grados de libertad - - - - - - - - - &reftitle.returnvalues; - - Una desviación aleatoria - - - - - - diff --git a/reference/stats/functions/stats-rand-get-seeds.xml b/reference/stats/functions/stats-rand-get-seeds.xml deleted file mode 100644 index 6c4c389320..0000000000 --- a/reference/stats/functions/stats-rand-get-seeds.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - stats_rand_get_seeds - Devuelve los valores de la semilla del generador de números aleatorios - - - &reftitle.description; - - arraystats_rand_get_seeds - - - - Devuelve las semillas actuales del generador de números aleatorios - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un array de dos enteros. - - - - - - diff --git a/reference/stats/functions/stats-rand-phrase-to-seeds.xml b/reference/stats/functions/stats-rand-phrase-to-seeds.xml deleted file mode 100644 index 5c16b2af19..0000000000 --- a/reference/stats/functions/stats-rand-phrase-to-seeds.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - stats_rand_phrase_to_seeds - Genera dos semillas para el generador de números aleatorios RGN - - - &reftitle.description; - - arraystats_rand_phrase_to_seeds - stringphrase - - - Genera dos semillas para el generador de números aleatorios a partir de una phrase. - - - - &reftitle.parameters; - - - - phrase - - - La frase de entrada - - - - - - - - - &reftitle.returnvalues; - - Devuelve un array de dos enteros. - - - - - - diff --git a/reference/stats/functions/stats-rand-ranf.xml b/reference/stats/functions/stats-rand-ranf.xml deleted file mode 100644 index 4eeeb2df3c..0000000000 --- a/reference/stats/functions/stats-rand-ranf.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - stats_rand_ranf - Genera un número flotante aleatorio entre 0 y 1 - - - &reftitle.description; - - floatstats_rand_ranf - - - - Devuelve un número flotante aleatorio de una distribución uniforme entre 0 (exclusivo) y 1 (exclusivo). - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un número flotante aleatorio - - - - - - diff --git a/reference/stats/functions/stats-rand-setall.xml b/reference/stats/functions/stats-rand-setall.xml deleted file mode 100644 index 3b0615a529..0000000000 --- a/reference/stats/functions/stats-rand-setall.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - stats_rand_setall - Define los valores de la semilla para el generador aleatorio - - - &reftitle.description; - - voidstats_rand_setall - intiseed1 - intiseed2 - - - Define iseed1 y iseed2 como valores de la semilla para el generador aleatorio - utilizado en las funciones estadísticas. - - - - &reftitle.parameters; - - - - iseed1 - - - El valor utilizado como semilla aleatoria - - - - - iseed2 - - - El valor utilizado como semilla aleatoria - - - - - - - - - &reftitle.returnvalues; - - No se devuelve ningún valor. - - - - - - diff --git a/reference/stats/functions/stats-skew.xml b/reference/stats/functions/stats-skew.xml deleted file mode 100644 index 691975fa7a..0000000000 --- a/reference/stats/functions/stats-skew.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - stats_skew - Calcula la asimetría de los datos en una tabla - - - &reftitle.description; - - floatstats_skew - arraya - - - Devuelve la asimetría de los valores en a. - - - - &reftitle.parameters; - - - - a - - - El array de entradas - - - - - - - - - &reftitle.returnvalues; - - Devuelve la asimetría de los valores en a, - o &false; si a está vacío o no es un array. - - - - - - diff --git a/reference/stats/functions/stats-standard-deviation.xml b/reference/stats/functions/stats-standard-deviation.xml deleted file mode 100644 index f5233bfe37..0000000000 --- a/reference/stats/functions/stats-standard-deviation.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - stats_standard_deviation - Devuelve la desviación estándar - - - &reftitle.description; - - floatstats_standard_deviation - arraya - boolsample&false; - - - Devuelve la desviación estándar de los valores en a. - - - - &reftitle.parameters; - - - - a - - - El array de datos para el cual se calcula la desviación estándar. Es de notar que todos - los valores del array serán convertidos en float. - - - - - sample - - - Indica si a representa una muestra de la - población; por omisión es &false;. - - - - - - - - - &reftitle.returnvalues; - - Devuelve la desviación estándar en caso de éxito; &false; en caso de fallo. - - - - - &reftitle.errors; - - Lanza una E_WARNING cuando hay menos de 2 - valores en a. - - - - - - diff --git a/reference/stats/functions/stats-stat-binomial-coef.xml b/reference/stats/functions/stats-stat-binomial-coef.xml deleted file mode 100644 index 833e58b285..0000000000 --- a/reference/stats/functions/stats-stat-binomial-coef.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - stats_stat_binomial_coef - Devuelve un coeficiente binomial - - - &reftitle.description; - - floatstats_stat_binomial_coef - intx - intn - - - Devuelve el coeficiente binomial de n elegido x. - - - - &reftitle.parameters; - - - - x - - - El número de elecciones en el conjunto - - - - - n - - - El número de elementos en el conjunto - - - - - - - - - &reftitle.returnvalues; - - Devuelve el coeficiente binomial - - - - - - diff --git a/reference/stats/functions/stats-stat-correlation.xml b/reference/stats/functions/stats-stat-correlation.xml deleted file mode 100644 index 72f0621a5c..0000000000 --- a/reference/stats/functions/stats-stat-correlation.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - stats_stat_correlation - Devuelve el coeficiente de correlación de Pearson de dos conjuntos de datos - - - &reftitle.description; - - floatstats_stat_correlation - arrayarr1 - arrayarr2 - - - Devuelve el coeficiente de correlación de Pearson entre arr1 y arr2. - - - - &reftitle.parameters; - - - - arr1 - - - El primer array - - - - - arr2 - - - El segundo array - - - - - - - - - &reftitle.returnvalues; - - Devuelve el coeficiente de correlación de Pearson entre arr1 y arr2, - o &false; en caso de fallo. - - - - - - diff --git a/reference/stats/functions/stats-stat-factorial.xml b/reference/stats/functions/stats-stat-factorial.xml deleted file mode 100644 index c8fe2a7578..0000000000 --- a/reference/stats/functions/stats-stat-factorial.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - stats_stat_factorial - Devuelve el factorial de un entero - - - - &reftitle.description; - - floatstats_stat_factorial - intn - - - Devuelve el factorial de un entero, n. - - - - - &reftitle.parameters; - - - n - - - Un entero - - - - - - - - &reftitle.returnvalues; - - El factorial de n. - - - - - - diff --git a/reference/stats/functions/stats-stat-independent-t.xml b/reference/stats/functions/stats-stat-independent-t.xml deleted file mode 100644 index b86adb50af..0000000000 --- a/reference/stats/functions/stats-stat-independent-t.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - stats_stat_independent_t - Devuelve el valor t de la prueba t para dos muestras independientes - - - &reftitle.description; - - floatstats_stat_independent_t - arrayarr1 - arrayarr2 - - - Devuelve el valor t de la prueba t para dos muestras independientes entre - arr1 y arr2. - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - arr1 - - - El primer conjunto de valores - - - - - arr2 - - - El segundo conjunto de valores - - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor t, o &false; en caso de fallo. - - - - - - diff --git a/reference/stats/functions/stats-stat-innerproduct.xml b/reference/stats/functions/stats-stat-innerproduct.xml deleted file mode 100644 index 07c6a94667..0000000000 --- a/reference/stats/functions/stats-stat-innerproduct.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - stats_stat_innerproduct - Devuelve el producto interno de dos vectores - - - &reftitle.description; - - floatstats_stat_innerproduct - arrayarr1 - arrayarr2 - - - Devuelve el producto interno de arr1 y arr2. - - - - &reftitle.parameters; - - - - arr1 - - - El primer array - - - - - arr2 - - - El segundo array - - - - - - - - - &reftitle.returnvalues; - - Devuelve el producto interno de arr1 y arr2, - o &false; en caso de error. - - - - - - diff --git a/reference/stats/functions/stats-stat-paired-t.xml b/reference/stats/functions/stats-stat-paired-t.xml deleted file mode 100644 index 9664459011..0000000000 --- a/reference/stats/functions/stats-stat-paired-t.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - stats_stat_paired_t - Devuelve el valor t de la prueba t dependiente de dos muestras emparejadas - - - &reftitle.description; - - floatstats_stat_paired_t - arrayarr1 - arrayarr2 - - - Devuelve el valor t de la prueba t dependiente de dos muestras emparejadas para las muestras - arr1 y arr2. - - - - &reftitle.parameters; - - - - arr1 - - - La primera muestra - - - - - arr2 - - - La segunda muestra - - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor t, o &false; en caso de fallo. - - - - - - diff --git a/reference/stats/functions/stats-stat-percentile.xml b/reference/stats/functions/stats-stat-percentile.xml deleted file mode 100644 index dd936f4d23..0000000000 --- a/reference/stats/functions/stats-stat-percentile.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - stats_stat_percentile - Devuelve el valor del percentil - - - &reftitle.description; - - floatstats_stat_percentile - arrayarr - floatperc - - - Devuelve el valor del perc-ésimo percentil del conjunto de datos arr. - - - - &reftitle.parameters; - - - - arr - - - El array de entrada - - - - - perc - - - El percentil - - - - - - - - - &reftitle.returnvalues; - - Devuelve el percentil del conjunto de datos. - - - - - - diff --git a/reference/stats/functions/stats-stat-powersum.xml b/reference/stats/functions/stats-stat-powersum.xml deleted file mode 100644 index 8447a8ab5c..0000000000 --- a/reference/stats/functions/stats-stat-powersum.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - stats_stat_powersum - Devuelve la suma de las potencias de un vector - - - &reftitle.description; - - floatstats_stat_powersum - arrayarr - floatpower - - - Devuelve la suma de la power-ésima potencia de un vector representado como un array arr. - - - - &reftitle.parameters; - - - - arr - - - El array de entrada - - - - - power - - - La potencia - - - - - - - - - &reftitle.returnvalues; - - Devuelve la suma de las potencias del conjunto de datos. - - - - - - diff --git a/reference/stats/functions/stats-variance.xml b/reference/stats/functions/stats-variance.xml deleted file mode 100644 index 3735d8b8b0..0000000000 --- a/reference/stats/functions/stats-variance.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - stats_variance - Devuelve la varianza - - - &reftitle.description; - - floatstats_variance - arraya - boolsample&false; - - - Devuelve la varianza de los valores en a. - - - - &reftitle.parameters; - - - - a - - - El array de datos para el cual se calcula la varianza. Se debe tener en cuenta que todos - los valores del array serán convertidos en float. - - - - - sample - - - Indica si a representa una muestra de la - población; por omisión es &false;. - - - - - - - - - &reftitle.returnvalues; - - Devuelve la varianza en caso de éxito; &false; en caso de fallo. - - - - - - diff --git a/reference/stats/reference.xml b/reference/stats/reference.xml deleted file mode 100644 index 3d2c5cec45..0000000000 --- a/reference/stats/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - &Functions; estadísticas - - &reference.stats.entities.functions; - - - - diff --git a/reference/stats/setup.xml b/reference/stats/setup.xml deleted file mode 100644 index 2cf92a5f63..0000000000 --- a/reference/stats/setup.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - No se requiere ninguna biblioteca externa. La extensión se entrega con las bibliotecas utilizadas. - -
    - - - -
    - &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 deleted file mode 100644 index 97802437cd..0000000000 --- a/reference/stomp/book.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - Cliente Stomp - Stomp - - - &reftitle.intro; - - Esta extensión permite a aplicaciones php comunicarse con cualquier Message Brokers compatible con el protocolo STOMP, - a través de sencillas interfaces procedurales orientadas a objetos. - Sitio oficial de Stomp - - - - &reference.stomp.setup; - &reference.stomp.examples; - &reference.stomp.reference; - &reference.stomp.stomp; - &reference.stomp.stompframe; - &reference.stomp.stompexception; - - diff --git a/reference/stomp/examples.xml b/reference/stomp/examples.xml deleted file mode 100644 index cda15dcf7c..0000000000 --- a/reference/stomp/examples.xml +++ /dev/null @@ -1,164 +0,0 @@ - - - - - - &reftitle.examples; - - - &style.oop; - -getMessage()); -} - -/* Enviar un mensaje a la cola 'foo' */ -$stomp->send($queue, $msg); - -/* suscribirse a mensajes de la cola 'foo' */ -$stomp->subscribe($queue); - -/* leer una trama (frame) */ -$frame = $stomp->readFrame(); - -if ($frame->body === $msg) { - var_dump($frame); - - /* reconocer que la trama (frame) fue recibida */ - $stomp->ack($frame); -} - -/* cerrar conexión */ -unset($stomp); - -?> -]]> - - &example.outputs.similar; - - - string(7) "MESSAGE" - ["headers"]=> - array(5) { - ["message-id"]=> - string(41) "ID:php.net-55293-1257226743606-4:2:-1:1:1" - ["destination"]=> - string(10) "/queue/foo" - ["timestamp"]=> - string(13) "1257226805828" - ["expires"]=> - string(1) "0" - ["priority"]=> - string(1) "0" - } - ["body"]=> - string(3) "bar" -} -]]> - - - - &style.procedural; - - 't1')); - -/* confirmar una transacción */ -stomp_commit($link, 't1'); - -/* suscribirse a mensajes de la cola 'foo' */ -stomp_subscribe($link, $queue); - -/* leer una trama (frame) */ -$frame = stomp_read_frame($link); - -if ($frame['body'] === $msg) { - var_dump($frame); - - /* reconocer que la trama fue recibida */ - stomp_ack($link, $frame['headers']['message-id']); -} - -/* cerrar conexión */ -stomp_close($link); - -?> -]]> - - &example.outputs.similar; - - - string(7) "MESSAGE" - ["body"]=> - string(3) "bar" - ["headers"]=> - array(6) { - ["transaction"]=> - string(2) "t1" - ["message-id"]=> - string(41) "ID:php.net-55293-1257226743606-4:3:-1:1:1" - ["destination"]=> - string(10) "/queue/foo" - ["timestamp"]=> - string(13) "1257227037059" - ["expires"]=> - string(1) "0" - ["priority"]=> - string(1) "0" - } -} -]]> - - - - - diff --git a/reference/stomp/functions/stomp-connect-error.xml b/reference/stomp/functions/stomp-connect-error.xml deleted file mode 100644 index d2810bd644..0000000000 --- a/reference/stomp/functions/stomp-connect-error.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - stomp_connect_error - Devuelve una cadena descripción de el último error al conectar - - - - &reftitle.description; - - stringstomp_connect_error - - - - Devuelve una cadena descripción de el último error al conectar. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Una cadena que describe el error, o &null; si no hay errores. - - - - - &reftitle.examples; - - Ejemplo de <function>stomp_connect_error</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/stomp/functions/stomp-version.xml b/reference/stomp/functions/stomp-version.xml deleted file mode 100644 index 61206567b8..0000000000 --- a/reference/stomp/functions/stomp-version.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - stomp_version - Obtiene la versión actual de la extensión stomp - - - - &reftitle.description; - - stringstomp_version - - - - Devuelve una cadena que contiene la versión actual de la extensión stomp. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Esta devuelve la versión actual de la extensión stomp - - - - - &reftitle.examples; - - Ejemplo de <function>stomp_version</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/stomp/ini.xml b/reference/stomp/ini.xml deleted file mode 100644 index db16195873..0000000000 --- a/reference/stomp/ini.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - &ConfigureOptions; Stomp - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - stomp.default_broker - tcp://localhost:61613 - INI_ALL - - - - stomp.default_connection_timeout_sec - 2 - INI_ALL - - - - stomp.default_connection_timeout_usec - 0 - INI_ALL - - - - - stomp.default_read_timeout_sec - 2 - INI_ALL - - - - stomp.default_read_timeout_usec - 0 - INI_ALL - - - - -
    - - &ini.descriptions.title; - - - - - stomp.default_broker - string - - - - La URI broker por defecto a utilizar cuando conectemos a el message broker si otra URI no es especificada. - - - - - - stomp.default_connection_timeout_sec - int - - - - Los segundos parte del tiempo de espera de la solicitud de conexión por defecto. - - - - - - stomp.default_connection_timeout_usec - int - - - - Los microsegundos parte del tiempo de espera de la solicitud de conexión por defecto. - - - - - - stomp.default_read_timeout_sec - int - - - - Los segundos parte del tiempo de espera de lectura por defecto. - - - - - - stomp.default_read_timeout_usec - int - - - - Los microsegundos parte del tiempo de espera de lectura por defecto. - - - - -
    diff --git a/reference/stomp/reference.xml b/reference/stomp/reference.xml deleted file mode 100644 index 96d40eda90..0000000000 --- a/reference/stomp/reference.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - - - - - &Functions; Stomp - - &reference.stomp.entities.functions; - - - - - diff --git a/reference/stomp/setup.xml b/reference/stomp/setup.xml deleted file mode 100644 index 2f2c5eaac6..0000000000 --- a/reference/stomp/setup.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - &reftitle.setup; - -
    - &reftitle.required; - El paquete OpenSSL >= 0.9.6 y la extensión openssl pueden ser también requeridos para utilizar stomp a través de SSL. -
    - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;stomp - -
    - - - &reference.stomp.ini; - - - -
    - &reftitle.resources; - - Sólo hay un tipo de recurso utilizado en la extensión stomp - este es - el identificador de enlace para una conexión stomp. - -
    - - -
    - diff --git a/reference/stomp/stomp.xml b/reference/stomp/stomp.xml deleted file mode 100644 index 2e1f6a0a4c..0000000000 --- a/reference/stomp/stomp.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - La clase Stomp - Stomp - - - - -
    - &reftitle.intro; - -Representa una conexión entre PHP y un Message Brokers que cumpla con las normas del protocolo Stomp. - -
    - - -
    - &reftitle.classsynopsis; - - - - Stomp - - - - - Stomp - - - - - &Methods; - - - - - - -
    - -
    - - &reference.stomp.entities.stomp; - -
    - diff --git a/reference/stomp/stomp/abort.xml b/reference/stomp/stomp/abort.xml deleted file mode 100644 index c9c990a7a0..0000000000 --- a/reference/stomp/stomp/abort.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - Stomp::abort - stomp_abort - Deshacer una transacción en curso - - - - &reftitle.description; - &style.oop; (método): - - public boolStomp::abort - stringtransaction_id - arrayheaders - - &style.procedural;: - - boolstomp_abort - resourcelink - stringtransaction_id - arrayheaders - - - Deshacer una transacción en curso. - - - - - &reftitle.parameters; - - &stomp.param.link; - - transaction_id - - - La transacción a abortar. - - - - &stomp.param.headers; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - &style.oop; - -getMessage()); -} - -/* iniciar una transacción */ -$stomp->begin('t1'); - -/* enviar un mensaje a la cola */ -$stomp->send('/queue/foo', 'bar', array('transaction' => 't1')); - -/* deshacer/abortar */ -$stomp->abort('t1'); - -/* cerrar la conexión */ -unset($stomp); -?> -]]> - - - - &style.procedural; - - 't1')); - -/* deshacer/abortar */ -stomp_abort($link, 't1'); - -/* cerrar la conexión */ -stomp_close($link); - -?> -]]> - - - - - - &reftitle.notes; - &stomp.note.sync; - - - - diff --git a/reference/stomp/stomp/ack.xml b/reference/stomp/stomp/ack.xml deleted file mode 100644 index d319735d06..0000000000 --- a/reference/stomp/stomp/ack.xml +++ /dev/null @@ -1,171 +0,0 @@ - - - - - - Stomp::ack - stomp_ack - Confirmar la recepción y el consumo de un mensaje - - - - &reftitle.description; - &style.oop; (método): - - public boolStomp::ack - mixedmsg - arrayheaders - - &style.procedural;: - - boolstomp_ack - resourcelink - mixedmsg - arrayheaders - - - Confirmar el consumo de un mensaje desde una suscripción enviando el cliente una trama ACK de confirmación. - - - - - &reftitle.parameters; - - &stomp.param.link; - - msg - - - El mensaje/Id del mensaje a ser confirmado. - - - - &stomp.param.headers; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - &style.oop; - -getMessage()); -} - -/* enviar un mensaje a la cola 'foo' */ -$stomp->send($queue, $msg); - -/* suscribirse a mensajes de la cola 'foo' */ -$stomp->subscribe($queue); - -/* leer una trama */ -$frame = $stomp->readFrame(); - -if ($frame->body === $msg) { - /* confirmar que la trama fue recibida */ - $stomp->ack($frame); -} - -/* eliminar la suscripción */ -$stomp->unsubscribe($queue); - -/* cerrar la conexión */ -unset($stomp); - -?> -]]> - - - - &style.procedural; - - 't1')); - -/* validar una transacción */ -stomp_commit($link, 't1'); - -/* suscribirse a mensajes de la cola 'foo' */ -stomp_subscribe($link, $queue); - -/* leer una trama */ -$frame = stomp_read_frame($link); - -if ($frame['body'] === $msg) { - /* confirmar que la trama fue recibida */ - stomp_ack($link, $frame['headers']['message-id']); -} - -/* eliminar la suscripción */ -stomp_unsubscribe($link, $queue); - -/* cerrar la conexión */ -stomp_close($link); - -?> -]]> - - - - - - &reftitle.notes; - &stomp.note.transaction; - &stomp.note.sync; - - - - diff --git a/reference/stomp/stomp/begin.xml b/reference/stomp/stomp/begin.xml deleted file mode 100644 index 0eb374be2b..0000000000 --- a/reference/stomp/stomp/begin.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Stomp::begin - stomp_begin - Iniciar una transacción - - - - &reftitle.description; - &style.oop; (método): - - public boolStomp::begin - stringtransaction_id - arrayheaders - - &style.procedural;: - - boolstomp_begin - resourcelink - stringtransaction_id - arrayheaders - - - Inicia una transacción. - - - - - &reftitle.parameters; - - &stomp.param.link; - - transaction_id - - - La identificación de la transacción. - - - - &stomp.param.headers; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Vea stomp_commit o stomp_abort. - - - - - &reftitle.notes; - &stomp.note.sync; - - - - diff --git a/reference/stomp/stomp/commit.xml b/reference/stomp/stomp/commit.xml deleted file mode 100644 index fe24334aac..0000000000 --- a/reference/stomp/stomp/commit.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - Stomp::commit - stomp_commit - Validar una transacción en curso - - - - &reftitle.description; - &style.oop; (método): - - public boolStomp::commit - stringtransaction_id - arrayheaders - - &style.procedural;: - - boolstomp_commit - resourcelink - stringtransaction_id - arrayheaders - - - Valida una transacción en curso. - - - - - &reftitle.parameters; - - &stomp.param.link; - - transaction_id - - - La identificación de la transacción. - - - - &stomp.param.headers; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - &style.oop; - -getMessage()); -} - -/* iniciar una transacción */ -$stomp->begin('t1'); - -/* enviar un mensaje a la cola */ -$stomp->send('/queue/foo', 'bar', array('transaction' => 't1')); - -/* validar */ -$stomp->commit('t1'); - -/* cerrar la conexión */ -unset($stomp); - -?> -]]> - - - - &style.procedural; - - 't1')); - -/* validar */ -stomp_commit($link, 't1'); - -/* cerrar la conexión */ -stomp_close($link); - -?> -]]> - - - - - - &reftitle.notes; - &stomp.note.sync; - - - - diff --git a/reference/stomp/stomp/construct.xml b/reference/stomp/stomp/construct.xml deleted file mode 100644 index 27c597d773..0000000000 --- a/reference/stomp/stomp/construct.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - - Stomp::__construct - stomp_connect - Abre una conexión - - - - &reftitle.description; - &style.oop; (constructor): - - public Stomp::__construct - stringbrokerini_get("stomp.default_broker_uri") - stringusername - stringpassword - arrayheaders - - &style.procedural;: - - resourcestomp_connect - stringbrokerini_get("stomp.default_broker_uri") - stringusername - stringpassword - arrayheaders - - - Abre una conexión con un Message Broker compatible con el protocolo STOMP. - - - - - &reftitle.parameters; - - - broker - - - La URI broker - - - - - username - - - El nombre de usuario. - - - - - password - - - La contraseña. - - - - &stomp.param.headers; - - - - - &reftitle.returnvalues; - &stomp.note.transaction; - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL stomp 1.0.1 - - El paramétro headers fue añadido - - - - - - - - - &reftitle.examples; - - &style.oop; - -getMessage()); -} - -/* cerrar la conexión */ -unset($stomp); - -?> -]]> - - - - &style.procedural; - - -]]> - - - - - - diff --git a/reference/stomp/stomp/destruct.xml b/reference/stomp/stomp/destruct.xml deleted file mode 100644 index e6a10dbd28..0000000000 --- a/reference/stomp/stomp/destruct.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - Stomp::__destruct - stomp_close - Cierra una conexión stomp - - - - &reftitle.description; - &style.oop; (destructor): - - public Stomp::__destruct - - - &style.procedural;: - - boolstomp_close - resourcelink - - - Cierra una conexión previamente abierta. - - - - - &reftitle.parameters; - - &stomp.param.link; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Vea stomp_connect. - - - - diff --git a/reference/stomp/stomp/error.xml b/reference/stomp/stomp/error.xml deleted file mode 100644 index 75c65596d1..0000000000 --- a/reference/stomp/stomp/error.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - Stomp::error - stomp_error - Obtiene el último error stomp - - - - &reftitle.description; - &style.oop; (método): - - public stringStomp::error - - - &style.procedural;: - - stringstomp_error - resourcelink - - - Obtiene el último error stomp. - - - - - &reftitle.parameters; - - &stomp.param.link; - - - - - &reftitle.returnvalues; - - Devuelve una cadena de error o &false; si no hay errores. - - - - - &reftitle.examples; - - &style.oop; - -getMessage()); -} - -var_dump($stomp->error()); - -if (!$stomp->abort('unknown-transaction', array('receipt' => 'foo'))) { - var_dump($stomp->error()); -} - -/* cerrar la conexión */ -unset($stomp); - -?> -]]> - - &example.outputs.similar; - - - - - - &style.procedural; - - 'foo'))) { - var_dump(stomp_error($link)); -} - -/* cerrar la conexión */ -stomp_close($link); - -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/stomp/stomp/getreadtimeout.xml b/reference/stomp/stomp/getreadtimeout.xml deleted file mode 100644 index b4c66cf510..0000000000 --- a/reference/stomp/stomp/getreadtimeout.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - - Stomp::getReadTimeout - stomp_get_read_timeout - Obtener la lectura del tiempo de espera de la solicitud - - - - &reftitle.description; - &style.oop; (método): - - public arrayStomp::getReadTimeout - - - &style.procedural;: - - arraystomp_get_read_timeout - resourcelink - - - Obtiene la lectura del tiempo de espera de la solicitud - - - - - &reftitle.parameters; - - &stomp.param.link; - - - - - &reftitle.returnvalues; - - Devuelve un array con dos elementos: sec y usec. - - - - - &reftitle.examples; - - &style.oop; - -getMessage()); -} - -var_dump($stomp->getReadTimeout()); - -/* cerrar la conexión */ -unset($stomp); - -?> -]]> - - &example.outputs.similar; - - - int(2) - ["usec"]=> - int(0) -} -]]> - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - int(2) - ["usec"]=> - int(0) -} -]]> - - - - - - - diff --git a/reference/stomp/stomp/getsessionid.xml b/reference/stomp/stomp/getsessionid.xml deleted file mode 100644 index 3ae93581a3..0000000000 --- a/reference/stomp/stomp/getsessionid.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - Stomp::getSessionId - stomp_get_session_id - Obtiene el identificador de sesión actual stomp - - - - &reftitle.description; - &style.oop; (método): - - public stringfalseStomp::getSessionId - - - &style.procedural;: - - stringfalsestomp_get_session_id - resourcelink - - - Obtiene el identificador de sesión actual stomp. - - - - - &reftitle.parameters; - - &stomp.param.link; - - - - - &reftitle.returnvalues; - - El identificador de sesión como &string; en caso de éxito&return.falseforfailure;. - - - - - &reftitle.examples; - - &style.oop; - -getMessage()); -} - -var_dump($stomp->getSessionId()); - -/* cerrar la conexión */ -unset($stomp); - -?> -]]> - - &example.outputs.similar; - - - - - - Estilo procedural - - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/stomp/stomp/hasframe.xml b/reference/stomp/stomp/hasframe.xml deleted file mode 100644 index e5f3151c72..0000000000 --- a/reference/stomp/stomp/hasframe.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - Stomp::hasFrame - stomp_has_frame - Indica si existe o no una trama lista para leer - - - - &reftitle.description; - &style.oop; (método): - - public boolStomp::hasFrame - - - &style.procedural;: - - boolstomp_has_frame - resourcelink - - - Indica si existe o no una trama lista para leer. - - - - - &reftitle.parameters; - - &stomp.param.link; - - - - - &reftitle.returnvalues; - - Devuelve &true; si hay una trama lista para leer, o &false; en caso contrario. - - - - - diff --git a/reference/stomp/stomp/readframe.xml b/reference/stomp/stomp/readframe.xml deleted file mode 100644 index f7b33ac410..0000000000 --- a/reference/stomp/stomp/readframe.xml +++ /dev/null @@ -1,198 +0,0 @@ - - - - - - - Stomp::readFrame - stomp_read_frame - Leer la siguiente trama - - - - &reftitle.description; - &style.oop; (método): - - public stompframeStomp::readFrame - stringclass_name"stompFrame" - - &style.procedural;: - - arraystomp_read_frame - resourcelink - - - Lee la siguiente trama. Es posible crear una instancia de un objeto de una clase específica, y pasar parámetros al constructor de esa clase. - - - - - &reftitle.parameters; - - &stomp.param.link; - - class_name - - - El nombre de la clase a instanciar. Si no se especifica, un objeto stompFrame es devuelto. - - - - - - - - &reftitle.returnvalues; - &stomp.note.transaction; - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL stomp 0.4.0 - - El parámentro class_name fue añadido. - - - - - - - - - &reftitle.examples; - - &style.oop; - -getMessage()); -} - -/* suscribirse a mensajes de la cola 'foo' */ -$stomp->subscribe('/queue/foo'); - -/* leer una trama */ -var_dump($stomp->readFrame()); - -/* cerrar la conexión */ -unset($stomp); - -?> -]]> - - &example.outputs.similar; - - - string(7) "MESSAGE" - ["headers"]=> - array(5) { - ["message-id"]=> - string(41) "ID:php.net-55293-1257226743606-4:2:-1:1:1" - ["destination"]=> - string(10) "/queue/foo" - ["timestamp"]=> - string(13) "1257226805828" - ["expires"]=> - string(1) "0" - ["priority"]=> - string(1) "0" - } - ["body"]=> - string(3) "bar" -} -]]> - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - string(7) "MESSAGE" - ["body"]=> - string(3) "bar" - ["headers"]=> - array(6) { - ["transaction"]=> - string(2) "t1" - ["message-id"]=> - string(41) "ID:php.net-55293-1257226743606-4:3:-1:1:1" - ["destination"]=> - string(10) "/queue/foo" - ["timestamp"]=> - string(13) "1257227037059" - ["expires"]=> - string(1) "0" - ["priority"]=> - string(1) "0" - } -} -]]> - - - - - - diff --git a/reference/stomp/stomp/send.xml b/reference/stomp/stomp/send.xml deleted file mode 100644 index 634318e959..0000000000 --- a/reference/stomp/stomp/send.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - Stomp::send - stomp_send - Envía un mensaje - - - - &reftitle.description; - &style.oop; (método): - - public boolStomp::send - stringdestination - mixedmsg - arrayheaders - - &style.procedural;: - - boolstomp_send - resourcelink - stringdestination - mixedmsg - arrayheaders - - - Envía un mensaje a el Message Broker. - - - - - &reftitle.parameters; - - &stomp.param.link; - - destination - - - A dónde eenviar el mensaje - - - - - msg - - - Mensaje a enviar. - - - - &stomp.param.headers; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Vea stomp_ack. - - - - - &reftitle.notes; - &stomp.note.transaction; - &stomp.note.sync; - - - - diff --git a/reference/stomp/stomp/setreadtimeout.xml b/reference/stomp/stomp/setreadtimeout.xml deleted file mode 100644 index 7a5f09c015..0000000000 --- a/reference/stomp/stomp/setreadtimeout.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - Stomp::setReadTimeout - stomp_set_read_timeout - Establecer el tiempo de espera de lectura - - - - &reftitle.description; - &style.oop; (método): - - public voidStomp::setReadTimeout - intseconds - intmicroseconds - - &style.procedural;: - - voidstomp_set_read_timeout - resourcelink - intseconds - intmicroseconds - - - Establece el tiempo de espera de lectura. - - - - - &reftitle.parameters; - - &stomp.param.link; - - seconds - - - Los segundos parte de el tiempo de espera a ser establecido. - - - - - microseconds - - - Los microsegundos parte de el tiempo de espera a ser establecido. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - &style.oop; - -getMessage()); -} - -$stomp->setReadTimeout(10); - -/* cerrar la conexión */ -unset($stomp); - -?> -]]> - - - - &style.procedural; - - -]]> - - - - - - diff --git a/reference/stomp/stomp/subscribe.xml b/reference/stomp/stomp/subscribe.xml deleted file mode 100644 index fc2760438a..0000000000 --- a/reference/stomp/stomp/subscribe.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Stomp::subscribe - stomp_subscribe - Registrarse para escuchar a un destino dado - - - - &reftitle.description; - &style.oop; (método): - - public boolStomp::subscribe - stringdestination - arrayheaders - - &style.procedural;: - - boolstomp_subscribe - resourcelink - stringdestination - arrayheaders - - - Registrarse para escuchar a un destino dado. - - - - - &reftitle.parameters; - - &stomp.param.link; - - destination - - - Destino al que suscribirse. - - - - &stomp.param.headers; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Vea stomp_ack. - - - - - &reftitle.notes; - &stomp.note.sync; - - - - diff --git a/reference/stomp/stomp/unsubscribe.xml b/reference/stomp/stomp/unsubscribe.xml deleted file mode 100644 index 3bce51c292..0000000000 --- a/reference/stomp/stomp/unsubscribe.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Stomp::unsubscribe - stomp_unsubscribe - Dar de baja una suscripción existente - - - - &reftitle.description; - &style.oop; (método): - - public boolStomp::unsubscribe - stringdestination - arrayheaders - - &style.procedural;: - - boolstomp_unsubscribe - resourcelink - stringdestination - arrayheaders - - - Dar de baja una suscripción existente. - - - - - &reftitle.parameters; - - &stomp.param.link; - - destination - - - Suscripción a eliminar - - - - &stomp.param.headers; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Vea stomp_ack. - - - - - &reftitle.notes; - &stomp.note.sync; - - - - diff --git a/reference/stomp/stompexception.xml b/reference/stomp/stompexception.xml deleted file mode 100644 index b48f92dc3a..0000000000 --- a/reference/stomp/stompexception.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - La clase StompException - StompException - - - - -
    - &reftitle.intro; - -Representa un error proveniente desde la extensión stomp. Vea Exceptions para obtener más información acerca de las excepciones en PHP. - -
    - - -
    - &reftitle.classsynopsis; - - - - StompException - - - - - StompException - - - - extends - Exception - - - - - &InheritedMethods; - - - &Methods; - - - - -
    -
    - - &reference.stomp.entities.stompexception; - -
    - diff --git a/reference/stomp/stompexception/getdetails.xml b/reference/stomp/stompexception/getdetails.xml deleted file mode 100644 index 016226116f..0000000000 --- a/reference/stomp/stompexception/getdetails.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - StompException::getDetails - Obtener detalles de la excepción - - - - &reftitle.description; - - public stringStompException::getDetails - - - - Obtener detalles de la excepción. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &string; que contiene los detalles del error. - - - - - diff --git a/reference/stomp/stompframe.xml b/reference/stomp/stompframe.xml deleted file mode 100644 index fbd9503744..0000000000 --- a/reference/stomp/stompframe.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - La clase StompFrame - StompFrame - - - - -
    - &reftitle.intro; - - Representa un mensaje el cual fue enviado o recibido desde un Message Brokers que cumple con las normas del protocolo Stomp. - -
    - - -
    - &reftitle.classsynopsis; - - - - StompFrame - - - - - StompFrame - - - - &Properties; - - public - command - - - public - headers - - - public - body - - - - &Methods; - - - - -
    - - - -
    - &reftitle.properties; - - - command - - Comando de la trama. - - - - headers - - Encabezados de la trama (&array;). - - - - body - - Cuerpo de la trama. - - - -
    - - - -
    - - &reference.stomp.entities.stompframe; - -
    - diff --git a/reference/stomp/stompframe/construct.xml b/reference/stomp/stompframe/construct.xml deleted file mode 100644 index 7dd17d60ff..0000000000 --- a/reference/stomp/stompframe/construct.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - StompFrame::__construct - Constructor - - - - &reftitle.description; - - StompFrame::__construct - stringcommand - arrayheaders - stringbody - - - Constructor. - - - - - &reftitle.parameters; - - - command - - - Comando del frame - - - - - headers - - - encabezados del frame (&array;). - - - - - body - - - cuerpo del frame - - - - - - - diff --git a/reference/svm/book.xml b/reference/svm/book.xml deleted file mode 100644 index ec7a692e10..0000000000 --- a/reference/svm/book.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - - - Support Vector Machine - SVM - - - &reftitle.intro; - &warn.experimental; - - LibSVM es un solucionador eficiente para problemas de clasificación y regresión SVM. La extensión SVM se presenta como una interfaz PHP sencilla de utilizar en scripts PHP. - - - - &reference.svm.setup; - &reference.svm.examples; - - &reference.svm.svm; - &reference.svm.svmmodel; - &reference.svm.svmexception; - - - diff --git a/reference/svm/configure.xml b/reference/svm/configure.xml deleted file mode 100644 index d69517a312..0000000000 --- a/reference/svm/configure.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;svm - - -
    - diff --git a/reference/svm/examples.xml b/reference/svm/examples.xml deleted file mode 100644 index 827ab4d7eb..0000000000 --- a/reference/svm/examples.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - &reftitle.examples; - - - El proceso básico consiste en definir argumentos, someter datos de entrenamiento para la generación de un modelo y, - posteriormente, realizar predicciones basadas en este modelo. Existe un conjunto predeterminado de argumentos que - deberían proporcionar resultados con la mayoría de las entradas, por lo que se comenzará examinando estos datos. - - - Los datos se someten a través de un fichero, un flujo o un array. Si se proporcionan a través de un fichero o un - flujo, deben contener una línea por ejemplo de entrenamiento, la cual debe estar formateada como una clase entera - (generalmente 1 y -1), seguida de una serie de pares clave/característica en orden creciente de características. Las - características son enteros y los valores son números de punto flotante en el rango 0-1. Por ejemplo: - - - -1 1:0.43 3:0.12 9284:0.2 - - - En un problema de clasificación de documentos, por ejemplo, relacionado con el spam, cada línea debe representar un - documento. Debe haber 2 clases, -1 para el spam y 1 para el ham. Cada característica representa palabras y los valores - representan la importancia de estas palabras en el documento (por ejemplo, la frecuencia de aparición de estas - palabras en el documento, con el total en el rango adecuado). Las características con valor 0 (es decir, la palabra no - aparece en absoluto en el documento) simplemente no se incluirán. - - - En el modo array, los datos deben pasarse en forma de arrays de arrays. Cada subarray debe tener la clase como primer - elemento, más pares clave => valor para las características/valor. - - - Estos datos se pasan a la función de entrenamiento de la clase SVM, que devolverá un modelo SVM en caso de éxito. - - - Una vez generado el modelo, puede utilizarse para realizar predicciones sobre datos no vistos previamente. Estos - pueden pasarse en forma de array a la función de predicción del modelo, en el mismo formato que antes, pero sin la - etiqueta. La respuesta será la clase. - - - Los modelos pueden guardarse y restaurarse según sea necesario, utilizando las funciones de guardado y carga, que - toman como argumento la ruta al fichero correspondiente. - - - - Entrenamiento desde un array - - 0.43, 3 => 0.12, 9284 => 0.2), - array(1, 1 => 0.22, 5 => 0.01, 94 => 0.11), -); - -$svm = new SVM(); -$model = $svm->train($data); - -$data = array(1 => 0.43, 3 => 0.12, 9284 => 0.2); -$result = $model->predict($data); -var_dump($result); -$model->save('model.svm'); -?> -]]> - - &example.outputs.similar; - - - - - - Entrenamiento desde un fichero - - train("traindata.txt"); -?> -]]> - - - - - diff --git a/reference/svm/setup.xml b/reference/svm/setup.xml deleted file mode 100644 index 0997719a6c..0000000000 --- a/reference/svm/setup.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - LIBSVM es requerido, y está disponible a través de algunos gestores de paquetes - - libsvm-devel para el sistema basado en RPM o libsvm-dev para los basados en - Debian. Como alternativa, está disponible directamente desde el sitio web. - Si está instalando desde el sitio web oficial - algunos pasos son necesarios ya que el paquete no se instala automáticamente. - Por ejemplo, suponiendo que la última versión es la 3.1: - - - - - - - Este último paso debe mostrar LIBSVM está instalado. - -
    - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;svm - -
    - -
    - diff --git a/reference/svm/svm.xml b/reference/svm/svm.xml deleted file mode 100644 index 60ea543b6c..0000000000 --- a/reference/svm/svm.xml +++ /dev/null @@ -1,370 +0,0 @@ - - - - - - La clase SVM - SVM - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - SVM - - - - - SVM - - - - &Constants; - - const - int - SVM::C_SVC - 0 - - - const - int - SVM::NU_SVC - 1 - - - const - int - SVM::ONE_CLASS - 2 - - - const - int - SVM::EPSILON_SVR - 3 - - - const - int - SVM::NU_SVR - 4 - - - const - int - SVM::KERNEL_LINEAR - 0 - - - const - int - SVM::KERNEL_POLY - 1 - - - const - int - SVM::KERNEL_RBF - 2 - - - const - int - SVM::KERNEL_SIGMOID - 3 - - - const - int - SVM::KERNEL_PRECOMPUTED - 4 - - - const - int - SVM::OPT_TYPE - 101 - - - const - int - SVM::OPT_KERNEL_TYPE - 102 - - - const - int - SVM::OPT_DEGREE - 103 - - - const - int - SVM::OPT_SHRINKING - 104 - - - const - int - SVM::OPT_PROBABILITY - 105 - - - const - int - SVM::OPT_GAMMA - 201 - - - const - int - SVM::OPT_NU - 202 - - - const - int - SVM::OPT_EPS - 203 - - - const - int - SVM::OPT_P - 204 - - - const - int - SVM::OPT_COEF_ZERO - 205 - - - const - int - SVM::OPT_C - 206 - - - const - int - SVM::OPT_CACHE_SIZE - 207 - - - &Methods; - - - - - - - - - -
    - - -
    - &reftitle.constants; -
    - Constantes SVM - - - - SVM::C_SVC - - El tipo básico C_SVC SVM. Es el tipo por defecto. Un buen punto de partida. - - - - - SVM::NU_SVC - - El tipo NU_SVC usa una diferente y más flexible ponderación de errores. - - - - - SVM::ONE_CLASS - - Una clase de tipo SVM. Guía simplemente a una clase, usando valores extremos como ejemplos negativos. - - - - - SVM::EPSILON_SVR - - Un tipo SVM para regresión (prediciento un valor más que símplemente una clase) - - - - - SVM::NU_SVR - - Un tipo de regresión SVM al estilo NU. - - - - - SVM::KERNEL_LINEAR - - Un núcleo muy simple, puede funcionar bien con problemas de clasificación de documentos grandes. - - - - - SVM::KERNEL_POLY - - Un núcleo polinómico - - - - - SVM::KERNEL_RBF - - El común nucleo Gaussiano RBD. Maneja bien problemas no lineales y es un buen estándar para la clasificación. - - - - - SVM::KERNEL_SIGMOID - - Un núcleo basado en la función sigmoid. Usando esta, SVM se hace muy similar a sigmoid de dos capas basado en redes neuronales. - - - - - SVM::KERNEL_PRECOMPUTED - - Un núcleo precalculado - actualmente sin soporte. - - - - - SVM::OPT_TYPE - - La clave de opciones para el tipo SVM - - - - - SVM::OPT_KERNEL_TYPE - - La clave opcional para el tipo de núcleo - - - - - SVM::OPT_DEGREE - - - - - - - SVM::OPT_SHRINKING - - Parámetro de formación, booleano, para cualquier uso de reducciones heurísticas. - - - - - SVM::OPT_PROBABILITY - - Parámetro de formación, booleano, para recaudar y estimar el uso de probabilidades. - - - - - SVM::OPT_GAMMA - - Parámetro algorítmico para usar Poly, RBF y Sigmoid como tipos de núcleo. - - - - - SVM::OPT_NU - - La clave de opción para el parámetro NU, solo usado en tipos NU_ SVM. - - - - - SVM::OPT_EPS - - La clave para la opción del parámetro Epsilon, Usada en regresiones epsilon. - - - - - SVM::OPT_P - - Parámetro de formación usado por regresiones Episilon SVR - - - - - SVM::OPT_COEF_ZERO - - Parámetro para el algoritmo de núcleos poly y sigmoid - - - - - SVM::OPT_C - - La opción para el parámetro de coste que controla la compensación entre errores y generalidad - efectivamente la sanción por la clasificación errónea de los ejemplos de formación. - - - - - SVM::OPT_CACHE_SIZE - - Tamaño de la memoria caché, en MB. - - - -
    -
    - - - -
    - - &reference.svm.entities.svm; - -
    - diff --git a/reference/svm/svm/construct.xml b/reference/svm/svm/construct.xml deleted file mode 100644 index 25abe2bb26..0000000000 --- a/reference/svm/svm/construct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - SVM::__construct - Construir un nuevo objeto SVM - - - - &reftitle.description; - - public SVM::__construct - - - - Construye un nuevo objeto SVM listo para aceptar datos de entrenamiento. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.errors; - - Lanza una SVMException si la libreria - libsvm no puede ser cargada. - - - - - diff --git a/reference/svm/svm/crossvalidate.xml b/reference/svm/svm/crossvalidate.xml deleted file mode 100644 index 3c31cca1ce..0000000000 --- a/reference/svm/svm/crossvalidate.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - SVM::crossvalidate - Prueba los argumentos de entrenamiento en los subconjuntos de datos de entrenamiento - - - - &reftitle.description; - - public floatsvm::crossvalidate - arrayproblem - intnumber_of_folds - - - Puede ser utilizado para probar la efectividad del conjunto de argumentos - actual en los subconjuntos de datos de entrenamiento. Al proporcionar un - problema así como n "plis", la función separará el conjunto del problema en - n subconjuntos, y comenzará entrenamientos sucesivos en los subconjuntos. - Aunque la precisión sea generalmente más baja que la de un SVM entrenado - con el conjunto de datos completo, el porcentaje correcto retornado - debería ser suficientemente útil para probar diferentes argumentos de entrenamiento. - - - - - - &reftitle.parameters; - - - problem - - - Los datos del problema. Puede estar en forma de array, de una URL - hacia un archivo SVMLight, o de un flujo hacia un recurso de datos - SVMLight abierto. - - - - - number_of_folds - - - El número de conjuntos en los que los datos deben ser divididos - y probados. Un número alto significa que los conjuntos de entrenamiento - serán más pequeños y menos fiables. 5 es un buen comienzo. - - - - - - - - &reftitle.returnvalues; - - El porcentaje correcto, expresado como un número de punto flotante en el - intervalo 0-1. En el caso de un núcleo NU_SVC o EPSILON_SVR, el error cuadrático - medio será retornado. - - - - - &reftitle.seealso; - - SVM::train - - - - - diff --git a/reference/svm/svm/getoptions.xml b/reference/svm/svm/getoptions.xml deleted file mode 100644 index 769df56bd7..0000000000 --- a/reference/svm/svm/getoptions.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SVM::getOptions - Devuelve los argumentos de entrenamiento actuales - - - - &reftitle.description; - - public arraySVM::getOptions - - - - Recupera un array que contiene los argumentos de entrenamiento. - Estos argumentos tendrán como claves las constantes SVM predefinidas. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un array que contiene los argumentos de configuración. - - - - - diff --git a/reference/svm/svm/setoptions.xml b/reference/svm/svm/setoptions.xml deleted file mode 100644 index 38ec84e9ac..0000000000 --- a/reference/svm/svm/setoptions.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - SVM::setOptions - Define argumentos de entrenamiento - - - - &reftitle.description; - - public boolSVM::setOptions - arrayparams - - - Define uno o más argumentos de entrenamiento. - - - - - - &reftitle.parameters; - - - params - - - Un array de argumentos de entrenamiento, cuyos - claves son las constantes SVM. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; en caso de éxito, y lanza una excepción - SVMException si ocurre un error. - - - - diff --git a/reference/svm/svm/train.xml b/reference/svm/svm/train.xml deleted file mode 100644 index 2b84e2080f..0000000000 --- a/reference/svm/svm/train.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - SVM::train - Crea un modelo SVMModel basado en los datos de entrenamiento - - - - &reftitle.description; - - public SVMModelsvm::train - arrayproblem - arrayweights - - - Entrena una máquina vectorial basada en los datos de entrenamiento - proporcionados. - - - - - - &reftitle.parameters; - - - problem - - - El problema puede ser proporcionado de 3 maneras. Un array, donde las - datos deben comenzar por la etiqueta de la clase (habitualmente - 1 o -1), seguido por una serie de datos en forma de pares - dimensión/dato. Una URL hacia un archivo que contiene un problema - en formato SVM Light, donde cada línea comienza con un nuevo ejemplo - de entrenamiento, el inicio de cada línea contiene la clase (1 o -1) - seguido de una serie de valores de datos separados por una tabulación - en forma clave:valor. Un flujo abierto que apunta hacia una fuente - de datos formateada como en el archivo anterior. - - - - - weights - - - Los pesos son conjuntos opcionales de parámetros de ponderación para - las diferentes clases, para ayudar en el conteo para conjuntos de - entrenamiento desequilibrados. Por ejemplo, si las clases son 1 y -1, y - que -1 tiene más ejemplos significativos que el primero, el peso para -1 - podría ser de 0.5. Los pesos deben estar en el intervalo 0-1. - - - - - - - - &reftitle.returnvalues; - - Devuelve un modelo SVMModel que puede ser utilizado para clasificar - datos previamente no vistos. - Lanza una excepción SVMException si ocurre un error. - - - - - diff --git a/reference/svm/svmexception.xml b/reference/svm/svmexception.xml deleted file mode 100644 index e064241b12..0000000000 --- a/reference/svm/svmexception.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - La clase SVMException - SVMException - - - - -
    - &reftitle.intro; - - El objeto excepción que se produce en los errores de la SVM y clases SVMModel. - -
    - - -
    - &reftitle.classsynopsis; - - - - SVMException - - - - - SVMException - - - - extends - Exception - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - - -
    - -
    - diff --git a/reference/svm/svmmodel.xml b/reference/svm/svmmodel.xml deleted file mode 100644 index e5f6fab1fd..0000000000 --- a/reference/svm/svmmodel.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - La clase SVMModel - SVMModel - - - - -
    - &reftitle.intro; - - El SVMModel es el resultado final del proceso de formación. - Puede ser utilizado para clasificar los datos nunca antes vistos. - -
    - - -
    - &reftitle.classsynopsis; - - - - SVMModel - - - - - SVMModel - - - - - &Methods; - - - - - - - - - -
    - -
    - - &reference.svm.entities.svmmodel; - -
    - diff --git a/reference/svm/svmmodel/checkprobabilitymodel.xml b/reference/svm/svmmodel/checkprobabilitymodel.xml deleted file mode 100644 index 4deacc9f19..0000000000 --- a/reference/svm/svmmodel/checkprobabilitymodel.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - SVMModel::checkProbabilityModel - Devuelve &true; si el modelo tiene información probabilística - - - - &reftitle.description; - - public boolSVMModel::checkProbabilityModel - - - - Devuelve &true; si el modelo tiene información probabilística. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un bool. - - - - - diff --git a/reference/svm/svmmodel/construct.xml b/reference/svm/svmmodel/construct.xml deleted file mode 100644 index 9b7c095934..0000000000 --- a/reference/svm/svmmodel/construct.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - SVMModel::__construct - Construye un nuevo objeto SVMModel - - - - &reftitle.description; - - public SVMModel::__construct - stringfilename - - - Construye un nuevo objeto SVMModel. Los modelos se construyen generalmente - desde la función SVM::train, mientras que los modelos guardados pueden ser - restaurados directamente. - - - - - - &reftitle.parameters; - - - filename - - - El nombre del archivo para el modelo guardado a cargar. - - - - - - - - &reftitle.errors; - - Lanza una excepción SVMException si ocurre un error. - - - - - &reftitle.seealso; - - SVMModel::load - - - - - diff --git a/reference/svm/svmmodel/getlabels.xml b/reference/svm/svmmodel/getlabels.xml deleted file mode 100644 index 4bff723557..0000000000 --- a/reference/svm/svmmodel/getlabels.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - SVMModel::getLabels - Recupera los etiquetas utilizados para entrenar el modelo - - - - &reftitle.description; - - public arraySVMModel::getLabels - - - - Devuelve un array de etiquetas utilizados para entrenar el modelo. - Para los casos de regresión y para las clases móviles solas, - un array vacío es devuelto. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un array de etiquetas. - - - - - &reftitle.seealso; - - SVMModel::getNrClass - - - - - diff --git a/reference/svm/svmmodel/getnrclass.xml b/reference/svm/svmmodel/getnrclass.xml deleted file mode 100644 index 0491afc430..0000000000 --- a/reference/svm/svmmodel/getnrclass.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - SVMModel::getNrClass - Devuelve el número de clases utilizadas para entrenar el modelo - - - - &reftitle.description; - - public integerSVMModel::getNrClass - - - - Devuelve el número de clases utilizadas para entrenar el - modelo; devolverá 2 para una sola clase y para los modelos de regresión. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el número de clases, en forma de un entero. - - - - - diff --git a/reference/svm/svmmodel/getsvmtype.xml b/reference/svm/svmmodel/getsvmtype.xml deleted file mode 100644 index f338f3fdff..0000000000 --- a/reference/svm/svmmodel/getsvmtype.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - SVMModel::getSvmType - Recupera el tipo SVM utilizado para entrenar el modelo - - - - &reftitle.description; - - public integerSVMModel::getSvmType - - - - Devuelve un entero representando el tipo del modelo SVM utilizado, i.e. SVM::C_SVC. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el tipo SVM en forma de un entero. - - - - - diff --git a/reference/svm/svmmodel/getsvrprobability.xml b/reference/svm/svmmodel/getsvrprobability.xml deleted file mode 100644 index 81dcbb9f01..0000000000 --- a/reference/svm/svmmodel/getsvrprobability.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - SVMModel::getSvrProbability - Recupera el valor sigma para los tipos de regresión - - - - &reftitle.description; - - public floatSVMModel::getSvrProbability - - - - Para los modelos de regresión, devuelve un valor sigma; - Si no hay información de probabilidad o el modelo - no es SVR, 0 será devuelto. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un valor sigma. - - - - - diff --git a/reference/svm/svmmodel/load.xml b/reference/svm/svmmodel/load.xml deleted file mode 100644 index 81c831d8a5..0000000000 --- a/reference/svm/svmmodel/load.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - SVMModel::load - Cargar un modelo SVM guardado - - - - &reftitle.description; - - public boolSVMModel::load - stringfilename - - - Cargar un archivo de un modelo listo para la clasificación o regresión. - - - - - - &reftitle.parameters; - - - filename - - - El nombre del modelo. - - - - - - - - &reftitle.returnvalues; - - Lanza SVMException en caso de error. - Devuelve true en caso de éxito. - - - - - &reftitle.seealso; - - SVMModel::save - - - - - diff --git a/reference/svm/svmmodel/predict-probability.xml b/reference/svm/svmmodel/predict-probability.xml deleted file mode 100644 index 48d47ca1b3..0000000000 --- a/reference/svm/svmmodel/predict-probability.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - - SVMModel::predict_probability - Devuelve las probabilidades para los datos anteriores no presentados - - - - &reftitle.description; - - public floatSVMModel::predict_probability - arraydata - - - Esta función acepta un array de datos y trata de predecir la clase, - como con las funciones de predicción. Además, sin embargo, esta función devuelve - un array de probabilidades, una por clase del modelo, que representa - la probabilidad estimada de que los datos proporcionados sean un miembro de esa clase. - Necesita que el modelo a utilizar sea tratado con el parámetro de probabilidad - establecido en &true;. - - - - - - &reftitle.parameters; - - - data - - - El array a clasificar. Esto debe ser una serie de pares clave=>valor - cuyos índices están en orden creciente, pero no necesariamente continuo. - - - - - probabilities - - - El valor proporcionado será completado con las probabilidades. - Esto puede ser &null; en el caso de que el modelo no contenga - información de probabilidad, o un array en el que los - índices sean los nombres de clase y los valores, las probabilidades. - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor predicho. Esto será una etiqueta de clase en el caso - de una clasificación, un valor real en el caso de una regresión. - Lanza una excepción de tipo SVMException en caso de error. - - - - - &reftitle.seealso; - - SVM::predict - - - - - diff --git a/reference/svm/svmmodel/predict.xml b/reference/svm/svmmodel/predict.xml deleted file mode 100644 index 3a6c9a9f83..0000000000 --- a/reference/svm/svmmodel/predict.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - SVMModel::predict - Predice un valor para datos anteriores no vistos - - - - &reftitle.description; - - public floatSVMModel::predict - arraydata - - - Esta función acepta un array de datos y trata de predecir - el valor de la clase o de la regresión, según el modelo extraído - desde los datos previamente entrenados. - - - - - - &reftitle.parameters; - - - data - - - El array a clasificar. Esto puede ser una serie de pares clave => valor - en orden creciente de las claves, pero no necesariamente continuo. - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor predicho. Esto puede ser una etiqueta de clase - en el caso de una clasificación, un valor real en el caso - de una regresión. Lanza una excepción SVMException en caso de error. - - - - - &reftitle.seealso; - - SVM::train - - - - - diff --git a/reference/svm/svmmodel/save.xml b/reference/svm/svmmodel/save.xml deleted file mode 100644 index d57822d2ce..0000000000 --- a/reference/svm/svmmodel/save.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - SVMModel::save - Guardar un modelo en un archivo - - - - &reftitle.description; - - public boolSVMModel::save - stringfilename - - - Guardar los datos del modelo en un archivo, para su uso posterior. - - - - - - &reftitle.parameters; - - - filename - - - El archivo para guardar el modelo. - - - - - - - - &reftitle.returnvalues; - - Lanza SVMException en caso de error. - Devuelve true en caso de éxito. - - - - - &reftitle.seealso; - - SVMModel::load - - - - - diff --git a/reference/svn/book.xml b/reference/svn/book.xml deleted file mode 100644 index eb0d5a6609..0000000000 --- a/reference/svn/book.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - - - Subversion - SVN - - - - &reftitle.intro; - - Esta extensión implementa las funciones PHP para - Subversion (SVN), un sistema de control - de versiones, permitiendo a los scripts PHP comunicarse con los repositorios SVN - y las copias de trabajo, sin utilizar directamente llamadas a los ejecutables - svn. - - &warn.experimental; - - - - &reference.svn.setup; - &reference.svn.constants; - &reference.svn.reference; - - - diff --git a/reference/svn/configure.xml b/reference/svn/configure.xml deleted file mode 100644 index 46f07a50b4..0000000000 --- a/reference/svn/configure.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - -
    - &reftitle.install; - - &pecl.info; - - - - Si ./configure está teniendo problemas para encontrar los - archivos SVN (Por ejemplo, Subversion fue instalado con un prefijo de directorio - diferente), use - ./configure --with-svn=$USR_PATH - para especificar el directorio donde - include/subversion-1/ está ubicado. - - - &pecl.windows.download; - - - - Si la extensión es compilada contra libsvn 1.3, - las funciones que trabajan con copias fallarán - cuando trabaje en copias creadas por Subversion 1.4. - - -
    - diff --git a/reference/svn/constants.xml b/reference/svn/constants.xml deleted file mode 100644 index cc715a35d5..0000000000 --- a/reference/svn/constants.xml +++ /dev/null @@ -1,420 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - SVN_REVISION_HEAD - (int) - - - - Número mágico (-1) especificando la revisión HEAD - - - - - - Constantes usables con <function>svn_auth_set_parameter</function> - - - SVN_AUTH_PARAM_DEFAULT_USERNAME - (string) - - - - Proiedad para el nombre de usuario por omisión a ser usada cuando realice una autenticación básica - - - - - - SVN_AUTH_PARAM_DEFAULT_PASSWORD - (string) - - - - Propiedad para la clave por omisión a ser usada cuando realice una autenticación básica - - - - - - SVN_AUTH_PARAM_NON_INTERACTIVE - (string) - - - - - - SVN_AUTH_PARAM_DONT_STORE_PASSWORDS - (string) - - - - - - SVN_AUTH_PARAM_NO_AUTH_CACHE - (string) - - - - - - SVN_AUTH_PARAM_SSL_SERVER_FAILURES - (string) - - - - - - SVN_AUTH_PARAM_SSL_SERVER_CERT_INFO - (string) - - - - - - SVN_AUTH_PARAM_CONFIG - (string) - - - - - - SVN_AUTH_PARAM_SERVER_GROUP - (string) - - - - - - SVN_AUTH_PARAM_CONFIG_DIR - (string) - - - - - - PHP_SVN_AUTH_PARAM_IGNORE_SSL_VERIFY_ERRORS - (string) - - - - Propiedad personalizada para ignorar los errores de verificación del certificado SSL - - - - - - Constantes del sistema de archivos - - - SVN_FS_CONFIG_FS_TYPE - (string) - - - - Llave de configuración que determina el tipo de sistema de archivos - - - - - - SVN_FS_TYPE_BDB - (string) - - - - Sistema de archivos es una implemetación Berkeley-DB - - - - - - SVN_FS_TYPE_FSFS - (string) - - - - Implementación del sistema de ficheros nativo - - - - - - Constantes de propiedad reservadas - - - SVN_PROP_REVISION_DATE - (string) - - - - svn:date - - - - - - SVN_PROP_REVISION_ORIG_DATE - (string) - - - - svn:original-date - - - - - - SVN_PROP_REVISION_AUTHOR - (string) - - - - svn:author - - - - - - SVN_PROP_REVISION_LOG - (string) - - - - svn:log - - - - - - constantes de trabajo con estado de copias - - - SVN_WC_STATUS_NONE - (int) - - - - Estado no existe - - - - - - SVN_WC_STATUS_UNVERSIONED - (int) - - - - El artículo no está versionado en la copia de trabajo - - - - - - SVN_WC_STATUS_NORMAL - (int) - - - - El artículo existe, nada más está ocurriendo - - - - - - SVN_WC_STATUS_ADDED - (int) - - - - El artículo está programado para su adición - - - - - - SVN_WC_STATUS_MISSING - (int) - - - - El artículo está versionado pero la copia de trabajo está ausante - - - - - - SVN_WC_STATUS_DELETED - (int) - - - - El artículo está programado para ser borrado - - - - - - SVN_WC_STATUS_REPLACED - (int) - - - - El artículo fue borrado y luego re-agregado - - - - - - SVN_WC_STATUS_MODIFIED - (int) - - - - El artículo (texto o propiedades) fue modificado - - - - - - SVN_WC_STATUS_MERGED - (int) - - - - Las modificaciones locales del artículo fueron unidas con las modificaciones del repositorio - - - - - - SVN_WC_STATUS_CONFLICTED - (int) - - - - Las modificaciones locales del artículo discreparon con las modificaciones de repositorio - - - - - - SVN_WC_STATUS_IGNORED - (int) - - - - El artículo está desversionado pero configurado para ser ignorado - - - - - - SVN_WC_STATUS_OBSTRUCTED - (int) - - - - Artículo desversionado está en el camino de un recurso versionado - - - - - - SVN_WC_STATUS_EXTERNAL - (int) - - - - Rura desversionada que está poblada usando svn:externals - - - - - - SVN_WC_STATUS_INCOMPLETE - (int) - - - - El directorio no contiene la lista completa de entradas - - - - - - Constantes de tipo de nodo - - - SVN_NODE_NONE - (int) - - - - Ausente - - - - - - SVN_NODE_FILE - (int) - - - - Archivo - - - - - - SVN_NODE_DIR - (int) - - - - Directorio - - - - - - SVN_NODE_UNKNOWN - (int) - - - - Algo que la subversión no puede identificar - - - - - - - diff --git a/reference/svn/functions/svn-add.xml b/reference/svn/functions/svn-add.xml deleted file mode 100644 index b422c6e95d..0000000000 --- a/reference/svn/functions/svn-add.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - - svn_add - Prevé la adición de un elemento en el directorio de trabajo - - - - &reftitle.description; - - boolsvn_add - stringpath - boolrecursive&true; - boolforce&false; - - - Añade un fichero, un directorio o un enlace simbólico, utilizando - la ruta path en el directorio de trabajo. - El elemento será añadido al repositorio en la próxima llamada a la función - svn_commit sobre la copia de trabajo. - - - - - &reftitle.parameters; - - - path - - - Ruta del elemento a añadir. - - &svn.relativepath; - - - - recursive - - - Si el elemento es un directorio, si se debe o no añadir - recursivamente todo su contenido. Por omisión, vale &true; - - - - - force - - - Si vale &true;, Subversion buscará recursivamente en los directorios - versionados existentes para añadir todos los ficheros que - actualmente no están versionados. Por omisión, vale &false; - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>svn_add</function> - - En un directorio de trabajo donde el comando svn status - devuelve: - - - - - ...este código: - - -]]> - - - ...marcará el fichero foobar.txt como fichero a añadir - en el directorio. - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - Documentación SVN sobre el comando "svn add" - - - - diff --git a/reference/svn/functions/svn-auth-get-parameter.xml b/reference/svn/functions/svn-auth-get-parameter.xml deleted file mode 100644 index 2e2ae59aa0..0000000000 --- a/reference/svn/functions/svn-auth-get-parameter.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - svn_auth_get_parameter - Recupera un parámetro de identificación - - - - &reftitle.description; - - stringsvn_auth_get_parameter - stringkey - - - Recupera el parámetro de identificación cuya clave es - key. - Para una lista de claves válidas y sus significados, consulte - la lista de constantes de identificación. - - - - - &reftitle.parameters; - - - key - - - Nombre de la clave. Utilice una constante de identificación definida - por esta extensión para especificar una clave. - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor del parámetro cuya clave es key; - devuelve &null; si el parámetro no existe. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - svn_auth_set_parameter - Constantes de identificación - - - - - diff --git a/reference/svn/functions/svn-auth-set-parameter.xml b/reference/svn/functions/svn-auth-set-parameter.xml deleted file mode 100644 index dc992e96d2..0000000000 --- a/reference/svn/functions/svn-auth-set-parameter.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - svn_auth_set_parameter - Especifica un parámetro de autenticación - - - - &reftitle.description; - - voidsvn_auth_set_parameter - stringkey - stringvalue - - - Especifica el parámetro de autenticación key con - el valor value. - Para una lista de claves válidas y sus significados, - consulte la lista de - constantes de autenticación. - - - - - &reftitle.parameters; - - - key - - - Nombre de la clave. Utilice una constante de autenticación - definida por esta extensión para especificar la clave. - - - - - value - - - Valor a establecer para la nueva clave. El formato del valor - varía según el parámetro. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de autenticación - - Este ejemplo configura SVN con el nombre de usuario "Bob" y - la contraseña "abc123": - - - -]]> - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - svn_auth_get_parameter - Constantes de autenticación - - - - - diff --git a/reference/svn/functions/svn-blame.xml b/reference/svn/functions/svn-blame.xml deleted file mode 100644 index afb20fa8a3..0000000000 --- a/reference/svn/functions/svn-blame.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - svn_blame - Obtiene las acusaciones SVN de un archivo - - - - &reftitle.description; - - arraysvn_blame - stringrepository_url - intrevision_noSVN_REVISION_HEAD - - - Obtiene las acusaciones SVN de un archivo desde una URL de repositorio. - - - - - &reftitle.parameters; - - - repository_url - - - La URL del repositorio. - - - - - revision_no - - - El número de revisión. - - - - - - - - &reftitle.returnvalues; - - Un array con la información de acuses SVN separados por línea - incluyendo los números de revisión, número de línea, línea de codigo, - autor, y fecha. - - - - - &reftitle.examples; - - Ejemplo de <function>svn_blame</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - svn_diff - svn_logs - svn_status - - - - - diff --git a/reference/svn/functions/svn-cat.xml b/reference/svn/functions/svn-cat.xml deleted file mode 100644 index f63e997d22..0000000000 --- a/reference/svn/functions/svn-cat.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - svn_cat - Recupera el contenido de un fichero del repositorio - - - - &reftitle.description; - - stringsvn_cat - stringrepos_url - intrevision_no - - - Recupera el contenido del fichero apuntado por la URL repos_url - del repositorio, opcionalmente, en la revisión revision_no. - - - - - &reftitle.parameters; - - - repos_url - - - URL del elemento del repositorio. - - - - - revision_no - - - Número de revisión del elemento a recuperar; por omisión, es HEAD. - - - - - - - - &reftitle.returnvalues; - - Devuelve el contenido del elemento desde el repositorio en caso de éxito, - y &false; si ocurre un error. - - - - - &reftitle.examples; - - Ejemplo de uso - - Este ejemplo recupera el contenido de un fichero, en la revisión 28: - - - -]]> - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - svn_list - Documentación SVN sobre el comando "svn cat" - - - - diff --git a/reference/svn/functions/svn-checkout.xml b/reference/svn/functions/svn-checkout.xml deleted file mode 100644 index acc324ccd6..0000000000 --- a/reference/svn/functions/svn-checkout.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - - svn_checkout - Extrae una copia de trabajo desde un repositorio - - - - &reftitle.description; - - boolsvn_checkout - stringrepos - stringtargetpath - intrevision - intflags0 - - - Extrae una copia de trabajo desde el repositorio repos - hacia targetpath en la revisión revision. - - - - - &reftitle.parameters; - - - repos - - - URL del directorio en el repositorio a extraer. - - - - - targetpath - - - Ruta local del directorio en el cual se realiza la extracción - - &svn.relativepath; - - - - revision - - - Número de revisión del repositorio a extraer. Por omisión, es - HEAD, la revisión más reciente. - - - - - flags - - - Cualquier combinación de SVN_NON_RECURSIVE y - SVN_IGNORE_EXTERNALS. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo de uso - - Este ejemplo muestra cómo extraer un directorio desde un - repositorio hacia un directorio llamado "calc": - - - -]]> - - - El uso de dirname(__FILE__) es necesario - para convertir la ruta relativa del directorio calc en una ruta absoluta. - Si calc existe, asimismo se puede utilizar realpath - para obtener una ruta absoluta. - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - svn_add - svn_commit - svn_status - svn_update - Documentación SVN sobre el comando "svn checkout" - - - - - diff --git a/reference/svn/functions/svn-cleanup.xml b/reference/svn/functions/svn-cleanup.xml deleted file mode 100644 index 276c843ad3..0000000000 --- a/reference/svn/functions/svn-cleanup.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - svn_cleanup - Limpia, de forma recursiva, un directorio de trabajo, finalizando las operaciones incompletas y eliminando los bloqueos - - - - &reftitle.description; - - boolsvn_cleanup - stringworkingdir - - - Limpia, de forma recursiva, un directorio de trabajo workingdir, - finalizando las operaciones incompletas y eliminando los bloqueos. Se debe utilizar - cuando la copia de trabajo ya no es funcional. - - - - - &reftitle.parameters; - - - workingdir - - - Ruta al directorio local de trabajo a limpiar. - - &svn.relativepath; - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo de uso - - Este ejemplo muestra cómo limpiar una copia de trabajo de - un directorio llamado "help-me": - - - -]]> - - - La función realpath debe ser llamada, debido a - la mala gestión de las rutas relativas por parte de SVN. - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - update - Documentación SVN sobre el comando "svn cleanup" - - - - - diff --git a/reference/svn/functions/svn-client-version.xml b/reference/svn/functions/svn-client-version.xml deleted file mode 100644 index 486ee42d18..0000000000 --- a/reference/svn/functions/svn-client-version.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - svn_client_version - Obtiene la versión de las bibliotecas cliente SVN - - - - &reftitle.description; - - stringsvn_client_version - - - - Obtiene la versión de las bibliotecas cliente SVN. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Número de la versión, habitualmente en el formato x.y.z. - - - - - &reftitle.examples; - - Ejemplo de uso - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-commit.xml b/reference/svn/functions/svn-commit.xml deleted file mode 100644 index 846c70dd21..0000000000 --- a/reference/svn/functions/svn-commit.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - - svn_commit - Envía los cambios desde la copia local al repositorio - - - - &reftitle.description; - - arraysvn_commit - stringlog - arraytargets - boolrecursive&true; - - - Envía los cambios realizados en los ficheros locales enumerados - por el array targets al repositorio, con el mensaje - log. Los directorios contenidos en el array - targets serán enviados recursivamente a menos que el - parámetro recursive haya sido definido como &false;. - - - - Esta función no contiene ningún parámetro específico de identificación, - por lo tanto, el nombre de usuario y la contraseña deben ser definidos - utilizando la función svn_auth_set_parameter - - - - - - &reftitle.parameters; - - - log - - - Mensaje de registro a utilizar durante el envío. - - - - - targets - - - Array de rutas locales de los ficheros a enviar. - - - - Este parámetro debe ser un array; una string para un único - objetivo no es aceptada. - - - &svn.relativepath; - - - - recursive - - - Bandera de tipo booleano para desactivar la recursividad - al enviar directorios en el array targets. - Por omisión, vale &true;. - - - - - - - - &reftitle.returnvalues; - - Devuelve un array, en el siguiente formato: - - - número (integer) de revisión del envío - 1 => fecha y hora (formato ISO 8601) del envío - 2 => nombre de usuario de la persona que envió -) -]]> - - - Devuelve &false; si ocurre un error. - - - - - &reftitle.examples; - - Ejemplo de uso - - Este ejemplo envía el directorio "calculator" al repositorio, utilizando - como nombre de usuario "Bob" y como contraseña "abc123": - - - -]]> - - &example.outputs; - - 1415, - 1 => '2007-05-26T01:44:28.453125Z', - 2 => 'Bob' -) -]]> - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - svn_auth_set_parameter - Documentación SVN sobre el comando "svn commit" - - - - diff --git a/reference/svn/functions/svn-delete.xml b/reference/svn/functions/svn-delete.xml deleted file mode 100644 index 8f980c0801..0000000000 --- a/reference/svn/functions/svn-delete.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - - svn_delete - Elimina un elemento de un directorio de trabajo o de un repositorio - - - - &reftitle.description; - - boolsvn_delete - stringpath - boolforce&false; - - - Elimina un fichero, un directorio o un enlace simbólico, según el - path utilizado, desde un directorio de trabajo. - El elemento será eliminado del repositorio en la próxima llamada a la función - svn_commit en el directorio de trabajo. - - - - - &reftitle.parameters; - - - path - - - Ruta hacia el elemento a eliminar. - - &svn.relativepath; - - - - force - - - Si vale &true;, el fichero será eliminado incluso si tiene modificaciones locales. - De lo contrario, las modificaciones locales harán fallar la función. - Por omisión, vale &false;. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - Documentación SVN sobre la eliminación - - - - - diff --git a/reference/svn/functions/svn-diff.xml b/reference/svn/functions/svn-diff.xml deleted file mode 100644 index 9fda627d56..0000000000 --- a/reference/svn/functions/svn-diff.xml +++ /dev/null @@ -1,207 +0,0 @@ - - - - - - - svn_diff - Comparar dos rutas de forma recursiva - - - - &reftitle.description; - - arraysvn_diff - stringpath1 - intrev1 - stringpath2 - intrev2 - - - Compara dos rutas, path1 y - path2, de forma recursiva. - - - - No es una utilidad de comparación real. Solo los ficheros - locales que están versionados pueden ser comparados: otros ficheros - fallarán. - - - - - - &reftitle.parameters; - - - path1 - - - Primera ruta. Puede ser una URL hacia un fichero/directorio de un - repositorio SVN o una ruta hacia un fichero/directorio local. - - &svn.relativepath; - - - Si una ruta hacia un fichero local solo tiene barras invertidas y ninguna - barra, esta extensión fallará. Reemplace siempre todas las barras invertidas - con barras al utilizar esta función. - - - - - - rev1 - - - Número de revisión de la primera ruta. Utilice la constante - SVN_REVISON_HEAD para especificar la revisión - más reciente. - - - - - path2 - - - Segunda ruta a comparar. Ver el argumento - path1 para la descripción. - - - - - rev2 - - - Número de revisión de la segunda ruta. Ver el argumento - rev1 para la descripción. - - - - - - - - &reftitle.returnvalues; - - Devuelve un array que contiene 2 flujos: el primero representa la salida - de la comparación, y el segundo contiene los errores. Los flujos pueden - ser leídos utilizando la función fread. Devuelve - &false; o &null; si ocurre un error. - - - La salida del comparador puede, por omisión, estar en formato de comparación - unificado Subversion, pero un - motor externo de - comparación puede ser utilizado, según la configuración SVN. - - - - - &reftitle.examples; - - Ejemplo de uso - - Este ejemplo muestra un uso básico de esta función y recupera - el contenido desde los flujos: - - - -]]> - - &example.outputs; - - - - - - Comparación de dos revisiones de una ruta del repositorio - - Este ejemplo implementa un gestor que permite - a un usuario comparar fácilmente dos revisiones de un elemento - utilizando una ruta de repositorio externa (la sintaxis por omisión es verbosa): - - - -]]> - - - - Comparación, más portable, de dos ficheros locales - - Este ejemplo implementa un gestor para comparar - dos ficheros locales, de forma más portable gestionando el problema de - realpath y el error con las barras invertidas: - - - -]]> - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - Documentación SVN sobre la orden "svn diff" - - - - - diff --git a/reference/svn/functions/svn-export.xml b/reference/svn/functions/svn-export.xml deleted file mode 100644 index 590b1c978c..0000000000 --- a/reference/svn/functions/svn-export.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - svn_export - Exporta el contenido de un directorio SVN - - - - &reftitle.description; - - boolsvn_export - stringfrompath - stringtopath - boolworking_copy&true; - intrevision_no-1 - - - Exporta el contenido de una copia de trabajo o un repositorio en un - directorio 'limpio'. - - - - - &reftitle.parameters; - - - frompath - - - La ruta del repositorio actual. - - - - - topath - - - La ruta del nuevo repositorio. - - - - - working_copy - - - Si es &true;, exportará ficheros no cometidos de la copia de trabajo. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo de <function>svn_export</function> - - -]]> - - - - - - &reftitle.seealso; - - svn_import - - - - - diff --git a/reference/svn/functions/svn-fs-abort-txn.xml b/reference/svn/functions/svn-fs-abort-txn.xml deleted file mode 100644 index e68464ce08..0000000000 --- a/reference/svn/functions/svn-fs-abort-txn.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - svn_fs_abort_txn - Interrumpir una transacción - - - - &reftitle.description; - - boolsvn_fs_abort_txn - resourcetxn - - &warn.undocumented.func; - - Detiene una transacción, retorna &true; si todo es correcto, &false; en caso contrario. - - - - - &reftitle.parameters; - - - txn - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-apply-text.xml b/reference/svn/functions/svn-fs-apply-text.xml deleted file mode 100644 index a093cd5be8..0000000000 --- a/reference/svn/functions/svn-fs-apply-text.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - svn_fs_apply_text - Crea y devuelve una secuencia que se utilizará para reemplazar el contenido de un archivo - - - - &reftitle.description; - - resourcesvn_fs_apply_text - resourceroot - stringpath - - &warn.undocumented.func; - - Crea y devuelve una secuencia que se utilizará para reemplazar el contenido de un archivo. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - - - - - - - - - diff --git a/reference/svn/functions/svn-fs-begin-txn2.xml b/reference/svn/functions/svn-fs-begin-txn2.xml deleted file mode 100644 index fd3bd285a7..0000000000 --- a/reference/svn/functions/svn-fs-begin-txn2.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - - svn_fs_begin_txn2 - Crear una nueva transacción - - - - &reftitle.description; - - resourcesvn_fs_begin_txn2 - resourcerepos - intrev - - &warn.undocumented.func; - - Crear una nueva transacción - - - - - &reftitle.notes; - &warn.experimental.func; - - - - - - - - - - - - diff --git a/reference/svn/functions/svn-fs-change-node-prop.xml b/reference/svn/functions/svn-fs-change-node-prop.xml deleted file mode 100644 index 13fb8f7447..0000000000 --- a/reference/svn/functions/svn-fs-change-node-prop.xml +++ /dev/null @@ -1,175 +0,0 @@ - - - - - - - svn_fs_change_node_prop - Retorna verdadero si todo está ok, falso en caso contrario - - - - &reftitle.description; - - boolsvn_fs_change_node_prop - resourceroot - stringpath - stringname - stringvalue - - &warn.undocumented.func; - - Retorna verdadero si todo está ok, falso en caso contrario - - - - - &reftitle.notes; - &warn.experimental.func; - - - - - - - - - - - - diff --git a/reference/svn/functions/svn-fs-check-path.xml b/reference/svn/functions/svn-fs-check-path.xml deleted file mode 100644 index 95934089cd..0000000000 --- a/reference/svn/functions/svn-fs-check-path.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - - svn_fs_check_path - Determina que tipo de elemento está apuntado por una ruta de acceso determinada, en un repositorio fsroot - - - - &reftitle.description; - - intsvn_fs_check_path - resourcefsroot - stringpath - - &warn.undocumented.func; - - Determina que tipo de elemento está apuntado por una ruta de acceso determinada, en un repositorio fsroot - - - - - &reftitle.notes; - &warn.experimental.func; - - - - - - - - - - - - diff --git a/reference/svn/functions/svn-fs-contents-changed.xml b/reference/svn/functions/svn-fs-contents-changed.xml deleted file mode 100644 index 5928cf39e5..0000000000 --- a/reference/svn/functions/svn-fs-contents-changed.xml +++ /dev/null @@ -1,175 +0,0 @@ - - - - - - - svn_fs_contents_changed - Devuelve verdadero si el contenido es diferente, falso en caso contrario - - - - &reftitle.description; - - boolsvn_fs_contents_changed - resourceroot1 - stringpath1 - resourceroot2 - stringpath2 - - &warn.undocumented.func; - - Devuelve verdadero si el contenido es diferente, falso en caso contrario - - - - - &reftitle.notes; - &warn.experimental.func; - - - - - - - - - - - - diff --git a/reference/svn/functions/svn-fs-copy.xml b/reference/svn/functions/svn-fs-copy.xml deleted file mode 100644 index 1e59892ab4..0000000000 --- a/reference/svn/functions/svn-fs-copy.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - svn_fs_copy - Copia un fichero o un directorio - - - - &reftitle.description; - - boolsvn_fs_copy - resourcefrom_root - stringfrom_path - resourceto_root - stringto_path - - &warn.undocumented.func; - - Copia un fichero o un directorio. - - - - - &reftitle.parameters; - - - from_root - - - - - - - - from_path - - - - - - - - to_root - - - - - - - - to_path - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-delete.xml b/reference/svn/functions/svn-fs-delete.xml deleted file mode 100644 index 899b6f5209..0000000000 --- a/reference/svn/functions/svn-fs-delete.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - svn_fs_delete - Elimina un fichero o un directorio - - - - &reftitle.description; - - boolsvn_fs_delete - resourceroot - stringpath - - &warn.undocumented.func; - - Elimina un fichero o un directorio. - - - - - &reftitle.parameters; - - - root - - - - - - - - path - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-dir-entries.xml b/reference/svn/functions/svn-fs-dir-entries.xml deleted file mode 100644 index b8f3403d7b..0000000000 --- a/reference/svn/functions/svn-fs-dir-entries.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - - svn_fs_dir_entries - Enumera los directorios que hay bajo una ruta de acceso determinada; devuelve un array con los nombres de los directorios - - - - &reftitle.description; - - arraysvn_fs_dir_entries - resourcefsroot - stringpath - - &warn.undocumented.func; - - Enumera los directorios que hay bajo una ruta de acceso determinada; devuelve un array con los nombres de los directorios - - - - - &reftitle.notes; - &warn.experimental.func; - - - - - - - - - - - - diff --git a/reference/svn/functions/svn-fs-file-contents.xml b/reference/svn/functions/svn-fs-file-contents.xml deleted file mode 100644 index acf9f88945..0000000000 --- a/reference/svn/functions/svn-fs-file-contents.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - - svn_fs_file_contents - Devuelve un flujo de acceso al contenido de un fichero para una versión del sistema de ficheros dada - - - - &reftitle.description; - - resourcesvn_fs_file_contents - resourcefsroot - stringpath - - &warn.undocumented.func; - - Devuelve un flujo de acceso al contenido de un fichero para una versión del sistema de ficheros dada - - - - - &reftitle.notes; - &warn.experimental.func; - - - - - - - - - - - - diff --git a/reference/svn/functions/svn-fs-file-length.xml b/reference/svn/functions/svn-fs-file-length.xml deleted file mode 100644 index 1ac2daa268..0000000000 --- a/reference/svn/functions/svn-fs-file-length.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - - svn_fs_file_length - Devuelve la longitud de un fichero para una versión dada de sistema de ficheros - - - - &reftitle.description; - - intsvn_fs_file_length - resourcefsroot - stringpath - - &warn.undocumented.func; - - Devuelve la longitud de un fichero para una versión dada de sistema de ficheros - - - - - &reftitle.notes; - &warn.experimental.func; - - - - - - - - - - - - diff --git a/reference/svn/functions/svn-fs-is-dir.xml b/reference/svn/functions/svn-fs-is-dir.xml deleted file mode 100644 index 8a90fcb453..0000000000 --- a/reference/svn/functions/svn-fs-is-dir.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - svn_fs_is_dir - Determina si una ruta dada apunta a un directorio - - - - &reftitle.description; - - boolsvn_fs_is_dir - resourceroot - stringpath - - &warn.undocumented.func; - - Determina si una ruta dada apunta a un directorio. - - - - - &reftitle.parameters; - - - root - - - - - - - - path - - - - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si la ruta apunta a un directorio, &false; en caso contrario. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-is-file.xml b/reference/svn/functions/svn-fs-is-file.xml deleted file mode 100644 index 03716e2231..0000000000 --- a/reference/svn/functions/svn-fs-is-file.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - svn_fs_is_file - Determina si una ruta dada apunta a un fichero - - - - &reftitle.description; - - boolsvn_fs_is_file - resourceroot - stringpath - - &warn.undocumented.func; - - Determina si una ruta dada apunta a un fichero. - - - - - &reftitle.parameters; - - - root - - - - - - - - path - - - - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si la ruta apunta a un fichero, &false; en caso contrario. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-make-dir.xml b/reference/svn/functions/svn-fs-make-dir.xml deleted file mode 100644 index 29a8a87f58..0000000000 --- a/reference/svn/functions/svn-fs-make-dir.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - svn_fs_make_dir - Crea un nuevo directorio vacío - - - - &reftitle.description; - - boolsvn_fs_make_dir - resourceroot - stringpath - - &warn.undocumented.func; - - Crea un nuevo directorio. - - - - - &reftitle.parameters; - - - root - - - - - - - - path - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-make-file.xml b/reference/svn/functions/svn-fs-make-file.xml deleted file mode 100644 index f454e39621..0000000000 --- a/reference/svn/functions/svn-fs-make-file.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - svn_fs_make_file - Crea un nuevo fichero vacío - - - - &reftitle.description; - - boolsvn_fs_make_file - resourceroot - stringpath - - &warn.undocumented.func; - - Crea un nuevo fichero vacío. - - - - - &reftitle.parameters; - - - root - - - - - - - - path - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.notes; - &warn.experimental.func; - - - - diff --git a/reference/svn/functions/svn-fs-node-created-rev.xml b/reference/svn/functions/svn-fs-node-created-rev.xml deleted file mode 100644 index 60a0b8b723..0000000000 --- a/reference/svn/functions/svn-fs-node-created-rev.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - - svn_fs_node_created_rev - Devuelve la revisión en la que la ruta de acceso bajo fsroot fue creado - - - - &reftitle.description; - - intsvn_fs_node_created_rev - resourcefsroot - stringpath - - &warn.undocumented.func; - - Devuelve la revisión en la que la ruta de acceso bajo fsroot fue creado - - - - - &reftitle.notes; - &warn.experimental.func; - - - - - - - - - - - - diff --git a/reference/svn/functions/svn-fs-node-prop.xml b/reference/svn/functions/svn-fs-node-prop.xml deleted file mode 100644 index 5ff4edc873..0000000000 --- a/reference/svn/functions/svn-fs-node-prop.xml +++ /dev/null @@ -1,166 +0,0 @@ - - - - - - - svn_fs_node_prop - Devuelve el valor de una propiedad de un nodo - - - - &reftitle.description; - - stringsvn_fs_node_prop - resourcefsroot - stringpath - stringpropname - - &warn.undocumented.func; - - Devuelve el valor de una propiedad de un nodo - - - - - &reftitle.notes; - &warn.experimental.func; - - - - - - - - - - - - diff --git a/reference/svn/functions/svn-fs-props-changed.xml b/reference/svn/functions/svn-fs-props-changed.xml deleted file mode 100644 index b806dfa535..0000000000 --- a/reference/svn/functions/svn-fs-props-changed.xml +++ /dev/null @@ -1,175 +0,0 @@ - - - - - - - svn_fs_props_changed - Devuelve verdadero si las propiedades son diferentes, falso en caso contrario - - - - &reftitle.description; - - boolsvn_fs_props_changed - resourceroot1 - stringpath1 - resourceroot2 - stringpath2 - - &warn.undocumented.func; - - Devuelve verdadero si las propiedades son diferentes, falso en caso contrario - - - - - &reftitle.notes; - &warn.experimental.func; - - - - - - - - - - - - diff --git a/reference/svn/functions/svn-fs-revision-prop.xml b/reference/svn/functions/svn-fs-revision-prop.xml deleted file mode 100644 index a75698d6a5..0000000000 --- a/reference/svn/functions/svn-fs-revision-prop.xml +++ /dev/null @@ -1,166 +0,0 @@ - - - - - - - svn_fs_revision_prop - Recupera el valor de una propiedad con determinado nombre - - - - &reftitle.description; - - stringsvn_fs_revision_prop - resourcefs - intrevnum - stringpropname - - &warn.undocumented.func; - - Recupera el valor de una propiedad con determinado nombre - - - - - &reftitle.notes; - &warn.experimental.func; - - - - - - - - - - - - diff --git a/reference/svn/functions/svn-fs-revision-root.xml b/reference/svn/functions/svn-fs-revision-root.xml deleted file mode 100644 index 119ce537b4..0000000000 --- a/reference/svn/functions/svn-fs-revision-root.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - - svn_fs_revision_root - Obtiene un gestor en una versión específica del repositorio 'root' - - - - &reftitle.description; - - resourcesvn_fs_revision_root - resourcefs - intrevnum - - &warn.undocumented.func; - - Obtiene un gestor en una versión específica del repositorio 'root' - - - - - &reftitle.notes; - &warn.experimental.func; - - - - - - - - - - - - diff --git a/reference/svn/functions/svn-fs-txn-root.xml b/reference/svn/functions/svn-fs-txn-root.xml deleted file mode 100644 index d4a5075f65..0000000000 --- a/reference/svn/functions/svn-fs-txn-root.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - - svn_fs_txn_root - Crea y retorna una transacción 'root' - - - - &reftitle.description; - - resourcesvn_fs_txn_root - resourcetxn - - &warn.undocumented.func; - - Crea y retorna una transacción 'root' - - - - - &reftitle.notes; - &warn.experimental.func; - - - - - - - - - - - - diff --git a/reference/svn/functions/svn-fs-youngest-rev.xml b/reference/svn/functions/svn-fs-youngest-rev.xml deleted file mode 100644 index b6a9291e73..0000000000 --- a/reference/svn/functions/svn-fs-youngest-rev.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - - svn_fs_youngest_rev - Devuelve el número de la revisión más reciente del sistema de ficheros - - - - &reftitle.description; - - intsvn_fs_youngest_rev - resourcefs - - &warn.undocumented.func; - - Devuelve el número de la revisión más reciente del sistema de ficheros - - - - - &reftitle.notes; - &warn.experimental.func; - - - - - - - - - - - - diff --git a/reference/svn/functions/svn-import.xml b/reference/svn/functions/svn-import.xml deleted file mode 100644 index 1803dbdcae..0000000000 --- a/reference/svn/functions/svn-import.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - svn_import - Importa una ruta no versionada en un repositorio - - - - &reftitle.description; - - boolsvn_import - stringpath - stringurl - boolnonrecursive - - - Entrega una ruta path no versionada en el - repositorio a la URL url. Si path - es un directorio y nonrecursive es &false;, - el directorio será importado recursivamente. - - - - - &reftitle.parameters; - - - path - - - Ruta hacia el fichero o directorio a importar. - - &svn.relativepath; - - - - url - - - URL del repositorio en el cual se importa. - - - - - nonrecursive - - - Si se debe o no realizar una importación recursiva. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo de uso - - Este ejemplo muestra un uso clásico de esta función. Para importar - un directorio llamado "new-files" en el repositorio a la URL - "http://www.example.com/svnroot/incoming/abc", se utiliza: - - - -]]> - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - svn_add - Documentación SVN sobre el comando "svn import" - - - - - diff --git a/reference/svn/functions/svn-log.xml b/reference/svn/functions/svn-log.xml deleted file mode 100644 index 69f7dd0e13..0000000000 --- a/reference/svn/functions/svn-log.xml +++ /dev/null @@ -1,224 +0,0 @@ - - - - - - - svn_log - Recupera el mensaje de historial de una URL del repositorio - - - - &reftitle.description; - - arraysvn_log - stringrepos_url - intstart_revision - intend_revision - intlimit0 - intflagsSVN_DISCOVER_CHANGED_PATHS | SVN_STOP_ON_COPY - - - svn_log recupera el historial completo del elemento - correspondiente a la URL repos_url, o el historial de una revisión específica - si start_revision está especificado. Esta función es equivalente - al comando svn log --verbose -r $start_revision $repos_url. - - - - - &reftitle.parameters; - - - repos_url - - - URL en el repositorio del elemento del que se debe recuperar el historial. - - - - - start_revision - - - Número de revisión del primer historial a recuperar. Utilice - la constante SVN_REVISION_HEAD para recuperar - el historial de la revisión más reciente. - - - - - end_revision - - - Número de revisión del último historial a recuperar. Por omisión vale - start_revision si está especificado, de lo contrario vale la - constante SVN_REVISION_INITIAL. - - - - - limit - - - Número de historiales a recuperar. - - - - - flags - - - Cualquier combinación de SVN_OMIT_MESSAGES, - SVN_DISCOVER_CHANGED_PATHS y - SVN_STOP_ON_COPY. - - - - - - - - &reftitle.returnvalues; - - En caso de éxito, esta función devuelve un array de ficheros - en el formato: - - Array, ordenado del número de revisión más grande al más pequeño -( - [rev] => número de revisión - [author] => nombre del autor - [msg] => mensaje de historial - [date] => fecha, en formato ISO 8601, es decir, date('c') - [paths] => Array, describiendo los ficheros modificados - ( - [0] => Array - ( - [action] => letra, especificando la modificación - [path] => ruta absoluta del repositorio al fichero modificado - ) - [1] => ... - ) -) -[1] => ... -]]> - - - - - La salida será siempre un array indexado numéricamente de arrays, - incluso si no hay ninguno, o solo un mensaje de historial. - - - - El valor de action es una subparte de - la salida de estado - en la primera columna, donde los valores posibles son: - - - Acciones - - - - Letra - Descripción - - - - - M - El elemento ha sido modificado - - - A - El elemento ha sido añadido - - - D - El elemento ha sido eliminado - - - R - El elemento ha sido reemplazado - - - -
    - - Si no se ha realizado ninguna modificación al elemento, se devolverá un array - vacío. - -
    - - - &reftitle.examples; - - Ejemplo con <function>svn_log</function> - - -]]> - - &example.outputs.similar; - - Array - ( - [rev] => 23 - [author] => 'joe' - [msg] => 'Add cheese and salami to our sandwich.' - [date] => '2007-04-06T16:00:27-04:00' - [paths] => Array - ( - [0] => Array - ( - [action] => 'M' - [path] => '/sandwich.txt' - ) - ) - ) -) -]]> - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - - Documentación SVN para el comando "svn log" - - - -
    - diff --git a/reference/svn/functions/svn-ls.xml b/reference/svn/functions/svn-ls.xml deleted file mode 100644 index c922eb804e..0000000000 --- a/reference/svn/functions/svn-ls.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - - svn_ls - Devuelve la lista del contenido de un directorio de un repositorio, opcionalmente en la revisión proporcionada - - - &reftitle.description; - - arraysvn_ls - stringrepos_url - intrevision_noSVN_REVISION_HEAD - boolrecurse&false; - boolpeg&false; - - - Esta función consulta la URL del repositorio y devuelve una lista de los ficheros y directorios, opcionalmente desde una revisión específica. Es el equivalente al comando svn list $repos_url[@$revision_no]. - - - - Esta función no funciona con copias de trabajo. repos_url DEBE ser una URL de repositorio. - - - - - - &reftitle.parameters; - - - url - - - URL del repositorio, por ejemplo http://www.example.com/svnroot. Para acceder a un repositorio local Subversion a través del sistema de ficheros, utilice el siguiente URI: file:///home/user/svn-repos. - - - - - revision - - - Número de revisión a utilizar. Si se omite, se utilizará HEAD. - - - - - recurse - - - Activa la recursividad. - - - - - - - &reftitle.returnvalues; - - En caso de éxito, esta función devuelve un array de ficheros, listados de la siguiente forma: - - Array - ( - [created_rev] => número de revisión de la última edición - [last_author] => nombre del autor de la última edición - [size] => tamaño del fichero - [time] => fecha y hora de la última edición, en formato 'M d H:i' o 'M d Y', según la antigüedad del fichero - [time_t] => timestamp Unix de la última edición - [name] => nombre del fichero o directorio - [type] => tipo, puede ser 'file' o 'dir' - ) -[1] => ... -]]> - - - - - - &reftitle.examples; - - Ejemplo con <function>svn_ls</function> - - -]]> - - &example.outputs.similar; - - Array - ( - [created_rev] => 20 - [last_author] => Joe - [size] => 0 - [time] => Apr 02 09:28 - [time_t] => 1175520529 - [name] => tags - [type] => dir - ) - [1] => Array - ( - [created_rev] => 23 - [last_author] => Bob - [size] => 0 - [time] => Apr 02 15:15 - [time_t] => 1175541322 - [name] => trunk - [type] => dir - ) -) -]]> - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - - Documentación SVN sobre el comando "svn list" - - - - - diff --git a/reference/svn/functions/svn-mkdir.xml b/reference/svn/functions/svn-mkdir.xml deleted file mode 100644 index 23f20a763d..0000000000 --- a/reference/svn/functions/svn-mkdir.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - svn_mkdir - Crea un directorio en la copia de trabajo actual o repositorio - - - - &reftitle.description; - - boolsvn_mkdir - stringpath - stringlog_message - - - Crea un directorio en la copia de trabajo o repositorio. - - - - - &reftitle.parameters; - - - path - - - La ruta a la copia de trabajo o repositorio. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - svn_add - svn_copy - - - - - diff --git a/reference/svn/functions/svn-repos-create.xml b/reference/svn/functions/svn-repos-create.xml deleted file mode 100644 index 4895f51088..0000000000 --- a/reference/svn/functions/svn-repos-create.xml +++ /dev/null @@ -1,166 +0,0 @@ - - - - - - - svn_repos_create - Crea un nuevo repositorio de subversión - - - - &reftitle.description; - - resourcesvn_repos_create - stringpath - arrayconfig - arrayfsconfig - - &warn.undocumented.func; - - Crea un nuevo repositorio de subversión en un path determinado. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - - - - - - - - - diff --git a/reference/svn/functions/svn-repos-fs-begin-txn-for-commit.xml b/reference/svn/functions/svn-repos-fs-begin-txn-for-commit.xml deleted file mode 100644 index 58212d1ea6..0000000000 --- a/reference/svn/functions/svn-repos-fs-begin-txn-for-commit.xml +++ /dev/null @@ -1,175 +0,0 @@ - - - - - - - svn_repos_fs_begin_txn_for_commit - Crea una nueva transacción - - - - &reftitle.description; - - resourcesvn_repos_fs_begin_txn_for_commit - resourcerepos - intrev - stringauthor - stringlog_msg - - &warn.undocumented.func; - - Crea una nueva transacción - - - - - &reftitle.notes; - &warn.experimental.func; - - - - - - - - - - - - diff --git a/reference/svn/functions/svn-repos-fs-commit-txn.xml b/reference/svn/functions/svn-repos-fs-commit-txn.xml deleted file mode 100644 index 9b3de1013e..0000000000 --- a/reference/svn/functions/svn-repos-fs-commit-txn.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - - svn_repos_fs_commit_txn - Consolida una transacción y devuelve la nueva revisión - - - - &reftitle.description; - - intsvn_repos_fs_commit_txn - resourcetxn - - &warn.undocumented.func; - - Consolida una transacción y devuelve la nueva revisión - - - - - &reftitle.notes; - &warn.experimental.func; - - - - - - - - - - - - diff --git a/reference/svn/functions/svn-repos-fs.xml b/reference/svn/functions/svn-repos-fs.xml deleted file mode 100644 index cd6b0ad155..0000000000 --- a/reference/svn/functions/svn-repos-fs.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - - svn_repos_fs - Obtiene un gestor del sistema de ficheros para un repositorio - - - - &reftitle.description; - - resourcesvn_repos_fs - resourcerepos - - &warn.undocumented.func; - - Obtiene un gestor del sistema de ficheros para un repositorio - - - - - &reftitle.notes; - &warn.experimental.func; - - - - - - - - - - - - diff --git a/reference/svn/functions/svn-repos-hotcopy.xml b/reference/svn/functions/svn-repos-hotcopy.xml deleted file mode 100644 index aaa29cb6ff..0000000000 --- a/reference/svn/functions/svn-repos-hotcopy.xml +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - - svn_repos_hotcopy - Realiza una copia en caliente del repositorio en pathrepospath; y lo copia en destpath - - - - &reftitle.description; - - boolsvn_repos_hotcopy - stringrepospath - stringdestpath - boolcleanlogs - - &warn.undocumented.func; - - Realiza una copia en caliente del repositorio en pathrepospath; y lo copia en destpath - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - - - - - - - - - diff --git a/reference/svn/functions/svn-repos-open.xml b/reference/svn/functions/svn-repos-open.xml deleted file mode 100644 index 93a65dfa59..0000000000 --- a/reference/svn/functions/svn-repos-open.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - - svn_repos_open - Abre una cerradura compartida en un repositorio - - - - &reftitle.description; - - resourcesvn_repos_open - stringpath - - &warn.undocumented.func; - - Abre una cerradura compartida en un repositorio. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - - - - - - - - - diff --git a/reference/svn/functions/svn-repos-recover.xml b/reference/svn/functions/svn-repos-recover.xml deleted file mode 100644 index fe1d0a8411..0000000000 --- a/reference/svn/functions/svn-repos-recover.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - - svn_repos_recover - Ejecuta los procesos de recuperación en el repositorio localizado en un path determinado - - - - &reftitle.description; - - boolsvn_repos_recover - stringpath - - &warn.undocumented.func; - - Ejecuta los procesos de recuperación en el repositorio localizado en un path determinado. - - - - - &reftitle.notes; - &warn.experimental.func; - - - - - - - - - - - - diff --git a/reference/svn/functions/svn-revert.xml b/reference/svn/functions/svn-revert.xml deleted file mode 100644 index 84a7f1bf8e..0000000000 --- a/reference/svn/functions/svn-revert.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - svn_revert - Deshace los cambios en la copia de trabajo - - - - &reftitle.description; - - boolsvn_revert - stringpath - boolrecursive&false; - - - Deshace cualquier cambio local de la ruta en la copia de trabajo. - - - - - &reftitle.parameters; - - - path - - - La ruta del repositorio de trabajo. - - - - - recursive - - - Hacer cambios de forma recursiva, opcional. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - svn_delete - svn_export - - - - - diff --git a/reference/svn/functions/svn-status.xml b/reference/svn/functions/svn-status.xml deleted file mode 100644 index 1c13881828..0000000000 --- a/reference/svn/functions/svn-status.xml +++ /dev/null @@ -1,362 +0,0 @@ - - - - - - - svn_status - Obtiene el estado de los ficheros y directorios de la copia de trabajo - - - - &reftitle.description; - - arraysvn_status - stringpath - intflags0 - - - Devuelve el estado de los ficheros y directorios de la copia de trabajo, proporcionando - las modificaciones, adiciones, eliminaciones, así como otros cambios - de los elementos de la copia de trabajo. - - - - - &reftitle.parameters; - - - path - - - Ruta local al fichero o directorio del que se desea obtener el estado. - - &svn.relativepath; - - - - flags - - - Cualquier combinación de Svn::NON_RECURSIVE, - Svn::ALL (independientemente del estado de modificación), - Svn::SHOW_UPDATES (se añadirán entradas para elementos - que no están actualizados), Svn::NO_IGNORE (ignora las propiedades - svn:ignore al analizar nuevos ficheros) - y Svn::IGNORE_EXTERNALS. - - - - - - - - &reftitle.returnvalues; - - Devuelve un array indexado numéricamente de arrays asociativos - que detallan el estado de los elementos del repositorio: - - - Array ( - // información sobre el elemento - ) - [1] => ... -) -]]> - - - La información sobre un elemento es un array asociativo que puede contener - las siguientes claves: - - - - path - - - Ruta al fichero/directorio de esta entrada en el sistema de ficheros - local. - - - - - text_status - - - Estado del texto del elemento. &svn.referto.status; - - - - - repos_text_status - - - Estado del texto del elemento en el repositorio. Solo ocurre si - update está definido como &true;. - &svn.referto.status; - - - - - prop_status - - - Estado de la propiedad del elemento. &svn.referto.status; - - - - - repos_prop_status - - - Estado de la propiedad del elemento en el repositorio. Solo ocurre si - update está definido como &true;. &svn.referto.status; - - - - - locked - - - Si el elemento está bloqueado. (Definido solo si &true;.) - - - - - copied - - - Si el elemento ha sido copiado o no (previsto para añadir con el registro). - (Definido solo si &true;.) - - - - - switched - - - Si el elemento ha cambiado de repositorio de referencia, - utilizando el comando switch. - (Definido solo si &true;) - - - - - - Estas claves solo están definidas si el elemento está versionado: - - - - name - - - Nombre base del elemento en el repositorio. - - - - - url - - - URL del elemento en el repositorio. - - - - - repos - - - URL base del repositorio. - - - - - revision - - - Revisión del elemento en la copia de trabajo. - - - - - kind - - - Tipo del elemento, es decir, fichero o directorio. &svn.referto.type; - - - - - schedule - - - Acción prevista para el elemento, es decir, adición o eliminación. - Las constantes para estos números mágicos no están disponibles, - pueden ser emuladas utilizando: - - - -]]> - - - - - deleted - - - Si el elemento ha sido eliminado, pero las revisiones padre aún existen - (Definido solo si &true;.) - - - - - absent - - - Si el elemento está ausente, pero Subversion sabe que debería - estar aquí. (Definido solo si &true;.) - - - - - incomplete - - - Si la entrada del fichero para un directorio está incompleta. - (Definido solo si &true;.) - - - - - cmt_date - - - Timestamp Unix de la fecha del último commit. - (No afectado por el parámetro update). - - - - - cmt_rev - - - Revisión del último commit. (No afectado por el parámetro - update). - - - - - cmt_author - - - Nombre del autor del último commit. (No afectado por el - parámetro update). - - - - - prop_time - - - Timestamp Unix que representa la fecha/hora de la última actualización - de las propiedades. - - - - - text_time - - - Timestamp Unix que representa la fecha/hora de la última actualización - del texto. - - - - - - - - &reftitle.examples; - - Ejemplo de uso - - Este ejemplo muestra un uso básico de esta función. - - - -]]> - - &example.outputs.similar; - - Array ( - [path] => /home/bob/wc/sandwich.txt - [text_status] => 8 // el elemento ha sido modificado - [repos_text_status] => 1 // Ninguna información disponible, use update - [prop_status] => 3 // ningún cambio - [repos_prop_status] => 1 // Ninguna información disponible, use update - [name] => sandwich.txt - [url] => http://www.example.com/svnroot/deli/trunk/sandwich.txt - [repos] => http://www.example.com/svnroot/ - [revision] => 123 - [kind] => 1 // fichero - [schedule] => 0 // ninguna acción prevista - [cmt_date] => 1165543135 - [cmt_rev] => 120 - [cmt_author] => Alice - [prop_time] => 1180201728 - [text_time] => 1180201729 - ) -) -]]> - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - svn_update - svn_log - Documentación SVN del comando "svn status" - - - - diff --git a/reference/svn/functions/svn-update.xml b/reference/svn/functions/svn-update.xml deleted file mode 100644 index b74d4c6a7d..0000000000 --- a/reference/svn/functions/svn-update.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - svn_update - Actualiza la copia de trabajo - - - - &reftitle.description; - - intsvn_update - stringpath - intrevnoSVN_REVISION_HEAD - boolrecurse&true; - - - Actualiza la copia de trabajo apuntada por la ruta path a la revisión revno. Si recurse vale &true;, los directorios se actualizarán recursivamente. - - - - - &reftitle.parameters; - - - path - - - Ruta hacia la copia de trabajo local. - - &svn.relativepath; - - - - revno - - - Número de revisión hacia el cual actualizar; por omisión vale SVN_REVISION_HEAD. - - - - - recurse - - - Si se deben o no actualizar los directorios recursivamente. - - - - - - - - &reftitle.returnvalues; - - Devuelve el nuevo número de revisión en caso de éxito, o &false; si ocurre un error. - - - - - &reftitle.examples; - - Ejemplo de uso - - Este ejemplo muestra un uso básico de esta función: - - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - svn_checkout - svn_commit - Documentación SVN para el comando "svn update" - - - - diff --git a/reference/svn/reference.xml b/reference/svn/reference.xml deleted file mode 100644 index bb42cd006f..0000000000 --- a/reference/svn/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - &Functions; SVN - - &reference.svn.entities.functions; - - - - diff --git a/reference/svn/setup.xml b/reference/svn/setup.xml deleted file mode 100644 index fa54e35168..0000000000 --- a/reference/svn/setup.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - Los binarios de Subversion no son necesarios para usar esta - extensión. Sin embargo, cuando compile la extensión, libsvn - (las cabeceras de Subversion) debe estar disponible. - -
    - - - - &reference.svn.configure; - - -
    - diff --git a/reference/swoole/book.xml b/reference/swoole/book.xml deleted file mode 100644 index c8b8013fba..0000000000 --- a/reference/swoole/book.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Swoole - Swoole - - - - &reftitle.intro; - - Swoole es un motor de comunicación en red paralelo basado en eventos asíncronos y corrutinas, - escrito en C++, que proporciona soporte para corrutinas y programación de red de alto rendimiento para PHP. - Ofrece varios módulos de servidor y cliente de red para múltiples protocolos de comunicación, lo que facilita - la implementación rápida de servicios TCP/UDP, Web de alto rendimiento, servicios WebSocket, IoT, comunicación en tiempo real, juegos, - microservicios, etc., rompiendo los límites de PHP en los dominios web tradicionales. - - Para comenzar, consulte la Documentación de Swoole. - - ¬e.no-windows.extension; - - - - &reference.swoole.setup; - &reference.swoole.constants; - &reference.swoole.reference; - - &reference.swoole.swoole.async; - &reference.swoole.swoole.atomic; - &reference.swoole.swoole.buffer; - &reference.swoole.swoole.channel; - &reference.swoole.swoole.client; - &reference.swoole.swoole.connection.iterator; - &reference.swoole.swoole.coroutine; - &reference.swoole.swoole.coroutine.lock; - - - - - &reference.swoole.swoole.event; - &reference.swoole.swoole.exception; - &reference.swoole.swoole.http.client; - &reference.swoole.swoole.http.request; - &reference.swoole.swoole.http.response; - &reference.swoole.swoole.http.server; - &reference.swoole.swoole.lock; - &reference.swoole.swoole.mmap; - &reference.swoole.swoole.module; - &reference.swoole.swoole.mysql; - &reference.swoole.swoole.mysql.exception; - &reference.swoole.swoole.process; - &reference.swoole.swoole.redis.server; - &reference.swoole.swoole.runtime; - &reference.swoole.swoole.serialize; - &reference.swoole.swoole.server; - - &reference.swoole.swoole.table; - &reference.swoole.swoole.timer; - &reference.swoole.swoole.websocket.frame; - &reference.swoole.swoole.websocket.server; - - - - diff --git a/reference/swoole/configure.xml b/reference/swoole/configure.xml deleted file mode 100644 index 286a178f3a..0000000000 --- a/reference/swoole/configure.xml +++ /dev/null @@ -1,16 +0,0 @@ - - - - -
    - &reftitle.install; - - - Utilizar durante la compilación de PHP. - - - - &pecl.info; - &url.pecl.package;swoole - -
    diff --git a/reference/swoole/constants.xml b/reference/swoole/constants.xml deleted file mode 100644 index 631cb8c3c2..0000000000 --- a/reference/swoole/constants.xml +++ /dev/null @@ -1,3873 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - - - - SWOOLE_VERSION - (string) - - - - La versión de Swoole. - - - - - - SWOOLE_VERSION_ID - (int) - - - - La versión de Swoole. - - - - - - SWOOLE_MAJOR_VERSION - (int) - - - - La versión mayor de Swoole. - - - - - - SWOOLE_MINOR_VERSION - (int) - - - - La versión menor de Swoole. - - - - - - SWOOLE_RELEASE_VERSION - (int) - - - - La versión de lanzamiento de Swoole. - - - - - - SWOOLE_EXTRA_VERSION - (string) - - - - La versión extra de Swoole. - - - - - - SWOOLE_DEBUG - (int) - - - - El modo de depuración de Swoole. - - - - - - SWOOLE_HAVE_COMPRESSION - (int) - - - - Activa el modo de compresión de las respuestas HTTP. - - - - - - SWOOLE_HAVE_ZLIB - (int) - - - - Si la herramienta de compresión zlib está disponible. - - - - - - SWOOLE_HAVE_BROTLI - (int) - - - - Si la herramienta de compresión brotli está disponible. - - - - - - SWOOLE_USE_HTTP2 - (int) - - - - El soporte para HTTP2. - - - - - - SWOOLE_USE_SHORTNAME - (int) - - - - Activa/desactiva los alias cortos. - - - - - - SWOOLE_SOCK_TCP - (int) - - - - El socket TCP ipv4. - - - - - - SWOOLE_SOCK_TCP6 - (int) - - - - El socket TCP ipv6. - - - - - - SWOOLE_SOCK_UDP - (int) - - - - El socket UDP ipv4. - - - - - - SWOOLE_SOCK_UDP6 - (int) - - - - El socket UDP ipv6. - - - - - - SWOOLE_SOCK_UNIX_DGRAM - (int) - - - - El socket UNIX dgram. - - - - - - SWOOLE_SOCK_UNIX_STREAM - (int) - - - - El socket UNIX stream. - - - - - - SWOOLE_SOCK_SYNC - (int) - - - - El modo cliente síncrono. - - - - - - SWOOLE_SOCK_ASYNC - (int) - - - - El modo cliente asíncrono. - - - - - - SWOOLE_KEEP - (int) - - - - Swoole\Client soporta la creación de una conexión TCP larga al servidor en PHP-FPM/Apache. - - - - - - SWOOLE_SSL - (int) - - - - Activa el cifrado SSL. - - - - - - SWOOLE_SSLv3_METHOD - (int) - - - - Método SSLv3. - - - - - - SWOOLE_SSLv3_SERVER_METHOD - (int) - - - - El método de servidor SSLv3. - - - - - - SWOOLE_SSLv3_CLIENT_METHOD - (int) - - - - El método de cliente SSLv3. - - - - - - SWOOLE_TLSv1_METHOD - (int) - - - - El método TLSv1. - - - - - - SWOOLE_TLSv1_SERVER_METHOD - (int) - - - - El método de servidor TLSv1. - - - - - - SWOOLE_TLSv1_CLIENT_METHOD - (int) - - - - El método de cliente TLSv1. - - - - - - SWOOLE_TLSv1_1_METHOD - (int) - - - - El método TLSv1_1. - - - - - - SWOOLE_TLSv1_1_SERVER_METHOD - (int) - - - - El método de servidor TLSv1_1. - - - - - - SWOOLE_TLSv1_1_CLIENT_METHOD - (int) - - - - El método de cliente TLSv1_1. - - - - - - SWOOLE_TLSv1_2_METHOD - (int) - - - - El método TLSv1_2. - - - - - - SWOOLE_TLSv1_2_SERVER_METHOD - (int) - - - - El método de servidor TLSv1_2. - - - - - - SWOOLE_TLSv1_2_CLIENT_METHOD - (int) - - - - El método de cliente TLSv1_2. - - - - - - SWOOLE_DTLS_SERVER_METHOD - (int) - - - - El método de servidor DTLS. - - - - - - SWOOLE_DTLS_CLIENT_METHOD - (int) - - - - El método de cliente DTLS. - - - - - - SWOOLE_SSLv23_METHOD - (int) - - - - El método SSLv23. - - - - - - SWOOLE_SSLv23_SERVER_METHOD - (int) - - - - El método de servidor SSLv23. - - - - - - SWOOLE_SSLv23_CLIENT_METHOD - (int) - - - - El método de cliente SSLv23. - - - - - - SWOOLE_TLS_METHOD - (int) - - - - El método TLS. - - - - - - SWOOLE_TLS_SERVER_METHOD - (int) - - - - El método de servidor TLS. - - - - - - SWOOLE_TLS_CLIENT_METHOD - (int) - - - - El método de cliente TLS. - - - - - - SWOOLE_SSL_SSLv3 - (int) - - - - El protocolo SSLv3. - - - - - - SWOOLE_SSL_TLSv1 - (int) - - - - El protocolo TLSv1. - - - - - - SWOOLE_SSL_TLSv1_1 - (int) - - - - El protocolo TLSv1_1. - - - - - - SWOOLE_SSL_TLSv1_2 - (int) - - - - El protocolo TLSv1_2. - - - - - - SWOOLE_SSL_TLSv1_3 - (int) - - - - El protocolo TLSv1_3. - - - - - - SWOOLE_SSL_DTLS - (int) - - - - El protocolo DTLS. - - - - - - SWOOLE_SSL_SSLv2 - (int) - - - - El protocolo SSLv2. - - - - - - SWOOLE_EVENT_READ - (int) - - - - Si es necesario escuchar los eventos de lectura. - - - - - - SWOOLE_EVENT_WRITE - (int) - - - - Si es necesario escuchar los eventos de escritura. - - - - - - SWOOLE_STRERROR_SYSTEM - (int) - - - - Convierte el número errno del sistema en mensajes de error. - - - - - - SWOOLE_STRERROR_GAI - (int) - - - - Convierte el número errno de la información de dirección en mensajes de error. - - - - - - SWOOLE_STRERROR_DNS - (int) - - - - Convierte el número errno de DNS en mensajes de error. - - - - - - SWOOLE_STRERROR_SWOOLE - (int) - - - - Convierte el número errno de Swoole en mensajes de error. - - - - - - SWOOLE_ERROR_MALLOC_FAIL - (int) - - - - Fallo en la asignación de memoria (MALLOC). - - - - - - SWOOLE_ERROR_SYSTEM_CALL_FAIL - (int) - - - - Fallo en la llamada al sistema. - - - - - - SWOOLE_ERROR_PHP_FATAL_ERROR - (int) - - - - Error fatal de PHP. - - - - - - SWOOLE_ERROR_NAME_TOO_LONG - (int) - - - - Nombre demasiado largo. - - - - - - SWOOLE_ERROR_INVALID_PARAMS - (int) - - - - Parámetros no válidos. - - - - - - SWOOLE_ERROR_QUEUE_FULL - (int) - - - - La cola está llena. - - - - - - SWOOLE_ERROR_OPERATION_NOT_SUPPORT - (int) - - - - Operación no soportada. - - - - - - SWOOLE_ERROR_PROTOCOL_ERROR - (int) - - - - Error de protocolo. - - - - - - SWOOLE_ERROR_WRONG_OPERATION - (int) - - - - Operación incorrecta. - - - - - - SWOOLE_ERROR_PHP_RUNTIME_NOTICE - (int) - - - - Aviso de ejecución de PHP. - - - - - - SWOOLE_ERROR_FOR_TEST - (int) - - - - Para pruebas. - - - - - - SWOOLE_ERROR_NO_PAYLOAD - (int) - - - - Sin carga útil. - - - - - - SWOOLE_ERROR_UNDEFINED_BEHAVIOR - (int) - - - - Comportamiento no definido. - - - - - - SWOOLE_ERROR_NOT_THREAD_SAFETY - (int) - - - - No es seguro para los hilos. - - - - - - SWOOLE_ERROR_FILE_NOT_EXIST - (int) - - - - El fichero no existe. - - - - - - SWOOLE_ERROR_FILE_TOO_LARGE - (int) - - - - Fichero demasiado grande. - - - - - - SWOOLE_ERROR_FILE_EMPTY - (int) - - - - Fichero vacío. - - - - - - SWOOLE_ERROR_DNSLOOKUP_DUPLICATE_REQUEST - (int) - - - - La solicitud de búsqueda DNS está duplicada. - - - - - - SWOOLE_ERROR_DNSLOOKUP_RESOLVE_FAILED - (int) - - - - La resolución DNS ha fallado. - - - - - - SWOOLE_ERROR_DNSLOOKUP_RESOLVE_TIMEOUT - (int) - - - - La resolución DNS ha tardado demasiado. - - - - - - SWOOLE_ERROR_DNSLOOKUP_UNSUPPORTED - (int) - - - - La resolución DNS no está soportada. - - - - - - SWOOLE_ERROR_DNSLOOKUP_NO_SERVER - (int) - - - - La resolución DNS no tiene servidor. - - - - - - SWOOLE_ERROR_BAD_IPV6_ADDRESS - (int) - - - - Dirección IPv6 incorrecta. - - - - - - SWOOLE_ERROR_UNREGISTERED_SIGNAL - (int) - - - - Señal no registrada. - - - - - - SWOOLE_ERROR_BAD_HOST_ADDR - (int) - - - - Dirección de host incorrecta. - - - - - - SWOOLE_ERROR_EVENT_SOCKET_REMOVED - (int) - - - - Socket de evento eliminado. - - - - - - SWOOLE_ERROR_SESSION_CLOSED_BY_SERVER - (int) - - - - La sesión ha sido cerrada por el servidor. - - - - - - SWOOLE_ERROR_SESSION_CLOSED_BY_CLIENT - (int) - - - - La sesión ha sido cerrada por el cliente. - - - - - - SWOOLE_ERROR_SESSION_CLOSING - (int) - - - - Cierre de sesión. - - - - - - SWOOLE_ERROR_SESSION_CLOSED - (int) - - - - Sesión cerrada. - - - - - - SWOOLE_ERROR_SESSION_NOT_EXIST - (int) - - - - La sesión no existe. - - - - - - SWOOLE_ERROR_SESSION_INVALID_ID - (int) - - - - La sesión tiene un ID inválido. - - - - - - SWOOLE_ERROR_SESSION_DISCARD_TIMEOUT_DATA - (int) - - - - Datos de sesión con tiempo de espera agotado. - - - - - - SWOOLE_ERROR_SESSION_DISCARD_DATA - (int) - - - - Datos de sesión descartados. - - - - - - SWOOLE_ERROR_OUTPUT_BUFFER_OVERFLOW - (int) - - - - Desbordamiento del búfer de salida. - - - - - - SWOOLE_ERROR_OUTPUT_SEND_YIELD - (int) - - - - Rendimiento de envío de salida. - - - - - - SWOOLE_ERROR_SSL_NOT_READY - (int) - - - - SSL no está listo. - - - - - - SWOOLE_ERROR_SSL_CANNOT_USE_SENFILE - (int) - - - - SSL no puede utilizar sendfile. - - - - - - SWOOLE_ERROR_SSL_EMPTY_PEER_CERTIFICATE - (int) - - - - SSL certificado de par vacío. - - - - - - SWOOLE_ERROR_SSL_VERIFY_FAILED - (int) - - - - SSL verificación fallida. - - - - - - SWOOLE_ERROR_SSL_BAD_CLIENT - (int) - - - - SSL cliente incorrecto. - - - - - - SWOOLE_ERROR_SSL_BAD_PROTOCOL - (int) - - - - SSL protocolo incorrecto. - - - - - - SWOOLE_ERROR_SSL_RESET - (int) - - - - SSL reiniciado. - - - - - - SWOOLE_ERROR_SSL_HANDSHAKE_FAILED - (int) - - - - SSL fallo en el apretón de manos. - - - - - - SWOOLE_ERROR_PACKAGE_LENGTH_TOO_LARGE - (int) - - - - Longitud de paquete demasiado grande. - - - - - - SWOOLE_ERROR_PACKAGE_LENGTH_NOT_FOUND - (int) - - - - Longitud de paquete no encontrada. - - - - - - SWOOLE_ERROR_DATA_LENGTH_TOO_LARGE - (int) - - - - Los datos son demasiado largos. - - - - - - SWOOLE_ERROR_PACKAGE_MALFORMED_DATA - (int) - - - - Error de datos de paquete mal formado. - - - - - - SWOOLE_ERROR_TASK_PACKAGE_TOO_BIG - (int) - - - - Paquete de tarea demasiado grande. - - - - - - SWOOLE_ERROR_TASK_DISPATCH_FAIL - (int) - - - - Distribución de tarea fallida. - - - - - - SWOOLE_ERROR_TASK_TIMEOUT - (int) - - - - Tiempo de espera de la tarea agotado. - - - - - - SWOOLE_ERROR_HTTP2_STREAM_ID_TOO_BIG - (int) - - - - El identificador del flujo HTTP2 es demasiado grande. - - - - - - SWOOLE_ERROR_HTTP2_STREAM_NO_HEADER - (int) - - - - El flujo HTTP2 no tiene encabezado. - - - - - - SWOOLE_ERROR_HTTP2_STREAM_NOT_FOUND - (int) - - - - El flujo HTTP2 no ha sido encontrado. - - - - - - SWOOLE_ERROR_HTTP2_STREAM_IGNORE - (int) - - - - El flujo HTTP2 es ignorado. - - - - - - SWOOLE_ERROR_HTTP2_SEND_CONTROL_FRAME_FAILED - (int) - - - - El envío del marco de control Http2 ha fallado. - - - - - - SWOOLE_ERROR_AIO_BAD_REQUEST - (int) - - - - Solicitud Aio incorrecta. - - - - - - SWOOLE_ERROR_AIO_CANCELED - (int) - - - - Aio cancelada. - - - - - - SWOOLE_ERROR_AIO_TIMEOUT - (int) - - - - Tiempo de espera Aio agotado. - - - - - - SWOOLE_ERROR_CLIENT_NO_CONNECTION - (int) - - - - El cliente no tiene conexión. - - - - - - SWOOLE_ERROR_SOCKET_CLOSED - (int) - - - - El socket ha sido cerrado. - - - - - - SWOOLE_ERROR_SOCKET_POLL_TIMEOUT - (int) - - - - Tiempo de espera del socket poll agotado. - - - - - - SWOOLE_ERROR_SOCKS5_UNSUPPORT_VERSION - (int) - - - - Versión no soportada de Socks5. - - - - - - SWOOLE_ERROR_SOCKS5_UNSUPPORT_METHOD - (int) - - - - Método no soportado de Socks5. - - - - - - SWOOLE_ERROR_SOCKS5_AUTH_FAILED - (int) - - - - La autenticación Socks5 ha fallado. - - - - - - SWOOLE_ERROR_SOCKS5_SERVER_ERROR - (int) - - - - Error del servidor Socks5. - - - - - - SWOOLE_ERROR_SOCKS5_HANDSHAKE_FAILED - (int) - - - - El apretón de manos Socks5 ha fallado. - - - - - - SWOOLE_ERROR_HTTP_PROXY_HANDSHAKE_ERROR - (int) - - - - Error de apretón de manos Http proxy. - - - - - - SWOOLE_ERROR_HTTP_INVALID_PROTOCOL - (int) - - - - Protocolo Http inválido. - - - - - - SWOOLE_ERROR_HTTP_PROXY_HANDSHAKE_FAILED - (int) - - - - Fallo en el apretón de manos Http proxy. - - - - - - SWOOLE_ERROR_HTTP_PROXY_BAD_RESPONSE - (int) - - - - Respuesta incorrecta Http proxy. - - - - - - SWOOLE_ERROR_HTTP_CONFLICT_HEADER - (int) - - - - Conflicto de encabezado Http. - - - - - - SWOOLE_ERROR_HTTP_CONTEXT_UNAVAILABLE - (int) - - - - Contexto Http no disponible. - - - - - - SWOOLE_ERROR_HTTP_COOKIE_UNAVAILABLE - (int) - - - - Cookie Http no disponible. - - - - - - SWOOLE_ERROR_WEBSOCKET_BAD_CLIENT - (int) - - - - Cliente Websocket incorrecto. - - - - - - SWOOLE_ERROR_WEBSOCKET_BAD_OPCODE - (int) - - - - Opcode Websocket incorrecto. - - - - - - SWOOLE_ERROR_WEBSOCKET_UNCONNECTED - (int) - - - - Websocket no conectado. - - - - - - SWOOLE_ERROR_WEBSOCKET_HANDSHAKE_FAILED - (int) - - - - El apretón de manos de Websocket ha fallado. - - - - - - SWOOLE_ERROR_WEBSOCKET_PACK_FAILED - (int) - - - - El empaquetado de Websocket ha fallado. - - - - - - SWOOLE_ERROR_WEBSOCKET_UNPACK_FAILED - (int) - - - - El desempaquetado de Websocket ha fallado. - - - - - - SWOOLE_ERROR_WEBSOCKET_INCOMPLETE_PACKET - (int) - - - - Paquete Websocket incompleto. - - - - - - SWOOLE_ERROR_SERVER_MUST_CREATED_BEFORE_CLIENT - (int) - - - - El servidor debe ser creado antes que el cliente. - - - - - - SWOOLE_ERROR_SERVER_TOO_MANY_SOCKET - (int) - - - - El servidor tiene demasiados sockets. - - - - - - SWOOLE_ERROR_SERVER_WORKER_TERMINATED - (int) - - - - El servidor de trabajo ha sido terminado. - - - - - - SWOOLE_ERROR_SERVER_INVALID_LISTEN_PORT - (int) - - - - Puerto de escucha del servidor inválido. - - - - - - SWOOLE_ERROR_SERVER_TOO_MANY_LISTEN_PORT - (int) - - - - El servidor tiene demasiados puertos de escucha. - - - - - - SWOOLE_ERROR_SERVER_PIPE_BUFFER_FULL - (int) - - - - El búfer de tubería del servidor está lleno. - - - - - - SWOOLE_ERROR_SERVER_NO_IDLE_WORKER - (int) - - - - El servidor no tiene trabajadores inactivos. - - - - - - SWOOLE_ERROR_SERVER_ONLY_START_ONE - (int) - - - - El servidor solo puede iniciarse una vez. - - - - - - SWOOLE_ERROR_SERVER_SEND_IN_MASTER - (int) - - - - Servidor enviado en el maestro. - - - - - - SWOOLE_ERROR_SERVER_INVALID_REQUEST - (int) - - - - Solicitud inválida del servidor. - - - - - - SWOOLE_ERROR_SERVER_CONNECT_FAIL - (int) - - - - Fallo en la conexión del servidor. - - - - - - SWOOLE_ERROR_SERVER_INVALID_COMMAND - (int) - - - - Comando inválido del servidor. - - - - - - SWOOLE_ERROR_SERVER_IS_NOT_REGULAR_FILE - (int) - - - - El servidor no es un archivo regular. - - - - - - SWOOLE_ERROR_SERVER_SEND_TO_WOKER_TIMEOUT - (int) - - - - Tiempo de espera agotado al enviar del servidor al trabajador. - - - - - - SWOOLE_ERROR_SERVER_INVALID_CALLBACK - (int) - - - - Función de devolución de llamada inválida del servidor. - - - - - - SWOOLE_ERROR_SERVER_UNRELATED_THREAD - (int) - - - - El servidor no está vinculado a un hilo. - - - - - - SWOOLE_ERROR_SERVER_WORKER_EXIT_TIMEOUT - (int) - - - - Tiempo de espera de salida del servidor de trabajo. - - - - - - SWOOLE_ERROR_SERVER_WORKER_ABNORMAL_PIPE_DATA - (int) - - - - Datos de pipe anormales del servidor de trabajo. - - - - - - SWOOLE_ERROR_SERVER_WORKER_UNPROCESSED_DATA - (int) - - - - Datos no procesados del servidor de trabajo. - - - - - - SWOOLE_ERROR_CO_OUT_OF_COROUTINE - (int) - - - - Corrutina fuera de corrutina. - - - - - - SWOOLE_ERROR_CO_HAS_BEEN_BOUND - (int) - - - - La corrutina ha sido vinculada. - - - - - - SWOOLE_ERROR_CO_HAS_BEEN_DISCARDED - (int) - - - - La corrutina ha sido descartada. - - - - - - SWOOLE_ERROR_CO_MUTEX_DOUBLE_UNLOCK - (int) - - - - El mutex de corrutina ha sido desbloqueado dos veces. - - - - - - SWOOLE_ERROR_CO_BLOCK_OBJECT_LOCKED - (int) - - - - El bloque de objeto de corrutina está bloqueado. - - - - - - SWOOLE_ERROR_CO_BLOCK_OBJECT_WAITING - (int) - - - - El bloque de objeto de corrutina está en espera. - - - - - - SWOOLE_ERROR_CO_YIELD_FAILED - (int) - - - - El rendimiento de la corrutina ha fallado. - - - - - - SWOOLE_ERROR_CO_GETCONTEXT_FAILED - (int) - - - - Getcontext de la corrutina ha fallado. - - - - - - SWOOLE_ERROR_CO_SWAPCONTEXT_FAILED - (int) - - - - Swapcontext de la corrutina ha fallado. - - - - - - SWOOLE_ERROR_CO_MAKECONTEXT_FAILED - (int) - - - - Makecontext de la corrutina ha fallado. - - - - - - SWOOLE_ERROR_CO_IOCPINIT_FAILED - (int) - - - - Iocpinit de la corrutina ha fallado. - - - - - - SWOOLE_ERROR_CO_PROTECT_STACK_FAILED - (int) - - - - Protect stack de la corrutina ha fallado. - - - - - - SWOOLE_ERROR_CO_STD_THREAD_LINK_ERROR - (int) - - - - Error de enlace de hilo std de corrutina. - - - - - - SWOOLE_ERROR_CO_DISABLED_MULTI_THREAD - (int) - - - - Desactiva el multi-hilo de corrutina. - - - - - - SWOOLE_ERROR_CO_CANNOT_CANCEL - (int) - - - - La corrutina no puede ser cancelada. - - - - - - SWOOLE_ERROR_CO_NOT_EXISTS - (int) - - - - La corrutina no existe. - - - - - - SWOOLE_ERROR_CO_CANCELED - (int) - - - - La coroutine ha sido cancelada. - - - - - - SWOOLE_ERROR_CO_TIMEDOUT - (int) - - - - La coroutine ha expirado. - - - - - - SWOOLE_ERROR_CO_SOCKET_CLOSE_WAIT - (int) - - - - Espera de cierre de socket de coroutine. - - - - - - SWOOLE_TRACE_SERVER - (int) - - - - Flag de registro del servidor. - - - - - - SWOOLE_TRACE_CLIENT - (int) - - - - Flag de registro del cliente. - - - - - - SWOOLE_TRACE_BUFFER - (int) - - - - Flag de registro del búfer. - - - - - - SWOOLE_TRACE_CONN - (int) - - - - Flag de registro de la conexión. - - - - - - SWOOLE_TRACE_EVENT - (int) - - - - Flag de registro de eventos. - - - - - - SWOOLE_TRACE_WORKER - (int) - - - - Flag de registro del trabajador. - - - - - - SWOOLE_TRACE_MEMORY - (int) - - - - Flag de registro de la memoria. - - - - - - SWOOLE_TRACE_REACTOR - (int) - - - - Flag de registro del reactor. - - - - - - SWOOLE_TRACE_PHP - (int) - - - - Flag de registro PHP. - - - - - - SWOOLE_TRACE_HTTP - (int) - - - - Flag de registro HTTP. - - - - - - SWOOLE_TRACE_HTTP2 - (int) - - - - Flag de registro HTTP2. - - - - - - SWOOLE_TRACE_EOF_PROTOCOL - (int) - - - - Flag de registro del protocolo eof. - - - - - - SWOOLE_TRACE_LENGTH_PROTOCOL - (int) - - - - Flag de registro del protocolo de longitud. - - - - - - SWOOLE_TRACE_CLOSE - (int) - - - - Flag de registro de cierre. - - - - - - SWOOLE_TRACE_WEBSOCKET - (int) - - - - Flag de registro Websocket. - - - - - - SWOOLE_TRACE_REDIS_CLIENT - (int) - - - - Flag de registro del cliente Redis. - - - - - - SWOOLE_TRACE_MYSQL_CLIENT - (int) - - - - Flag de registro del cliente MySQL. - - - - - - SWOOLE_TRACE_HTTP_CLIENT - (int) - - - - Flag de registro del cliente HTTP. - - - - - - SWOOLE_TRACE_AIO - (int) - - - - Flag de registro AIO. - - - - - - SWOOLE_TRACE_SSL - (int) - - - - Flag de registro SSL. - - - - - - SWOOLE_TRACE_NORMAL - (int) - - - - Flag de registro normal. - - - - - - SWOOLE_TRACE_CHANNEL - (int) - - - - Flag de registro de canal. - - - - - - SWOOLE_TRACE_TIMER - (int) - - - - Flag de registro del temporizador. - - - - - - SWOOLE_TRACE_SOCKET - (int) - - - - Flag de registro de socket. - - - - - - SWOOLE_TRACE_COROUTINE - (int) - - - - Flag de registro de coroutine. - - - - - - SWOOLE_TRACE_CONTEXT - (int) - - - - Flag de registro de contexto. - - - - - - SWOOLE_TRACE_CO_HTTP_SERVER - (int) - - - - Flag de registro del servidor http de coroutine. - - - - - - SWOOLE_TRACE_TABLE - (int) - - - - Flag de registro de la tabla. - - - - - - SWOOLE_TRACE_CO_CURL - (int) - - - - Flag de registro de la coroutine curl. - - - - - - SWOOLE_TRACE_CARES - (int) - - - - Flag de registro de Cares. - - - - - - SWOOLE_TRACE_ZLIB - (int) - - - - Flag de registro zlib. - - - - - - SWOOLE_TRACE_CO_PGSQL - (int) - - - - Flag de registro de la coroutine pgsql. - - - - - - SWOOLE_TRACE_CO_ODBC - (int) - - - - Flag de registro de la coroutine odbc. - - - - - - SWOOLE_TRACE_CO_ORACLE - (int) - - - - Flag de registro de la coroutine oracle. - - - - - - SWOOLE_TRACE_CO_SQLITE - (int) - - - - Flag de registro de la coroutine sqlite. - - - - - - SWOOLE_TRACE_ALL - (int) - - - - Flag de registro de todos los niveles. - - - - - - SWOOLE_LOG_DEBUG - (int) - - - - Flag de registro de depuración. - - - - - - SWOOLE_LOG_TRACE - (int) - - - - Flag de registro de trace. - - - - - - SWOOLE_LOG_INFO - (int) - - - - Flag de registro de información. - - - - - - SWOOLE_LOG_NOTICE - (int) - - - - Flag de registro de notificación. - - - - - - SWOOLE_LOG_WARNING - (int) - - - - Flag de registro de advertencia. - - - - - - SWOOLE_LOG_ERROR - (int) - - - - Bandera de registro de errores. - - - - - - SWOOLE_LOG_NONE - (int) - - - - Equivale a desactivar las informaciones de registro, las informaciones de registro no serán lanzadas. - - - - - - SWOOLE_LOG_ROTATION_SINGLE - (int) - - - - Desactiva la rotación de los registros. - - - - - - SWOOLE_LOG_ROTATION_MONTHLY - (int) - - - - Gira los registros mensualmente. - - - - - - SWOOLE_LOG_ROTATION_DAILY - (int) - - - - Gira los registros diariamente. - - - - - - SWOOLE_LOG_ROTATION_HOURLY - (int) - - - - Gira los registros cada hora. - - - - - - SWOOLE_LOG_ROTATION_EVERY_MINUTE - (int) - - - - Gira los registros cada minuto. - - - - - - SWOOLE_IPC_NONE - (int) - - - - No utilizar mecanismo de comunicación interproceso (IPC). - - - - - - SWOOLE_IPC_UNIXSOCK - (int) - - - - Para la comunicación entre procesos (IPC), el uso de sockets Unix (UnixSocket) en modo corrutina - es altamente recomendado. - - - - - - SWOOLE_IPC_SOCKET - (int) - - - - Para la comunicación entre procesos (IPC), - el método listen debe ser llamado para especificar la dirección y el puerto a monitorear. - - - - - - SWOOLE_IOV_MAX - (int) - - - - El límite MAX de iov. - - - - - - SWOOLE_IOURING_DEFAULT - (int) - - - - En modo interrupt-driven, las I/O son enviadas a través de la llamada al sistema io_uring_enter, - y la finalización es determinada verificando directamente el estado de la cola de finalización. - - - - - - SWOOLE_IOURING_SQPOLL - (int) - - - - En modo de interrogación del núcleo, el núcleo crea hilos dedicados para enviar y recolectar las solicitudes I/O, - eliminando casi los cambios de contexto entre el usuario y el núcleo. - - - - - - SWOOLE_BASE - (int) - - - - Modo básico. - - - - - - SWOOLE_PROCESS - (int) - - - - Modo multi-processus. - - - - - - SWOOLE_THREAD - (int) - - - - Modo multi-thread. - - - - - - SWOOLE_IPC_UNSOCK - (int) - - - - El proceso de tarea comunica con el proceso de trabajo utilizando un socket Unix. - - - - - - SWOOLE_IPC_MSGQUEUE - (int) - - - - El proceso de tarea comunica con el proceso de trabajo utilizando una cola de mensajes Sysv. - - - - - - SWOOLE_IPC_PREEMPTIVE - (int) - - - - El proceso de tarea comunica con el proceso de trabajo utilizando un modo preemptivo sobre una cola de mensajes sysvmsg. - - - - - - SWOOLE_SERVER_COMMAND_MASTER - (int) - - - - El proceso maestro acepta las solicitudes. - - - - - - SWOOLE_SERVER_COMMAND_MANAGER - (int) - - - - El proceso de gestión acepta las solicitudes. - - - - - - SWOOLE_SERVER_COMMAND_REACTOR_THREAD - (int) - - - - El hilo Reactor acepta las solicitudes. - - - - - - SWOOLE_SERVER_COMMAND_EVENT_WORKER - (int) - - - - El proceso de trabajador de eventos acepta las solicitudes. - - - - - - SWOOLE_SERVER_COMMAND_TASK_WORKER - (int) - - - - El proceso de trabajador de tareas acepta las solicitudes. - - - - - - SWOOLE_DISPATCH_ROUND - (int) - - - - Modo round robin, cada proceso Worker será asignado secuencialmente para cada conexión recibida. - - - - - - SWOOLE_DISPATCH_FDMOD - (int) - - - - Asigna el Worker en función del descriptor de archivo de la conexión. Esto garantiza que los datos de la misma conexión - serán tratados por el mismo Worker únicamente. - - - - - - SWOOLE_DISPATCH_IDLE_WORKER - (int) - - - - El proceso principal elegirá la entrega en función del estado de carga de trabajo del Worker, entregando únicamente a los Workers inactivos. - - - - - - SWOOLE_DISPATCH_IPMOD - (int) - - - - Asignación basada en la IP del cliente utilizando un hachado módulo, asignando a un proceso Worker específico. - Esto asegura que los datos de la misma conexión de IP fuente serán siempre asignados al - mismo proceso Worker. Algoritmo: inet_addr_mod(ClientIP, worker_num). - - - - - - SWOOLE_DISPATCH_UIDMOD - (int) - - - - Requiere la asignación de un uid único llamando a Server->bind() en el código del usuario. - Luego, el sistema subyacente asigna a diferentes procesos Worker en función del valor del UID. - Algoritmo: UID % worker_num. Para usar strings como UID, puede utilizarse crc32(UID_STRING). - - - - - - SWOOLE_DISPATCH_USERFUNC - (int) - - - - Define una función de retorno dispatch_func, donde el valor de retorno determina - qué proceso maneja la solicitud. - - - - - - SWOOLE_DISPATCH_CO_CONN_LB - (int) - - - - Determina qué proceso maneja la solicitud en función del número de conexiones. - - - - - - SWOOLE_DISPATCH_CO_REQ_LB - (int) - - - - Determina qué proceso maneja la solicitud en función del número de solicitudes. - - - - - - SWOOLE_DISPATCH_CONCURRENT_LB - (int) - - - - Determina qué proceso maneja la solicitud en función del número de conexiones y solicitudes. - - - - - - SWOOLE_WORKER_BUSY - (int) - - - - El proceso está ocupado. - - - - - - SWOOLE_WORKER_IDLE - (int) - - - - El proceso está inactivo. - - - - - - SWOOLE_WORKER_EXIT - (int) - - - - El proceso ha finalizado. - - - - - - SWOOLE_MUTEX - (int) - - - - Bloqueo Mutex. - - - - - - SWOOLE_RWLOCK - (int) - - - - Bloqueo RW. - - - - - - SWOOLE_SPINLOCK - (int) - - - - Bloqueo de espera activa (spinlock). - - - - - - SWOOLE_CORO_MAX_NUM_LIMIT - (int) - - - - El número máximo de corrutinas creadas (PHP_INT_MAX). - - - - - - SWOOLE_CORO_INIT - (int) - - - - Inicialización de corrutina. - - - - - - SWOOLE_CORO_WAITING - (int) - - - - Rendimiento de la corrutina. - - - - - - SWOOLE_CORO_RUNNING - (int) - - - - Completación de la corrutina. - - - - - - SWOOLE_CORO_END - (int) - - - - Corrutina completada. - - - - - - SWOOLE_EXIT_IN_COROUTINE - (int) - - - - Ejecuta la función exit() en la corrutina. - - - - - - SWOOLE_EXIT_IN_SERVER - (int) - - - - Ejecuta la función exit() en el servidor. - - - - - - SWOOLE_HTTP2_TYPE_DATA - (int) - - - - Trama de datos HTTP2. - - - - - - SWOOLE_HTTP2_TYPE_HEADERS - (int) - - - - Trama de encabezados HTTP2. - - - - - - SWOOLE_HTTP2_TYPE_PRIORITY - (int) - - - - Trama de prioridad HTTP2. - - - - - - SWOOLE_HTTP2_TYPE_RST_STREAM - (int) - - - - Trama de rst de flujo HTTP2. - - - - - - SWOOLE_HTTP2_TYPE_SETTINGS - (int) - - - - Trama de parámetros HTTP2. - - - - - - SWOOLE_HTTP2_TYPE_PUSH_PROMISE - (int) - - - - Trama de promesa de empuje HTTP2. - - - - - - SWOOLE_HTTP2_TYPE_PING - (int) - - - - Trama de ping HTTP2. - - - - - - SWOOLE_HTTP2_TYPE_GOAWAY - (int) - - - - Trama de goaway HTTP2. - - - - - - SWOOLE_HTTP2_TYPE_WINDOW_UPDATE - (int) - - - - Trama de actualización de ventana HTTP2. - - - - - - SWOOLE_HTTP2_TYPE_CONTINUATION - (int) - - - - Trama de continuación HTTP2. - - - - - - SWOOLE_HTTP2_ERROR_NO_ERROR - (int) - - - - Ningún error HTTP2. - - - - - - SWOOLE_HTTP2_ERROR_PROTOCOL_ERROR - (int) - - - - Error de protocolo HTTP2. - - - - - - SWOOLE_HTTP2_ERROR_INTERNAL_ERROR - (int) - - - - Error interno HTTP2. - - - - - - SWOOLE_HTTP2_ERROR_FLOW_CONTROL_ERROR - (int) - - - - Error de control de flujo HTTP2. - - - - - - SWOOLE_HTTP2_ERROR_SETTINGS_TIMEOUT - (int) - - - - Error de tiempo de espera de los parámetros HTTP2. - - - - - - SWOOLE_HTTP2_ERROR_STREAM_CLOSED - (int) - - - - Error de flujo HTTP2 cerrado. - - - - - - SWOOLE_HTTP2_ERROR_FRAME_SIZE_ERROR - (int) - - - - Error de tamaño de trama HTTP2. - - - - - - SWOOLE_HTTP2_ERROR_REFUSED_STREAM - (int) - - - - Error de flujo rechazado HTTP2. - - - - - - SWOOLE_HTTP2_ERROR_CANCEL - (int) - - - - Error de cancelación HTTP2. - - - - - - SWOOLE_HTTP2_ERROR_COMPRESSION_ERROR - (int) - - - - Error de compresión HTTP2. - - - - - - SWOOLE_HTTP2_ERROR_CONNECT_ERROR - (int) - - - - Error de conexión HTTP2. - - - - - - SWOOLE_HTTP2_ERROR_ENHANCE_YOUR_CALM - (int) - - - - Error enhance your calm HTTP2. - - - - - - SWOOLE_HTTP2_ERROR_INADEQUATE_SECURITY - (int) - - - - Error de seguridad inadecuada HTTP2. - - - - - - SWOOLE_HTTP2_ERROR_HTTP_1_1_REQUIRED - (int) - - - - Error HTTP2 requiere http1.1. - - - - - - SWOOLE_HTTP_CLIENT_ESTATUS_CONNECT_FAILED - (int) - - - - Expiración de la conexión, el servidor no escucha en el puerto o hay una falla en la red, - se puede leer $errCode para obtener el código de error de red específico. - - - - - - SWOOLE_HTTP_CLIENT_ESTATUS_REQUEST_TIMEOUT - (int) - - - - Expiración de la petición, el servidor no ha devuelto una respuesta en el tiempo especificado. - - - - - - SWOOLE_HTTP_CLIENT_ESTATUS_SERVER_RESET - (int) - - - - Después de que la petición del cliente sea enviada, el servidor ha forzado la desconexión de la conexión. - - - - - - SWOOLE_HTTP_CLIENT_ESTATUS_SEND_FAILED - (int) - - - - Fallo al enviar al cliente (esta constante está disponible en Swoole versión >= v4.5.9, - anteriormente, se utilizaba el código de estado). - - - - - - SWOOLE_MSGQUEUE_ORIENT - (int) - - - - Swoole\Process::pop() va a devolver un dato específico en la cola con el tipo de mensaje como id del proceso + 1, - Swoole\Process::pusl() va a añadir el tipo de mensaje id del proceso + 1 al dato. - - - - - - SWOOLE_MSGQUEUE_BALANCE - (int) - - - - Swoole\Process::pop() devuelve el primer mensaje en la cola, - Swoole\Process::push() no añade un tipo específico al mensaje. - - - - - - SWOOLE_HOOK_TCP - (int) - - - - Flujo basado en corrutina de tipo TCP Socket, incluyendo los tipos más comunes como Redis, PDO, Mysqli. - - - - - - SWOOLE_HOOK_UDP - (int) - - - - Flujo basado en corrutina de tipo UDP Socket. - - - - - - SWOOLE_HOOK_UNIX - (int) - - - - Flujo basado en corrutina de tipo Unix Socket. - - - - - - SWOOLE_HOOK_UDG - (int) - - - - Flujo basado en corrutina de tipo UDG Stream Socket. - - - - - - SWOOLE_HOOK_SSL - (int) - - - - Flujo basado en corrutina de tipo SSL Stream Socket. - - - - - - SWOOLE_HOOK_TLS - (int) - - - - Flujo basado en corrutina de tipo TLS Stream Socket. - - - - - - SWOOLE_HOOK_STREAM_FUNCTION - (int) - - - - Flujo basado en corrutina para las funciones stream_*. - - - - - - SWOOLE_HOOK_FILE - (int) - - - - Fichero basado en corrutina para las funciones de ficheros. - - - - - - SWOOLE_HOOK_STDIO - (int) - - - - Operaciones STDIO basadas en corrutina. - - - - - - SWOOLE_HOOK_SLEEP - (int) - - - - Operaciones de sueño basadas en corrutina, incluyendo sleep, usleep, time_nanosleep, time_sleep_until. - - - - - - SWOOLE_HOOK_PROC - (int) - - - - Funciones proc* basadas en corrutina, incluyendo: proc_open, proc_close, proc_get_status, proc_terminate. - - - - - - SWOOLE_HOOK_CURL - (int) - - - - Extensión curl basada en corrutina. - - - - - - SWOOLE_HOOK_NATIVE_CURL - (int) - - - - Extensión curl nativa basada en corrutina. - - - - - - SWOOLE_HOOK_BLOCKING_FUNCTION - (int) - - - - Función no bloqueante basada en corrutina, incluyendo: gethostbyname, exec, shell_exec. - - - - - - SWOOLE_HOOK_SOCKETS - (int) - - - - Extensión sockets basada en corrutina. - - - - - - SWOOLE_HOOK_PDO_PGSQL - (int) - - - - Extensión pdo_pgsql basada en corrutina. - - - - - - SWOOLE_HOOK_PDO_ODBC - (int) - - - - Extensión pdo_odbc basada en corrutina. - - - - - - SWOOLE_HOOK_PDO_ORACLE - (int) - - - - Extensión pdo_oracle basada en corrutina. - - - - - - SWOOLE_HOOK_PDO_SQLITE - (int) - - - - Extensión pdo_sqlite basada en corrutina. - - - - - - SWOOLE_HOOK_ALL - (int) - - - - Todos los bloques de funciones y extensiones basadas en corrutina. - - - - - - SOCKET_ECANCELED - (int) - - - - Error de socket ecanceled. - - - - - - TCP_INFO - (int) - - - - TCP_INFO. - - - - - - SWOOLE_TIMER_MIN_MS - (int) - - - - El mínimo del intervalo de temporizador soportado (en milisegundos). - - - - - - SWOOLE_TIMER_MIN_SEC - (double) - - - - El mínimo del intervalo de temporizador admitido (en segundos). - - - - - - SWOOLE_TIMER_MAX_MS - (int) - - - - El máximo del intervalo de temporizador admitido (en milisegundos). - - - - - - SWOOLE_TIMER_MAX_SEC - (int) - - - - El máximo del intervalo de temporizador admitido (en segundos). - - - - - - SWOOLE_WEBSOCKET_STATUS_CONNECTION - (int) - - - - WebSocket se encuentra en fase de conexión. - - - - - - SWOOLE_WEBSOCKET_STATUS_HANDSHAKE - (int) - - - - El WebSocket se encuentra en fase de apretón de manos. - - - - - - SWOOLE_WEBSOCKET_STATUS_ACTIVE - (int) - - - - Conexión WebSocket activa. - - - - - - SWOOLE_WEBSOCKET_STATUS_CLOSING - (int) - - - - La conexión WebSocket está cerrada. - - - - - - SWOOLE_WEBSOCKET_OPCODE_CONTINUATION - (int) - - - - Trama de continuación WebSocket. - - - - - - SWOOLE_WEBSOCKET_OPCODE_TEXT - (int) - - - - Trama de texto WebSocket. - - - - - - SWOOLE_WEBSOCKET_OPCODE_BINARY - (int) - - - - Trama binaria WebSocket. - - - - - - SWOOLE_WEBSOCKET_OPCODE_CLOSE - (int) - - - - Trama de cierre WebSocket. - - - - - - SWOOLE_WEBSOCKET_OPCODE_PING - (int) - - - - Trama de ping WebSocket. - - - - - - SWOOLE_WEBSOCKET_OPCODE_PONG - (int) - - - - Trama de pong WebSocket. - - - - - - SWOOLE_WEBSOCKET_FLAG_FIN - (int) - - - - Flag FIN WebSocket. - - - - - - SWOOLE_WEBSOCKET_FLAG_RSV1 - (int) - - - - Flag RSV1 WebSocket. - - - - - - SWOOLE_WEBSOCKET_FLAG_RSV2 - (int) - - - - Flag RSV2 WebSocket. - - - - - - SWOOLE_WEBSOCKET_FLAG_RSV3 - (int) - - - - Flag RSV3 WebSocket. - - - - - - SWOOLE_WEBSOCKET_FLAG_MASK - (int) - - - - Flag MASK WebSocket. - - - - - - SWOOLE_WEBSOCKET_FLAG_COMPRESS - (int) - - - - Flag COMPRESS WebSocket. - - - - - - SWOOLE_WEBSOCKET_CLOSE_NORMAL - (int) - - - - Cierre normal (la conexión ha finalizado con éxito). - - - - - - SWOOLE_WEBSOCKET_CLOSE_GOING_AWAY - (int) - - - - El punto final se ha ido (por ejemplo, pestaña del navegador cerrada). - - - - - - SWOOLE_WEBSOCKET_CLOSE_PROTOCOL_ERROR - (int) - - - - Error de protocolo (trama de datos malformada). - - - - - - SWOOLE_WEBSOCKET_CLOSE_DATA_ERROR - (int) - - - - Recepción de datos no soportada (por ejemplo, binaria cuando se espera texto). - - - - - - SWOOLE_WEBSOCKET_CLOSE_STATUS_ERROR - (int) - - - - No se ha proporcionado código de estado (enviado como un espacio reservado). - - - - - - SWOOLE_WEBSOCKET_CLOSE_ABNORMAL - (int) - - - - Cierre anormal (ninguna trama de cierre recibida, por ejemplo, reinicialización TCP). - - - - - - SWOOLE_WEBSOCKET_CLOSE_MESSAGE_ERROR - (int) - - - - Datos inválidos (por ejemplo, texto no-UTF-8 en una trama de texto). - - - - - - SWOOLE_WEBSOCKET_CLOSE_POLICY_ERROR - (int) - - - - Violación de la política (por ejemplo, acción no autorizada). - - - - - - SWOOLE_WEBSOCKET_CLOSE_MESSAGE_TOO_BIG - (int) - - - - Mensaje demasiado grande (supera el tamaño máximo del servidor). - - - - - - SWOOLE_WEBSOCKET_CLOSE_EXTENSION_MISSING - (int) - - - - El cliente no ha negociado las extensiones requeridas. - - - - - - SWOOLE_WEBSOCKET_CLOSE_SERVER_ERROR - (int) - - - - El servidor ha encontrado un error. - - - - - - SWOOLE_WEBSOCKET_CLOSE_CLOSE_SERVICE_RESTART - (int) - - - - El servicio se reinicia (condición temporal). - - - - - - SWOOLE_WEBSOCKET_CLOSE_TRY_AGAIN_LATER - (int) - - - - El servidor está temporalmente sobrecargado (el cliente debería reintentar). - - - - - - SWOOLE_WEBSOCKET_CLOSE_BAD_GATEWAY - (int) - - - - Respuesta inválida del servidor en amont. - - - - - - SWOOLE_WEBSOCKET_CLOSE_TLS - (int) - - - - El apretón de manos TLS ha fallado (utilizado cuando HTTPS falla). - - - - - - - - diff --git a/reference/swoole/functions/swoole-async-dns-lookup.xml b/reference/swoole/functions/swoole-async-dns-lookup.xml deleted file mode 100644 index bb31c99d66..0000000000 --- a/reference/swoole/functions/swoole-async-dns-lookup.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - swoole_async_dns_lookup - Busca de manera asíncrona y no bloqueante la dirección IP de un host - - - - &reftitle.description; - - boolswoole_async_dns_lookup - stringhostname - callablecallback - - - - - - - - - &reftitle.parameters; - - - hostname - - - El nombre de host. - - - - - callback - - - - mixedcallback - stringhostname - stringip - - - - hostname - - - El nombre de host. - - - - - IP - - - La dirección IP. - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/swoole/functions/swoole-async-read.xml b/reference/swoole/functions/swoole-async-read.xml deleted file mode 100644 index c99257288e..0000000000 --- a/reference/swoole/functions/swoole-async-read.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - swoole_async_read - Lee un flujo de fichero de manera asíncrona - - - - &reftitle.description; - - boolswoole_async_read - stringfilename - callablecallback - intchunk_size65536 - intoffset0 - - - - - - - - - &reftitle.parameters; - - - filename - - - El nombre del fichero a leer. - - - - - callback - - - mixedcallback - stringfilename - stringcontent - - - - filename - - - El nombre del fichero. - - - - - content - - - El contenido leído del flujo de fichero. - - - - - - - - chunk_size - - - El tamaño del fragmento. - - - - - offset - - - El desplazamiento. - - - - - - - - &reftitle.returnvalues; - - Si la lectura tiene éxito. - - - - - - diff --git a/reference/swoole/functions/swoole-async-readfile.xml b/reference/swoole/functions/swoole-async-readfile.xml deleted file mode 100644 index 822bc71013..0000000000 --- a/reference/swoole/functions/swoole-async-readfile.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - swoole_async_readfile - Lee un fichero de manera asíncrona - - - - &reftitle.description; - - boolswoole_async_readfile - stringfilename - callablecallback - - - - - - - - - &reftitle.parameters; - - - filename - - - El nombre del fichero a leer. - - - - - callback - - - mixedcallback - stringfilename - stringcontent - - - - filename - - - El nombre del fichero. - - - - - content - - - El contenido leído del fichero. - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/swoole/functions/swoole-async-set.xml b/reference/swoole/functions/swoole-async-set.xml deleted file mode 100644 index 5faa461dd5..0000000000 --- a/reference/swoole/functions/swoole-async-set.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - swoole_async_set - Actualiza las opciones de E/S asíncronas - - - - &reftitle.description; - - voidswoole_async_set - arraysettings - - - - - - - - - &reftitle.parameters; - - - settings - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/swoole/functions/swoole-async-write.xml b/reference/swoole/functions/swoole-async-write.xml deleted file mode 100644 index 5c81de0587..0000000000 --- a/reference/swoole/functions/swoole-async-write.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - swoole_async_write - Escribe datos en un flujo de fichero de manera asíncrona - - - - &reftitle.description; - - boolswoole_async_write - stringfilename - stringcontent - intoffset - callablecallback - - - - - - - - - &reftitle.parameters; - - - filename - - - El nombre del fichero a escribir. - - - - - content - - - El contenido a escribir en el fichero. - - - - - offset - - - El desplazamiento. - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/swoole/functions/swoole-async-writefile.xml b/reference/swoole/functions/swoole-async-writefile.xml deleted file mode 100644 index 0c78c14d8a..0000000000 --- a/reference/swoole/functions/swoole-async-writefile.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - swoole_async_writefile - Escribe datos en un fichero de manera asíncrona - - - - &reftitle.description; - - boolswoole_async_writefile - stringfilename - stringcontent - callablecallback - intflags0 - - - - - - - - - &reftitle.parameters; - - - filename - - - El nombre del fichero a escribir. - - - - - content - - - El contenido a escribir en el fichero. - - - - - callback - - - - - - - - flags - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/swoole/functions/swoole-clear-error.xml b/reference/swoole/functions/swoole-clear-error.xml deleted file mode 100644 index b4186f88b4..0000000000 --- a/reference/swoole/functions/swoole-clear-error.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - swoole_clear_error - Elimina los errores en el socket o el último código de error - - - - &reftitle.description; - - voidswoole_clear_error - - - - Elimina los errores en el socket o el último código de error. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/swoole/functions/swoole-client-select.xml b/reference/swoole/functions/swoole-client-select.xml deleted file mode 100644 index a979a830dd..0000000000 --- a/reference/swoole/functions/swoole-client-select.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - swoole_client_select - Devuelve la descripción del fichero listo para ser leído/escrito o un error - - - - &reftitle.description; - - intswoole_client_select - arrayread_array - arraywrite_array - arrayerror_array - floattimeout0.5 - - - - - - - - - &reftitle.parameters; - - - read_array - - - - - - - - write_array - - - - - - - - error_array - - - - - - - - timeout - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/functions/swoole-cpu-num.xml b/reference/swoole/functions/swoole-cpu-num.xml deleted file mode 100644 index 592ab925dd..0000000000 --- a/reference/swoole/functions/swoole-cpu-num.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - swoole_cpu_num - Devuelve el número de CPU - - - - &reftitle.description; - - intswoole_cpu_num - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El número de CPU. - - - - - - diff --git a/reference/swoole/functions/swoole-errno.xml b/reference/swoole/functions/swoole-errno.xml deleted file mode 100644 index d425e98093..0000000000 --- a/reference/swoole/functions/swoole-errno.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - swoole_errno - Devuelve el código de error de la última llamada al sistema - - - - &reftitle.description; - - intswoole_errno - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/functions/swoole-error-log.xml b/reference/swoole/functions/swoole-error-log.xml deleted file mode 100644 index af30cd4928..0000000000 --- a/reference/swoole/functions/swoole-error-log.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - swoole_error_log - Escribe los mensajes de error en el registro - - - - &reftitle.description; - - voidswoole_error_log - intlevel - stringmsg - - - Escribe los mensajes de error en el registro. - - - - - &reftitle.parameters; - - - level - - - El nivel de registro, las siguientes constantes pueden ser utilizadas: SWOOLE_LOG_DEBUG, - SWOOLE_LOG_TRACE, - SWOOLE_LOG_INFO, - SWOOLE_LOG_NOTICE, - SWOOLE_LOG_WARNING, - SWOOLE_LOG_ERROR, - SWOOLE_LOG_NONE - - - - - msg - - - El contenido del mensaje a escribir en el registro. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/swoole/functions/swoole-event-add.xml b/reference/swoole/functions/swoole-event-add.xml deleted file mode 100644 index 29dc696847..0000000000 --- a/reference/swoole/functions/swoole-event-add.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - swoole_event_add - Añade una nueva función de retrollamada de un socket en el EventLoop - - - - &reftitle.description; - - intswoole_event_add - intfd - callableread_callback - callablewrite_callback - intevents0 - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - read_callback - - - - - - - - write_callback - - - - - - - - events - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/functions/swoole-event-defer.xml b/reference/swoole/functions/swoole-event-defer.xml deleted file mode 100644 index c50e94838e..0000000000 --- a/reference/swoole/functions/swoole-event-defer.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - swoole_event_defer - Añade una retrollamada a la próxima iteración del bucle de eventos - - - - &reftitle.description; - - boolswoole_event_defer - callablecallback - - - - - - - - - &reftitle.parameters; - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/swoole/functions/swoole-event-del.xml b/reference/swoole/functions/swoole-event-del.xml deleted file mode 100644 index c7ca42c5bc..0000000000 --- a/reference/swoole/functions/swoole-event-del.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - swoole_event_del - Elimina todas las funciones de retrollamada de eventos de un socket - - - - &reftitle.description; - - boolswoole_event_del - intfd - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/swoole/functions/swoole-event-exit.xml b/reference/swoole/functions/swoole-event-exit.xml deleted file mode 100644 index e8080a6d4c..0000000000 --- a/reference/swoole/functions/swoole-event-exit.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - swoole_event_exit - Sale del bucle de eventos, disponible únicamente en el lado-cliente - - - - &reftitle.description; - - voidswoole_event_exit - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/functions/swoole-event-set.xml b/reference/swoole/functions/swoole-event-set.xml deleted file mode 100644 index 802e74a780..0000000000 --- a/reference/swoole/functions/swoole-event-set.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - swoole_event_set - Actualiza las funciones de retrollamada de eventos de un socket - - - - &reftitle.description; - - boolswoole_event_set - intfd - callableread_callback - callablewrite_callback - intevents0 - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - read_callback - - - - - - - - write_callback - - - - - - - - events - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/functions/swoole-event-wait.xml b/reference/swoole/functions/swoole-event-wait.xml deleted file mode 100644 index b024b25d50..0000000000 --- a/reference/swoole/functions/swoole-event-wait.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - swoole_event_wait - Inicia el bucle de eventos - - - - &reftitle.description; - - voidswoole_event_wait - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/functions/swoole-event-write.xml b/reference/swoole/functions/swoole-event-write.xml deleted file mode 100644 index adaf8be81e..0000000000 --- a/reference/swoole/functions/swoole-event-write.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - swoole_event_write - Escribe datos en un socket - - - - &reftitle.description; - - boolswoole_event_write - intfd - stringdata - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - data - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/swoole/functions/swoole-get-local-ip.xml b/reference/swoole/functions/swoole-get-local-ip.xml deleted file mode 100644 index d64631c7c6..0000000000 --- a/reference/swoole/functions/swoole-get-local-ip.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - swoole_get_local_ip - Devuelve las direcciones IP IPv4 de cada NIC en la máquina - - - - &reftitle.description; - - arrayswoole_get_local_ip - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/functions/swoole-last-error.xml b/reference/swoole/functions/swoole-last-error.xml deleted file mode 100644 index 1eacfdc095..0000000000 --- a/reference/swoole/functions/swoole-last-error.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - swoole_last_error - Devuelve el último mensaje de error - - - - &reftitle.description; - - intswoole_last_error - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/functions/swoole-load-module.xml b/reference/swoole/functions/swoole-load-module.xml deleted file mode 100644 index d1322b54d8..0000000000 --- a/reference/swoole/functions/swoole-load-module.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - swoole_load_module - Carga una extensión swoole - - - - &reftitle.description; - - mixedswoole_load_module - stringfilename - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/functions/swoole-select.xml b/reference/swoole/functions/swoole-select.xml deleted file mode 100644 index d62b0f9637..0000000000 --- a/reference/swoole/functions/swoole-select.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - swoole_select - Selecciona las descripciones de ficheros listas para leer/escribir o en error en el bucle de eventos - - - - &reftitle.description; - - intswoole_select - arrayread_array - arraywrite_array - arrayerror_array - floattimeout - - - - - - - - - &reftitle.parameters; - - - read_array - - - - - - - - write_array - - - - - - - - error_array - - - - - - - - timeout - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/functions/swoole-set-process-name.xml b/reference/swoole/functions/swoole-set-process-name.xml deleted file mode 100644 index 168020a4b5..0000000000 --- a/reference/swoole/functions/swoole-set-process-name.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - swoole_set_process_name - Define el nombre del proceso - - - - &reftitle.description; - - voidswoole_set_process_name - stringprocess_name - intsize128 - - - - - - - - - &reftitle.parameters; - - - process_name - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/functions/swoole-strerror.xml b/reference/swoole/functions/swoole-strerror.xml deleted file mode 100644 index b2c639186e..0000000000 --- a/reference/swoole/functions/swoole-strerror.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - swoole_strerror - Convierte el Errno en mensajes de error - - - - &reftitle.description; - - stringswoole_strerror - interrno - interror_type0 - - - - - - - - - &reftitle.parameters; - - - errno - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/functions/swoole-timer-after.xml b/reference/swoole/functions/swoole-timer-after.xml deleted file mode 100644 index 1abfb90579..0000000000 --- a/reference/swoole/functions/swoole-timer-after.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - swoole_timer_after - Dispara una retrollamada única en el futuro - - - - &reftitle.description; - - intswoole_timer_after - intms - callablecallback - mixedparam - - - - - - - - - &reftitle.parameters; - - - ms - - - - - - - - callback - - - - - - - - param - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/functions/swoole-timer-exists.xml b/reference/swoole/functions/swoole-timer-exists.xml deleted file mode 100644 index 19664cd328..0000000000 --- a/reference/swoole/functions/swoole-timer-exists.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - swoole_timer_exists - Devuelve si existe una retrollamada de temporizador - - - - &reftitle.description; - - boolswoole_timer_exists - inttimer_id - - - - - - - - - &reftitle.parameters; - - - timer_id - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/functions/swoole-timer-tick.xml b/reference/swoole/functions/swoole-timer-tick.xml deleted file mode 100644 index 9648936364..0000000000 --- a/reference/swoole/functions/swoole-timer-tick.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - swoole_timer_tick - Dispara una retrollamada de temporizador por intervalo de tiempo - - - - &reftitle.description; - - intswoole_timer_tick - intms - callablecallback - mixedparam - - - - - - - - - &reftitle.parameters; - - - ms - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/functions/swoole-version.xml b/reference/swoole/functions/swoole-version.xml deleted file mode 100644 index 0401401e42..0000000000 --- a/reference/swoole/functions/swoole-version.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - swoole_version - Devuelve la versión de Swoole - - - - &reftitle.description; - - stringswoole_version - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La versión de Swoole. - - - - - - diff --git a/reference/swoole/ini.xml b/reference/swoole/ini.xml deleted file mode 100644 index 4eaed2cdd4..0000000000 --- a/reference/swoole/ini.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - - Opciones de configuración de Swoole - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - swoole.enable_library - On - INI_ALL - - - - swoole.enable_fiber_mock - Off - INI_ALL - - - - swoole.enable_preemptive_scheduler - Off - INI_ALL - - - - swoole.display_errors - On - INI_ALL - - - - swoole.use_shortname - On - INI_SYSTEM - - - - swoole.unixsock_buffer_size - 8388608 - INI_ALL - - - - -
    -
    - - &ini.descriptions.title; - - - - - - swoole.enable_library - string - - - - Activa o desactiva la biblioteca integrada de la extensión. - - - - - - swoole.enable_fiber_mock - string - - - - Activa o desactiva el uso de la extensión xdebug para depurar programas Swoole. - - - - - - swoole.enable_preemptive_scheduler - string - - - - Impide que ciertas corrutinas consuman demasiado tiempo de CPU en un bucle cerrado (10 ms de tiempo CPU), - lo que podría impedir la planificación de otras corrutinas. - - - - - - swoole.display_errors - string - - - - Activa o desactiva la visualización de los mensajes de error de Swoole. - - - - - - - swoole.use_shortname - string - - - - Activa o desactiva los alias cortos. - - - - - - - swoole.unixsock_buffer_size - int - - - - Define el tamaño del búfer Socket para la comunicación interprocesos. - - - - - -
    - - diff --git a/reference/swoole/reference.xml b/reference/swoole/reference.xml deleted file mode 100644 index 8f7f892b0c..0000000000 --- a/reference/swoole/reference.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - - - &Functions; de Swoole - - &reference.swoole.entities.functions; - - diff --git a/reference/swoole/setup.xml b/reference/swoole/setup.xml deleted file mode 100644 index 4f4838d38c..0000000000 --- a/reference/swoole/setup.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Swoole requiere la biblioteca libbrotli. - - - La activación de la opción --enable-swoole-curl requiere la biblioteca libcurl, - y PHP así como Swoole deben estar vinculados a la misma biblioteca compartida libcurl - y a los mismos encabezados, a fin de evitar un comportamiento indefinido. - - - La activación de la opción --enable-iouring requiere la biblioteca liburing (versión ≥ 2.0) - y un núcleo Linux (versión ≥ 5.12). - - - La activación de la opción --enable-swoole-thread requiere que PHP sea compilado en modo ZTS (Zend Thread Safety). - - - La activación de la opción --enable-cares requiere la biblioteca libc-ares. - - - La activación de la opción --enable-zstd requiere la biblioteca libzstd (versión ≥ 1.4.0). - - - La activación de la opción --enable-swoole-sqlite requiere la biblioteca libsqlite. - - - La activación de la opción --enable-swoole-pgsql requiere la biblioteca libpq. - - - La activación de la opción --with-swoole-odbc requiere la biblioteca unixodbc-dev. - - - La activación de la opción --with-swoole-oracle requiere las bibliotecas Oracle Instant Client. - -
    - - -&reference.swoole.configure; - - - -&reference.swoole.ini; - - -
    diff --git a/reference/swoole/swoole.async.xml b/reference/swoole/swoole.async.xml deleted file mode 100644 index 5afdeecab0..0000000000 --- a/reference/swoole/swoole.async.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - La clase Swoole\Async - Swoole\Async - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Async - - - - - Swoole\Async - - - - - &Methods; - - - - -
    - -
    - - &reference.swoole.swoole.entities.async; - -
    - - diff --git a/reference/swoole/swoole.atomic.xml b/reference/swoole/swoole.atomic.xml deleted file mode 100644 index 53983ab748..0000000000 --- a/reference/swoole/swoole.atomic.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - La clase Swoole\Atomic - Swoole\Atomic - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Atomic - - - - - Swoole\Atomic - - - - - &Methods; - - - - -
    - -
    - - &reference.swoole.swoole.entities.atomic; - -
    - - diff --git a/reference/swoole/swoole.buffer.xml b/reference/swoole/swoole.buffer.xml deleted file mode 100644 index 5c13b05847..0000000000 --- a/reference/swoole/swoole.buffer.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - La clase Swoole\Buffer - Swoole\Buffer - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Buffer - - - - - Swoole\Buffer - - - - - &Methods; - - - - -
    - -
    - - &reference.swoole.swoole.entities.buffer; - -
    - - diff --git a/reference/swoole/swoole.channel.xml b/reference/swoole/swoole.channel.xml deleted file mode 100644 index 9fe1e0eb1f..0000000000 --- a/reference/swoole/swoole.channel.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - La clase Swoole\Channel - Swoole\Channel - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Channel - - - - - Swoole\Channel - - - - - &Methods; - - - - -
    - -
    - - &reference.swoole.swoole.entities.channel; - -
    - - diff --git a/reference/swoole/swoole.client.xml b/reference/swoole/swoole.client.xml deleted file mode 100644 index d76d585dbf..0000000000 --- a/reference/swoole/swoole.client.xml +++ /dev/null @@ -1,178 +0,0 @@ - - - - - La clase Swoole\Client - Swoole\Client - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Client - - - - - Swoole\Client - - - - &Constants; - - const - int - Swoole\Client::MSG_OOB - 1 - - - const - int - Swoole\Client::MSG_PEEK - 2 - - - const - int - Swoole\Client::MSG_DONTWAIT - 128 - - - const - int - Swoole\Client::MSG_WAITALL - 64 - - - &Properties; - - public - errCode - - - public - sock - - - public - reuse - - - public - reuseCount - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - errCode - - - - - - sock - - - - - - reuse - - - - - - reuseCount - - - - - -
    - - - -
    - &reftitle.constants; - - - - Swoole\Client::MSG_OOB - - - - - - - Swoole\Client::MSG_PEEK - - - - - - - Swoole\Client::MSG_DONTWAIT - - - - - - - Swoole\Client::MSG_WAITALL - - - - - - -
    - - -
    - - &reference.swoole.swoole.entities.client; - -
    - - diff --git a/reference/swoole/swoole.connection.iterator.xml b/reference/swoole/swoole.connection.iterator.xml deleted file mode 100644 index 01c0846829..0000000000 --- a/reference/swoole/swoole.connection.iterator.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - La clase Swoole\Connection\Iterator - Swoole\Connection\Iterator - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Connection\Iterator - - - - - Swoole\Connection\Iterator - - - - Iterator - - - - Countable - - - - ArrayAccess - - - - - &Methods; - - - - -
    - -
    - - &reference.swoole.swoole.connection.entities.iterator; - -
    - - diff --git a/reference/swoole/swoole.coroutine.client.xml b/reference/swoole/swoole.coroutine.client.xml deleted file mode 100644 index 644d21b2f0..0000000000 --- a/reference/swoole/swoole.coroutine.client.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - La clase Swoole\Coroutine\Client - Swoole\Coroutine\Client - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Coroutine\Client - - - - - Swoole\Coroutine\Client - - - - &Constants; - - const - int - Swoole\Coroutine\Client::MSG_OOB - 1 - - - const - int - Swoole\Coroutine\Client::MSG_PEEK - 2 - - - const - int - Swoole\Coroutine\Client::MSG_DONTWAIT - 128 - - - const - int - Swoole\Coroutine\Client::MSG_WAITALL - 64 - - - &Properties; - - public - errCode - - - public - sock - - - &Methods; - - - -
    - - -
    - &reftitle.properties; - - - errCode - - - - - - sock - - - - - -
    - - - -
    - &reftitle.constants; - - - - Swoole\Coroutine\Client::MSG_OOB - - - - - - - Swoole\Coroutine\Client::MSG_PEEK - - - - - - - Swoole\Coroutine\Client::MSG_DONTWAIT - - - - - - - Swoole\Coroutine\Client::MSG_WAITALL - - - - - - -
    - - -
    - - &reference.swoole.swoole.coroutine.entities.client; - -
    - - diff --git a/reference/swoole/swoole.coroutine.http.client.xml b/reference/swoole/swoole.coroutine.http.client.xml deleted file mode 100644 index 80de8fad9f..0000000000 --- a/reference/swoole/swoole.coroutine.http.client.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - La clase Swoole\Coroutine\Http\Client - Swoole\Coroutine\Http\Client - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Coroutine\Http\Client - - - - - Swoole\Coroutine\Http\Client - - - - &Properties; - - public - errCode - - - public - sock - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - errCode - - - - - - sock - - - - - -
    - - -
    - - &reference.swoole.swoole.coroutine.http.entities.client; - -
    - - diff --git a/reference/swoole/swoole.coroutine.lock.xml b/reference/swoole/swoole.coroutine.lock.xml deleted file mode 100644 index 9bdec77353..0000000000 --- a/reference/swoole/swoole.coroutine.lock.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - La clase Swoole\Coroutine\Lock - Swoole\Coroutine\Lock - - - - -
    - &reftitle.intro; - - Swoole 6.0.1 introdujo un bloqueo de corrutina que admite el uso compartido entre procesos e hilos. - Este bloqueo está diseñado con un comportamiento no bloqueante y permite una sincronización eficiente - de corrutinas en entornos multiproceso y multihilo. - - - Cuando se compila con la opción --enable-iouring y el kernel de Linux admite - la característica io_uring futex, el bloqueo de corrutina de Swoole implementa - la sincronización usando io_uring futex. En este caso, las corrutinas esperan - las activaciones del bloqueo usando un mecanismo de cola eficiente, mejorando significativamente el rendimiento. - - - Sin io_uring futex, el bloqueo de corrutina recurre a un mecanismo de retroceso - exponencial, donde el tiempo de espera aumenta en 2^n milisegundos (siendo n el número de fallos) - después de cada intento fallido de adquirir el bloqueo. Aunque este enfoque evita la espera activa, - introduce una carga adicional de programación de CPU y latencia. - - - El bloqueo de corrutina es reentrante, lo que permite a la corrutina que actualmente lo posee realizar - múltiples operaciones de bloqueo de manera segura. - - - - No cree bloqueos en funciones de retrollamada como onReceive, ya que esto causará - un crecimiento continuo de la memoria y llevará a fugas de memoria. - - - - - El bloqueo y desbloqueo deben realizarse en la misma corrutina, de lo contrario se romperán - las condiciones estáticas. - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Coroutine\Lock - - - - - Swoole\Coroutine\Lock - - - - - &Methods; - - - - -
    - -
    - &reftitle.examples; - - Uso básico - -add(); - $lock->lock(); - sleep(1); - $lock->unlock(); - $waitGroup->done(); - }); - - go(function() use ($lock, $waitGroup) { - $waitGroup->add(); - $lock->lock(); // Espera a que la corrutina que lo posee lo desbloquee - sleep(1); - $lock->unlock(); - $waitGroup->done(); - }); - - echo 'El bloqueo no bloquea el proceso'; - $waitGroup->wait(); -}); -]]> - - -
    - -
    - - &reference.swoole.swoole.coroutine.entities.lock; -
    - - diff --git a/reference/swoole/swoole.coroutine.mysql.exception.xml b/reference/swoole/swoole.coroutine.mysql.exception.xml deleted file mode 100644 index adf5c758aa..0000000000 --- a/reference/swoole/swoole.coroutine.mysql.exception.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - La clase Swoole\Coroutine\MySQL\Exception - Swoole\Coroutine\MySQL\Exception - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Coroutine\MySQL\Exception - - - - - Swoole\Coroutine\MySQL\Exception - - - - extends - Exception - - - - Throwable - - - - &InheritedProperties; - - - - - -
    - -
    - -
    - - diff --git a/reference/swoole/swoole.coroutine.mysql.xml b/reference/swoole/swoole.coroutine.mysql.xml deleted file mode 100644 index a929df7b20..0000000000 --- a/reference/swoole/swoole.coroutine.mysql.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - La clase Swoole\Coroutine\MySQL - Swoole\Coroutine\MySQL - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Coroutine\MySQL - - - - - Swoole\Coroutine\MySQL - - - - &Properties; - - public - sock - - - public - connected - - - public - connect_error - - - public - connect_errno - - - public - affected_rows - - - public - insert_id - - - public - error - - - public - errno - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - sock - - - - - - connected - - - - - - connect_error - - - - - - connect_errno - - - - - - affected_rows - - - - - - insert_id - - - - - - error - - - - - - errno - - - - - -
    - - -
    - - &reference.swoole.swoole.coroutine.entities.mysql; - -
    - - diff --git a/reference/swoole/swoole.coroutine.xml b/reference/swoole/swoole.coroutine.xml deleted file mode 100644 index 1c6d6db717..0000000000 --- a/reference/swoole/swoole.coroutine.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - La clase Swoole\Coroutine - Swoole\Coroutine - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Coroutine - - - - - Swoole\Coroutine - - - - - &Methods; - - - - -
    - -
    - - &reference.swoole.swoole.entities.coroutine; - -
    - - diff --git a/reference/swoole/swoole.event.xml b/reference/swoole/swoole.event.xml deleted file mode 100644 index 941d856c36..0000000000 --- a/reference/swoole/swoole.event.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - La clase Swoole\Event - Swoole\Event - - - - -
    - &reftitle.intro; - - La extensión Swoole proporciona interfaces de bajo nivel para manipular directamente - el bucle de eventos subyacente epoll/kqueue/poll/select. - Permite añadir al EventLoop de Swoole sockets creados por otras extensiones - o por las extensiones stream/socket de PHP. - - - - El módulo Event es de bajo nivel, ya que es un encapsulamiento básico de epoll. - Los usuarios deberían tener experiencia en programación con multiplexación de E/S. - - -
    - - -
    - Prioridad de los eventos - - Funciones de retrollamada de manejo de señales definidas mediante Process::signal - Funciones de retrollamada de temporizador definidas mediante Timer::tick y Timer::after - Funciones de ejecución diferida definidas mediante Event::defer - Funciones de retrollamada periódicas definidas mediante Event::cycle - -
    - -
    - Tipo de socket de eventos de Swoole - - - - - fd - int - - - - Descriptores de fichero, incluyendo Swoole\Client->$sock, Swoole\Process->$pipe, - o cualquier otro descriptor de fichero (fd). - - - - - - stream resource - resource - - - - Recursos creados por stream_socket_client/fsockopen. - - - - - - socket resource - resource - - - - Los recursos creados por socket_create de la extensión sockets requieren - la opción --enable-sockets durante la compilación de Swoole. - - - - - - object - object - - - - Swoole convierte automáticamente Swoole\Process en un UnixSocket y Swoole\Client - en un socket cliente conectado a bajo nivel. - - - - - -
    - -
    - &reftitle.classsynopsis; - - - - Swoole\Event - - - - - Swoole\Event - - - - - &Methods; - - - - -
    - -
    - - &reference.swoole.swoole.entities.event; - -
    - - diff --git a/reference/swoole/swoole.exception.xml b/reference/swoole/swoole.exception.xml deleted file mode 100644 index 4501200fbc..0000000000 --- a/reference/swoole/swoole.exception.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - La clase Swoole\Exception - Swoole\Exception - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Exception - - - - - Swoole\Exception - - - - extends - Exception - - - - Throwable - - - - &InheritedProperties; - - - - - -
    - -
    - -
    - - diff --git a/reference/swoole/swoole.http.client.xml b/reference/swoole/swoole.http.client.xml deleted file mode 100644 index 5d651aa037..0000000000 --- a/reference/swoole/swoole.http.client.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - La clase Swoole\Http\Client - Swoole\Http\Client - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Http\Client - - - - - Swoole\Http\Client - - - - &Properties; - - public - errCode - - - public - sock - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - errCode - - - - - - sock - - - - - -
    - - -
    - - &reference.swoole.swoole.http.entities.client; - -
    - - diff --git a/reference/swoole/swoole.http.request.xml b/reference/swoole/swoole.http.request.xml deleted file mode 100644 index 3b02d65685..0000000000 --- a/reference/swoole/swoole.http.request.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - La clase Swoole\Http\Request - Swoole\Http\Request - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Http\Request - - - - - Swoole\Http\Request - - - - - &Methods; - - - - -
    - -
    - - &reference.swoole.swoole.http.entities.request; - -
    - - diff --git a/reference/swoole/swoole.http.response.xml b/reference/swoole/swoole.http.response.xml deleted file mode 100644 index 71f8181108..0000000000 --- a/reference/swoole/swoole.http.response.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - La clase Swoole\Http\Response - Swoole\Http\Response - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Http\Response - - - - - Swoole\Http\Response - - - - - &Methods; - - - - -
    - -
    - - &reference.swoole.swoole.http.entities.response; - -
    - - diff --git a/reference/swoole/swoole.http.server.xml b/reference/swoole/swoole.http.server.xml deleted file mode 100644 index 046a6b64a5..0000000000 --- a/reference/swoole/swoole.http.server.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - La clase Swoole\Http\Server - Swoole\Http\Server - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Http\Server - - - - - Swoole\Http\Server - - - - extends - Swoole\Server - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.swoole.swoole.http.entities.server; - -
    - - diff --git a/reference/swoole/swoole.lock.xml b/reference/swoole/swoole.lock.xml deleted file mode 100644 index 1fba8c2dad..0000000000 --- a/reference/swoole/swoole.lock.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - La clase Swoole\Lock - Swoole\Lock - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Lock - - - - - Swoole\Lock - - - - - &Methods; - - - - -
    - -
    - - &reference.swoole.swoole.entities.lock; - -
    - - diff --git a/reference/swoole/swoole.mmap.xml b/reference/swoole/swoole.mmap.xml deleted file mode 100644 index 6457bc1f9a..0000000000 --- a/reference/swoole/swoole.mmap.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - La clase Swoole\Mmap - Swoole\Mmap - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Mmap - - - - - Swoole\Mmap - - - - - &Methods; - - - - -
    - -
    - - &reference.swoole.swoole.entities.mmap; - -
    - - diff --git a/reference/swoole/swoole.module.xml b/reference/swoole/swoole.module.xml deleted file mode 100644 index d82f7de3c1..0000000000 --- a/reference/swoole/swoole.module.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - La clase Swoole\Module - Swoole\Module - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Module - - - - - Swoole\Module - - - - - - - -
    - -
    - -
    - - diff --git a/reference/swoole/swoole.mysql.exception.xml b/reference/swoole/swoole.mysql.exception.xml deleted file mode 100644 index f9145144e5..0000000000 --- a/reference/swoole/swoole.mysql.exception.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - La clase Swoole\MySQL\Exception - Swoole\MySQL\Exception - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\MySQL\Exception - - - - - Swoole\MySQL\Exception - - - - extends - Exception - - - - Throwable - - - - &InheritedProperties; - - - - - -
    - -
    - -
    - - diff --git a/reference/swoole/swoole.mysql.xml b/reference/swoole/swoole.mysql.xml deleted file mode 100644 index ce7604dffd..0000000000 --- a/reference/swoole/swoole.mysql.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - La clase Swoole\MySQL - Swoole\MySQL - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\MySQL - - - - - Swoole\MySQL - - - - - &Methods; - - - - -
    - -
    - - &reference.swoole.swoole.entities.mysql; - -
    - - diff --git a/reference/swoole/swoole.process.xml b/reference/swoole/swoole.process.xml deleted file mode 100644 index b2904c4691..0000000000 --- a/reference/swoole/swoole.process.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - La clase Swoole\Process - Swoole\Process - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Process - - - - - Swoole\Process - - - - &Constants; - - const - int - Swoole\Process::IPC_NOWAIT - 256 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - Swoole\Process::IPC_NOWAIT - - - - - - -
    - - -
    - - &reference.swoole.swoole.entities.process; - -
    - - diff --git a/reference/swoole/swoole.redis.server.xml b/reference/swoole/swoole.redis.server.xml deleted file mode 100644 index b09d8e7da1..0000000000 --- a/reference/swoole/swoole.redis.server.xml +++ /dev/null @@ -1,176 +0,0 @@ - - - - - La clase Swoole\Redis\Server - Swoole\Redis\Server - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Redis\Server - - - - - Swoole\Redis\Server - - - - extends - Swoole\Server - - - - &Constants; - - const - int - Swoole\Redis\Server::NIL - 1 - - - const - int - Swoole\Redis\Server::ERROR - 0 - - - const - int - Swoole\Redis\Server::STATUS - 2 - - - const - int - Swoole\Redis\Server::INT - 3 - - - const - int - Swoole\Redis\Server::STRING - 4 - - - const - int - Swoole\Redis\Server::SET - 5 - - - const - int - Swoole\Redis\Server::MAP - 6 - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.constants; - - - - 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 - - - - - - -
    - - -
    - - &reference.swoole.swoole.redis.entities.server; - -
    - - diff --git a/reference/swoole/swoole.runtime.xml b/reference/swoole/swoole.runtime.xml deleted file mode 100644 index 8aa4315cc0..0000000000 --- a/reference/swoole/swoole.runtime.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - La clase Swoole\Runtime - Swoole\Runtime - - - - -
    - &reftitle.intro; - - Swoole\Runtime proporciona soporte de corrutinas para varias funciones PHP a través del mecanismo de hook, - permitiendo que el código síncrono funcione de manera asíncrona en un entorno de corrutinas. - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Runtime - - - - - Swoole\Runtime - - - - - &Methods; - - - - -
    - -
    - - &reference.swoole.swoole.entities.runtime; - -
    - - diff --git a/reference/swoole/swoole.serialize.xml b/reference/swoole/swoole.serialize.xml deleted file mode 100644 index c41ea58090..0000000000 --- a/reference/swoole/swoole.serialize.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - La clase Swoole\Serialize - Swoole\Serialize - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Serialize - - - - - Swoole\Serialize - - - - - &Methods; - - - - -
    - -
    - - &reference.swoole.swoole.entities.serialize; - -
    - - diff --git a/reference/swoole/swoole.server.port.xml b/reference/swoole/swoole.server.port.xml deleted file mode 100644 index 5293944052..0000000000 --- a/reference/swoole/swoole.server.port.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - La clase Swoole\Server\Port - Swoole\Server\Port - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Server\Port - - - - - Swoole\Server\Port - - - - - &Methods; - - - - -
    - -
    - - &reference.swoole.swoole.server.entities.port; - -
    - - diff --git a/reference/swoole/swoole.server.xml b/reference/swoole/swoole.server.xml deleted file mode 100644 index 67858ca656..0000000000 --- a/reference/swoole/swoole.server.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - La clase Swoole\Server - Swoole\Server - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Server - - - - - Swoole\Server - - - - - &Methods; - - - - -
    - -
    - - &reference.swoole.swoole.entities.server; - -
    - - diff --git a/reference/swoole/swoole.table.xml b/reference/swoole/swoole.table.xml deleted file mode 100644 index 3f315eac73..0000000000 --- a/reference/swoole/swoole.table.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - La clase Swoole\Table - Swoole\Table - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Table - - - - - Swoole\Table - - - - Iterator - - - - Countable - - - - &Constants; - - const - int - Swoole\Table::TYPE_INT - 1 - - - const - int - Swoole\Table::TYPE_STRING - 7 - - - const - int - Swoole\Table::TYPE_FLOAT - 6 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - Swoole\Table::TYPE_INT - - - - - - - Swoole\Table::TYPE_STRING - - - - - - - Swoole\Table::TYPE_FLOAT - - - - - - -
    - - -
    - - &reference.swoole.swoole.entities.table; - -
    - - diff --git a/reference/swoole/swoole.timer.xml b/reference/swoole/swoole.timer.xml deleted file mode 100644 index 391f9ec834..0000000000 --- a/reference/swoole/swoole.timer.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - La clase Swoole\Timer - Swoole\Timer - - - - -
    - &reftitle.intro; - - Temporizador con precisión de milisegundos. La implementación subyacente se - basa en epoll_wait y setitimer, con una estructura de datos de montículo - mínimo que permite añadir un gran número de temporizadores. - - - En los procesos con E/S síncrona, como los procesos Manager y TaskWorker, se - implementa mediante setitimer y señales. - - - En los procesos con E/S asíncrona, se implementa mediante el tiempo de - espera de epoll_wait/kevent/poll/select. - - - El sistema subyacente no admite temporizadores con un retardo de - 0; los valores inferiores a 1 - milisegundo emiten un E_WARNING y la llamada falla. - Esto difiere de lenguajes como Node.js. - Swoole\Event::defer - puede utilizarse para obtener una funcionalidad similar. - - -]]> - - - - Corrección del temporizador: el tiempo de ejecución de la función de - retrollamada no afecta al instante de la siguiente ejecución. Por ejemplo, - para un temporizador tick de 10 ms creado en 0,002 s, la primera - retrollamada se ejecuta en 0,012 s; si la función de retrollamada tarda - 5 ms, el siguiente disparo se produce igualmente en 0,022 s, y no en - 0,027 s. - - - En cambio, si la función de retrollamada tarda demasiado, hasta cubrir el - instante de la siguiente ejecución, el sistema subyacente corrige el tiempo: - descarta los disparos vencidos y vuelve a llamar a la función en el - siguiente instante disponible. Por ejemplo, si la retrollamada ejecutada en - 0,012 s tarda 15 ms, lo que retrasa el temporizador previsto para 0,022 s, - la retrollamada se dispara de nuevo en 0,032 s. - - - De forma predeterminada, cuando un temporizador se dispara se crea - automáticamente una corrutina para ejecutar la función de retrollamada. - Este comportamiento puede desactivarse con - swoole_async_set. - - - - Un temporizador solo funciona en el espacio del proceso actual. - - - - - Los temporizadores son puramente asíncronos e incompatibles con las - funciones de E/S síncrona. - - - - - La ejecución de un temporizador puede presentar ligeras desviaciones de - tiempo. - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\Timer - - - - - Swoole\Timer - - - - - &Methods; - - - - -
    - -
    - - &reference.swoole.swoole.entities.timer; - -
    - - diff --git a/reference/swoole/swoole.websocket.frame.xml b/reference/swoole/swoole.websocket.frame.xml deleted file mode 100644 index 6dba6336f0..0000000000 --- a/reference/swoole/swoole.websocket.frame.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - La clase Swoole\WebSocket\Frame - Swoole\WebSocket\Frame - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\WebSocket\Frame - - - - - Swoole\WebSocket\Frame - - - - - &Methods; - - - - -
    - -
    - -
    - - diff --git a/reference/swoole/swoole.websocket.server.xml b/reference/swoole/swoole.websocket.server.xml deleted file mode 100644 index 8861703b47..0000000000 --- a/reference/swoole/swoole.websocket.server.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - La clase Swoole\WebSocket\Server - Swoole\WebSocket\Server - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Swoole\WebSocket\Server - - - - - Swoole\WebSocket\Server - - - - extends - Swoole\Http\Server - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.swoole.swoole.websocket.entities.server; - -
    - - diff --git a/reference/swoole/swoole/async/dnslookup.xml b/reference/swoole/swoole/async/dnslookup.xml deleted file mode 100644 index ed7ac52c73..0000000000 --- a/reference/swoole/swoole/async/dnslookup.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Swoole\Async::dnsLookup - Busca de manera asíncrona y no bloqueante la dirección IP de un host. - - - - &reftitle.description; - - public static voidSwoole\Async::dnsLookup - stringhostname - callablecallback - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - hostname - - - El nombre de host. - - - - - callback - - - mixedcallback - stringhostname - stringip - - - - hostname - - - El nombre de host. - - - - - IP - - - La dirección IP. - - - - - - - - - - - - diff --git a/reference/swoole/swoole/async/read.xml b/reference/swoole/swoole/async/read.xml deleted file mode 100644 index 59324c2a26..0000000000 --- a/reference/swoole/swoole/async/read.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - Swoole\Async::read - Lee de manera asíncrona un flujo de fichero. - - - - &reftitle.description; - - public static boolSwoole\Async::read - stringfilename - callablecallback - intchunk_size - intoffset - - - - - - - - - &reftitle.parameters; - - - filename - - - El nombre del fichero. - - - - - callback - - - mixedcallback - stringfilename - stringcontent - - - - filename - - - El nombre del fichero. - - - - - content - - - El contenido leído desde el flujo de fichero. - - - - - - - - chunk_size - - - El tamaño del fragmento. - - - - - offset - - - El desplazamiento. - - - - - - - - &reftitle.returnvalues; - - Si la lectura tiene éxito. - - - - - - diff --git a/reference/swoole/swoole/async/readfile.xml b/reference/swoole/swoole/async/readfile.xml deleted file mode 100644 index 1a6fcdfbbf..0000000000 --- a/reference/swoole/swoole/async/readfile.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - Swoole\Async::readFile - Lee un fichero de manera asíncrona. - - - - &reftitle.description; - - public static voidSwoole\Async::readFile - stringfilename - callablecallback - - - - - - - - - &reftitle.parameters; - - - filename - - - El nombre del fichero a leer. - - - - - callback - - - mixedcallback - stringfilename - stringcontent - - - - filename - - - El nombre del fichero. - - - - - content - - - El contenido leído desde el fichero. - - - - - - - - - - - - diff --git a/reference/swoole/swoole/async/set.xml b/reference/swoole/swoole/async/set.xml deleted file mode 100644 index dbae837867..0000000000 --- a/reference/swoole/swoole/async/set.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Async::set - Actualiza las opciones de E/S asíncrona. - - - - &reftitle.description; - - public static voidSwoole\Async::set - arraysettings - - - - - - - - - &reftitle.parameters; - - - settings - - - - - - - - - - - - diff --git a/reference/swoole/swoole/async/write.xml b/reference/swoole/swoole/async/write.xml deleted file mode 100644 index ef0d9c6ae2..0000000000 --- a/reference/swoole/swoole/async/write.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Swoole\Async::write - Escribe de manera asíncrona datos en un flujo de fichero. - - - - &reftitle.description; - - public static voidSwoole\Async::write - stringfilename - stringcontent - intoffset - callablecallback - - - - - - - - - &reftitle.parameters; - - - filename - - - El nombre del fichero en el cual escribir. - - - - - content - - - El contenido a escribir en el fichero. - - - - - offset - - - El desplazamiento. - - - - - callback - - - - - - - - - - - - diff --git a/reference/swoole/swoole/async/writefile.xml b/reference/swoole/swoole/async/writefile.xml deleted file mode 100644 index 56cce5bc01..0000000000 --- a/reference/swoole/swoole/async/writefile.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Swoole\Async::writeFile - Descripción - - - - &reftitle.description; - - public static voidSwoole\Async::writeFile - stringfilename - stringcontent - callablecallback - stringflags - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - filename - - - El nombre del fichero a escribir. - - - - - content - - - El contenido a escribir en el fichero. - - - - - callback - - - - - - - - flags - - - - - - - - - - - - diff --git a/reference/swoole/swoole/atomic/add.xml b/reference/swoole/swoole/atomic/add.xml deleted file mode 100644 index 413969d5b4..0000000000 --- a/reference/swoole/swoole/atomic/add.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Atomic::add - Añade un número al valor del objeto atómico. - - - - &reftitle.description; - - public intSwoole\Atomic::add - intadd_value - - - Añade un número al valor del objeto atómico. - - - - - - &reftitle.parameters; - - - add_value - - - El valor que será añadido al valor actual. - - - - - - - - &reftitle.returnvalues; - - El nuevo valor del objeto atómico. - - - - - - diff --git a/reference/swoole/swoole/atomic/cmpset.xml b/reference/swoole/swoole/atomic/cmpset.xml deleted file mode 100644 index f388d2605f..0000000000 --- a/reference/swoole/swoole/atomic/cmpset.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - Swoole\Atomic::cmpset - Compara y define el valor del objeto atómico. - - - - &reftitle.description; - - public intSwoole\Atomic::cmpset - intcmp_value - intnew_value - - - - - - - - - &reftitle.parameters; - - - cmp_value - - - El valor a comparar con el valor actual del objeto atómico. - - - - - new_value - - - El valor a definir en el objeto atómico si el valor de cmp_value es el mismo que el valor actual del - objeto atómico. - - - - - - - - &reftitle.returnvalues; - - El nuevo valor del objeto atómico. - - - - - - diff --git a/reference/swoole/swoole/atomic/construct.xml b/reference/swoole/swoole/atomic/construct.xml deleted file mode 100644 index d567c2fc3c..0000000000 --- a/reference/swoole/swoole/atomic/construct.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Swoole\Atomic::__construct - Construye un nuevo objeto atómico Swoole. - - - - &reftitle.description; - - public Swoole\Atomic::__construct - intvalue - - - Un objeto atómico Swoole es una variable entera que permite a cualquier procesador probar y modificar de manera atómica. - Se implementa sobre la base de las instrucciones atómicas del procesador. Las variables atómicas Swoole deben definirse antes - de que se llame a swoole_server->start. - - - - Compare-and-swap (CAS) es una instrucción atómica utilizada en el multithreading para realizar la sincronización. - Compara el contenido de una ubicación de memoria con un valor dado y, solo si son idénticos, - modifica el contenido de esa ubicación de memoria a un nuevo valor dado. - - - - - - &reftitle.parameters; - - - value - - - El valor del objeto atómico. - - - - - - - - - diff --git a/reference/swoole/swoole/atomic/get.xml b/reference/swoole/swoole/atomic/get.xml deleted file mode 100644 index d584f9978c..0000000000 --- a/reference/swoole/swoole/atomic/get.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Atomic::get - Devuelve el valor actual del objeto atómico. - - - - &reftitle.description; - - public intSwoole\Atomic::get - - - - Devuelve el valor actual del objeto atómico. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El valor actual del objeto atómico. - - - - - - diff --git a/reference/swoole/swoole/atomic/set.xml b/reference/swoole/swoole/atomic/set.xml deleted file mode 100644 index aea8837287..0000000000 --- a/reference/swoole/swoole/atomic/set.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - Swoole\Atomic::set - Define un nuevo valor para el objeto atómico. - - - - &reftitle.description; - - public intSwoole\Atomic::set - intvalue - - - Define un nuevo valor para el objeto atómico. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - value - - - El valor a definir para el objeto atómico. - - - - - - - - &reftitle.returnvalues; - - El nuevo valor del objeto atómico. - - - - - - diff --git a/reference/swoole/swoole/atomic/sub.xml b/reference/swoole/swoole/atomic/sub.xml deleted file mode 100644 index 13735d2313..0000000000 --- a/reference/swoole/swoole/atomic/sub.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Atomic::sub - Sustrae un número del valor del objeto atómico. - - - - &reftitle.description; - - public intSwoole\Atomic::sub - intsub_value - - - Sustrae un número del valor del objeto atómico. - - - - - - &reftitle.parameters; - - - sub_value - - - El valor que será sustraído del valor actual. - - - - - - - - &reftitle.returnvalues; - - El nuevo valor del objeto atómico. - - - - - - diff --git a/reference/swoole/swoole/buffer/append.xml b/reference/swoole/swoole/buffer/append.xml deleted file mode 100644 index 92b6addbcf..0000000000 --- a/reference/swoole/swoole/buffer/append.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Buffer::append - Añade la string o los datos binarios al final del buffer de memoria y devuelve el nuevo tamaño de la memoria asignada. - - - - &reftitle.description; - - public intSwoole\Buffer::append - stringdata - - - - - - - - - &reftitle.parameters; - - - data - - - La string o los datos binarios a añadir al final del buffer de memoria. - - - - - - - - &reftitle.returnvalues; - - El nuevo tamaño del buffer de memoria. - - - - - - diff --git a/reference/swoole/swoole/buffer/clear.xml b/reference/swoole/swoole/buffer/clear.xml deleted file mode 100644 index 47323061bb..0000000000 --- a/reference/swoole/swoole/buffer/clear.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - Swoole\Buffer::clear - Reinicializa el búfer de memoria. - - - - &reftitle.description; - - public voidSwoole\Buffer::clear - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/swoole/swoole/buffer/construct.xml b/reference/swoole/swoole/buffer/construct.xml deleted file mode 100644 index 6b73280ee0..0000000000 --- a/reference/swoole/swoole/buffer/construct.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - Swoole\Buffer::__construct - Asignación de bloques de memoria de tamaño fijo. - - - - &reftitle.description; - - public Swoole\Buffer::__construct - intsize - - - - - - - - - &reftitle.parameters; - - - size - - - El tamaño de la memoria a asignar. - - - - - - - - - - - diff --git a/reference/swoole/swoole/buffer/destruct.xml b/reference/swoole/swoole/buffer/destruct.xml deleted file mode 100644 index 785b0dfeb3..0000000000 --- a/reference/swoole/swoole/buffer/destruct.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - Swoole\Buffer::__destruct - Destruye el buffer de memoria Swoole. - - - - &reftitle.description; - - public voidSwoole\Buffer::__destruct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/swoole/swoole/buffer/expand.xml b/reference/swoole/swoole/buffer/expand.xml deleted file mode 100644 index 587fef237f..0000000000 --- a/reference/swoole/swoole/buffer/expand.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Buffer::expand - Amplía el tamaño del búfer de memoria. - - - - &reftitle.description; - - public intSwoole\Buffer::expand - intsize - - - - - - - - - &reftitle.parameters; - - - size - - - El nuevo tamaño del búfer de memoria. - - - - - - - - &reftitle.returnvalues; - - El nuevo tamaño del búfer de memoria. - - - - - - diff --git a/reference/swoole/swoole/buffer/read.xml b/reference/swoole/swoole/buffer/read.xml deleted file mode 100644 index 4e74c9c9c3..0000000000 --- a/reference/swoole/swoole/buffer/read.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Swoole\Buffer::read - Lee los datos del búfer de memoria en función del desplazamiento y la longitud. - - - - &reftitle.description; - - public stringSwoole\Buffer::read - intoffset - intlength - - - - - - - - - &reftitle.parameters; - - - offset - - - El desplazamiento. - - - - - length - - - La longitud. - - - - - - - - &reftitle.returnvalues; - - Los datos leídos del búfer de memoria. - - - - - - diff --git a/reference/swoole/swoole/buffer/recycle.xml b/reference/swoole/swoole/buffer/recycle.xml deleted file mode 100644 index 497fe635a7..0000000000 --- a/reference/swoole/swoole/buffer/recycle.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - Swoole\Buffer::recycle - Libera la memoria al SO que no es utilizada por el buffer de memoria. - - - - &reftitle.description; - - public voidSwoole\Buffer::recycle - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/swoole/swoole/buffer/substr.xml b/reference/swoole/swoole/buffer/substr.xml deleted file mode 100644 index f63cab4ce5..0000000000 --- a/reference/swoole/swoole/buffer/substr.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Swoole\Buffer::substr - Lee los datos del búfer de memoria en función del desplazamiento y la longitud. O elimina los datos del búfer de memoria. - - - - &reftitle.description; - - public stringSwoole\Buffer::substr - intoffset - intlength - boolremove - - - Si $remove está definido como true y $offset está definido como 0, los datos serán eliminados del búfer. - La memoria para almacenar los datos será liberada cuando el objeto búfer sea destruido. - - - - - - &reftitle.parameters; - - - offset - - - El desplazamiento. - - - - - length - - - La longitud. - - - - - remove - - - Si los datos deben ser eliminados del búfer. - - - - - - - - &reftitle.returnvalues; - - Los datos leídos del búfer de memoria. - - - - - - diff --git a/reference/swoole/swoole/buffer/tostring.xml b/reference/swoole/swoole/buffer/tostring.xml deleted file mode 100644 index da1f1cdba8..0000000000 --- a/reference/swoole/swoole/buffer/tostring.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Buffer::__toString - Devuelve el valor de la string del búfer de memoria. - - - - &reftitle.description; - - public stringSwoole\Buffer::__toString - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El valor de la string del búfer de memoria. - - - - - - diff --git a/reference/swoole/swoole/buffer/write.xml b/reference/swoole/swoole/buffer/write.xml deleted file mode 100644 index a0d55f785b..0000000000 --- a/reference/swoole/swoole/buffer/write.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Swoole\Buffer::write - Escribe datos en el buffer de memoria. La memoria asignada para el buffer no será modificada. - - - - &reftitle.description; - - public voidSwoole\Buffer::write - intoffset - stringdata - - - - - - - - - &reftitle.parameters; - - - offset - - - El desplazamiento. - - - - - data - - - Los datos a escribir en el buffer de memoria. - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/channel/construct.xml b/reference/swoole/swoole/channel/construct.xml deleted file mode 100644 index d217f264c8..0000000000 --- a/reference/swoole/swoole/channel/construct.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - Swoole\Channel::__construct - Construye un canal Swoole - - - - &reftitle.description; - - public Swoole\Channel::__construct - stringsize - - - Un canal Swoole es una estructura de datos en memoria que funciona como Chan en Golang, implementada sobre la base de - memoria compartida y cerrojos mutex. Puede ser utilizado como una cola de mensajes de alto rendimiento en memoria. - Construye un canal swoole con un tamaño fijo. El tamaño mínimo de un canal swoole es de 64 Ko. - Se lanzarán excepciones si no hay suficiente memoria. - - - - - - &reftitle.parameters; - - - size - - - El tamaño del canal Swoole. - - - - - - - - - diff --git a/reference/swoole/swoole/channel/destruct.xml b/reference/swoole/swoole/channel/destruct.xml deleted file mode 100644 index 6499aea27b..0000000000 --- a/reference/swoole/swoole/channel/destruct.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - Swoole\Channel::__destruct - Destruye un canal Swoole. - - - - &reftitle.description; - - public voidSwoole\Channel::__destruct - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/swoole/swoole/channel/pop.xml b/reference/swoole/swoole/channel/pop.xml deleted file mode 100644 index 6e1c7a6f6f..0000000000 --- a/reference/swoole/swoole/channel/pop.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Channel::pop - Lee y extrae datos del canal swoole. - - - - &reftitle.description; - - public mixedSwoole\Channel::pop - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Si el canal está vacío, la función devolverá false, o devolverá los datos deserializados. - - - - - - diff --git a/reference/swoole/swoole/channel/push.xml b/reference/swoole/swoole/channel/push.xml deleted file mode 100644 index 006a2dd9d9..0000000000 --- a/reference/swoole/swoole/channel/push.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - Swoole\Channel::push - Escribe y empuja datos en el canal Swoole. - - - - &reftitle.description; - - public boolSwoole\Channel::push - stringdata - - - Los datos pueden ser cualquier variable PHP no vacía, la variable será serializada si no es de tipo string. - - - Si el tamaño de los datos es superior a 8 Ko, el canal swoole utilizará un almacenamiento de ficheros temporales. - - - La función devolverá true si la operación de escritura es exitosa, o devolverá false si no hay suficiente espacio. - - - - - - &reftitle.parameters; - - - data - - - Los datos a empujar en el canal Swoole. - - - - - - - - &reftitle.returnvalues; - - Si los datos son empujados en el canal Swoole. - - - - - - diff --git a/reference/swoole/swoole/channel/stats.xml b/reference/swoole/swoole/channel/stats.xml deleted file mode 100644 index e964ded1bc..0000000000 --- a/reference/swoole/swoole/channel/stats.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Channel::stats - Devuelve las estadísticas del canal Swoole. - - - - &reftitle.description; - - public arraySwoole\Channel::stats - - - - Devuelve el número de elementos en espera y el tamaño total de la memoria utilizada por la cola. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Las estadísticas del canal Swoole. - - - - - - diff --git a/reference/swoole/swoole/client/close.xml b/reference/swoole/swoole/client/close.xml deleted file mode 100644 index d870ecb25d..0000000000 --- a/reference/swoole/swoole/client/close.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Client::close - Cierra la conexión establecida. - - - - &reftitle.description; - - public boolSwoole\Client::close - boolforce - - - - - - - - - &reftitle.parameters; - - - force - - - Forzar o no el cierre de la conexión. - - - - - - - - &reftitle.returnvalues; - - Si la conexión es cerrada. - - - - - - diff --git a/reference/swoole/swoole/client/connect.xml b/reference/swoole/swoole/client/connect.xml deleted file mode 100644 index b6d86f1d0b..0000000000 --- a/reference/swoole/swoole/client/connect.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - Swoole\Client::connect - Conecta al puerto TCP o UDP remoto. - - - - &reftitle.description; - - public boolSwoole\Client::connect - stringhost - intport - inttimeout - intflag - - - - - - - - - &reftitle.parameters; - - - host - - - El nombre de host de la dirección remota. - - - - - port - - - El número de puerto de la dirección remota. - - - - - timeout - - - El tiempo de espera (en segundos) de conexión/envío/recepción, el valor por omisión es de 0,1 s. - - - - - flag - - - Si el tipo de cliente es UDP, el $flag indica si se debe activar la configuración udp_connect. - Si la configuración udp_connect está activada, el cliente solo recibirá los datos de la ip:puerto especificada. - Si el tipo de cliente es TCP y el $flag está definido en 1, se debe utilizar swoole_client_select para verificar el estado de la conexión antes de enviar/recibir. - - - - - - - - &reftitle.returnvalues; - - Si la conexión es establecida. - - - - - - diff --git a/reference/swoole/swoole/client/construct.xml b/reference/swoole/swoole/client/construct.xml deleted file mode 100644 index fbd0007b57..0000000000 --- a/reference/swoole/swoole/client/construct.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - Swoole\Client::__construct - Crea un cliente TCP/UDP síncrono o asíncrono Swoole, con o sin SSL. - - - - &reftitle.description; - - public Swoole\Client::__construct - intsock_type - intis_async - - - - - - - - - &reftitle.parameters; - - - sock_type - - - El tipo de socket: SWOOLE_TCP, SWOOLE_UDP, SWOOLE_ASYNC, SWOOLE_SSL, SWOOLE_KEEP. - - - - - is_async - - - Cliente síncrono o asíncrono. - - - - - - - - - diff --git a/reference/swoole/swoole/client/destruct.xml b/reference/swoole/swoole/client/destruct.xml deleted file mode 100644 index 8755fa40ae..0000000000 --- a/reference/swoole/swoole/client/destruct.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - Swoole\Client::__destruct - Destruye el cliente Swoole. - - - - &reftitle.description; - - public voidSwoole\Client::__destruct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/swoole/swoole/client/getpeername.xml b/reference/swoole/swoole/client/getpeername.xml deleted file mode 100644 index 56e4a20aef..0000000000 --- a/reference/swoole/swoole/client/getpeername.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Client::getpeername - Devuelve el nombre del socket remoto de la conexión. - - - - &reftitle.description; - - public arraySwoole\Client::getpeername - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El host y el puerto del socket remoto. - - - - - - diff --git a/reference/swoole/swoole/client/getsockname.xml b/reference/swoole/swoole/client/getsockname.xml deleted file mode 100644 index 45707b614f..0000000000 --- a/reference/swoole/swoole/client/getsockname.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Client::getsockname - Devuelve el nombre del socket local de la conexión. - - - - &reftitle.description; - - public arraySwoole\Client::getsockname - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El host y el puerto del socket local. - - - - - - diff --git a/reference/swoole/swoole/client/isconnected.xml b/reference/swoole/swoole/client/isconnected.xml deleted file mode 100644 index 102e1b96a1..0000000000 --- a/reference/swoole/swoole/client/isconnected.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Client::isConnected - Verifica si la conexión está establecida. - - - - &reftitle.description; - - public boolSwoole\Client::isConnected - - - - Este método devuelve el estado de la conexión de la capa de aplicación. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Si la conexión está establecida. - - - - - - diff --git a/reference/swoole/swoole/client/on.xml b/reference/swoole/swoole/client/on.xml deleted file mode 100644 index e76092d1f0..0000000000 --- a/reference/swoole/swoole/client/on.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - Swoole\Client::on - Añade funciones de retrollamada desencadenadas por eventos. - - - - &reftitle.description; - - public voidSwoole\Client::on - stringevent - callablecallback - - - - - - - - - &reftitle.parameters; - - - event - - - - - - - - callback - - - - - - - - - - - - diff --git a/reference/swoole/swoole/client/pause.xml b/reference/swoole/swoole/client/pause.xml deleted file mode 100644 index 300cceab25..0000000000 --- a/reference/swoole/swoole/client/pause.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - Swoole\Client::pause - Pone en pausa la recepción de datos. - - - - &reftitle.description; - - public voidSwoole\Client::pause - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/swoole/swoole/client/pipe.xml b/reference/swoole/swoole/client/pipe.xml deleted file mode 100644 index 842b138fe4..0000000000 --- a/reference/swoole/swoole/client/pipe.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Client::pipe - Redirige los datos hacia otro descriptor de fichero. - - - - &reftitle.description; - - public voidSwoole\Client::pipe - stringsocket - - - - - - - - - &reftitle.parameters; - - - socket - - - - - - - - - - - - diff --git a/reference/swoole/swoole/client/recv.xml b/reference/swoole/swoole/client/recv.xml deleted file mode 100644 index 4ee9c5e9dd..0000000000 --- a/reference/swoole/swoole/client/recv.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - Swoole\Client::recv - Recibe datos del socket remoto. - - - - &reftitle.description; - - public voidSwoole\Client::recv - stringsize - stringflag - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - size - - - - - - - - flag - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/client/resume.xml b/reference/swoole/swoole/client/resume.xml deleted file mode 100644 index 20f78bcf52..0000000000 --- a/reference/swoole/swoole/client/resume.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - Swoole\Client::resume - Reanuda la recepción de datos. - - - - &reftitle.description; - - public voidSwoole\Client::resume - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/swoole/swoole/client/send.xml b/reference/swoole/swoole/client/send.xml deleted file mode 100644 index 7418a5fe3f..0000000000 --- a/reference/swoole/swoole/client/send.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - Swoole\Client::send - Envía datos al socket TCP remoto. - - - - &reftitle.description; - - public intSwoole\Client::send - stringdata - stringflag - - - - - - - - - &reftitle.parameters; - - - data - - - Los datos a enviar que pueden ser una string o binarios. - - - - - flag - - - - - - - - - - - &reftitle.returnvalues; - - Si el cliente envía datos con éxito, devuelve la longitud de los datos enviados. - O devuelve false y define $swoole_client->errCode. Para el cliente síncrono, - no hay límite para los datos a enviar. Para el cliente asíncrono, el límite - para los datos a enviar es socket_buffer_size. - - - - - - diff --git a/reference/swoole/swoole/client/sendfile.xml b/reference/swoole/swoole/client/sendfile.xml deleted file mode 100644 index 1720dd2d02..0000000000 --- a/reference/swoole/swoole/client/sendfile.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Swoole\Client::sendfile - Envía un fichero al socket TCP remoto. - - - - &reftitle.description; - - public boolSwoole\Client::sendfile - stringfilename - intoffset - - - Esto es una envoltura de la llamada al sistema sendfile de Linux. - - - - - - &reftitle.parameters; - - - filename - - - La ruta del fichero a enviar. - - - - - offset - - - El desplazamiento del fichero a enviar. - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/client/sendto.xml b/reference/swoole/swoole/client/sendto.xml deleted file mode 100644 index c0214f6425..0000000000 --- a/reference/swoole/swoole/client/sendto.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - Swoole\Client::sendto - Envía datos a la dirección UDP remota. - - - - &reftitle.description; - - public boolSwoole\Client::sendto - stringip - intport - stringdata - - - El cliente swoole debe ser de tipo SWOOLE_SOCK_UDP o SWOOLE_SOCK_UDP6. - - - - - - &reftitle.parameters; - - - ip - - - La dirección IP del host remoto, IPv4 o IPv6. - - - - - port - - - El número de puerto del host remoto. - - - - - data - - - Los datos a enviar que deben ser inferiores a 64K. - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/client/set.xml b/reference/swoole/swoole/client/set.xml deleted file mode 100644 index 2cde27b0f5..0000000000 --- a/reference/swoole/swoole/client/set.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Client::set - Define los parámetros del cliente Swoole antes de que la conexión sea establecida. - - - - &reftitle.description; - - public voidSwoole\Client::set - arraysettings - - - - - - - - - &reftitle.parameters; - - - settings - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/client/sleep.xml b/reference/swoole/swoole/client/sleep.xml deleted file mode 100644 index 301faf07a7..0000000000 --- a/reference/swoole/swoole/client/sleep.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Client::sleep - Elimina el cliente TCP del bucle de eventos del sistema. - - - - &reftitle.description; - - public voidSwoole\Client::sleep - - - - Elimina el cliente TCP del bucle de eventos del sistema. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/client/wakeup.xml b/reference/swoole/swoole/client/wakeup.xml deleted file mode 100644 index 53cb6c2489..0000000000 --- a/reference/swoole/swoole/client/wakeup.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Client::wakeup - Añade el cliente TCP al ciclo de eventos del sistema. - - - - &reftitle.description; - - public voidSwoole\Client::wakeup - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/connection/iterator/count.xml b/reference/swoole/swoole/connection/iterator/count.xml deleted file mode 100644 index 935de473b4..0000000000 --- a/reference/swoole/swoole/connection/iterator/count.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Connection\Iterator::count - Cuenta las conexiones. - - - - &reftitle.description; - - public intSwoole\Connection\Iterator::count - - - - Devuelve el número de conexiones. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El número de conexiones. - - - - - - diff --git a/reference/swoole/swoole/connection/iterator/current.xml b/reference/swoole/swoole/connection/iterator/current.xml deleted file mode 100644 index 10b0f93b5b..0000000000 --- a/reference/swoole/swoole/connection/iterator/current.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Connection\Iterator::current - Devuelve la entrada de conexión actual. - - - - &reftitle.description; - - public ConnectionSwoole\Connection\Iterator::current - - - - Devuelve la entrada de conexión actual. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La entrada de conexión actual. - - - - - - diff --git a/reference/swoole/swoole/connection/iterator/key.xml b/reference/swoole/swoole/connection/iterator/key.xml deleted file mode 100644 index 67424bdf45..0000000000 --- a/reference/swoole/swoole/connection/iterator/key.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Connection\Iterator::key - Devuelve la clave de la conexión actual. - - - - &reftitle.description; - - public intSwoole\Connection\Iterator::key - - - - Esta función devuelve la clave de la conexión actual. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La clave de la conexión actual. - - - - - - diff --git a/reference/swoole/swoole/connection/iterator/next.xml b/reference/swoole/swoole/connection/iterator/next.xml deleted file mode 100644 index c1cce9952c..0000000000 --- a/reference/swoole/swoole/connection/iterator/next.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Connection\Iterator::next - Se desplaza hacia la siguiente conexión. - - - - &reftitle.description; - - public ConnectionSwoole\Connection\Iterator::next - - - - El iterador se desplaza hacia la siguiente conexión. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/connection/iterator/offsetexists.xml b/reference/swoole/swoole/connection/iterator/offsetexists.xml deleted file mode 100644 index 1172a64067..0000000000 --- a/reference/swoole/swoole/connection/iterator/offsetexists.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Connection\Iterator::offsetExists - Verifica si una posición existe. - - - - &reftitle.description; - - public boolSwoole\Connection\Iterator::offsetExists - intindex - - - Verifica si una posición existe. - - - - - - &reftitle.parameters; - - - index - - - La posición a verificar. - - - - - - - - &reftitle.returnvalues; - - Devuelve TRUE si la posición existe, FALSE en caso contrario. - - - - - - diff --git a/reference/swoole/swoole/connection/iterator/offsetget.xml b/reference/swoole/swoole/connection/iterator/offsetget.xml deleted file mode 100644 index 15b816da24..0000000000 --- a/reference/swoole/swoole/connection/iterator/offsetget.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Connection\Iterator::offsetGet - Posición a recuperar. - - - - &reftitle.description; - - public ConnectionSwoole\Connection\Iterator::offsetGet - stringindex - - - Devuelve la conexión en la posición especificada. - - - - - - &reftitle.parameters; - - - index - - - La posición a recuperar. - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/connection/iterator/offsetset.xml b/reference/swoole/swoole/connection/iterator/offsetset.xml deleted file mode 100644 index d7d15dd2db..0000000000 --- a/reference/swoole/swoole/connection/iterator/offsetset.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Swoole\Connection\Iterator::offsetSet - Asigna una conexión a la posición especificada. - - - - &reftitle.description; - - public voidSwoole\Connection\Iterator::offsetSet - intoffset - mixedconnection - - - Asigna una conexión a la posición especificada. - - - - - - &reftitle.parameters; - - - offset - - - La posición a la cual asignar la conexión. - - - - - connection - - - La conexión a asignar. - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/connection/iterator/offsetunset.xml b/reference/swoole/swoole/connection/iterator/offsetunset.xml deleted file mode 100644 index a15c5f6ed4..0000000000 --- a/reference/swoole/swoole/connection/iterator/offsetunset.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Connection\Iterator::offsetUnset - Elimina una posición. - - - - &reftitle.description; - - public voidSwoole\Connection\Iterator::offsetUnset - intoffset - - - Elimina una posición. - - - - - - &reftitle.parameters; - - - offset - - - La posición a eliminar. - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/connection/iterator/rewind.xml b/reference/swoole/swoole/connection/iterator/rewind.xml deleted file mode 100644 index 464d41467e..0000000000 --- a/reference/swoole/swoole/connection/iterator/rewind.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Connection\Iterator::rewind - Reinicializa el iterador. - - - - &reftitle.description; - - public voidSwoole\Connection\Iterator::rewind - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/connection/iterator/valid.xml b/reference/swoole/swoole/connection/iterator/valid.xml deleted file mode 100644 index ec3498bb9a..0000000000 --- a/reference/swoole/swoole/connection/iterator/valid.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Connection\Iterator::valid - Verifica si la posición actual es válida. - - - - &reftitle.description; - - public boolSwoole\Connection\Iterator::valid - - - - Verifica si la posición actual es válida. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve TRUE si la posición actual es válida, FALSE en caso contrario. - - - - - - diff --git a/reference/swoole/swoole/coroutine/call-user-func-array.xml b/reference/swoole/swoole/coroutine/call-user-func-array.xml deleted file mode 100644 index fd905c8b0e..0000000000 --- a/reference/swoole/swoole/coroutine/call-user-func-array.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - Swoole\Coroutine::call_user_func_array - Llama a una función de retrollamada con un array de argumentos - - - - &reftitle.description; - - public static mixedSwoole\Coroutine::call_user_func_array - callablecallback - arrayparam_array - - - Llama a la función de retrollamada dada por el primer argumento con los argumentos en param_array. - - - - - - &reftitle.parameters; - - - - callback - - - El callable a llamar. - - - - - param_array - - - Cero o más argumentos en el array a pasar a la función de retrollamada. - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/call-user-func.xml b/reference/swoole/swoole/coroutine/call-user-func.xml deleted file mode 100644 index 1432389a3e..0000000000 --- a/reference/swoole/swoole/coroutine/call-user-func.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - Swoole\Coroutine::call_user_func - Llama a una función de retrollamada dada por el primer argumento - - - - &reftitle.description; - - public static mixedSwoole\Coroutine::call_user_func - callablecallback - mixedargs - - - Llama al callback dado por el primer argumento y pasa los argumentos restantes como argumentos. - - - - - - &reftitle.parameters; - - - - callback - - - El callable a llamar. - - - - - args - - - Cero o más argumentos a pasar a la función de retrollamada. - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/cli-wait.xml b/reference/swoole/swoole/coroutine/cli-wait.xml deleted file mode 100644 index c2a8e8ddfd..0000000000 --- a/reference/swoole/swoole/coroutine/cli-wait.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Coroutine::cli_wait - Descripción - - - - &reftitle.description; - - public static ReturnTypeSwoole\Coroutine::cli_wait - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/client/close.xml b/reference/swoole/swoole/coroutine/client/close.xml deleted file mode 100644 index 0b0ba4fa05..0000000000 --- a/reference/swoole/swoole/coroutine/client/close.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\Client::close - Descripción - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Client::close - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/client/connect.xml b/reference/swoole/swoole/coroutine/client/connect.xml deleted file mode 100644 index ec1fc4307e..0000000000 --- a/reference/swoole/swoole/coroutine/client/connect.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\Client::connect - Descripción - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Client::connect - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/client/construct.xml b/reference/swoole/swoole/coroutine/client/construct.xml deleted file mode 100644 index 62c90bf091..0000000000 --- a/reference/swoole/swoole/coroutine/client/construct.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - Swoole\Coroutine\Client::__construct - Descripción - - - - &reftitle.description; - - public Swoole\Coroutine\Client::__construct - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - - diff --git a/reference/swoole/swoole/coroutine/client/destruct.xml b/reference/swoole/swoole/coroutine/client/destruct.xml deleted file mode 100644 index 10417f7d8e..0000000000 --- a/reference/swoole/swoole/coroutine/client/destruct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\Client::__destruct - Descripción - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Client::__destruct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/client/getpeername.xml b/reference/swoole/swoole/coroutine/client/getpeername.xml deleted file mode 100644 index b46779770e..0000000000 --- a/reference/swoole/swoole/coroutine/client/getpeername.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\Client::getpeername - Descripción - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Client::getpeername - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/client/getsockname.xml b/reference/swoole/swoole/coroutine/client/getsockname.xml deleted file mode 100644 index 1fa07d74cc..0000000000 --- a/reference/swoole/swoole/coroutine/client/getsockname.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\Client::getsockname - Descripción - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Client::getsockname - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/client/isconnected.xml b/reference/swoole/swoole/coroutine/client/isconnected.xml deleted file mode 100644 index 2fd8987d67..0000000000 --- a/reference/swoole/swoole/coroutine/client/isconnected.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\Client::isConnected - Descripción - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Client::isConnected - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/client/recv.xml b/reference/swoole/swoole/coroutine/client/recv.xml deleted file mode 100644 index 2fb24ffd0d..0000000000 --- a/reference/swoole/swoole/coroutine/client/recv.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\Client::recv - Descripción - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Client::recv - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/client/send.xml b/reference/swoole/swoole/coroutine/client/send.xml deleted file mode 100644 index ef9a3e01a9..0000000000 --- a/reference/swoole/swoole/coroutine/client/send.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\Client::send - Descripción - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Client::send - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/client/sendfile.xml b/reference/swoole/swoole/coroutine/client/sendfile.xml deleted file mode 100644 index 48fd6446b0..0000000000 --- a/reference/swoole/swoole/coroutine/client/sendfile.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\Client::sendfile - Descripción - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Client::sendfile - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/client/sendto.xml b/reference/swoole/swoole/coroutine/client/sendto.xml deleted file mode 100644 index a8f12afc35..0000000000 --- a/reference/swoole/swoole/coroutine/client/sendto.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\Client::sendto - Descripción - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Client::sendto - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/client/set.xml b/reference/swoole/swoole/coroutine/client/set.xml deleted file mode 100644 index de3abf6eaa..0000000000 --- a/reference/swoole/swoole/coroutine/client/set.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\Client::set - Descripción - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Client::set - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/create.xml b/reference/swoole/swoole/coroutine/create.xml deleted file mode 100644 index d8f882856b..0000000000 --- a/reference/swoole/swoole/coroutine/create.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine::create - Descripción - - - - &reftitle.description; - - public static ReturnTypeSwoole\Coroutine::create - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/getuid.xml b/reference/swoole/swoole/coroutine/getuid.xml deleted file mode 100644 index 4bc221d111..0000000000 --- a/reference/swoole/swoole/coroutine/getuid.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine::getuid - Descripción - - - - &reftitle.description; - - public static ReturnTypeSwoole\Coroutine::getuid - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/addfile.xml b/reference/swoole/swoole/coroutine/http/client/addfile.xml deleted file mode 100644 index 430751c5eb..0000000000 --- a/reference/swoole/swoole/coroutine/http/client/addfile.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::addFile - Descripción - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::addFile - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/close.xml b/reference/swoole/swoole/coroutine/http/client/close.xml deleted file mode 100644 index 8d7920b690..0000000000 --- a/reference/swoole/swoole/coroutine/http/client/close.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::close - Descripción - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::close - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/construct.xml b/reference/swoole/swoole/coroutine/http/client/construct.xml deleted file mode 100644 index 87fd72ccbc..0000000000 --- a/reference/swoole/swoole/coroutine/http/client/construct.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::__construct - Descripción - - - - &reftitle.description; - - public Swoole\Coroutine\Http\Client::__construct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/destruct.xml b/reference/swoole/swoole/coroutine/http/client/destruct.xml deleted file mode 100644 index dfd7888524..0000000000 --- a/reference/swoole/swoole/coroutine/http/client/destruct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::__destruct - Descripción - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::__destruct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/execute.xml b/reference/swoole/swoole/coroutine/http/client/execute.xml deleted file mode 100644 index c574229ce9..0000000000 --- a/reference/swoole/swoole/coroutine/http/client/execute.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::execute - Descripción - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::execute - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/get.xml b/reference/swoole/swoole/coroutine/http/client/get.xml deleted file mode 100644 index aa9eaae451..0000000000 --- a/reference/swoole/swoole/coroutine/http/client/get.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::get - Descripción - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::get - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/getdefer.xml b/reference/swoole/swoole/coroutine/http/client/getdefer.xml deleted file mode 100644 index cde0fe761c..0000000000 --- a/reference/swoole/swoole/coroutine/http/client/getdefer.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::getDefer - Descripción - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::getDefer - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/isconnected.xml b/reference/swoole/swoole/coroutine/http/client/isconnected.xml deleted file mode 100644 index 529143fd22..0000000000 --- a/reference/swoole/swoole/coroutine/http/client/isconnected.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::isConnected - Descripción - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::isConnected - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/post.xml b/reference/swoole/swoole/coroutine/http/client/post.xml deleted file mode 100644 index a231888467..0000000000 --- a/reference/swoole/swoole/coroutine/http/client/post.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::post - Descripción - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::post - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/recv.xml b/reference/swoole/swoole/coroutine/http/client/recv.xml deleted file mode 100644 index 72de036d07..0000000000 --- a/reference/swoole/swoole/coroutine/http/client/recv.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::recv - Descripción - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::recv - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/set.xml b/reference/swoole/swoole/coroutine/http/client/set.xml deleted file mode 100644 index dc6f7685c9..0000000000 --- a/reference/swoole/swoole/coroutine/http/client/set.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::set - Descripción - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::set - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/setcookies.xml b/reference/swoole/swoole/coroutine/http/client/setcookies.xml deleted file mode 100644 index 457a260674..0000000000 --- a/reference/swoole/swoole/coroutine/http/client/setcookies.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::setCookies - Descripción - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::setCookies - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/setdata.xml b/reference/swoole/swoole/coroutine/http/client/setdata.xml deleted file mode 100644 index cc5212e85c..0000000000 --- a/reference/swoole/swoole/coroutine/http/client/setdata.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::setData - Descripción - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::setData - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/setdefer.xml b/reference/swoole/swoole/coroutine/http/client/setdefer.xml deleted file mode 100644 index 639d069b4d..0000000000 --- a/reference/swoole/swoole/coroutine/http/client/setdefer.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::setDefer - Descripción - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::setDefer - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/setheaders.xml b/reference/swoole/swoole/coroutine/http/client/setheaders.xml deleted file mode 100644 index 28e47f2542..0000000000 --- a/reference/swoole/swoole/coroutine/http/client/setheaders.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::setHeaders - Descripción - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::setHeaders - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/http/client/setmethod.xml b/reference/swoole/swoole/coroutine/http/client/setmethod.xml deleted file mode 100644 index 2de5988313..0000000000 --- a/reference/swoole/swoole/coroutine/http/client/setmethod.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\Http\Client::setMethod - Descripción - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\Http\Client::setMethod - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/lock/construct.xml b/reference/swoole/swoole/coroutine/lock/construct.xml deleted file mode 100644 index a2e3fad366..0000000000 --- a/reference/swoole/swoole/coroutine/lock/construct.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - Swoole\Coroutine\Lock::__construct - Construye un nuevo bloqueo de corrutina - - - - &reftitle.description; - - public voidSwoole\Coroutine\Lock::__construct - - - - Crea una nueva instancia de bloqueo de corrutina. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/swoole/swoole/coroutine/lock/lock.xml b/reference/swoole/swoole/coroutine/lock/lock.xml deleted file mode 100644 index 2107d1c197..0000000000 --- a/reference/swoole/swoole/coroutine/lock/lock.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\Lock::lock - Adquirir el bloqueo, bloqueando si es necesario - - - - &reftitle.description; - - public boolSwoole\Coroutine\Lock::lock - - - - Al ejecutar la operación de bloqueo, si el bloqueo ya está siendo mantenido por otra corrutina, - la corrutina actual cederá activamente el control de la CPU y entrará en un estado suspendido. - Cuando la corrutina que mantiene el bloqueo llame a unlock(), la corrutina en espera será - despertada y tratará de adquirir el bloqueo nuevamente. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Retorna &true; si el bloqueo fue adquirido exitosamente, - &false; en caso contrario. - - - - - diff --git a/reference/swoole/swoole/coroutine/lock/trylock.xml b/reference/swoole/swoole/coroutine/lock/trylock.xml deleted file mode 100644 index d3df9c62c3..0000000000 --- a/reference/swoole/swoole/coroutine/lock/trylock.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\Lock::trylock - Intenta adquirir el bloqueo sin bloquear - - - - &reftitle.description; - - public boolSwoole\Coroutine\Lock::trylock - - - - Al llamar a la operación de bloqueo, si el bloqueo ya está siendo mantenido por otra corrutina, - la función devolverá inmediatamente false sin suspender la corrutina actual - ni ceder el control de la CPU. Este diseño no bloqueante permite al llamador manejar - flexiblemente situaciones de contención, como reintentar, abandonar o ejecutar otra lógica. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si el bloqueo se adquirió con éxito, - &false; si el bloqueo no está disponible. - - - - - diff --git a/reference/swoole/swoole/coroutine/lock/unlock.xml b/reference/swoole/swoole/coroutine/lock/unlock.xml deleted file mode 100644 index 6f23d718e4..0000000000 --- a/reference/swoole/swoole/coroutine/lock/unlock.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - Swoole\Coroutine\Lock::unlock - Liberar el bloqueo - - - - &reftitle.description; - - public boolSwoole\Coroutine\Lock::unlock - - - - - - Comportamiento de desbloqueo - - - - Con io_uring futex: el sistema despertará precisamente una corrutina en la cola de espera. - - - - - Sin io_uring futex: las corrutinas en espera deben esperar a que termine su tiempo de retroceso - y competir para readquirir el bloqueo. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si el bloqueo se liberó correctamente, - &false; en caso contrario. - - - - - diff --git a/reference/swoole/swoole/coroutine/mysql/close.xml b/reference/swoole/swoole/coroutine/mysql/close.xml deleted file mode 100644 index 69c0fc9a47..0000000000 --- a/reference/swoole/swoole/coroutine/mysql/close.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\MySQL::close - Descripción - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\MySQL::close - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/mysql/connect.xml b/reference/swoole/swoole/coroutine/mysql/connect.xml deleted file mode 100644 index 6a08a467de..0000000000 --- a/reference/swoole/swoole/coroutine/mysql/connect.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\MySQL::connect - Descripción - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\MySQL::connect - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/mysql/construct.xml b/reference/swoole/swoole/coroutine/mysql/construct.xml deleted file mode 100644 index 53972b2f63..0000000000 --- a/reference/swoole/swoole/coroutine/mysql/construct.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - Swoole\Coroutine\MySQL::__construct - Descripción - - - - &reftitle.description; - - public Swoole\Coroutine\MySQL::__construct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - - diff --git a/reference/swoole/swoole/coroutine/mysql/destruct.xml b/reference/swoole/swoole/coroutine/mysql/destruct.xml deleted file mode 100644 index 4d1d8fa112..0000000000 --- a/reference/swoole/swoole/coroutine/mysql/destruct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\MySQL::__destruct - Descripción - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\MySQL::__destruct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/mysql/getdefer.xml b/reference/swoole/swoole/coroutine/mysql/getdefer.xml deleted file mode 100644 index ff90d6eef4..0000000000 --- a/reference/swoole/swoole/coroutine/mysql/getdefer.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\MySQL::getDefer - Descripción - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\MySQL::getDefer - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/mysql/query.xml b/reference/swoole/swoole/coroutine/mysql/query.xml deleted file mode 100644 index af10660fa0..0000000000 --- a/reference/swoole/swoole/coroutine/mysql/query.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\MySQL::query - Descripción - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\MySQL::query - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/mysql/recv.xml b/reference/swoole/swoole/coroutine/mysql/recv.xml deleted file mode 100644 index 9a6368727e..0000000000 --- a/reference/swoole/swoole/coroutine/mysql/recv.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\MySQL::recv - Descripción - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\MySQL::recv - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/mysql/setdefer.xml b/reference/swoole/swoole/coroutine/mysql/setdefer.xml deleted file mode 100644 index 7a6a16083c..0000000000 --- a/reference/swoole/swoole/coroutine/mysql/setdefer.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine\MySQL::setDefer - Descripción - - - - &reftitle.description; - - public ReturnTypeSwoole\Coroutine\MySQL::setDefer - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/resume.xml b/reference/swoole/swoole/coroutine/resume.xml deleted file mode 100644 index 7bfb9cf342..0000000000 --- a/reference/swoole/swoole/coroutine/resume.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine::resume - Descripción - - - - &reftitle.description; - - public static ReturnTypeSwoole\Coroutine::resume - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/coroutine/suspend.xml b/reference/swoole/swoole/coroutine/suspend.xml deleted file mode 100644 index 4c49e620cf..0000000000 --- a/reference/swoole/swoole/coroutine/suspend.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Coroutine::suspend - Descripción - - - - &reftitle.description; - - public static ReturnTypeSwoole\Coroutine::suspend - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/event/add.xml b/reference/swoole/swoole/event/add.xml deleted file mode 100644 index 69df9bd497..0000000000 --- a/reference/swoole/swoole/event/add.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - Swoole\Event::add - Añade un socket al escuchador de eventos del reactor subyacente - - - - &reftitle.description; - - public static boolSwoole\Event::add - mixedsock - callableread_callback - callablewrite_callback - intflags - - - Añade un socket al escuchador de eventos del reactor subyacente. Esta función puede usarse tanto en modo Server como en modo Client. - - - - Un socket que ya ha sido añadido no puede añadirse de nuevo. Se debe usar swoole_event_set para - modificar las funciones de retrollamada y los tipos de eventos correspondientes al socket. - - - - - - &reftitle.parameters; - - - sock - - - Descriptor de fichero, recurso de flujo, recurso de sockets u objeto. - - - - - read_callback - - - Función de retrollamada para los eventos de lectura. - - - - - write_callback - - - Función de retrollamada para los eventos de escritura. - - - - - flags - - - Máscara del tipo de evento (por ejemplo SWOOLE_EVENT_READ, SWOOLE_EVENT_WRITE - o SWOOLE_EVENT_READ | SWOOLE_EVENT_WRITE). - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Ejemplo de <function>Swoole\Event::add</function> - - -]]> - - - - - - - diff --git a/reference/swoole/swoole/event/defer.xml b/reference/swoole/swoole/event/defer.xml deleted file mode 100644 index d39b78a321..0000000000 --- a/reference/swoole/swoole/event/defer.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - Swoole\Event::defer - Ejecuta una función al inicio de la próxima iteración del bucle de eventos - - - - &reftitle.description; - - public static voidSwoole\Event::defer - callablecallback_function - - - Programa una función para que se ejecute al inicio de la próxima iteración del bucle de eventos. - - - - - &reftitle.parameters; - - - callback_function - - - Función de retrollamada a ejecutar (no se permiten parámetros; se debe usar use para las variables de la función anónima). - - - - - - - - &reftitle.returnvalues; - - No devuelve ningún valor. - - - - - &reftitle.examples; - - - Ejemplo de <function>Swoole\Event::defer</function> - - -]]> - - - - - - - diff --git a/reference/swoole/swoole/event/del.xml b/reference/swoole/swoole/event/del.xml deleted file mode 100644 index 5d944c9a7c..0000000000 --- a/reference/swoole/swoole/event/del.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - Swoole\Event::del - Elimina un socket del escuchador de eventos del reactor - - - - &reftitle.description; - - public static boolSwoole\Event::del - mixedsock - - - Elimina un socket del escuchador de eventos del reactor. - - - - Se debe llamar siempre a Event::del para anular el registro de la monitorización - de eventos antes de cerrar el socket. No hacerlo puede provocar fugas de memoria. - - - - - - &reftitle.parameters; - - - sock - - - El descriptor de fichero del socket a eliminar. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/swoole/swoole/event/set.xml b/reference/swoole/swoole/event/set.xml deleted file mode 100644 index cb56d79572..0000000000 --- a/reference/swoole/swoole/event/set.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - Swoole\Event::set - Modifica las funciones de retrollamada y la máscara de eventos - - - - &reftitle.description; - - public static boolSwoole\Event::set - mixedsock - callableread_callback - callablewrite_callback - intflags - - - Modifica las funciones de retrollamada y la máscara de eventos asociadas al descriptor de fichero indicado. - - - - Cuando $read_callback no es null, la función de retrollamada del evento de lectura se modifica por la función especificada. - - - - - Cuando $write_callback no es null, la función de retrollamada del evento de escritura se actualiza a la función especificada. - - - - - Definir únicamente SWOOLE_EVENT_READ desactiva la escucha de los eventos de escritura, - mientras que definir únicamente SWOOLE_EVENT_WRITE desactiva la escucha de los eventos de lectura. - - - - - Swoole\Event::set reemplaza las funciones de retrollamada, pero no las libera. - Especificar null para las funciones de retrollamada (por ejemplo, read_callback/write_callback) - conserva las funciones de retrollamada existentes en lugar de eliminarlas. - - - - - Escuchar SWOOLE_EVENT_READ sin read_callback (o SWOOLE_EVENT_WRITE sin write_callback) - provoca el fallo de la operación y devuelve false. - - - - - - &reftitle.parameters; - - - sock - - - Descriptor de fichero, recurso de flujo, recurso de sockets u objeto. - - - - - read_callback - - - Función de retrollamada para los eventos de lectura. - - - - - write_callback - - - Función de retrollamada para los eventos de escritura. - - - - - flags - - - Máscara del tipo de evento (por ejemplo, SWOOLE_EVENT_READ, SWOOLE_EVENT_WRITE - o SWOOLE_EVENT_READ | SWOOLE_EVENT_WRITE). - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/swoole/swoole/event/wait.xml b/reference/swoole/swoole/event/wait.xml deleted file mode 100644 index 946ff845c4..0000000000 --- a/reference/swoole/swoole/event/wait.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - Swoole\Event::wait - Inicia el bucle de eventos - - - - &reftitle.description; - - public static voidSwoole\Event::wait - - - - Inicia el bucle de eventos. Debe colocarse al final del programa PHP. - - - - - &reftitle.returnvalues; - - No devuelve ningún valor. - - - - - &reftitle.examples; - - - Ejemplo de <function>Swoole\Event::wait</function> - - -]]> - - - - - - - diff --git a/reference/swoole/swoole/event/write.xml b/reference/swoole/swoole/event/write.xml deleted file mode 100644 index 239e23b0d1..0000000000 --- a/reference/swoole/swoole/event/write.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - Swoole\Event::write - Escribe datos en un socket de forma asíncrona - - - - &reftitle.description; - - public static boolSwoole\Event::write - mixedfd - mixeddata - - - Hace que el envío de datos sea asíncrono para los recursos de tipo stream/socket. - - - - Si se escriben datos continuamente en un socket pero el otro extremo no puede leerlos con - suficiente rapidez, el búfer del socket acabará por llenarse. En ese caso, la capa subyacente - de Swoole almacenará los datos sobrantes en un búfer en memoria y esperará a que se dispare el - evento de escritura antes de intentar escribir de nuevo en el socket. Sin embargo, si el búfer - en memoria también se llena, Swoole lanzará un error - "pipe buffer overflow, reactor will block" y cambiará a modo bloqueante, deteniendo las - escrituras posteriores hasta que vuelva a haber espacio disponible. - - - - - El retorno de &false; por búfer lleno es una operación atómica: garantiza - o bien el éxito completo (todos los datos escritos) o bien el fallo total (nada escrito). - - - - - Event::write no puede utilizarse con streams o sockets cifrados mediante SSL/TLS (conexiones tunelizadas). - - - - - Tras una ejecución correcta, Event::write cambiará automáticamente $socket a modo no bloqueante. - - - - - - &reftitle.parameters; - - - fd - - - Descriptor de fichero (recurso stream/socket, entero u objeto). - - - - - data - - - Datos a enviar (la longitud no debe exceder el tamaño del búfer del socket). - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Ejemplo de <function>Swoole\Event::write</function> - - -]]> - - - - - - - diff --git a/reference/swoole/swoole/http/client/addfile.xml b/reference/swoole/swoole/http/client/addfile.xml deleted file mode 100644 index aa9c4dc4ab..0000000000 --- a/reference/swoole/swoole/http/client/addfile.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Swoole\Http\Client::addFile - Añade un fichero al formulario de publicación. - - - - &reftitle.description; - - public voidSwoole\Http\Client::addFile - stringpath - stringname - stringtype - stringfilename - stringoffset - - - - - - - - - &reftitle.parameters; - - - path - - - - - - - - name - - - - - - - - type - - - - - - - - filename - - - - - - - - offset - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/http/client/close.xml b/reference/swoole/swoole/http/client/close.xml deleted file mode 100644 index 97e8e891ac..0000000000 --- a/reference/swoole/swoole/http/client/close.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Http\Client::close - Cierra la conexión http. - - - - &reftitle.description; - - public voidSwoole\Http\Client::close - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/http/client/construct.xml b/reference/swoole/swoole/http/client/construct.xml deleted file mode 100644 index 8fcbf5cbf7..0000000000 --- a/reference/swoole/swoole/http/client/construct.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Swoole\Http\Client::__construct - Construye el cliente HTTP asíncrono. - - - - &reftitle.description; - - public Swoole\Http\Client::__construct - stringhost - stringport - boolssl - - - - - - - - - &reftitle.parameters; - - - host - - - El nombre de host del host remoto. - - - - - port - - - El número de puerto del host remoto. - - - - - ssl - - - Activar o no SSL. - - - - - - - - - - - diff --git a/reference/swoole/swoole/http/client/destruct.xml b/reference/swoole/swoole/http/client/destruct.xml deleted file mode 100644 index 31c7f316e3..0000000000 --- a/reference/swoole/swoole/http/client/destruct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Http\Client::__destruct - Destruye el cliente HTTP. - - - - &reftitle.description; - - public voidSwoole\Http\Client::__destruct - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/http/client/download.xml b/reference/swoole/swoole/http/client/download.xml deleted file mode 100644 index 8535985723..0000000000 --- a/reference/swoole/swoole/http/client/download.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Swoole\Http\Client::download - Descarga un fichero desde el servidor remoto. - - - - &reftitle.description; - - public voidSwoole\Http\Client::download - stringpath - stringfile - callablecallback - intoffset - - - - - - - - - &reftitle.parameters; - - - path - - - - - - - - file - - - - - - - - callback - - - - - - - - offset - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/http/client/execute.xml b/reference/swoole/swoole/http/client/execute.xml deleted file mode 100644 index 51a00b10f0..0000000000 --- a/reference/swoole/swoole/http/client/execute.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Swoole\Http\Client::execute - Envía la petición HTTP después de haber definido los parámetros. - - - - &reftitle.description; - - public voidSwoole\Http\Client::execute - stringpath - stringcallback - - - - - - - - - &reftitle.parameters; - - - path - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/http/client/get.xml b/reference/swoole/swoole/http/client/get.xml deleted file mode 100644 index a8ece97730..0000000000 --- a/reference/swoole/swoole/http/client/get.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Swoole\Http\Client::get - Envía una petición HTTP GET al servidor remoto. - - - - &reftitle.description; - - public voidSwoole\Http\Client::get - stringpath - callablecallback - - - - - - - - - &reftitle.parameters; - - - path - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/http/client/isconnected.xml b/reference/swoole/swoole/http/client/isconnected.xml deleted file mode 100644 index 4a214bed3a..0000000000 --- a/reference/swoole/swoole/http/client/isconnected.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Http\Client::isConnected - Verifica si la conexión HTTP está establecida. - - - - &reftitle.description; - - public boolSwoole\Http\Client::isConnected - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/http/client/on.xml b/reference/swoole/swoole/http/client/on.xml deleted file mode 100644 index 5c2eb002fd..0000000000 --- a/reference/swoole/swoole/http/client/on.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Swoole\Http\Client::on - Registra una retrollamada por nombre de evento. - - - - &reftitle.description; - - public voidSwoole\Http\Client::on - stringevent_name - callablecallback - - - - - - - - - &reftitle.parameters; - - - event_name - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/http/client/post.xml b/reference/swoole/swoole/http/client/post.xml deleted file mode 100644 index 36dc28731b..0000000000 --- a/reference/swoole/swoole/http/client/post.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - Swoole\Http\Client::post - Envía una petición HTTP POST al servidor remoto. - - - - &reftitle.description; - - public voidSwoole\Http\Client::post - stringpath - stringdata - callablecallback - - - - - - - - - &reftitle.parameters; - - - path - - - - - - - - data - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/http/client/push.xml b/reference/swoole/swoole/http/client/push.xml deleted file mode 100644 index 9329858a62..0000000000 --- a/reference/swoole/swoole/http/client/push.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - Swoole\Http\Client::push - Añade datos al cliente websocket. - - - - &reftitle.description; - - public voidSwoole\Http\Client::push - stringdata - stringopcode - stringfinish - - - - - - - - - &reftitle.parameters; - - - data - - - - - - - - opcode - - - - - - - - finish - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/http/client/set.xml b/reference/swoole/swoole/http/client/set.xml deleted file mode 100644 index 5b45e18dbd..0000000000 --- a/reference/swoole/swoole/http/client/set.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Http\Client::set - Actualiza los parámetros del cliente HTTP. - - - - &reftitle.description; - - public voidSwoole\Http\Client::set - arraysettings - - - - - - - - - &reftitle.parameters; - - - settings - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/http/client/setcookies.xml b/reference/swoole/swoole/http/client/setcookies.xml deleted file mode 100644 index b02fbf272e..0000000000 --- a/reference/swoole/swoole/http/client/setcookies.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Http\Client::setCookies - Define las cookies de la petición HTTP. - - - - &reftitle.description; - - public voidSwoole\Http\Client::setCookies - arraycookies - - - - - - - - - &reftitle.parameters; - - - cookies - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/http/client/setdata.xml b/reference/swoole/swoole/http/client/setdata.xml deleted file mode 100644 index 275904f683..0000000000 --- a/reference/swoole/swoole/http/client/setdata.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Http\Client::setData - Define los datos del cuerpo de la petición HTTP. - - - - &reftitle.description; - - public ReturnTypeSwoole\Http\Client::setData - stringdata - - - El método HTTP será modificado para ser POST. - - - - - - &reftitle.parameters; - - - data - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/http/client/setheaders.xml b/reference/swoole/swoole/http/client/setheaders.xml deleted file mode 100644 index 51a5ca0d1d..0000000000 --- a/reference/swoole/swoole/http/client/setheaders.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Http\Client::setHeaders - Define las cabeceras de la petición HTTP. - - - - &reftitle.description; - - public voidSwoole\Http\Client::setHeaders - arrayheaders - - - - - - - - - &reftitle.parameters; - - - headers - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/http/client/setmethod.xml b/reference/swoole/swoole/http/client/setmethod.xml deleted file mode 100644 index 13aaa7c70c..0000000000 --- a/reference/swoole/swoole/http/client/setmethod.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Http\Client::setMethod - Define el método de petición HTTP. - - - - &reftitle.description; - - public voidSwoole\Http\Client::setMethod - stringmethod - - - - - - - - - &reftitle.parameters; - - - method - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/http/client/upgrade.xml b/reference/swoole/swoole/http/client/upgrade.xml deleted file mode 100644 index d33e6bc6f5..0000000000 --- a/reference/swoole/swoole/http/client/upgrade.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Swoole\Http\Client::upgrade - Actualiza al protocolo websocket. - - - - &reftitle.description; - - public voidSwoole\Http\Client::upgrade - stringpath - stringcallback - - - - - - - - - &reftitle.parameters; - - - path - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/http/request/destruct.xml b/reference/swoole/swoole/http/request/destruct.xml deleted file mode 100644 index 98dc605686..0000000000 --- a/reference/swoole/swoole/http/request/destruct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Http\Request::__destruct - Destruye la petición HTTP. - - - - &reftitle.description; - - public voidSwoole\Http\Request::__destruct - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/http/request/rawcontent.xml b/reference/swoole/swoole/http/request/rawcontent.xml deleted file mode 100644 index 4665b5e586..0000000000 --- a/reference/swoole/swoole/http/request/rawcontent.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Http\Request::rawcontent - Devuelve el cuerpo bruto de la petición HTTP. - - - - &reftitle.description; - - public stringSwoole\Http\Request::rawcontent - - - - Este método se utiliza para obtener los datos POST que no están en la forma de `application/x-www-form-urlencoded`. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/http/response/cookie.xml b/reference/swoole/swoole/http/response/cookie.xml deleted file mode 100644 index 6e5bba8349..0000000000 --- a/reference/swoole/swoole/http/response/cookie.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - Swoole\Http\Response::cookie - Define las cookies de la respuesta HTTP. - - - - &reftitle.description; - - public stringSwoole\Http\Response::cookie - stringname - stringvalue - stringexpires - stringpath - stringdomain - stringsecure - stringhttponly - - - - - - - - - &reftitle.parameters; - - - name - - - - - - - - value - - - - - - - - expires - - - - - - - - path - - - - - - - - domain - - - - - - - - secure - - - - - - - - httponly - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/http/response/destruct.xml b/reference/swoole/swoole/http/response/destruct.xml deleted file mode 100644 index 899006b5d7..0000000000 --- a/reference/swoole/swoole/http/response/destruct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Http\Response::__destruct - Destruye la respuesta HTTP. - - - - &reftitle.description; - - public voidSwoole\Http\Response::__destruct - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/http/response/end.xml b/reference/swoole/swoole/http/response/end.xml deleted file mode 100644 index 8b23f3e3de..0000000000 --- a/reference/swoole/swoole/http/response/end.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Http\Response::end - Envía los datos para la petición HTTP y termina la respuesta. - - - - &reftitle.description; - - public voidSwoole\Http\Response::end - stringcontent - - - - - - - - - &reftitle.parameters; - - - content - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/http/response/gzip.xml b/reference/swoole/swoole/http/response/gzip.xml deleted file mode 100644 index d3ca614f71..0000000000 --- a/reference/swoole/swoole/http/response/gzip.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Http\Response::gzip - Activa la compresión gzip del contenido de la respuesta. - - - - &reftitle.description; - - public ReturnTypeSwoole\Http\Response::gzip - stringcompress_level - - - Las cabeceras sobre Content-Encoding serán añadidas automáticamente. - - - - - - &reftitle.parameters; - - - compress_level - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/http/response/header.xml b/reference/swoole/swoole/http/response/header.xml deleted file mode 100644 index c64fec80a4..0000000000 --- a/reference/swoole/swoole/http/response/header.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - Swoole\Http\Response::header - Define los encabezados de respuesta HTTP. - - - - &reftitle.description; - - public voidSwoole\Http\Response::header - stringkey - stringvalue - stringucwords - - - - - - - - - &reftitle.parameters; - - - key - - - - - - - - value - - - - - - - - ucwords - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/http/response/initheader.xml b/reference/swoole/swoole/http/response/initheader.xml deleted file mode 100644 index 7edbcd57b3..0000000000 --- a/reference/swoole/swoole/http/response/initheader.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Http\Response::initHeader - Inicializa el encabezado de respuesta HTTP. - - - - &reftitle.description; - - public ReturnTypeSwoole\Http\Response::initHeader - - - - Inicializa el encabezado de respuesta HTTP. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/http/response/rawcookie.xml b/reference/swoole/swoole/http/response/rawcookie.xml deleted file mode 100644 index b66131c054..0000000000 --- a/reference/swoole/swoole/http/response/rawcookie.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - Swoole\Http\Response::rawcookie - Define las cookies sin formato de la respuesta HTTP. - - - - &reftitle.description; - - public ReturnTypeSwoole\Http\Response::rawcookie - stringname - stringvalue - stringexpires - stringpath - stringdomain - stringsecure - stringhttponly - - - - - - - - - &reftitle.parameters; - - - name - - - - - - - - value - - - - - - - - expires - - - - - - - - path - - - - - - - - domain - - - - - - - - secure - - - - - - - - httponly - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/http/response/sendfile.xml b/reference/swoole/swoole/http/response/sendfile.xml deleted file mode 100644 index b96351f029..0000000000 --- a/reference/swoole/swoole/http/response/sendfile.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Swoole\Http\Response::sendfile - Envía un fichero a través de la respuesta HTTP. - - - - &reftitle.description; - - public ReturnTypeSwoole\Http\Response::sendfile - stringfilename - intoffset - - - Envía un fichero a través de la respuesta HTTP. - - - - - - &reftitle.parameters; - - - filename - - - - - - - - offset - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/http/response/status.xml b/reference/swoole/swoole/http/response/status.xml deleted file mode 100644 index 9d33bea03e..0000000000 --- a/reference/swoole/swoole/http/response/status.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Http\Response::status - Define el código de estado de la respuesta HTTP. - - - - &reftitle.description; - - public ReturnTypeSwoole\Http\Response::status - stringhttp_code - - - Define el código de estado de la respuesta HTTP. - - - - - - &reftitle.parameters; - - - http_code - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/http/response/write.xml b/reference/swoole/swoole/http/response/write.xml deleted file mode 100644 index 4d55a5409e..0000000000 --- a/reference/swoole/swoole/http/response/write.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Http\Response::write - Añade el contenido del cuerpo HTTP a la respuesta HTTP. - - - - &reftitle.description; - - public voidSwoole\Http\Response::write - stringcontent - - - Añade el contenido del cuerpo HTTP a la respuesta HTTP. - - - - - - &reftitle.parameters; - - - content - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/http/server/on.xml b/reference/swoole/swoole/http/server/on.xml deleted file mode 100644 index 62393670d4..0000000000 --- a/reference/swoole/swoole/http/server/on.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Swoole\Http\Server::on - Vincula una retrollamada al servidor HTTP por nombre de evento. - - - - &reftitle.description; - - public voidSwoole\Http\Server::on - stringevent_name - callablecallback - - - Vincula una retrollamada al servidor HTTP por nombre de evento. - - - - - - &reftitle.parameters; - - - event_name - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/http/server/start.xml b/reference/swoole/swoole/http/server/start.xml deleted file mode 100644 index ce1d7dae79..0000000000 --- a/reference/swoole/swoole/http/server/start.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Http\Server::start - Inicia el servidor HTTP swoole. - - - - &reftitle.description; - - public voidSwoole\Http\Server::start - - - - Inicia el servidor HTTP swoole. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/lock/construct.xml b/reference/swoole/swoole/lock/construct.xml deleted file mode 100644 index 14a078ac8a..0000000000 --- a/reference/swoole/swoole/lock/construct.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - Swoole\Lock::__construct - Construye un bloqueo de memoria. - - - - &reftitle.description; - - public Swoole\Lock::__construct - stringtype - stringfile_lock_location - - - Un bloqueo Swoole se utiliza para la sincronización de datos entre varios hilos o procesos. - - - - - - &reftitle.parameters; - - - type - - - - - - - - file_lock_location - - - - - - - - - - - - - - diff --git a/reference/swoole/swoole/lock/destruct.xml b/reference/swoole/swoole/lock/destruct.xml deleted file mode 100644 index 2b92724a9b..0000000000 --- a/reference/swoole/swoole/lock/destruct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Lock::__destruct - Destruye un bloqueo de memoria Swoole. - - - - &reftitle.description; - - public voidSwoole\Lock::__destruct - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/lock/lock-read.xml b/reference/swoole/swoole/lock/lock-read.xml deleted file mode 100644 index 1d4aa741b9..0000000000 --- a/reference/swoole/swoole/lock/lock-read.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Lock::lock_read - Bloquea un bloqueo de lectura-escritura para la lectura. - - - - &reftitle.description; - - public voidSwoole\Lock::lock_read - - - - Bloquea un bloqueo de lectura-escritura para la lectura. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/lock/lock.xml b/reference/swoole/swoole/lock/lock.xml deleted file mode 100644 index ba87dd7506..0000000000 --- a/reference/swoole/swoole/lock/lock.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Lock::lock - Intenta adquirir el bloqueo. Bloqueará si el bloqueo no está disponible. - - - - &reftitle.description; - - public voidSwoole\Lock::lock - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/lock/trylock-read.xml b/reference/swoole/swoole/lock/trylock-read.xml deleted file mode 100644 index 2acf9ed3ad..0000000000 --- a/reference/swoole/swoole/lock/trylock-read.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Lock::trylock_read - Intenta bloquear un bloqueo de lectura-escritura para la lectura y devuelve inmediatamente incluso si el bloqueo no está disponible. - - - - &reftitle.description; - - public voidSwoole\Lock::trylock_read - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/lock/trylock.xml b/reference/swoole/swoole/lock/trylock.xml deleted file mode 100644 index ba5f40abfa..0000000000 --- a/reference/swoole/swoole/lock/trylock.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Lock::trylock - Intenta adquirir el bloqueo y devuelve inmediatamente incluso si el bloqueo no está disponible. - - - - &reftitle.description; - - public voidSwoole\Lock::trylock - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/lock/unlock.xml b/reference/swoole/swoole/lock/unlock.xml deleted file mode 100644 index 2a09a6ae9d..0000000000 --- a/reference/swoole/swoole/lock/unlock.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Lock::unlock - Libera el bloqueo. - - - - &reftitle.description; - - public voidSwoole\Lock::unlock - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/mmap/open.xml b/reference/swoole/swoole/mmap/open.xml deleted file mode 100644 index c8beb4893b..0000000000 --- a/reference/swoole/swoole/mmap/open.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - Swoole\Mmap::open - Mapea un fichero en memoria y devuelve el recurso de flujo que puede ser utilizado por las operaciones de flujo PHP. - - - - &reftitle.description; - - public static ReturnTypeSwoole\Mmap::open - stringfilename - stringsize - stringoffset - - - - - - - - - &reftitle.parameters; - - - filename - - - - - - - - size - - - - - - - - offset - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/mysql/close.xml b/reference/swoole/swoole/mysql/close.xml deleted file mode 100644 index 8abe6cdd5c..0000000000 --- a/reference/swoole/swoole/mysql/close.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\MySQL::close - Cierra la conexión MySQL asíncrona. - - - - &reftitle.description; - - public voidSwoole\MySQL::close - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/mysql/connect.xml b/reference/swoole/swoole/mysql/connect.xml deleted file mode 100644 index 671a15011b..0000000000 --- a/reference/swoole/swoole/mysql/connect.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Swoole\MySQL::connect - Conecta al servidor MySQL remoto. - - - - &reftitle.description; - - public voidSwoole\MySQL::connect - arrayserver_config - callablecallback - - - Conecta al servidor MySQL remoto. - - - - - - &reftitle.parameters; - - - server_config - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/mysql/construct.xml b/reference/swoole/swoole/mysql/construct.xml deleted file mode 100644 index 985d2b08d9..0000000000 --- a/reference/swoole/swoole/mysql/construct.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - Swoole\MySQL::__construct - Construye un cliente MySQL asíncrono. - - - - &reftitle.description; - - public Swoole\MySQL::__construct - - - - Construye un cliente MySQL asíncrono. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - - diff --git a/reference/swoole/swoole/mysql/destruct.xml b/reference/swoole/swoole/mysql/destruct.xml deleted file mode 100644 index 566e968b9c..0000000000 --- a/reference/swoole/swoole/mysql/destruct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\MySQL::__destruct - Destruye el cliente MySQL asíncrono. - - - - &reftitle.description; - - public voidSwoole\MySQL::__destruct - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/mysql/getbuffer.xml b/reference/swoole/swoole/mysql/getbuffer.xml deleted file mode 100644 index b1a1fe718e..0000000000 --- a/reference/swoole/swoole/mysql/getbuffer.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\MySQL::getBuffer - Descripción - - - - &reftitle.description; - - public ReturnTypeSwoole\MySQL::getBuffer - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/mysql/on.xml b/reference/swoole/swoole/mysql/on.xml deleted file mode 100644 index b475ff08aa..0000000000 --- a/reference/swoole/swoole/mysql/on.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Swoole\MySQL::on - Registra una retrollamada basada en el nombre del evento. - - - - &reftitle.description; - - public voidSwoole\MySQL::on - stringevent_name - callablecallback - - - Registra una retrollamada basada en el nombre del evento, actualmente solo el evento 'close' es soportado. - - - - - - &reftitle.parameters; - - - event_name - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/mysql/query.xml b/reference/swoole/swoole/mysql/query.xml deleted file mode 100644 index a60388e1ff..0000000000 --- a/reference/swoole/swoole/mysql/query.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Swoole\MySQL::query - Ejecuta la consulta SQL. - - - - &reftitle.description; - - public ReturnTypeSwoole\MySQL::query - stringsql - callablecallback - - - - - - - - - &reftitle.parameters; - - - sql - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/process/alarm.xml b/reference/swoole/swoole/process/alarm.xml deleted file mode 100644 index 633fb9f38b..0000000000 --- a/reference/swoole/swoole/process/alarm.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Process::alarm - Temporizador de alta precisión que dispara una señal a intervalo fijo. - - - - &reftitle.description; - - public static voidSwoole\Process::alarm - intinterval_usec - - - - - - - - - &reftitle.parameters; - - - interval_usec - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/process/close.xml b/reference/swoole/swoole/process/close.xml deleted file mode 100644 index b460a44dc4..0000000000 --- a/reference/swoole/swoole/process/close.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Process::close - Cierra el tubo hacia el proceso hijo. - - - - &reftitle.description; - - public voidSwoole\Process::close - - - - Cierra el tubo hacia el proceso hijo. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/process/construct.xml b/reference/swoole/swoole/process/construct.xml deleted file mode 100644 index baad729bcb..0000000000 --- a/reference/swoole/swoole/process/construct.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Swoole\Process::__construct - Construye un proceso. - - - - &reftitle.description; - - public Swoole\Process::__construct - callablecallback - boolredirect_stdin_and_stdout - intpipe_type - - - - - - - - - &reftitle.parameters; - - - callback - - - - - - - - redirect_stdin_and_stdout - - - - - - - - pipe_type - - - - - - - - - - - - - - diff --git a/reference/swoole/swoole/process/daemon.xml b/reference/swoole/swoole/process/daemon.xml deleted file mode 100644 index af9913db62..0000000000 --- a/reference/swoole/swoole/process/daemon.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - Swoole\Process::daemon - Cambia el proceso a un proceso daemon. - - - - &reftitle.description; - - public static voidSwoole\Process::daemon - boolnochdir - boolnoclose - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - nochdir - - - - - - - - noclose - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/process/destruct.xml b/reference/swoole/swoole/process/destruct.xml deleted file mode 100644 index 836f592511..0000000000 --- a/reference/swoole/swoole/process/destruct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Process::__destruct - Destruye el proceso. - - - - &reftitle.description; - - public voidSwoole\Process::__destruct - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/process/exec.xml b/reference/swoole/swoole/process/exec.xml deleted file mode 100644 index c80a16afed..0000000000 --- a/reference/swoole/swoole/process/exec.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Swoole\Process::exec - Ejecuta un comando del sistema. - - - - &reftitle.description; - - public ReturnTypeSwoole\Process::exec - stringexec_file - stringargs - - - El proceso será reemplazado por el proceso del comando del sistema, pero el tubo hacia el proceso padre será conservado. - - - - - - &reftitle.parameters; - - - exec_file - - - - - - - - args - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/process/exit.xml b/reference/swoole/swoole/process/exit.xml deleted file mode 100644 index 3bbcf67caf..0000000000 --- a/reference/swoole/swoole/process/exit.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Process::exit - Detiene los procesos hijos. - - - - &reftitle.description; - - public voidSwoole\Process::exit - stringexit_code - - - - - - - - - &reftitle.parameters; - - - exit_code - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/process/freequeue.xml b/reference/swoole/swoole/process/freequeue.xml deleted file mode 100644 index ce9f92d3be..0000000000 --- a/reference/swoole/swoole/process/freequeue.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Process::freeQueue - Destruye la cola de mensajes creada por swoole_process::useQueue. - - - - &reftitle.description; - - public voidSwoole\Process::freeQueue - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/process/kill.xml b/reference/swoole/swoole/process/kill.xml deleted file mode 100644 index 1cac47d6f7..0000000000 --- a/reference/swoole/swoole/process/kill.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Swoole\Process::kill - Envía una señal al proceso hijo. - - - - &reftitle.description; - - public static boolSwoole\Process::kill - intpid - intsignal_no - - - Envía una señal al proceso hijo. - - - - - - &reftitle.parameters; - - - pid - - - El PID del proceso - - - - - signal_no - - - La señal a enviar - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/swoole/swoole/process/name.xml b/reference/swoole/swoole/process/name.xml deleted file mode 100644 index db996ad275..0000000000 --- a/reference/swoole/swoole/process/name.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Process::name - Define el nombre del proceso. - - - - &reftitle.description; - - public boolSwoole\Process::name - stringprocess_name - - - - - - - - - &reftitle.parameters; - - - process_name - - - Define el nombre del proceso. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/swoole/swoole/process/pop.xml b/reference/swoole/swoole/process/pop.xml deleted file mode 100644 index 658698d0be..0000000000 --- a/reference/swoole/swoole/process/pop.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Process::pop - Lee y extrae datos de la cola de mensajes. - - - - &reftitle.description; - - public mixedSwoole\Process::pop - intmaxsize - - - - - - - - - &reftitle.parameters; - - - maxsize - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/process/push.xml b/reference/swoole/swoole/process/push.xml deleted file mode 100644 index 2ed641696c..0000000000 --- a/reference/swoole/swoole/process/push.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Process::push - Escribe y empuja datos en la cola de mensajes. - - - - &reftitle.description; - - public boolSwoole\Process::push - stringdata - - - - - - - - - &reftitle.parameters; - - - data - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/process/read.xml b/reference/swoole/swoole/process/read.xml deleted file mode 100644 index 802fd08264..0000000000 --- a/reference/swoole/swoole/process/read.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Process::read - Lee los datos enviados al proceso. - - - - &reftitle.description; - - public stringSwoole\Process::read - intmaxsize - - - - - - - - - &reftitle.parameters; - - - maxsize - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/process/signal.xml b/reference/swoole/swoole/process/signal.xml deleted file mode 100644 index 0a55c781c5..0000000000 --- a/reference/swoole/swoole/process/signal.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Swoole\Process::signal - Envía un signal a los procesos hijos. - - - - &reftitle.description; - - public static voidSwoole\Process::signal - stringsignal_no - callablecallback - - - - - - - - - &reftitle.parameters; - - - signal_no - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - Si el signal es enviado con éxito, devuelve TRUE, de lo contrario devuelve FALSE. - - - - - - diff --git a/reference/swoole/swoole/process/start.xml b/reference/swoole/swoole/process/start.xml deleted file mode 100644 index ac43abdb41..0000000000 --- a/reference/swoole/swoole/process/start.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Process::start - Inicia el proceso. - - - - &reftitle.description; - - public voidSwoole\Process::start - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/process/statqueue.xml b/reference/swoole/swoole/process/statqueue.xml deleted file mode 100644 index 735d9839c2..0000000000 --- a/reference/swoole/swoole/process/statqueue.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Process::statQueue - Devuelve las estadísticas de la cola de mensajes utilizada como método de comunicación entre los procesos. - - - - &reftitle.description; - - public arraySwoole\Process::statQueue - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El array de estado de la cola de mensajes. - - - - - - - diff --git a/reference/swoole/swoole/process/usequeue.xml b/reference/swoole/swoole/process/usequeue.xml deleted file mode 100644 index 2e58c12de9..0000000000 --- a/reference/swoole/swoole/process/usequeue.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Swoole\Process::useQueue - Crear una cola de mensajes como método de comunicación entre el proceso padre y los procesos hijos. - - - - &reftitle.description; - - public boolSwoole\Process::useQueue - intkey - intmode - - - - - - - - - &reftitle.parameters; - - - key - - - - - - - - mode - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/process/wait.xml b/reference/swoole/swoole/process/wait.xml deleted file mode 100644 index df9ebb6203..0000000000 --- a/reference/swoole/swoole/process/wait.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Process::wait - Espera los eventos de los procesos hijos. - - - - &reftitle.description; - - public static arraySwoole\Process::wait - boolblocking - - - - - - - - - &reftitle.parameters; - - - blocking - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/process/write.xml b/reference/swoole/swoole/process/write.xml deleted file mode 100644 index d4b6ad1d2b..0000000000 --- a/reference/swoole/swoole/process/write.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Process::write - Escribe datos en el tubo y comunica con el proceso padre o los procesos hijos. - - - - &reftitle.description; - - public intSwoole\Process::write - stringdata - - - - - - - - - &reftitle.parameters; - - - data - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/redis/server/format.xml b/reference/swoole/swoole/redis/server/format.xml deleted file mode 100644 index ec7f3041ee..0000000000 --- a/reference/swoole/swoole/redis/server/format.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - Swoole\Redis\Server::format - Descripción - - - - &reftitle.description; - - public static ReturnTypeSwoole\Redis\Server::format - stringtype - stringvalue - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - type - - - - - - - - value - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/redis/server/sethandler.xml b/reference/swoole/swoole/redis/server/sethandler.xml deleted file mode 100644 index 5aabe57404..0000000000 --- a/reference/swoole/swoole/redis/server/sethandler.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - Swoole\Redis\Server::setHandler - Descripción - - - - &reftitle.description; - - public ReturnTypeSwoole\Redis\Server::setHandler - stringcommand - stringcallback - stringnumber_of_string_param - stringtype_of_array_param - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - command - - - - - - - - callback - - - - - - - - number_of_string_param - - - - - - - - type_of_array_param - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/redis/server/start.xml b/reference/swoole/swoole/redis/server/start.xml deleted file mode 100644 index c520696b3c..0000000000 --- a/reference/swoole/swoole/redis/server/start.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - Swoole\Redis\Server::start - Descripción - - - - &reftitle.description; - - public ReturnTypeSwoole\Redis\Server::start - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/runtime/enableCoroutine.xml b/reference/swoole/swoole/runtime/enableCoroutine.xml deleted file mode 100644 index 6c0c26e0f4..0000000000 --- a/reference/swoole/swoole/runtime/enableCoroutine.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Swoole\Runtime::enableCoroutine - Habilitar corrutinas para funciones específicas - - - - &reftitle.description; - - public static voidSwoole\Runtime::enableCoroutine - intflagsSWOOLE_HOOK_ALL - - - Este método habilita el soporte de corrutinas para funciones PHP específicas según los flags proporcionados. - Debe ser llamado una vez al inicio de la aplicación. - - - - - &reftitle.parameters; - - - flags - - - Máscara de bits de flags que especifica qué funciones se deben interceptar. Puede combinarse usando el operador |. - Flags disponibles: - SWOOLE_HOOK_TCP, - SWOOLE_HOOK_UDP, - SWOOLE_HOOK_UNIX, - SWOOLE_HOOK_UDG, - SWOOLE_HOOK_SSL, - SWOOLE_HOOK_TLS, - SWOOLE_HOOK_SLEEP, - SWOOLE_HOOK_FILE, - SWOOLE_HOOK_STREAM_FUNCTION, - SWOOLE_HOOK_BLOCKING_FUNCTION, - SWOOLE_HOOK_PROC, - SWOOLE_HOOK_CURL, - SWOOLE_HOOK_NATIVE_CURL, - SWOOLE_HOOK_SOCKETS, - SWOOLE_HOOK_STDIO, - SWOOLE_HOOK_PDO_PGSQL, - SWOOLE_HOOK_PDO_ODBC, - SWOOLE_HOOK_PDO_ORACLE, - SWOOLE_HOOK_PDO_SQLITE, - o SWOOLE_HOOK_ALL para todos los flags. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/swoole/swoole/runtime/getHookFlags.xml b/reference/swoole/swoole/runtime/getHookFlags.xml deleted file mode 100644 index 8f815284e6..0000000000 --- a/reference/swoole/swoole/runtime/getHookFlags.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Runtime::getHookFlags - Obtiene los flags de hook actuales - - - - &reftitle.description; - - public static intSwoole\Runtime::getHookFlags - - - - Obtiene los flags de hook actuales. - Tenga en cuenta que los flags devueltos pueden diferir de lo que se estableció si algunos hooks fallaron. - - - - - &reftitle.parameters; - - Esta función no tiene parámetros. - - - - - &reftitle.returnvalues; - - Devuelve los flags de hook actuales como una máscara de bits. - - - - - diff --git a/reference/swoole/swoole/runtime/setHookFlags.xml b/reference/swoole/swoole/runtime/setHookFlags.xml deleted file mode 100644 index 113b24ca33..0000000000 --- a/reference/swoole/swoole/runtime/setHookFlags.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Swoole\Runtime::setHookFlags - Establece los flags de hook para corrutinas - - - - &reftitle.description; - - public static boolSwoole\Runtime::setHookFlags - intflags - - - Establece los flags de hook para el soporte de corrutinas. - Esto cambia dinámicamente los flags de hook en tiempo de ejecución. - - - - - &reftitle.parameters; - - - flags - - - Máscara de bits de flags que especifica qué funciones se deben hookear. Los mismos flags que enableCoroutine. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/swoole/swoole/serialize/pack.xml b/reference/swoole/swoole/serialize/pack.xml deleted file mode 100644 index 641b42e77b..0000000000 --- a/reference/swoole/swoole/serialize/pack.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Swoole\Serialize::pack - Serializa los datos. - - - - &reftitle.description; - - public static ReturnTypeSwoole\Serialize::pack - stringdata - intis_fast - - - Swoole proporciona un módulo de serialización rápido y eficiente. - - - - - - &reftitle.parameters; - - - data - - - - - - - - is_fast - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/serialize/unpack.xml b/reference/swoole/swoole/serialize/unpack.xml deleted file mode 100644 index 9b387b66a6..0000000000 --- a/reference/swoole/swoole/serialize/unpack.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Swoole\Serialize::unpack - Deserializa los datos. - - - - &reftitle.description; - - public static ReturnTypeSwoole\Serialize::unpack - stringdata - stringargs - - - Deserializa los datos. - - - - - - &reftitle.parameters; - - - string - - - - - - - - args - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/addlistener.xml b/reference/swoole/swoole/server/addlistener.xml deleted file mode 100644 index c222c25b15..0000000000 --- a/reference/swoole/swoole/server/addlistener.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - Swoole\Server::addlistener - Añade un nuevo observador al servidor. - - - - &reftitle.description; - - public voidSwoole\Server::addlistener - stringhost - intport - stringsocket_type - - - - - - - - - &reftitle.parameters; - - - host - - - - - - - - port - - - - - - - - socket_type - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/addprocess.xml b/reference/swoole/swoole/server/addprocess.xml deleted file mode 100644 index 6ca530aeb3..0000000000 --- a/reference/swoole/swoole/server/addprocess.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Server::addProcess - Añade un swoole_process definido por el usuario al servidor. - - - - &reftitle.description; - - public boolSwoole\Server::addProcess - swoole_processprocess - - - - - - - - - &reftitle.parameters; - - - process - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/after.xml b/reference/swoole/swoole/server/after.xml deleted file mode 100644 index 3f9de614f7..0000000000 --- a/reference/swoole/swoole/server/after.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - Swoole\Server::after - Dispara una retrollamada después de un período de tiempo. - - - - &reftitle.description; - - public ReturnTypeSwoole\Server::after - intafter_time_ms - callablecallback - stringparam - - - - - - - - - &reftitle.parameters; - - - after_time_ms - - - - - - - - callback - - - - - - - - param - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/bind.xml b/reference/swoole/swoole/server/bind.xml deleted file mode 100644 index 0c8665ecaf..0000000000 --- a/reference/swoole/swoole/server/bind.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Swoole\Server::bind - Vincula la conexión a un identificador de usuario definido por el usuario. - - - - &reftitle.description; - - public boolSwoole\Server::bind - intfd - intuid - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - uid - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/cleartimer.xml b/reference/swoole/swoole/server/cleartimer.xml deleted file mode 100644 index 4d28180ed5..0000000000 --- a/reference/swoole/swoole/server/cleartimer.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Swoole\Server::clearTimer - swoole_timer_clear - Destruye y detiene un temporizador. - - - - &reftitle.description; - &style.oop; (method): - - public voidSwoole\Server::clearTimer - inttimer_id - - &style.procedural;: - - voidswoole_timer_clear - inttimer_id - - - Detiene y destruye un temporizador. - - - - - - &reftitle.parameters; - - - - timer_id - - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/close.xml b/reference/swoole/swoole/server/close.xml deleted file mode 100644 index bb93af8400..0000000000 --- a/reference/swoole/swoole/server/close.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Swoole\Server::close - Cierra una conexión con el cliente. - - - - &reftitle.description; - - public boolSwoole\Server::close - intfd - boolreset - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - reset - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/confirm.xml b/reference/swoole/swoole/server/confirm.xml deleted file mode 100644 index c5c85682f6..0000000000 --- a/reference/swoole/swoole/server/confirm.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Server::confirm - Verifica el estado de la conexión. - - - - &reftitle.description; - - public boolSwoole\Server::confirm - intfd - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/connection-info.xml b/reference/swoole/swoole/server/connection-info.xml deleted file mode 100644 index aa3b9964c8..0000000000 --- a/reference/swoole/swoole/server/connection-info.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Swoole\Server::connection_info - Devuelve la información de conexión por la descripción del fichero. - - - - &reftitle.description; - - public arraySwoole\Server::connection_info - intfd - intreactor_id - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - reactor_id - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/connection-list.xml b/reference/swoole/swoole/server/connection-list.xml deleted file mode 100644 index 4177146cd2..0000000000 --- a/reference/swoole/swoole/server/connection-list.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Swoole\Server::connection_list - Devuelve todas las conexiones establecidas. - - - - &reftitle.description; - - public arraySwoole\Server::connection_list - intstart_fd - intpagesize - - - - - - - - - &reftitle.parameters; - - - start_fd - - - - - - - - pagesize - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/construct.xml b/reference/swoole/swoole/server/construct.xml deleted file mode 100644 index d93b2f9362..0000000000 --- a/reference/swoole/swoole/server/construct.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - Swoole\Server::__construct - Construye un servidor Swoole. - - - - &reftitle.description; - - public Swoole\Server::__construct - stringhost - intport - intmode - intsock_type - - - - - - - - - &reftitle.parameters; - - - host - - - - - - - - port - - - - - - - - mode - - - - - - - - sock_type - - - - - - - - - - - - - - diff --git a/reference/swoole/swoole/server/defer.xml b/reference/swoole/swoole/server/defer.xml deleted file mode 100644 index 72f574cf32..0000000000 --- a/reference/swoole/swoole/server/defer.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Server::defer - Retrasa la ejecución de la función de retrollamada al final del ciclo de eventos actual. - - - - &reftitle.description; - - public voidSwoole\Server::defer - callablecallback - - - - - - - - - &reftitle.parameters; - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/exist.xml b/reference/swoole/swoole/server/exist.xml deleted file mode 100644 index 5bfc52d096..0000000000 --- a/reference/swoole/swoole/server/exist.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Server::exist - Verifica si la conexión existe. - - - - &reftitle.description; - - public boolSwoole\Server::exist - intfd - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/finish.xml b/reference/swoole/swoole/server/finish.xml deleted file mode 100644 index e38a61fb72..0000000000 --- a/reference/swoole/swoole/server/finish.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Server::finish - Utilizado en el proceso de tarea para enviar el resultado al proceso de trabajo cuando la tarea está terminada. - - - - &reftitle.description; - - public voidSwoole\Server::finish - stringdata - - - - - - - - - &reftitle.parameters; - - - data - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/getclientinfo.xml b/reference/swoole/swoole/server/getclientinfo.xml deleted file mode 100644 index 28c99fbc82..0000000000 --- a/reference/swoole/swoole/server/getclientinfo.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Swoole\Server::getClientInfo - Devuelve la información de conexión por la descripción del fichero. - - - - &reftitle.description; - - public arraySwoole\Server::getClientInfo - intfd - intreactor_id - boolignore_error - - - - - - - - - &reftitle.parameters; - - - fd - - - Los descriptores de ficheros. - - - - - reactor_id - - - El identificador del thread Reactor donde se establece la conexión. - - - - - ignore_error - - - Ignorar los errores o no, si se establece en true, - la información de conexión será devuelta incluso si la conexión está cerrada. - - - - - - - - &reftitle.returnvalues; - - Devuelve la información sobre la conexión del cliente. - - - - - - diff --git a/reference/swoole/swoole/server/getclientlist.xml b/reference/swoole/swoole/server/getclientlist.xml deleted file mode 100644 index 8215dfb32a..0000000000 --- a/reference/swoole/swoole/server/getclientlist.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - Swoole\Server::getClientList - Devuelve todas las conexiones establecidas. - - - - &reftitle.description; - - public arraySwoole\Server::getClientList - intstart_fd - intpagesize - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - start_fd - - - - - - - - pagesize - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/getlasterror.xml b/reference/swoole/swoole/server/getlasterror.xml deleted file mode 100644 index 8df3c4ca74..0000000000 --- a/reference/swoole/swoole/server/getlasterror.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Server::getLastError - Devuelve el código de error del último error. - - - - &reftitle.description; - - public intSwoole\Server::getLastError - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/heartbeat.xml b/reference/swoole/swoole/server/heartbeat.xml deleted file mode 100644 index 5289e50971..0000000000 --- a/reference/swoole/swoole/server/heartbeat.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Server::heartbeat - Verifica todas las conexiones en el servidor. - - - - &reftitle.description; - - public mixedSwoole\Server::heartbeat - boolif_close_connection - - - - - - - - - &reftitle.parameters; - - - if_close_connection - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/listen.xml b/reference/swoole/swoole/server/listen.xml deleted file mode 100644 index d029425b59..0000000000 --- a/reference/swoole/swoole/server/listen.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - Swoole\Server::listen - Escucha en la IP y el puerto dados, tipo de socket. - - - - &reftitle.description; - - public boolSwoole\Server::listen - stringhost - intport - stringsocket_type - - - - - - - - - &reftitle.parameters; - - - host - - - - - - - - port - - - - - - - - socket_type - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/on.xml b/reference/swoole/swoole/server/on.xml deleted file mode 100644 index 835dd39a6d..0000000000 --- a/reference/swoole/swoole/server/on.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Swoole\Server::on - Registra una retrollamada por nombre de evento. - - - - &reftitle.description; - - public voidSwoole\Server::on - stringevent_name - callablecallback - - - - - - - - - &reftitle.parameters; - - - event_name - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/pause.xml b/reference/swoole/swoole/server/pause.xml deleted file mode 100644 index 738e029b25..0000000000 --- a/reference/swoole/swoole/server/pause.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Server::pause - Detiene la recepción de datos de la conexión. - - - - &reftitle.description; - - public voidSwoole\Server::pause - intfd - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/port/construct.xml b/reference/swoole/swoole/server/port/construct.xml deleted file mode 100644 index 4799f03f66..0000000000 --- a/reference/swoole/swoole/server/port/construct.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - Swoole\Server\Port::__construct - Construye un puerto de servidor - - - - &reftitle.description; - - private Swoole\Server\Port::__construct - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - - diff --git a/reference/swoole/swoole/server/port/destruct.xml b/reference/swoole/swoole/server/port/destruct.xml deleted file mode 100644 index bc0e04fafa..0000000000 --- a/reference/swoole/swoole/server/port/destruct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Server\Port::__destruct - Destruye el puerto del servidor - - - - &reftitle.description; - - public voidSwoole\Server\Port::__destruct - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/port/on.xml b/reference/swoole/swoole/server/port/on.xml deleted file mode 100644 index 15c83f2337..0000000000 --- a/reference/swoole/swoole/server/port/on.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Swoole\Server\Port::on - Registra una retrollamada por nombre de evento. - - - - &reftitle.description; - - public ReturnTypeSwoole\Server\Port::on - stringevent_name - callablecallback - - - - - - - - - &reftitle.parameters; - - - event_name - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/port/set.xml b/reference/swoole/swoole/server/port/set.xml deleted file mode 100644 index 4865e742a4..0000000000 --- a/reference/swoole/swoole/server/port/set.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Server\Port::set - Define el protocolo del puerto del servidor. - - - - &reftitle.description; - - public voidSwoole\Server\Port::set - arraysettings - - - - - - - - - &reftitle.parameters; - - - settings - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/protect.xml b/reference/swoole/swoole/server/protect.xml deleted file mode 100644 index 6924b62587..0000000000 --- a/reference/swoole/swoole/server/protect.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Swoole\Server::protect - Pone la conexión en modo protegido. - - - - &reftitle.description; - - public voidSwoole\Server::protect - intfd - boolis_protected - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - is_protected - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/reload.xml b/reference/swoole/swoole/server/reload.xml deleted file mode 100644 index e2f67e48ae..0000000000 --- a/reference/swoole/swoole/server/reload.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Server::reload - Reinicia todos los procesos de trabajo. - - - - &reftitle.description; - - public boolSwoole\Server::reload - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/resume.xml b/reference/swoole/swoole/server/resume.xml deleted file mode 100644 index f48d22adb9..0000000000 --- a/reference/swoole/swoole/server/resume.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Server::resume - Reanuda la recepción de datos desde la conexión. - - - - &reftitle.description; - - public voidSwoole\Server::resume - intfd - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/send.xml b/reference/swoole/swoole/server/send.xml deleted file mode 100644 index de77ef432c..0000000000 --- a/reference/swoole/swoole/server/send.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Swoole\Server::send - Envía datos al cliente. - - - - &reftitle.description; - - public boolSwoole\Server::send - intfd - stringdata - intreactor_id - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - fd - - - - - - - - data - - - - - - - - reactor_id - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/sendfile.xml b/reference/swoole/swoole/server/sendfile.xml deleted file mode 100644 index 245f1bc223..0000000000 --- a/reference/swoole/swoole/server/sendfile.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Swoole\Server::sendfile - Envía un fichero a la conexión. - - - - &reftitle.description; - - public boolSwoole\Server::sendfile - intfd - stringfilename - intoffset - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - fd - - - - - - - - filename - - - - - - - - offset - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/sendmessage.xml b/reference/swoole/swoole/server/sendmessage.xml deleted file mode 100644 index ed3361f8f4..0000000000 --- a/reference/swoole/swoole/server/sendmessage.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Swoole\Server::sendMessage - Envía un mensaje a los procesos de trabajo por ID. - - - - &reftitle.description; - - public boolSwoole\Server::sendMessage - intworker_id - stringdata - - - - - - - - - &reftitle.parameters; - - - dst_worker_id - - - - - - - - data - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/sendto.xml b/reference/swoole/swoole/server/sendto.xml deleted file mode 100644 index 124ee1757a..0000000000 --- a/reference/swoole/swoole/server/sendto.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Swoole\Server::sendto - Envía datos a la dirección UDP remota. - - - - &reftitle.description; - - public boolSwoole\Server::sendto - stringip - intport - stringdata - stringserver_socket - - - - - - - - - &reftitle.parameters; - - - ip - - - - - - - - port - - - - - - - - data - - - - - - - - server_socket - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/sendwait.xml b/reference/swoole/swoole/server/sendwait.xml deleted file mode 100644 index f8f48eff92..0000000000 --- a/reference/swoole/swoole/server/sendwait.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - Swoole\Server::sendwait - Envía datos al socket remoto de manera bloqueante. - - - - &reftitle.description; - - public boolSwoole\Server::sendwait - intfd - stringdata - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - fd - - - - - - - - data - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/set.xml b/reference/swoole/swoole/server/set.xml deleted file mode 100644 index 23028388b9..0000000000 --- a/reference/swoole/swoole/server/set.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Server::set - Define los parámetros de ejecución del servidor swoole. - - - - &reftitle.description; - - public ReturnTypeSwoole\Server::set - arraysettings - - - Define los parámetros de ejecución del servidor swoole. Los parámetros pueden ser accedidos por $server->setting cuando el servidor swoole ha iniciado. - - - - - - &reftitle.parameters; - - - settings - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/shutdown.xml b/reference/swoole/swoole/server/shutdown.xml deleted file mode 100644 index 5e599cbddb..0000000000 --- a/reference/swoole/swoole/server/shutdown.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Server::shutdown - Detiene el proceso del servidor maestro, esta función puede ser llamada en los procesos de trabajo. - - - - &reftitle.description; - - public voidSwoole\Server::shutdown - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/start.xml b/reference/swoole/swoole/server/start.xml deleted file mode 100644 index 532189d848..0000000000 --- a/reference/swoole/swoole/server/start.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Server::start - Inicia el servidor Swoole. - - - - &reftitle.description; - - public voidSwoole\Server::start - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/stats.xml b/reference/swoole/swoole/server/stats.xml deleted file mode 100644 index 87c2b4d590..0000000000 --- a/reference/swoole/swoole/server/stats.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Server::stats - Devuelve las estadísticas del servidor Swoole. - - - - &reftitle.description; - - public arraySwoole\Server::stats - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/stop.xml b/reference/swoole/swoole/server/stop.xml deleted file mode 100644 index d876cd84dd..0000000000 --- a/reference/swoole/swoole/server/stop.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Server::stop - Detiene el servidor Swoole. - - - - &reftitle.description; - - public boolSwoole\Server::stop - intworker_id - - - - - - - - - &reftitle.parameters; - - - worker_id - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/task.xml b/reference/swoole/swoole/server/task.xml deleted file mode 100644 index e038e2146e..0000000000 --- a/reference/swoole/swoole/server/task.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Swoole\Server::task - Envía datos a los procesos de trabajo de tarea. - - - - &reftitle.description; - - public mixedSwoole\Server::task - stringdata - intdst_worker_id - callablecallback - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - data - - - - - - - - dst_worker_id - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/taskwait.xml b/reference/swoole/swoole/server/taskwait.xml deleted file mode 100644 index 5906fa7037..0000000000 --- a/reference/swoole/swoole/server/taskwait.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Swoole\Server::taskwait - Envía datos a los procesos de trabajo de tarea de manera bloqueante. - - - - &reftitle.description; - - public voidSwoole\Server::taskwait - stringdata - floattimeout - intworker_id - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - data - - - - - - - - timeout - - - - - - - - worker_id - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/taskwaitmulti.xml b/reference/swoole/swoole/server/taskwaitmulti.xml deleted file mode 100644 index e681c42f3d..0000000000 --- a/reference/swoole/swoole/server/taskwaitmulti.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Swoole\Server::taskWaitMulti - Ejecuta varias tareas en paralelo. - - - - &reftitle.description; - - public voidSwoole\Server::taskWaitMulti - arraytasks - floattimeout_ms - - - - - - - - - &reftitle.parameters; - - - tasks - - - - - - - - timeout_ms - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/server/tick.xml b/reference/swoole/swoole/server/tick.xml deleted file mode 100644 index 2cbf8fa158..0000000000 --- a/reference/swoole/swoole/server/tick.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Swoole\Server::tick - Repite una función dada a cada intervalo de tiempo dado. - - - - &reftitle.description; - - public voidSwoole\Server::tick - intinterval_ms - callablecallback - - - - - - - - - &reftitle.parameters; - - - interval_ms - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/table/column.xml b/reference/swoole/swoole/table/column.xml deleted file mode 100644 index f212a95376..0000000000 --- a/reference/swoole/swoole/table/column.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Swoole\Table::column - Define el tipo de datos y el tamaño de las columnas. - - - - &reftitle.description; - - public boolSwoole\Table::column - stringname - stringtype - intsize - - - - - - - - - &reftitle.parameters; - - - name - - - Especifica el nombre del campo. - - - - - - type - - - Especifica el tipo del campo. - - - - - size - - - Especifica el tamaño del campo. - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/table/construct.xml b/reference/swoole/swoole/table/construct.xml deleted file mode 100644 index 758c168184..0000000000 --- a/reference/swoole/swoole/table/construct.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - Swoole\Table::__construct - Construye una tabla de memoria Swoole de tamaño fijo. - - - - &reftitle.description; - - public Swoole\Table::__construct - inttable_size - - - - - - - - - &reftitle.parameters; - - - table_size - - - - - - - - - - - - - - diff --git a/reference/swoole/swoole/table/count.xml b/reference/swoole/swoole/table/count.xml deleted file mode 100644 index f732fd6d9d..0000000000 --- a/reference/swoole/swoole/table/count.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Table::count - Cuenta las filas en la tabla, o cuenta todos los elementos en la tabla si $mode = 1. - - - - &reftitle.description; - - public intSwoole\Table::count - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/table/create.xml b/reference/swoole/swoole/table/create.xml deleted file mode 100644 index e4e4ee3d0b..0000000000 --- a/reference/swoole/swoole/table/create.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Table::create - Crear la tabla de memoria swoole. - - - - &reftitle.description; - - public boolSwoole\Table::create - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/table/current.xml b/reference/swoole/swoole/table/current.xml deleted file mode 100644 index 5d1c3c3232..0000000000 --- a/reference/swoole/swoole/table/current.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Table::current - Devuelve la fila actual. - - - - &reftitle.description; - - public arraySwoole\Table::current - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/table/decr.xml b/reference/swoole/swoole/table/decr.xml deleted file mode 100644 index 6bd9e78f9f..0000000000 --- a/reference/swoole/swoole/table/decr.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - Swoole\Table::decr - Disminuye el valor en la tabla Swoole por $key y $column - - - - &reftitle.description; - - public intSwoole\Table::decr - stringkey - stringcolumn - intdecrby - - - - - - - - - &reftitle.parameters; - - - key - - - Clave de los datos. - - - - - column - - - Especifica el nombre de la columna. - - - - - decrby - - - Valor de decremento. - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/table/del.xml b/reference/swoole/swoole/table/del.xml deleted file mode 100644 index 6905c8259f..0000000000 --- a/reference/swoole/swoole/table/del.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Table::del - Elimina una fila en la tabla Swoole mediante $key - - - - &reftitle.description; - - public boolSwoole\Table::del - stringkey - - - - - - - - - &reftitle.parameters; - - - key - - - Clave para identificar la fila a eliminar - - - - - - - - &reftitle.returnvalues; - - Devuelve true si la operación fue exitosa, false en caso contrario - - - - - - diff --git a/reference/swoole/swoole/table/destroy.xml b/reference/swoole/swoole/table/destroy.xml deleted file mode 100644 index f5b765069d..0000000000 --- a/reference/swoole/swoole/table/destroy.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Table::destroy - Destruye la tabla Swoole. - - - - &reftitle.description; - - public boolSwoole\Table::destroy - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/table/exist.xml b/reference/swoole/swoole/table/exist.xml deleted file mode 100644 index ffd29832f2..0000000000 --- a/reference/swoole/swoole/table/exist.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\Table::exist - Verifica si una fila existe por $row_key. - - - - &reftitle.description; - - public boolSwoole\Table::exist - stringkey - - - - - - - - - &reftitle.parameters; - - - key - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/table/get.xml b/reference/swoole/swoole/table/get.xml deleted file mode 100644 index 1e64cda754..0000000000 --- a/reference/swoole/swoole/table/get.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Swoole\Table::get - Devuelve el valor en la tabla Swoole mediante $key y $field. - - - - &reftitle.description; - - public mixedSwoole\Table::get - stringkey - stringfield - - - Este método permite obtener un valor almacenado en una tabla Swoole mediante una clave y un campo específico. - - - - - - &reftitle.parameters; - - - key - - - La clave utilizada para identificar la fila en la tabla Swoole. - - - - - field - - - El nombre del campo del cual se desea obtener el valor. Si no se especifica, se devuelve todo el array asociativo de la fila. - - - - - - - - &reftitle.returnvalues; - - El valor asociado a la clave y campo especificados, o el array completo de la fila si no se especifica campo. En caso de no existir la clave, se devuelve NULL. - - - - - - diff --git a/reference/swoole/swoole/table/incr.xml b/reference/swoole/swoole/table/incr.xml deleted file mode 100644 index 972a5271e9..0000000000 --- a/reference/swoole/swoole/table/incr.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - Swoole\Table::incr - Incrementa el valor por $key y $column - - - - &reftitle.description; - - public intSwoole\Table::incr - stringkey - stringcolumn - intincrby - - - - - - - - - &reftitle.parameters; - - - key - - - Clave para los datos. - - - - - column - - - Especifica el nombre de la columna. - - - - - incrby - - - Valor de incremento. - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/table/key.xml b/reference/swoole/swoole/table/key.xml deleted file mode 100644 index b75c11ba2f..0000000000 --- a/reference/swoole/swoole/table/key.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Table::key - Devuelve la clave de la fila actual. - - - - &reftitle.description; - - public mixedSwoole\Table::key - - - - Este método permite obtener la clave de la fila actual en una tabla Swoole. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El valor devuelto es de tipo mixed, correspondiente a la clave de la fila actual. - - - - - - diff --git a/reference/swoole/swoole/table/next.xml b/reference/swoole/swoole/table/next.xml deleted file mode 100644 index fddf0142fb..0000000000 --- a/reference/swoole/swoole/table/next.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Swoole\Table::next - Avanza el iterador a la siguiente fila - - - - &reftitle.description; - - public voidSwoole\Table::next - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/swoole/swoole/table/rewind.xml b/reference/swoole/swoole/table/rewind.xml deleted file mode 100644 index 96ab7f6f03..0000000000 --- a/reference/swoole/swoole/table/rewind.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Table::rewind - Reinicializa el iterador. - - - - &reftitle.description; - - public voidSwoole\Table::rewind - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/table/set.xml b/reference/swoole/swoole/table/set.xml deleted file mode 100644 index 3b5b1ae354..0000000000 --- a/reference/swoole/swoole/table/set.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Swoole\Table::set - Actualiza una línea de la tabla mediante $key. - - - - &reftitle.description; - - public boolSwoole\Table::set - stringkey - arrayvalue - - - - - - - - - &reftitle.parameters; - - - key - - - La clave de los datos. - - - - - value - - - El valor de los datos. - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/table/valid.xml b/reference/swoole/swoole/table/valid.xml deleted file mode 100644 index 8901ba6781..0000000000 --- a/reference/swoole/swoole/table/valid.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Swoole\Table::valid - Verifica si la línea actual es válida. - - - - &reftitle.description; - - public boolSwoole\Table::valid - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/timer/after.xml b/reference/swoole/swoole/timer/after.xml deleted file mode 100644 index 63dd7545fc..0000000000 --- a/reference/swoole/swoole/timer/after.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - Swoole\Timer::after - Ejecuta una función después de un tiempo determinado - - - - &reftitle.description; - - public static intfalseSwoole\Timer::after - intms - callablecallback - mixedparams - - - Crea un temporizador de un solo disparo, que se destruye una vez ejecutada - su retrollamada. A diferencia de sleep, no bloquea el - proceso actual. - - - - - &reftitle.parameters; - - - ms - - - El retardo en milisegundos. Debe ser mayor o igual que - 1; un valor inferior emite un - E_WARNING y la llamada falla. - - - - - callback - - - La función a ejecutar una vez transcurrido el retardo. Se llama como - callback(mixed ...$params). A diferencia de - Swoole\Timer::tick, el identificador del - temporizador no se pasa a la retrollamada. - - - - - params - - - Valores adicionales que se pasan a callback. - - - - - - - - &reftitle.returnvalues; - - Devuelve el identificador del temporizador, que puede pasarse a - Swoole\Timer::clear para cancelarlo antes de que se - dispare. Devuelve &false; si el temporizador no ha podido crearse, en - particular cuando ms es menor que - 1. - - - - - &reftitle.examples; - - Ejemplo de <function>Swoole\Timer::after</function> - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/swoole/swoole/timer/clear.xml b/reference/swoole/swoole/timer/clear.xml deleted file mode 100644 index 7e4e24a1e6..0000000000 --- a/reference/swoole/swoole/timer/clear.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Swoole\Timer::clear - Elimina un temporizador por su identificador - - - - &reftitle.description; - - public static boolSwoole\Timer::clear - inttimer_id - - - Elimina el temporizador con el identificador indicado. Solo pueden - eliminarse los temporizadores creados por el proceso actual; los - temporizadores que pertenecen a otros procesos no son visibles aquí. - - - - - &reftitle.parameters; - - - timer_id - - - El identificador del temporizador devuelto por - Swoole\Timer::tick o - Swoole\Timer::after. - - - - - - - - &reftitle.returnvalues; - - &return.success; - Se devuelve &false; cuando no existe ningún temporizador con este - identificador en el proceso actual, o cuando el identificador corresponde a - un temporizador interno. - - - - - &reftitle.examples; - - Ejemplo de <function>Swoole\Timer::clear</function> - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/swoole/swoole/timer/clearAll.xml b/reference/swoole/swoole/timer/clearAll.xml deleted file mode 100644 index 52a9799b4d..0000000000 --- a/reference/swoole/swoole/timer/clearAll.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - Swoole\Timer::clearAll - Elimina todos los temporizadores del proceso actual. - - - - &reftitle.description; - - public static boolSwoole\Timer::clearAll - - - - Elimina todos los temporizadores del proceso actual. A partir de Swoole 4.4.0. - - - - - &reftitle.returnvalues; - - &return.success; - Se devuelve &false; cuando todavía no se ha creado ningún temporizador en - este proceso. Solo se eliminan los temporizadores creados desde PHP; los - temporizadores internos se mantienen. - - - - - diff --git a/reference/swoole/swoole/timer/exists.xml b/reference/swoole/swoole/timer/exists.xml deleted file mode 100644 index 758e533cb3..0000000000 --- a/reference/swoole/swoole/timer/exists.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - Swoole\Timer::exists - Comprueba si un temporizador existe - - - - &reftitle.description; - - public static boolSwoole\Timer::exists - inttimer_id - - - Comprueba si existe en el proceso actual un temporizador con el - identificador indicado. - - - - - - &reftitle.parameters; - - - timer_id - - - El identificador del temporizador devuelto por - Swoole\Timer::tick o - Swoole\Timer::after. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si existe un temporizador con este identificador en el - proceso actual, y &false; en caso contrario. - - - - - - - diff --git a/reference/swoole/swoole/timer/info.xml b/reference/swoole/swoole/timer/info.xml deleted file mode 100644 index 83d5435b79..0000000000 --- a/reference/swoole/swoole/timer/info.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - Swoole\Timer::info - Obtiene información sobre un temporizador. - - - - &reftitle.description; - - public static arraynullSwoole\Timer::info - inttimer_id - - - Obtiene información sobre un temporizador. A partir de Swoole 4.4.0. - - - - - &reftitle.parameters; - - - timer_id - - - El identificador del temporizador devuelto por - Swoole\Timer::tick o - Swoole\Timer::after. - - - - - - - - &reftitle.returnvalues; - - Devuelve un array que describe el temporizador, o &null; si no existe - ningún temporizador con este identificador en el proceso actual. El array - contiene las siguientes claves: - - - - exec_msec - - - El instante de la siguiente ejecución, en milisegundos, contado desde el - momento en que se inició el subsistema de temporizadores. No es una - duración. - - - - - exec_count - - - El número de veces que se ha ejecutado la retrollamada. - Disponible a partir de Swoole 4.8.0. - - - - - interval - - - El intervalo del temporizador, en milisegundos. - - - - - round - - - El número de la vuelta del bucle de temporizadores en la que se creó el - temporizador. - - - - - removed - - - Indica si el temporizador ha sido eliminado. - - - - - - - - &reftitle.examples; - - Ejemplo de <function>Swoole\Timer::info</function> - - -]]> - - &example.outputs.similar; - - - int(1000) - ["exec_count"]=> - int(0) - ["interval"]=> - int(1000) - ["round"]=> - int(0) - ["removed"]=> - bool(false) -} -]]> - - - - - - diff --git a/reference/swoole/swoole/timer/list.xml b/reference/swoole/swoole/timer/list.xml deleted file mode 100644 index 9c3a2461b3..0000000000 --- a/reference/swoole/swoole/timer/list.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - Swoole\Timer::list - Obtiene un iterador sobre los temporizadores del proceso actual - - - - &reftitle.description; - - public static Swoole\Timer\IteratorSwoole\Timer::list - - - - Devuelve un iterador sobre los identificadores de los temporizadores creados - desde PHP en el proceso actual. Los temporizadores creados internamente por - Swoole no se enumeran. A partir de Swoole 4.4.0. - - - - - &reftitle.returnvalues; - - Devuelve un objeto Swoole\Timer\Iterator, que extiende - ArrayIterator y proporciona los identificadores de - los temporizadores como valores int. El iterador es una - instantánea tomada en el momento de la llamada; está vacío cuando no existe - ningún temporizador. - - - - - &reftitle.examples; - - Ejemplo de <function>Swoole\Timer::list</function> - - -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/swoole/swoole/timer/set.xml b/reference/swoole/swoole/timer/set.xml deleted file mode 100644 index 5b34729ac2..0000000000 --- a/reference/swoole/swoole/timer/set.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - Swoole\Timer::set - Define los parámetros relacionados con los temporizadores - - - - &reftitle.description; - - public static voidSwoole\Timer::set - arraysettings - - - Define las opciones utilizadas por los temporizadores del proceso actual. - - - - - Este método quedó obsoleto en Swoole 4.6.0 y se eliminó en Swoole 6.0.0. - Utilice swoole_async_set en su lugar. - - - - - - &reftitle.parameters; - - - settings - - - Un array asociativo de opciones. Solo se reconoce - enable_coroutine: cuando vale &false;, las - retrollamadas de los temporizadores se ejecutan directamente y no dentro - de una corrutina creada al efecto. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/swoole/swoole/timer/stats.xml b/reference/swoole/swoole/timer/stats.xml deleted file mode 100644 index cba8c59ba9..0000000000 --- a/reference/swoole/swoole/timer/stats.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Swoole\Timer::stats - Obtiene estadísticas de los temporizadores. - - - - &reftitle.description; - - public static arraySwoole\Timer::stats - - - - Obtiene estadísticas de los temporizadores. A partir de Swoole 4.4.0. - - - - - &reftitle.returnvalues; - - Devuelve un array con las siguientes claves: - - - - initialized - - - Indica si el subsistema de temporizadores ha sido iniciado. Vale &false; - hasta que se crea el primer temporizador. - - - - - num - - - El número de temporizadores registrados actualmente en el proceso. - - - - - round - - - La vuelta actual del bucle de temporizadores. - - - - - - - - &reftitle.examples; - - Ejemplo de <function>Swoole\Timer::stats</function> - - -]]> - - &example.outputs.similar; - - - bool(true) - ["num"]=> - int(1) - ["round"]=> - int(0) -} -]]> - - - - - - diff --git a/reference/swoole/swoole/timer/tick.xml b/reference/swoole/swoole/timer/tick.xml deleted file mode 100644 index 4bb5618563..0000000000 --- a/reference/swoole/swoole/timer/tick.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - Swoole\Timer::tick - Define un temporizador de intervalo repetitivo - - - - &reftitle.description; - - public static intfalseSwoole\Timer::tick - intms - callablecallback - mixedparams - - - Define un temporizador que se dispara cada ms - milisegundos. A diferencia de un temporizador creado con - Swoole\Timer::after, sigue disparándose hasta que - se elimina con Swoole\Timer::clear. - - - - - &reftitle.parameters; - - - ms - - - El intervalo en milisegundos. Debe ser mayor o igual que - 1; un valor inferior emite un - E_WARNING y la llamada falla. - - - - - callback - - - La función a ejecutar en cada disparo. Se llama como - callback(int $timer_id, mixed ...$params): el - identificador del temporizador se pasa como primer argumento, seguido de - los valores indicados en params. - - - - - params - - - Valores adicionales que se pasan a callback - después del identificador del temporizador. - - - - - - - - &reftitle.returnvalues; - - Devuelve el identificador del temporizador, que puede pasarse a - Swoole\Timer::clear. Devuelve &false; si el - temporizador no ha podido crearse, en particular cuando - ms es menor que 1. - - - - - &reftitle.examples; - - Ejemplo de <function>Swoole\Timer::tick</function> - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/swoole/swoole/websocket/server/exist.xml b/reference/swoole/swoole/websocket/server/exist.xml deleted file mode 100644 index 9f860c9029..0000000000 --- a/reference/swoole/swoole/websocket/server/exist.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\WebSocket\Server::exist - Verifica si el descriptor de fichero existe. - - - - &reftitle.description; - - public boolSwoole\WebSocket\Server::exist - intfd - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/websocket/server/on.xml b/reference/swoole/swoole/websocket/server/on.xml deleted file mode 100644 index 3866222b4c..0000000000 --- a/reference/swoole/swoole/websocket/server/on.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Swoole\WebSocket\Server::on - Registra la función de retrollamada del evento - - - - &reftitle.description; - - public ReturnTypeSwoole\WebSocket\Server::on - stringevent_name - callablecallback - - - Registra la función de retrollamada del evento - - - - - - &reftitle.parameters; - - - event_name - - - - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/websocket/server/pack.xml b/reference/swoole/swoole/websocket/server/pack.xml deleted file mode 100644 index a76a000a31..0000000000 --- a/reference/swoole/swoole/websocket/server/pack.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Swoole\WebSocket\Server::pack - Devuelve un paquete de datos binarios para enviar en una sola trama. - - - - &reftitle.description; - - public static binarySwoole\WebSocket\Server::pack - stringdata - stringopcode - stringfinish - stringmask - - - - - - - - - &reftitle.parameters; - - - data - - - - - - - - opcode - - - - - - - - finish - - - - - - - - mask - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/websocket/server/push.xml b/reference/swoole/swoole/websocket/server/push.xml deleted file mode 100644 index 81e578cfb0..0000000000 --- a/reference/swoole/swoole/websocket/server/push.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Swoole\WebSocket\Server::push - Envía los datos al cliente remoto. - - - - &reftitle.description; - - public voidSwoole\WebSocket\Server::push - stringfd - stringdata - stringopcode - stringfinish - - - - - - - - - &reftitle.parameters; - - - fd - - - - - - - - data - - - - - - - - opcode - - - - - - - - finish - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/swoole/swoole/websocket/server/unpack.xml b/reference/swoole/swoole/websocket/server/unpack.xml deleted file mode 100644 index fea94e5a5b..0000000000 --- a/reference/swoole/swoole/websocket/server/unpack.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Swoole\WebSocket\Server::unpack - Descomprime los datos binarios recibidos del cliente. - - - - &reftitle.description; - - public static stringSwoole\WebSocket\Server::unpack - binarydata - - - - - - - - - &reftitle.parameters; - - - data - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/sync/book.xml b/reference/sync/book.xml deleted file mode 100644 index 8e6df1ec56..0000000000 --- a/reference/sync/book.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - Sync - Sync - - - &reftitle.intro; - - La extensión sync introduce la sincronización de objetos multiplataforma en PHP. - Los Mutex nombrados o no, los semáforos, los eventos, los objetos de - lectura-escritura y la memoria compartida se beneficiarán de una sincronización a nivel del sistema operativo tanto en - los sistemas POSIX (i.e. Linux) como en los sistemas Windows. - - - Una limpieza automática de los objetos que han obtenido una sincronización - se realiza al desmontar la extensión. Esto significa que si PHP termina prematuramente - un script (i.e. el script excede su tiempo máximo de ejecución), los objetos - no se dejarán en un estado desconocido. La única excepción a este mecanismo - es si PHP mismo se bloquea (i.e. un desbordamiento de buffer interno). - - - La sincronización de los objetos no nombrados no tiene utilidad fuera de un - escenario multihilo. Los objetos no nombrados son más útiles en conjunción - con la extensión PECL pthreads. - - - - Los objetos nombrados requieren atención adicional para ser utilizados - en todos los sistemas. Si un objeto se instancia con un conjunto específico de - parámetros, siempre debe ser instanciado con estos parámetros o el objeto - probablemente terminará en un estado no consistente hasta el próximo - reinicio o hasta que un administrador los limpie. - - - - - &reference.sync.setup; - &reference.sync.syncmutex; - &reference.sync.syncsemaphore; - &reference.sync.syncevent; - &reference.sync.syncreaderwriter; - &reference.sync.syncsharedmemory; - - - diff --git a/reference/sync/configure.xml b/reference/sync/configure.xml deleted file mode 100644 index f009cec861..0000000000 --- a/reference/sync/configure.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;sync - - -
    - diff --git a/reference/sync/setup.xml b/reference/sync/setup.xml deleted file mode 100644 index 838532c27d..0000000000 --- a/reference/sync/setup.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Un sistema con soporte POSIX de memoria compartida (shm_open()) o funcionando bajo Windows. - -
    - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;sync. - -
    - -
    - diff --git a/reference/sync/syncevent.xml b/reference/sync/syncevent.xml deleted file mode 100644 index cb92373d76..0000000000 --- a/reference/sync/syncevent.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - La clase SyncEvent - SyncEvent - - - - -
    - &reftitle.intro; - - Una implementación multiplataforma nativa de objetos de eventos nombrados o sin nombre. - Se soportan tanto los objetos de eventos automáticos como manuales. - - - Un objeto de evento espera, sin cola, que los objetos sean lanzados/definidos. - Una instancia espera en el objeto de evento mientras otra lanza/define el evento. - Los objetos de eventos son útiles a lo largo de un proceso largo (i.e. verificar si una descarga de datos debe ser analizada). - -
    - - -
    - &reftitle.classsynopsis; - - - - SyncEvent - - - - - SyncEvent - - - - - &Methods; - - - - -
    - -
    - - &reference.sync.entities.syncevent; - -
    - diff --git a/reference/sync/syncevent/construct.xml b/reference/sync/syncevent/construct.xml deleted file mode 100644 index fce30c8044..0000000000 --- a/reference/sync/syncevent/construct.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - - SyncEvent::__construct - Construye un nuevo objeto SyncEvent - - - - &reftitle.description; - - public SyncEvent::__construct - stringname - boolmanual&false; - boolprefire&false; - - - Construye un objeto de evento nombrado o no. - - - - - &reftitle.parameters; - - - name - - - El nombre del evento si es un objeto de evento nombrado. - - - - Si el nombre ya existe, debe ser posible abrirlo con el usuario - actual que ejecuta el proceso, o se lanzará una excepción - con el contenido del mensaje de error. - - - - - - manual - - - Especifica si el objeto de evento debe ser reinicializado manualmente o no. - - - - La reinicialización manual de los objetos de eventos permite la - puesta en espera de los procesos hasta que el objeto sea reinicializado. - - - - - - prefire - - - Especifica si se debe o no pre-enviar (la señal) - al objeto de evento. - - - - Solo tiene impacto si la llamada al proceso/hilo - es el primero en crear el objeto. - - - - - - - - - &reftitle.returnvalues; - - El nuevo objeto SyncEvent. - - - - - &reftitle.errors; - - Se lanza una excepción si el objeto de evento - no puede ser creado o abierto. - - - - - &reftitle.examples; - - Ejemplo con <function>SyncEvent::__construct</function> - -fire(); - -// En un cron: -$event = new SyncEvent("GetAppReport"); -$event->wait(); -?> -]]> - - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL sync 1.1.0 - - - Adición del parámetro prefire. - - - - - - - - - - &reftitle.seealso; - - SyncEvent::fire - SyncEvent::reset - SyncEvent::wait - - - - - diff --git a/reference/sync/syncevent/fire.xml b/reference/sync/syncevent/fire.xml deleted file mode 100644 index dc73138b02..0000000000 --- a/reference/sync/syncevent/fire.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - SyncEvent::fire - Lanza/define el evento - - - - &reftitle.description; - - public boolSyncEvent::fire - - - - Lanza/define un objeto SyncEvent. Mantiene varios hilos en espera - si el objeto de evento ha sido creado con un valor manual a &true;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>SyncEvent::fire</function> - -fire(); - -// En un cron: -$event = new SyncEvent("GetAppReport"); -$event->wait(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncEvent::reset - SyncEvent::wait - - - - - diff --git a/reference/sync/syncevent/reset.xml b/reference/sync/syncevent/reset.xml deleted file mode 100644 index c609456ed6..0000000000 --- a/reference/sync/syncevent/reset.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - SyncEvent::reset - Reinicializa manualmente un evento - - - - &reftitle.description; - - public boolSyncEvent::reset - - - - Reinicializa un objeto SyncEvent que ha sido lanzado/definido. Solo válido para - los objetos de evento manuales. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>SyncEvent::reset</function> - -wait(); - -// En un cron: -$event = new SyncEvent("DemoApplication", true); -$event->reset(); -/* ... Realizar algunas tareas de mantenimiento ... */ -$event->fire(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncEvent::fire - SyncEvent::reset - SyncEvent::wait - - - - - diff --git a/reference/sync/syncevent/wait.xml b/reference/sync/syncevent/wait.xml deleted file mode 100644 index 02cde30575..0000000000 --- a/reference/sync/syncevent/wait.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - SyncEvent::wait - Espera a que el objeto SyncEvent sea lanzado - - - - &reftitle.description; - - public boolSyncEvent::wait - intwait-1 - - - Espera a que el objeto SyncEvent sea lanzado. - - - - - &reftitle.parameters; - - - wait - - - El número de milisegundos a esperar a que el evento sea lanzado. - Un valor de -1 significa que se espera indefinidamente. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>SyncEvent::wait</function> - -fire(); - -// En un cron: -$event = new SyncEvent("GetAppReport"); -$event->wait(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncEvent::fire - - - - - diff --git a/reference/sync/syncmutex.xml b/reference/sync/syncmutex.xml deleted file mode 100644 index 1ed188163c..0000000000 --- a/reference/sync/syncmutex.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - La clase SyncMutex - SyncMutex - - - - -
    - &reftitle.intro; - - Una implementación multiplataforma, nativa de los objetos Mutex nombrados o no nombrados. - - - Un Mutex es un objeto de exclusión mutua que restringe el acceso a un recurso compartido - (i.e. un fichero) a una sola instancia. Los Mutex contables adquieren el mutex una - sola vez y, internamente, rastrean el número de veces que el mutex es bloqueado. - El Mutex es desbloqueado tan pronto como sale del ámbito o es desbloqueado el - mismo número de veces que ha sido bloqueado. - -
    - - -
    - &reftitle.classsynopsis; - - - - SyncMutex - - - - - SyncMutex - - - - - &Methods; - - - - -
    - -
    - - &reference.sync.entities.syncmutex; - -
    - diff --git a/reference/sync/syncmutex/construct.xml b/reference/sync/syncmutex/construct.xml deleted file mode 100644 index 0e14fd8fce..0000000000 --- a/reference/sync/syncmutex/construct.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - - SyncMutex::__construct - Construye un nuevo objeto SyncMutex - - - - &reftitle.description; - - public SyncMutex::__construct - stringname - - - Construye un objeto contable nombrado o no. - - - - - &reftitle.parameters; - - - name - - - El nombre del mutex si se trata de un objeto mutex nombrado. - - - - Si el nombre ya existe, debe ser capaz de ser abierto por el usuario - actual ejecutando el proceso, o bien se lanzará una excepción - con el mensaje de error correspondiente. - - - - - - - - - &reftitle.returnvalues; - - El nuevo objeto SyncMutex. - - - - - &reftitle.errors; - - Se lanza una excepción si el mutex no puede - ser creado o abierto. - - - - - &reftitle.examples; - - Ejemplo con <function>SyncMutex::__construct</function> - y un mutex nombrado con un tiempo de espera máximo para el bloqueo - -lock(3000)) -{ - echo "Imposible bloquear el mutex."; - - exit(); -} - -/* ... */ - -$mutex->unlock(); -?> -]]> - - - - Ejemplo con <function>SyncMutex::__construct</function> - y un mutex no nombrado - -lock(); - -/* ... */ - -$mutex->unlock(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncMutex::lock - SyncMutex::unlock - - - - - diff --git a/reference/sync/syncmutex/lock.xml b/reference/sync/syncmutex/lock.xml deleted file mode 100644 index 33dd3795c2..0000000000 --- a/reference/sync/syncmutex/lock.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - SyncMutex::lock - Obtiene un bloqueo exclusivo - - - - &reftitle.description; - - public boolSyncMutex::lock - intwait-1 - - - Obtiene un bloqueo exclusivo sobre un objeto SyncMutex. - Si el bloqueo ya está adquirido, entonces este método incrementará el contador interno. - - - - - &reftitle.parameters; - - - wait - - - El número de milisegundos a esperar para la obtención del bloqueo exclusivo. - Un valor de -1 significa que se espera indefinidamente. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>SyncMutex::lock</function> - -lock(3000)) -{ - echo "Imposible bloquear el mutex."; - - exit(); -} - -/* ... */ - -$mutex->unlock(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncMutex::unlock - - - - - diff --git a/reference/sync/syncmutex/unlock.xml b/reference/sync/syncmutex/unlock.xml deleted file mode 100644 index 215a629235..0000000000 --- a/reference/sync/syncmutex/unlock.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - SyncMutex::unlock - Desbloquea el mutex - - - - &reftitle.description; - - public boolSyncMutex::unlock - boolall&false; - - - Decrementa el contador interno de un objeto SyncMutex. - Cuando el contador interno llega a cero, el bloqueo actual - del objeto se libera. - - - - - &reftitle.parameters; - - - all - - - Especifica si se debe o no establecer el contador interno a cero - y, por lo tanto, liberar el bloqueo. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>SyncMutex::unlock</function> - -lock(); - -/* ... */ - -$mutex->unlock(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncMutex::lock - - - - - diff --git a/reference/sync/syncreaderwriter.xml b/reference/sync/syncreaderwriter.xml deleted file mode 100644 index 4434e649b5..0000000000 --- a/reference/sync/syncreaderwriter.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - La clase SyncReaderWriter - SyncReaderWriter - - - - -
    - &reftitle.intro; - - Una implementación multiplataforma, nativa de los objetos de lectura-escritura nombrados o no. - - - Un objeto de lectura-escritura permite múltiples lecturas o una escritura para acceder a un recurso. Es una solución eficiente para gestionar los recursos donde el acceso es originalmente de solo lectura, pero un acceso de escritura es ocasionalmente necesario. - -
    - - -
    - &reftitle.classsynopsis; - - - - SyncReaderWriter - - - - - SyncReaderWriter - - - - - &Methods; - - - - -
    - -
    - - &reference.sync.entities.syncreaderwriter; - -
    - diff --git a/reference/sync/syncreaderwriter/construct.xml b/reference/sync/syncreaderwriter/construct.xml deleted file mode 100644 index e25426a0f5..0000000000 --- a/reference/sync/syncreaderwriter/construct.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - SyncReaderWriter::__construct - Construye un nuevo objeto SyncReaderWriter - - - - &reftitle.description; - - public SyncReaderWriter::__construct - stringname - intautounlock1 - - - Construye un objeto de lectura/escritura nombrado o no. - - - - - &reftitle.parameters; - - - name - - - El nombre del objeto si está nombrado. - - - - Si el nombre ya existe, el objeto debe poder ser abierto con el usuario - actual que ejecuta el proceso, o se emitirá una excepción conteniendo - el mensaje de error. - - - - - En Windows, name no debe contener barras invertidas. - - - - - - autounlock - - - Especifica si se debe desbloquear automáticamente el objeto al final del - script PHP. - - - - Si el objeto es un objeto de lectura/escritura con el autounlock en &false;, - el objeto está bloqueado en lectura o en escritura, y el script PHP - terminará antes del desbloqueo del objeto, y por lo tanto, el objeto - subyacente terminará en un estado no consistente. - - - - - - - - - &reftitle.returnvalues; - - El nuevo objeto SyncReaderWriter. - - - - - &reftitle.errors; - - Se emite una excepción si el objeto de - lectura/escritura no puede ser creado o abierto. - - - - - &reftitle.examples; - - Ejemplo con <function>SyncReaderWriter::__construct</function> - -readlock(); -/* ... */ -$readwrite->readunlock(); - -$readwrite->writelock(); -/* ... */ -$readwrite->writeunlock(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncReaderWriter::readlock - SyncReaderWriter::readunlock - SyncReaderWriter::writelock - SyncReaderWriter::writeunlock - - - - - diff --git a/reference/sync/syncreaderwriter/readlock.xml b/reference/sync/syncreaderwriter/readlock.xml deleted file mode 100644 index c837d3aeb0..0000000000 --- a/reference/sync/syncreaderwriter/readlock.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - SyncReaderWriter::readlock - Obtiene un bloqueo de lectura - - - - &reftitle.description; - - public boolSyncReaderWriter::readlock - intwait-1 - - - Obtiene un bloqueo de lectura en un objeto SyncReaderWriter. - - - - - &reftitle.parameters; - - - wait - - - El número de milisegundos de espera para obtener un bloqueo. Un valor de -1 significa - que se espera indefinidamente. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>SyncReaderWriter::readlock</function> - -readlock(); -/* ... */ -$readwrite->readunlock(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncReaderWriter::readunlock - - - - - diff --git a/reference/sync/syncreaderwriter/readunlock.xml b/reference/sync/syncreaderwriter/readunlock.xml deleted file mode 100644 index 254b60d91a..0000000000 --- a/reference/sync/syncreaderwriter/readunlock.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - SyncReaderWriter::readunlock - Libera un bloqueo de lectura - - - - &reftitle.description; - - public boolSyncReaderWriter::readunlock - - - - Libera un bloqueo de lectura sobre un objeto SyncReaderWriter. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>SyncReaderWriter::readunlock</function> - -readlock(); -/* ... */ -$readwrite->readunlock(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncReaderWriter::readlock - - - - - diff --git a/reference/sync/syncreaderwriter/writelock.xml b/reference/sync/syncreaderwriter/writelock.xml deleted file mode 100644 index a07dc4171f..0000000000 --- a/reference/sync/syncreaderwriter/writelock.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - SyncReaderWriter::writelock - Espera un bloqueo de escritura exclusivo - - - - &reftitle.description; - - public boolSyncReaderWriter::writelock - intwait-1 - - - Obtiene un bloqueo de escritura exclusivo sobre un objeto SyncReaderWriter. - - - - - &reftitle.parameters; - - - wait - - - El número de milisegundos para esperar el bloqueo. - Un valor de -1 significa que se espera indefinidamente. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>SyncReaderWriter::writelock</function> - -writelock(); -/* ... */ -$readwrite->writeunlock(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncReaderWriter::writeunlock - - - - - diff --git a/reference/sync/syncreaderwriter/writeunlock.xml b/reference/sync/syncreaderwriter/writeunlock.xml deleted file mode 100644 index cfc626bb3c..0000000000 --- a/reference/sync/syncreaderwriter/writeunlock.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - SyncReaderWriter::writeunlock - Libera un bloqueo de escritura - - - - &reftitle.description; - - public boolSyncReaderWriter::writeunlock - - - - Libera un bloqueo de escritura en un objeto SyncReaderWriter. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>SyncReaderWriter::writeunlock</function> - -writelock(); -/* ... */ -$readwrite->writeunlock(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncReaderWriter::writelock - - - - - diff --git a/reference/sync/syncsemaphore.xml b/reference/sync/syncsemaphore.xml deleted file mode 100644 index dee9c9fb7a..0000000000 --- a/reference/sync/syncsemaphore.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - La clase SyncSemaphore - SyncSemaphore - - - - -
    - &reftitle.intro; - - Una implementación multiplataforma, nativa de los objetos Semáforo nombrados o no nombrados. - - - Un semáforo restringe el acceso a un recurso limitado a un número limitado - de instancias. Los semáforos difieren de los mutexes en el sentido de que permiten - a más de una instancia acceder a un recurso al mismo tiempo, mientras que el mutex - solo permite una instancia a la vez. - -
    - - -
    - &reftitle.classsynopsis; - - - - SyncSemaphore - - - - - SyncSemaphore - - - - - &Methods; - - - - -
    - -
    - - &reference.sync.entities.syncsemaphore; - -
    - diff --git a/reference/sync/syncsemaphore/construct.xml b/reference/sync/syncsemaphore/construct.xml deleted file mode 100644 index 4fcb4c2c58..0000000000 --- a/reference/sync/syncsemaphore/construct.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - - SyncSemaphore::__construct - Construye un nuevo objeto SyncSemaphore - - - - &reftitle.description; - - public SyncSemaphore::__construct - stringname - intinitialval1 - boolautounlock&true; - - - Construye un semáforo con nombre o sin nombre. - - - - - &reftitle.parameters; - - - name - - - El nombre del semáforo si tiene nombre. - - - - Si el nombre ya existe, el objeto debe poder ser abierto por el usuario - actual que ejecuta el proceso, o se emitirá una excepción con el mensaje de error. - - - - - - initialval - - - El valor inicial del semáforo. Este será el número de bloqueos que pueden - ser obtenidos. - - - - - autounlock - - - Especifica si se debe desbloquear automáticamente el semáforo al final del script PHP. - - - - Si el objeto es un semáforo con nombre cuyo autounlock es &false;, el objeto está bloqueado, y el script PHP termina antes de que el objeto sea desbloqueado, entonces el semáforo subyacente terminará en un estado no consistente. - - - - - - - - - &reftitle.returnvalues; - - El nuevo objeto SyncSemaphore. - - - - - &reftitle.errors; - - Se emitirá una excepción si el semáforo no puede ser creado o abierto. - - - - - &reftitle.examples; - - Ejemplo con <function>SyncSemaphore::__construct</function> - -lock(3000)) -{ - echo "Imposible bloquear el semáforo."; - - exit(); -} - -/* ... */ - -$semaphore->unlock(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncSemaphore::lock - SyncSemaphore::unlock - - - - - diff --git a/reference/sync/syncsemaphore/lock.xml b/reference/sync/syncsemaphore/lock.xml deleted file mode 100644 index c3414802c5..0000000000 --- a/reference/sync/syncsemaphore/lock.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - SyncSemaphore::lock - Disminuye el contador del objeto SyncSemaphore o espera - - - - &reftitle.description; - - public boolSyncSemaphore::lock - intwait-1 - - - Disminuye el contador del objeto SyncSemaphore o espera hasta que el semáforo - tenga un valor diferente de cero. - - - - - &reftitle.parameters; - - - wait - - - El número de milisegundos a esperar por el semáforo. - Un valor de -1 significa que se espera indefinidamente. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>SyncSemaphore::lock</function> - -lock(3000)) -{ - echo "Imposible desbloquear el semáforo."; - - exit(); -} - -/* ... */ - -$semaphore->unlock(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncSemaphore::unlock - - - - - diff --git a/reference/sync/syncsemaphore/unlock.xml b/reference/sync/syncsemaphore/unlock.xml deleted file mode 100644 index d4c1f7a508..0000000000 --- a/reference/sync/syncsemaphore/unlock.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - SyncSemaphore::unlock - Incrementa el contador del objeto SyncSemaphore - - - - &reftitle.description; - - public boolSyncSemaphore::unlock - intprevcount - - - Incrementa el contador del objeto SyncSemaphore. - - - - - &reftitle.parameters; - - - prevcount - - - Devuelve el contador anterior del semáforo. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>SyncSemaphore::unlock</function> - -lock(3000)) -{ - echo "Imposible desbloquear el semáforo."; - - exit(); -} - -/* ... */ - -$semaphore->unlock(); -?> -]]> - - - - - - &reftitle.seealso; - - SyncSemaphore::lock - - - - - diff --git a/reference/sync/syncsharedmemory.xml b/reference/sync/syncsharedmemory.xml deleted file mode 100644 index 2cd898d485..0000000000 --- a/reference/sync/syncsharedmemory.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - La clase SyncSharedMemory - SyncSharedMemory - - - - -
    - &reftitle.intro; - - Una implementación nativa, coherente y multiplataforma de objetos de memoria compartida nombrada. - - - La memoria compartida permite a dos procesos distintos comunicarse sin necesidad de - tuberías o sockets complejos. Existen varias implementaciones de memoria compartida - basadas en enteros para PHP. La memoria compartida nombrada es una alternativa. - - - Los objetos de sincronización (por ejemplo, SyncMutex) son siempre necesarios para proteger la mayoría - de los usos de la memoria compartida. - -
    - - -
    - &reftitle.classsynopsis; - - - - SyncSharedMemory - - - - - SyncSharedMemory - - - - - &Methods; - - - - -
    - -
    - - &reference.sync.entities.syncsharedmemory; - -
    - diff --git a/reference/sync/syncsharedmemory/construct.xml b/reference/sync/syncsharedmemory/construct.xml deleted file mode 100644 index c35770cb83..0000000000 --- a/reference/sync/syncsharedmemory/construct.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - SyncSharedMemory::__construct - Construye un nuevo objeto SyncSharedMemory - - - - &reftitle.description; - - public SyncSharedMemory::__construct - stringname - intsize - - - Construye un objeto de memoria compartida con nombre. - - - - - &reftitle.parameters; - - - name - - - El nombre del objeto de memoria compartida. - - - - Si el nombre ya existe, debe poder ser abierto por el usuario actual - que el proceso está en ejecución o se lanzará una excepción con un mensaje de error - sin significado. - - - - - - size - - - El tamaño, en bytes, de la memoria compartida a reservar. - - - - La cantidad de memoria no puede ser redimensionada posteriormente. Solicite suficiente almacenamiento de antemano. - - - - - - - - - &reftitle.returnvalues; - - El nuevo objeto SyncSharedMemory. - - - - - &reftitle.errors; - - Se lanza una excepción si el objeto de memoria compartida no puede ser creado o abierto. - - - - - &reftitle.examples; - - Ejemplo de <function>SyncSharedMemory::__construct</function> - -first()) -{ - // Realizar el trabajo de inicialización la primera vez aquí. -} - -$result = $mem->write(json_encode(array("name" => "my_report.txt"))); -?> -]]> - - - - - - &reftitle.seealso; - - SyncSharedMemory::first - SyncSharedMemory::size - SyncSharedMemory::write - SyncSharedMemory::read - - - - - diff --git a/reference/sync/syncsharedmemory/first.xml b/reference/sync/syncsharedmemory/first.xml deleted file mode 100644 index 68b92eb578..0000000000 --- a/reference/sync/syncsharedmemory/first.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - SyncSharedMemory::first - Verifica si el objeto es la primera instancia en todo el sistema de la memoria compartida nombrada - - - - &reftitle.description; - - public boolSyncSharedMemory::first - - - - Recupera el estado de primera instancia del objeto SyncSharedMemory en todo el sistema. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo de <function>SyncSharedMemory::first</function> - -first()) -{ - // Realizar el trabajo de inicialización la primera vez aquí. -} - -var_dump($mem->first()); - -$mem2 = new SyncSharedMemory("AppReportName", 1024); - -var_dump($mem2->first()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SyncSharedMemory::write - SyncSharedMemory::read - - - - - diff --git a/reference/sync/syncsharedmemory/read.xml b/reference/sync/syncsharedmemory/read.xml deleted file mode 100644 index f5a16fa8dc..0000000000 --- a/reference/sync/syncsharedmemory/read.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - SyncSharedMemory::read - Copia de datos de la memoria compartida nombrada - - - - &reftitle.description; - - public SyncSharedMemory::read - intstart0 - intlength - - - Copia de datos de la memoria compartida nombrada. - - - - - &reftitle.parameters; - - - start - - - El inicio/desplazamiento, en bytes, para comenzar la lectura. - - - - Si el valor es negativo, la posición de inicio comenzará en el número especificado - de bytes desde el final del segmento de memoria compartida. - - - - - - length - - - El número de bytes a leer. - - - - Si no se especifica, la lectura se detendrá al final del segmento de memoria compartida. - - - Si el valor es negativo, la lectura se detendrá en el número especificado de bytes - desde el final del segmento de memoria compartida. - - - - - - - - - &reftitle.returnvalues; - - Un string que contiene los datos leídos de la memoria compartida. - - - - - &reftitle.examples; - - Ejemplo de <function>SyncSharedMemory::__construct</function> - -first()) -{ - // Realizar el trabajo de inicialización la primera vez aquí. -} - -$result = $mem->write("report.txt"); - -$result = $mem->read(3, -4); -var_dump($result); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SyncSharedMemory::__construct - SyncSharedMemory::first - SyncSharedMemory::write - SyncSharedMemory::read - - - - - diff --git a/reference/sync/syncsharedmemory/size.xml b/reference/sync/syncsharedmemory/size.xml deleted file mode 100644 index 800c26c24c..0000000000 --- a/reference/sync/syncsharedmemory/size.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - SyncSharedMemory::size - Devuelve el tamaño de la memoria compartida nombrada - - - - &reftitle.description; - - public intSyncSharedMemory::size - - - - Recupera el tamaño de la memoria compartida de un objeto SyncSharedMemory. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un integer que contiene el tamaño de la memoria compartida. Este será el mismo tamaño que se pasó al constructor. - - - - - &reftitle.examples; - - Ejemplo de <function>SyncSharedMemory::size</function> - -size()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SyncSharedMemory::__construct - SyncSharedMemory::write - SyncSharedMemory::read - - - - - diff --git a/reference/sync/syncsharedmemory/write.xml b/reference/sync/syncsharedmemory/write.xml deleted file mode 100644 index ffb083b898..0000000000 --- a/reference/sync/syncsharedmemory/write.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - SyncSharedMemory::write - Copia los datos en la memoria compartida nombrada - - - - &reftitle.description; - - public SyncSharedMemory::write - stringstring - intstart0 - - - Copia los datos en la memoria compartida nombrada. - - - - - &reftitle.parameters; - - - string - - - Los datos a escribir en la memoria compartida. - - - - Si el tamaño de los datos excede el tamaño de la memoria compartida, el número - de bytes escritos devueltos será inferior a la longitud de la entrada. - - - - - - start - - - El inicio/desplazamiento, en bytes, para comenzar la escritura. - - - - Si el valor es negativo, la posición de inicio comenzará en el número especificado - de bytes desde el final del segmento de memoria compartida. - - - - - - - - - &reftitle.returnvalues; - - Un integer que contiene el número de bytes escritos en la memoria compartida. - - - - - &reftitle.examples; - - Ejemplo de <function>SyncSharedMemory::write</function> - -first()) -{ - // Realizar el trabajo de inicialización la primera vez aquí. -} - -$result = $mem->write("report.txt"); -var_dump($result); - -$result = $mem->write("report.txt", -3); -var_dump($result); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - SyncSharedMemory::__construct - SyncSharedMemory::first - SyncSharedMemory::write - SyncSharedMemory::read - - - - - diff --git a/reference/taint/book.xml b/reference/taint/book.xml deleted file mode 100644 index 12cb6e3667..0000000000 --- a/reference/taint/book.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Taint - Taint - - - &reftitle.intro; - - Taint es una extensión para detectar código XSS (strings corrompidos, - «tainted»). También puede utilizarse para localizar inyecciones SQL, - inyecciones de comandos, inyecciones de rutas de ficheros y - vulnerabilidades similares. - - - Cuando taint está habilitada, los strings recibidos de la entrada del - usuario — $_GET, $_POST y - $_COOKIE — se marcan como corrompidos al inicio de la - petición, y la marca se propaga a través de las operaciones con strings. - Cuando un string corrompido alcanza un punto peligroso (salida, consulta - SQL, comando del sistema, ruta de fichero, ...), taint emite una - advertencia que señala ese punto. Consulte - Propagación y puntos comprobados para - ver las listas completas. - - - Taint es una herramienta de desarrollo y auditoría, no una defensa en - tiempo de ejecución: solo informa de posibles problemas, y nunca bloquea - ni altera los datos. Es deliberadamente conservadora y puede informar de - más de la cuenta, de modo que una ejecución limpia solo significa «nada - que taint pudiera ver», nunca «demostrablemente seguro». No la habilite - en entornos de producción. - - - Ejemplo de taint - - -]]> - - &example.outputs.similar; - - - - - - - &reference.taint.setup; - &reference.taint.detail; - &reference.taint.reference; - - - - diff --git a/reference/taint/configure.xml b/reference/taint/configure.xml deleted file mode 100644 index 9370dc9498..0000000000 --- a/reference/taint/configure.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;taint. - - - - Se instala con PECL: - - - - - - - - - El código fuente está alojado en - GitHub. Para compilar - la extensión desde el código fuente: - - - - - - - A continuación se habilita la extensión añadiendo - extension=taint.so (o extension=php_taint.dll - en Windows) a &php.ini;, y estableciendo - taint.enable a - 1. - - - - - Taint es una herramienta de desarrollo y auditoría. No la habilite en - entornos de producción: la instrumentación ralentiza cada petición y - deshabilita el JIT de OPcache, y las advertencias pueden filtrar datos de - la petición a los registros. - - -
    - - diff --git a/reference/taint/detail.xml b/reference/taint/detail.xml deleted file mode 100644 index ef54fb715d..0000000000 --- a/reference/taint/detail.xml +++ /dev/null @@ -1,298 +0,0 @@ - - - - - Propagación y puntos comprobados - -
    - Cómo se propaga la marca de corrupción - - La marca de corrupción es un único bit almacenado en el propio string, no - en la variable que lo contiene. Asignar, pasar o compartir de cualquier - otra forma un string corrompido conserva la marca. La concatenación y la - interpolación de strings también la propagan: - - - - Operadores que propagan la marca de corrupción - - - - = (asignación, incluyendo list() y la desestructuración de arrays) - - - . (concatenación) - - - .= (asignación con concatenación) - - - "{$var}" (interpolación de strings, incluyendo la vía rápida ROPE) - - - -
    -
    - - Además, taint conoce un conjunto fijo de funciones de strings: cuando - alguno de los argumentos de tipo string relevantes está corrompido, el - string devuelto también se marca como corrompido. Se cubren tanto la - llamada habitual como, en PHP 8.4 y posteriores, la llamada por la vía - rápida sin marco de pila. - - - - Funciones que propagan la marca de corrupción - - - - trim, rtrim, ltrim - - - substr, strstr - - - str_replace, str_ireplace - - - str_pad, strtolower, strtoupper, strval - - - explode (cada elemento del array resultante) - - - implode/join (un separador corrompido también corrompe el resultado) - - - sprintf, vsprintf (solo el especificador %s transporta la marca; sprintf("%d", $t) devuelve un string limpio) - - - dirname, basename, pathinfo - - - -
    -
    - - Cualquier función que taint no conozca explícitamente devuelve un string - nuevo y sin marcar, incluidas las funciones de escapado como - htmlspecialchars, htmlentities o - mysqli_real_escape_string. Esto es deliberado: taint - informa de más de la cuenta en lugar de intentar decidir si un valor es - seguro para un contexto de salida concreto. Se debe usar - untaint para eliminar la marca de los valores que se - hayan validado manualmente. - -
    - -
    - Dónde emite advertencias taint - - Cuando un string corrompido alcanza uno de los puntos indicados a - continuación, taint emite una advertencia (por defecto un - E_USER_WARNING; el nivel es configurable mediante - taint.error_level). - Solo se inspeccionan los argumentos de tipo string de primer nivel; - volcar un array que simplemente contiene valores corrompidos no genera - ninguna advertencia. - - - - Puntos de salida - - - PuntoComprobado - - - - echo, print - la expresión mostrada o impresa - - - printf, vprintf - el string de formato y los valores sustituidos - - - print_r, var_dump, var_export - el valor volcado, cuando es un string - - - exit/die con un mensaje - el mensaje - - - file_put_contents, fwrite, fputs hacia php://output - los datos escritos - - - -
    -
    - - - Puntos del sistema de ficheros - - - PuntoComprobado - - - - fopen, opendir, unlink - la ruta - - - file, readfile, file_get_contents, highlight_file/show_source - la ruta - - - copy, rename, move_uploaded_file - tanto la ruta de origen como la de destino - - - mkdir, rmdir, touch - la ruta - - - include, include_once, require, require_once - la ruta del fichero - - - -
    -
    - - - Puntos SQL - - - PuntoComprobado - - - - mysqli_query, mysqli_prepare, mysqli_real_query, mysqli_multi_query - el string de la consulta - - - mysql_query, sqlite_query, sqlite_single_query, oci_parse, pg_query, pg_send_query - el string de la consulta - - - mysqli::query, mysqli::prepare, mysqli::real_query, mysqli::multi_query - el string de la consulta - - - PDO::query, PDO::prepare, PDO::exec - el string de la consulta - - - SQLite3::query, SQLite3::prepare, SQLite3::exec, SQLiteDatabase::query, SQLiteDatabase::singleQuery - el string de la consulta - - - -
    -
    - - - Puntos de ejecución de comandos - - - PuntoComprobado - - - - exec, system, passthru, shell_exec (incluyendo el operador de comillas invertidas) - el string del comando - - - proc_open, popen - el string del comando - - - eval - el código evaluado - - - las llamadas dinámicas como $func(), $obj->$method(), call_user_func o los callables en forma de array - el nombre de la función, del método o de la clase que se resuelve - - - preg_match, preg_match_all, preg_replace, preg_split, preg_grep, preg_replace_callback - el patrón (y el nombre de la retrollamada en el caso de preg_replace_callback) - - - -
    -
    - - - Puntos de cabeceras y cookies - - - PuntoComprobado - - - - header - el string de la cabecera - - - setcookie, setrawcookie - el nombre y el valor de la cookie - - - -
    -
    - - - Otros puntos - - - PuntoComprobado - - - - unserialize - el string serializado - - - mail - el destinatario, el asunto, los parámetros adicionales y las cabeceras adicionales (el cuerpo del mensaje es contenido y no se comprueba) - - - -
    -
    - - Las advertencias siguen el formato - nombre_de_funcion() [punto]: mensaje, donde - punto identifica la operación comprobada (por ejemplo - echo, include o el nombre de la - función) y el mensaje describe lo que se ha encontrado como posiblemente - corrompido. - -
    - -
    - - diff --git a/reference/taint/functions/is-tainted.xml b/reference/taint/functions/is-tainted.xml deleted file mode 100644 index b458455bda..0000000000 --- a/reference/taint/functions/is-tainted.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - is_tainted - Comprueba si un string está corrompido - - - - &reftitle.description; - - boolis_tainted - stringstring - - - Comprueba si el valor indicado lleva la marca de corrupción. Solo los - strings pueden estar corrompidos; cualquier otro tipo devuelve &false;. - - - - - &reftitle.parameters; - - - string - - - El valor que se va a comprobar. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si el valor es un string corrompido, y &false; en caso - contrario. Devuelve siempre &false; cuando - taint.enable está deshabilitado. - - - - - &reftitle.examples; - - Ejemplo con <function>is_tainted</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - taint - untaint - - - - - - - diff --git a/reference/taint/functions/taint.xml b/reference/taint/functions/taint.xml deleted file mode 100644 index 9601c0f713..0000000000 --- a/reference/taint/functions/taint.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - taint - Marca strings como corrompidos - - - - &reftitle.description; - - booltaint - stringstring - stringstrings - - - Marca manualmente los strings indicados como corrompidos, como si - procedieran de la entrada del usuario. Las variables se pasan por - referencia, pero la marca se almacena en el string y no en la variable: - todas las variables que comparten el mismo string quedan corrompidas a la - vez. - - - Resulta útil sobre todo para pruebas, y para simular la entrada del - usuario en scripts CLI, donde las superglobales - $_GET, - $_POST y - $_COOKIE no están - pobladas. - - - - - &reftitle.parameters; - - - string - - - Una variable que contiene el string que se va a marcar. - - - - - strings - - - Variables adicionales que se van a marcar. - - - - - - - - &reftitle.returnvalues; - - Devuelve siempre &true;. Cuando - taint.enable está deshabilitado, - la función no hace nada y aun así devuelve &true;. - - - - - &reftitle.examples; - - Ejemplo con <function>taint</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.notes; - - - Solo se marcan los strings no vacíos; las variables que contienen otros - tipos, o strings vacíos, se ignoran silenciosamente. - - - - - Los strings internados, persistentes y permanentes (literales de string, - strings compartidos de opcache) no pueden llevar nunca la marca y se - omiten silenciosamente. - - - - - - &reftitle.seealso; - - - untaint - is_tainted - - - - - - - diff --git a/reference/taint/functions/untaint.xml b/reference/taint/functions/untaint.xml deleted file mode 100644 index 5bd1a212c2..0000000000 --- a/reference/taint/functions/untaint.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - untaint - Elimina la marca de corrupción de los strings - - - - &reftitle.description; - - booluntaint - stringstring - stringstrings - - - Elimina la marca de corrupción de los strings indicados. - - - La marca se almacena en el propio string y no en la variable, por lo que - se elimina a la vez para todas las variables que comparten ese string. Se - utiliza para dar por buenos los valores que se hayan validado - manualmente, por ejemplo tras una comprobación estricta contra una lista - de valores permitidos. - - - - - &reftitle.parameters; - - - string - - - Una variable que contiene el string que se va a limpiar. - - - - - strings - - - Variables adicionales que se van a limpiar. - - - - - - - - &reftitle.returnvalues; - - Devuelve siempre &true;. Cuando - taint.enable está deshabilitado, - la función no hace nada y aun así devuelve &true;. - - - - - &reftitle.examples; - - Ejemplo con <function>untaint</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.notes; - - - Solo los valores de tipo string pueden llevar la marca; pasar un valor - que no sea un string no tiene ningún efecto. - - - - - - &reftitle.seealso; - - - taint - is_tainted - - - - - - - diff --git a/reference/taint/ini.xml b/reference/taint/ini.xml deleted file mode 100644 index 461a3fa0cf..0000000000 --- a/reference/taint/ini.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - - &ConfigureOptions; de taint - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - taint.enable - 0 - INI_SYSTEM - - - - taint.error_level - 512 (E_USER_WARNING) - INI_ALL - - - - -
    -
    - - &ini.descriptions.title; - - - - - - taint.enable - bool - - - - Interruptor principal. Cuando está habilitado, taint engancha el - ejecutor y marca como corrompidos los strings de - $_GET, $_POST y - $_COOKIE al inicio de la petición. - - - Esta directiva solo puede establecerse en &php.ini;: habilitarla - requiere reiniciar el proceso, por lo que no puede alternarse por - petición ni por directorio. - - - - No habilite esta directiva en entornos de producción: la - instrumentación ralentiza cada petición y es incompatible con el JIT - de OPcache. - - - - - - - taint.error_level - int - - - - El nivel de error utilizado cuando taint informa de un string - posiblemente corrompido. Por defecto es - E_USER_WARNING (512). - - - Puesto que esta directiva es INI_ALL, puede - modificarse en tiempo de ejecución. Por ejemplo, para silenciar las - advertencias de taint en el script actual: - - - - -]]> - - - - - - -
    - - diff --git a/reference/taint/reference.xml b/reference/taint/reference.xml deleted file mode 100644 index 3ece43971d..0000000000 --- a/reference/taint/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - &Functions; de taint - - &reference.taint.entities.functions; - - - - diff --git a/reference/taint/setup.xml b/reference/taint/setup.xml deleted file mode 100644 index a6b4188bf4..0000000000 --- a/reference/taint/setup.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Taint 3.x requiere PHP 8.0 o posterior. Para PHP 7.x se deben utilizar las - versiones taint 2.1.x, y para PHP 5.x las versiones taint 1.x. - -
    - - - &reference.taint.configure; - - - - &reference.taint.ini; - - -
    - &reftitle.resources; - - Taint no define ningún tipo de recurso. La propia marca de corrupción se - almacena en la estructura interna zend_string, no en un - recurso visible por el usuario. - -
    - -
    - - diff --git a/reference/tcpwrap/book.xml b/reference/tcpwrap/book.xml deleted file mode 100644 index bda5be7582..0000000000 --- a/reference/tcpwrap/book.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - - Envolturas TCP - TCP - - - - &reftitle.intro; - - Las envolturas de TCP proporciona un mecanismo clásico de Unix que ha sido - diseñado para comprobar si el cliente remoto es capaz de conectarse a la dirección IP - dada. - - - - - &reference.tcpwrap.setup; - &reference.tcpwrap.reference; - - - - - diff --git a/reference/tcpwrap/configure.xml b/reference/tcpwrap/configure.xml deleted file mode 100644 index 2e8a85709a..0000000000 --- a/reference/tcpwrap/configure.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;tcpwrap. - - - &pecl.windows.download; - -
    - - diff --git a/reference/tcpwrap/functions/tcpwrap-check.xml b/reference/tcpwrap/functions/tcpwrap-check.xml deleted file mode 100644 index 2db46ef5a6..0000000000 --- a/reference/tcpwrap/functions/tcpwrap-check.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - - - tcpwrap_check - Verificación Tcpwrap - - - &reftitle.description; - - booltcpwrap_check - stringdaemon - stringaddress - stringuser - boolnodns&false; - - - tcpwrap_check consulta los ficheros /etc/hosts.allow - y /etc/hosts.deny para verificar si el acceso al servicio - daemon está permitido o no para un cliente. - - - - &reftitle.parameters; - - - - daemon - - - El nombre del servicio. - - - - - address - - - La dirección remota del cliente. Puede ser una dirección IP o un nombre de - dominio. - - - - - user - - - Un nombre de usuario, opcional. - - - - - nodns - - - Si address se asemeja a un nombre de dominio, - DNS es utilizado para resolverlo en una dirección IP; defina - nodns a &true; para evitar este comportamiento. - - - - - - - - &reftitle.returnvalues; - - Esta función devuelve &true; si el acceso debe ser autorizado, &false; en caso contrario. - - - - &reftitle.examples; - - Rechazar todas las conexiones desde localhost - - Si su fichero /etc/hosts.deny contiene : - - - - - - Y su código se asemeja a : - - - - ]]> - - - - - &reftitle.seealso; - - Para más detalles, consulte la página man de hosts_access(3). - - - - - diff --git a/reference/tcpwrap/reference.xml b/reference/tcpwrap/reference.xml deleted file mode 100644 index d6d54c3615..0000000000 --- a/reference/tcpwrap/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - TCP &Functions; - - &reference.tcpwrap.entities.functions; - - - - diff --git a/reference/tcpwrap/setup.xml b/reference/tcpwrap/setup.xml deleted file mode 100644 index b916012fbd..0000000000 --- a/reference/tcpwrap/setup.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - - - - &reftitle.setup; - - - &reference.tcpwrap.configure; - - - - - - diff --git a/reference/trader/book.xml b/reference/trader/book.xml deleted file mode 100644 index b4f788daf5..0000000000 --- a/reference/trader/book.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - Análisis técnico para comerciantes - Trader - - - &reftitle.intro; - - La extensión trader es una biblioteca de código abierto gratuita basada en TA-Lib. - Está dedicada a los desarrolladores de software de actividad comercial que requieren realizar - análisis técnicos de datos de mercado financiero. Al lado de muchos indicadores como ADX, MACD, - RSI, Estocástico, TRIX, están presentes el reconocimiento de patrones de velas y varias - funciones de vectores aritméticas y algebraicas. - - - Los cálculos se pueden realizar en dos modos: TA-Lib y Metastock. Cambiándolo usando - trader_set_compat() - afectará la manera en que funcionan algunas funciones de trader. - - - Algunas funciones de trader proporcionan diferentes resultados dependiendo del "punto de inicio" - de los datos involucrados. Esto se refiere a menudo como que una función posee memoria. - Un ejemplo de tales funciones es la Media móvil exponencial. Es posible controlar el perido - inestable (la cantidad de datos a quitar) usando la función - trader_set_unstable_period(). - - - Se puede encontrar documentación ampliada sobre indicadores, fórmulas e implementaciones - en otros lenguajes de programación en &url.trader.lib;. - - - - &reference.trader.setup; - &reference.trader.constants; - - &reference.trader.reference; - - - - diff --git a/reference/trader/configure.xml b/reference/trader/configure.xml deleted file mode 100644 index 80f98ac1e6..0000000000 --- a/reference/trader/configure.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;trader - - - -
    - - - diff --git a/reference/trader/constants.xml b/reference/trader/constants.xml deleted file mode 100644 index 8bd49a960e..0000000000 --- a/reference/trader/constants.xml +++ /dev/null @@ -1,603 +0,0 @@ - - - - - - &reftitle.constants; - &extension.constants; - - - - - TRADER_MA_TYPE_SMA - (int) - - - - - - - - - TRADER_MA_TYPE_EMA - (int) - - - - - - - - - TRADER_MA_TYPE_WMA - (int) - - - - - - - - - TRADER_MA_TYPE_DEMA - (int) - - - - - - - - - TRADER_MA_TYPE_TEMA - (int) - - - - - - - - - TRADER_MA_TYPE_TRIMA - (int) - - - - - - - - - TRADER_MA_TYPE_KAMA - (int) - - - - - - - - - TRADER_MA_TYPE_MAMA - (int) - - - - - - - - - TRADER_MA_TYPE_T3 - (int) - - - - - - - - - TRADER_REAL_MIN - (float) - - - - - - - - - TRADER_REAL_MAX - (float) - - - - - - - - - TRADER_FUNC_UNST_ADX - (int) - - - - - - - - - TRADER_FUNC_UNST_ADXR - (int) - - - - - - - - - TRADER_FUNC_UNST_ATR - (int) - - - - - - - - - TRADER_FUNC_UNST_CMO - (int) - - - - - - - - - TRADER_FUNC_UNST_DX - (int) - - - - - - - - - TRADER_FUNC_UNST_EMA - (int) - - - - - - - - - TRADER_FUNC_UNST_HT_DCPERIOD - (int) - - - - - - - - - TRADER_FUNC_UNST_HT_DCPHASE - (int) - - - - - - - - - TRADER_FUNC_UNST_HT_PHASOR - (int) - - - - - - - - - TRADER_FUNC_UNST_HT_SINE - (int) - - - - - - - - - TRADER_FUNC_UNST_HT_TRENDLINE - (int) - - - - - - - - - TRADER_FUNC_UNST_HT_TRENDMODE - (int) - - - - - - - - - TRADER_FUNC_UNST_KAMA - (int) - - - - - - - - - TRADER_FUNC_UNST_MAMA - (int) - - - - - - - - - TRADER_FUNC_UNST_MFI - (int) - - - - - - - - - TRADER_FUNC_UNST_MINUS_DI - (int) - - - - - - - - - TRADER_FUNC_UNST_MINUS_DM - (int) - - - - - - - - - TRADER_FUNC_UNST_NATR - (int) - - - - - - - - - TRADER_FUNC_UNST_PLUS_DI - (int) - - - - - - - - - TRADER_FUNC_UNST_PLUS_DM - (int) - - - - - - - - - TRADER_FUNC_UNST_RSI - (int) - - - - - - - - - TRADER_FUNC_UNST_STOCHRSI - (int) - - - - - - - - - TRADER_FUNC_UNST_T3 - (int) - - - - - - - - - TRADER_FUNC_UNST_ALL - (int) - - - - - - - - - TRADER_FUNC_UNST_NONE - (int) - - - - - - - - - TRADER_COMPATIBILITY_DEFAULT - (int) - - - - - - - - - TRADER_COMPATIBILITY_METASTOCK - (int) - - - - - - - - - TRADER_ERR_SUCCESS - (int) - - - - - - - - - TRADER_ERR_LIB_NOT_INITIALIZE - (int) - - - - - - - - - TRADER_ERR_BAD_PARAM - (int) - - - - - - - - - TRADER_ERR_ALLOC_ERR - (int) - - - - - - - - - TRADER_ERR_GROUP_NOT_FOUND - (int) - - - - - - - - - TRADER_ERR_FUNC_NOT_FOUND - (int) - - - - - - - - - TRADER_ERR_INVALID_HANDLE - (int) - - - - - - - - - TRADER_ERR_INVALID_PARAM_HOLDER - (int) - - - - - - - - - TRADER_ERR_INVALID_PARAM_HOLDER_TYPE - (int) - - - - - - - - - TRADER_ERR_INVALID_PARAM_FUNCTION - (int) - - - - - - - - - TRADER_ERR_INPUT_NOT_ALL_INITIALIZE - (int) - - - - - - - - - TRADER_ERR_OUTPUT_NOT_ALL_INITIALIZE - (int) - - - - - - - - - TRADER_ERR_OUT_OF_RANGE_START_INDEX - (int) - - - - - - - - - TRADER_ERR_OUT_OF_RANGE_END_INDEX - (int) - - - - - - - - - TRADER_ERR_INVALID_LIST_TYPE - (int) - - - - - - - - - TRADER_ERR_BAD_OBJECT - (int) - - - - - - - - - TRADER_ERR_NOT_SUPPORTED - (int) - - - - - - - - - TRADER_ERR_INTERNAL_ERROR - (int) - - - - - - - - - TRADER_ERR_UNKNOWN_ERROR - (int) - - - - - - - - - - - diff --git a/reference/trader/functions/trader-acos.xml b/reference/trader/functions/trader-acos.xml deleted file mode 100644 index 3e7f894ee5..0000000000 --- a/reference/trader/functions/trader-acos.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - - trader_acos - Arcocoseno trigonométrico de vectores - - - - &reftitle.description; - - arraytrader_acos - arrayreal - - - Calcula el arcocoseno para cada valor de - real y devuelve el array resultante. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-ad.xml b/reference/trader/functions/trader-ad.xml deleted file mode 100644 index 5c654174ef..0000000000 --- a/reference/trader/functions/trader-ad.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_ad - Línea A/D Chaikin - - - - &reftitle.description; - - arraytrader_ad - arrayhigh - arraylow - arrayclose - arrayvolume - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - volume - - - &trader.arg.array.of.real.volume; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-add.xml b/reference/trader/functions/trader-add.xml deleted file mode 100644 index ea32bb74cc..0000000000 --- a/reference/trader/functions/trader-add.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - trader_add - Suma aritmética de vectores - - - - &reftitle.description; - - arraytrader_add - arrayreal0 - arrayreal1 - - - Calcula la suma de vectores de real0 a - real1 y devuelve el vector resultante. - - - - - &reftitle.parameters; - - - real0 - - - &trader.arg.array.of.real; - - - - - real1 - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-adosc.xml b/reference/trader/functions/trader-adosc.xml deleted file mode 100644 index 2d72573b0b..0000000000 --- a/reference/trader/functions/trader-adosc.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - - trader_adosc - Oscilador A/D Chaikin - - - - &reftitle.description; - - arraytrader_adosc - arrayhigh - arraylow - arrayclose - arrayvolume - intfastPeriod - intslowPeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - volume - - - &trader.arg.array.of.real.volume; - - - - - fastPeriod - - - &trader.arg.fast.period; - - - - - slowPeriod - - - &trader.arg.slow.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-adx.xml b/reference/trader/functions/trader-adx.xml deleted file mode 100644 index 3284851d1e..0000000000 --- a/reference/trader/functions/trader-adx.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_adx - Índice de movimiento direccional medio - - - - &reftitle.description; - - arraytrader_adx - arrayhigh - arraylow - arrayclose - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-adxr.xml b/reference/trader/functions/trader-adxr.xml deleted file mode 100644 index c6b62d6608..0000000000 --- a/reference/trader/functions/trader-adxr.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_adxr - Tasación del índice de movimiento direccional medio - - - - &reftitle.description; - - arraytrader_adxr - arrayhigh - arraylow - arrayclose - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-apo.xml b/reference/trader/functions/trader-apo.xml deleted file mode 100644 index 619dd9e1d8..0000000000 --- a/reference/trader/functions/trader-apo.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_apo - Oscilador de precio absoluto - - - - &reftitle.description; - - arraytrader_apo - arrayreal - intfastPeriod - intslowPeriod - intmAType - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - fastPeriod - - - &trader.arg.fast.period; - - - - - slowPeriod - - - &trader.arg.slow.period; - - - - - mAType - - - &trader.arg.ma.type; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-aroon.xml b/reference/trader/functions/trader-aroon.xml deleted file mode 100644 index 16f50d4c2c..0000000000 --- a/reference/trader/functions/trader-aroon.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - trader_aroon - Aroon - - - - &reftitle.description; - - arraytrader_aroon - arrayhigh - arraylow - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-aroonosc.xml b/reference/trader/functions/trader-aroonosc.xml deleted file mode 100644 index e7270e2e37..0000000000 --- a/reference/trader/functions/trader-aroonosc.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - trader_aroonosc - Oscilador Aroon - - - - &reftitle.description; - - arraytrader_aroonosc - arrayhigh - arraylow - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-asin.xml b/reference/trader/functions/trader-asin.xml deleted file mode 100644 index ee0bc1b695..0000000000 --- a/reference/trader/functions/trader-asin.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - - trader_asin - Arcoseno trigonométrico de vectores - - - - &reftitle.description; - - arraytrader_asin - arrayreal - - - Calcula el seno para cada valor de - real y devuelve el array resultante. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-atan.xml b/reference/trader/functions/trader-atan.xml deleted file mode 100644 index f2e355db25..0000000000 --- a/reference/trader/functions/trader-atan.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - - trader_atan - Arcotangente trigonométrica de vectores - - - - &reftitle.description; - - arraytrader_atan - arrayreal - - - Calcula la arcotangente para cada valor de - real y devuelve el array resultante. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-atr.xml b/reference/trader/functions/trader-atr.xml deleted file mode 100644 index 2b426de283..0000000000 --- a/reference/trader/functions/trader-atr.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_atr - Rango verdadero medio - - - - &reftitle.description; - - arraytrader_atr - arrayhigh - arraylow - arrayclose - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-avgprice.xml b/reference/trader/functions/trader-avgprice.xml deleted file mode 100644 index 489f7ba444..0000000000 --- a/reference/trader/functions/trader-avgprice.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_avgprice - Precio medio - - - - &reftitle.description; - - arraytrader_avgprice - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-bbands.xml b/reference/trader/functions/trader-bbands.xml deleted file mode 100644 index da9c754e16..0000000000 --- a/reference/trader/functions/trader-bbands.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - - trader_bbands - Bandas de Bollinger - - - - &reftitle.description; - - arraytrader_bbands - arrayreal - inttimePeriod - floatnbDevUp - floatnbDevDn - intmAType - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - nbDevUp - - - &trader.arg.nbdevup; - - - - - nbDevDn - - - &trader.arg.nbdevdn; - - - - - mAType - - - &trader.arg.ma.type; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-beta.xml b/reference/trader/functions/trader-beta.xml deleted file mode 100644 index 508d15a619..0000000000 --- a/reference/trader/functions/trader-beta.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - trader_beta - Beta - - - - &reftitle.description; - - arraytrader_beta - arrayreal0 - arrayreal1 - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real0 - - - &trader.arg.array.of.real; - - - - - real1 - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-bop.xml b/reference/trader/functions/trader-bop.xml deleted file mode 100644 index 6feabdda2a..0000000000 --- a/reference/trader/functions/trader-bop.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_bop - Equilibrio de poder - - - - &reftitle.description; - - arraytrader_bop - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cci.xml b/reference/trader/functions/trader-cci.xml deleted file mode 100644 index 5eb98ab360..0000000000 --- a/reference/trader/functions/trader-cci.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cci - Índice de Canal de Comodidad - - - - &reftitle.description; - - arraytrader_cci - arrayhigh - arraylow - arrayclose - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdl2crows.xml b/reference/trader/functions/trader-cdl2crows.xml deleted file mode 100644 index b7539c0769..0000000000 --- a/reference/trader/functions/trader-cdl2crows.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdl2crows - Dos Cuervos - - - - &reftitle.description; - - arraytrader_cdl2crows - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdl3blackcrows.xml b/reference/trader/functions/trader-cdl3blackcrows.xml deleted file mode 100644 index 0e55030cd8..0000000000 --- a/reference/trader/functions/trader-cdl3blackcrows.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdl3blackcrows - Tres Cuervos Negros - - - - &reftitle.description; - - arraytrader_cdl3blackcrows - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdl3inside.xml b/reference/trader/functions/trader-cdl3inside.xml deleted file mode 100644 index c658b1d022..0000000000 --- a/reference/trader/functions/trader-cdl3inside.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdl3inside - Tres Velas Interiores Alcistas/Bajistas - - - - &reftitle.description; - - arraytrader_cdl3inside - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdl3linestrike.xml b/reference/trader/functions/trader-cdl3linestrike.xml deleted file mode 100644 index e02b367c86..0000000000 --- a/reference/trader/functions/trader-cdl3linestrike.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdl3linestrike - Triple Golpe - - - - &reftitle.description; - - arraytrader_cdl3linestrike - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdl3outside.xml b/reference/trader/functions/trader-cdl3outside.xml deleted file mode 100644 index 0cdf70a83f..0000000000 --- a/reference/trader/functions/trader-cdl3outside.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdl3outside - Tres Velas Exteriores Alcistas/Bajistas - - - - &reftitle.description; - - arraytrader_cdl3outside - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdl3starsinsouth.xml b/reference/trader/functions/trader-cdl3starsinsouth.xml deleted file mode 100644 index e0b5549eec..0000000000 --- a/reference/trader/functions/trader-cdl3starsinsouth.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdl3starsinsouth - Tres Estrellas en el Sur - - - - &reftitle.description; - - arraytrader_cdl3starsinsouth - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdl3whitesoldiers.xml b/reference/trader/functions/trader-cdl3whitesoldiers.xml deleted file mode 100644 index f8ef6b2df8..0000000000 --- a/reference/trader/functions/trader-cdl3whitesoldiers.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdl3whitesoldiers - Tres Soldados Blancos Avanzando - - - - &reftitle.description; - - arraytrader_cdl3whitesoldiers - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlabandonedbaby.xml b/reference/trader/functions/trader-cdlabandonedbaby.xml deleted file mode 100644 index 716e9b98fa..0000000000 --- a/reference/trader/functions/trader-cdlabandonedbaby.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - - trader_cdlabandonedbaby - Bebé Abandonado - - - - &reftitle.description; - - arraytrader_cdlabandonedbaby - arrayopen - arrayhigh - arraylow - arrayclose - floatpenetration - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - penetration - - - &trader.arg.penetration; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdladvanceblock.xml b/reference/trader/functions/trader-cdladvanceblock.xml deleted file mode 100644 index df2f009d66..0000000000 --- a/reference/trader/functions/trader-cdladvanceblock.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdladvanceblock - Avance en Bloque - - - - &reftitle.description; - - arraytrader_cdladvanceblock - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlbelthold.xml b/reference/trader/functions/trader-cdlbelthold.xml deleted file mode 100644 index 730d6bf53c..0000000000 --- a/reference/trader/functions/trader-cdlbelthold.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlbelthold - Belt-hold - - - - &reftitle.description; - - arraytrader_cdlbelthold - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlbreakaway.xml b/reference/trader/functions/trader-cdlbreakaway.xml deleted file mode 100644 index e738ff0a4b..0000000000 --- a/reference/trader/functions/trader-cdlbreakaway.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlbreakaway - Escape - - - - &reftitle.description; - - arraytrader_cdlbreakaway - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlclosingmarubozu.xml b/reference/trader/functions/trader-cdlclosingmarubozu.xml deleted file mode 100644 index a765ea358a..0000000000 --- a/reference/trader/functions/trader-cdlclosingmarubozu.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlclosingmarubozu - Vela Cerrada Marubozu - - - - &reftitle.description; - - arraytrader_cdlclosingmarubozu - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlconcealbabyswall.xml b/reference/trader/functions/trader-cdlconcealbabyswall.xml deleted file mode 100644 index daa644d998..0000000000 --- a/reference/trader/functions/trader-cdlconcealbabyswall.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlconcealbabyswall - Pequeña Golondrina Escondida - - - - &reftitle.description; - - arraytrader_cdlconcealbabyswall - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlcounterattack.xml b/reference/trader/functions/trader-cdlcounterattack.xml deleted file mode 100644 index 240d318c44..0000000000 --- a/reference/trader/functions/trader-cdlcounterattack.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlcounterattack - Contraataque - - - - &reftitle.description; - - arraytrader_cdlcounterattack - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdldarkcloudcover.xml b/reference/trader/functions/trader-cdldarkcloudcover.xml deleted file mode 100644 index 3b5bf6b46d..0000000000 --- a/reference/trader/functions/trader-cdldarkcloudcover.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - - trader_cdldarkcloudcover - Cubierta de Nube Oscura - - - - &reftitle.description; - - arraytrader_cdldarkcloudcover - arrayopen - arrayhigh - arraylow - arrayclose - floatpenetration - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - penetration - - - &trader.arg.penetration; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdldoji.xml b/reference/trader/functions/trader-cdldoji.xml deleted file mode 100644 index 65e0e33c1e..0000000000 --- a/reference/trader/functions/trader-cdldoji.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdldoji - Doji - - - - &reftitle.description; - - arraytrader_cdldoji - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdldojistar.xml b/reference/trader/functions/trader-cdldojistar.xml deleted file mode 100644 index 0c0e4014e0..0000000000 --- a/reference/trader/functions/trader-cdldojistar.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdldojistar - Estrella Doji - - - - &reftitle.description; - - arraytrader_cdldojistar - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdldragonflydoji.xml b/reference/trader/functions/trader-cdldragonflydoji.xml deleted file mode 100644 index f1eb813974..0000000000 --- a/reference/trader/functions/trader-cdldragonflydoji.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdldragonflydoji - Doji Libélula - - - - &reftitle.description; - - arraytrader_cdldragonflydoji - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlengulfing.xml b/reference/trader/functions/trader-cdlengulfing.xml deleted file mode 100644 index 4fb6f40f65..0000000000 --- a/reference/trader/functions/trader-cdlengulfing.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlengulfing - Patrón envolvente - - - - &reftitle.description; - - arraytrader_cdlengulfing - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdleveningdojistar.xml b/reference/trader/functions/trader-cdleveningdojistar.xml deleted file mode 100644 index 69ff65fac4..0000000000 --- a/reference/trader/functions/trader-cdleveningdojistar.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - - trader_cdleveningdojistar - Estrella Vespertina Doji - - - - &reftitle.description; - - arraytrader_cdleveningdojistar - arrayopen - arrayhigh - arraylow - arrayclose - floatpenetration - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - penetration - - - &trader.arg.penetration; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdleveningstar.xml b/reference/trader/functions/trader-cdleveningstar.xml deleted file mode 100644 index 05f7be1449..0000000000 --- a/reference/trader/functions/trader-cdleveningstar.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - - trader_cdleveningstar - Estrella de Atardecer - - - - &reftitle.description; - - arraytrader_cdleveningstar - arrayopen - arrayhigh - arraylow - arrayclose - floatpenetration - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - penetration - - - &trader.arg.penetration; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlgapsidesidewhite.xml b/reference/trader/functions/trader-cdlgapsidesidewhite.xml deleted file mode 100644 index 9f12c31a8f..0000000000 --- a/reference/trader/functions/trader-cdlgapsidesidewhite.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlgapsidesidewhite - Velas blancas paralelas de hueco alcista/bajista - - - - &reftitle.description; - - arraytrader_cdlgapsidesidewhite - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlgravestonedoji.xml b/reference/trader/functions/trader-cdlgravestonedoji.xml deleted file mode 100644 index 91a3b28ac4..0000000000 --- a/reference/trader/functions/trader-cdlgravestonedoji.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlgravestonedoji - Doji Lápida - - - - &reftitle.description; - - arraytrader_cdlgravestonedoji - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlhammer.xml b/reference/trader/functions/trader-cdlhammer.xml deleted file mode 100644 index 71cfb5b17f..0000000000 --- a/reference/trader/functions/trader-cdlhammer.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlhammer - Martillo - - - - &reftitle.description; - - arraytrader_cdlhammer - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlhangingman.xml b/reference/trader/functions/trader-cdlhangingman.xml deleted file mode 100644 index df71940823..0000000000 --- a/reference/trader/functions/trader-cdlhangingman.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlhangingman - Hombre Colgado - - - - &reftitle.description; - - arraytrader_cdlhangingman - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlharami.xml b/reference/trader/functions/trader-cdlharami.xml deleted file mode 100644 index d8aa98071a..0000000000 --- a/reference/trader/functions/trader-cdlharami.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlharami - Patrón Harami - - - - &reftitle.description; - - arraytrader_cdlharami - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlharamicross.xml b/reference/trader/functions/trader-cdlharamicross.xml deleted file mode 100644 index d7168b2f33..0000000000 --- a/reference/trader/functions/trader-cdlharamicross.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlharamicross - Patrón Cruz Harami - - - - &reftitle.description; - - arraytrader_cdlharamicross - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlhighwave.xml b/reference/trader/functions/trader-cdlhighwave.xml deleted file mode 100644 index 8fdfef28c7..0000000000 --- a/reference/trader/functions/trader-cdlhighwave.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlhighwave - Vela de Onda Alta - - - - &reftitle.description; - - arraytrader_cdlhighwave - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlhikkake.xml b/reference/trader/functions/trader-cdlhikkake.xml deleted file mode 100644 index 2e63e9ccc7..0000000000 --- a/reference/trader/functions/trader-cdlhikkake.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlhikkake - Patrón Hikkake - - - - &reftitle.description; - - arraytrader_cdlhikkake - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlhikkakemod.xml b/reference/trader/functions/trader-cdlhikkakemod.xml deleted file mode 100644 index c3daab9562..0000000000 --- a/reference/trader/functions/trader-cdlhikkakemod.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlhikkakemod - Patrón Hikkake Modificado - - - - &reftitle.description; - - arraytrader_cdlhikkakemod - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlhomingpigeon.xml b/reference/trader/functions/trader-cdlhomingpigeon.xml deleted file mode 100644 index 665f8cb794..0000000000 --- a/reference/trader/functions/trader-cdlhomingpigeon.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlhomingpigeon - Paloma Mensajera - - - - &reftitle.description; - - arraytrader_cdlhomingpigeon - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlidentical3crows.xml b/reference/trader/functions/trader-cdlidentical3crows.xml deleted file mode 100644 index 61f9cdfde7..0000000000 --- a/reference/trader/functions/trader-cdlidentical3crows.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlidentical3crows - Tres Cuervos Idénticos - - - - &reftitle.description; - - arraytrader_cdlidentical3crows - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlinneck.xml b/reference/trader/functions/trader-cdlinneck.xml deleted file mode 100644 index aec3f4d900..0000000000 --- a/reference/trader/functions/trader-cdlinneck.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlinneck - Patrón Formación en el cuello - - - - &reftitle.description; - - arraytrader_cdlinneck - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlinvertedhammer.xml b/reference/trader/functions/trader-cdlinvertedhammer.xml deleted file mode 100644 index 4b4162b6fe..0000000000 --- a/reference/trader/functions/trader-cdlinvertedhammer.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlinvertedhammer - Martilllo Invertido - - - - &reftitle.description; - - arraytrader_cdlinvertedhammer - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlkicking.xml b/reference/trader/functions/trader-cdlkicking.xml deleted file mode 100644 index 20d9cb909b..0000000000 --- a/reference/trader/functions/trader-cdlkicking.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlkicking - Patada - - - - &reftitle.description; - - arraytrader_cdlkicking - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlkickingbylength.xml b/reference/trader/functions/trader-cdlkickingbylength.xml deleted file mode 100644 index 0bcc2e90a1..0000000000 --- a/reference/trader/functions/trader-cdlkickingbylength.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlkickingbylength - Patada - alza/baja determinada por el marubozu más largo - - - - &reftitle.description; - - arraytrader_cdlkickingbylength - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlladderbottom.xml b/reference/trader/functions/trader-cdlladderbottom.xml deleted file mode 100644 index 407c94eac1..0000000000 --- a/reference/trader/functions/trader-cdlladderbottom.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlladderbottom - Suelo de escalera - - - - &reftitle.description; - - arraytrader_cdlladderbottom - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdllongleggeddoji.xml b/reference/trader/functions/trader-cdllongleggeddoji.xml deleted file mode 100644 index 1b087cebc0..0000000000 --- a/reference/trader/functions/trader-cdllongleggeddoji.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdllongleggeddoji - Doji Zancudo - - - - &reftitle.description; - - arraytrader_cdllongleggeddoji - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdllongline.xml b/reference/trader/functions/trader-cdllongline.xml deleted file mode 100644 index e759444e70..0000000000 --- a/reference/trader/functions/trader-cdllongline.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdllongline - Vela de Línea Larga - - - - &reftitle.description; - - arraytrader_cdllongline - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlmarubozu.xml b/reference/trader/functions/trader-cdlmarubozu.xml deleted file mode 100644 index 971761e07b..0000000000 --- a/reference/trader/functions/trader-cdlmarubozu.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlmarubozu - Marubozu - - - - &reftitle.description; - - arraytrader_cdlmarubozu - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlmatchinglow.xml b/reference/trader/functions/trader-cdlmatchinglow.xml deleted file mode 100644 index 37da77b6f1..0000000000 --- a/reference/trader/functions/trader-cdlmatchinglow.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlmatchinglow - Mínimos coincidentes - - - - &reftitle.description; - - arraytrader_cdlmatchinglow - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlmathold.xml b/reference/trader/functions/trader-cdlmathold.xml deleted file mode 100644 index 657521377d..0000000000 --- a/reference/trader/functions/trader-cdlmathold.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - - trader_cdlmathold - Mat Hold - - - - &reftitle.description; - - arraytrader_cdlmathold - arrayopen - arrayhigh - arraylow - arrayclose - floatpenetration - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - penetration - - - &trader.arg.penetration; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlmorningdojistar.xml b/reference/trader/functions/trader-cdlmorningdojistar.xml deleted file mode 100644 index c8f77e35b2..0000000000 --- a/reference/trader/functions/trader-cdlmorningdojistar.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - - trader_cdlmorningdojistar - Lucero del Alba Doji - - - - &reftitle.description; - - arraytrader_cdlmorningdojistar - arrayopen - arrayhigh - arraylow - arrayclose - floatpenetration - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - penetration - - - &trader.arg.penetration; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlmorningstar.xml b/reference/trader/functions/trader-cdlmorningstar.xml deleted file mode 100644 index 0da021c506..0000000000 --- a/reference/trader/functions/trader-cdlmorningstar.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - - trader_cdlmorningstar - Lucero del Alba - - - - &reftitle.description; - - arraytrader_cdlmorningstar - arrayopen - arrayhigh - arraylow - arrayclose - floatpenetration - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - penetration - - - &trader.arg.penetration; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlonneck.xml b/reference/trader/functions/trader-cdlonneck.xml deleted file mode 100644 index 0f34bf8235..0000000000 --- a/reference/trader/functions/trader-cdlonneck.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlonneck - Patrón Sobre el cuello - - - - &reftitle.description; - - arraytrader_cdlonneck - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlpiercing.xml b/reference/trader/functions/trader-cdlpiercing.xml deleted file mode 100644 index 02cba8908e..0000000000 --- a/reference/trader/functions/trader-cdlpiercing.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlpiercing - Patrón penetrante - - - - &reftitle.description; - - arraytrader_cdlpiercing - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlrickshawman.xml b/reference/trader/functions/trader-cdlrickshawman.xml deleted file mode 100644 index 2829a15d74..0000000000 --- a/reference/trader/functions/trader-cdlrickshawman.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlrickshawman - Calesero - - - - &reftitle.description; - - arraytrader_cdlrickshawman - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlrisefall3methods.xml b/reference/trader/functions/trader-cdlrisefall3methods.xml deleted file mode 100644 index 0a58942823..0000000000 --- a/reference/trader/functions/trader-cdlrisefall3methods.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlrisefall3methods - Triple Formación Alcista/Bajista - - - - &reftitle.description; - - arraytrader_cdlrisefall3methods - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlseparatinglines.xml b/reference/trader/functions/trader-cdlseparatinglines.xml deleted file mode 100644 index 4a5ae3e261..0000000000 --- a/reference/trader/functions/trader-cdlseparatinglines.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlseparatinglines - Lineas Separadas - - - - &reftitle.description; - - arraytrader_cdlseparatinglines - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlshootingstar.xml b/reference/trader/functions/trader-cdlshootingstar.xml deleted file mode 100644 index c6840b637b..0000000000 --- a/reference/trader/functions/trader-cdlshootingstar.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlshootingstar - Estrella Fugaz - - - - &reftitle.description; - - arraytrader_cdlshootingstar - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlshortline.xml b/reference/trader/functions/trader-cdlshortline.xml deleted file mode 100644 index 83f6c6d26a..0000000000 --- a/reference/trader/functions/trader-cdlshortline.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlshortline - Vela de Línea Corta - - - - &reftitle.description; - - arraytrader_cdlshortline - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlspinningtop.xml b/reference/trader/functions/trader-cdlspinningtop.xml deleted file mode 100644 index 242f62bd0d..0000000000 --- a/reference/trader/functions/trader-cdlspinningtop.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlspinningtop - Peonza - - - - &reftitle.description; - - arraytrader_cdlspinningtop - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlstalledpattern.xml b/reference/trader/functions/trader-cdlstalledpattern.xml deleted file mode 100644 index a8194143d5..0000000000 --- a/reference/trader/functions/trader-cdlstalledpattern.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlstalledpattern - Patrón Añejo - - - - &reftitle.description; - - arraytrader_cdlstalledpattern - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlsticksandwich.xml b/reference/trader/functions/trader-cdlsticksandwich.xml deleted file mode 100644 index de08851baf..0000000000 --- a/reference/trader/functions/trader-cdlsticksandwich.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlsticksandwich - Bocadillo - - - - &reftitle.description; - - arraytrader_cdlsticksandwich - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdltakuri.xml b/reference/trader/functions/trader-cdltakuri.xml deleted file mode 100644 index 97f8a1dd39..0000000000 --- a/reference/trader/functions/trader-cdltakuri.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdltakuri - Takuri (Libélula Doji con sombra muy larga) - - - - &reftitle.description; - - arraytrader_cdltakuri - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdltasukigap.xml b/reference/trader/functions/trader-cdltasukigap.xml deleted file mode 100644 index fa0b38f147..0000000000 --- a/reference/trader/functions/trader-cdltasukigap.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdltasukigap - Hueco Tasuki - - - - &reftitle.description; - - arraytrader_cdltasukigap - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlthrusting.xml b/reference/trader/functions/trader-cdlthrusting.xml deleted file mode 100644 index 0b042e4baa..0000000000 --- a/reference/trader/functions/trader-cdlthrusting.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlthrusting - Patrón de empuje - - - - &reftitle.description; - - arraytrader_cdlthrusting - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdltristar.xml b/reference/trader/functions/trader-cdltristar.xml deleted file mode 100644 index c8b30d1aa7..0000000000 --- a/reference/trader/functions/trader-cdltristar.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdltristar - Patrón de tres estrellas - - - - &reftitle.description; - - arraytrader_cdltristar - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlunique3river.xml b/reference/trader/functions/trader-cdlunique3river.xml deleted file mode 100644 index 3640c2acdd..0000000000 --- a/reference/trader/functions/trader-cdlunique3river.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlunique3river - Tres ríos únicos - - - - &reftitle.description; - - arraytrader_cdlunique3river - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlupsidegap2crows.xml b/reference/trader/functions/trader-cdlupsidegap2crows.xml deleted file mode 100644 index 3b252faaad..0000000000 --- a/reference/trader/functions/trader-cdlupsidegap2crows.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlupsidegap2crows - Dos Cuervos tras un Huevo al Alza - - - - &reftitle.description; - - arraytrader_cdlupsidegap2crows - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cdlxsidegap3methods.xml b/reference/trader/functions/trader-cdlxsidegap3methods.xml deleted file mode 100644 index 5f3e98ec8d..0000000000 --- a/reference/trader/functions/trader-cdlxsidegap3methods.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_cdlxsidegap3methods - Métodos de Tres Huevos al Alza/Baja - - - - &reftitle.description; - - arraytrader_cdlxsidegap3methods - arrayopen - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - open - - - &trader.arg.array.of.real.open; - - - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-ceil.xml b/reference/trader/functions/trader-ceil.xml deleted file mode 100644 index f90c61614f..0000000000 --- a/reference/trader/functions/trader-ceil.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - - trader_ceil - Redondeo hacia arriba de vectores - - - - &reftitle.description; - - arraytrader_ceil - arrayreal - - - Calcula el siguiente entero mayor para cada valor de - real y devuelve el array resultante. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cmo.xml b/reference/trader/functions/trader-cmo.xml deleted file mode 100644 index 7a6adc6be4..0000000000 --- a/reference/trader/functions/trader-cmo.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - trader_cmo - Oscilador de momento de Chande - - - - &reftitle.description; - - arraytrader_cmo - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-correl.xml b/reference/trader/functions/trader-correl.xml deleted file mode 100644 index 53c6954d2c..0000000000 --- a/reference/trader/functions/trader-correl.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - trader_correl - Coeficiente de correlación de Pearson (r) - - - - &reftitle.description; - - arraytrader_correl - arrayreal0 - arrayreal1 - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real0 - - - &trader.arg.array.of.real; - - - - - real1 - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cos.xml b/reference/trader/functions/trader-cos.xml deleted file mode 100644 index 842a630aa6..0000000000 --- a/reference/trader/functions/trader-cos.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - - trader_cos - Coseno trigonométrico de vectores - - - - &reftitle.description; - - arraytrader_cos - arrayreal - - - Calcula el coseno para cada valor de - real y devuelve el array resultante. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-cosh.xml b/reference/trader/functions/trader-cosh.xml deleted file mode 100644 index 041435c9b8..0000000000 --- a/reference/trader/functions/trader-cosh.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - - trader_cosh - Coseno hiperbólico de un vector - - - - &reftitle.description; - - arraytrader_cosh - arrayreal - - - Calcula el coseno hiperbólico para cada valor de - real y devuelve el array resultante. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-dema.xml b/reference/trader/functions/trader-dema.xml deleted file mode 100644 index 212e6b2836..0000000000 --- a/reference/trader/functions/trader-dema.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - trader_dema - Media móvil exponencial doble - - - - &reftitle.description; - - arraytrader_dema - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-div.xml b/reference/trader/functions/trader-div.xml deleted file mode 100644 index d96c0e81ba..0000000000 --- a/reference/trader/functions/trader-div.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - trader_div - División aritmética de vectores - - - - &reftitle.description; - - arraytrader_div - arrayreal0 - arrayreal1 - - - Divide cada valor de real0 por el valor - correspondiente de real1 y devuelve el array resultante. - - - - - &reftitle.parameters; - - - real0 - - - &trader.arg.array.of.real; - - - - - real1 - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de fallo. - - - - - - diff --git a/reference/trader/functions/trader-dx.xml b/reference/trader/functions/trader-dx.xml deleted file mode 100644 index 81c5126dc3..0000000000 --- a/reference/trader/functions/trader-dx.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_dx - Índice de movimiento direccional - - - - &reftitle.description; - - arraytrader_dx - arrayhigh - arraylow - arrayclose - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-ema.xml b/reference/trader/functions/trader-ema.xml deleted file mode 100644 index 605d96c483..0000000000 --- a/reference/trader/functions/trader-ema.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - trader_ema - Media móvil exponencial - - - - &reftitle.description; - - arraytrader_ema - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-errno.xml b/reference/trader/functions/trader-errno.xml deleted file mode 100644 index 17638e3e70..0000000000 --- a/reference/trader/functions/trader-errno.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - trader_errno - Obtener el código de error - - - - &reftitle.description; - - inttrader_errno - - - - Obtener el código de error de la última operación. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - Devuelve el código de error identificado por una de las constantes TRADER_ERR_*. - - - - diff --git a/reference/trader/functions/trader-exp.xml b/reference/trader/functions/trader-exp.xml deleted file mode 100644 index 9b5c8705f1..0000000000 --- a/reference/trader/functions/trader-exp.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - trader_exp - Exponencial aritmética de vectores - - - - &reftitle.description; - - arraytrader_exp - arrayreal - - - Calcula e elevado a la potencia de cada valor de real. Devuelve un array con los datos calculados. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-floor.xml b/reference/trader/functions/trader-floor.xml deleted file mode 100644 index 22e3f7a69d..0000000000 --- a/reference/trader/functions/trader-floor.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - - trader_floor - Redondeo hacia abajo de vectores - - - - &reftitle.description; - - arraytrader_floor - arrayreal - - - Calcula el siguiente entero menor para cada valor de - real y devuelve el array resultante. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-get-compat.xml b/reference/trader/functions/trader-get-compat.xml deleted file mode 100644 index e9751c340a..0000000000 --- a/reference/trader/functions/trader-get-compat.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - trader_get_compat - Obtiene el modo de compatibilidad - - - - &reftitle.description; - - inttrader_get_compat - - - - Obtiene el modo de compatibilidad que afecta a la forma de realizar los cálculos de todas las funciones de la extensión. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - Devuelve el id del modo de compatibilidad que puede ser identificado por la serie de constantes de TRADER_COMPATIBILITY_*. - - - - - diff --git a/reference/trader/functions/trader-get-unstable-period.xml b/reference/trader/functions/trader-get-unstable-period.xml deleted file mode 100644 index 261f44e06c..0000000000 --- a/reference/trader/functions/trader-get-unstable-period.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - trader_get_unstable_period - Obtiene el periodo inestable - - - - &reftitle.description; - - inttrader_get_unstable_period - intfunctionId - - - Obtiene el factor de periodo inestable para una función en particular. - - - - - &reftitle.parameters; - - - functionId - - - El ID de la función por la que leer el factor. Se debería usar la serie de constantes TRADER_FUNC_UNST_*. - - - - - - - - &reftitle.returnvalues; - Devuelve el factor del periodo inestable para la función correspondiente. - - - - - - diff --git a/reference/trader/functions/trader-ht-dcperiod.xml b/reference/trader/functions/trader-ht-dcperiod.xml deleted file mode 100644 index 4e8f8d80d4..0000000000 --- a/reference/trader/functions/trader-ht-dcperiod.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - trader_ht_dcperiod - Transformación de Hilbert - Período de ciclo dominante - - - - &reftitle.description; - - arraytrader_ht_dcperiod - arrayreal - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-ht-dcphase.xml b/reference/trader/functions/trader-ht-dcphase.xml deleted file mode 100644 index 48171d482e..0000000000 --- a/reference/trader/functions/trader-ht-dcphase.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - trader_ht_dcphase - Transformación de Hilbert - Fase de ciclo dominante - - - - &reftitle.description; - - arraytrader_ht_dcphase - arrayreal - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-ht-phasor.xml b/reference/trader/functions/trader-ht-phasor.xml deleted file mode 100644 index c77d0b9aa4..0000000000 --- a/reference/trader/functions/trader-ht-phasor.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - trader_ht_phasor - Transformación de Hilbert - Componentes de un fasor - - - - &reftitle.description; - - arraytrader_ht_phasor - arrayreal - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-ht-sine.xml b/reference/trader/functions/trader-ht-sine.xml deleted file mode 100644 index e44ba9f0d0..0000000000 --- a/reference/trader/functions/trader-ht-sine.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - trader_ht_sine - Transformación de Hilbert - Sinusoide - - - - &reftitle.description; - - arraytrader_ht_sine - arrayreal - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-ht-trendline.xml b/reference/trader/functions/trader-ht-trendline.xml deleted file mode 100644 index 45b1a28dea..0000000000 --- a/reference/trader/functions/trader-ht-trendline.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - trader_ht_trendline - Transformación de Hilbert - Línea de tendencia instantánea - - - - &reftitle.description; - - arraytrader_ht_trendline - arrayreal - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-ht-trendmode.xml b/reference/trader/functions/trader-ht-trendmode.xml deleted file mode 100644 index 4375aa7c60..0000000000 --- a/reference/trader/functions/trader-ht-trendmode.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - trader_ht_trendmode - Transformación de Hilbert - Tendencia vs Modo de ciclo - - - - &reftitle.description; - - arraytrader_ht_trendmode - arrayreal - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-kama.xml b/reference/trader/functions/trader-kama.xml deleted file mode 100644 index f84a17324a..0000000000 --- a/reference/trader/functions/trader-kama.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - trader_kama - Media móvil adaptativa de Kaufman - - - - &reftitle.description; - - arraytrader_kama - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-linearreg-angle.xml b/reference/trader/functions/trader-linearreg-angle.xml deleted file mode 100644 index 05647b1b23..0000000000 --- a/reference/trader/functions/trader-linearreg-angle.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - trader_linearreg_angle - Ángulo de regresión lineal - - - - &reftitle.description; - - arraytrader_linearreg_angle - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-linearreg-intercept.xml b/reference/trader/functions/trader-linearreg-intercept.xml deleted file mode 100644 index c77db1ac5b..0000000000 --- a/reference/trader/functions/trader-linearreg-intercept.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - trader_linearreg_intercept - Intercepción de regresión lineal - - - - &reftitle.description; - - arraytrader_linearreg_intercept - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-linearreg-slope.xml b/reference/trader/functions/trader-linearreg-slope.xml deleted file mode 100644 index 2695c11661..0000000000 --- a/reference/trader/functions/trader-linearreg-slope.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - trader_linearreg_slope - Pendiente de regresión lineal - - - - &reftitle.description; - - arraytrader_linearreg_slope - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-linearreg.xml b/reference/trader/functions/trader-linearreg.xml deleted file mode 100644 index b099e2f3b6..0000000000 --- a/reference/trader/functions/trader-linearreg.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - trader_linearreg - Regresión lineal - - - - &reftitle.description; - - arraytrader_linearreg - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-ln.xml b/reference/trader/functions/trader-ln.xml deleted file mode 100644 index 3c4b307d59..0000000000 --- a/reference/trader/functions/trader-ln.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - - trader_ln - Logaritmo natural de vectores - - - - &reftitle.description; - - arraytrader_ln - arrayreal - - - Calcula el logaritmo natural para cada valor de - real y devuelve el array resultante. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-log10.xml b/reference/trader/functions/trader-log10.xml deleted file mode 100644 index b137d7c0bf..0000000000 --- a/reference/trader/functions/trader-log10.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - - trader_log10 - Logaritmo en base 10 de vectores - - - - &reftitle.description; - - arraytrader_log10 - arrayreal - - - Calcula el logaritmo en base 10 para cada valor de - real y devuelve el array resultante. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-ma.xml b/reference/trader/functions/trader-ma.xml deleted file mode 100644 index 52522d679e..0000000000 --- a/reference/trader/functions/trader-ma.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - trader_ma - Media móvil - - - - &reftitle.description; - - arraytrader_ma - arrayreal - inttimePeriod - intmAType - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - mAType - - - &trader.arg.ma.type; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-macd.xml b/reference/trader/functions/trader-macd.xml deleted file mode 100644 index 919cc42e37..0000000000 --- a/reference/trader/functions/trader-macd.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_macd - Convergencia/divergencia de la media móvil - - - - &reftitle.description; - - arraytrader_macd - arrayreal - intfastPeriod - intslowPeriod - intsignalPeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - fastPeriod - - - &trader.arg.fast.period; - - - - - slowPeriod - - - &trader.arg.slow.period; - - - - - signalPeriod - - - &trader.arg.signal.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-macdext.xml b/reference/trader/functions/trader-macdext.xml deleted file mode 100644 index f032dc7b01..0000000000 --- a/reference/trader/functions/trader-macdext.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - - trader_macdext - MACD con tipo MA controlable - - - - &reftitle.description; - - arraytrader_macdext - arrayreal - intfastPeriod - intfastMAType - intslowPeriod - intslowMAType - intsignalPeriod - intsignalMAType - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - fastPeriod - - - &trader.arg.fast.period; - - - - - fastMAType - - - &trader.arg.fast.ma.type; - - - - - slowPeriod - - - &trader.arg.slow.period; - - - - - slowMAType - - - &trader.arg.slow.ma.type; - - - - - signalPeriod - - - &trader.arg.signal.period; - - - - - signalMAType - - - &trader.arg.signal.ma.type; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-macdfix.xml b/reference/trader/functions/trader-macdfix.xml deleted file mode 100644 index c0bb95202d..0000000000 --- a/reference/trader/functions/trader-macdfix.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - trader_macdfix - Convergencia/divergencia fija 12/26 de la media móvil - - - - &reftitle.description; - - arraytrader_macdfix - arrayreal - intsignalPeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - signalPeriod - - - &trader.arg.signal.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-mama.xml b/reference/trader/functions/trader-mama.xml deleted file mode 100644 index 89829c0a80..0000000000 --- a/reference/trader/functions/trader-mama.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - trader_mama - Media móvil adaptativa MESA - - - - &reftitle.description; - - arraytrader_mama - arrayreal - floatfastLimit - floatslowLimit - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - fastLimit - - - &trader.arg.fast.limit; - - - - - slowLimit - - - &trader.arg.slow.limit; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-mavp.xml b/reference/trader/functions/trader-mavp.xml deleted file mode 100644 index e10793c2dc..0000000000 --- a/reference/trader/functions/trader-mavp.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - - trader_mavp - Media móvil con periodo variable - - - - &reftitle.description; - - arraytrader_mavp - arrayreal - arrayperiods - intminPeriod - intmaxPeriod - intmAType - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - periods - - - &trader.arg.array.of.real.periods; - - - - - minPeriod - - - &trader.arg.min.period; - - - - - maxPeriod - - - &trader.arg.max.period; - - - - - mAType - - - &trader.arg.ma.type; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-max.xml b/reference/trader/functions/trader-max.xml deleted file mode 100644 index c7c6db9649..0000000000 --- a/reference/trader/functions/trader-max.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - trader_max - Valor mayor sobre un periodo especificado - - - - &reftitle.description; - - arraytrader_max - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-maxindex.xml b/reference/trader/functions/trader-maxindex.xml deleted file mode 100644 index 0e248ceee6..0000000000 --- a/reference/trader/functions/trader-maxindex.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - trader_maxindex - Índice del valor mayor sobre un periodo especificado - - - - &reftitle.description; - - arraytrader_maxindex - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-medprice.xml b/reference/trader/functions/trader-medprice.xml deleted file mode 100644 index 01e6b79f51..0000000000 --- a/reference/trader/functions/trader-medprice.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - trader_medprice - Precio medio - - - - &reftitle.description; - - arraytrader_medprice - arrayhigh - arraylow - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-mfi.xml b/reference/trader/functions/trader-mfi.xml deleted file mode 100644 index da1ff01959..0000000000 --- a/reference/trader/functions/trader-mfi.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - - trader_mfi - Índice de flujo de dinero - - - - &reftitle.description; - - arraytrader_mfi - arrayhigh - arraylow - arrayclose - arrayvolume - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - volume - - - &trader.arg.array.of.real.volume; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-midpoint.xml b/reference/trader/functions/trader-midpoint.xml deleted file mode 100644 index 150810aa35..0000000000 --- a/reference/trader/functions/trader-midpoint.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - trader_midpoint - Punto medio sobre un periodo - - - - &reftitle.description; - - arraytrader_midpoint - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-midprice.xml b/reference/trader/functions/trader-midprice.xml deleted file mode 100644 index c09bccea18..0000000000 --- a/reference/trader/functions/trader-midprice.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - trader_midprice - Precio de punto medio sobre un periodo - - - - &reftitle.description; - - arraytrader_midprice - arrayhigh - arraylow - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-min.xml b/reference/trader/functions/trader-min.xml deleted file mode 100644 index 6b2ca9ddd9..0000000000 --- a/reference/trader/functions/trader-min.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - trader_min - Valor más bajo sobre un periodo especificado - - - - &reftitle.description; - - arraytrader_min - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-minindex.xml b/reference/trader/functions/trader-minindex.xml deleted file mode 100644 index dbe5077762..0000000000 --- a/reference/trader/functions/trader-minindex.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - trader_minindex - Índice del valor más bajo sobre un periodo especificado - - - - &reftitle.description; - - arraytrader_minindex - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-minmax.xml b/reference/trader/functions/trader-minmax.xml deleted file mode 100644 index ba924dbebb..0000000000 --- a/reference/trader/functions/trader-minmax.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - trader_minmax - Valores más altos y bajos sobre un periodo especificado - - - - &reftitle.description; - - arraytrader_minmax - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-minmaxindex.xml b/reference/trader/functions/trader-minmaxindex.xml deleted file mode 100644 index 8e0a15c606..0000000000 --- a/reference/trader/functions/trader-minmaxindex.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - trader_minmaxindex - Índices de los valores más bajos y altos sobre un periodo especificado - - - - &reftitle.description; - - arraytrader_minmaxindex - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-minus-di.xml b/reference/trader/functions/trader-minus-di.xml deleted file mode 100644 index 4be76c11b2..0000000000 --- a/reference/trader/functions/trader-minus-di.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_minus_di - Indicador direccional menos - - - - &reftitle.description; - - arraytrader_minus_di - arrayhigh - arraylow - arrayclose - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-minus-dm.xml b/reference/trader/functions/trader-minus-dm.xml deleted file mode 100644 index ccaa431dcf..0000000000 --- a/reference/trader/functions/trader-minus-dm.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - trader_minus_dm - Movimiento direccional menos - - - - &reftitle.description; - - arraytrader_minus_dm - arrayhigh - arraylow - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-mom.xml b/reference/trader/functions/trader-mom.xml deleted file mode 100644 index c5fe68a3c5..0000000000 --- a/reference/trader/functions/trader-mom.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - trader_mom - Momentum - - - - &reftitle.description; - - arraytrader_mom - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-mult.xml b/reference/trader/functions/trader-mult.xml deleted file mode 100644 index d0d4ada612..0000000000 --- a/reference/trader/functions/trader-mult.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - trader_mult - Multiplicación aritmética de vectores - - - - &reftitle.description; - - arraytrader_mult - arrayreal0 - arrayreal1 - - - Calcula el producto escalar de real0 con - real1 y devuelve el vector resultante. - - - - - &reftitle.parameters; - - - real0 - - - &trader.arg.array.of.real; - - - - - real1 - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-natr.xml b/reference/trader/functions/trader-natr.xml deleted file mode 100644 index a2b6137ad0..0000000000 --- a/reference/trader/functions/trader-natr.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_natr - Rango verdadero de la media normalizada - - - - &reftitle.description; - - arraytrader_natr - arrayhigh - arraylow - arrayclose - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-obv.xml b/reference/trader/functions/trader-obv.xml deleted file mode 100644 index bf18c42004..0000000000 --- a/reference/trader/functions/trader-obv.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - trader_obv - Volumen sobre balance - - - - &reftitle.description; - - arraytrader_obv - arrayreal - arrayvolume - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - volume - - - &trader.arg.array.of.real.volume; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-plus-di.xml b/reference/trader/functions/trader-plus-di.xml deleted file mode 100644 index 9cfdcbf3b0..0000000000 --- a/reference/trader/functions/trader-plus-di.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_plus_di - Indicador direccional más - - - - &reftitle.description; - - arraytrader_plus_di - arrayhigh - arraylow - arrayclose - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-plus-dm.xml b/reference/trader/functions/trader-plus-dm.xml deleted file mode 100644 index 0ce9037153..0000000000 --- a/reference/trader/functions/trader-plus-dm.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - trader_plus_dm - Movimiento direccional más - - - - &reftitle.description; - - arraytrader_plus_dm - arrayhigh - arraylow - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-ppo.xml b/reference/trader/functions/trader-ppo.xml deleted file mode 100644 index a66484eea6..0000000000 --- a/reference/trader/functions/trader-ppo.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_ppo - Oscilador de precio porcentual - - - - &reftitle.description; - - arraytrader_ppo - arrayreal - intfastPeriod - intslowPeriod - intmAType - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - fastPeriod - - - &trader.arg.fast.period; - - - - - slowPeriod - - - &trader.arg.slow.period; - - - - - mAType - - - &trader.arg.ma.type; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-roc.xml b/reference/trader/functions/trader-roc.xml deleted file mode 100644 index 54550bfda2..0000000000 --- a/reference/trader/functions/trader-roc.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - trader_roc - Ritmo de cambio : ((precio/precioAnterior)-1)*100 - - - - &reftitle.description; - - arraytrader_roc - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-rocp.xml b/reference/trader/functions/trader-rocp.xml deleted file mode 100644 index 38b15cd8ac..0000000000 --- a/reference/trader/functions/trader-rocp.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - trader_rocp - Porcentaje del ritmo de cabio: (precio-precioAnterior)/precioAnterior - - - - &reftitle.description; - - arraytrader_rocp - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-rocr.xml b/reference/trader/functions/trader-rocr.xml deleted file mode 100644 index ad7acc1a1b..0000000000 --- a/reference/trader/functions/trader-rocr.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - trader_rocr - Ratio del ritmo de cambio: (precio/precioAnterior) - - - - &reftitle.description; - - arraytrader_rocr - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-rocr100.xml b/reference/trader/functions/trader-rocr100.xml deleted file mode 100644 index cc41ab0ba0..0000000000 --- a/reference/trader/functions/trader-rocr100.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - trader_rocr100 - Ratio del ritmo de cambio en escala 100: (precio/precioAnterior)*100 - - - - &reftitle.description; - - arraytrader_rocr100 - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-rsi.xml b/reference/trader/functions/trader-rsi.xml deleted file mode 100644 index d8834a483b..0000000000 --- a/reference/trader/functions/trader-rsi.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - trader_rsi - Índice de fuerza relativa - - - - &reftitle.description; - - arraytrader_rsi - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-sar.xml b/reference/trader/functions/trader-sar.xml deleted file mode 100644 index d6fd265996..0000000000 --- a/reference/trader/functions/trader-sar.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_sar - Sistema parabólico - - - - &reftitle.description; - - arraytrader_sar - arrayhigh - arraylow - floatacceleration - floatmaximum - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - acceleration - - - Factor de aceleración usado hasta el valor máximo. Rango válido de 0 hasta TRADER_REAL_MAX. - - - - - maximum - - - Valor máximo del factor de aceleración. Rango válido de 0 hasta TRADER_REAL_MAX. - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-sarext.xml b/reference/trader/functions/trader-sarext.xml deleted file mode 100644 index c5591601cd..0000000000 --- a/reference/trader/functions/trader-sarext.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - - - trader_sarext - Sistema parabólico - Extendido - - - - &reftitle.description; - - arraytrader_sarext - arrayhigh - arraylow - floatstartValue - floatoffsetOnReverse - floataccelerationInitLong - floataccelerationLong - floataccelerationMaxLong - floataccelerationInitShort - floataccelerationShort - floataccelerationMaxShort - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - startValue - - - Valor inicial y dirección. 0 para Auto, >0 para Long, <0 para Short. Rango válido de TRADER_REAL_MIN hasta TRADER_REAL_MAX. - - - - - offsetOnReverse - - - Índice de porcentaje añadido/eliminado a la parada inicial sobre el reverso short/long reversal. Rango válido de 0 hasta TRADER_REAL_MAX. - - - - - accelerationInitLong - - - Valor inicial del factor de aceleración para la dirección Long. Rango válido de 0 hasta TRADER_REAL_MAX. - - - - - accelerationLong - - - Factor de acelereción para la dirección Long. Rango válido de 0 hasta TRADER_REAL_MAX. - - - - - accelerationMaxLong - - - Valor máximo del factor de aceleración para la dirección Long. Rango válido de 0 hasta TRADER_REAL_MAX. - - - - - accelerationInitShort - - - Valor inicial del factor de aceleración para la dirección Short. Rango válido de 0 hasta TRADER_REAL_MAX. - - - - - accelerationShort - - - Factor de aceleración para la dirección Short. Rango válido de 0 hasta TRADER_REAL_MAX. - - - - - accelerationMaxShort - - - Valor máximo del factor de aceleración para la dirección Short. Rango válido de 0 hasta TRADER_REAL_MAX. - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-set-compat.xml b/reference/trader/functions/trader-set-compat.xml deleted file mode 100644 index 3630a62274..0000000000 --- a/reference/trader/functions/trader-set-compat.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - trader_set_compat - Establece el modo de compatibilidad - - - - &reftitle.description; - - voidtrader_set_compat - intcompatId - - - Establece el modo de compatibilidad que afectará a la forma de realizar los cálculos de todas las funciones de la extensión. - - - - - &reftitle.parameters; - - - compatId - - - El ID de compatibilidad. Debería usarse la serie de constantes TRADER_COMPATIBILITY_*. - - - - - - - - &reftitle.returnvalues; - &return.void; - - - - - - diff --git a/reference/trader/functions/trader-set-unstable-period.xml b/reference/trader/functions/trader-set-unstable-period.xml deleted file mode 100644 index a06cd67c4b..0000000000 --- a/reference/trader/functions/trader-set-unstable-period.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - trader_set_unstable_period - Establece el periodo inestable - - - - &reftitle.description; - - voidtrader_set_unstable_period - intfunctionId - inttimePeriod - - - Factor de periodos inestables de influencia para funciones, las cuales son sensibles a él. Se puede encontrar más información sobre periodos inestables en la página de la documentación de la API TA-Lib. - - - - - &reftitle.parameters; - - - functionId - - - El ID de la función para la cual debería establecerse el factor. Se pueden usar la serie de constantes TRADER_FUNC_UNST_* para afectar a la función correspondiente. - - - - - timePeriod - - - El valor de periodo inestable. - - - - - - - - &reftitle.returnvalues; - &return.void; - - - - - - diff --git a/reference/trader/functions/trader-sin.xml b/reference/trader/functions/trader-sin.xml deleted file mode 100644 index 20921c695b..0000000000 --- a/reference/trader/functions/trader-sin.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - - trader_sin - Seno trigonométrico de vectores - - - - &reftitle.description; - - arraytrader_sin - arrayreal - - - Calcula el seno para cada valor de - real y devuelve el array resultante. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-sinh.xml b/reference/trader/functions/trader-sinh.xml deleted file mode 100644 index 49689de6c1..0000000000 --- a/reference/trader/functions/trader-sinh.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - - trader_sinh - Seno hiperbólico de vectores - - - - &reftitle.description; - - arraytrader_sinh - arrayreal - - - Calcula el seno hiperbólico para cada valor de - real y devuelve el array resultante. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-sma.xml b/reference/trader/functions/trader-sma.xml deleted file mode 100644 index 4bc76d012b..0000000000 --- a/reference/trader/functions/trader-sma.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - trader_sma - Media móvil simple - - - - &reftitle.description; - - arraytrader_sma - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-sqrt.xml b/reference/trader/functions/trader-sqrt.xml deleted file mode 100644 index 72b567e7a2..0000000000 --- a/reference/trader/functions/trader-sqrt.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - - trader_sqrt - Raíz cuadrada de vectores - - - - &reftitle.description; - - arraytrader_sqrt - arrayreal - - - Calcula la raíz cuadrada de cada valor de - real y devuelve el array resultante. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-stddev.xml b/reference/trader/functions/trader-stddev.xml deleted file mode 100644 index 5f0e206f3e..0000000000 --- a/reference/trader/functions/trader-stddev.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - trader_stddev - Desviación estándar - - - - &reftitle.description; - - arraytrader_stddev - arrayreal - inttimePeriod - floatnbDev - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - nbDev - - - - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-stoch.xml b/reference/trader/functions/trader-stoch.xml deleted file mode 100644 index d27d29e630..0000000000 --- a/reference/trader/functions/trader-stoch.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - - - trader_stoch - Estocástico - - - - &reftitle.description; - - arraytrader_stoch - arrayhigh - arraylow - arrayclose - intfastK_Period - intslowK_Period - intslowK_MAType - intslowD_Period - intslowD_MAType - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - fastK_Period - - - &trader.arg.fastk.period; - - - - - slowK_Period - - - &trader.arg.slowk.period; - - - - - slowK_MAType - - - &trader.arg.slowk.ma.type; - - - - - slowD_Period - - - &trader.arg.slowd.period; - - - - - slowD_MAType - - - &trader.arg.slowd.ma.type; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-stochf.xml b/reference/trader/functions/trader-stochf.xml deleted file mode 100644 index 3793ace49a..0000000000 --- a/reference/trader/functions/trader-stochf.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - - trader_stochf - Estocástico rápido - - - - &reftitle.description; - - arraytrader_stochf - arrayhigh - arraylow - arrayclose - intfastK_Period - intfastD_Period - intfastD_MAType - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - fastK_Period - - - &trader.arg.fastk.period; - - - - - fastD_Period - - - &trader.arg.fastd.period; - - - - - fastD_MAType - - - &trader.arg.fastd.ma.type; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-stochrsi.xml b/reference/trader/functions/trader-stochrsi.xml deleted file mode 100644 index c83de7ff00..0000000000 --- a/reference/trader/functions/trader-stochrsi.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - - trader_stochrsi - Índice de fuerza relativa estocástica - - - - &reftitle.description; - - arraytrader_stochrsi - arrayreal - inttimePeriod - intfastK_Period - intfastD_Period - intfastD_MAType - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - fastK_Period - - - &trader.arg.fastk.period; - - - - - fastD_Period - - - &trader.arg.fastd.period; - - - - - fastD_MAType - - - &trader.arg.fastd.ma.type; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-sub.xml b/reference/trader/functions/trader-sub.xml deleted file mode 100644 index 8d0a92ea34..0000000000 --- a/reference/trader/functions/trader-sub.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - trader_sub - Sustracción artimética de vectores - - - - &reftitle.description; - - arraytrader_sub - arrayreal0 - arrayreal1 - - - Calcula la suma de vectores de real1 desde - real0 y devuelve el vector resultante. - - - - - &reftitle.parameters; - - - real0 - - - &trader.arg.array.of.real; - - - - - real1 - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-sum.xml b/reference/trader/functions/trader-sum.xml deleted file mode 100644 index 6899e2b3a7..0000000000 --- a/reference/trader/functions/trader-sum.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - trader_sum - Sumatorio - - - - &reftitle.description; - - arraytrader_sum - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-t3.xml b/reference/trader/functions/trader-t3.xml deleted file mode 100644 index 8dec99e324..0000000000 --- a/reference/trader/functions/trader-t3.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - trader_t3 - Media móvil exponencial triple (T3) - - - - &reftitle.description; - - arraytrader_t3 - arrayreal - inttimePeriod - floatvFactor - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - vFactor - - - &trader.arg.vfactor; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-tan.xml b/reference/trader/functions/trader-tan.xml deleted file mode 100644 index 6b4c0ce8db..0000000000 --- a/reference/trader/functions/trader-tan.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - - trader_tan - Tangente trigonométrica de vectores - - - - &reftitle.description; - - arraytrader_tan - arrayreal - - - Calcula la tangente para cada valor de - real y devuelve el array resultante. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-tanh.xml b/reference/trader/functions/trader-tanh.xml deleted file mode 100644 index 43c174861f..0000000000 --- a/reference/trader/functions/trader-tanh.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - - trader_tanh - Tangente hiperbólica trigonométrica de vectores - - - - &reftitle.description; - - arraytrader_tanh - arrayreal - - - Calcula la tangente hiperbólica para cada valor de - real y devuelve el array resultante. - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-tema.xml b/reference/trader/functions/trader-tema.xml deleted file mode 100644 index bfa3c47c85..0000000000 --- a/reference/trader/functions/trader-tema.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - trader_tema - Media móvil exponencial triple - - - - &reftitle.description; - - arraytrader_tema - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-trange.xml b/reference/trader/functions/trader-trange.xml deleted file mode 100644 index cbd289a94c..0000000000 --- a/reference/trader/functions/trader-trange.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - trader_trange - Rango verdadero - - - - &reftitle.description; - - arraytrader_trange - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-trima.xml b/reference/trader/functions/trader-trima.xml deleted file mode 100644 index 671e7601d9..0000000000 --- a/reference/trader/functions/trader-trima.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - trader_trima - Media móvil triangular - - - - &reftitle.description; - - arraytrader_trima - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-trix.xml b/reference/trader/functions/trader-trix.xml deleted file mode 100644 index d9abcb1fb5..0000000000 --- a/reference/trader/functions/trader-trix.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - trader_trix - Ritmo de cambio de 1 día (RDC) de una MME suave triple - - - - &reftitle.description; - - arraytrader_trix - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-tsf.xml b/reference/trader/functions/trader-tsf.xml deleted file mode 100644 index d6e0f21b07..0000000000 --- a/reference/trader/functions/trader-tsf.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - trader_tsf - Previsión de series de tiempo - - - - &reftitle.description; - - arraytrader_tsf - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-typprice.xml b/reference/trader/functions/trader-typprice.xml deleted file mode 100644 index f6c8ea3cd2..0000000000 --- a/reference/trader/functions/trader-typprice.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - trader_typprice - Precio típico - - - - &reftitle.description; - - arraytrader_typprice - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-ultosc.xml b/reference/trader/functions/trader-ultosc.xml deleted file mode 100644 index e3ba891a4a..0000000000 --- a/reference/trader/functions/trader-ultosc.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - - trader_ultosc - Oscilador final - - - - &reftitle.description; - - arraytrader_ultosc - arrayhigh - arraylow - arrayclose - inttimePeriod1 - inttimePeriod2 - inttimePeriod3 - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - timePeriod1 - - - Número de barras para el primer periodo. Rango válido de 1 hasta 100000. - - - - - timePeriod2 - - - Número de barras para el segundo periodo. Rango válido de 1 hasta 100000. - - - - - timePeriod3 - - - Número de barras para el tercer periodo. Rango válido de 1 hasta 100000. - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-var.xml b/reference/trader/functions/trader-var.xml deleted file mode 100644 index 950400b50c..0000000000 --- a/reference/trader/functions/trader-var.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - trader_var - Varianza - - - - &reftitle.description; - - arraytrader_var - arrayreal - inttimePeriod - floatnbDev - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - nbDev - - - - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-wclprice.xml b/reference/trader/functions/trader-wclprice.xml deleted file mode 100644 index 66e518456c..0000000000 --- a/reference/trader/functions/trader-wclprice.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - trader_wclprice - Precio de cierre ponderado - - - - &reftitle.description; - - arraytrader_wclprice - arrayhigh - arraylow - arrayclose - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-willr.xml b/reference/trader/functions/trader-willr.xml deleted file mode 100644 index 7cb87eeaa7..0000000000 --- a/reference/trader/functions/trader-willr.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - trader_willr - %R de Williams - - - - &reftitle.description; - - arraytrader_willr - arrayhigh - arraylow - arrayclose - inttimePeriod - - - - - - - - &reftitle.parameters; - - - high - - - &trader.arg.array.of.real.high; - - - - - low - - - &trader.arg.array.of.real.low; - - - - - close - - - &trader.arg.array.of.real.close; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/functions/trader-wma.xml b/reference/trader/functions/trader-wma.xml deleted file mode 100644 index d71fe0de05..0000000000 --- a/reference/trader/functions/trader-wma.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - trader_wma - Media móvil ponderada - - - - &reftitle.description; - - arraytrader_wma - arrayreal - inttimePeriod - - - - - - - - &reftitle.parameters; - - - real - - - &trader.arg.array.of.real; - - - - - timePeriod - - - &trader.arg.time.period; - - - - - - - - &reftitle.returnvalues; - Devuelve un array con los datos calculados o false en caso de error. - - - - - - diff --git a/reference/trader/ini.xml b/reference/trader/ini.xml deleted file mode 100644 index 0ed2a07043..0000000000 --- a/reference/trader/ini.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - -
    - &reftitle.runtime; - &extension.runtime; - - - Trader &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - trader.real_precision - 3 - INI_ALL - Desde trader 0.2.1 - - - trader.real_round_mode - HALF_DOWN - INI_ALL - Desde trader 0.3.0 - - - -
    -
    - - &ini.descriptions.title; - - - - - - trader.real_precision - int - - - - Todos los valores de los arrays devueltos serán redondeados a esta precisión. - Sin enbargo, los cálculos dentro de TA-Lib se realizarán con valores no redondeados. - - - - - - trader.real_round_mode - string - - - - Controla la política de redondeo de números reales de trader. Los valores válidos son HALF_UP, - HALF_DOWN, HALF_EVEN y HALF_ODD. El comportamiento es idéntico al de la función round() usada con el argumento de modo. - - - - - -
    - - diff --git a/reference/trader/reference.xml b/reference/trader/reference.xml deleted file mode 100644 index ab57ed0fe8..0000000000 --- a/reference/trader/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - &Functions; de Trader - - &reference.trader.entities.functions; - - - - diff --git a/reference/trader/setup.xml b/reference/trader/setup.xml deleted file mode 100644 index 4db8031df0..0000000000 --- a/reference/trader/setup.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - La extensión trader se basa en - TA-Lib. - TA-Lib está totalmente integrado en la extensión, por lo que no es - necesaria ninguna biblioteca externa. - -
    - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;trader. - -
    - - - &reference.trader.ini; - - - - -
    - - diff --git a/reference/ui/book.xml b/reference/ui/book.xml deleted file mode 100644 index 78ac2dc457..0000000000 --- a/reference/ui/book.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - - - UI - UI - - - &reftitle.intro; - - &warn.experimental; - Esta extensión encapsula libui - para proporcionar una API orientada a objetos destinada al desarrollo multiplataforma - de interfaces de usuario nativas con un aspecto y comportamiento auténticos. - - - - &reference.ui.setup; - - - &reference.ui.ui.point; - &reference.ui.ui.size; - - &reference.ui.ui.window; - &reference.ui.ui.control; - &reference.ui.ui.menu; - &reference.ui.ui.menuitem; - &reference.ui.ui.area; - &reference.ui.ui.executor; - - &reference.ui.ui.controls.tab; - &reference.ui.ui.controls.check; - &reference.ui.ui.controls.button; - &reference.ui.ui.controls.colorbutton; - &reference.ui.ui.controls.label; - &reference.ui.ui.controls.entry; - &reference.ui.ui.controls.multilineentry; - &reference.ui.ui.controls.spin; - &reference.ui.ui.controls.slider; - &reference.ui.ui.controls.progress; - &reference.ui.ui.controls.separator; - &reference.ui.ui.controls.combo; - &reference.ui.ui.controls.editablecombo; - &reference.ui.ui.controls.radio; - &reference.ui.ui.controls.picker; - - &reference.ui.ui.controls.form; - &reference.ui.ui.controls.grid; - &reference.ui.ui.controls.group; - &reference.ui.ui.controls.box; - - &reference.ui.ui.draw.pen; - &reference.ui.ui.draw.path; - &reference.ui.ui.draw.matrix; - &reference.ui.ui.draw.color; - &reference.ui.ui.draw.stroke; - &reference.ui.ui.draw.brush; - &reference.ui.ui.draw.brush.gradient; - &reference.ui.ui.draw.brush.lineargradient; - &reference.ui.ui.draw.brush.radialgradient; - - &reference.ui.ui.draw.text.layout; - &reference.ui.ui.draw.text.font; - &reference.ui.ui.draw.text.font.descriptor; - - &reference.ui.reference; - - &reference.ui.ui.draw.text.font.weight; - &reference.ui.ui.draw.text.font.italic; - &reference.ui.ui.draw.text.font.stretch; - &reference.ui.ui.draw.line.cap; - &reference.ui.ui.draw.line.join; - &reference.ui.ui.key; - - &reference.ui.ui.exception.invalidargumentexception; - &reference.ui.ui.exception.runtimeexception; - - - diff --git a/reference/ui/configure.xml b/reference/ui/configure.xml deleted file mode 100644 index cacf00de70..0000000000 --- a/reference/ui/configure.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - -
    - &reftitle.install; - - - Utilizar la opción durante la compilación de PHP. - - - - Los usuarios de Windows deben incluir php_ui.dll en el archivo &php.ini; - - -
    - - diff --git a/reference/ui/functions/ui.draw.text.font.fontfamilies.xml b/reference/ui/functions/ui.draw.text.font.fontfamilies.xml deleted file mode 100644 index 724ae0b37e..0000000000 --- a/reference/ui/functions/ui.draw.text.font.fontfamilies.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - - UI\Draw\Text\Font\fontFamilies - Obtiene las familias de fuentes - - - - &reftitle.description; - - arrayUI\Draw\Text\Font\fontFamilies - - - - Devuelve un array de las familias de fuentes válidas para el sistema actual. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un &array; de las familias de fuentes válidas para el sistema actual. - - - - - diff --git a/reference/ui/functions/ui.quit.xml b/reference/ui/functions/ui.quit.xml deleted file mode 100644 index 08472e1b93..0000000000 --- a/reference/ui/functions/ui.quit.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - UI\quit - Sale de la bucle UI - - - - &reftitle.description; - - voidUI\quit - - - - Debe hacer que la bucle principal se detenga - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/ui/functions/ui.run.xml b/reference/ui/functions/ui.run.xml deleted file mode 100644 index 0562fd8da6..0000000000 --- a/reference/ui/functions/ui.run.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - - UI\run - Entra en la bucle UI - - - - &reftitle.description; - - voidUI\run - intflags - - - Debe hacer que PHP entre en la bucle principal. Por omisión, el control no será devuelto a la función llamadora. - - - - - - &reftitle.parameters; - - - flags - - - Poner UI\Loop para devolver el control y UI\Wait para devolver el control después de la espera. - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/ui/reference.xml b/reference/ui/reference.xml deleted file mode 100644 index dfcab3b05a..0000000000 --- a/reference/ui/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - UI &Functions; - - &reference.ui.entities.functions; - - - - diff --git a/reference/ui/setup.xml b/reference/ui/setup.xml deleted file mode 100644 index f802c7d9bf..0000000000 --- a/reference/ui/setup.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - La instalación requiere la biblioteca libui y PHP 7 o una versión más reciente. - - - Esta extensión requiere la instalación de la biblioteca libui - versión 0.1.0 o una versión más reciente. Consulte la documentación de libui para obtener una lista de los requisitos previos. - -
    - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;ui. - - - &pecl.windows.download.avail; - -
    - -
    - - diff --git a/reference/ui/ui.area.xml b/reference/ui/ui.area.xml deleted file mode 100644 index c044a8135e..0000000000 --- a/reference/ui/ui.area.xml +++ /dev/null @@ -1,166 +0,0 @@ - - - - - Area - UI\Area - - - - -
    - &reftitle.intro; - - Una área (Area) representa un lienzo sobre el cual se puede dibujar y responder a los eventos de ratón y teclado. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Area - - - - - UI\Area - - - - extends - UI\Control - - - - &Constants; - - const - int - UI\Area::Ctrl - - - const - int - UI\Area::Alt - - - const - int - UI\Area::Shift - - - const - int - UI\Area::Super - - - const - int - UI\Area::Down - - - const - int - UI\Area::Up - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Area::Ctrl - - - Debe ser definido en los modificadores pasados a los eventos - de teclado y ratón cuando la tecla CTRL está activa - - - - - - UI\Area::Alt - - - Debe ser definido en los modificadores pasados a los eventos - de teclado y ratón cuando la tecla ALT está activa - - - - - - UI\Area::Shift - - - Debe ser definido en los modificadores pasados a los eventos - de teclado y ratón cuando la tecla SHIFT está activa - - - - - - UI\Area::Super - - - - - - - UI\Area::Down - - Debe ser definido en los modificadores pasados a los eventos de teclado y ratón - - - - - UI\Area::Up - - Debe ser definido en los modificadores pasados a los eventos de teclado y ratón - - - - -
    - - -
    - - &reference.ui.ui.entities.area; - -
    - - diff --git a/reference/ui/ui.control.xml b/reference/ui/ui.control.xml deleted file mode 100644 index da65982569..0000000000 --- a/reference/ui/ui.control.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - Controlar - UI\Control - - - - -
    - &reftitle.intro; - - Esta clase es la clase base cerrada para todos los controles UI. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Control - - - - - final - UI\Control - - - - - &Methods; - - - - -
    - -
    - - &reference.ui.ui.entities.control; - -
    - - diff --git a/reference/ui/ui.controls.box.xml b/reference/ui/ui.controls.box.xml deleted file mode 100644 index f760c86483..0000000000 --- a/reference/ui/ui.controls.box.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - Caja de control (Disposición) - UI\Controls\Box - - - - -
    - &reftitle.intro; - - Una caja (Box) permite el arreglo de otros controles - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Box - - - - - UI\Controls\Box - - - - extends - UI\Control - - - - - &Constants; - - const - int - UI\Controls\Box::Vertical - - - const - int - UI\Controls\Box::Horizontal - - - &Properties; - - protected - controls - - - Constructor - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.properties; - - - controls - - - Contiene los controles, no debe ser manipulado directamente - - - - -
    - - - -
    - &reftitle.constants; - - - - UI\Controls\Box::Vertical - - - - - - - UI\Controls\Box::Horizontal - - - - - - -
    - - -
    - - &reference.ui.ui.controls.entities.box; - -
    - - diff --git a/reference/ui/ui.controls.button.xml b/reference/ui/ui.controls.button.xml deleted file mode 100644 index bc5b9fa76e..0000000000 --- a/reference/ui/ui.controls.button.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - Botón de control - UI\Controls\Button - - - - -
    - &reftitle.intro; - - Representa un botón (Button) cliquable etiquetado - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Button - - - - - UI\Controls\Button - - - - extends - UI\Control - - - - - Constructor - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.ui.ui.controls.entities.button; - -
    - - diff --git a/reference/ui/ui.controls.check.xml b/reference/ui/ui.controls.check.xml deleted file mode 100644 index 9a269dc03a..0000000000 --- a/reference/ui/ui.controls.check.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - Casilla de control - UI\Controls\Check - - - - -
    - &reftitle.intro; - - Una casilla de verificación (Check) es una caja de verificación etiquetada - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Check - - - - - UI\Controls\Check - - - - extends - UI\Control - - - - - Constructor - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.ui.ui.controls.entities.check; - -
    - - diff --git a/reference/ui/ui.controls.colorbutton.xml b/reference/ui/ui.controls.colorbutton.xml deleted file mode 100644 index 598c021b61..0000000000 --- a/reference/ui/ui.controls.colorbutton.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - Botón de control de color - UI\Controls\ColorButton - - - - -
    - &reftitle.intro; - - Un botón de color (ColorButton) es un botón que muestra un selector de color cuando se hace clic en él - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\ColorButton - - - - - UI\Controls\ColorButton - - - - extends - UI\Control - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.ui.ui.controls.entities.colorbutton; - -
    - - diff --git a/reference/ui/ui.controls.combo.xml b/reference/ui/ui.controls.combo.xml deleted file mode 100644 index b25e1edf54..0000000000 --- a/reference/ui/ui.controls.combo.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - Caja de combinación de Control - UI\Controls\Combo - - - - -
    - &reftitle.intro; - - Una caja de combinación (Combo) representa una lista de opciones, como el elemento select HTML familiar. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Combo - - - - - UI\Controls\Combo - - - - extends - UI\Control - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.ui.ui.controls.entities.combo; - -
    - - diff --git a/reference/ui/ui.controls.editablecombo.xml b/reference/ui/ui.controls.editablecombo.xml deleted file mode 100644 index 1a7a95e7ea..0000000000 --- a/reference/ui/ui.controls.editablecombo.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - Cuadro combinado de control editable - UI\Controls\EditableCombo - - - - -
    - &reftitle.intro; - - Una boîte de combinaison éditable (Editable Combo) es un Combo que permite al usuario ingresar opciones personalizadas. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\EditableCombo - - - - - UI\Controls\EditableCombo - - - - extends - UI\Control - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.ui.ui.controls.entities.editablecombo; - -
    - - diff --git a/reference/ui/ui.controls.entry.xml b/reference/ui/ui.controls.entry.xml deleted file mode 100644 index 26af35725b..0000000000 --- a/reference/ui/ui.controls.entry.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - Entrada de control - UI\Controls\Entry - - - - -
    - &reftitle.intro; - - Una entrada (Entry) es un control de entrada de texto, adaptado para ingresar texto sin tratar, contraseñas, o términos de búsqueda. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Entry - - - - - UI\Controls\Entry - - - - extends - UI\Control - - - - &Constants; - - const - int - UI\Controls\Entry::Normal - - - const - int - UI\Controls\Entry::Password - - - const - int - UI\Controls\Entry::Search - - - Constructor - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Controls\Entry::Normal - - Una entrada normal simple - - - - - UI\Controls\Entry::Password - - Una entrada de contraseña - - - - - UI\Controls\Entry::Search - - Una entrada de búsqueda - - - - -
    - - -
    - - &reference.ui.ui.controls.entities.entry; - -
    - - diff --git a/reference/ui/ui.controls.form.xml b/reference/ui/ui.controls.form.xml deleted file mode 100644 index 52e402409f..0000000000 --- a/reference/ui/ui.controls.form.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - Formulario de Control (Disposición) - UI\Controls\Form - - - - -
    - &reftitle.intro; - - Un formulario (Form) es un control que permite el arreglo de otros controles en una disposición familiar (el formulario). - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Form - - - - - UI\Controls\Form - - - - extends - UI\Control - - - - - &Properties; - - protected - controls - - - &Methods; - - - &InheritedMethods; - - - - - - -
    - &reftitle.properties; - - - controls - - - Contiene controles, no debe ser manipulado directamente - - - - -
    - - -
    - -
    - - &reference.ui.ui.controls.entities.form; - -
    - - diff --git a/reference/ui/ui.controls.grid.xml b/reference/ui/ui.controls.grid.xml deleted file mode 100644 index a3c7a5e351..0000000000 --- a/reference/ui/ui.controls.grid.xml +++ /dev/null @@ -1,203 +0,0 @@ - - - - - Cuadrícula de Control (Disposición) - UI\Controls\Grid - - - - -
    - &reftitle.intro; - - Una cuadrícula (Grid) es un control que permite el arreglo de los hijos en una cuadrícula. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Grid - - - - - UI\Controls\Grid - - - - extends - UI\Control - - - - &Constants; - - const - int - UI\Controls\Grid::Fill - - - const - int - UI\Controls\Grid::Start - - - const - int - UI\Controls\Grid::Center - - - const - int - UI\Controls\Grid::End - - - const - int - UI\Controls\Grid::Leading - - - const - int - UI\Controls\Grid::Top - - - const - int - UI\Controls\Grid::Trailing - - - const - int - UI\Controls\Grid::Bottom - - - &Properties; - - protected - controls - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Controls\Grid::Fill - - Rellena el espacio disponible. - - - - - UI\Controls\Grid::Start - - Alinea al inicio. - - - - - UI\Controls\Grid::Center - - Centra en el espacio disponible. - - - - - UI\Controls\Grid::End - - Alinea al final. - - - - - UI\Controls\Grid::Leading - - Alinea al inicio del texto. - - - - - UI\Controls\Grid::Top - - Alinea en la parte superior. - - - - - UI\Controls\Grid::Trailing - - Alinea al final del texto. - - - - - UI\Controls\Grid::Bottom - - Alinea en la parte inferior. - - - - -
    - - - -
    - &reftitle.properties; - - - controls - - - Contiene controles, no debe ser manipulado directamente. - - - - -
    - - -
    - - &reference.ui.ui.controls.entities.grid; - -
    - - diff --git a/reference/ui/ui.controls.group.xml b/reference/ui/ui.controls.group.xml deleted file mode 100644 index 3ae27a31e0..0000000000 --- a/reference/ui/ui.controls.group.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - Grupo de Control (Disposición) - UI\Controls\Group - - - - -
    - &reftitle.intro; - - Un grupo (Group) es un contenedor con título para los controles hijos. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Group - - - - - UI\Controls\Group - - - - extends - UI\Control - - - - - &Properties; - - protected - controls - - - Constructor - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.properties; - - - controls - - - Contiene controles, no debe ser manipulado directamente. - - - - -
    - - -
    - - &reference.ui.ui.controls.entities.group; - -
    - - diff --git a/reference/ui/ui.controls.label.xml b/reference/ui/ui.controls.label.xml deleted file mode 100644 index 7fd85bd59a..0000000000 --- a/reference/ui/ui.controls.label.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - Etiqueta de Control - UI\Controls\Label - - - - -
    - &reftitle.intro; - - Una etiqueta (Label) es una línea de texto única, destinada a identificar, para el usuario, un elemento de la interfaz. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Label - - - - - UI\Controls\Label - - - - extends - UI\Control - - - - - Constructor - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.ui.ui.controls.entities.label; - -
    - - diff --git a/reference/ui/ui.controls.multilineentry.xml b/reference/ui/ui.controls.multilineentry.xml deleted file mode 100644 index db50c65658..0000000000 --- a/reference/ui/ui.controls.multilineentry.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - Entrada Multilínea de Control - UI\Controls\MultilineEntry - - - - -
    - &reftitle.intro; - - Una entrada multilínea (Multiline Entry) es un control de entrada de texto capaz de contener múltiples líneas de texto, con o sin retorno de carro. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\MultilineEntry - - - - - UI\Controls\MultilineEntry - - - - extends - UI\Control - - - - &Constants; - - const - int - UI\Controls\MultilineEntry::Wrap - - - const - int - UI\Controls\MultilineEntry::NoWrap - - - Constructor - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Controls\MultilineEntry::Wrap - - Permitir que las líneas se devuelvan. - - - - - UI\Controls\MultilineEntry::NoWrap - - No permitir que las líneas se devuelvan. - - - - -
    - - -
    - - &reference.ui.ui.controls.entities.multilineentry; - -
    - - diff --git a/reference/ui/ui.controls.picker.xml b/reference/ui/ui.controls.picker.xml deleted file mode 100644 index 6ffb893add..0000000000 --- a/reference/ui/ui.controls.picker.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - Selector de Control - UI\Controls\Picker - - - - -
    - &reftitle.intro; - - Un selector (Picker) representa un botón que, al ser clicado, presenta una interfaz nativa de selección de Fecha/Hora/FechaHora al usuario. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Picker - - - - - UI\Controls\Picker - - - - extends - UI\Control - - - - &Constants; - - const - int - UI\Controls\Picker::Date - - - const - int - UI\Controls\Picker::Time - - - const - int - UI\Controls\Picker::DateTime - - - Constructor - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Controls\Picker::Date - - Un selector de Fecha - - - - - UI\Controls\Picker::Time - - Un selector de Tiempo - - - - - UI\Controls\Picker::DateTime - - Un selector de Fecha y Tiempo - - - - -
    - - -
    - - &reference.ui.ui.controls.entities.picker; - -
    - - diff --git a/reference/ui/ui.controls.progress.xml b/reference/ui/ui.controls.progress.xml deleted file mode 100644 index 20dea03d7b..0000000000 --- a/reference/ui/ui.controls.progress.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - Control de Progreso - UI\Controls\Progress - - - - -
    - &reftitle.intro; - - Un control de Progreso (Progress Control) es una barra de progreso familiar: representa el progreso en porcentaje, con un rango posible de 0 a 100 (inclusive). - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Progress - - - - - UI\Controls\Progress - - - - extends - UI\Control - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.ui.ui.controls.entities.progress; - -
    - - diff --git a/reference/ui/ui.controls.radio.xml b/reference/ui/ui.controls.radio.xml deleted file mode 100644 index 7f225250c9..0000000000 --- a/reference/ui/ui.controls.radio.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - Radio de Control - UI\Controls\Radio - - - - -
    - &reftitle.intro; - - Una radio es un control de entrada de tipo botón de radio, familiar de las entradas de tipo radio en HTML. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Radio - - - - - UI\Controls\Radio - - - - extends - UI\Control - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.ui.ui.controls.entities.radio; - -
    - - diff --git a/reference/ui/ui.controls.separator.xml b/reference/ui/ui.controls.separator.xml deleted file mode 100644 index bc1bd0760d..0000000000 --- a/reference/ui/ui.controls.separator.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - Separador de Control - UI\Controls\Separator - - - - -
    - &reftitle.intro; - - Un separador (Separator) representa un control separador, no tiene otra función. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Separator - - - - - UI\Controls\Separator - - - - extends - UI\Control - - - - &Constants; - - const - int - UI\Controls\Separator::Horizontal - - - const - int - UI\Controls\Separator::Vertical - - - Constructor - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Controls\Separator::Horizontal - - Un separador horizontal. - - - - - UI\Controls\Separator::Vertical - - Un separador vertical. - - - - -
    - - -
    - - &reference.ui.ui.controls.entities.separator; - -
    - - diff --git a/reference/ui/ui.controls.slider.xml b/reference/ui/ui.controls.slider.xml deleted file mode 100644 index 1eed0b7589..0000000000 --- a/reference/ui/ui.controls.slider.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - Control de Deslizamiento - UI\Controls\Slider - - - - -
    - &reftitle.intro; - - Un control de deslizamiento (Slider) es un control que representa un rango y un valor actual dentro del rango. El elemento de deslizamiento del control (a veces llamado "pulgón") refleja el valor y puede ser ajustado dentro del rango. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Slider - - - - - UI\Controls\Slider - - - - extends - UI\Control - - - - - Constructor - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.ui.ui.controls.entities.slider; - -
    - - diff --git a/reference/ui/ui.controls.spin.xml b/reference/ui/ui.controls.spin.xml deleted file mode 100644 index 93c5f84467..0000000000 --- a/reference/ui/ui.controls.spin.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - Caja de rotación de control - UI\Controls\Spin - - - - -
    - &reftitle.intro; - - Una caja giratoria ( Spin ) es una caja de texto con un control arriba-abajo que cambia todo el valor de la caja, dentro de un rango definido. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Spin - - - - - UI\Controls\Spin - - - - extends - UI\Control - - - - - Constructor - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.ui.ui.controls.entities.spin; - -
    - - diff --git a/reference/ui/ui.controls.tab.xml b/reference/ui/ui.controls.tab.xml deleted file mode 100644 index 9188c6726a..0000000000 --- a/reference/ui/ui.controls.tab.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - Cuadro de pestaña de control - UI\Controls\Tab - - - - -
    - &reftitle.intro; - - Un cuadro de pestañas (Tab) es un contenedor de controles, cada pestaña contiene un título seleccionable por el usuario. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Controls\Tab - - - - - UI\Controls\Tab - - - - extends - UI\Control - - - - - &Properties; - - protected - controls - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.properties; - - - controls - - - Contiene controles, no debe manipularse directamente - - - - -
    - - -
    - - &reference.ui.ui.controls.entities.tab; - -
    - - diff --git a/reference/ui/ui.draw.brush.gradient.xml b/reference/ui/ui.draw.brush.gradient.xml deleted file mode 100644 index 97bc6ca104..0000000000 --- a/reference/ui/ui.draw.brush.gradient.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - Pinceles de degradado - UI\Draw\Brush\Gradient - - - - -
    - &reftitle.intro; - - Abstracción para pinceles de degradado - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Brush\Gradient - - - - - abstract - UI\Draw\Brush\Gradient - - - - extends - UI\Draw\Brush - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.ui.ui.draw.entities.brush.gradient; - -
    - - diff --git a/reference/ui/ui.draw.brush.lineargradient.xml b/reference/ui/ui.draw.brush.lineargradient.xml deleted file mode 100644 index 93af43d7bb..0000000000 --- a/reference/ui/ui.draw.brush.lineargradient.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - Gradiente lineal - UI\Draw\Brush\LinearGradient - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Brush\LinearGradient - - - - - UI\Draw\Brush\LinearGradient - - - - extends - UI\Draw\Brush\Gradient - - - - - Constructor - - - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.ui.ui.draw.entities.brush.lineargradient; - -
    - - diff --git a/reference/ui/ui.draw.brush.radialgradient.xml b/reference/ui/ui.draw.brush.radialgradient.xml deleted file mode 100644 index 7c1e8bc2af..0000000000 --- a/reference/ui/ui.draw.brush.radialgradient.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - Gradiente radial - UI\Draw\Brush\RadialGradient - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Brush\RadialGradient - - - - - UI\Draw\Brush\RadialGradient - - - - extends - UI\Draw\Brush\Gradient - - - - - Constructor - - - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.ui.ui.draw.entities.brush.radialgradient; - -
    - - diff --git a/reference/ui/ui.draw.brush.xml b/reference/ui/ui.draw.brush.xml deleted file mode 100644 index 7e4d7f4743..0000000000 --- a/reference/ui/ui.draw.brush.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - Pinceles - UI\Draw\Brush - - - - -
    - &reftitle.intro; - - Representa un pincel de color sólido - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Brush - - - - - UI\Draw\Brush - - - - - Constructor - - - &Methods; - - - - -
    - -
    - - &reference.ui.ui.draw.entities.brush; - -
    - - diff --git a/reference/ui/ui.draw.color.xml b/reference/ui/ui.draw.color.xml deleted file mode 100644 index 41dcf0ff26..0000000000 --- a/reference/ui/ui.draw.color.xml +++ /dev/null @@ -1,180 +0,0 @@ - - - - - Representación en color - UI\Draw\Color - - - - -
    - &reftitle.intro; - - Representa un color RGBA, los canales individuales son accesibles a través de propiedades públicas. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Color - - - - - UI\Draw\Color - - - - &Constants; - - const - int - UI\Draw\Color::Red - - - const - int - UI\Draw\Color::Green - - - const - int - UI\Draw\Color::Blue - - - const - int - UI\Draw\Color::Alpha - - - &Properties; - - public - r - - - public - g - - - public - b - - - public - a - - - Constructor - - - &Methods; - - - - -
    - - - -
    - &reftitle.properties; - - - r - - Proporciona acceso al canal rojo - - - - g - - Proporciona acceso al canal verde - - - - b - - Proporciona acceso al canal azul - - - - a - - Proporciona acceso al canal alfa - - - -
    - - - - -
    - &reftitle.constants; - - - - UI\Draw\Color::Red - - Identifica el canal rojo - - - - - UI\Draw\Color::Green - - Identifica el canal verde - - - - - UI\Draw\Color::Blue - - Identifica el canal azul - - - - - UI\Draw\Color::Alpha - - Identifica el canal alfa - - - - -
    - - - -
    - - &reference.ui.ui.draw.entities.color; - -
    - - diff --git a/reference/ui/ui.draw.line.cap.xml b/reference/ui/ui.draw.line.cap.xml deleted file mode 100644 index e801ab0b28..0000000000 --- a/reference/ui/ui.draw.line.cap.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - Parámetros de terminación de línea - UI\Draw\Line\Cap - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Line\Cap - - - - - final - UI\Draw\Line\Cap - - - - &Constants; - - const - int - UI\Draw\Line\Cap::Flat - - - const - int - UI\Draw\Line\Cap::Round - - - const - int - UI\Draw\Line\Cap::Square - - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Draw\Line\Cap::Flat - - - - - - UI\Draw\Line\Cap::Round - - - - - - UI\Draw\Line\Cap::Square - - - - - - -
    - -
    - -
    - - diff --git a/reference/ui/ui.draw.line.join.xml b/reference/ui/ui.draw.line.join.xml deleted file mode 100644 index cbdea1f578..0000000000 --- a/reference/ui/ui.draw.line.join.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - Parámetros de unión de líneas - UI\Draw\Line\Join - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Line\Join - - - - - final - UI\Draw\Line\Join - - - - &Constants; - - const - int - UI\Draw\Line\Join::Miter - - - const - int - UI\Draw\Line\Join::Round - - - const - int - UI\Draw\Line\Join::Bevel - - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Draw\Line\Join::Miter - - - - - - UI\Draw\Line\Join::Round - - - - - - UI\Draw\Line\Join::Bevel - - - - - - -
    - -
    - -
    - - diff --git a/reference/ui/ui.draw.matrix.xml b/reference/ui/ui.draw.matrix.xml deleted file mode 100644 index 20c41268c5..0000000000 --- a/reference/ui/ui.draw.matrix.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - Matriz de dibujo - UI\Draw\Matrix - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Matrix - - - - - UI\Draw\Matrix - - - - - &Methods; - - - - -
    - -
    - - &reference.ui.ui.draw.entities.matrix; - -
    - - diff --git a/reference/ui/ui.draw.path.xml b/reference/ui/ui.draw.path.xml deleted file mode 100644 index f25a180dd9..0000000000 --- a/reference/ui/ui.draw.path.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - Dibujo del camino - UI\Draw\Path - - - - -
    - &reftitle.intro; - - Una ruta de dibujo guía al rotulador, indicándole dónde dibujar en un área. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Path - - - - - UI\Draw\Path - - - - &Constants; - - const - int - UI\Draw\Path::Winding - - - const - int - UI\Draw\Path::Alternate - - - Constructor - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Draw\Path::Winding - - - Este es el modo de trazado por defecto - - - - - - UI\Draw\Path::Alternate - - - Este es el modo alternativo de diseño de la ruta - - - - - -
    - - - -
    - - &reference.ui.ui.draw.entities.path; - -
    - - diff --git a/reference/ui/ui.draw.pen.xml b/reference/ui/ui.draw.pen.xml deleted file mode 100644 index 5d4b586b02..0000000000 --- a/reference/ui/ui.draw.pen.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - Lápiz de dibujo - UI\Draw\Pen - - - - -
    - &reftitle.intro; - - El lápiz se pasa al evento de dibujo de zona y se utiliza para recortar, rellenar, dibujar y escribir trazados de dibujo. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Pen - - - - - final - UI\Draw\Pen - - - - - &Methods; - - - - -
    - -
    - - &reference.ui.ui.draw.entities.pen; - -
    - - diff --git a/reference/ui/ui.draw.stroke.xml b/reference/ui/ui.draw.stroke.xml deleted file mode 100644 index b6c3f68945..0000000000 --- a/reference/ui/ui.draw.stroke.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - Dibujo lineal - UI\Draw\Stroke - - - - -
    - &reftitle.intro; - - Mantiene la configuración para que el Pen haga una línea - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Stroke - - - - - UI\Draw\Stroke - - - - - Constructor - - - &Methods; - - - - -
    - -
    - - &reference.ui.ui.draw.entities.stroke; - -
    - - diff --git a/reference/ui/ui.draw.text.font.descriptor.xml b/reference/ui/ui.draw.text.font.descriptor.xml deleted file mode 100644 index 28be445ac2..0000000000 --- a/reference/ui/ui.draw.text.font.descriptor.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - Descriptor de fuente - UI\Draw\Text\Font\Descriptor - - - - -
    - &reftitle.intro; - - Describe un tipo de letra - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Text\Font\Descriptor - - - - - UI\Draw\Text\Font\Descriptor - - - - - Constructor - - - &Methods; - - - - -
    - -
    - - &reference.ui.ui.draw.text.entities.font.descriptor; - -
    - - diff --git a/reference/ui/ui.draw.text.font.italic.xml b/reference/ui/ui.draw.text.font.italic.xml deleted file mode 100644 index f7fa141327..0000000000 --- a/reference/ui/ui.draw.text.font.italic.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - Configuración de la fuente cursiva - UI\Draw\Text\Font\Italic - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Text\Font\Italic - - - - - final - UI\Draw\Text\Font\Italic - - - - &Constants; - - const - int - UI\Draw\Text\Font\Italic::Normal - 0 - - - const - int - UI\Draw\Text\Font\Italic::Oblique - 1 - - - const - int - UI\Draw\Text\Font\Italic::Italic - 2 - - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Draw\Text\Font\Italic::Normal - - - - - - UI\Draw\Text\Font\Italic::Oblique - - - - - - UI\Draw\Text\Font\Italic::Italic - - - - - - -
    - -
    - -
    - - diff --git a/reference/ui/ui.draw.text.font.stretch.xml b/reference/ui/ui.draw.text.font.stretch.xml deleted file mode 100644 index 74148f1cff..0000000000 --- a/reference/ui/ui.draw.text.font.stretch.xml +++ /dev/null @@ -1,181 +0,0 @@ - - - - - Ajustes de estiramiento de fuentes - UI\Draw\Text\Font\Stretch - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Text\Font\Stretch - - - - - final - UI\Draw\Text\Font\Stretch - - - - &Constants; - - const - int - UI\Draw\Text\Font\Stretch::UltraCondensed - 0 - - - const - int - UI\Draw\Text\Font\Stretch::ExtraCondensed - 1 - - - const - int - UI\Draw\Text\Font\Stretch::Condensed - 2 - - - const - int - UI\Draw\Text\Font\Stretch::SemiCondensed - 3 - - - const - int - UI\Draw\Text\Font\Stretch::Normal - 4 - - - const - int - UI\Draw\Text\Font\Stretch::SemiExpanded - 5 - - - const - int - UI\Draw\Text\Font\Stretch::Expanded - 6 - - - const - int - UI\Draw\Text\Font\Stretch::ExtraExpanded - 7 - - - const - int - UI\Draw\Text\Font\Stretch::UltraExpanded - 8 - - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Draw\Text\Font\Stretch::UltraCondensed - - - - - - UI\Draw\Text\Font\Stretch::ExtraCondensed - - - - - - UI\Draw\Text\Font\Stretch::Condensed - - - - - - UI\Draw\Text\Font\Stretch::SemiCondensed - - - - - - UI\Draw\Text\Font\Stretch::Normal - - - - - - UI\Draw\Text\Font\Stretch::SemiExpanded - - - - - - UI\Draw\Text\Font\Stretch::Expanded - - - - - - UI\Draw\Text\Font\Stretch::ExtraExpanded - - - - - - UI\Draw\Text\Font\Stretch::UltraExpanded - - - - - - -
    - -
    - -
    - - diff --git a/reference/ui/ui.draw.text.font.weight.xml b/reference/ui/ui.draw.text.font.weight.xml deleted file mode 100644 index 63ba3e4701..0000000000 --- a/reference/ui/ui.draw.text.font.weight.xml +++ /dev/null @@ -1,194 +0,0 @@ - - - - - Configuración del grosor de la fuente - UI\Draw\Text\Font\Weight - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Text\Font\Weight - - - - - final - UI\Draw\Text\Font\Weight - - - - &Constants; - - const - int - UI\Draw\Text\Font\Weight::Thin - - - const - int - UI\Draw\Text\Font\Weight::UltraLight - - - const - int - UI\Draw\Text\Font\Weight::Light - - - const - int - UI\Draw\Text\Font\Weight::Book - - - const - int - UI\Draw\Text\Font\Weight::Normal - - - const - int - UI\Draw\Text\Font\Weight::Medium - - - const - int - UI\Draw\Text\Font\Weight::SemiBold - - - const - int - UI\Draw\Text\Font\Weight::Bold - - - const - int - UI\Draw\Text\Font\Weight::UltraBold - - - const - int - UI\Draw\Text\Font\Weight::Heavy - - - const - int - UI\Draw\Text\Font\Weight::UltraHeavy - - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Draw\Text\Font\Weight::Thin - - - - - - UI\Draw\Text\Font\Weight::UltraLight - - - - - - UI\Draw\Text\Font\Weight::Light - - - - - - UI\Draw\Text\Font\Weight::Book - - - - - - UI\Draw\Text\Font\Weight::Normal - - - - - - UI\Draw\Text\Font\Weight::Medium - - - - - - UI\Draw\Text\Font\Weight::SemiBold - - - - - - UI\Draw\Text\Font\Weight::Bold - - - - - - UI\Draw\Text\Font\Weight::UltraBold - - - - - - UI\Draw\Text\Font\Weight::Heavy - - - - - - UI\Draw\Text\Font\Weight::UltraHeavy - - - - - - -
    - -
    - -
    - - diff --git a/reference/ui/ui.draw.text.font.xml b/reference/ui/ui.draw.text.font.xml deleted file mode 100644 index a6d84d3d6b..0000000000 --- a/reference/ui/ui.draw.text.font.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - Representa una fuente - UI\Draw\Text\Font - - - - -
    - &reftitle.intro; - - Carga una fuente descrita - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Text\Font - - - - - UI\Draw\Text\Font - - - - - Constructor - - - &Methods; - - - - - -
    - -
    - - &reference.ui.ui.draw.text.entities.font; - -
    - - diff --git a/reference/ui/ui.draw.text.layout.xml b/reference/ui/ui.draw.text.layout.xml deleted file mode 100644 index 49ff947956..0000000000 --- a/reference/ui/ui.draw.text.layout.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - Representa el diseño del texto - UI\Draw\Text\Layout - - - - -
    - &reftitle.intro; - - Un diseño de texto representa el diseño del texto que dibujará el lápiz. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Draw\Text\Layout - - - - - UI\Draw\Text\Layout - - - - - Constructor - - - &Methods; - - - - -
    - -
    - - &reference.ui.ui.draw.text.entities.layout; - -
    - - diff --git a/reference/ui/ui.exception.invalidargumentexception.xml b/reference/ui/ui.exception.invalidargumentexception.xml deleted file mode 100644 index 05a2ae769c..0000000000 --- a/reference/ui/ui.exception.invalidargumentexception.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - InvalidArgumentException - UI\Exception\InvalidArgumentException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Exception\InvalidArgumentException - - - - - UI\Exception\InvalidArgumentException - - - - extends - InvalidArgumentException - - - - Throwable - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - -
    - -
    - - diff --git a/reference/ui/ui.exception.runtimeexception.xml b/reference/ui/ui.exception.runtimeexception.xml deleted file mode 100644 index e406eaeaea..0000000000 --- a/reference/ui/ui.exception.runtimeexception.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - RuntimeException - UI\Exception\RuntimeException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Exception\RuntimeException - - - - - UI\Exception\RuntimeException - - - - extends - RuntimeException - - - - Throwable - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - -
    - -
    - - diff --git a/reference/ui/ui.executor.xml b/reference/ui/ui.executor.xml deleted file mode 100644 index e385508248..0000000000 --- a/reference/ui/ui.executor.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - Planificador de la ejecución - UI\Executor - - - - -
    - &reftitle.intro; - - Esto se puede utilizar para programar la ejecución repetida de una función de devolución de llamada, útil para animaciones y actividades similares. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Executor - - - - - abstract - UI\Executor - - - - - Constructor - - - &Methods; - - - - -
    - -
    - - &reference.ui.ui.entities.executor; - -
    - - diff --git a/reference/ui/ui.key.xml b/reference/ui/ui.key.xml deleted file mode 100644 index b83c9c7828..0000000000 --- a/reference/ui/ui.key.xml +++ /dev/null @@ -1,502 +0,0 @@ - - - - - Identificadores clave - UI\Key - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Key - - - - - final - UI\Key - - - - &Constants; - - const - int - UI\Key::Escape - - - const - int - UI\Key::Insert - - - const - int - UI\Key::Delete - - - const - int - UI\Key::Home - - - const - int - UI\Key::End - - - const - int - UI\Key::PageUp - - - const - int - UI\Key::PageDown - - - const - int - UI\Key::Up - - - const - int - UI\Key::Down - - - const - int - UI\Key::Left - - - const - int - UI\Key::Right - - - const - int - UI\Key::F1 - - - const - int - UI\Key::F2 - - - const - int - UI\Key::F3 - - - const - int - UI\Key::F4 - - - const - int - UI\Key::F5 - - - const - int - UI\Key::F6 - - - const - int - UI\Key::F7 - - - const - int - UI\Key::F8 - - - const - int - UI\Key::F9 - - - const - int - UI\Key::F10 - - - const - int - UI\Key::F11 - - - const - int - UI\Key::F12 - - - const - int - UI\Key::N0 - - - const - int - UI\Key::N1 - - - const - int - UI\Key::N2 - - - const - int - UI\Key::N3 - - - const - int - UI\Key::N4 - - - const - int - UI\Key::N5 - - - const - int - UI\Key::N6 - - - const - int - UI\Key::N7 - - - const - int - UI\Key::N8 - - - const - int - UI\Key::N9 - - - const - int - UI\Key::NDot - - - const - int - UI\Key::NEnter - - - const - int - UI\Key::NAdd - - - const - int - UI\Key::NSubtract - - - const - int - UI\Key::NMultiply - - - const - int - UI\Key::NDivide - - - - - -
    - - -
    - &reftitle.constants; - - - - UI\Key::Escape - - - - - - UI\Key::Insert - - - - - - UI\Key::Delete - - - - - - UI\Key::Home - - - - - - UI\Key::End - - - - - - UI\Key::PageUp - - - - - - UI\Key::PageDown - - - - - - UI\Key::Up - - - - - - UI\Key::Down - - - - - - UI\Key::Left - - - - - - UI\Key::Right - - - - - - UI\Key::F1 - - - - - - UI\Key::F2 - - - - - - UI\Key::F3 - - - - - - UI\Key::F4 - - - - - - UI\Key::F5 - - - - - - UI\Key::F6 - - - - - - UI\Key::F7 - - - - - - UI\Key::F8 - - - - - - UI\Key::F9 - - - - - - UI\Key::F10 - - - - - - UI\Key::F11 - - - - - - UI\Key::F12 - - - - - - UI\Key::N0 - - - - - - UI\Key::N1 - - - - - - UI\Key::N2 - - - - - - UI\Key::N3 - - - - - - UI\Key::N4 - - - - - - UI\Key::N5 - - - - - - UI\Key::N6 - - - - - - UI\Key::N7 - - - - - - UI\Key::N8 - - - - - - UI\Key::N9 - - - - - - UI\Key::NDot - - - - - - UI\Key::NEnter - - - - - - UI\Key::NAdd - - - - - - UI\Key::NSubtract - - - - - - UI\Key::NMultiply - - - - - - UI\Key::NDivide - - - - - - -
    - -
    - -
    - - diff --git a/reference/ui/ui.menu.xml b/reference/ui/ui.menu.xml deleted file mode 100644 index 75506c167a..0000000000 --- a/reference/ui/ui.menu.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - Menú - UI\Menu - - - - -
    - &reftitle.intro; - - Los menús deben crearse antes de la primera ventana y pueden aparecer en cualquier ventana. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Menu - - - - - UI\Menu - - - - - Constructor - - - &Methods; - - - - -
    - -
    - - &reference.ui.ui.entities.menu; - -
    - - diff --git a/reference/ui/ui.menuitem.xml b/reference/ui/ui.menuitem.xml deleted file mode 100644 index 431a70e68b..0000000000 --- a/reference/ui/ui.menuitem.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - Elemento del menú - UI\MenuItem - - - - -
    - &reftitle.intro; - - Los elementos de menú sólo pueden crearse mediante la función - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\MenuItem - - - - - UI\MenuItem - - - - - &Methods; - - - - -
    - -
    - - &reference.ui.ui.entities.menuitem; - -
    - - diff --git a/reference/ui/ui.point.xml b/reference/ui/ui.point.xml deleted file mode 100644 index 3b0b113bb2..0000000000 --- a/reference/ui/ui.point.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - Representa una posición (x,y) - UI\Point - - - - -
    - &reftitle.intro; - - Los puntos se utilizan en toda la interfaz de usuario para representar coordenadas en una pantalla, control o zona. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Point - - - - - final - UI\Point - - - - &Properties; - - public - x - - - public - y - - - Constructor - - - &Methods; - - - - -
    - - - -
    - &reftitle.properties; - - - x - - - Contiene la coordenada X, se puede leer/escribir directamente - - - - - y - - - Contiene la coordenada Y, se puede leer/escribir directamente - - - - -
    - - - -
    - - &reference.ui.ui.entities.point; - -
    - - diff --git a/reference/ui/ui.size.xml b/reference/ui/ui.size.xml deleted file mode 100644 index 5f9d794631..0000000000 --- a/reference/ui/ui.size.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - Représente des dimensions (largeur, hauteur) - UI\Size - - - - -
    - &reftitle.intro; - - Los tamaños se utilizan en toda la interfaz de usuario para representar el tamaño de una pantalla, control o zona. - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Size - - - - - final - UI\Size - - - - &Properties; - - public - width - - - public - height - - - Constructor - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - width - - - Contiene la anchura, se puede leer/escribir directamente - - - - - height - - - Contiene la altura, se puede leer/escribir directamente - - - - -
    - - -
    - - &reference.ui.ui.entities.size; - -
    - - diff --git a/reference/ui/ui.window.xml b/reference/ui/ui.window.xml deleted file mode 100644 index b99075288d..0000000000 --- a/reference/ui/ui.window.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - Ventana - UI\Window - - - - -
    - &reftitle.intro; - - Representa una ventana de interfaz de usuario - -
    - - -
    - &reftitle.classsynopsis; - - - - UI\Window - - - - - UI\Window - - - - extends - UI\Control - - - - &Properties; - - protected - controls - - - Constructor - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.properties; - - - controls - - - Contiene controles, no debe manipularse directamente - - - - -
    - - -
    - - &reference.ui.ui.entities.window; - -
    - - diff --git a/reference/ui/ui/area/ondraw.xml b/reference/ui/ui/area/ondraw.xml deleted file mode 100644 index f3a41df912..0000000000 --- a/reference/ui/ui/area/ondraw.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - UI\Area::onDraw - Retrollamada de dibujo - - - - &reftitle.description; - - protected UI\Area::onDraw - UI\Draw\Penpen - UI\SizeareaSize - UI\PointclipPoint - UI\SizeclipSize - - - Debe ser invocada cuando esta área necesita ser redibujada - - - - - - &reftitle.parameters; - - - pen - - - Un lápiz adecuado para dibujar en esta área - - - - - areaSize - - - El tamaño del área - - - - - clipPoint - - - El punto de recorte del área - - - - - clipSize - - - El tamaño de recorte del área - - - - - - - - - diff --git a/reference/ui/ui/area/onkey.xml b/reference/ui/ui/area/onkey.xml deleted file mode 100644 index ad4709d7e9..0000000000 --- a/reference/ui/ui/area/onkey.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - UI\Area::onKey - Retrollamada de tecla - - - - &reftitle.description; - - protected UI\Area::onKey - stringkey - intext - intflags - - - Debe ser ejecutada en los eventos de tecla - - - - - - &reftitle.parameters; - - - key - - - La tecla presionada - - - - - ext - - - La tecla extendida presionada - - - - - flags - - - Modificadores de eventos - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/ui/ui/area/onmouse.xml b/reference/ui/ui/area/onmouse.xml deleted file mode 100644 index 828acf0505..0000000000 --- a/reference/ui/ui/area/onmouse.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - UI\Area::onMouse - Retrollamada de ratón - - - - &reftitle.description; - - protected UI\Area::onMouse - UI\PointareaPoint - UI\SizeareaSize - intflags - - - Debe ser ejecutada en los eventos de ratón - - - - - - &reftitle.parameters; - - - areaPoint - - - Las coordenadas del evento - - - - - areaSize - - - El tamaño de la zona del evento - - - - - flags - - - Modificadores de eventos - - - - - - - - - diff --git a/reference/ui/ui/area/redraw.xml b/reference/ui/ui/area/redraw.xml deleted file mode 100644 index e3ed9d0a88..0000000000 --- a/reference/ui/ui/area/redraw.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - UI\Area::redraw - Redibuja el área - - - - &reftitle.description; - - public UI\Area::redraw - - - - Solicita que este área sea redibujada - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/ui/ui/area/scrollto.xml b/reference/ui/ui/area/scrollto.xml deleted file mode 100644 index c88cfc33b5..0000000000 --- a/reference/ui/ui/area/scrollto.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - UI\Area::scrollTo - Desplazamiento del área - - - - &reftitle.description; - - public UI\Area::scrollTo - UI\Pointpoint - UI\Sizesize - - - Desplaza este área - - - - - - &reftitle.parameters; - - - point - - - El punto al que desplazarse - - - - - size - - - El tamaño del panel de desplazamiento - - - - - - - - - diff --git a/reference/ui/ui/area/setsize.xml b/reference/ui/ui/area/setsize.xml deleted file mode 100644 index b0e30585f4..0000000000 --- a/reference/ui/ui/area/setsize.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Area::setSize - Establece el tamaño - - - - &reftitle.description; - - public UI\Area::setSize - UI\Sizesize - - - Establece el tamaño de este área - - - - - - &reftitle.parameters; - - - size - - - El nuevo tamaño - - - - - - - - - diff --git a/reference/ui/ui/control/destroy.xml b/reference/ui/ui/control/destroy.xml deleted file mode 100644 index 6478735b69..0000000000 --- a/reference/ui/ui/control/destroy.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - UI\Control::destroy - Destruye el control - - - - &reftitle.description; - - public UI\Control::destroy - - - - Destruye este control - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/ui/ui/control/disable.xml b/reference/ui/ui/control/disable.xml deleted file mode 100644 index 550b243e85..0000000000 --- a/reference/ui/ui/control/disable.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - UI\Control::disable - Desactiva el control - - - - &reftitle.description; - - public UI\Control::disable - - - - Desactiva este control - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/ui/ui/control/enable.xml b/reference/ui/ui/control/enable.xml deleted file mode 100644 index 4536f4a7b6..0000000000 --- a/reference/ui/ui/control/enable.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - UI\Control::enable - Activa el control - - - - &reftitle.description; - - public UI\Control::enable - - - - Activa este control - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/ui/ui/control/getparent.xml b/reference/ui/ui/control/getparent.xml deleted file mode 100644 index 7d532da468..0000000000 --- a/reference/ui/ui/control/getparent.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - UI\Control::getParent - Devuelve el control padre - - - - &reftitle.description; - - public UI\ControlUI\Control::getParent - - - - Devuelve el control padre - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/ui/ui/control/gettoplevel.xml b/reference/ui/ui/control/gettoplevel.xml deleted file mode 100644 index ec16baa649..0000000000 --- a/reference/ui/ui/control/gettoplevel.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Control::getTopLevel - Devuelve el nivel más alto - - - - &reftitle.description; - - public intUI\Control::getTopLevel - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/ui/ui/control/hide.xml b/reference/ui/ui/control/hide.xml deleted file mode 100644 index 4e2309595b..0000000000 --- a/reference/ui/ui/control/hide.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - UI\Control::hide - Oculta el control - - - - &reftitle.description; - - public UI\Control::hide - - - - Oculta este control - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/ui/ui/control/isenabled.xml b/reference/ui/ui/control/isenabled.xml deleted file mode 100644 index 0268c45cbf..0000000000 --- a/reference/ui/ui/control/isenabled.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - UI\Control::isEnabled - Devuelve si el control está activado - - - - &reftitle.description; - - public boolUI\Control::isEnabled - - - - Devuelve si este control está activado - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/ui/ui/control/isvisible.xml b/reference/ui/ui/control/isvisible.xml deleted file mode 100644 index 005a2a28dc..0000000000 --- a/reference/ui/ui/control/isvisible.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - UI\Control::isVisible - Devuelve si el control es visible - - - - &reftitle.description; - - public boolUI\Control::isVisible - - - - Devuelve si este control es visible - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/ui/ui/control/setparent.xml b/reference/ui/ui/control/setparent.xml deleted file mode 100644 index d33b1ddfd6..0000000000 --- a/reference/ui/ui/control/setparent.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - UI\Control::setParent - Establece el control padre - - - - &reftitle.description; - - public UI\Control::setParent - UI\Controlparent - - - Establece el control padre de este control - - - - - - &reftitle.parameters; - - - parent - - - El control padre - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/ui/ui/control/show.xml b/reference/ui/ui/control/show.xml deleted file mode 100644 index 2be8e3f90f..0000000000 --- a/reference/ui/ui/control/show.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - UI\Control::show - Muestra el control - - - - &reftitle.description; - - public UI\Control::show - - - - Muestra este control - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/ui/ui/controls/box/append.xml b/reference/ui/ui/controls/box/append.xml deleted file mode 100644 index cc57ae9fe1..0000000000 --- a/reference/ui/ui/controls/box/append.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - UI\Controls\Box::append - Añade un control - - - - &reftitle.description; - - public intUI\Controls\Box::append - Controlcontrol - boolstretchy&false; - - - Añade el control dado a esta caja - - - - - - &reftitle.parameters; - - - control - - - El control a añadir - - - - - stretchy - - - Define si el control debe ser estirado - - - - - - - - &reftitle.returnvalues; - - Devuelve el índice del control añadido, puede ser 0 - - - - - - diff --git a/reference/ui/ui/controls/box/construct.xml b/reference/ui/ui/controls/box/construct.xml deleted file mode 100644 index a344d6c402..0000000000 --- a/reference/ui/ui/controls/box/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Controls\Box::__construct - Construye una nueva caja - - - - &reftitle.description; - - public UI\Controls\Box::__construct - intorientationUI\Controls\Box::Horizontal - - - Construye una nueva caja - - - - - - &reftitle.parameters; - - - orientation - - - Box::Horizontal o Box::Vertical - - - - - - - - - diff --git a/reference/ui/ui/controls/box/delete.xml b/reference/ui/ui/controls/box/delete.xml deleted file mode 100644 index 07768fbe9a..0000000000 --- a/reference/ui/ui/controls/box/delete.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - UI\Controls\Box::delete - Elimina un control - - - - &reftitle.description; - - public boolUI\Controls\Box::delete - intindex - - - Elimina el control en el índice dado de esta caja - - - - - - &reftitle.parameters; - - - index - - - El índice del control a eliminar - - - - - - - - &reftitle.returnvalues; - - Indica el éxito - - - - - - diff --git a/reference/ui/ui/controls/box/getorientation.xml b/reference/ui/ui/controls/box/getorientation.xml deleted file mode 100644 index 78b7ed3cad..0000000000 --- a/reference/ui/ui/controls/box/getorientation.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - UI\Controls\Box::getOrientation - Devuelve la orientación - - - - &reftitle.description; - - public intUI\Controls\Box::getOrientation - - - - Devuelve la orientación de esta caja - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/ui/ui/controls/box/ispadded.xml b/reference/ui/ui/controls/box/ispadded.xml deleted file mode 100644 index 04189ab01b..0000000000 --- a/reference/ui/ui/controls/box/ispadded.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - UI\Controls\Box::isPadded - Detección del relleno - - - - &reftitle.description; - - public boolUI\Controls\Box::isPadded - - - - Detecta si el relleno está activado en esta caja - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/ui/ui/controls/box/setpadded.xml b/reference/ui/ui/controls/box/setpadded.xml deleted file mode 100644 index 8774301e6f..0000000000 --- a/reference/ui/ui/controls/box/setpadded.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Controls\Box::setPadded - Establece el relleno - - - - &reftitle.description; - - public UI\Controls\Box::setPadded - boolpadded - - - Establece si el relleno está activado o no en esta caja - - - - - - &reftitle.parameters; - - - padded - - - Indica si el relleno está activado - - - - - - - - - diff --git a/reference/ui/ui/controls/button/construct.xml b/reference/ui/ui/controls/button/construct.xml deleted file mode 100644 index a6e299753d..0000000000 --- a/reference/ui/ui/controls/button/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Controls\Button::__construct - Construye un nuevo botón - - - - &reftitle.description; - - public UI\Controls\Button::__construct - stringtext - - - Construye un nuevo botón - - - - - - &reftitle.parameters; - - - text - - - El texto (etiqueta) de este botón - - - - - - - - - diff --git a/reference/ui/ui/controls/button/gettext.xml b/reference/ui/ui/controls/button/gettext.xml deleted file mode 100644 index eac8d6ccc8..0000000000 --- a/reference/ui/ui/controls/button/gettext.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - UI\Controls\Button::getText - Devuelve el texto - - - - &reftitle.description; - - public stringUI\Controls\Button::getText - - - - Devuelve el texto (etiqueta) de este botón - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El texto (etiqueta) actual - - - - - - diff --git a/reference/ui/ui/controls/button/onclick.xml b/reference/ui/ui/controls/button/onclick.xml deleted file mode 100644 index f182f89974..0000000000 --- a/reference/ui/ui/controls/button/onclick.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - UI\Controls\Button::onClick - Gestor de clic - - - - &reftitle.description; - - protected UI\Controls\Button::onClick - - - - Debe ser ejecutado cuando este botón es clicado - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/ui/ui/controls/button/settext.xml b/reference/ui/ui/controls/button/settext.xml deleted file mode 100644 index d7e1c8986e..0000000000 --- a/reference/ui/ui/controls/button/settext.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Controls\Button::setText - Establece el texto - - - - &reftitle.description; - - public UI\Controls\Button::setText - stringtext - - - Establece el texto (etiqueta) de este botón - - - - - - &reftitle.parameters; - - - text - - - El nuevo texto (etiqueta) - - - - - - - - - diff --git a/reference/ui/ui/controls/check/construct.xml b/reference/ui/ui/controls/check/construct.xml deleted file mode 100644 index 9ad5ced5e6..0000000000 --- a/reference/ui/ui/controls/check/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Controls\Check::__construct - Construye una nueva casilla de verificación - - - - &reftitle.description; - - public UI\Controls\Check::__construct - stringtext - - - Construye una nueva casilla de verificación - - - - - - &reftitle.parameters; - - - text - - - El texto (etiqueta) para la casilla de verificación - - - - - - - - - diff --git a/reference/ui/ui/controls/check/gettext.xml b/reference/ui/ui/controls/check/gettext.xml deleted file mode 100644 index a65fa529ec..0000000000 --- a/reference/ui/ui/controls/check/gettext.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - UI\Controls\Check::getText - Devuelve el texto - - - - &reftitle.description; - - public stringUI\Controls\Check::getText - - - - Devuelve el texto (etiqueta) para esta casilla de verificación - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El texto (etiqueta) actual - - - - - - diff --git a/reference/ui/ui/controls/check/ischecked.xml b/reference/ui/ui/controls/check/ischecked.xml deleted file mode 100644 index c2acbe0598..0000000000 --- a/reference/ui/ui/controls/check/ischecked.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - UI\Controls\Check::isChecked - Detección de la casilla marcada - - - - &reftitle.description; - - public boolUI\Controls\Check::isChecked - - - - Detecta el estado de esta casilla de verificación - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/ui/ui/controls/check/ontoggle.xml b/reference/ui/ui/controls/check/ontoggle.xml deleted file mode 100644 index f980750751..0000000000 --- a/reference/ui/ui/controls/check/ontoggle.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - UI\Controls\Check::onToggle - Función de devolución de llamada de alternancia - - - - &reftitle.description; - - protected UI\Controls\Check::onToggle - - - - Debe ser ejecutada cuando el estado de esta casilla de verificación cambia - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/ui/ui/controls/check/setchecked.xml b/reference/ui/ui/controls/check/setchecked.xml deleted file mode 100644 index d7b35c3ccc..0000000000 --- a/reference/ui/ui/controls/check/setchecked.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Controls\Check::setChecked - Establece la casilla marcada - - - - &reftitle.description; - - public UI\Controls\Check::setChecked - boolchecked - - - Cambia el estado de esta casilla de verificación - - - - - - &reftitle.parameters; - - - checked - - - El nuevo estado - - - - - - - - - diff --git a/reference/ui/ui/controls/check/settext.xml b/reference/ui/ui/controls/check/settext.xml deleted file mode 100644 index d172961bb0..0000000000 --- a/reference/ui/ui/controls/check/settext.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Controls\Check::setText - Establece el texto - - - - &reftitle.description; - - public UI\Controls\Check::setText - stringtext - - - Establece el texto (etiqueta) para esta casilla de verificación - - - - - - &reftitle.parameters; - - - text - - - El nuevo texto (etiqueta) - - - - - - - - - diff --git a/reference/ui/ui/controls/colorbutton/getcolor.xml b/reference/ui/ui/controls/colorbutton/getcolor.xml deleted file mode 100644 index 98395c0e52..0000000000 --- a/reference/ui/ui/controls/colorbutton/getcolor.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - UI\Controls\ColorButton::getColor - Devuelve el color - - - - &reftitle.description; - - public UI\ColorUI\Controls\ColorButton::getColor - - - - Devuelve el color actualmente seleccionado - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/ui/ui/controls/colorbutton/onchange.xml b/reference/ui/ui/controls/colorbutton/onchange.xml deleted file mode 100644 index bfbd56cd5c..0000000000 --- a/reference/ui/ui/controls/colorbutton/onchange.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - UI\Controls\ColorButton::onChange - Gestor de cambio - - - - &reftitle.description; - - protected UI\Controls\ColorButton::onChange - - - - Debe ser ejecutado cuando el color seleccionado cambia - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/ui/ui/controls/colorbutton/setcolor.xml b/reference/ui/ui/controls/colorbutton/setcolor.xml deleted file mode 100644 index c8dd6cc8f9..0000000000 --- a/reference/ui/ui/controls/colorbutton/setcolor.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - UI\Controls\ColorButton::setColor - Establece el color - - - - &reftitle.description; - - public UI\Controls\ColorButton::setColor - UI\Draw\Colorcolor - - - public UI\Controls\ColorButton::setColor - intcolor - - - Establece el color actualmente seleccionado - - - - - - &reftitle.parameters; - - - color - - - El nuevo color - - - - - - - - - diff --git a/reference/ui/ui/controls/combo/append.xml b/reference/ui/ui/controls/combo/append.xml deleted file mode 100644 index 9c30280e63..0000000000 --- a/reference/ui/ui/controls/combo/append.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Controls\Combo::append - Añade una opción - - - - &reftitle.description; - - public UI\Controls\Combo::append - stringtext - - - Añade una opción a esta lista desplegable. - - - - - - &reftitle.parameters; - - - text - - - El texto para la nueva opción. - - - - - - - - - diff --git a/reference/ui/ui/controls/combo/getselected.xml b/reference/ui/ui/controls/combo/getselected.xml deleted file mode 100644 index 24da79bd4d..0000000000 --- a/reference/ui/ui/controls/combo/getselected.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\Combo::getSelected - Devuelve la opción seleccionada - - - - &reftitle.description; - - public intUI\Controls\Combo::getSelected - - - - Devuelve el índice de la opción seleccionada en este cuadro de selección. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/combo/onselected.xml b/reference/ui/ui/controls/combo/onselected.xml deleted file mode 100644 index 4959c298a6..0000000000 --- a/reference/ui/ui/controls/combo/onselected.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\Combo::onSelected - Gestor de selección - - - - &reftitle.description; - - protected UI\Controls\Combo::onSelected - - - - Debe ejecutarse cuando se selecciona una opción en este cuadro de selección. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/combo/setselected.xml b/reference/ui/ui/controls/combo/setselected.xml deleted file mode 100644 index 5eac478375..0000000000 --- a/reference/ui/ui/controls/combo/setselected.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Combo::setSelected - Establece la opción seleccionada - - - - &reftitle.description; - - public UI\Controls\Combo::setSelected - intindex - - - Define la opción actualmente seleccionada en este cuadro de selección. - - - - - - &reftitle.parameters; - - - index - - - Índice de la opción que debe seleccionarse - - - - - - - - - - diff --git a/reference/ui/ui/controls/editablecombo/append.xml b/reference/ui/ui/controls/editablecombo/append.xml deleted file mode 100644 index cc1b7e53ae..0000000000 --- a/reference/ui/ui/controls/editablecombo/append.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\EditableCombo::append - Añade una opción - - - - &reftitle.description; - - public UI\Controls\EditableCombo::append - stringtext - - - Añade una nueva opción a este cuadro de selección editable - - - - - - &reftitle.parameters; - - - text - - - El texto de la nueva opción - - - - - - - - - - diff --git a/reference/ui/ui/controls/editablecombo/gettext.xml b/reference/ui/ui/controls/editablecombo/gettext.xml deleted file mode 100644 index 0896b1c009..0000000000 --- a/reference/ui/ui/controls/editablecombo/gettext.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\EditableCombo::getText - Devuelve el texto - - - - &reftitle.description; - - public stringUI\Controls\EditableCombo::getText - - - - Devuelve el valor de la opción seleccionada actualmente en este cuadro de selección editable - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/editablecombo/onchange.xml b/reference/ui/ui/controls/editablecombo/onchange.xml deleted file mode 100644 index 651c7cb1a6..0000000000 --- a/reference/ui/ui/controls/editablecombo/onchange.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - UI\Controls\EditableCombo::onChange - Gestor de cambios - - - - &reftitle.description; - - protected UI\Controls\EditableCombo::onChange - - - - Debe ejecutarse cuando cambia el valor de este cuadro de selección editable - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/ui/ui/controls/editablecombo/settext.xml b/reference/ui/ui/controls/editablecombo/settext.xml deleted file mode 100644 index 0f007e0558..0000000000 --- a/reference/ui/ui/controls/editablecombo/settext.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\EditableCombo::setText - Define el texto - - - - &reftitle.description; - - public UI\Controls\EditableCombo::setText - stringtext - - - Define el texto de la opción seleccionada actualmente en este cuadro de selección editable - - - - - - &reftitle.parameters; - - - text - - - El nuevo texto - - - - - - - - - - diff --git a/reference/ui/ui/controls/entry/construct.xml b/reference/ui/ui/controls/entry/construct.xml deleted file mode 100644 index 6245b3e028..0000000000 --- a/reference/ui/ui/controls/entry/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Controls\Entry::__construct - Construye una nueva entrada - - - - &reftitle.description; - - public UI\Controls\Entry::__construct - inttypeUI\Controls\Entry::Normal - - - Crea una nueva entrada del tipo dado - - - - - - &reftitle.parameters; - - - type - - - Entry::Normal, Entry::Password, o Entry::Search - - - - - - - - - diff --git a/reference/ui/ui/controls/entry/gettext.xml b/reference/ui/ui/controls/entry/gettext.xml deleted file mode 100644 index d7dd04473f..0000000000 --- a/reference/ui/ui/controls/entry/gettext.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Controls\Entry::getText - Devuelve el texto - - - - &reftitle.description; - - public stringUI\Controls\Entry::getText - - - - Devuelve el texto actual de esta entrada - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El texto actual - - - - - - - diff --git a/reference/ui/ui/controls/entry/isreadonly.xml b/reference/ui/ui/controls/entry/isreadonly.xml deleted file mode 100644 index 0d206df18e..0000000000 --- a/reference/ui/ui/controls/entry/isreadonly.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Controls\Entry::isReadOnly - Detecta si la entrada es de sólo lectura - - - - &reftitle.description; - - public boolUI\Controls\Entry::isReadOnly - - - - Detecta si esta entrada es de sólo lectura - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/controls/entry/onchange.xml b/reference/ui/ui/controls/entry/onchange.xml deleted file mode 100644 index 9639c58256..0000000000 --- a/reference/ui/ui/controls/entry/onchange.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - UI\Controls\Entry::onChange - Gestor de cambios - - - - &reftitle.description; - - protected UI\Controls\Entry::onChange - - - - Debe ejecutarse cuando cambia el texto de esta entrada - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/ui/ui/controls/entry/setreadonly.xml b/reference/ui/ui/controls/entry/setreadonly.xml deleted file mode 100644 index 3ef3aa2e04..0000000000 --- a/reference/ui/ui/controls/entry/setreadonly.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Entry::setReadOnly - Define si la entrada es de sólo lectura - - - - &reftitle.description; - - public UI\Controls\Entry::setReadOnly - boolreadOnly - - - Activa o desactiva el modo de sólo lectura para esta entrada - - - - - - &reftitle.parameters; - - - readOnly - - - - - - - - - - - - - diff --git a/reference/ui/ui/controls/entry/settext.xml b/reference/ui/ui/controls/entry/settext.xml deleted file mode 100644 index d72535fb01..0000000000 --- a/reference/ui/ui/controls/entry/settext.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Entry::setText - Define el texto - - - - &reftitle.description; - - public UI\Controls\Entry::setText - stringtext - - - Define el texto de esta entrada - - - - - - &reftitle.parameters; - - - text - - - El nuevo texto - - - - - - - - - - diff --git a/reference/ui/ui/controls/form/append.xml b/reference/ui/ui/controls/form/append.xml deleted file mode 100644 index 7be3ebc5db..0000000000 --- a/reference/ui/ui/controls/form/append.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - UI\Controls\Form::append - Añade un control - - - - &reftitle.description; - - public intUI\Controls\Form::append - stringlabel - UI\Controlcontrol - boolstretchy&false; - - - Añade el control al formulario y define la etiqueta - - - - - - &reftitle.parameters; - - - label - - - El texto de la etiqueta - - - - - control - - - Un control - - - - - stretchy - - - Debe establecerse en true para estirar el control - - - - - - - - &reftitle.returnvalues; - - Devuelve el índice del control añadido, puede ser 0 - - - - - - - diff --git a/reference/ui/ui/controls/form/delete.xml b/reference/ui/ui/controls/form/delete.xml deleted file mode 100644 index 7173fb8a25..0000000000 --- a/reference/ui/ui/controls/form/delete.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - UI\Controls\Form::delete - Suprime un control - - - - &reftitle.description; - - public boolUI\Controls\Form::delete - intindex - - - Suprime el control en el índice dado en este formulario - - - - - &reftitle.parameters; - - - index - - - El índice del control que se va a eliminar - - - - - - - - &reftitle.returnvalues; - - Indicación de éxito - - - - - - - diff --git a/reference/ui/ui/controls/form/ispadded.xml b/reference/ui/ui/controls/form/ispadded.xml deleted file mode 100644 index 9197993909..0000000000 --- a/reference/ui/ui/controls/form/ispadded.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\Form::isPadded - Detección de relleno - - - - &reftitle.description; - - public boolUI\Controls\Form::isPadded - - - - Detecta si el relleno está activado en este formulario - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/form/setpadded.xml b/reference/ui/ui/controls/form/setpadded.xml deleted file mode 100644 index 8584e41320..0000000000 --- a/reference/ui/ui/controls/form/setpadded.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Form::setPadded - Define el relleno - - - - &reftitle.description; - - public UI\Controls\Form::setPadded - boolpadded - - - Define si el relleno está activado o desactivado en este formulario - - - - - - &reftitle.parameters; - - - padded - - - - - - - - - - - - - diff --git a/reference/ui/ui/controls/grid/append.xml b/reference/ui/ui/controls/grid/append.xml deleted file mode 100644 index 61f6bd9950..0000000000 --- a/reference/ui/ui/controls/grid/append.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - UI\Controls\Grid::append - Añade un control - - - - &reftitle.description; - - public UI\Controls\Grid::append - UI\Controlcontrol - intleft - inttop - intxspan - intyspan - boolhexpand - inthalign - boolvexpand - intvalign - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - control - - - El control a añadir - - - - - left - - - - - - - - top - - - - - - - - xspan - - - - - - - - yspan - - - - - - - - hexpand - - - - - - - - halign - - - - - - - - vexpand - - - - - - - - valign - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/controls/grid/ispadded.xml b/reference/ui/ui/controls/grid/ispadded.xml deleted file mode 100644 index 2cd67b1f71..0000000000 --- a/reference/ui/ui/controls/grid/ispadded.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\Grid::isPadded - Detección de relleno - - - - &reftitle.description; - - public boolUI\Controls\Grid::isPadded - - - - Detecta si el relleno está activado en esta cuadrícula - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/grid/setpadded.xml b/reference/ui/ui/controls/grid/setpadded.xml deleted file mode 100644 index 92a3408a91..0000000000 --- a/reference/ui/ui/controls/grid/setpadded.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Grid::setPadded - Define el relleno - - - - &reftitle.description; - - public UI\Controls\Grid::setPadded - boolpadding - - - Define si el relleno está activado o no en esta cuadrícula - - - - - - &reftitle.parameters; - - - padding - - - - - - - - - - - - - diff --git a/reference/ui/ui/controls/group/append.xml b/reference/ui/ui/controls/group/append.xml deleted file mode 100644 index e64985ee9d..0000000000 --- a/reference/ui/ui/controls/group/append.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Group::append - Añade un control - - - - &reftitle.description; - - public UI\Controls\Group::append - UI\Controlcontrol - - - Añade un control a este grupo - - - - - - &reftitle.parameters; - - - control - - - El control que debe añadirse - - - - - - - - - - diff --git a/reference/ui/ui/controls/group/construct.xml b/reference/ui/ui/controls/group/construct.xml deleted file mode 100644 index 308d3b9024..0000000000 --- a/reference/ui/ui/controls/group/construct.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - UI\Controls\Group::__construct - Crea un nuevo grupo - - - - &reftitle.description; - - public UI\Controls\Group::__construct - stringtitle - - - Crea un nuevo grupo con el título indicado - - - - - - &reftitle.parameters; - - - title - - - Texto de la etiqueta del título - - - - - - - - - - - diff --git a/reference/ui/ui/controls/group/gettitle.xml b/reference/ui/ui/controls/group/gettitle.xml deleted file mode 100644 index e23568e87e..0000000000 --- a/reference/ui/ui/controls/group/gettitle.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Controls\Group::getTitle - Devuelve el título - - - - &reftitle.description; - - public stringUI\Controls\Group::getTitle - - - - Devuelve el título actual de este grupo - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El título actual - - - - - - - diff --git a/reference/ui/ui/controls/group/hasmargin.xml b/reference/ui/ui/controls/group/hasmargin.xml deleted file mode 100644 index a9e529939f..0000000000 --- a/reference/ui/ui/controls/group/hasmargin.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\Group::hasMargin - Detección de márgenes - - - - &reftitle.description; - - public boolUI\Controls\Group::hasMargin - - - - Detecta si el margen está activado en este grupo - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/group/setmargin.xml b/reference/ui/ui/controls/group/setmargin.xml deleted file mode 100644 index 958913564d..0000000000 --- a/reference/ui/ui/controls/group/setmargin.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Group::setMargin - Define el margen - - - - &reftitle.description; - - public UI\Controls\Group::setMargin - boolmargin - - - Define si el margen está activado o no en este grupo - - - - - - &reftitle.parameters; - - - margin - - - - - - - - - - - - - diff --git a/reference/ui/ui/controls/group/settitle.xml b/reference/ui/ui/controls/group/settitle.xml deleted file mode 100644 index cc81b4a495..0000000000 --- a/reference/ui/ui/controls/group/settitle.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Group::setTitle - Define el título - - - - &reftitle.description; - - public UI\Controls\Group::setTitle - stringtitle - - - Define el título de este grupo - - - - - - &reftitle.parameters; - - - title - - - El texto del nuevo título - - - - - - - - - - diff --git a/reference/ui/ui/controls/label/construct.xml b/reference/ui/ui/controls/label/construct.xml deleted file mode 100644 index 7e05c01a1d..0000000000 --- a/reference/ui/ui/controls/label/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Controls\Label::__construct - Crea una nueva etiqueta - - - - &reftitle.description; - - public UI\Controls\Label::__construct - stringtext - - - Crea una nueva etiqueta - - - - - - &reftitle.parameters; - - - text - - - El texto de esta etiqueta - - - - - - - - - diff --git a/reference/ui/ui/controls/label/gettext.xml b/reference/ui/ui/controls/label/gettext.xml deleted file mode 100644 index 5dd7fabb79..0000000000 --- a/reference/ui/ui/controls/label/gettext.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Label::getText - Devuelve el texto - - - - &reftitle.description; - - public stringUI\Controls\Label::getText - - - - Devuelve el texto actual de esta etiqueta - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/controls/label/settext.xml b/reference/ui/ui/controls/label/settext.xml deleted file mode 100644 index a4069901b9..0000000000 --- a/reference/ui/ui/controls/label/settext.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Controls\Label::setText - Define el texto - - - - &reftitle.description; - - public UI\Controls\Label::setText - stringtext - - - Define el texto de esta etiqueta - - - - - - &reftitle.parameters; - - - text - - - El nuevo texto - - - - - - - - - diff --git a/reference/ui/ui/controls/multilineentry/append.xml b/reference/ui/ui/controls/multilineentry/append.xml deleted file mode 100644 index dbc008c71a..0000000000 --- a/reference/ui/ui/controls/multilineentry/append.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\MultilineEntry::append - Añadir un texto - - - - &reftitle.description; - - public UI\Controls\MultilineEntry::append - stringtext - - - Añade el texto dado al texto de esta entrada multilínea - - - - - - &reftitle.parameters; - - - text - - - El texto a añadir - - - - - - - - - - diff --git a/reference/ui/ui/controls/multilineentry/construct.xml b/reference/ui/ui/controls/multilineentry/construct.xml deleted file mode 100644 index 943d320dae..0000000000 --- a/reference/ui/ui/controls/multilineentry/construct.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - UI\Controls\MultilineEntry::__construct - Crea una nueva entrada multilínea - - - - &reftitle.description; - - public UI\Controls\MultilineEntry::__construct - inttype - - - Crea una nueva entrada multilínea del tipo dado - - - - - - &reftitle.parameters; - - - type - - - MultilineEntry::Wrap o MultilineEntry::NoWrap - - - - - - - - - - - diff --git a/reference/ui/ui/controls/multilineentry/gettext.xml b/reference/ui/ui/controls/multilineentry/gettext.xml deleted file mode 100644 index 0ea7d558c6..0000000000 --- a/reference/ui/ui/controls/multilineentry/gettext.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\MultilineEntry::getText - Devuelve el texto - - - - &reftitle.description; - - public stringUI\Controls\MultilineEntry::getText - - - - Devuelve el texto de esta entrada multilínea - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/multilineentry/isreadonly.xml b/reference/ui/ui/controls/multilineentry/isreadonly.xml deleted file mode 100644 index 735beeaad3..0000000000 --- a/reference/ui/ui/controls/multilineentry/isreadonly.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\MultilineEntry::isReadOnly - Devuelve si esta entrada multilínea es de sólo lectura - - - - &reftitle.description; - - public boolUI\Controls\MultilineEntry::isReadOnly - - - - Detecta si esta entrada multilínea es de sólo lectura - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/multilineentry/onchange.xml b/reference/ui/ui/controls/multilineentry/onchange.xml deleted file mode 100644 index c88a4e8cbc..0000000000 --- a/reference/ui/ui/controls/multilineentry/onchange.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - UI\Controls\MultilineEntry::onChange - Gestor de cambios - - - - &reftitle.description; - - protected UI\Controls\MultilineEntry::onChange - - - - Debe ejecutarse cuando se modifica el texto de esta entrada multilínea - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/ui/ui/controls/multilineentry/setreadonly.xml b/reference/ui/ui/controls/multilineentry/setreadonly.xml deleted file mode 100644 index 058c6623fe..0000000000 --- a/reference/ui/ui/controls/multilineentry/setreadonly.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\MultilineEntry::setReadOnly - Define si esta entrada multilínea es de sólo lectura - - - - &reftitle.description; - - public UI\Controls\MultilineEntry::setReadOnly - boolreadOnly - - - Define si se activa o no el modo de sólo lectura en esta entrada multilínea. - - - - - - &reftitle.parameters; - - - readOnly - - - - - - - - - - - - - diff --git a/reference/ui/ui/controls/multilineentry/settext.xml b/reference/ui/ui/controls/multilineentry/settext.xml deleted file mode 100644 index 2cbc79a383..0000000000 --- a/reference/ui/ui/controls/multilineentry/settext.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Controls\MultilineEntry::setText - Define el texto - - - - &reftitle.description; - - public UI\Controls\MultilineEntry::setText - stringtext - - - Define el texto de esta entrada multilínea - - - - - - &reftitle.parameters; - - - text - - - Le nouveau texte - - - - - - - - - diff --git a/reference/ui/ui/controls/picker/construct.xml b/reference/ui/ui/controls/picker/construct.xml deleted file mode 100644 index 48ece55d0c..0000000000 --- a/reference/ui/ui/controls/picker/construct.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - UI\Controls\Picker::__construct - Crea un nuevo selector - - - - &reftitle.description; - - public UI\Controls\Picker::__construct - inttypeUI\Controls\Picker::Date - - - Crea un nuevo selector del tipo dado - - - - - - &reftitle.parameters; - - - type - - - Picker::Date, Picker::Time, o Picker::DateTime - - - - - - - - - - - diff --git a/reference/ui/ui/controls/progress/getvalue.xml b/reference/ui/ui/controls/progress/getvalue.xml deleted file mode 100644 index 7886d4a5c5..0000000000 --- a/reference/ui/ui/controls/progress/getvalue.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\Progress::getValue - Devuelve el valor - - - - &reftitle.description; - - public intUI\Controls\Progress::getValue - - - - Devuelve el valor actual de esta barra de progreso - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/progress/setvalue.xml b/reference/ui/ui/controls/progress/setvalue.xml deleted file mode 100644 index 2d3f0ec8cc..0000000000 --- a/reference/ui/ui/controls/progress/setvalue.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Controls\Progress::setValue - Define el valor - - - - &reftitle.description; - - public UI\Controls\Progress::setValue - intvalue - - - Define el valor de esta barra de progreso - - - - - - &reftitle.parameters; - - - value - - - Un número entero entre 0 y 100 (ambos inclusive) - - - - - - - - - diff --git a/reference/ui/ui/controls/radio/append.xml b/reference/ui/ui/controls/radio/append.xml deleted file mode 100644 index 2825f79309..0000000000 --- a/reference/ui/ui/controls/radio/append.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Radio::append - Añade una opción - - - - &reftitle.description; - - public UI\Controls\Radio::append - stringtext - - - Añade una nueva opción a esta radio - - - - - - &reftitle.parameters; - - - text - - - El texto (etiqueta) de la opción - - - - - - - - - - diff --git a/reference/ui/ui/controls/radio/getselected.xml b/reference/ui/ui/controls/radio/getselected.xml deleted file mode 100644 index f5a653cb45..0000000000 --- a/reference/ui/ui/controls/radio/getselected.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\Radio::getSelected - Devuelve la opción seleccionada - - - - &reftitle.description; - - public intUI\Controls\Radio::getSelected - - - - Devuelve el índice de la opción seleccionada actualmente en esta radio - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/radio/onselected.xml b/reference/ui/ui/controls/radio/onselected.xml deleted file mode 100644 index 2fa380ab78..0000000000 --- a/reference/ui/ui/controls/radio/onselected.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - UI\Controls\Radio::onSelected - Gestor de selección - - - - &reftitle.description; - - protected UI\Controls\Radio::onSelected - - - - Debe ejecutarse cuando cambia la opción seleccionada en esta radio - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/ui/ui/controls/radio/setselected.xml b/reference/ui/ui/controls/radio/setselected.xml deleted file mode 100644 index 9daea44f5b..0000000000 --- a/reference/ui/ui/controls/radio/setselected.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Radio::setSelected - Establece la opción seleccionada - - - - &reftitle.description; - - public UI\Controls\Radio::setSelected - intindex - - - Define la opción actualmente seleccionada en esta radio - - - - - - &reftitle.parameters; - - - index - - - Índice de la opción que debe seleccionarse - - - - - - - - - - diff --git a/reference/ui/ui/controls/separator/construct.xml b/reference/ui/ui/controls/separator/construct.xml deleted file mode 100644 index 4d4969c83c..0000000000 --- a/reference/ui/ui/controls/separator/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Controls\Separator::__construct - Construye un nuevo separador - - - - &reftitle.description; - - public UI\Controls\Separator::__construct - inttypeUI\Controls\Separator::Horizontal - - - Construye un nuevo separador del tipo dado - - - - - - &reftitle.parameters; - - - type - - - Separator::Horizontal o Separator::Vertical - - - - - - - - - diff --git a/reference/ui/ui/controls/slider/construct.xml b/reference/ui/ui/controls/slider/construct.xml deleted file mode 100644 index 63bb1505bf..0000000000 --- a/reference/ui/ui/controls/slider/construct.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - UI\Controls\Slider::__construct - Construye una nueva diapositiva - - - - &reftitle.description; - - public UI\Controls\Slider::__construct - intmin - intmax - - - Construye una nueva diapositiva con el rango dado - - - - - - &reftitle.parameters; - - - min - - - El valor mínimo autorizado - - - - - max - - - El valor máximo autorizado - - - - - - - - - diff --git a/reference/ui/ui/controls/slider/getvalue.xml b/reference/ui/ui/controls/slider/getvalue.xml deleted file mode 100644 index dfae05194c..0000000000 --- a/reference/ui/ui/controls/slider/getvalue.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\Slider::getValue - Devuelve el valor - - - - &reftitle.description; - - public intUI\Controls\Slider::getValue - - - - Devuelve el valor de este deslizador - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/slider/onchange.xml b/reference/ui/ui/controls/slider/onchange.xml deleted file mode 100644 index e605e6c504..0000000000 --- a/reference/ui/ui/controls/slider/onchange.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\Slider::onChange - Gestor de cambios - - - - &reftitle.description; - - protected UI\Controls\Slider::onChange - - - - Debe ejecutarse cuando cambia el valor de este deslizador - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/slider/setvalue.xml b/reference/ui/ui/controls/slider/setvalue.xml deleted file mode 100644 index bcecc2b5de..0000000000 --- a/reference/ui/ui/controls/slider/setvalue.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - UI\Controls\Slider::setValue - Define el valor - - - - &reftitle.description; - - public UI\Controls\Slider::setValue - intvalue - - - Define el valor de este control deslizante - - - - - - &reftitle.parameters; - - - value - - - El nuevo valor - - - - - - - - - diff --git a/reference/ui/ui/controls/spin/construct.xml b/reference/ui/ui/controls/spin/construct.xml deleted file mode 100644 index 44039898fa..0000000000 --- a/reference/ui/ui/controls/spin/construct.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - UI\Controls\Spin::__construct - Construye una nueva caja de rotación - - - - &reftitle.description; - - public UI\Controls\Spin::__construct - intmin - intmax - - - Construye una nueva caja de rotación con el rango dado - - - - - - &reftitle.parameters; - - - min - - - El valor mínimo autorizado - - - - - max - - - El valor máximo autorizado - - - - - - - - - - - diff --git a/reference/ui/ui/controls/spin/getvalue.xml b/reference/ui/ui/controls/spin/getvalue.xml deleted file mode 100644 index 68d8a01558..0000000000 --- a/reference/ui/ui/controls/spin/getvalue.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - UI\Controls\Spin::getValue - Devuelve el valor - - - - &reftitle.description; - - public intUI\Controls\Spin::getValue - - - - Devuelve el valor de esta casilla de rotación - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - diff --git a/reference/ui/ui/controls/spin/onchange.xml b/reference/ui/ui/controls/spin/onchange.xml deleted file mode 100644 index a2d4cb433c..0000000000 --- a/reference/ui/ui/controls/spin/onchange.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - UI\Controls\Spin::onChange - Gestor de cambios - - - - &reftitle.description; - - protected UI\Controls\Spin::onChange - - - - Debe ejecutarse cuando cambia el valor de esta casilla de rotación - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/controls/spin/setvalue.xml b/reference/ui/ui/controls/spin/setvalue.xml deleted file mode 100644 index 8b2d1e92fd..0000000000 --- a/reference/ui/ui/controls/spin/setvalue.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Controls\Spin::setValue - Define el valor - - - - &reftitle.description; - - public UI\Controls\Spin::setValue - intvalue - - - Define el valor de esta casilla de rotación - - - - - - &reftitle.parameters; - - - value - - - El nuevo valor - - - - - - - - - - diff --git a/reference/ui/ui/controls/tab/append.xml b/reference/ui/ui/controls/tab/append.xml deleted file mode 100644 index 3a5cd850f7..0000000000 --- a/reference/ui/ui/controls/tab/append.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - UI\Controls\Tab::append - Añadir una página - - - - &reftitle.description; - - public intUI\Controls\Tab::append - stringname - UI\Controlcontrol - - - Añade una nueva página a esta pestaña - - - - - - &reftitle.parameters; - - - name - - - El nombre de la nueva página - - - - - control - - - Control de la nueva página - - - - - - - - &reftitle.returnvalues; - - Devuelve el índice del control añadido, puede ser 0 - - - - - - - diff --git a/reference/ui/ui/controls/tab/delete.xml b/reference/ui/ui/controls/tab/delete.xml deleted file mode 100644 index 3f6a99a361..0000000000 --- a/reference/ui/ui/controls/tab/delete.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - UI\Controls\Tab::delete - Elimina una página - - - - &reftitle.description; - - public boolUI\Controls\Tab::delete - intindex - - - Elimina la página seleccionada de esta ficha - - - - - - &reftitle.parameters; - - - index - - - El índice de la página que se va a eliminar - - - - - - - - &reftitle.returnvalues; - - Indicación de éxito - - - - - - diff --git a/reference/ui/ui/controls/tab/hasmargin.xml b/reference/ui/ui/controls/tab/hasmargin.xml deleted file mode 100644 index b4ef20fc9a..0000000000 --- a/reference/ui/ui/controls/tab/hasmargin.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - UI\Controls\Tab::hasMargin - Detección de márgenes - - - - &reftitle.description; - - public boolUI\Controls\Tab::hasMargin - intpage - - - Detecta si el margen está activado en esta página - - - - - &reftitle.parameters; - - - page - - - El índice de páginas - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/controls/tab/insertat.xml b/reference/ui/ui/controls/tab/insertat.xml deleted file mode 100644 index a0dc130842..0000000000 --- a/reference/ui/ui/controls/tab/insertat.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - UI\Controls\Tab::insertAt - Inserta una página - - - - &reftitle.description; - - public UI\Controls\Tab::insertAt - stringname - intpage - UI\Controlcontrol - - - Inserta una nueva página en esta pestaña - - - - - - &reftitle.parameters; - - - name - - - El nombre de la nueva página - - - - - page - - - El índice para insertar antes - - - - - control - - - Control de la nueva página - - - - - - - - - diff --git a/reference/ui/ui/controls/tab/pages.xml b/reference/ui/ui/controls/tab/pages.xml deleted file mode 100644 index 14a619cc95..0000000000 --- a/reference/ui/ui/controls/tab/pages.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Controls\Tab::pages - Número de páginas - - - - &reftitle.description; - - public intUI\Controls\Tab::pages - - - - Devuelve el número de páginas de esta ficha - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El número de páginas de esta ficha - - - - - - - diff --git a/reference/ui/ui/controls/tab/setmargin.xml b/reference/ui/ui/controls/tab/setmargin.xml deleted file mode 100644 index 7d39a0e14b..0000000000 --- a/reference/ui/ui/controls/tab/setmargin.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - UI\Controls\Tab::setMargin - Define el margen - - - - &reftitle.description; - - public UI\Controls\Tab::setMargin - intpage - boolmargin - - - Define si se activa o no el margen en la página seleccionada. - - - - - - &reftitle.parameters; - - - page - - - La página a seleccionar - - - - - margin - - - Cambio de margen - - - - - - - - - diff --git a/reference/ui/ui/draw/brush.gradient/addstop.xml b/reference/ui/ui/draw/brush.gradient/addstop.xml deleted file mode 100644 index 51b310a111..0000000000 --- a/reference/ui/ui/draw/brush.gradient/addstop.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - UI\Draw\Brush\Gradient::addStop - Dejar de manipular - - - - &reftitle.description; - - public intUI\Draw\Brush\Gradient::addStop - floatposition - UI\Draw\Colorcolor - - - public intUI\Draw\Brush\Gradient::addStop - floatposition - intcolor - - - Añade un tope en la posición dada con el color dado - - - - - - &reftitle.parameters; - - - position - - - La posición para la nueva parada - - - - - color - - - El color para la nueva parada puede ser un objeto UI\Draw\Color o un entero RRGGBBAA. - - - - - - - - &reftitle.returnvalues; - - Número total de paradas - - - - - - - diff --git a/reference/ui/ui/draw/brush.gradient/delstop.xml b/reference/ui/ui/draw/brush.gradient/delstop.xml deleted file mode 100644 index c59c71bdea..0000000000 --- a/reference/ui/ui/draw/brush.gradient/delstop.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - UI\Draw\Brush\Gradient::delStop - Dejar de manipular - - - - &reftitle.description; - - public intUI\Draw\Brush\Gradient::delStop - intindex - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - index - - - - - - - - - - - &reftitle.returnvalues; - - Número total de paradas - - - - - - - diff --git a/reference/ui/ui/draw/brush.gradient/setstop.xml b/reference/ui/ui/draw/brush.gradient/setstop.xml deleted file mode 100644 index 42f6329876..0000000000 --- a/reference/ui/ui/draw/brush.gradient/setstop.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - UI\Draw\Brush\Gradient::setStop - Dejar de manipular - - - - &reftitle.description; - - public boolUI\Draw\Brush\Gradient::setStop - intindex - floatposition - UI\Draw\Colorcolor - - - public boolUI\Draw\Brush\Gradient::setStop - intindex - floatposition - intcolor - - - - - - - - - &reftitle.parameters; - - - index - - - El índice de la parada que debe definirse - - - - - position - - - Posición de parada - - - - - color - - - El color del tope puede ser un objeto UI\Draw\Color o un entero RRGGBBAA. - - - - - - - - &reftitle.returnvalues; - - Indicación de éxito - - - - - - - diff --git a/reference/ui/ui/draw/brush.lineargradient/construct.xml b/reference/ui/ui/draw/brush.lineargradient/construct.xml deleted file mode 100644 index 6160503632..0000000000 --- a/reference/ui/ui/draw/brush.lineargradient/construct.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - UI\Draw\Brush\LinearGradient::__construct - Construye un gradiente lineal - - - - &reftitle.description; - - public UI\Draw\Brush\LinearGradient::__construct - UI\Pointstart - UI\Pointend - - - Construye un nuevo gradiente lineal (linear gradient) - - - - - - &reftitle.parameters; - - - start - - - - - - - - end - - - - - - - - - - - - - - - - diff --git a/reference/ui/ui/draw/brush.radialgradient/construct.xml b/reference/ui/ui/draw/brush.radialgradient/construct.xml deleted file mode 100644 index ebf4cca3cc..0000000000 --- a/reference/ui/ui/draw/brush.radialgradient/construct.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - UI\Draw\Brush\RadialGradient::__construct - Construye un gradiente radial - - - - &reftitle.description; - - public UI\Draw\Brush\RadialGradient::__construct - UI\Pointstart - UI\Pointouter - floatradius - - - Crea un nuevo degradado radial (radial gradient) - - - - - - &reftitle.parameters; - - - start - - - - - - - - outer - - - - - - - - radius - - - - - - - - - - - - - - - - diff --git a/reference/ui/ui/draw/brush/construct.xml b/reference/ui/ui/draw/brush/construct.xml deleted file mode 100644 index c8119df558..0000000000 --- a/reference/ui/ui/draw/brush/construct.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - UI\Draw\Brush::__construct - Crea un nuevo pincel - - - - &reftitle.description; - - public UI\Draw\Brush::__construct - UI\Draw\Colorcolor - - - public UI\Draw\Brush::__construct - intcolor - - - Construye un pincel sólido utilizando el color dado - - - - - - &reftitle.parameters; - - - color - - - Puede ser un objeto UI\Draw\Color o un entero RRGGBBAA - - - - - - - - - diff --git a/reference/ui/ui/draw/brush/getcolor.xml b/reference/ui/ui/draw/brush/getcolor.xml deleted file mode 100644 index 6de2a71676..0000000000 --- a/reference/ui/ui/draw/brush/getcolor.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Brush::getColor - Devuelve el color - - - - &reftitle.description; - - public UI\Draw\ColorUI\Draw\Brush::getColor - - - - Devuelve un objeto UI\Draw\Color para este pincel - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El color actual del pincel - - - - - - - diff --git a/reference/ui/ui/draw/brush/setcolor.xml b/reference/ui/ui/draw/brush/setcolor.xml deleted file mode 100644 index 21b08bcc40..0000000000 --- a/reference/ui/ui/draw/brush/setcolor.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - UI\Draw\Brush::setColor - Define el color - - - - &reftitle.description; - - public voidUI\Draw\Brush::setColor - UI\Draw\Colorcolor - - - public voidUI\Draw\Brush::setColor - intcolor - - - Establece el color de este pincel al color suministrado - - - - - - &reftitle.parameters; - - - color - - - Puede ser un objeto UI\Draw\Color o un entero RRGGBBAA - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/color/construct.xml b/reference/ui/ui/draw/color/construct.xml deleted file mode 100644 index 44b268a246..0000000000 --- a/reference/ui/ui/draw/color/construct.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - UI\Draw\Color::__construct - Construye un nuevo color - - - - &reftitle.description; - - public UI\Draw\Color::__construct - UI\Draw\Colorcolor - - - public UI\Draw\Color::__construct - intcolor - - - Construirá un nuevo color - - - - - - &reftitle.parameters; - - - color - - - Puede ser UI\Draw\Color o RRGGBBAA - - - - - - - - - - - - - diff --git a/reference/ui/ui/draw/color/getchannel.xml b/reference/ui/ui/draw/color/getchannel.xml deleted file mode 100644 index 96b4955333..0000000000 --- a/reference/ui/ui/draw/color/getchannel.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - UI\Draw\Color::getChannel - Manipulación de color - - - - &reftitle.description; - - public floatUI\Draw\Color::getChannel - intchannel - - - Recuperará el valor de un canal - - - - - - &reftitle.parameters; - - - channel - - - La identidad del canal constante - - - - - - - - &reftitle.returnvalues; - - El valor actual del canal solicitado - - - - - - - diff --git a/reference/ui/ui/draw/color/setchannel.xml b/reference/ui/ui/draw/color/setchannel.xml deleted file mode 100644 index 837486336b..0000000000 --- a/reference/ui/ui/draw/color/setchannel.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - UI\Draw\Color::setChannel - Manipulación de color - - - - &reftitle.description; - - public voidUI\Draw\Color::setChannel - intchannel - floatvalue - - - Pondrá el canal seleccionado en el valor dado - - - - - - &reftitle.parameters; - - - channel - - - La identidad del canal constante - - - - - value - - - El nuevo valor para el canal seleccionado - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/matrix/invert.xml b/reference/ui/ui/draw/matrix/invert.xml deleted file mode 100644 index dfb1681a6b..0000000000 --- a/reference/ui/ui/draw/matrix/invert.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - - UI\Draw\Matrix::invert - Invertir matriz - - - - &reftitle.description; - - public UI\Draw\Matrix::invert - - - - Invertirá esta matriz - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/draw/matrix/isinvertible.xml b/reference/ui/ui/draw/matrix/isinvertible.xml deleted file mode 100644 index 28c6365599..0000000000 --- a/reference/ui/ui/draw/matrix/isinvertible.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - - UI\Draw\Matrix::isInvertible - Detección de invertido - - - - &reftitle.description; - - public boolUI\Draw\Matrix::isInvertible - - - - Detectará si esta Matriz puede ser invertida - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/draw/matrix/multiply.xml b/reference/ui/ui/draw/matrix/multiply.xml deleted file mode 100644 index f8674a5159..0000000000 --- a/reference/ui/ui/draw/matrix/multiply.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - UI\Draw\Matrix::multiply - Multiplica la matriz - - - - &reftitle.description; - - public UI\Draw\MatrixUI\Draw\Matrix::multiply - UI\Draw\Matrixmatrix - - - Multiplicará esta matriz con la matriz dada - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La nueva matriz - - - - - - diff --git a/reference/ui/ui/draw/matrix/rotate.xml b/reference/ui/ui/draw/matrix/rotate.xml deleted file mode 100644 index fb42d95438..0000000000 --- a/reference/ui/ui/draw/matrix/rotate.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - UI\Draw\Matrix::rotate - Rota la matriz - - - - &reftitle.description; - - public UI\Draw\Matrix::rotate - UI\Pointpoint - floatamount - - - Rotar esta Matriz - - - - - - &reftitle.parameters; - - - point - - - - - - - - amount - - - - - - - - - - - - - diff --git a/reference/ui/ui/draw/matrix/scale.xml b/reference/ui/ui/draw/matrix/scale.xml deleted file mode 100644 index 510665f7a5..0000000000 --- a/reference/ui/ui/draw/matrix/scale.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - UI\Draw\Matrix::scale - Escala la Matriz - - - - &reftitle.description; - - public UI\Draw\Matrix::scale - UI\Pointcenter - UI\Pointpoint - - - Escalará esta Matriz - - - - - - &reftitle.parameters; - - - center - - - - - - - - point - - - - - - - - - - - - - diff --git a/reference/ui/ui/draw/matrix/skew.xml b/reference/ui/ui/draw/matrix/skew.xml deleted file mode 100644 index 9ef4edeb39..0000000000 --- a/reference/ui/ui/draw/matrix/skew.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - UI\Draw\Matrix::skew - Inclina la Matriz - - - - &reftitle.description; - - public UI\Draw\Matrix::skew - UI\Pointpoint - UI\Pointamount - - - Inclinará esta Matriz - - - - - - &reftitle.parameters; - - - point - - - - - - - - amount - - - - - - - - - - - - - diff --git a/reference/ui/ui/draw/matrix/translate.xml b/reference/ui/ui/draw/matrix/translate.xml deleted file mode 100644 index e54f93cdc8..0000000000 --- a/reference/ui/ui/draw/matrix/translate.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - UI\Draw\Matrix::translate - Traduce la matriz - - - - &reftitle.description; - - public UI\Draw\Matrix::translate - UI\Pointpoint - - - Traducirá esta Matriz - - - - - - &reftitle.parameters; - - - point - - - - - - - - - - - - - diff --git a/reference/ui/ui/draw/path/addrectangle.xml b/reference/ui/ui/draw/path/addrectangle.xml deleted file mode 100644 index 7a96a8a27b..0000000000 --- a/reference/ui/ui/draw/path/addrectangle.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - UI\Draw\Path::addRectangle - Dibuja un rectángulo - - - - &reftitle.description; - - public UI\Draw\Path::addRectangle - UI\Pointpoint - UI\Sizesize - - - Trazará la ruta de un rectángulo del tamaño dado, en el punto dado - - - - - - &reftitle.parameters; - - - point - - - El punto de partida de la forma - - - - - size - - - El tamaño del rectángulo - - - - - - - - - diff --git a/reference/ui/ui/draw/path/arcto.xml b/reference/ui/ui/draw/path/arcto.xml deleted file mode 100644 index b78030103a..0000000000 --- a/reference/ui/ui/draw/path/arcto.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - - UI\Draw\Path::arcTo - Dibuja un arco - - - - &reftitle.description; - - public UI\Draw\Path::arcTo - UI\Pointpoint - floatradius - floatangle - floatsweep - floatnegative - - - Trazará la ruta para un arco - - - - - - &reftitle.parameters; - - - point - - - El punto de partida del mapeo - - - - - radius - - - El radio del arco - - - - - angle - - - El ángulo del arco - - - - - sweep - - - El alcance del arco - - - - - negative - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/path/bezierto.xml b/reference/ui/ui/draw/path/bezierto.xml deleted file mode 100644 index d03647b3dd..0000000000 --- a/reference/ui/ui/draw/path/bezierto.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - UI\Draw\Path::bezierTo - Dibujar una curva de Bézier - - - - &reftitle.description; - - public UI\Draw\Path::bezierTo - UI\Pointpoint - floatradius - floatangle - floatsweep - floatnegative - - - Dibujar una curva de Bézier - - - - - - &reftitle.parameters; - - - point - - - El punto de partida de la ruta - - - - - radius - - - El radio de la curva - - - - - angle - - - El ángulo de la curva - - - - - sweep - - - La extensión de la curva - - - - - negative - - - - - - - - - - - - - diff --git a/reference/ui/ui/draw/path/closefigure.xml b/reference/ui/ui/draw/path/closefigure.xml deleted file mode 100644 index d9dabcdd73..0000000000 --- a/reference/ui/ui/draw/path/closefigure.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - - UI\Draw\Path::closeFigure - Cerrar Figura - - - - &reftitle.description; - - public UI\Draw\Path::closeFigure - - - - Cerrará la figura actual - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/draw/path/construct.xml b/reference/ui/ui/draw/path/construct.xml deleted file mode 100644 index 8cab8bccc7..0000000000 --- a/reference/ui/ui/draw/path/construct.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - UI\Draw\Path::__construct - Construye una nueva ruta - - - - &reftitle.description; - - public UI\Draw\Path::__construct - intmodeUI\Draw\Path::Winding - - - Construirá una nueva ruta en el modo dado - - - - - - &reftitle.parameters; - - - mode - - - Path::Winding o Path::Alternate - - - - - - - - - diff --git a/reference/ui/ui/draw/path/end.xml b/reference/ui/ui/draw/path/end.xml deleted file mode 100644 index 6f8b41e32c..0000000000 --- a/reference/ui/ui/draw/path/end.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - - UI\Draw\Path::end - Finalizar Ruta - - - - &reftitle.description; - - public UI\Draw\Path::end - - - - Finalizará esta ruta - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/draw/path/lineto.xml b/reference/ui/ui/draw/path/lineto.xml deleted file mode 100644 index 79d63de334..0000000000 --- a/reference/ui/ui/draw/path/lineto.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - - UI\Draw\Path::lineTo - Dibuja una línea - - - - &reftitle.description; - - public UI\Draw\Path::lineTo - UI\Pointpoint - floatradius - floatangle - floatsweep - floatnegative - - - Trazará la ruta para una línea - - - - - - &reftitle.parameters; - - - point - - - El punto de partida del mapeo - - - - - radius - - - - - - - - angle - - - - - - - - sweep - - - - - - - - negative - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/path/newfigure.xml b/reference/ui/ui/draw/path/newfigure.xml deleted file mode 100644 index 7b691b283f..0000000000 --- a/reference/ui/ui/draw/path/newfigure.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - UI\Draw\Path::newFigure - Dibuja figura - - - - &reftitle.description; - - public UI\Draw\Path::newFigure - UI\Pointpoint - - - Trazará una nueva figura en el punto dado - - - - - - &reftitle.parameters; - - - point - - - El punto de partida del mapeo - - - - - - - - - - diff --git a/reference/ui/ui/draw/path/newfigurewitharc.xml b/reference/ui/ui/draw/path/newfigurewitharc.xml deleted file mode 100644 index 10f7c60684..0000000000 --- a/reference/ui/ui/draw/path/newfigurewitharc.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - - UI\Draw\Path::newFigureWithArc - Dibuja figura con arco - - - - &reftitle.description; - - public UI\Draw\Path::newFigureWithArc - UI\Pointpoint - floatradius - floatangle - floatsweep - floatnegative - - - - - - - - - &reftitle.parameters; - - - point - - - - - - - - radius - - - - - - - - angle - - - - - - - - sweep - - - - - - - - negative - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/pen/clip.xml b/reference/ui/ui/draw/pen/clip.xml deleted file mode 100644 index ed19b18db2..0000000000 --- a/reference/ui/ui/draw/pen/clip.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - UI\Draw\Pen::clip - Cortar un camino - - - - &reftitle.description; - - public UI\Draw\Pen::clip - UI\Draw\Pathpath - - - Corta la ruta dada - - - - - - &reftitle.parameters; - - - path - - - El camino a cortar - - - - - - - - - - diff --git a/reference/ui/ui/draw/pen/fill.xml b/reference/ui/ui/draw/pen/fill.xml deleted file mode 100644 index 695c65611b..0000000000 --- a/reference/ui/ui/draw/pen/fill.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - UI\Draw\Pen::fill - Llena una ruta - - - - &reftitle.description; - - public UI\Draw\Pen::fill - UI\Draw\Pathpath - UI\Draw\Brushwith - - - public UI\Draw\Pen::fill - UI\Draw\Pathpath - UI\Draw\Colorwith - - - public UI\Draw\Pen::fill - UI\Draw\Pathpath - intwith - - - Llenará la ruta dada - - - - - - &reftitle.parameters; - - - path - - - La ruta a llenar - - - - - with - - - El color o el pincel para rellenar - - - - - - - - - - diff --git a/reference/ui/ui/draw/pen/restore.xml b/reference/ui/ui/draw/pen/restore.xml deleted file mode 100644 index b5dd276ac5..0000000000 --- a/reference/ui/ui/draw/pen/restore.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - - UI\Draw\Pen::restore - Restaura - - - - &reftitle.description; - - public UI\Draw\Pen::restore - - - - Restaurará un bolígrafo previamente guardado - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/draw/pen/save.xml b/reference/ui/ui/draw/pen/save.xml deleted file mode 100644 index 6b117851b4..0000000000 --- a/reference/ui/ui/draw/pen/save.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - - UI\Draw\Pen::save - Guarda - - - - &reftitle.description; - - public UI\Draw\Pen::save - - - - Guardará el bolígrafo - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/draw/pen/stroke.xml b/reference/ui/ui/draw/pen/stroke.xml deleted file mode 100644 index cf6c46fd90..0000000000 --- a/reference/ui/ui/draw/pen/stroke.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - - UI\Draw\Pen::stroke - Traza una ruta - - - - &reftitle.description; - - public UI\Draw\Pen::stroke - UI\Draw\Pathpath - UI\Draw\Brushwith - UI\Draw\Strokestroke - - - public UI\Draw\Pen::stroke - UI\Draw\Pathpath - UI\Draw\Colorwith - UI\Draw\Strokestroke - - - public UI\Draw\Pen::stroke - UI\Draw\Pathpath - intwith - UI\Draw\Strokestroke - - - Trazará la ruta dada - - - - - - &reftitle.parameters; - - - path - - - La ruta del trazo - - - - - with - - - El color o el pincel con el que trazar - - - - - stroke - - - La configuración del trazo - - - - - - - - - diff --git a/reference/ui/ui/draw/pen/transform.xml b/reference/ui/ui/draw/pen/transform.xml deleted file mode 100644 index 7673e1911f..0000000000 --- a/reference/ui/ui/draw/pen/transform.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - UI\Draw\Pen::transform - Transformación de la matriz - - - - &reftitle.description; - - public UI\Draw\Pen::transform - UI\Draw\Matrixmatrix - - - Realizará la transformación de la matriz - - - - - - &reftitle.parameters; - - - matrix - - - La matriz a usar - - - - - - - - - diff --git a/reference/ui/ui/draw/pen/write.xml b/reference/ui/ui/draw/pen/write.xml deleted file mode 100644 index 3269d99879..0000000000 --- a/reference/ui/ui/draw/pen/write.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - UI\Draw\Pen::write - Dibuja el texto en el punto - - - - &reftitle.description; - - public UI\Draw\Pen::write - UI\Pointpoint - UI\Draw\Text\Layoutlayout - - - Dibujará la disposición del texto en el punto dado - - - - - - &reftitle.parameters; - - - point - - - El punto a realizar el dibujo - - - - - layout - - - La disposición del texto a dibujar - - - - - - - - - - diff --git a/reference/ui/ui/draw/stroke/construct.xml b/reference/ui/ui/draw/stroke/construct.xml deleted file mode 100644 index 74be5de950..0000000000 --- a/reference/ui/ui/draw/stroke/construct.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - - UI\Draw\Stroke::__construct - Construye un nuevo trazo - - - - &reftitle.description; - - public UI\Draw\Stroke::__construct - intcapUI\Draw\Line\Cap::Flat - intjoinUI\Draw\Line\Join::Miter - floatthickness1 - floatmiterLimit10 - - - Construirá un nuevo trazo - - - - - - &reftitle.parameters; - - - cap - - - UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round, o UI\Draw\Line\Cap::Square - - - - - join - - - UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round, o UI\Draw\Line\Join::Bevel - - - - - thickness - - - El grosor del trazo - - - - - miterLimit - - - Límite de inglete (el valor por defecto es válido para todas las plataformas) - - - - - - - - - - - diff --git a/reference/ui/ui/draw/stroke/getcap.xml b/reference/ui/ui/draw/stroke/getcap.xml deleted file mode 100644 index 269f9372cc..0000000000 --- a/reference/ui/ui/draw/stroke/getcap.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Stroke::getCap - Devuelve el tipo de terminación de línea - - - - &reftitle.description; - - public intUI\Draw\Stroke::getCap - - - - Devuelve el tipo de terminación de este trazo - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round, o UI\Draw\Line\Cap::Square - - - - - - - diff --git a/reference/ui/ui/draw/stroke/getjoin.xml b/reference/ui/ui/draw/stroke/getjoin.xml deleted file mode 100644 index 4a61fa5a78..0000000000 --- a/reference/ui/ui/draw/stroke/getjoin.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - UI\Draw\Stroke::getJoin - Obtiene la unión de línea - - - - &reftitle.description; - - public intUI\Draw\Stroke::getJoin - - - - Recuperaremos el ajuste de la línea de unión de este trazo - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round, o UI\Draw\Line\Join::Bevel - - - - - - - diff --git a/reference/ui/ui/draw/stroke/getmiterlimit.xml b/reference/ui/ui/draw/stroke/getmiterlimit.xml deleted file mode 100644 index 82350ecc4f..0000000000 --- a/reference/ui/ui/draw/stroke/getmiterlimit.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - UI\Draw\Stroke::getMiterLimit - Obtiene el límite de inglete - - - - &reftitle.description; - - public floatUI\Draw\Stroke::getMiterLimit - - - - Recuperará el límite de ingletes de este trazo - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El actual límite de ingletes - - - - - - - diff --git a/reference/ui/ui/draw/stroke/getthickness.xml b/reference/ui/ui/draw/stroke/getthickness.xml deleted file mode 100644 index c387ed1d04..0000000000 --- a/reference/ui/ui/draw/stroke/getthickness.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - UI\Draw\Stroke::getThickness - Obtiene el grosor - - - - &reftitle.description; - - public floatUI\Draw\Stroke::getThickness - - - - Recuperará el grosor de este trazo - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El grosor actual - - - - - - - diff --git a/reference/ui/ui/draw/stroke/setcap.xml b/reference/ui/ui/draw/stroke/setcap.xml deleted file mode 100644 index 78a3ce6d44..0000000000 --- a/reference/ui/ui/draw/stroke/setcap.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Stroke::setCap - Define la terminación de la línea - - - - &reftitle.description; - - public UI\Draw\Stroke::setCap - intcap - - - Define el final de esta línea - - - - - &reftitle.parameters; - - - cap - - - UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round, o UI\Draw\Line\Cap::Square - - - - - - - - - diff --git a/reference/ui/ui/draw/stroke/setjoin.xml b/reference/ui/ui/draw/stroke/setjoin.xml deleted file mode 100644 index 08ae56fab2..0000000000 --- a/reference/ui/ui/draw/stroke/setjoin.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - UI\Draw\Stroke::setJoin - Establece la línea de unión - - - - &reftitle.description; - - public UI\Draw\Stroke::setJoin - intjoin - - - Establecerá la línea de unión para este trazo - - - - - - &reftitle.parameters; - - - join - - - UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round, o UI\Draw\Line\Join::Bevel - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/stroke/setmiterlimit.xml b/reference/ui/ui/draw/stroke/setmiterlimit.xml deleted file mode 100644 index d14e96c36d..0000000000 --- a/reference/ui/ui/draw/stroke/setmiterlimit.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - UI\Draw\Stroke::setMiterLimit - Establece el límite de ingletes - - - - &reftitle.description; - - public UI\Draw\Stroke::setMiterLimit - floatlimit - - - Establece el límite de ingletes para este trazo - - - - - - &reftitle.parameters; - - - limit - - - El nuevo límite - - - - - - - - - - diff --git a/reference/ui/ui/draw/stroke/setthickness.xml b/reference/ui/ui/draw/stroke/setthickness.xml deleted file mode 100644 index 3d33428937..0000000000 --- a/reference/ui/ui/draw/stroke/setthickness.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - UI\Draw\Stroke::setThickness - Establece el grosor - - - - &reftitle.description; - - public UI\Draw\Stroke::setThickness - floatthickness - - - Establecerá el grosor de este trazo - - - - - - &reftitle.parameters; - - - thickness - - - El nuevo grosor - - - - - - - - - - diff --git a/reference/ui/ui/draw/text/font.descriptor/construct.xml b/reference/ui/ui/draw/text/font.descriptor/construct.xml deleted file mode 100644 index 66181dbe84..0000000000 --- a/reference/ui/ui/draw/text/font.descriptor/construct.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - UI\Draw\Text\Font\Descriptor::__construct - Crea un nuevo descriptor de fuente - - - - &reftitle.description; - - public UI\Draw\Text\Font\Descriptor::__construct - stringfamily - floatsize - intweightUI\Draw\Text\Font\Weight::Normal - intitalicUI\Draw\Text\Font\Italic::Normal - intstretchUI\Draw\Text\Font\Stretch::Normal - - - Crea un nuevo descriptor de fuente - - - - - - &reftitle.parameters; - - - family - - - El nombre de una familia de fuentes válida - - - - - size - - - Tamaño preferido - - - - - weight - - - Una constante de UI\Draw\Text\Font\Weight - - - - - italic - - - Una constante de UI\Draw\Text\Font\Italic - - - - - stretch - - - Una constante de UI\Draw\Text\Font\Stretch - - - - - - - - - - - - - diff --git a/reference/ui/ui/draw/text/font.descriptor/getfamily.xml b/reference/ui/ui/draw/text/font.descriptor/getfamily.xml deleted file mode 100644 index 45e65edc5c..0000000000 --- a/reference/ui/ui/draw/text/font.descriptor/getfamily.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Text\Font\Descriptor::getFamily - Devuelve la familia tipográfica - - - - &reftitle.description; - - public stringUI\Draw\Text\Font\Descriptor::getFamily - - - - Devuelve la familia tipográfica solicitado - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/text/font.descriptor/getitalic.xml b/reference/ui/ui/draw/text/font.descriptor/getitalic.xml deleted file mode 100644 index 0c03491151..0000000000 --- a/reference/ui/ui/draw/text/font.descriptor/getitalic.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Text\Font\Descriptor::getItalic - Detección de estilos - - - - &reftitle.description; - - public intUI\Draw\Text\Font\Descriptor::getItalic - - - - Devuelve la constante del parámetro - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/text/font.descriptor/getsize.xml b/reference/ui/ui/draw/text/font.descriptor/getsize.xml deleted file mode 100644 index ae98b06974..0000000000 --- a/reference/ui/ui/draw/text/font.descriptor/getsize.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Text\Font\Descriptor::getSize - Detección de tamaño - - - - &reftitle.description; - - public floatUI\Draw\Text\Font\Descriptor::getSize - - - - Devuelve el tamaño solicitado - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/text/font.descriptor/getstretch.xml b/reference/ui/ui/draw/text/font.descriptor/getstretch.xml deleted file mode 100644 index 50e27b2e22..0000000000 --- a/reference/ui/ui/draw/text/font.descriptor/getstretch.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Text\Font\Descriptor::getStretch - Detección de estilos - - - - &reftitle.description; - - public intUI\Draw\Text\Font\Descriptor::getStretch - - - - Devuelve la escalabilidad solicitada - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/text/font.descriptor/getweight.xml b/reference/ui/ui/draw/text/font.descriptor/getweight.xml deleted file mode 100644 index 39d580aa04..0000000000 --- a/reference/ui/ui/draw/text/font.descriptor/getweight.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Draw\Text\Font\Descriptor::getWeight - Detección de espesor - - - - &reftitle.description; - - public intUI\Draw\Text\Font\Descriptor::getWeight - - - - Devuelve el grosor solicitado - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/text/font/construct.xml b/reference/ui/ui/draw/text/font/construct.xml deleted file mode 100644 index 9fb86baca3..0000000000 --- a/reference/ui/ui/draw/text/font/construct.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - UI\Draw\Text\Font::__construct - Construye una nueva fuente - - - - &reftitle.description; - - public UI\Draw\Text\Font::__construct - UI\Draw\Text\Font\Descriptordescriptor - - - Construirá una nueva fuente usando el descriptor dado - - - - - - &reftitle.parameters; - - - descriptor - - - El descriptor de la fuente - - - - - - - - - diff --git a/reference/ui/ui/draw/text/font/getascent.xml b/reference/ui/ui/draw/text/font/getascent.xml deleted file mode 100644 index 7b1efe5804..0000000000 --- a/reference/ui/ui/draw/text/font/getascent.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - UI\Draw\Text\Font::getAscent - Métricas de la fuente - - - - &reftitle.description; - - public floatUI\Draw\Text\Font::getAscent - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/text/font/getdescent.xml b/reference/ui/ui/draw/text/font/getdescent.xml deleted file mode 100644 index ccecbe772b..0000000000 --- a/reference/ui/ui/draw/text/font/getdescent.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - UI\Draw\Text\Font::getDescent - Métricas de la fuente - - - - &reftitle.description; - - public floatUI\Draw\Text\Font::getDescent - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/text/font/getleading.xml b/reference/ui/ui/draw/text/font/getleading.xml deleted file mode 100644 index 130e202cd6..0000000000 --- a/reference/ui/ui/draw/text/font/getleading.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - UI\Draw\Text\Font::getLeading - Métricas de la fuente - - - - &reftitle.description; - - public floatUI\Draw\Text\Font::getLeading - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/text/font/getunderlineposition.xml b/reference/ui/ui/draw/text/font/getunderlineposition.xml deleted file mode 100644 index fb0363eca2..0000000000 --- a/reference/ui/ui/draw/text/font/getunderlineposition.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - UI\Draw\Text\Font::getUnderlinePosition - Métricas de la fuente - - - - &reftitle.description; - - public floatUI\Draw\Text\Font::getUnderlinePosition - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/text/font/getunderlinethickness.xml b/reference/ui/ui/draw/text/font/getunderlinethickness.xml deleted file mode 100644 index 5ee44fc083..0000000000 --- a/reference/ui/ui/draw/text/font/getunderlinethickness.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - UI\Draw\Text\Font::getUnderlineThickness - Métricas de la fuente - - - - &reftitle.description; - - public floatUI\Draw\Text\Font::getUnderlineThickness - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/draw/text/layout/construct.xml b/reference/ui/ui/draw/text/layout/construct.xml deleted file mode 100644 index 2f6b31cf46..0000000000 --- a/reference/ui/ui/draw/text/layout/construct.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - UI\Draw\Text\Layout::__construct - Construir un nuevo diseño de texto - - - - &reftitle.description; - - public UI\Draw\Text\Layout::__construct - stringtext - UI\Draw\Text\Fontfont - floatwidth - - - Construirá un nuevo diseño de texto - - - - - - &reftitle.parameters; - - - text - - - El texto para el diseño - - - - - font - - - El tipo de letra a utilizar para escribir - - - - - width - - - El ancho del diseño - - - - - - - - - - - diff --git a/reference/ui/ui/draw/text/layout/setcolor.xml b/reference/ui/ui/draw/text/layout/setcolor.xml deleted file mode 100644 index 82a599de32..0000000000 --- a/reference/ui/ui/draw/text/layout/setcolor.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - - UI\Draw\Text\Layout::setColor - Establece el color - - - - &reftitle.description; - - public UI\Draw\Text\Layout::setColor - UI\Draw\Colorcolor - intstart0 - intend - - - public UI\Draw\Text\Layout::setColor - intcolor - intstart0 - intend - - - Establecerá el color para todo o un rango del texto en el diseño - - - - - - &reftitle.parameters; - - - color - - - El color a usar - - - - - start - - - El carácter inicial - - - - - end - - - El carácter final, por defecto el final del string - - - - - - - - - - diff --git a/reference/ui/ui/draw/text/layout/setwidth.xml b/reference/ui/ui/draw/text/layout/setwidth.xml deleted file mode 100644 index e6f7ab531c..0000000000 --- a/reference/ui/ui/draw/text/layout/setwidth.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - UI\Draw\Text\Layout::setWidth - Establece el ancho - - - - &reftitle.description; - - public UI\Draw\Text\Layout::setWidth - floatwidth - - - Establecerá el ancho del diseño del texto - - - - - - &reftitle.parameters; - - - width - - - El nuevo ancho - - - - - - - - - - diff --git a/reference/ui/ui/executor/construct.xml b/reference/ui/ui/executor/construct.xml deleted file mode 100644 index 7835104e22..0000000000 --- a/reference/ui/ui/executor/construct.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - UI\Executor::__construct - Construye un nuevo ejecutor - - - - &reftitle.description; - - public UI\Executor::__construct - - - - public UI\Executor::__construct - intmicroseconds - - - public UI\Executor::__construct - intseconds - intmicroseconds - - - Construye un ejecutor con el intervalo dado, no empezará a ejecutarse hasta que se entre en el bucle principal - - - - - - &reftitle.parameters; - - - seconds - - - El número de segundos entre ejecuciones - - - - - microseconds - - - El número de microsegundos entre ejecuciones - - - - - - - - - - - - - diff --git a/reference/ui/ui/executor/kill.xml b/reference/ui/ui/executor/kill.xml deleted file mode 100644 index 4b40feb888..0000000000 --- a/reference/ui/ui/executor/kill.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Executor::kill - Detener el ejecutor - - - - &reftitle.description; - - public voidUI\Executor::kill - - - - Detiene un ejecutor, el ejecutor no se puede reiniciar - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/executor/onexecute.xml b/reference/ui/ui/executor/onexecute.xml deleted file mode 100644 index 263710d50c..0000000000 --- a/reference/ui/ui/executor/onexecute.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - UI\Executor::onExecute - Función de devolución de llamada - - - - &reftitle.description; - - abstract protected voidUI\Executor::onExecute - - - - Debe ponerse en cola repetidamente para su ejecución en el hilo principal - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/executor/setinterval.xml b/reference/ui/ui/executor/setinterval.xml deleted file mode 100644 index ce84a2d12a..0000000000 --- a/reference/ui/ui/executor/setinterval.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - UI\Executor::setInterval - Manipulación de intervalos - - - - &reftitle.description; - - public boolUI\Executor::setInterval - intmicroseconds - - - public boolUI\Executor::setInterval - intseconds - intmicroseconds - - - Define el nuevo intervalo. Un intervalo de 0 pondrá en pausa el ejecutor hasta que se defina un nuevo intervalo. - - - - - - &reftitle.parameters; - - - seconds - - - - - - - - microseconds - - - - - - - - - - - &reftitle.returnvalues; - - Indicación de éxito - - - - - - - diff --git a/reference/ui/ui/menu/append.xml b/reference/ui/ui/menu/append.xml deleted file mode 100644 index c3962a18f8..0000000000 --- a/reference/ui/ui/menu/append.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - UI\Menu::append - Añade elemento de menú - - - - &reftitle.description; - - public UI\MenuItemUI\Menu::append - stringname - stringtypeUI\MenuItem::class - - - Añadirá un nuevo elemento del menú - - - - - - &reftitle.parameters; - - - name - - - El nombre (texto) del nuevo elemento - - - - - type - - - El tipo para el nuevo elemento - - - - - - - - &reftitle.returnvalues; - - Un objeto construido del tipo dado - - - - - - - diff --git a/reference/ui/ui/menu/appendabout.xml b/reference/ui/ui/menu/appendabout.xml deleted file mode 100644 index a753358bec..0000000000 --- a/reference/ui/ui/menu/appendabout.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - UI\Menu::appendAbout - Añade elemento de menú Acerca de - - - - &reftitle.description; - - public UI\MenuItemUI\Menu::appendAbout - stringtypeUI\MenuItem::class - - - Se añadirá un elemento del menú Acerca de - - - - - - &reftitle.parameters; - - - type - - - El tipo para el nuevo elemento - - - - - - - - &reftitle.returnvalues; - - Un elemento del menú Acerca de construido del tipo dado - - - - - - - diff --git a/reference/ui/ui/menu/appendcheck.xml b/reference/ui/ui/menu/appendcheck.xml deleted file mode 100644 index 2d10f2a6dc..0000000000 --- a/reference/ui/ui/menu/appendcheck.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - UI\Menu::appendCheck - Añade un elemento de menú comprobable - - - - &reftitle.description; - - public UI\MenuItemUI\Menu::appendCheck - stringname - stringtypeUI\MenuItem::class - - - Se añadirá un elemento del menú comprobable - - - - - - &reftitle.parameters; - - - name - - - El nombre (texto) del nuevo elemento - - - - - type - - - El tipo para el nuevo elemento - - - - - - - - &reftitle.returnvalues; - - Un elemento de menú construido y comprobable del tipo dado - - - - - - - diff --git a/reference/ui/ui/menu/appendpreferences.xml b/reference/ui/ui/menu/appendpreferences.xml deleted file mode 100644 index f1e96f413a..0000000000 --- a/reference/ui/ui/menu/appendpreferences.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - UI\Menu::appendPreferences - Añade elemento de menú de preferencias - - - - &reftitle.description; - - public UI\MenuItemUI\Menu::appendPreferences - stringtypeUI\MenuItem::class - - - Se añadirá un elemento del menú de Preferencias - - - - - - &reftitle.parameters; - - - type - - - El tipo para el nuevo elemento - - - - - - - - &reftitle.returnvalues; - - Un elemento de menú de Preferencias construido del tipo dado - - - - - - - diff --git a/reference/ui/ui/menu/appendquit.xml b/reference/ui/ui/menu/appendquit.xml deleted file mode 100644 index 7db1a90d13..0000000000 --- a/reference/ui/ui/menu/appendquit.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - UI\Menu::appendQuit - Añade elemento de menú salir - - - - &reftitle.description; - - public UI\MenuItemUI\Menu::appendQuit - stringtypeUI\MenuItem::class - - - Se añadirá un elemento del menú de salida - - - - - - &reftitle.parameters; - - - type - - - El tipo para el nuevo elemento - - - - - - - - &reftitle.returnvalues; - - Un elemento del menú de salida construido del tipo dado - - - - - - - diff --git a/reference/ui/ui/menu/appendseparator.xml b/reference/ui/ui/menu/appendseparator.xml deleted file mode 100644 index 6474f1375e..0000000000 --- a/reference/ui/ui/menu/appendseparator.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - - UI\Menu::appendSeparator - Añade separador de elementos del menú - - - - &reftitle.description; - - public UI\Menu::appendSeparator - - - - Se añadirá un separador - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/menu/construct.xml b/reference/ui/ui/menu/construct.xml deleted file mode 100644 index a1ae58c04e..0000000000 --- a/reference/ui/ui/menu/construct.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - UI\Menu::__construct - Construye un nuevo menú - - - - &reftitle.description; - - public UI\Menu::__construct - stringname - - - Construirá un nuevo menú - - - - - - &reftitle.parameters; - - - name - - - El nombre (texto) del menú - - - - - - - - - diff --git a/reference/ui/ui/menuitem/disable.xml b/reference/ui/ui/menuitem/disable.xml deleted file mode 100644 index 62011cf3d6..0000000000 --- a/reference/ui/ui/menuitem/disable.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - - UI\MenuItem::disable - Desactiva elemento del menú - - - - &reftitle.description; - - public UI\MenuItem::disable - - - - Desactivará este elemento del menú - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/menuitem/enable.xml b/reference/ui/ui/menuitem/enable.xml deleted file mode 100644 index 7d381a20b4..0000000000 --- a/reference/ui/ui/menuitem/enable.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - - UI\MenuItem::enable - Activa elemento de menú - - - - &reftitle.description; - - public UI\MenuItem::enable - - - - Activará este elemento del menú - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/menuitem/ischecked.xml b/reference/ui/ui/menuitem/ischecked.xml deleted file mode 100644 index f5346fec2d..0000000000 --- a/reference/ui/ui/menuitem/ischecked.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - - UI\MenuItem::isChecked - Detecta Marcado - - - - &reftitle.description; - - public boolUI\MenuItem::isChecked - - - - Detecta si este elemento del menú está marcado - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/menuitem/onclick.xml b/reference/ui/ui/menuitem/onclick.xml deleted file mode 100644 index 6d1fea0f13..0000000000 --- a/reference/ui/ui/menuitem/onclick.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - - UI\MenuItem::onClick - Llamada de retorno On Click - - - - &reftitle.description; - - protected UI\MenuItem::onClick - - - - Se ejecutará cuando se haga clic en este elemento del menú - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - diff --git a/reference/ui/ui/menuitem/setchecked.xml b/reference/ui/ui/menuitem/setchecked.xml deleted file mode 100644 index c353543e85..0000000000 --- a/reference/ui/ui/menuitem/setchecked.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - UI\MenuItem::setChecked - Establece marcado - - - - &reftitle.description; - - public UI\MenuItem::setChecked - boolchecked - - - Establecerá el estado marcado de este elemento del menú - - - - - - &reftitle.parameters; - - - checked - - - El nuevo estado - - - - - - - - - diff --git a/reference/ui/ui/point/at.xml b/reference/ui/ui/point/at.xml deleted file mode 100644 index 7413ef9675..0000000000 --- a/reference/ui/ui/point/at.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - UI\Point::at - Tamaño de coerción - - - - &reftitle.description; - - public static UI\PointUI\Point::at - floatpoint - - - public static UI\PointUI\Point::at - UI\Sizesize - - - Devolverá un objeto de punto UI donde x y y son iguales a los suministrados, ya sea en forma flotante o de tamaño UI. - - - - - - &reftitle.parameters; - - - point - - - El valor de x y y - - - - - size - - - El tamaño a convertir - - - - - - - - &reftitle.returnvalues; - - El punto resultante - - - - - - - diff --git a/reference/ui/ui/point/construct.xml b/reference/ui/ui/point/construct.xml deleted file mode 100644 index 25d9345f13..0000000000 --- a/reference/ui/ui/point/construct.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - UI\Point::__construct - Construye un nuevo punto - - - - &reftitle.description; - - public UI\Point::__construct - floatx - floaty - - - Construye un nuevo punto usando nuevas coordenadas - - - - - &reftitle.parameters; - - - x - - - La nueva coordenada X - - - - - y - - - La nueva coordenada Y - - - - - - - - - diff --git a/reference/ui/ui/point/getx.xml b/reference/ui/ui/point/getx.xml deleted file mode 100644 index 37b51d84d8..0000000000 --- a/reference/ui/ui/point/getx.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - UI\Point::getX - Recupera X - - - - &reftitle.description; - - public floatUI\Point::getX - - - - Recupera la coordenada X - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La coordenada X actual - - - - - - - diff --git a/reference/ui/ui/point/gety.xml b/reference/ui/ui/point/gety.xml deleted file mode 100644 index 4ef7dea478..0000000000 --- a/reference/ui/ui/point/gety.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - UI\Point::getY - Recupera Y - - - - &reftitle.description; - - public floatUI\Point::getY - - - - Recupera la coordenada Y - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La coordenada Y actual - - - - - - - diff --git a/reference/ui/ui/point/setx.xml b/reference/ui/ui/point/setx.xml deleted file mode 100644 index b4e555d50a..0000000000 --- a/reference/ui/ui/point/setx.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - - UI\Point::setX - Establece X - - - - &reftitle.description; - - public UI\Point::setX - floatpoint - - - Establece la coordenada X - - - - - &reftitle.parameters; - - - point - - - La nueva coordenada X - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/point/sety.xml b/reference/ui/ui/point/sety.xml deleted file mode 100644 index 7ef5b58c65..0000000000 --- a/reference/ui/ui/point/sety.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - - UI\Point::setY - Establece Y - - - - &reftitle.description; - - public UI\Point::setY - floatpoint - - - Establece la coordenada Y - - - - - &reftitle.parameters; - - - point - - - La nueva coordenada Y - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/size/construct.xml b/reference/ui/ui/size/construct.xml deleted file mode 100644 index f6337f8721..0000000000 --- a/reference/ui/ui/size/construct.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - - UI\Size::__construct - Construye un nuevo tamaño - - - - &reftitle.description; - - public UI\Size::__construct - floatwidth - floatheight - - - Construye un nuevo tamaño usando un nuevo ancho y alto - - - - - - &reftitle.parameters; - - - width - - - El nuevo ancho - - - - - height - - - El nuevo alto - - - - - - - - - - - - - diff --git a/reference/ui/ui/size/getheight.xml b/reference/ui/ui/size/getheight.xml deleted file mode 100644 index d6e7ff78bd..0000000000 --- a/reference/ui/ui/size/getheight.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - UI\Size::getHeight - Recupera la altura - - - - &reftitle.description; - - public floatUI\Size::getHeight - - - - Recupera la altura - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La altura actual - - - - - diff --git a/reference/ui/ui/size/getwidth.xml b/reference/ui/ui/size/getwidth.xml deleted file mode 100644 index b26e7a4434..0000000000 --- a/reference/ui/ui/size/getwidth.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - UI\Size::getWidth - Recupera el ancho - - - - &reftitle.description; - - public floatUI\Size::getWidth - - - - Recupera el ancho - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El ancho actual - - - - - - - diff --git a/reference/ui/ui/size/of.xml b/reference/ui/ui/size/of.xml deleted file mode 100644 index e8e682989b..0000000000 --- a/reference/ui/ui/size/of.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - UI\Size::of - Punto de coerción - - - - &reftitle.description; - - public static UI\SizeUI\Size::of - floatsize - - - public static UI\SizeUI\Size::of - UI\Pointpoint - - - Devolverá un objeto de tamaño UI en el que el ancho y la altura son iguales a los suministrados, ya sea en forma flotante o en forma de UI. - - - - - - &reftitle.parameters; - - - size - - - El valor de la anchura y la altura - - - - - point - - - El punto a convertir - - - - - - - - &reftitle.returnvalues; - - El tamaño resultante - - - - - - - diff --git a/reference/ui/ui/size/setheight.xml b/reference/ui/ui/size/setheight.xml deleted file mode 100644 index 12eef7530f..0000000000 --- a/reference/ui/ui/size/setheight.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - UI\Size::setHeight - Establece la altura - - - - &reftitle.description; - - public UI\Size::setHeight - floatsize - - - Establece una nueva altura - - - - - - &reftitle.parameters; - - - size - - - La nueva altura - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/size/setwidth.xml b/reference/ui/ui/size/setwidth.xml deleted file mode 100644 index a9cd228a88..0000000000 --- a/reference/ui/ui/size/setwidth.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - UI\Size::setWidth - Establece el ancho - - - - &reftitle.description; - - public UI\Size::setWidth - floatsize - - - Establece un nuevo ancho - - - - - - &reftitle.parameters; - - - size - - - El nuevo ancho - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/window/add.xml b/reference/ui/ui/window/add.xml deleted file mode 100644 index 4c46a40189..0000000000 --- a/reference/ui/ui/window/add.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - UI\Window::add - Añade un control - - - - &reftitle.description; - - public UI\Window::add - UI\Controlcontrol - - - Añadirá un control a esta ventana - - - - - - &reftitle.parameters; - - - control - - - El control a añadir - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/window/construct.xml b/reference/ui/ui/window/construct.xml deleted file mode 100644 index 642b754ec9..0000000000 --- a/reference/ui/ui/window/construct.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - - - UI\Window::__construct - Construye una nueva ventana - - - - &reftitle.description; - - public UI\Window::__construct - stringtitle - Sizesize - boolmenu&false; - - - Construirá una nueva ventana - - - - - - &reftitle.parameters; - - - title - - - El título de la Ventana - - - - - size - - - El tamaño de la Ventana - - - - - menu - - - Interruptor del menú - - - - - - - - - - - - - diff --git a/reference/ui/ui/window/error.xml b/reference/ui/ui/window/error.xml deleted file mode 100644 index e988e43475..0000000000 --- a/reference/ui/ui/window/error.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - UI\Window::error - Mostrar cuadro de error - - - - &reftitle.description; - - public UI\Window::error - stringtitle - stringmsg - - - Mostrará un cuadro de error - - - - - - &reftitle.parameters; - - - title - - - El título del cuadro de error - - - - - msg - - - El mensaje para el cuadro de error - - - - - - - - - - diff --git a/reference/ui/ui/window/getsize.xml b/reference/ui/ui/window/getsize.xml deleted file mode 100644 index 129499d32a..0000000000 --- a/reference/ui/ui/window/getsize.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - UI\Window::getSize - Obtiene el tamaño de la ventana - - - - &reftitle.description; - - public UI\SizeUI\Window::getSize - - - - Devolverá el tamaño de esta ventana - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/window/gettitle.xml b/reference/ui/ui/window/gettitle.xml deleted file mode 100644 index bbee14e6b5..0000000000 --- a/reference/ui/ui/window/gettitle.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - UI\Window::getTitle - Obtiene el título - - - - &reftitle.description; - - public stringUI\Window::getTitle - - - - Recuperará el título de esta Ventana - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/window/hasborders.xml b/reference/ui/ui/window/hasborders.xml deleted file mode 100644 index 6c0b38810d..0000000000 --- a/reference/ui/ui/window/hasborders.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - UI\Window::hasBorders - Detección del Borde - - - - &reftitle.description; - - public boolUI\Window::hasBorders - - - - Detectará si se usan bordes en esta ventana - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/window/hasmargin.xml b/reference/ui/ui/window/hasmargin.xml deleted file mode 100644 index 63b738cec1..0000000000 --- a/reference/ui/ui/window/hasmargin.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - UI\Window::hasMargin - Detección de Margen - - - - &reftitle.description; - - public boolUI\Window::hasMargin - - - - Detectará si se usan márgenes en esta ventana - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/window/isfullscreen.xml b/reference/ui/ui/window/isfullscreen.xml deleted file mode 100644 index 0432c06efa..0000000000 --- a/reference/ui/ui/window/isfullscreen.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - UI\Window::isFullScreen - Detección de pantalla completa - - - - &reftitle.description; - - public boolUI\Window::isFullScreen - - - - Detectará si esta ventana utiliza toda la pantalla - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/window/msg.xml b/reference/ui/ui/window/msg.xml deleted file mode 100644 index d7310cb266..0000000000 --- a/reference/ui/ui/window/msg.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - UI\Window::msg - Mostrar Cuadro de Mensajes - - - - &reftitle.description; - - public UI\Window::msg - stringtitle - stringmsg - - - Mostrará un cuadro de mensajes - - - - - - &reftitle.parameters; - - - title - - - El título del cuadro de mensajes - - - - - msg - - - El mensaje - - - - - - - - - - diff --git a/reference/ui/ui/window/onclosing.xml b/reference/ui/ui/window/onclosing.xml deleted file mode 100644 index 914fa58409..0000000000 --- a/reference/ui/ui/window/onclosing.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - UI\Window::onClosing - Cierre de la devolución de llamada - - - - &reftitle.description; - - protected intUI\Window::onClosing - - - - Debería destruir con agilidad esta ventana - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/window/open.xml b/reference/ui/ui/window/open.xml deleted file mode 100644 index a2b9173fde..0000000000 --- a/reference/ui/ui/window/open.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - UI\Window::open - Abrir Diálogo - - - - &reftitle.description; - - public stringUI\Window::open - - - - Mostrará un diálogo de archivo abierto - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el nombre del archivo seleccionado para su apertura - - - - - - - diff --git a/reference/ui/ui/window/save.xml b/reference/ui/ui/window/save.xml deleted file mode 100644 index dcab9d3e51..0000000000 --- a/reference/ui/ui/window/save.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - UI\Window::save - Guarda Diálogo - - - - &reftitle.description; - - public stringUI\Window::save - - - - Mostrará un diálogo a guardar - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el nombre del archivo seleccionado para ser guardado - - - - - - - diff --git a/reference/ui/ui/window/setborders.xml b/reference/ui/ui/window/setborders.xml deleted file mode 100644 index 957027e49b..0000000000 --- a/reference/ui/ui/window/setborders.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - UI\Window::setBorders - Uso de Bordes - - - - &reftitle.description; - - public UI\Window::setBorders - boolborders - - - Habilitará o deshabilitará el uso de los bordes en esta ventana - - - - - - &reftitle.parameters; - - - borders - - - - - - - - - - - - - diff --git a/reference/ui/ui/window/setfullscreen.xml b/reference/ui/ui/window/setfullscreen.xml deleted file mode 100644 index e67a160ec2..0000000000 --- a/reference/ui/ui/window/setfullscreen.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - - UI\Window::setFullScreen - Uso de la pantalla completa - - - - &reftitle.description; - - public UI\Window::setFullScreen - boolfull - - - Activará o desactivará el uso de la pantalla completa para esta ventana - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - full - - - - - - - - - - - - - diff --git a/reference/ui/ui/window/setmargin.xml b/reference/ui/ui/window/setmargin.xml deleted file mode 100644 index 0a380f4c00..0000000000 --- a/reference/ui/ui/window/setmargin.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - UI\Window::setMargin - Uso del Margen - - - - &reftitle.description; - - public UI\Window::setMargin - boolmargin - - - Habilitará o deshabilitará el uso de los márgenes para esta Ventana - - - - - - &reftitle.parameters; - - - margin - - - - - - - - - - - - - diff --git a/reference/ui/ui/window/setsize.xml b/reference/ui/ui/window/setsize.xml deleted file mode 100644 index 9492317576..0000000000 --- a/reference/ui/ui/window/setsize.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - UI\Window::setSize - Establece Tamaño - - - - &reftitle.description; - - public UI\Window::setSize - UI\Sizesize - - - Establecerá el tamaño de esta ventana - - - - - - &reftitle.parameters; - - - size - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/ui/ui/window/settitle.xml b/reference/ui/ui/window/settitle.xml deleted file mode 100644 index 78b967ab98..0000000000 --- a/reference/ui/ui/window/settitle.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - UI\Window::setTitle - Título de la Vetana - - - - &reftitle.description; - - public UI\Window::setTitle - stringtitle - - - Pondrá el título de esta ventana - - - - - - &reftitle.parameters; - - - title - - - El nuevo título - - - - - - - - - - diff --git a/reference/uopz/book.xml b/reference/uopz/book.xml deleted file mode 100644 index 5630a299ff..0000000000 --- a/reference/uopz/book.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - - Operaciones de usuario para Zend - uopz - - - &reftitle.intro; - - La extensión uopz - User Operations for Zend (N. del T.: operaciones de usuario para Zend) - - expone las funcionalidades del motor Zend, normalmente utilizadas durante - la compilación y la ejecución, para permitir la modificación de las - estructuras internas que representan el código PHP, y para que el código - de usuario interactúe con la VM. - - - uopz soporta las siguientes actividades: - - - Sobrescritura de opcodes incluyendo ZEND_EXIT y ZEND_NEW - Guardado y restauración de funciones y métodos - Renombrado de funciones y métodos - Copiado de funciones y métodos - Eliminación de funciones y métodos - Re-definición de constantes globales y de clase - Eliminación de constantes globales y de clase - Composición y modificación de clases en tiempo de ejecución - - - - Todas las actividades soportadas son compatibles con opcache. - - - - - PECL uopz 6.1.1 no es compatible con Xdebug >= 2.9.4. - Las versiones posteriores de uopz no son compatibles con Xdebug < 2.9.4. - - - - - &reference.uopz.setup; - &reference.uopz.constants; - &reference.uopz.reference; - - - - diff --git a/reference/uopz/configure.xml b/reference/uopz/configure.xml deleted file mode 100644 index bb52951403..0000000000 --- a/reference/uopz/configure.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - -
    - &reftitle.install; - - - Utilice - durante la compilación de PHP. - - - - Los usuarios de Windows deben incluir la biblioteca - php_uopz.dll en el &php.ini; - - -
    - - diff --git a/reference/uopz/constants.xml b/reference/uopz/constants.xml deleted file mode 100644 index f7fa344013..0000000000 --- a/reference/uopz/constants.xml +++ /dev/null @@ -1,315 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - Los siguientes opcodes son definidos como constantes por uopz antes de 5.0.0: - - - - - - ZEND_EXIT - (int) - - - - Invoca exit() y die(); no recibe ningún argumento. - Devuelve &true; para salir, &false; para continuar - - - - - - ZEND_NEW - (int) - - - - Invocado por la construcción de un objeto, recibe el objeto de la clase creada como - único argumento - - - - - - ZEND_THROW - (int) - - - - Invocado por la estructura throw, recibe la excepción de la clase emitida como único argumento - - - - - - ZEND_FETCH_CLASS - (int) - - - - Invocado durante una composición, recibe la clase, el nombre de la clase recuperada como único argumento - - - - - - ZEND_ADD_TRAIT - (int) - - - - Invocado durante una composición, recibe la clase en la cual el trait será añadido, como primer - argumento, y el nombre del trait como segundo argumento - - - - - - ZEND_ADD_INTERFACE - (int) - - - - Invocado durante una composición, recibe la clase en la cual la interfaz será añadida como primer - argumento, y el nombre de la interfaz como segundo argumento - - - - - - ZEND_INSTANCEOF - (int) - - - - Invocado por el operador instanceof, recibe el objeto a verificar como primer argumento, - y el nombre de la clase a la que pertenece el objeto como segundo argumento - - - - - - - Las siguientes constantes controlan el comportamiento del VM después de que un gestor usuario - sea llamado; sea extremadamente cuidadoso! - Estas constantes son eliminadas a partir de uopz 5.0.0. - - - - - - ZEND_USER_OPCODE_CONTINUE - (int) - - - - Avance de un opcode, y continúe - - - - - - ZEND_USER_OPCODE_ENTER - (int) - - - - Entrar en un nuevo op_array sin recursión - - - - - - ZEND_USER_OPCODE_LEAVE - (int) - - - - Retorna el op_array llamado en el mismo ejecutor - - - - - - ZEND_USER_OPCODE_DISPATCH - (int) - - - - Despacha el gestor opcode original - - - - - - ZEND_USER_OPCODE_DISPATCH_TO - (int) - - - - Despacha a un gestor específico (o combinado con la constante opcode de ZEND) - - - - - - ZEND_USER_OPCODE_RETURN - (int) - - - - Sale del ejecutor (retorna a la función) - - - - - - - Los siguientes modificadores están registrados como constantes por uopz - - - - - - ZEND_ACC_PUBLIC - (int) - - - - Marca una función como pública, el comportamiento por omisión - - - - - - ZEND_ACC_PROTECTED - (int) - - - - Marca una función como protegida - - - - - - ZEND_ACC_PRIVATE - (int) - - - - Marca una función como privada - - - - - - ZEND_ACC_STATIC - (int) - - - - Marca una función como estática - - - - - - ZEND_ACC_FINAL - (int) - - - - Marca una función como final - - - - - - ZEND_ACC_ABSTRACT - (int) - - - - Marca una función como abstracta - - - - - - ZEND_ACC_CLASS - (int) - - - - Registro ficticio para consistencia, el tipo de entrada de clase por omisión. - Eliminada a partir de uopz 5.0.0. - - - - - - ZEND_ACC_INTERFACE - (int) - - - - Marca la clase como una interfaz. - Eliminada a partir de uopz 5.0.0. - - - - - - ZEND_ACC_TRAIT - (int) - - - - Marca la clase como un trait. - Eliminada a partir de uopz 5.0.0. - - - - - - ZEND_ACC_FETCH - (int) - - - - Utilizado para recuperar solo los flags. - Eliminada a partir de uopz 5.0.0. - - - - - - - - diff --git a/reference/uopz/functions/uopz-add-function.xml b/reference/uopz/functions/uopz-add-function.xml deleted file mode 100644 index f5a0db0f2e..0000000000 --- a/reference/uopz/functions/uopz-add-function.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - uopz_add_function - Añade una función o método inexistente - - - - &reftitle.description; - - booluopz_add_function - stringfunction - Closurehandler - intflagsZEND_ACC_PUBLIC - - - booluopz_add_function - stringclass - stringfunction - Closurehandler - intflagsZEND_ACC_PUBLIC - intall&true; - - - Añade una función o método inexistente. - - - - - &reftitle.parameters; - - - class - - - El nombre de la clase. - - - - - function - - - El nombre de la función o método. - - - - - handler - - - La Closure que define la nueva función o método. - - - - - flags - - - Los flags a definir para la nueva función o método. - - - - - all - - - Si todas las clases que heredan de class serán - también afectadas. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - uopz_add_function lanza una RuntimeException - si la función o método a añadir ya existe. - - - - - &reftitle.examples; - - Uso básico de <function>uopz_add_function</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - uopz_del_function - uopz_set_return - - - - - - diff --git a/reference/uopz/functions/uopz-allow-exit.xml b/reference/uopz/functions/uopz-allow-exit.xml deleted file mode 100644 index 2a312da8df..0000000000 --- a/reference/uopz/functions/uopz-allow-exit.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - uopz_allow_exit - Permite controlar el opcode exit desactivado - - - - &reftitle.description; - - voiduopz_allow_exit - boolallow - - - Por omisión, uopz desactiva el opcode exit, por lo que las llamadas a exit - son prácticamente ignoradas. uopz_allow_exit - permite controlar este comportamiento. - - - - - &reftitle.parameters; - - - allow - - - Permitir o no la ejecución de los opcodes exit. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de <function>uopz_allow_exit</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.notes; - - - OPcache optimiza el código muerto después de una salida incondicional. - - - - - - &reftitle.seealso; - - uopz_get_exit_status - - - - - - diff --git a/reference/uopz/functions/uopz-backup.xml b/reference/uopz/functions/uopz-backup.xml deleted file mode 100644 index 773854fced..0000000000 --- a/reference/uopz/functions/uopz-backup.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - - uopz_backup - Guarda una función - - - - &uopz.warn.removed.function-5-0-0; - - - - &reftitle.description; - - voiduopz_backup - stringfunction - - - voiduopz_backup - stringclass - stringfunction - - - Guarda una función en tiempo de ejecución. - - - - - - &reftitle.parameters; - - - class - - - El nombre de la clase que contiene la función a guardar - - - - - function - - - El nombre de la función - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.examples; - - Ejemplo con <function>uopz_backup</function> - - -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/uopz/functions/uopz-compose.xml b/reference/uopz/functions/uopz-compose.xml deleted file mode 100644 index c28d731037..0000000000 --- a/reference/uopz/functions/uopz-compose.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - - - uopz_compose - Componer una clase - - - - &uopz.warn.removed.function-5-0-0; - - - - &reftitle.description; - - voiduopz_compose - stringname - arrayclasses - arraymethods - arrayproperties - intflags - - - Crea una nueva clase con el nombre especificado, que implementa, extiende o - utiliza todas las clases proporcionadas. - - - - - &reftitle.parameters; - - - name - - - Un nombre de clase válido - - - - - classes - - - Un array de clases, interfaces o nombres de trait - - - - - methods - - - Un array asociativo de métodos; los valores son o bien closures, o bien [modificadores => closure] - - - - - properties - - - Un array asociativo de propiedades, con las claves como nombres, - y los valores como modificadores - - - - - flags - - - Tipo de entrada; por omisión, ZEND_ACC_CLASS - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.examples; - - Ejemplo con <function>uopz_compose</function> - - function() { - /* ... */ - } -]); - -var_dump( - class_uses(Composed::class), - class_parents(Composed::class), - class_implements(Composed::class)); -?> -]]> - - &example.outputs; - - - string(7) "myTrait" -} -array(1) { - ["myClass"]=> - string(7) "myClass" -} -array(1) { - ["myInterface"]=> - string(11) "myInterface" -} -]]> - - - - - - - diff --git a/reference/uopz/functions/uopz-copy.xml b/reference/uopz/functions/uopz-copy.xml deleted file mode 100644 index fd6aa08954..0000000000 --- a/reference/uopz/functions/uopz-copy.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - - uopz_copy - Copia una función - - - - &uopz.warn.removed.function-5-0-0; - - - - &reftitle.description; - - Closureuopz_copy - stringfunction - - - Closureuopz_copy - stringclass - stringfunction - - - Copia una función a partir de su nombre. - - - - - &reftitle.parameters; - - - class - - - El nombre de la clase que contiene la función a copiar - - - - - function - - - El nombre de la función - - - - - - - - &reftitle.returnvalues; - - Una closure para la función especificada. - - - - - &reftitle.examples; - - Ejemplo con <function>uopz_copy</function> - - -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/uopz/functions/uopz-del-function.xml b/reference/uopz/functions/uopz-del-function.xml deleted file mode 100644 index a0455d70a8..0000000000 --- a/reference/uopz/functions/uopz-del-function.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - uopz_del_function - Elimina una función o método previamente añadido - - - - &reftitle.description; - - booluopz_del_function - stringfunction - - - booluopz_del_function - stringclass - stringfunction - intall&true; - - - Elimina una función o método previamente añadido. - - - - - &reftitle.parameters; - - - class - - - El nombre de la clase. - - - - - function - - - El nombre de la función o método. - - - - - all - - - Si todas las clases que heredan de class serán también afectadas. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - uopz_del_function lanza una RuntimeException - si la función o método a eliminar no ha sido añadido por uopz_add_function. - - - - - &reftitle.examples; - - Uso básico de <function>uopz_del_function</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - uopz_add_function - uopz_unset_return - - - - - - diff --git a/reference/uopz/functions/uopz-delete.xml b/reference/uopz/functions/uopz-delete.xml deleted file mode 100644 index 1dfc90ef4d..0000000000 --- a/reference/uopz/functions/uopz-delete.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - - - uopz_delete - Elimina una función - - - - &uopz.warn.removed.function-5-0-0; - - - - &reftitle.description; - - voiduopz_delete - stringfunction - - - voiduopz_delete - stringclass - stringfunction - - - Elimina una función o método. - - - - - &reftitle.parameters; - - - class - - - El nombre de la clase. - - - - - function - - - El nombre de la función o método. - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.examples; - - Ejemplo con <function>uopz_delete</function> - - -]]> - - &example.outputs.similar; - - - - - - Ejemplo con <function>uopz_delete</function> y una clase - - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/uopz/functions/uopz-extend.xml b/reference/uopz/functions/uopz-extend.xml deleted file mode 100644 index 031786c555..0000000000 --- a/reference/uopz/functions/uopz-extend.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - uopz_extend - Extiende una clase en tiempo de ejecución - - - - &reftitle.description; - - booluopz_extend - stringclass - stringparent - - - Extiende la clase class utilizando - la clase parent. - - - - - &reftitle.parameters; - - - class - - - El nombre de la clase a extender - - - - - parent - - - El nombre de la clase padre - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - A partir de PHP 7.4.0, uopz_extend emite una - RuntimeException, si - OPcache está activado, y la entrada de clase - de class o parent (si en un trait) es inmutable. - - - - - &reftitle.examples; - - Ejemplo con <function>uopz_extend</function> - - -]]> - - &example.outputs; - - - string(1) "B" -} -]]> - - - - - - - diff --git a/reference/uopz/functions/uopz-flags.xml b/reference/uopz/functions/uopz-flags.xml deleted file mode 100644 index 3c020f2a54..0000000000 --- a/reference/uopz/functions/uopz-flags.xml +++ /dev/null @@ -1,189 +0,0 @@ - - - - - - - - uopz_flags - Recupera o define los flags de una función o clase - - - - &reftitle.description; - - intuopz_flags - stringfunction - intflagsPHP_INT_MAX - - - intuopz_flags - stringclass - stringfunction - intflagsPHP_INT_MAX - - - Recupera o define los flags de una clase o entrada de función en tiempo de ejecución. - - - - - - &reftitle.parameters; - - - class - - - El nombre de la clase - - - - - function - - - El nombre de la función. Si class es proporcionado y - una &string; vacía es pasada como function, - uopz_flags recupera o define los flags de la propia clase. - - - - - flags - - - Un conjunto válido de flags ZEND_ACC_. - Si se omite, uopz_flags actúa como recuperador. - - - - - - - - &reftitle.returnvalues; - - Si se definen flags, devuelve los flags antiguos, - de lo contrario, devuelve los flags actuales - - - - - &reftitle.errors; - - A partir de PHP 7.4.0, si el parámetro flags es proporcionado - uopz_flags emite una - RuntimeException, si - OPcache está activado, y la entrada de clase - de class o la entrada de función - function es inmutable. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL uopz 5.0.0 - - El parámetro flags es ahora opcional. Anteriormente, - ZEND_ACC_FETCH debía ser pasado para usar - uopz_flags como recuperador. - - - - - - - - - &reftitle.examples; - - Ejemplo con <function>uopz_flags</function> - - -]]> - - &example.outputs; - - - - - - Transformar una clase final en no final - -isFinal()); -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/uopz/functions/uopz-function.xml b/reference/uopz/functions/uopz-function.xml deleted file mode 100644 index 0c29c62283..0000000000 --- a/reference/uopz/functions/uopz-function.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - - - uopz_function - Crea una función en tiempo de ejecución - - - - &uopz.warn.removed.function-5-0-0; - - - - &reftitle.description; - - voiduopz_function - stringfunction - Closurehandler - intmodifiers - - - voiduopz_function - stringclass - stringfunction - Closurehandler - intmodifiers - - - Crea una función en tiempo de ejecución. - - - - - - &reftitle.parameters; - - - class - - - El nombre de la clase que debe recibir la nueva función - - - - - function - - - El nombre de la función - - - - - handler - - - La closure de la función - - - - - modifiers - - - Los modificadores de la función; por omisión, copiados o - ZEND_ACC_PUBLIC - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.examples; - - Ejemplo con <function>uopz_function</function> - - -]]> - - &example.outputs; - - - - - - Ejemplo con <function>uopz_function</function> y una clase - - -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/uopz/functions/uopz-get-exit-status.xml b/reference/uopz/functions/uopz-get-exit-status.xml deleted file mode 100644 index f5c6bcfb7f..0000000000 --- a/reference/uopz/functions/uopz-get-exit-status.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - uopz_get_exit_status - Devuelve el último estado de salida definido - - - - &reftitle.description; - - mixeduopz_get_exit_status - - - - Devuelve el último estado de salida definido, es decir, el valor pasado a - exit. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Esta función devuelve el último estado de salida, o &null; si exit - no ha sido llamada. - - - - - &reftitle.examples; - - Ejemplo de <function>uopz_get_exit_status</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.notes; - - - OPcache optimiza el código muerto después de una salida incondicional. - - - - - - &reftitle.seealso; - - uopz_allow_exit - - - - - - diff --git a/reference/uopz/functions/uopz-get-hook.xml b/reference/uopz/functions/uopz-get-hook.xml deleted file mode 100644 index 817056ff35..0000000000 --- a/reference/uopz/functions/uopz-get-hook.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - uopz_get_hook - Devuelve el hook previamente definido en una función o método - - - - &reftitle.description; - - Closureuopz_get_hook - stringfunction - - - Closureuopz_get_hook - stringclass - stringfunction - - - Devuelve el hook previamente definido en una función o método. - - - - - &reftitle.parameters; - - - class - - - El nombre de la clase. - - - - - function - - - El nombre de la función o método. - - - - - - - - &reftitle.returnvalues; - - Devuelve el hook previamente definido en una función o método, o &null; si ningún hook - ha sido definido. - - - - - &reftitle.examples; - - Uso básico de <function>uopz_get_hook</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - uopz_set_hook - uopz_unset_hook - - - - - - diff --git a/reference/uopz/functions/uopz-get-mock.xml b/reference/uopz/functions/uopz-get-mock.xml deleted file mode 100644 index d5afa9d447..0000000000 --- a/reference/uopz/functions/uopz-get-mock.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - uopz_get_mock - Devuelve la simulación actual de una clase - - - - &reftitle.description; - - mixeduopz_get_mock - stringclass - - - Devuelve la simulación actual de class. - - - - - &reftitle.parameters; - - - class - - - El nombre de la clase simulada. - - - - - - - &reftitle.returnvalues; - - O bien una cadena que contiene el nombre de la simulación, o bien un objeto, - o bien &null; si ninguna simulación ha sido definida. - - - - - &reftitle.examples; - - Ejemplo de <function>uopz_get_mock</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - uopz_set_mock - uopz_unset_mock - - - - - - diff --git a/reference/uopz/functions/uopz-get-property.xml b/reference/uopz/functions/uopz-get-property.xml deleted file mode 100644 index 1385453048..0000000000 --- a/reference/uopz/functions/uopz-get-property.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - uopz_get_property - Devuelve el valor de una propiedad de clase o instancia - - - - &reftitle.description; - - mixeduopz_get_property - stringclass - stringproperty - - - mixeduopz_get_property - objectinstance - stringproperty - - - Devuelve el valor de una propiedad de clase estática, si class - es proporcionado, o el valor de una propiedad de instancia, si instance - es proporcionado. - - - - - &reftitle.parameters; - - - class - - - El nombre de la clase. - - - - - instance - - - La instancia del objeto. - - - - - property - - - El nombre de la propiedad. - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor de la propiedad de clase o instancia, o &null; si la propiedad - no está definida. - - - - - &reftitle.examples; - - Uso básico de <function>uopz_get_property</function> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - uopz_set_property - - - - - - diff --git a/reference/uopz/functions/uopz-get-return.xml b/reference/uopz/functions/uopz-get-return.xml deleted file mode 100644 index 1a8eece0a6..0000000000 --- a/reference/uopz/functions/uopz-get-return.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - uopz_get_return - Devuelve un valor de retorno previamente definido para una función - - - - &reftitle.description; - - mixeduopz_get_return - stringfunction - - - mixeduopz_get_return - stringclass - stringfunction - - - Devuelve el valor de retorno de la function previamente definido por uopz_set_return. - - - - - &reftitle.parameters; - - - class - - - El nombre de la clase que contiene la función - - - - - function - - - El nombre de la función - - - - - - - - &reftitle.returnvalues; - - El valor de retorno o la closure previamente definida. - - - - - &reftitle.examples; - - Ejemplo de <function>uopz_get_return</function> - - -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/uopz/functions/uopz-get-static.xml b/reference/uopz/functions/uopz-get-static.xml deleted file mode 100644 index 8587c2cfde..0000000000 --- a/reference/uopz/functions/uopz-get-static.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - uopz_get_static - Devuelve las variables estáticas de una función o método - - - - &reftitle.description; - - arrayuopz_get_static - stringclass - stringfunction - - - arrayuopz_get_static - stringfunction - - - Devuelve las variables estáticas de una función o método. - - - - - &reftitle.parameters; - - - class - - - El nombre de la clase. - - - - - function - - - El nombre de la función o método. - - - - - - - - &reftitle.returnvalues; - - Devuelve un array asociativo de nombres de variables mapeados a sus - valores actuales en caso de éxito, o &null; si la función o método no existe. - - - Desde PHP 8.3.0, los inicializadores estáticos se calculan ya sea durante la compilación, - o si no es posible, solo cuando la función o método se ejecuta por primera vez, en cuyo caso - el valor de la variable estática se reporta como &null; antes de la primera invocación. - - - - - &reftitle.examples; - - Uso básico de <function>uopz_get_static</function> - - -]]> - - &example.outputs; - - - string(3) "baz" -} -]]> - - - - - - &reftitle.seealso; - - ReflectionFunctionAbstract::getStaticVariables - uopz_set_static - - - - - - diff --git a/reference/uopz/functions/uopz-implement.xml b/reference/uopz/functions/uopz-implement.xml deleted file mode 100644 index 5476c832d0..0000000000 --- a/reference/uopz/functions/uopz-implement.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - uopz_implement - Implementa una interfaz en tiempo de ejecución - - - - &reftitle.description; - - booluopz_implement - stringclass - stringinterface - - - Implementa la interface en la class. - - - - - - &reftitle.parameters; - - - class - - - El nombre de la clase. - - - - - interface - - - El nombre de la interfaz. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - A partir de PHP 7.4.0, uopz_implement emite una - RuntimeException, si - OPcache está activado, y la entrada de clase - de class es inmutable. - - - - - &reftitle.examples; - - Ejemplo con <function>uopz_implement</function> - - -]]> - - &example.outputs; - - - string(11) "myInterface" -} -]]> - - - - - - - diff --git a/reference/uopz/functions/uopz-overload.xml b/reference/uopz/functions/uopz-overload.xml deleted file mode 100644 index 75cb145be0..0000000000 --- a/reference/uopz/functions/uopz-overload.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - - uopz_overload - Sobrecarga un opcode de la VM - - - - &uopz.warn.removed.function-5-0-0; - - - - &reftitle.description; - - voiduopz_overload - intopcode - Callablecallable - - - Sobrecarga el opcode especificado con una función - definida por el usuario. - - - - - &reftitle.parameters; - - - opcode - - - Un opcode válido; consulte las constantes para más detalles - sobre los códigos admitidos. - - - - - callable - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo con <function>uopz_overload</function> - - -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/uopz/functions/uopz-redefine.xml b/reference/uopz/functions/uopz-redefine.xml deleted file mode 100644 index 3164b2170c..0000000000 --- a/reference/uopz/functions/uopz-redefine.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - - - uopz_redefine - Redefinir una constante - - - - &reftitle.description; - - booluopz_redefine - stringconstant - mixedvalue - - - booluopz_redefine - stringclass - stringconstant - mixedvalue - - - Redefine la constante constant proporcionada, - a value. - - - - - &reftitle.parameters; - - - class - - - El nombre de la clase que contiene la constante - - - - - constant - - - El nombre de la constante - - - - - value - - - El nuevo valor de la constante; debe ser un tipo válido para - una constante - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>uopz_redefine</function> - - -]]> - - &example.outputs; - - - - - - - - - - diff --git a/reference/uopz/functions/uopz-rename.xml b/reference/uopz/functions/uopz-rename.xml deleted file mode 100644 index 019fa8e25b..0000000000 --- a/reference/uopz/functions/uopz-rename.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - - - uopz_rename - Cambia el nombre de una función en tiempo de ejecución - - - - &uopz.warn.removed.function-5-0-0; - - - - &reftitle.description; - - voiduopz_rename - stringfunction - stringrename - - - voiduopz_rename - stringclass - stringfunction - stringrename - - - Cambia el nombre de la función function a rename. - - - - Si ambas funciones existen, sus nombres serán intercambiados. - - - - - - &reftitle.parameters; - - - class - - - El nombre de la clase que contiene la función - - - - - function - - - El nombre de una función existente - - - - - rename - - - El nuevo nombre de la función - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo con <function>uopz_rename</function> - - -]]> - - &example.outputs; - - - - - - Ejemplo con <function>uopz_rename</function> y una clase - - -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/uopz/functions/uopz-restore.xml b/reference/uopz/functions/uopz-restore.xml deleted file mode 100644 index 558dd8d64a..0000000000 --- a/reference/uopz/functions/uopz-restore.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - - uopz_restore - Restaura una función guardada - - - - &uopz.warn.removed.function-5-0-0; - - - - &reftitle.description; - - voiduopz_restore - stringfunction - - - voiduopz_restore - stringclass - stringfunction - - - Restaura una función guardada. - - - - - &reftitle.parameters; - - - class - - - El nombre de la clase que contiene la función a restaurar - - - - - function - - - El nombre de la función - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo con <function>uopz_restore</function> - - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/uopz/functions/uopz-set-hook.xml b/reference/uopz/functions/uopz-set-hook.xml deleted file mode 100644 index fc907612bc..0000000000 --- a/reference/uopz/functions/uopz-set-hook.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - uopz_set_hook - Define el hook que se ejecutará al entrar en una función o un método - - - - &reftitle.description; - - booluopz_set_hook - stringfunction - Closurehook - - - booluopz_set_hook - stringclass - stringfunction - Closurehook - - - Define un hook que se ejecutará al entrar en una función o un método. - - - - - &reftitle.parameters; - - - class - - - El nombre de la clase. - - - - - function - - - El nombre de la función o del método. - - - - - hook - - - Una función anónima que se ejecutará al entrar en la función o el método. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Uso básico de <function>uopz_set_hook</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - uopz_get_hook - uopz_unset_hook - - - - - - diff --git a/reference/uopz/functions/uopz-set-mock.xml b/reference/uopz/functions/uopz-set-mock.xml deleted file mode 100644 index e9ccd3e7dd..0000000000 --- a/reference/uopz/functions/uopz-set-mock.xml +++ /dev/null @@ -1,216 +0,0 @@ - - - - - - uopz_set_mock - Utiliza una simulación en lugar de una clase para nuevos objetos - - - - &reftitle.description; - - voiduopz_set_mock - stringclass - mixedmock - - - Si mock es una cadena que contiene el nombre de una clase, se instanciará en lugar de - class. mock también puede ser un objeto. - - - - Solo el acceso dinámico a las propiedades y métodos usará el objeto mock. - El acceso estático sigue utilizando la class original. - Consulte el ejemplo a continuación. - - - - - - &reftitle.parameters; - - - class - - - El nombre de la clase que se va a simular. - - - - - mock - - - La simulación a usar en forma de cadena que contiene el nombre de la clase a usar o un objeto. - Si se pasa una cadena, debe ser el nombre totalmente calificado de la clase. Se recomienda usar la constante mágica ::class en este caso. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL uopz 6.0.0 - - La simulación de miembros estáticos ya no es compatible con esta función. - uopz_redefine y uopz_set_return, - o Componere pueden ser utilizados en su lugar. - - - - - - - - - &reftitle.examples; - - Ejemplo de <function>uopz_set_mock</function> - -who(); -?> -]]> - - &example.outputs; - - - - - - Ejemplo de <function>uopz_set_mock</function> - -who(); -?> -]]> - - &example.outputs; - - - - - - <function>uopz_set_mock</function> y miembros estáticos - - Desde uopz 6.0.0, la simulación de miembros estáticos ya no es compatible. - - - -]]> - - &example.outputs; - - - - - El ejemplo anterior muestra con uopz 5: - - - - - - - - - &reftitle.seealso; - - uopz_get_mock - uopz_unset_mock - - - - - - diff --git a/reference/uopz/functions/uopz-set-property.xml b/reference/uopz/functions/uopz-set-property.xml deleted file mode 100644 index 78d98898a2..0000000000 --- a/reference/uopz/functions/uopz-set-property.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - uopz_set_property - Establece el valor de una propiedad de clase existente o de instancia - - - - &reftitle.description; - - voiduopz_set_property - stringclass - stringproperty - mixedvalue - - - voiduopz_set_property - objectinstance - stringproperty - mixedvalue - - - Establece el valor de una propiedad de clase estática existente, si se proporciona class, o el valor de una propiedad de instancia (sin importar si la propiedad de instancia ya existe), si se proporciona instance. - - - - - &reftitle.parameters; - - - class - - - El nombre de la clase. - - - - - instance - - - La instancia del objeto. - - - - - property - - - El nombre de la propiedad. - - - - - value - - - El valor a asignar a la propiedad. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Uso básico de <function>uopz_set_property</function> - -bar; - } -} -$foo = new Foo; -uopz_set_property('Foo', 'staticBar', 10); -uopz_set_property($foo, 'bar', 100); -var_dump(Foo::testStaticBar()); -var_dump($foo->testBar()); -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - uopz_get_property - - - - - - diff --git a/reference/uopz/functions/uopz-set-return.xml b/reference/uopz/functions/uopz-set-return.xml deleted file mode 100644 index c9c1406b1d..0000000000 --- a/reference/uopz/functions/uopz-set-return.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - uopz_set_return - Proporciona un valor de retorno para una función existente - - - - &reftitle.description; - - booluopz_set_return - stringfunction - mixedvalue - boolexecute&false; - - - booluopz_set_return - stringclass - stringfunction - mixedvalue - boolexecute&false; - - - Establece el valor de retorno de la function a value. Si value - es una función anónima y execute está establecido, la función anónima se ejecutará en lugar de la función original. - Es posible llamar a la función original desde la función anónima. - - - - Esta función reemplaza a uopz_rename. - - - - - - &reftitle.parameters; - - - class - - - El nombre de la clase que contiene la función - - - - - function - - - El nombre de una función existente - - - - - value - - - El valor que la función debe devolver. Si se proporciona una función anónima y el flag de ejecución está establecido, la función anónima se ejecutará en lugar de la función original. - - - - - execute - - - Si es verdadero, y se ha proporcionado una función anónima como valor, la función anónima se ejecutará en lugar de la función original. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; en caso de éxito, de lo contrario &false;. - - - - - &reftitle.examples; - - Ejemplo de <function>uopz_set_return</function> - - -]]> - - &example.outputs; - - - - - - Ejemplo de <function>uopz_set_return</function> - - -]]> - - &example.outputs; - - - - - - Ejemplo de <function>uopz_set_return</function> con una clase - - -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/uopz/functions/uopz-undefine.xml b/reference/uopz/functions/uopz-undefine.xml deleted file mode 100644 index 4e16879fc9..0000000000 --- a/reference/uopz/functions/uopz-undefine.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - uopz_undefine - Elimina una constante - - - - &reftitle.description; - - booluopz_undefine - stringconstant - - - booluopz_undefine - stringclass - stringconstant - - - Elimina una constante en tiempo de ejecución. - - - - - &reftitle.parameters; - - - class - - - El nombre de la clase que contiene la constant - - - - - constant - - - El nombre de una constante existente - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo con <function>uopz_undefine</function> - - -]]> - - &example.outputs; - - - - - - - - - - diff --git a/reference/uopz/functions/uopz-unset-hook.xml b/reference/uopz/functions/uopz-unset-hook.xml deleted file mode 100644 index af55c4bf6f..0000000000 --- a/reference/uopz/functions/uopz-unset-hook.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - uopz_unset_hook - Suprime el hook previamente fijado sobre una función o un método - - - - &reftitle.description; - - booluopz_unset_hook - stringfunction - - - booluopz_unset_hook - stringclass - stringfunction - - - Suprime el hook previamente fijado sobre una función o un método. - - - - - &reftitle.parameters; - - - class - - - El nombre de la clase. - - - - - function - - - El nombre de la función o del método. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Uso básico de <function>uopz_unset_hook</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - uopz_set_hook - uopz_get_hook - - - - - - diff --git a/reference/uopz/functions/uopz-unset-mock.xml b/reference/uopz/functions/uopz-unset-mock.xml deleted file mode 100644 index 7a35609a72..0000000000 --- a/reference/uopz/functions/uopz-unset-mock.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - uopz_unset_mock - Suprime la simulación previamente fijada - - - - &reftitle.description; - - voiduopz_unset_mock - stringclass - - - Suprime la simulación previamente fijada para class. - - - - - &reftitle.parameters; - - - class - - - El nombre de la clase simulada. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Una RuntimeException es lanzada si ninguna simulación ha sido previamente - fijada para class. - - - - - &reftitle.examples; - - Ejemplo de <function>uopz_unset_mock</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - uopz_set_mock - uopz_get_mock - - - - - - diff --git a/reference/uopz/functions/uopz-unset-return.xml b/reference/uopz/functions/uopz-unset-return.xml deleted file mode 100644 index 1bd2c4ebff..0000000000 --- a/reference/uopz/functions/uopz-unset-return.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - uopz_unset_return - Suprime un valor de retorno previamente fijado para una función - - - - &reftitle.description; - - booluopz_unset_return - stringfunction - - - booluopz_unset_return - stringclass - stringfunction - - - Suprime el valor de retorno de la function previamente fijado por uopz_set_return. - - - - - &reftitle.parameters; - - - class - - - El nombre de la clase que contiene la función - - - - - function - - - El nombre de la función - - - - - - - - &reftitle.returnvalues; - - &true; en caso de éxito. - - - - - &reftitle.examples; - - Ejemplo de <function>uopz_unset_return</function> - - -]]> - - &example.outputs; - - - - - - - - - - diff --git a/reference/uopz/functions/uopz_set_static.xml b/reference/uopz/functions/uopz_set_static.xml deleted file mode 100644 index 3134ead7dc..0000000000 --- a/reference/uopz/functions/uopz_set_static.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - uopz_set_static - Fija las variables estáticas en el ámbito de una función o de un método - - - - &reftitle.description; - - voiduopz_set_static - stringfunction - arraystatic - - - voiduopz_set_static - stringclass - stringfunction - arraystatic - - - Fija las variables estáticas en el ámbito de una función o de un método. - - - - - &reftitle.parameters; - - - class - - - El nombre de la clase. - - - - - function - - - El nombre de la función o del método. - - - - - static - - - El array asociativo de nombres de variables mapeados a sus valores. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Ejemplo de uso de <function>uopz_set_static</function> - - 'qux']); -foo(); -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - uopz_get_static - - - - - - diff --git a/reference/uopz/reference.xml b/reference/uopz/reference.xml deleted file mode 100644 index 10279d4e79..0000000000 --- a/reference/uopz/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - &Functions; Uopz - - &reference.uopz.entities.functions; - - - - diff --git a/reference/uopz/setup.xml b/reference/uopz/setup.xml deleted file mode 100644 index b9f7c47965..0000000000 --- a/reference/uopz/setup.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - A partir de uopz 5.0, PHP 7.0 es necesario. A partir de uopz 5.1, PHP 7.1+ es necesario. - -
    - -
    - &reftitle.install; - - Las versiones de uopz están alojadas por PECL y el código fuente por - github; - la forma más sencilla de instalarlo es a través de la instalación - via PECL : - &url.pecl.package;uopz. - - - Los usuarios de Windows pueden descargar los binarios desde el sitio web de - PECL. - - - A partir de uopz 5.0.0, la extensión debe ser cargada como una - extensión. Anterior a esta versión, debe - ser cargada como una zend_extension. - -
    - -
    - &reftitle.runtime; - &extension.runtime; - - - uopz &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - uopz.disable - "0" - INI_SYSTEM - Disponible a partir de uopz 5.0.2 - - - uopz.exit - "0" - INI_SYSTEM - Disponible a partir de uopz 6.0.1 - - - uopz.overloads - "1" - INI_SYSTEM - Disponible a partir de uopz 2.0.2. Eliminado a partir de uopz 5.0.0. - - - -
    - &ini.php.constants; -
    - - &ini.descriptions.title; - - - - - - uopz.disable - bool - - - - Si está activado, uopz no debería tener ningún efecto sobre el motor. - - - - - - uopz.exit - bool - - - - Permitir o no la ejecución de los códigos de operación (opcodes) de salida. - Este parámetro puede ser sobreescrito durante la ejecución llamando a uopz_allow_exit. - - - - - - uopz.overloads - bool - - - - Activa la posibilidad de utilizar uopz_overload. - - - - - - - - - Al ejecutar con OPcache activado, puede ser necesario desactivar todas las - optimizaciones OPcache - (opcache.optimization_level=0). - - -
    - -
    - - diff --git a/reference/v8js/book.xml b/reference/v8js/book.xml deleted file mode 100644 index 6de3469bd2..0000000000 --- a/reference/v8js/book.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - Motor de integración V8 Javascript - V8js - - - &reftitle.intro; - - Esta extensión incorpora el Motor V8 Javascript en PHP. - - - - &reference.v8js.setup; - &reference.v8js.examples; - - &reference.v8js.v8js; - &reference.v8js.v8jsexception; - - - - diff --git a/reference/v8js/configure.xml b/reference/v8js/configure.xml deleted file mode 100644 index 80cd867f59..0000000000 --- a/reference/v8js/configure.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;v8js - - - -
    - - - diff --git a/reference/v8js/examples.xml b/reference/v8js/examples.xml deleted file mode 100644 index 0ce35a035e..0000000000 --- a/reference/v8js/examples.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - &reftitle.examples; - - Uso básico - - - Básica ejecución Javascript - -executeString($JS, 'basic.js')); -} catch (V8JsException $e) { - var_dump($e); -} - -?> -]]> - - &example.outputs; - - - - - - - - diff --git a/reference/v8js/ini.xml b/reference/v8js/ini.xml deleted file mode 100644 index 77d605c1a7..0000000000 --- a/reference/v8js/ini.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - -
    - &reftitle.runtime; - &extension.runtime; - - - V8js &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - v8js.max_disposed_contexts - 25 - INI_ALL - - - - v8js.flags - - INI_ALL - - - - -
    -
    - - &ini.descriptions.title; - - - - - - v8js.max_disposed_contexts - int - - - - Establece límite para contextos dispuestas antes de forzar V8 que hacer la recolección de basura. - - - - - - v8js.flags - string - - - - Establece V8 opciones de la línea de comandos. La lista de los indicadores disponibles se puede obtener en el modo CLI estableciendo este parámetro en - --help. Ejemplo: - - - - - - - - Por estas banderas para ser eficaz en tiempo de ejecución de la ini_set () llamada se tiene que hacer antes de que los objetos se instancian V8Js! - - - - - - - - -
    - - diff --git a/reference/v8js/setup.xml b/reference/v8js/setup.xml deleted file mode 100644 index cfa7b933b3..0000000000 --- a/reference/v8js/setup.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - La biblioteca y los encabezados de PHP y V8 instalados en las rutas adecuadas. - -
    - - &reference.v8js.configure; - - &reference.v8js.ini; - -
    - - diff --git a/reference/v8js/v8js.xml b/reference/v8js/v8js.xml deleted file mode 100644 index 6acb4617d4..0000000000 --- a/reference/v8js/v8js.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - La clase <classname>V8Js</classname> - V8Js - - - - -
    - &reftitle.intro; - - Esta es la clase principal para la extensión de V8Js. Cada instancia creada a partir de - esta clase tiene su propio contexto en el que todo el Javascript es compilado y - ejecutado. - - - Véase V8Js::__construct para más información. - -
    - - -
    - &reftitle.classsynopsis; - - - - V8Js - - - - - V8Js - - - - &Constants; - - const - string - V8Js::V8_VERSION - - - const - int - V8Js::FLAG_NONE - 1 - - - const - int - V8Js::FLAG_FORCE_ARRAY - 2 - - - &Methods; - - - - - - - - - -
    - - -
    - &reftitle.constants; - - - - V8Js::V8_VERSION - - La versión del motor de Javascript V8. - - - - - V8Js::FLAG_NONE - - Ningún flag. - - - - - V8Js::FLAG_FORCE_ARRAY - - Obliga a todos los objetos JS a ser arrays asociativos en PHP. - - - - -
    - - - -
    - - &reference.v8js.entities.v8js; - -
    - - diff --git a/reference/v8js/v8js/construct.xml b/reference/v8js/v8js/construct.xml deleted file mode 100644 index f402156ea7..0000000000 --- a/reference/v8js/v8js/construct.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - V8Js::__construct - Construye un nuevo objeto V8Js - - - - &reftitle.description; - - public V8Js::__construct - stringobject_name"PHP" - arrayvariablesarray() - arrayextensionsarray() - boolreport_uncaught_exceptions&true; - - - Construye un nuevo objeto V8Js. - - - - - - &reftitle.parameters; - - - object_name - - - El nombre del objeto pasado a Javascript. - - - - - variables - - - Una lista de variables PHP que estarán disponibles en Javascript. Debe ser un - array asociativo en el formato array("nombre-para-js" => "nombre-de-la-variable-php"). - Por omisión, un array vacío. - - - - - extensions - - - Lista de extensiones registradas utilizando el método - V8Js::registerExtension, que deben estar disponibles - en el contexto Javascript del objeto V8Js creado. - - - Las extensiones registradas de tal manera que estén automáticamente activas no necesitan ser listadas en este array. - Además, si una extensión tiene dependencias, estas pueden ser omitidas. Por omisión, un array vacío. - - - - - - - report_uncaught_exceptions - - - Controla si las excepciones Javascript no capturadas se reportan inmediatamente o no. - Por omisión, vale &true;. Si se establece en &false;, se puede acceder a la excepción no capturada - utilizando el método V8Js::getPendingException. - - - - - - - - - diff --git a/reference/v8js/v8js/executestring.xml b/reference/v8js/v8js/executestring.xml deleted file mode 100644 index 3ed2e0fd75..0000000000 --- a/reference/v8js/v8js/executestring.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - - V8Js::executeString - Ejecuta un string como código Javascript - - - - &reftitle.description; - - public mixedV8Js::executeString - stringscript - stringidentifier"V8Js::executeString()" - intflagsV8Js::FLAG_NONE - - - Compila y ejecuta el string pasado con script como código Javascript. - - - - - &reftitle.parameters; - - - script - - - El string de código que a ejecutar. - - - - - identifier - - - Identificador para el código ejecutado. Usado para depuración. - - - - - flags - - - Flags de ejecución. Este valor debe ser una de - las constantes V8Js::FLAG_*, y por omisión es - V8Js::FLAG_NONE. - - - - V8Js::FLAG_NONE : ningún flag - - - - - V8Js::FLAG_FORCE_ARRAY : fuerza a todos - los objetos Javascript pasados a PHP a ser arrays asociativos - - - - - - - - - - - &reftitle.returnvalues; - - Devuelve la última variable instanciada en el código Javascript, convertida en una variable PHP del tipo correspondiente. - - - - - diff --git a/reference/v8js/v8js/getextensions.xml b/reference/v8js/v8js/getextensions.xml deleted file mode 100644 index 134dabc1f1..0000000000 --- a/reference/v8js/v8js/getextensions.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - V8Js::getExtensions - Devolver un array de extensiones registradas - - - - &reftitle.description; - - public static arrayV8Js::getExtensions - - - - Esta función devuelve el array de extensiones Javascript registradas mediante V8Js::registerExtension. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un array de extensiones registradas o un array vacío si no hay ninguna. - - - - - - diff --git a/reference/v8js/v8js/getpendingexception.xml b/reference/v8js/v8js/getpendingexception.xml deleted file mode 100644 index 6873c3e6ef..0000000000 --- a/reference/v8js/v8js/getpendingexception.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - V8Js::getPendingException - Devuelve la excepción de Javascript no capturada pendiente - - - - &reftitle.description; - - public V8JsExceptionV8Js::getPendingException - - - - Devuelve cualquier excepción de Javascript no capturada pendiente de una o varias llamadas anteriores a V8Js::executeString, - en forma de V8JsException. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un objeto V8JsException o &null;. - - - - - - diff --git a/reference/v8js/v8js/registerextension.xml b/reference/v8js/v8js/registerextension.xml deleted file mode 100644 index 8ebd6b17d2..0000000000 --- a/reference/v8js/v8js/registerextension.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - - V8Js::registerExtension - Registra extensiones Javascript para V8Js - - - - &reftitle.description; - - public static boolV8Js::registerExtension - stringextension_name - stringscript - arraydependenciesarray() - boolauto_enable&false; - - - Registra el código Javascript pasado por el argumento script - como extensión para ser utilizada en los contextos V8Js. - - - - - &reftitle.parameters; - - - extension_name - - - Nombre de la extensión a registrar. - - - - - script - - - El código Javascript a registrar. - - - - - dependencies - - - Un array de nombres de extensiones de las que depende la extensión que se está registrando. - Cada una de ellas será activada automáticamente al cargar esta extensión. - - - Todas las extensiones, incluyendo las dependencias, deben ser registradas antes - de la creación de cualquier objeto V8Js que las utilice. - - - - - - - auto_enable - - - Si se establece en &true;, la extensión será activada automáticamente en todos los - contextos V8Js. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si la extensión se ha registrado con éxito, &false; en caso contrario. - - - - - - diff --git a/reference/v8js/v8jsexception.xml b/reference/v8js/v8jsexception.xml deleted file mode 100644 index c278c1b00a..0000000000 --- a/reference/v8js/v8jsexception.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - - La clase <classname>V8JsException</classname> - V8JsException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - V8JsException - - - - - V8JsException - - - - extends - Exception - - - - &Properties; - - protected - JsFileName - - - protected - JsLineNumber - - - protected - JsSourceLine - - - protected - JsTrace - - - &InheritedProperties; - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - JsFileName - - - - - - JsLineNumber - - - - - - JsSourceLine - - - - - - JsTrace - - - - - -
    - - - -
    - - &reference.v8js.entities.v8jsexception; - -
    - - diff --git a/reference/v8js/v8jsexception/getjsfilename.xml b/reference/v8js/v8jsexception/getjsfilename.xml deleted file mode 100644 index 2c1d4f263a..0000000000 --- a/reference/v8js/v8jsexception/getjsfilename.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - V8JsException::getJsFileName - El propósito getJsFileName - - - - &reftitle.description; - - final public stringV8JsException::getJsFileName - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/v8js/v8jsexception/getjslinenumber.xml b/reference/v8js/v8jsexception/getjslinenumber.xml deleted file mode 100644 index 233f29f407..0000000000 --- a/reference/v8js/v8jsexception/getjslinenumber.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - V8JsException::getJsLineNumber - El propósito getJsLineNumber - - - - &reftitle.description; - - final public intV8JsException::getJsLineNumber - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/v8js/v8jsexception/getjssourceline.xml b/reference/v8js/v8jsexception/getjssourceline.xml deleted file mode 100644 index 9d18400c34..0000000000 --- a/reference/v8js/v8jsexception/getjssourceline.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - V8JsException::getJsSourceLine - El propósito getJsSourceLine - - - - &reftitle.description; - - final public stringV8JsException::getJsSourceLine - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/v8js/v8jsexception/getjstrace.xml b/reference/v8js/v8jsexception/getjstrace.xml deleted file mode 100644 index 8d0ae703ca..0000000000 --- a/reference/v8js/v8jsexception/getjstrace.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - V8JsException::getJsTrace - El propósito getJsTrace - - - - &reftitle.description; - - final public stringV8JsException::getJsTrace - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/var_representation/book.xml b/reference/var_representation/book.xml deleted file mode 100644 index 1dca379ed9..0000000000 --- a/reference/var_representation/book.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - var_representation - var_representation - - - &reftitle.intro; - - La extensión var_representation proporciona una alternativa compacta a var_export que escapa correctamente los caracteres de control. - - - - &reference.var-representation.setup; - &reference.var-representation.constants; - &reference.var-representation.reference; - - - - diff --git a/reference/var_representation/constants.xml b/reference/var_representation/constants.xml deleted file mode 100644 index 538b2af5b2..0000000000 --- a/reference/var_representation/constants.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - - VAR_REPRESENTATION_SINGLE_LINE - (int) - - - - El flag var_representation que indica que los saltos de línea - no deben ser utilizados para el espaciado en las representaciones de variables. - - - - - - VAR_REPRESENTATION_UNESCAPED - (int) - - - - El flag de var_representation que indica que los strings - deben ser codificados como cadenas simples con caracteres de control no escapados. - - - - - - - diff --git a/reference/var_representation/functions/var-representation.xml b/reference/var_representation/functions/var-representation.xml deleted file mode 100644 index 05c29ff3e3..0000000000 --- a/reference/var_representation/functions/var-representation.xml +++ /dev/null @@ -1,226 +0,0 @@ - - - - - - var_representation - Devuelve una representación legible, corta y analizable de una variable - - - - &reftitle.description; - - stringvar_representation - mixedvalue - intflags0 - - - var_representation (de la PECL var_representation) devuelve un string de caracteres con información estructurada sobre - la variable dada. Es similar a var_export con diferencias en la indentación, escape de strings y las representaciones de array. - - - - - &reftitle.parameters; - - - value - - - La variable para generar una representación. - - - - - flags - - - Una máscara de bits que consiste en - VAR_REPRESENTATION_SINGLE_LINE, - VAR_REPRESENTATION_UNESCAPED. - El comportamiento de estas constantes se describe en la página de las - constantes de var_representation. - - - - - - - - &reftitle.returnvalues; - - Devuelve la representación de la variable. - - - - - &reftitle.examples; - - - Ejemplo de <function>var_representation</function> - - 'value']]; -echo var_representation($a), "\n"; -echo var_representation($a, VAR_REPRESENTATION_SINGLE_LINE), "\n"; -?> -]]> - - &example.outputs; - - 'value', - ], -] -[1, 2, ['key' => 'value']] -]]> - - - - - - Escapado de caracteres de control - - -]]> - - &example.outputs; - - - - - - - - Exportar una <classname>stdClass</classname> - -name = 'ElePHPant ElePHPantsdotter'; -$person->website = 'https://php.net/elephpant.php'; - -echo var_representation($person); -?> -]]> - - &example.outputs; - - 'ElePHPant ElePHPantsdotter', - 'website' => 'https://php.net/elephpant.php', -] -]]> - - - - - - Exportar clases - -var = 5; -echo var_representation($a); -?> -]]> - - &example.outputs; - - 5, -]) -]]> - - - - - - Uso con <link linkend="object.set-state">__set_state()</link> - -var1 = $an_array['var1']; - $obj->var2 = $an_array['var2']; - return $obj; - } -} - -$a = new A; -$a->var1 = 5; -$a->var2 = 'foo'; - -eval('$b = ' . var_representation($a) . ';'); // $b = \A::__set_state([ - // 'var1' => 5, - // 'var2' => 'foo', - // ]); -var_dump($b); -?> -]]> - - &example.outputs; - - - int(5) - ["var2"]=> - string(3) "foo" -} -]]> - - - - - - - &reftitle.seealso; - - - var_export - - - - - diff --git a/reference/var_representation/reference.xml b/reference/var_representation/reference.xml deleted file mode 100644 index 6a3ce06c64..0000000000 --- a/reference/var_representation/reference.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - &Functions; de var_representation - - &reference.var-representation.entities.functions; - - - diff --git a/reference/var_representation/setup.xml b/reference/var_representation/setup.xml deleted file mode 100644 index 30939ddf40..0000000000 --- a/reference/var_representation/setup.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - &reftitle.setup; - -
    - &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 deleted file mode 100644 index eddf7e4eb1..0000000000 --- a/reference/varnish/book.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - - Varnish - Varnish - - - &reftitle.intro; - - Varnish Cache es un acelerador de aplicaciones web de última generación de - código abierto. La extensión permite interactuar con una instancia de varnish - en ejecución a través de un socket TCP o de memoria compartida. - - - - &reference.varnish.setup; - &reference.varnish.constants; - &reference.varnish.examples; - - &reference.varnish.varnishadmin; - &reference.varnish.varnishstat; - &reference.varnish.varnishlog; - &reference.varnish.varnishexception; - - - - diff --git a/reference/varnish/configure.xml b/reference/varnish/configure.xml deleted file mode 100644 index 4889d620ad..0000000000 --- a/reference/varnish/configure.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;varnish - - - -
    - - - diff --git a/reference/varnish/constants.xml b/reference/varnish/constants.xml deleted file mode 100644 index f17fbb54b8..0000000000 --- a/reference/varnish/constants.xml +++ /dev/null @@ -1,223 +0,0 @@ - - - - - - &reftitle.constants; - &extension.constants; - - - - - VARNISH_STATUS_SYNTAX - (int) - - - - - - - - - VARNISH_STATUS_UNKNOWN - (int) - - - - - - - - - VARNISH_STATUS_UNIMPL - (int) - - - - - - - - - VARNISH_STATUS_TOOFEW - (int) - - - - - - - - - VARNISH_STATUS_TOOMANY - (int) - - - - - - - - - VARNISH_STATUS_PARAM - (int) - - - - - - - - - VARNISH_STATUS_AUTH - (int) - - - - - - - - - VARNISH_STATUS_OK - (int) - - - - - - - - - VARNISH_STATUS_CANT - (int) - - - - - - - - - VARNISH_STATUS_COMMS - (int) - - - - - - - - - VARNISH_STATUS_CLOSE - (int) - - - - - - - - - VARNISH_CONFIG_IDENT - (string) - - - - - - - - - VARNISH_CONFIG_HOST - (string) - - - - - - - - - VARNISH_CONFIG_PORT - (string) - - - - - - - - - VARNISH_CONFIG_TIMEOUT - (string) - - - - - - - - - VARNISH_CONFIG_SECRET - (string) - - - - - - - - - VARNISH_CONFIG_COMPAT - (string) - - - - - - - - - VARNISH_COMPAT_2 - (int) - - - - - - - - - VARNISH_COMPAT_3 - (int) - - - - - - - - - - - diff --git a/reference/varnish/examples.xml b/reference/varnish/examples.xml deleted file mode 100644 index e81a5b97d4..0000000000 --- a/reference/varnish/examples.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - &reftitle.examples; -
    - Uso Básico de VarnishAdmin - - El ejemplo muestra un uso sencillo de la funcionalidad de prohibición - - - Prohibición de una URL - - "::1", - VARNISH_CONFIG_PORT => 6082, - VARNISH_CONFIG_SECRET => "5174826b-8595-4958-aa7a-0609632ad7ca", - VARNISH_CONFIG_TIMEOUT => 300, -); - -$va = new VarnishAdmin($args); - -try { - if(!$va->connect()) { - throw new VarnishException("Conexión fallida\n"); - } -} catch (VarnishException $e) { - echo $e->getMessage(); - exit(3); -} - -try { - if(!$va->auth()) { - throw new VarnishException("Autorización fallida\n"); - } -} catch (VarnishException $e) { - echo $e->getMessage(); - exit(3); -} - -try { - $estado = $va->ban('req.url ~ "^/$"'); - if (VARNISH_STATUS_OK != $estado) { - throw new VarnishException("El método ban devolvió el estado $estado\n"); - } -} catch (VarnishException $e) { - echo $e->getMessage(); - exit(3); -} - -exit(0); - -?> -]]> - - -
    -
    - Uso básico de VarnishStat - - El ejemplo muestra la obtención de una instantánea de las estadísticas de varnish de - memoria compartida - - - Obtención de una instantánea de las estadísticas - -getSnapshot(); -} catch (VarnishException $e) { - echo $e->getMessage(); - exit(3); -} - -exit(0); -?> -]]> - - -
    -
    - Uso básico de VarnishLog - - El ejemplo muestra la lectura de líneas del registro de varnish de memoria compartida - - - Lectura del log de varnish en la memoria compartida - -getLine(); - printf("%s %d %s", VarnishLog::getTagName($line['tag']), $line['id'], - $line['data']); -} - -exit(0); -?> -]]> - - -
    -
    - - - diff --git a/reference/varnish/setup.xml b/reference/varnish/setup.xml deleted file mode 100644 index 3991ad87f2..0000000000 --- a/reference/varnish/setup.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Para utilizar esta extensión, debe estar instalada una versión de Varnish Cache igual o superior a 3.0, - disponible en la página de inicio de Varnish Cache. - -
    - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;varnish. - -
    - -
    - - diff --git a/reference/varnish/varnishadmin.xml b/reference/varnish/varnishadmin.xml deleted file mode 100644 index 320a6eb4b3..0000000000 --- a/reference/varnish/varnishadmin.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - La clase VarnishAdmin - VarnishAdmin - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - VarnishAdmin - - - - - VarnishAdmin - - - - - &Methods; - - - - -
    - -
    - - &reference.varnish.entities.varnishadmin; - -
    - - diff --git a/reference/varnish/varnishadmin/auth.xml b/reference/varnish/varnishadmin/auth.xml deleted file mode 100644 index 231d1ef3e4..0000000000 --- a/reference/varnish/varnishadmin/auth.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - VarnishAdmin::auth - Autentificar en una instancia de varnish - - - - &reftitle.description; - - public boolVarnishAdmin::auth - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/varnish/varnishadmin/ban.xml b/reference/varnish/varnishadmin/ban.xml deleted file mode 100644 index 6424535825..0000000000 --- a/reference/varnish/varnishadmin/ban.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - VarnishAdmin::ban - Prohibe URLs usando una expresión VCL - - - - &reftitle.description; - - public intVarnishAdmin::ban - stringvcl_regex - - - - - - - - &reftitle.parameters; - - - - vcl_regex - - - expresión VCL de Varnish. Se basa en el comando de prohibición de varnish. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el estado de comando de varnish. - - - - - - - diff --git a/reference/varnish/varnishadmin/banurl.xml b/reference/varnish/varnishadmin/banurl.xml deleted file mode 100644 index 002eec2d92..0000000000 --- a/reference/varnish/varnishadmin/banurl.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - VarnishAdmin::banUrl - Prohibe una URL usando una expresión VCL - - - - &reftitle.description; - - public intVarnishAdmin::banUrl - stringvcl_regex - - - - - - - - &reftitle.parameters; - - - - vcl_regex - - - Expresión regular de URL en sintaxis compatible con PCRE. Está basado en el - comando de varnish ban.url. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el estado de comando varnish. - - - - - - - diff --git a/reference/varnish/varnishadmin/clearpanic.xml b/reference/varnish/varnishadmin/clearpanic.xml deleted file mode 100644 index 7451936d7d..0000000000 --- a/reference/varnish/varnishadmin/clearpanic.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - VarnishAdmin::clearPanic - Limpia mensajes de pánico de la instancia varnish - - - - &reftitle.description; - - public intVarnishAdmin::clearPanic - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el estado de comando varnish. - - - - - - - diff --git a/reference/varnish/varnishadmin/connect.xml b/reference/varnish/varnishadmin/connect.xml deleted file mode 100644 index 1a51a926e9..0000000000 --- a/reference/varnish/varnishadmin/connect.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - VarnishAdmin::connect - Conectarse a una interfaz de administración de instancias de varnish - - - - &reftitle.description; - - public boolVarnishAdmin::connect - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/varnish/varnishadmin/construct.xml b/reference/varnish/varnishadmin/construct.xml deleted file mode 100644 index f579c6922f..0000000000 --- a/reference/varnish/varnishadmin/construct.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - - VarnishAdmin::__construct - Constructor de VarnishAdmin - - - - &reftitle.description; - - public VarnishAdmin::__construct - arrayargs - - - - - - - - &reftitle.parameters; - - - args - - - Argumentos de configuración. Las posibles claves son: - - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.examples; - - Ejemplo con <function>VarnishAdmin::__construct</function> - - "::1", - VARNISH_CONFIG_PORT => 6082, - VARNISH_CONFIG_SECRET => "5174826b-8595-4958-aa7a-0609632ad7ca", - VARNISH_CONFIG_TIMEOUT => 300, - ); - $va = new VarnishAdmin($args); -?> -]]> - - - - - - - diff --git a/reference/varnish/varnishadmin/disconnect.xml b/reference/varnish/varnishadmin/disconnect.xml deleted file mode 100644 index 7dcf41b0e2..0000000000 --- a/reference/varnish/varnishadmin/disconnect.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - VarnishAdmin::disconnect - Desconecta interfaz de administración de la instancia de varnish - - - - &reftitle.description; - - public boolVarnishAdmin::disconnect - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/varnish/varnishadmin/getpanic.xml b/reference/varnish/varnishadmin/getpanic.xml deleted file mode 100644 index 7074f1897e..0000000000 --- a/reference/varnish/varnishadmin/getpanic.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - VarnishAdmin::getPanic - Obtener el último mensaje de pánico en una instancia varnish - - - - &reftitle.description; - - public stringVarnishAdmin::getPanic - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - &reftitle.returnvalues; - - Devuelve el último mensaje de pánico en la instancia varnish actual. - - - - - - - diff --git a/reference/varnish/varnishadmin/getparams.xml b/reference/varnish/varnishadmin/getparams.xml deleted file mode 100644 index 8d85be0f31..0000000000 --- a/reference/varnish/varnishadmin/getparams.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - VarnishAdmin::getParams - Busca los parámetros de configuración de la instancia varnish actual - - - - &reftitle.description; - - public arrayVarnishAdmin::getParams - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un array con los parámetros de configuración varnish. - - - - - - - diff --git a/reference/varnish/varnishadmin/isrunning.xml b/reference/varnish/varnishadmin/isrunning.xml deleted file mode 100644 index 98d15ecde5..0000000000 --- a/reference/varnish/varnishadmin/isrunning.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - VarnishAdmin::isRunning - Comprueba si el proceso varnish esclavo está actualmente en marcha - - - - &reftitle.description; - - public boolVarnishAdmin::isRunning - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/varnish/varnishadmin/setcompat.xml b/reference/varnish/varnishadmin/setcompat.xml deleted file mode 100644 index 1c4dcd30b0..0000000000 --- a/reference/varnish/varnishadmin/setcompat.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - VarnishAdmin::setCompat - Establece el parámetro de configuración de la clase compacta - - - - &reftitle.description; - - public voidVarnishAdmin::setCompat - intcompat - - - - - - - - &reftitle.parameters; - - - - compat - - - Opción de compatibilidad de varnish. - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/varnish/varnishadmin/sethost.xml b/reference/varnish/varnishadmin/sethost.xml deleted file mode 100644 index 51aad7f7b5..0000000000 --- a/reference/varnish/varnishadmin/sethost.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - VarnishAdmin::setHost - Establece el parámetro de configuración del host de la clase - - - - &reftitle.description; - - public voidVarnishAdmin::setHost - stringhost - - - - - - - - &reftitle.parameters; - - - - host - - - Parámetro de configuración del host de la conexión. - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/varnish/varnishadmin/setident.xml b/reference/varnish/varnishadmin/setident.xml deleted file mode 100644 index 32f75ec068..0000000000 --- a/reference/varnish/varnishadmin/setident.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - VarnishAdmin::setIdent - Establece el parámetro de configuración de la identificación de la clase - - - - &reftitle.description; - - public voidVarnishAdmin::setIdent - stringident - - - - - - - - &reftitle.parameters; - - - - ident - - - Parámetro de configuración de la identificación de la conexión. - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/varnish/varnishadmin/setparam.xml b/reference/varnish/varnishadmin/setparam.xml deleted file mode 100644 index 3c09122153..0000000000 --- a/reference/varnish/varnishadmin/setparam.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - VarnishAdmin::setParam - Establece los parámetros de configuración en la instancia varnish actual - - - - &reftitle.description; - - public intVarnishAdmin::setParam - stringname - stringintvalue - - - - - - - - &reftitle.parameters; - - - - name - - - Nombre del parámetro de configuración varnish. - - - - - value - - - Valor del parámetro de configuración varnish. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el estado de comando varnish. - - - - - - - diff --git a/reference/varnish/varnishadmin/setport.xml b/reference/varnish/varnishadmin/setport.xml deleted file mode 100644 index 801b456d8d..0000000000 --- a/reference/varnish/varnishadmin/setport.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - VarnishAdmin::setPort - Establece el parámetro de configuración del puerto de clase - - - - &reftitle.description; - - public voidVarnishAdmin::setPort - intport - - - - - - - - &reftitle.parameters; - - - - port - - - Parámetro de configuración del puerto de conexión. - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/varnish/varnishadmin/setsecret.xml b/reference/varnish/varnishadmin/setsecret.xml deleted file mode 100644 index c0bf658a3a..0000000000 --- a/reference/varnish/varnishadmin/setsecret.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - VarnishAdmin::setSecret - Establece los parámetros secretos de configuración de la clase - - - - &reftitle.description; - - public voidVarnishAdmin::setSecret - stringsecret - - - - - - - - &reftitle.parameters; - - - - secret - - - Parámetro secreto de configuración de la conexión. - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/varnish/varnishadmin/settimeout.xml b/reference/varnish/varnishadmin/settimeout.xml deleted file mode 100644 index 0ff15cae63..0000000000 --- a/reference/varnish/varnishadmin/settimeout.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - VarnishAdmin::setTimeout - Configura el parámetro de tiempo de espera de la clase - - - - &reftitle.description; - - public voidVarnishAdmin::setTimeout - inttimeout - - - - - - - - &reftitle.parameters; - - - - timeout - - - Parámetro de configuración del tiempo de espera de la conexión. - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/varnish/varnishadmin/start.xml b/reference/varnish/varnishadmin/start.xml deleted file mode 100644 index c2cc404804..0000000000 --- a/reference/varnish/varnishadmin/start.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - VarnishAdmin::start - Iniciar el proceso de varnish - - - - &reftitle.description; - - public intVarnishAdmin::start - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el estado de comando varnish. - - - - - - - diff --git a/reference/varnish/varnishadmin/stop.xml b/reference/varnish/varnishadmin/stop.xml deleted file mode 100644 index 8a8c462fe3..0000000000 --- a/reference/varnish/varnishadmin/stop.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - VarnishAdmin::stop - Detener el proceso de varnish - - - - &reftitle.description; - - public intVarnishAdmin::stop - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el estado de comando de varnish. - - - - - - - diff --git a/reference/varnish/varnishexception.xml b/reference/varnish/varnishexception.xml deleted file mode 100644 index 9234586c12..0000000000 --- a/reference/varnish/varnishexception.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - La clase VarnishException - VarnishException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - VarnishException - - - - - VarnishException - - - - extends - Exception - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - - -
    - -
    - - diff --git a/reference/varnish/varnishlog.xml b/reference/varnish/varnishlog.xml deleted file mode 100644 index cc8700290e..0000000000 --- a/reference/varnish/varnishlog.xml +++ /dev/null @@ -1,755 +0,0 @@ - - - - - - - La clase VarnishLog - VarnishLog - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - VarnishLog - - - - - VarnishLog - - - - &Constants; - - const - int - VarnishLog::TAG_Debug - 0 - - - const - int - VarnishLog::TAG_Error - 1 - - - const - int - VarnishLog::TAG_CLI - 2 - - - const - int - VarnishLog::TAG_StatSess - 3 - - - const - int - VarnishLog::TAG_ReqEnd - 4 - - - const - int - VarnishLog::TAG_SessionOpen - 5 - - - const - int - VarnishLog::TAG_SessionClose - 6 - - - const - int - VarnishLog::TAG_BackendOpen - 7 - - - const - int - VarnishLog::TAG_BackendXID - 8 - - - const - int - VarnishLog::TAG_BackendReuse - 9 - - - const - int - VarnishLog::TAG_BackendClose - 10 - - - const - int - VarnishLog::TAG_HttpGarbage - 11 - - - const - int - VarnishLog::TAG_Backend - 12 - - - const - int - VarnishLog::TAG_Length - 13 - - - const - int - VarnishLog::TAG_FetchError - 14 - - - const - int - VarnishLog::TAG_RxRequest - 15 - - - const - int - VarnishLog::TAG_RxResponse - 16 - - - const - int - VarnishLog::TAG_RxStatus - 17 - - - const - int - VarnishLog::TAG_RxURL - 18 - - - const - int - VarnishLog::TAG_RxProtocol - 19 - - - const - int - VarnishLog::TAG_RxHeader - 20 - - - const - int - VarnishLog::TAG_TxRequest - 21 - - - const - int - VarnishLog::TAG_TxResponse - 22 - - - const - int - VarnishLog::TAG_TxStatus - 23 - - - const - int - VarnishLog::TAG_TxURL - 24 - - - const - int - VarnishLog::TAG_TxProtocol - 25 - - - const - int - VarnishLog::TAG_TxHeader - 26 - - - const - int - VarnishLog::TAG_ObjRequest - 27 - - - const - int - VarnishLog::TAG_ObjResponse - 28 - - - const - int - VarnishLog::TAG_ObjStatus - 29 - - - const - int - VarnishLog::TAG_ObjURL - 30 - - - const - int - VarnishLog::TAG_ObjProtocol - 31 - - - const - int - VarnishLog::TAG_ObjHeader - 32 - - - const - int - VarnishLog::TAG_LostHeader - 33 - - - const - int - VarnishLog::TAG_TTL - 34 - - - const - int - VarnishLog::TAG_Fetch_Body - 35 - - - const - int - VarnishLog::TAG_VCL_acl - 36 - - - const - int - VarnishLog::TAG_VCL_call - 37 - - - const - int - VarnishLog::TAG_VCL_trace - 38 - - - const - int - VarnishLog::TAG_VCL_return - 39 - - - const - int - VarnishLog::TAG_VCL_error - 40 - - - const - int - VarnishLog::TAG_ReqStart - 41 - - - const - int - VarnishLog::TAG_Hit - 42 - - - const - int - VarnishLog::TAG_HitPass - 43 - - - const - int - VarnishLog::TAG_ExpBan - 44 - - - const - int - VarnishLog::TAG_ExpKill - 45 - - - const - int - VarnishLog::TAG_WorkThread - 46 - - - const - int - VarnishLog::TAG_ESI_xmlerror - 47 - - - const - int - VarnishLog::TAG_Hash - 48 - - - const - int - VarnishLog::TAG_Backend_health - 49 - - - const - int - VarnishLog::TAG_VCL_Log - 50 - - - const - int - VarnishLog::TAG_Gzip - 51 - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; - - - - 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 - - - - - - -
    - - - -
    - - &reference.varnish.entities.varnishlog; - -
    - - diff --git a/reference/varnish/varnishlog/construct.xml b/reference/varnish/varnishlog/construct.xml deleted file mode 100644 index 00dce7722f..0000000000 --- a/reference/varnish/varnishlog/construct.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - VarnishLog::__construct - Constructor de Varnishlog - - - - &reftitle.description; - - public VarnishLog::__construct - arrayargs - - - - - - - - &reftitle.parameters; - - - args - - - Argumentos de configuración. Las posibles claves son: - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/varnish/varnishlog/getline.xml b/reference/varnish/varnishlog/getline.xml deleted file mode 100644 index d1b3147902..0000000000 --- a/reference/varnish/varnishlog/getline.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - VarnishLog::getLine - Obtiene la siguiente línea de registro - - - - &reftitle.description; - - public arrayVarnishLog::getLine - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un array con los datos de la línea de registro. - - - - - - - diff --git a/reference/varnish/varnishlog/gettagname.xml b/reference/varnish/varnishlog/gettagname.xml deleted file mode 100644 index 11b36bbf21..0000000000 --- a/reference/varnish/varnishlog/gettagname.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - VarnishLog::getTagName - Obtener la etiqueta de registro representada por su índice - - - - &reftitle.description; - - public static stringVarnishLog::getTagName - intindex - - - - - - - - &reftitle.parameters; - - - - index - - - Índice de etiqueta de registro. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el nombre de la etiqueta de registro como un &string;. - - - - - - - diff --git a/reference/varnish/varnishstat.xml b/reference/varnish/varnishstat.xml deleted file mode 100644 index 8276582f5c..0000000000 --- a/reference/varnish/varnishstat.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - La clase VarnishStat - VarnishStat - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - VarnishStat - - - - - VarnishStat - - - - - &Methods; - - - - -
    - -
    - - &reference.varnish.entities.varnishstat; - -
    - - diff --git a/reference/varnish/varnishstat/construct.xml b/reference/varnish/varnishstat/construct.xml deleted file mode 100644 index 16a1edd36d..0000000000 --- a/reference/varnish/varnishstat/construct.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - VarnishStat::__construct - Constructor VarnishStat - - - - &reftitle.description; - - public VarnishStat::__construct - arrayargs - - - - - - - - &reftitle.parameters; - - - args - - - Argumentos de configuración. Las claves posibles son: - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/varnish/varnishstat/getsnapshot.xml b/reference/varnish/varnishstat/getsnapshot.xml deleted file mode 100644 index 9e17e771a0..0000000000 --- a/reference/varnish/varnishstat/getsnapshot.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - VarnishStat::getSnapshot - Obtener la instantánea actual de las estadísticas de instancia varnish - - - - &reftitle.description; - - public arrayVarnishStat::getSnapshot - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Array con la instantánea de las estadísticas varnish. Las claves del array - son idénticas a los la herramienta varnishstat. - - - - - - - diff --git a/reference/wddx/book.xml b/reference/wddx/book.xml deleted file mode 100644 index 2fac0f7932..0000000000 --- a/reference/wddx/book.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - - - WDDX - - - - &reftitle.intro; - - - Esta extensión está OBSOLETA y DESGRUPADA - a partir de PHP 7.4.0. - - - - Estas funciones están previstas para funcionar con - WDDX. - - - - No se deben pasar datos de usuario no confiables a la función - wddx_deserialize. La deserialización puede llevar al cargado - y ejecución de datos durante la instancia y el autocargado del objeto, y un usuario - malintencionado puede ser capaz de explotar este comportamiento. - Utilice un formato seguro de intercambio de datos como JSON - (usando las funciones json_decode y json_encode) - si se deben pasar datos serializados al usuario. - - - - - - &reference.wddx.setup; - &reference.wddx.examples; - &reference.wddx.reference; - - - diff --git a/reference/wddx/configure.xml b/reference/wddx/configure.xml deleted file mode 100644 index 408b4538ca..0000000000 --- a/reference/wddx/configure.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - -
    - &reftitle.install; - -
    - PHP 7.4 - - &pecl.moved-ver;7.4.0 - - - &pecl.info; - &url.pecl.package;wddx. - -
    - -
    - PHP < 7.4 - - Después de instalar la librería requerida Expat, compile PHP con - y utilice - para Expat. - - &windows.builtin; -
    -
    - - diff --git a/reference/wddx/examples.xml b/reference/wddx/examples.xml deleted file mode 100644 index 9749dd9a34..0000000000 --- a/reference/wddx/examples.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - &reftitle.examples; -
    - Ejemplos WDDX - - Todas las funciones que serializan variables utilizan - el primer elemento de un array para determinar si el array - debe ser serializado en un array o en una estructura. - Si el primer elemento tiene una cadena de caracteres como clave, - entonces será serializado en una estructura, de lo contrario, en un array. - - - - Serialización de un valor simple con WDDX - - -]]> - - - Este ejemplo mostrará: - - -
    -PHP to WDDX packet example -]]> - - - - - Uso de paquetes incrementales con WDDX - - -]]> - - - Este ejemplo mostrará: - - -
    -3.1415926 -AustinNovato -Seattle -]]> - - - - - - Los strings deben estar codificados en UTF-8; para manejar otros juegos de caracteres, - convierta primero el string utilizando mb_convert_encoding, - UConverter::transcode, o iconv. - - -
    -
    - diff --git a/reference/wddx/functions/wddx-add-vars.xml b/reference/wddx/functions/wddx-add-vars.xml deleted file mode 100644 index 637a24024b..0000000000 --- a/reference/wddx/functions/wddx-add-vars.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - - - wddx_add_vars - Se utiliza para añadir variables a un paquete WDDX con el ID especificado - - - - &warn.removed.function-7-4-0; - - - - &reftitle.description; - - boolwddx_add_vars - resourcepacket_id - mixedvar_name - mixedvar_names - - - Serializa las variables pasadas y añade el resultado al paquete dado. - - - - - &reftitle.parameters; - - Esta función acepta un número variable de argumentos. - - - packet_id - - - Un paquete WDDX, devuelto por la función - wddx_packet_start. - - - - - var_name - - - Puede ser una &string; que nombre una variable o un array - que contenga nombres de variables o de otros arrays, etc.. - - - - - var_names - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/wddx/functions/wddx-deserialize.xml b/reference/wddx/functions/wddx-deserialize.xml deleted file mode 100644 index 5ec3153a50..0000000000 --- a/reference/wddx/functions/wddx-deserialize.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - wddx_deserialize - Deserializa un paquete WDDX - - - - &warn.removed.function-7-4-0; - - - - &reftitle.description; - - mixedwddx_deserialize - stringpacket - - - Deserializa un paquete packet WDDX. - - - - No se debe pasar entrada de usuario no verificada a wddx_deserialize. - La deserialización puede hacer que el código sea cargado y ejecutado durante - la instancia y el autocargado del objeto, y un usuario malintencionado puede ser - capaz de alojar un exploit. Utilice un formato seguro, estándar de intercambio de datos - como JSON (usando json_decode y json_encode) - si se deben pasar datos serializados al usuario. - - - - - - &reftitle.parameters; - - - - packet - - - Un paquete WDDX, en forma de &string; o de flujo. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor deserializado, que puede ser un &string;, un número - o un array. Observe que las estructuras son deserializadas en arrays asociativos. - - - - - - diff --git a/reference/wddx/functions/wddx-packet-end.xml b/reference/wddx/functions/wddx-packet-end.xml deleted file mode 100644 index 7eed86c3a4..0000000000 --- a/reference/wddx/functions/wddx-packet-end.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - - wddx_packet_end - Cierra un paquete WDDX con el ID especificado - - - - &warn.removed.function-7-4-0; - - - - &reftitle.description; - - stringwddx_packet_end - resourcepacket_id - - - Cierra y devuelve un paquete WDDX dado. - - - - - &reftitle.parameters; - - - - packet_id - - - Un paquete WDDX, devuelto por la función - wddx_packet_start. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un &string; que contiene el paquete WDDX. - - - - - diff --git a/reference/wddx/functions/wddx-packet-start.xml b/reference/wddx/functions/wddx-packet-start.xml deleted file mode 100644 index 47874cf96b..0000000000 --- a/reference/wddx/functions/wddx-packet-start.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - wddx_packet_start - Inicia un nuevo paquete WDDX con una estructura dentro de él - - - - &warn.removed.function-7-4-0; - - - - &reftitle.description; - - resourcewddx_packet_start - stringcomment - - - Inicia un nuevo paquete WDDX para la adición incremental de variables. - Automáticamente crea una definición de estructura - en el paquete, para alojar variables. - - - - - &reftitle.parameters; - - - - comment - - - Un &string; opcional que contiene el comentario. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un identificador de paquete para su uso posterior con las funciones - WDDX, o &false; si ocurre un error. - - - - - diff --git a/reference/wddx/functions/wddx-serialize-value.xml b/reference/wddx/functions/wddx-serialize-value.xml deleted file mode 100644 index e4e7a44627..0000000000 --- a/reference/wddx/functions/wddx-serialize-value.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - wddx_serialize_value - Serializa un solo valor en un paquete WDDX - - - - &warn.removed.function-7-4-0; - - - - &reftitle.description; - - stringwddx_serialize_value - mixedvar - stringcomment - - - Crea un paquete WDDX a partir de un solo valor dado. - - - - - &reftitle.parameters; - - - - var - - - El valor a serializar. - - - - - comment - - - Una &string; opcional que contiene un comentario que aparece en - el encabezado del paquete. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el paquete WDDX, o &false; si ocurre un error. - - - - - diff --git a/reference/wddx/functions/wddx-serialize-vars.xml b/reference/wddx/functions/wddx-serialize-vars.xml deleted file mode 100644 index 61e882f123..0000000000 --- a/reference/wddx/functions/wddx-serialize-vars.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - - wddx_serialize_vars - Registra múltiples valores en un paquete WDDX - - - - &warn.removed.function-7-4-0; - - - - &reftitle.description; - - stringwddx_serialize_vars - mixedvar_name - mixedvar_names - - - Crea un paquete WDDX con una estructura que contiene la representación - serializada de las variables pasadas. - - - - - &reftitle.parameters; - - Esta función acepta un número variable de argumentos. - - - var_name - - - Puede ser una &string; que nombre una variable o un array - que contenga nombres de variables o de otros arrays, etc.. - - - - - var_names - - - - - - - - - - - &reftitle.returnvalues; - - Devuelve el paquete WDDX, o &false; si ocurre un error. - - - - - &reftitle.examples; - - - Ejemplo con <function>wddx_serialize_vars</function> - - -]]> - - &example.outputs; - -
    1 -5.5 -blueorangeviolet -colors -]]> - - - - - - - diff --git a/reference/wddx/reference.xml b/reference/wddx/reference.xml deleted file mode 100644 index 288048d6a8..0000000000 --- a/reference/wddx/reference.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - WDDX &Functions; - - &reference.wddx.entities.functions; - - - - diff --git a/reference/wddx/setup.xml b/reference/wddx/setup.xml deleted file mode 100644 index d0af0cf614..0000000000 --- a/reference/wddx/setup.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - &reftitle.setup; - - -
    - &reftitle.required; - &libxml.required; - - Para utilizar WDDX, es necesario instalar la biblioteca expat - (que se proporciona con Apache 1.3.7 o superior). - -
    - - - - &reference.wddx.configure; - - - -
    - &reftitle.resources; - - Esta extensión define un identificador de paquete WDDX, - devuelto por la función wddx_packet_start. - -
    - - -
    - - diff --git a/reference/win32service/book.xml b/reference/win32service/book.xml deleted file mode 100644 index 9c04182955..0000000000 --- a/reference/win32service/book.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - - - win32service - - - - &reftitle.intro; - - La extensión win32service es una extensión específica de Windows que - permite a PHP comunicarse con la Gestión de Control de Servicio para - iniciar, detener, registrar o eliminar servicios, y permite también - que los scripts PHP se ejecuten como servicio. - - - - - &reference.win32service.setup; - &reference.win32service.constants; - &reference.win32service.win32serviceexception; - &reference.win32service.win32servicerightinfo; - &reference.win32service.examples; - &reference.win32service.reference; - - - - diff --git a/reference/win32service/constants.xml b/reference/win32service/constants.xml deleted file mode 100644 index 177c0bd42e..0000000000 --- a/reference/win32service/constants.xml +++ /dev/null @@ -1,1152 +0,0 @@ - - - - - - &reftitle.constants; - &extension.constants; - - - Mascara binaria de tipo de Servicio de Win32Service - - - - Constante - Valor - Descripción - - - - - WIN32_SERVICE_WIN32_OWN_PROCESS - 0x00000010 - - El servicio se ejecuta en su propio proceso. - - - - WIN32_SERVICE_INTERACTIVE_PROCESS - 0x00000100 - - El servicio puede interactuar con el escritorio. Esta opción no está disponible en Windows Vista o versiones posteriores. - - - - WIN32_SERVICE_WIN32_OWN_PROCESS_INTERACTIVE - 0x00000110 - - El servicio se ejecuta en su propio proceso y puede interactuar con el escritorio. - Esta opción no está disponible en Windows Vista y siguientes. - - - - -
    - - - Constantes de Estado del Servicio de Win32Service - - - - Constante - Valor - Descripción - - - - - WIN32_SERVICE_CONTINUE_PENDING - 0x00000005 - - La continuación del servicio está en espera. - - - - WIN32_SERVICE_PAUSE_PENDING - 0x00000006 - - La pausa del servicio está en espera. - - - - WIN32_SERVICE_PAUSED - 0x00000004 - - El servicio está en pausa. - - - - WIN32_SERVICE_RUNNING - 0x00000004 - - El servicio está en curso de ejecución. - - - - WIN32_SERVICE_START_PENDING - 0x00000002 - - El servicio está en curso de inicio. - - - - WIN32_SERVICE_STOP_PENDING - 0x00000003 - - El servicio está en curso de parada. - - - - WIN32_SERVICE_STOPPED - 0x00000001 - - El servicio está parado. - - - - -
    - - - Constantes del Servicio de Control de Mensaje de Win32Service - - - - Constante - Valor - Descripción - - - - - WIN32_SERVICE_CONTROL_CONTINUE - 0x00000003 - - Avisa a un servicio suspendido que debe reanudarse. - - - - WIN32_SERVICE_CONTROL_DEVICEEVENT - 0x0000000B - - - - - WIN32_SERVICE_CONTROL_HARDWAREPROFILECHANGE - 0x0000000C - - - - - WIN32_SERVICE_CONTROL_INTERROGATE - 0x00000004 - - Avisa a un servicio que debe informar sobre su estado actual - al controlador de servicio. - - - - WIN32_SERVICE_CONTROL_NETBINDADD - 0x00000007 - - Avisa a un servicio de red que existe un nuevo componente para la conexión. - - - - WIN32_SERVICE_CONTROL_NETBINDDISABLE - 0x0000000A - - Avisa a un servicio de red que una de sus conexiones ha sido desactivada. - - - - WIN32_SERVICE_CONTROL_NETBINDENABLE - 0x00000009 - - Avisa a un servicio de red que una conexión desactivada ha sido activada. - - - - WIN32_SERVICE_CONTROL_NETBINDREMOVE - 0x00000008 - - Avisa a un servicio de red que un componente para la conexión ha sido eliminado. - - - - WIN32_SERVICE_CONTROL_PARAMCHANGE - 0x00000006 - - Avisa a un servicio que sus parámetros de inicio han cambiado. - - - - WIN32_SERVICE_CONTROL_PAUSE - 0x00000002 - - Avisa a un servicio que debe ponerse en pausa. - - - - WIN32_SERVICE_CONTROL_POWEREVENT - 0x0000000D - - - - - WIN32_SERVICE_CONTROL_PRESHUTDOWN - 0x0000000F - - Avisa a un servicio que el sistema va a apagarse. Un servicio que maneja - esta notificación bloquea el apagado del sistema hasta que el servicio se detenga o hasta - que expire el tiempo de preapagado. Este valor no es soportado por Windows Server 2003 y Windows XP/2000. - - - - WIN32_SERVICE_CONTROL_SESSIONCHANGE - 0x0000000E - - - - - WIN32_SERVICE_CONTROL_SHUTDOWN - 0x00000005 - - Avisa a un servicio que el sistema se está apagando y que el servicio puede - realizar tareas de limpieza. Si un servicio acepta este código de control, debe detenerse - tan pronto como complete sus tareas de limpieza. Después de enviar este código de control por el ACM, - ningún otro código de control será enviado al servicio. - - - - WIN32_SERVICE_CONTROL_STOP - 0x00000001 - - Avisa a un servicio que debe detenerse. - - - - -
    - - - Máscara binaria de Mensaje de Control de Servicio de Win32Service - - - - Constante - Valor - Descripción - - - - - WIN32_SERVICE_ACCEPT_HARDWAREPROFILECHANGE - 0x00000020 - - El servicio es notificado cuando el perfil de hardware del ordenador ha cambiado. - Esto permite al sistema enviar notificaciones - WIN32_SERVICE_CONTROL_HARDWAREPROFILECHANGE al servicio. - - - - WIN32_SERVICE_ACCEPT_NETBINDCHANGE - 0x00000010 - - El servicio es un componente de red que puede aceptar cambios en su conexión sin ser detenido y reiniciado. Este código de control permite al - servicio recibir las notificaciones - WIN32_SERVICE_CONTROL_NETBINDADD, - WIN32_SERVICE_CONTROL_NETBINDREMOVE, - WIN32_SERVICE_CONTROL_NETBINDENABLE, y - WIN32_SERVICE_CONTROL_NETBINDDISABLE. - - - - WIN32_SERVICE_ACCEPT_PARAMCHANGE - 0x00000008 - - El servicio puede releer sus parámetros de inicio sin ser detenido y reiniciado. - Este código de control permite al servicio recibir notificaciones WIN32_SERVICE_CONTROL_PARAMCHANGE. - - - - WIN32_SERVICE_ACCEPT_PAUSE_CONTINUE - 0x00000002 - - El servicio puede ser puesto en pausa y continuado. Este código de control permite al - servicio recibir las notificaciones - WIN32_SERVICE_CONTROL_PAUSE y WIN32_SERVICE_CONTROL_CONTINUE. - - - - WIN32_SERVICE_ACCEPT_POWEREVENT - 0x00000040 - - El servicio es notificado cuando el estado de alimentación del ordenador ha cambiado. - Esto permite al sistema enviar notificaciones - WIN32_SERVICE_CONTROL_POWEREVENT al servicio. - - - - WIN32_SERVICE_ACCEPT_PRESHUTDOWN - 0x00000100 - - El servicio puede realizar tareas antes del apagado. Este código de control permite - al servicio recibir la notificación WIN32_SERVICE_CONTROL_PRESHUTDOWN. - Este valor no es soportado por Windows Server 2003 y Windows XP/2000. - - - - WIN32_SERVICE_ACCEPT_SESSIONCHANGE - 0x00000080 - - El servicio es notificado cuando el estado de sesión del ordenador ha cambiado. - Esto permite al sistema enviar notificaciones - WIN32_SERVICE_CONTROL_SESSIONCHANGE al servicio. - Windows 2000: este valor no es soportado. - - - - WIN32_SERVICE_ACCEPT_SHUTDOWN - 0x00000004 - - El servicio es informado cuando ocurre el apagado del sistema. Este código de control - permite al servicio recibir la notificación WIN32_SERVICE_CONTROL_SHUTDOWN. - - - - WIN32_SERVICE_ACCEPT_STOP - 0x00000001 - - El servicio puede ser detenido. Este control permite al servicio recibir la - notificación WIN32_SERVICE_CONTROL_STOP. - - - - WIN32_SERVICE_ACCEPT_TIMECHANGE - 0x00000200 - - El servicio es notificado cuando la hora del sistema ha cambiado. - Esto permite al sistema enviar notificaciones - WIN32_SERVICE_CONTROL_TIMECHANGE al servicio. - Windows Server 2008, Windows Vista, Windows Server 2003 y Windows XP/2000: - este código de control no es soportado. - - - - WIN32_SERVICE_ACCEPT_TRIGGEREVENT - 0x00000400 - - El servicio es notificado cuando ocurre un evento para el cual el servicio se ha registrado. - Esto permite al sistema enviar notificaciones - WIN32_SERVICE_CONTROL_TRIGGEREVENT al servicio. - Windows Server 2008, Windows Vista, Windows Server 2003 y Windows XP/2000: - este código de control no es soportado. - - - - -
    - - - Constantes de Tipo de Inicio del Servicio de Win32Service - - - - Constante - Valor - Descripción - - - - - WIN32_SERVICE_BOOT_START - 0x00000000 - - Un controlador de dispositivo iniciado por el cargador del sistema. Este valor es válido únicamente para los servicios de controlador. - - - - WIN32_SERVICE_SYSTEM_START - 0x00000001 - - Un controlador de dispositivo iniciado por la función IoInitSystem. Este valor es válido únicamente para los servicios de controlador. - - - - WIN32_SERVICE_AUTO_START - 0x00000002 - - Un servicio lanzado automáticamente por el controlador de servicio al - inicio del sistema. - - - - WIN32_SERVICE_DEMAND_START - 0x00000003 - - Un servicio iniciado por el controlador de servicio cuando un - proceso llama a la función StartService. - - - - WIN32_SERVICE_DISABLED - 0x00000004 - - Un servicio que no puede ser iniciado. Los intentos para iniciar - devuelven un código de error WIN32_ERROR_SERVICE_DISABLED. - - - - -
    - - - Constantes de Control de Error de Win32Service - - - - Constante - Valor - Descripción - - - - - WIN32_SERVICE_ERROR_IGNORE - 0x00000000 - - El programa de inicio ignora el error y continúa la operación de inicio. - - - - WIN32_SERVICE_ERROR_NORMAL - 0x00000001 - - El programa de inicio registra el error en el registro de eventos, - pero continúa la operación de inicio. - - - - WIN32_SERVICE_ERROR_SEVERE - 0x00000002 - - El programa de inicio consigna el error en el registro de eventos. - Si la última configuración conocida es lanzada, la operación de inicio se - continúa. De lo contrario, el sistema se reinicia con la última configuración - conocida-bueno. - - - - WIN32_SERVICE_ERROR_CRITICAL - 0x00000003 - - El programa de inicio consigna el error en el registro de eventos, - si es posible. - Si la última configuración conocida es lanzada, la operación de inicio - falla. De lo contrario, el sistema se reinicia con la última configuración - conocida-bueno. - - - - -
    - - - Constantes de Flag de Servicio de Win32Service - - - - Constante - Valor - Descripción - - - - - WIN32_SERVICE_RUNS_IN_SYSTEM_PROCESS - 0x00000001 - - El servicio se ejecuta en un proceso del sistema que debe estar siempre - en ejecución. - - - - -
    - - - - Estas constantes ya no se utilizan a partir de Win32Service 1.0.0. - - - - Códigos de Error Win32 - - - - Constante - Valor - Descripción - - - - - WIN32_ERROR_ACCESS_DENIED - 0x00000005 - - El controlador de la base de datos SMC no dispone de los derechos de acceso apropiados. - - - - WIN32_ERROR_CIRCULAR_DEPENDENCY - 0x00000423 - - Una dependencia circular de servicio está especificada. - - - - WIN32_ERROR_DATABASE_DOES_NOT_EXIST - 0x00000429 - - La base de datos especificada no existe. - - - - WIN32_ERROR_DEPENDENT_SERVICES_RUNNING - 0x0000041B - - El servicio no puede ser detenido porque otros servicios en ejecución - dependen de él. - - - - WIN32_ERROR_DUPLICATE_SERVICE_NAME - 0x00000436 - - El nombre de visualización ya existe en la base de datos del controlador de servicio - como nombre de servicio o como nombre de visualización. - - - - WIN32_ERROR_FAILED_SERVICE_CONTROLLER_CONNECT - 0x00000427 - - Este error es devuelto si el programa es ejecutado en aplicación de consola - en lugar de como servicio. Si el programa es ejecutado en aplicación de consola para propósitos de depuración, - debe ser estructurado de manera que el código específico del servicio nunca sea llamado. - - - - WIN32_ERROR_INSUFFICIENT_BUFFER - 0x0000007A - - El buffer es demasiado pequeño para la estructura de estado del servicio. - Nada ha sido escrito en la estructura. - - - - WIN32_ERROR_INVALID_DATA - 0x0000000D - - La estructura de estado del servicio indicada no es válida. - - - - WIN32_ERROR_INVALID_HANDLE - 0x00000006 - - El manejador para el controlador de servicio especificado es inválido. - - - - WIN32_ERROR_INVALID_LEVEL - 0x0000007C - - El parámetro InfoLevel contiene un valor no soportado. - - - - WIN32_ERROR_INVALID_NAME - 0x0000007B - - El nombre de servicio especificado no es válido. - - - - WIN32_ERROR_INVALID_PARAMETER - 0x00000057 - - Un parámetro especificado no es válido. - - - - WIN32_ERROR_INVALID_SERVICE_ACCOUNT - 0x00000421 - - El nombre de usuario especificado en el parámetro user - no existe. Ver win32_create_service. - - - - WIN32_ERROR_INVALID_SERVICE_CONTROL - 0x0000041C - - El código de control solicitado no es válido, o es inaceptable para el servicio. - - - - WIN32_ERROR_PATH_NOT_FOUND - 0x00000003 - - El fichero binario del servicio no ha podido ser encontrado. - - - - WIN32_ERROR_SERVICE_ALREADY_RUNNING - 0x00000420 - - Una instancia del servicio ya está en ejecución. - - - - WIN32_ERROR_SERVICE_CANNOT_ACCEPT_CTRL - 0x00000425 - - El código de control solicitado no puede ser enviado al servicio porque el estado del servicio - es WIN32_SERVICE_STOPPED, - WIN32_SERVICE_START_PENDING o - WIN32_SERVICE_STOP_PENDING. - - - - WIN32_ERROR_SERVICE_DATABASE_LOCKED - 0x0000041F - - La base de datos está bloqueada. - - - - WIN32_ERROR_SERVICE_DEPENDENCY_DELETED - 0x00000433 - - El servicio depende de un servicio que no existe o que ha sido marcado para - eliminación. - - - - WIN32_ERROR_SERVICE_DEPENDENCY_FAIL - 0x0000042C - - Este servicio depende de otro servicio que no ha podido iniciar. - - - - WIN32_ERROR_SERVICE_DISABLED - 0x00000422 - - El servicio ha sido desactivado. - - - - WIN32_ERROR_SERVICE_DOES_NOT_EXIST - 0x00000424 - - El servicio especificado no existe como servicio instalado. - - - - WIN32_ERROR_SERVICE_EXISTS - 0x00000431 - - El servicio especificado ya existe en la base de datos. - - - - WIN32_ERROR_SERVICE_LOGON_FAILED - 0x0000042D - - El servicio no ha iniciado debido a un fallo de conexión. Este - error ocurre si el servicio está configurado para ejecutarse bajo - un cuenta que no tiene los derechos "conectar como servicio". - - - - WIN32_ERROR_SERVICE_MARKED_FOR_DELETE - 0x00000430 - - El servicio especificado ya ha sido marcado para eliminación. - - - - WIN32_ERROR_SERVICE_NO_THREAD - 0x0000041E - - Un thread no ha podido ser creado para el servicio. - - - - WIN32_ERROR_SERVICE_NOT_ACTIVE - 0x00000426 - - El servicio no ha sido iniciado. - - - - WIN32_ERROR_SERVICE_REQUEST_TIMEOUT - 0x0000041D - - El proceso del servicio ha sido iniciado, pero no ha llamado - StartServiceCtrlDispatcher, o el thread que ha llamado StartServiceCtrlDispatcher - puede estar bloqueado en una función del controlador de control. - - - - WIN32_ERROR_SHUTDOWN_IN_PROGRESS - 0x0000045B - - El sistema se está apagando, esta función no puede ser llamada. - - - - WIN32_ERROR_SERVICE_SPECIFIC_ERROR - 0x0000042A - - El servicio ha devuelto un código de error específico del servicio. - - - - WIN32_NO_ERROR - 0x00000000 - - Ningún error. - - - - -
    - - - Clases de Prioridad de Base Win32 - - - - Constante - Valor - Descripción - - - - - WIN32_ABOVE_NORMAL_PRIORITY_CLASS - 0x00008000 - - Proceso con una prioridad superior a WIN32_NORMAL_PRIORITY_CLASS - pero inferior a WIN32_HIGH_PRIORITY_CLASS. - - - - WIN32_BELOW_NORMAL_PRIORITY_CLASS - 0x00004000 - - Proceso con una prioridad superior a WIN32_IDLE_PRIORITY_CLASS - pero inferior a WIN32_NORMAL_PRIORITY_CLASS. - - - - WIN32_HIGH_PRIORITY_CLASS - 0x00000080 - - Proceso que ejecuta tareas críticas en el tiempo que deben - ser ejecutadas inmediatamente. El thread del proceso precede a los - threads de prioridad normal o en reposo. Un ejemplo es la lista de tareas, - que debe responder rápidamente cuando es llamada por - el usuario, independientemente de la carga del sistema. Sea extremadamente - cuidadoso cuando se utiliza la clase de alta prioridad, ya que una - aplicación de clase de alta prioridad puede utilizar casi todo - el tiempo CPU disponible. - - - - WIN32_IDLE_PRIORITY_CLASS - 0x00000040 - - Proceso cuyo threads solo se ejecutan cuando el sistema está - inactivo. Los threads del proceso son precedidos por los threads de cualquier - proceso en curso con una clase de mayor prioridad. - Un ejemplo es un protector de pantalla. Esta clase es heredada por los - procesos hijos. - - - - WIN32_NORMAL_PRIORITY_CLASS - 0x00000020 - - Proceso sin necesidades específicas de planificación. - - - - WIN32_REALTIME_PRIORITY_CLASS - 0x00000100 - - Proceso con la mayor prioridad posible. Los threads del proceso - preceden a los threads de cualquier otro proceso, incluyendo los procesos del - sistema operativo ejecutando tareas importantes. Por ejemplo, un - proceso en tiempo real que se ejecuta un poco demasiado lento puede causar - pérdidas de escritura del buffer en el disco o impedir a la ratón de - responder. - - - - -
    - - - Acciones de Recuperación Win32 - - - - Constante - Valor - Descripción - - - - - WIN32_SC_ACTION_NONE - 0x00000000 - - Ninguna acción. - - - - WIN32_SC_ACTION_RESTART - 0x00000001 - - Reiniciar el servicio. - - - - WIN32_SC_ACTION_REBOOT - 0x00000002 - - Reiniciar el servidor. - - - - WIN32_SC_ACTION_RUN_COMMAND - 0x00000003 - - Ejecutar un programa. - - - - -
    - - - Informaciones de Servicio Win32 - - - - Constante - Valor - Descripción - - - - - WIN32_INFO_SERVICE - "service" - - - - - WIN32_INFO_DISPLAY - "display" - - - - - WIN32_INFO_USER - "user" - - - - - WIN32_INFO_PASSWORD - "password" - - - - - WIN32_INFO_PATH - "path" - - - - - WIN32_INFO_PARAMS - "params" - - - - - WIN32_INFO_DESCRIPTION - "description" - - - - - WIN32_INFO_START_TYPE - "start_type" - - - - - WIN32_INFO_LOAD_ORDER - "load_order" - - - - - WIN32_INFO_SVC_TYPE - "svc_type" - - - - - WIN32_INFO_ERROR_CONTROL - "error_control" - - - - - WIN32_INFO_DELAYED_START - "delayed_start" - - - - - WIN32_INFO_BASE_PRIORITY - "base_priority" - - - - - WIN32_INFO_DEPENDENCIES - "dependencies" - - - - - WIN32_INFO_RECOVERY_DELAY - "recovery_delay" - - - - - WIN32_INFO_RECOVERY_ACTION_1 - "recovery_action_1" - - - - - WIN32_INFO_RECOVERY_ACTION_2 - "recovery_action_2" - - - - - WIN32_INFO_RECOVERY_ACTION_3 - "recovery_action_3" - - - - - WIN32_INFO_RECOVERY_RESET_PERIOD - "recovery_reset_period" - - - - - WIN32_INFO_RECOVERY_ENABLED - "recovery_enabled" - - - - - WIN32_INFO_RECOVERY_REBOOT_MSG - "recovery_reboot_msg" - - - - - WIN32_INFO_RECOVERY_COMMAND - "recovery_command" - - - - - -
    - - - Permisos de Servicio Win32 - - - - Constante - Valor - Descripción - - - - - WIN32_SERVICE_ALL_ACCESS - 0x000F003F - - - - - WIN32_SERVICE_CHANGE_CONFIG - 0x00000002 - - - - - WIN32_SERVICE_ENUMERATE_DEPENDENTS - 0x00000008 - - - - - WIN32_SERVICE_INTERROGATE - 0x00000080 - - - - - WIN32_SERVICE_PAUSE_CONTINUE - 0x00000040 - - - - - WIN32_SERVICE_QUERY_CONFIG - 0x00000001 - - - - - WIN32_SERVICE_QUERY_STATUS - 0x00000004 - - - - - WIN32_SERVICE_START - 0x00000010 - - - - - WIN32_SERVICE_STOP - 0x00000020 - - - - - WIN32_SERVICE_USER_DEFINED_CONTROL - 0x00000100 - - - - - WIN32_ACCESS_SYSTEM_SECURITY - 0x00001000 - - - - - WIN32_DELETE - 0x00010000 - - - - - WIN32_READ_CONTROL - 0x00020000 - - - - - WIN32_WRITE_DAC - 0x00040000 - - - - - WIN32_WRITE_OWNER - 0x00080000 - - - - - WIN32_GENERIC_READ - Incluye los permisos: - WIN32_STANDARD_RIGHTS_READ, - WIN32_SERVICE_QUERY_CONFIG, - WIN32_SERVICE_QUERY_STATUS, - WIN32_SERVICE_INTERROGATE, - WIN32_SERVICE_ENUMERATE_DEPENDENTS - - - - - - WIN32_GENERIC_WRITE - Incluye los permisos: - WIN32_STANDARD_RIGHTS_WRITE, - WIN32_SERVICE_CHANGE_CONFIG - - - - - - WIN32_GENERIC_EXECUTE - Incluye los permisos: - WIN32_STANDARD_RIGHTS_EXECUTE, - WIN32_SERVICE_START, - WIN32_SERVICE_STOP, - WIN32_SERVICE_PAUSE_CONTINUE, - WIN32_SERVICE_USER_DEFINED_CONTROL - - - - - - -
    -
    - - diff --git a/reference/win32service/examples.xml b/reference/win32service/examples.xml deleted file mode 100644 index eb79996bb7..0000000000 --- a/reference/win32service/examples.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - &reftitle.examples; - - - Registrar un script PHP para ejecutar como servicio - - 'dummyphp', # nombre del servicio - 'display' => 'sample dummy PHP service', # descripción corta - 'description' => 'This is a dummy Windows service created using PHP.', # descripción larga - 'params' => '"' . __FILE__ . '" run', # ruta hacia el script y argumentos -)); -?> -]]> - - - - - - Eliminar un servicio - - -]]> - - - - - - Ejecutar un servicio - - -]]> - - - - - - diff --git a/reference/win32service/functions/win32-add-right-access-service.xml b/reference/win32service/functions/win32-add-right-access-service.xml deleted file mode 100644 index a0152dd8c0..0000000000 --- a/reference/win32service/functions/win32-add-right-access-service.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - win32_add_right_access_service - Añade los derechos de acceso para un usuario al servicio - - - - &reftitle.description; - - voidwin32_add_right_access_service - stringservicename - stringusername - intright - stringmachine&null; - - - Añade los derechos de acceso para username en el servicio servicename. - Se requieren privilegios administrativos para que esto tenga éxito. - - - - - &reftitle.parameters; - - - - servicename - - - El nombre del servicio al que se añadirán los derechos de acceso. - - - - - username - - - Se añaden los derechos de acceso para username. - - - - - right - - - Los derechos autorizados para username. - Las constantes se utilizan para definir este valor. - - - - - machine - - - El nombre opcional de la máquina en la que se desea crear un servicio. - Si se omite, se utilizará la máquina local. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto Win32Service\RightInfo. - - - - - &reftitle.errors; - - Se lanzará una ValueError si el valor del parámetro service está vacío. - - - Se lanzará una ValueError si el valor del parámetro username está vacío. - - - Se lanzará una Win32ServiceException en caso de error. - - - - - &reftitle.seealso; - - - win32_read_all_rights_access_service - win32_read_rights_access_service - win32_remove_right_access_service - Constantes de permisos Win32 - - - - - - - diff --git a/reference/win32service/functions/win32-add-service-env-var.xml b/reference/win32service/functions/win32-add-service-env-var.xml deleted file mode 100644 index b4bd87fc79..0000000000 --- a/reference/win32service/functions/win32-add-service-env-var.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - win32_add_service_env_var - Añade una variable de entorno personalizada al servicio - - - - &reftitle.description; - - voidwin32_add_service_env_var - stringservicename - stringvarname - stringvalue - - - Añade una variable de entorno personalizada varname al servicio servicename. - Esta función solo funciona para la máquina local. Se requieren privilegios administrativos para que esto tenga éxito. - - - - - &reftitle.parameters; - - - - servicename - - - El nombre del servicio al que se añadirá la variable de entorno. - - - - - varname - - - El nombre de la variable de entorno. - - - - - value - - - El valor de la variable de entorno. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Se lanzará una ValueError si el - valor del parámetro service está vacío. - - - Se lanzará una ValueError si el - valor del parámetro varname está vacío. - - - Se lanzará una Win32ServiceException en caso de error. - - - - - &reftitle.seealso; - - - win32_get_service_env_vars - win32_remove_service_env_var - - - - - - - diff --git a/reference/win32service/functions/win32-continue-service.xml b/reference/win32service/functions/win32-continue-service.xml deleted file mode 100644 index ee7a3e9c3d..0000000000 --- a/reference/win32service/functions/win32-continue-service.xml +++ /dev/null @@ -1,147 +0,0 @@ - - - - - - - win32_continue_service - Reanuda un servicio en pausa - - - &reftitle.description; - - voidwin32_continue_service - stringservicename - stringmachine&null; - - - Reanuda un servicio en pausa. Se requieren privilegios de administrador o - una cuenta con los derechos adecuados definidos en el ACL del servicio. - - - - &reftitle.parameters; - - - - servicename - - - El nombre corto del servicio. - - - - - machine - - - Nombre de la máquina (opcional). Si se omite, se utilizará la máquina local. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - Antes de la versión 1.0.0, &win32service.noerror.false.error; - - - - - &reftitle.errors; - - Se lanzará una ValueError si el valor del parámetro - servicename está vacío. - - - Se lanzará una Win32ServiceException en caso de error. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Lanzará una ValueError si un parámetro es inválido, - antes se devolvía &false;. - - - - PECL win32service 1.0.0 - - Lanzará una Win32ServiceException en caso de error, - antes se devolvía un - Código de error Win32. - - - - PECL win32service 1.0.0 - - El tipo de retorno es ahora void, antes era mixed. - - - - PECL win32service 0.3.0 - - Esta función ya no requiere una cuenta de administrador si el ACL - está definido para otra cuenta. - - - - - - - - - - &reftitle.seealso; - - - win32_start_service - win32_stop_service - win32_pause_service - win32_send_custom_control - Los códigos de error Win32 - - - - - - - diff --git a/reference/win32service/functions/win32-create-service.xml b/reference/win32service/functions/win32-create-service.xml deleted file mode 100644 index 20c720945f..0000000000 --- a/reference/win32service/functions/win32-create-service.xml +++ /dev/null @@ -1,509 +0,0 @@ - - - - - - - win32_create_service - Crea una nueva entrada para servicio en la base de datos SCM - - - - &reftitle.description; - - voidwin32_create_service - arraydetails - stringmachine&null; - - - Intenta añadir un servicio en la base de datos SCM. Se necesitan privilegios - de administrador para que esto tenga éxito. - - - - - &reftitle.parameters; - - - - details - - - Un array de detalles del servicio: - - - service - - - El nombre corto del servicio. Este es el nombre que se utilizará - para controlar el servicio utilizando el comando - net. El servicio debe ser único (dos servicios - no pueden compartir el mismo nombre), e idealmente, debería evitar - tener espacios en su nombre. - - - - - display - - El nombre de visualización del servicio. Este es el nombre que se verá - en la Applet Servicios. - - - - - description - - - La descripción larga del servicio. - Esta es la descripción que se verá en la Applet de Servicios. - - - - - user - - - El nombre de usuario bajo el cual se desea que el servicio se ejecute. Si se omite, el servicio funcionará como - LocalSystem. Si se especifica el nombre de usuario, también se debe proporcionar una contraseña. - - - - - password - - - La contraseña que corresponde a user. - - - - - path - - - La ruta completa al módulo ejecutable que se iniciará cuando el - servicio se inicie. Si se omite, se utilizará la ruta del proceso actual de - PHP. - - - - - params - - - Argumentos de comando a pasar al servicio cuando se inicie. - Si se desea ejecutar un script PHP como servicio, entonces - el primer argumento debería ser la ruta completa al script PHP - que se planea ejecutar. Si el nombre del script o la ruta - contienen espacios, entonces, rodee la ruta completa del script - PHP con " - - - - - load_order - - - Controla el load_order. Esto aún no está completamente soportado. - - - - - svc_type - - - Establece el tipo de servicio. Si se omite, el valor por omisión es - WIN32_SERVICE_WIN32_OWN_PROCESS. No se debe cambiar esto a menos que se sepa realmente lo que se está haciendo. - - - - - start_type - - - Especifica cómo debe iniciarse el servicio. El valor por omisión es WIN32_SERVIDE_AUTO_START lo que significa que el servicio se iniciará cuando la máquina se inicie. - - - - - error_control - - - Informa al SCM sobre qué hacer cuando detecte un problema con el servicio. El valor por omisión es - WIN32_SERVER_ERROR_IGNORE. Cambiar este valor aún no está completamente soportado. - - - - - delayed_start - - - Si delayed_start está establecido a - &true;, entonces informará al SCM que este servicio debe iniciarse después de los servicios iniciados automáticamente y un cierto retraso. - - - Cualquier servicio puede ser marcado como un servicio retrasado después del inicio automático; sin embargo, esta configuración no tiene ningún efecto mientras el parámetro start_type - del servicio valga WIN32_SERVICE_AUTO_START. - - - Esta configuración solo se aplica en Windows Vista y servidores Windows 2008 y posteriores. - - - - - base_priority - - - Para reducir el impacto en el uso del procesador, puede ser necesario establecer una prioridad más baja que la normal. - - - El parámetro base_priority puede ser establecido a - una de las constantes definidas en las - clases de baja prioridad Win32. - - - - - dependencies - - - Para definir las dependencias del servicio, es necesario establecer este parámetro con la lista de nombres de servicios en un array. - - - - - recovery_delay - - - Este parámetro define el retraso entre el fallo y la ejecución de - la acción de recuperación. El valor es en milisegundos. - - - El valor por omisión es 60000. - - - - - recovery_action_1 - - - La acción que se ejecutará en caso de la primera falla. La acción por omisión es WIN32_SC_ACTION_NONE. - - - El parámetro recovery_action_1 puede ser establecido - con una de las constantes definidas en las - Acciones de recuperación Win32. - - - - - recovery_action_2 - - - La acción que se ejecutará en caso de la segunda falla. La acción por omisión es WIN32_SC_ACTION_NONE. - - - El parámetro recovery_action_2 puede ser establecido - con una de las constantes definidas en las - Acciones de recuperación Win32. - - - - - recovery_action_3 - - - La acción que se ejecutará en caso de fallas subsiguientes. La acción por omisión es WIN32_SC_ACTION_NONE. - - - El parámetro recovery_action_3 puede ser establecido - con una de las constantes definidas en las - Acciones de recuperación Win32. - - - - - recovery_reset_period - - - El contador de fallas se reiniciará después del retraso definido - en este parámetro. El retraso se expresa en segundos. - - - El valor por omisión es 86400. - - - - - recovery_enabled - - - Establecer este parámetro a &true; para habilitar las opciones de recuperación, y &false; - para deshabilitarlas. - - - El valor por omisión es &false; - - - - - recovery_reboot_msg - - - Añadir este parámetro para definir el mensaje registrado en el registro - de eventos de Windows antes del reinicio. Solo se utiliza si una - de las acciones está definida a - WIN32_SC_ACTION_REBOOT. - - - - - recovery_command - - - Añadir este parámetro para definir el comando a ejecutar cuando una - acción está definida a - WIN32_SC_ACTION_RUN_COMMAND. - - - - - - - - - machine - - - El nombre opcional de la máquina en la que se desea crear el servicio. - Si se omite, se utilizará la máquina local. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - Antes de la versión 1.0.0, &win32service.noerror.false.error; - - - - - &reftitle.errors; - - Se lanzará una ValueError si el valor del parámetro - service está vacío. - - - Se lanzará una ValueError si el valor del parámetro - path está omitido o vacío. - - - Se lanzará una ValueError si el valor del parámetro - svc_type es incorrecto. - - - Se lanzará una ValueError si el valor del parámetro - start_type es incorrecto. - - - Se lanzará una ValueError si el valor del parámetro - error_control es incorrecto. - - - Se lanzará una ValueError si el valor del parámetro - base_priority es incorrecto. - - - Se lanzará una ValueError si el valor del parámetro - recovery_delay no está entre - 0 y PHP_INT_MAX. - - - Se lanzará una ValueError si el valor del parámetro - recovery_action_1 es incorrecto. - - - Se lanzará una ValueError si el valor del parámetro - recovery_action_2 es incorrecto. - - - Se lanzará una ValueError si el valor del parámetro - recovery_action_3 es incorrecto. - - - Se lanzará una ValueError si el valor del parámetro - recovery_reset_period no está entre - 0 y PHP_INT_MAX. - - - Se lanzará una Win32ServiceException en caso de error. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Se lanzará una ValueError si un parámetro es inválido, - antes &false; era devuelto. - - - - PECL win32service 1.0.0 - - Se lanzará una Win32ServiceException en caso de error, - antes un - Código de error Win32 - era devuelto. - - - - PECL win32service 1.0.0 - - El tipo de retorno ahora es void, antes era mixed. - - - - PECL win32service 0.4.0 - - Los parámetros dependencies, recovery_delay, - recovery_action_1, recovery_action_2, - recovery_action_3, recovery_reset_period, - recovery_enabled, recovery_reboot_msg - y recovery_command han sido añadidos. - - - - - - - - - - &reftitle.examples; - - - Ejemplo con <function>win32_create_service</function> - - Crea un servicio cuyo nombre corto es 'dummyphp'. - - - 'dummyphp', // el nombre del servicio - 'display' => 'ejemplo de servicio PHP ficticio', // la descripción corta - 'description' => 'Este es un servicio Windows creado utilizando PHP', // la descripción larga - 'params' => '"' . __FILE__ . '" run', // ruta al script así como los argumentos -)); -debug_zval_dump(\$x); -?> -]]> - - - - - - Un ejemplo <function>win32_create_service</function> con dependencias - - Crea un servicio cuyo nombre corto es 'dummyphp' con dependencias. - - - 'dummyphp', // El nombre del servicio - 'display' => 'ejemplo de servicio PHP ficticio', // Una descripción corta - 'description' => 'Este es un servicio Windows creado utilizando PHP.', // Una descripción larga - 'params' => '"' . __FILE__ . '" run', // ruta al script así como los argumentos - 'dependencies' => array("Netman"), // La lista de dependencias -)); -debug_zval_dump(\$x); -?> -]]> - - - - - - Ejemplo de <function>win32_create_service</function> con opciones de recuperación - - Crea un servicio cuyo nombre corto es 'dummyphp' con opciones de recuperación. - - - 'dummyphp', // El nombre del servicio - 'display' => 'ejemplo de servicio PHP ficticio', // Una descripción corta - 'description' => 'Este es un servicio Windows creado utilizando PHP.', // Una descripción larga - 'params' => '"' . __FILE__ . '" run', // ruta al script así como los argumentos - 'recovery_delay' => 120000, // Las acciones de recuperación se ejecutarán después de 2 minutos - 'recovery_action_1' => WIN32_SC_ACTION_RESTART, // Primera falla, reiniciar el servicio - 'recovery_action_2' => WIN32_SC_ACTION_RUN_COMMAND, // Segunda falla, ejecutar un comando - 'recovery_action_3' => WIN32_SC_ACTION_NONE, // Fallas subsiguientes, no hacer nada - 'recovery_reset_period' => 86400, // Reiniciar el contador de fallas después de 1 día (86400 minutos) - 'recovery_enabled' => true, // Habilitar las opciones de recuperación - 'recovery_reboot_msg' => null, // No definir un mensaje de reinicio, no es útil. - 'recovery_command' => "c:\clean-service.bat", // Cuando la acción es WIN32_SC_ACTION_RUN_COMMAND, ejecutar este comando. -)); -debug_zval_dump(\$x); -?> -]]> - - - - - - - &reftitle.seealso; - - - win32_delete_service - Las clases de baja prioridad Win32 - Las acciones de recuperación Win32 - Los códigos de error Win32 - - - - - - - diff --git a/reference/win32service/functions/win32-delete-service.xml b/reference/win32service/functions/win32-delete-service.xml deleted file mode 100644 index 9a229884a4..0000000000 --- a/reference/win32service/functions/win32-delete-service.xml +++ /dev/null @@ -1,165 +0,0 @@ - - - - - - - win32_delete_service - Elimina una entrada de servicio de la base de datos SCM - - - &reftitle.description; - - voidwin32_delete_service - stringservicename - stringmachine&null; - - - Intenta eliminar un servicio de la base de datos SCM. Los privilegios - de administrador son necesarios para que esta función tenga éxito. - - - Esta función solo marca el servicio para eliminación. Si otros - procesos (como el Applet Services) están abiertos, entonces la eliminación será - pospuesta hasta que estas aplicaciones se cierren. Si un servicio está marcado para eliminación, otros intentos de eliminación fallarán y los intentos de crear un nuevo servicio con ese nombre también fallarán. - - - - - &reftitle.parameters; - - - - servicename - - - El nombre corto del servicio. - - - - - machine - - - El nombre opcional de la máquina. - Si se omite, se utilizará la máquina local. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - Antes de la versión 1.0.0, &win32service.noerror.false.error; - - - - - &reftitle.errors; - - Se lanzará una ValueError si el valor del argumento - servicename está vacío. - - - - Se lanzará una Win32ServiceException en caso de error. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Lanzará una ValueError si un argumento es inválido, - antes &false; era retornado. - - - - PECL win32service 1.0.0 - - Lanzará una Win32ServiceException en caso de error, - antes un - Código de error Win32 - era retornado. - - - - PECL win32service 1.0.0 - - El tipo de retorno es ahora void, antes era mixed. - - - - - - - - - - &reftitle.examples; - - - Ejemplo con <function>win32_delete_service</function> - - Elimina el servicio dummyphp. - - - -]]> - - - - - - - &reftitle.seealso; - - - win32_create_service - Los códigos de error Win32 - - - - - - - diff --git a/reference/win32service/functions/win32-get-last-control-message.xml b/reference/win32service/functions/win32-get-last-control-message.xml deleted file mode 100644 index 896339d11a..0000000000 --- a/reference/win32service/functions/win32-get-last-control-message.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - - win32_get_last_control_message - Devuelve el último mensaje de control que ha sido enviado a este servicio - - - &reftitle.description; - - intwin32_get_last_control_message - - - - Devuelve el código de control que ha sido enviado por última vez a este proceso de - servicio. Cuando funciona como servicio, debe verificar periódicamente para determinar si el servicio debe ser detenido. - - - - - Desde la versión 0.2.0, esta función solo funciona en línea de - comandos ("cli" SAPI). Está deshabilitada en otros casos. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una constante de control que será una de - las - constantes de control de mensajes de servicio Win32Service : - WIN32_SERVICE_CONTROL_CONTINUE, - WIN32_SERVICE_CONTROL_DEVICEEVENT, - WIN32_SERVICE_CONTROL_HARDWAREPROFILECHANGE, - WIN32_SERVICE_CONTROL_INTERROGATE, - WIN32_SERVICE_CONTROL_NETBINDADD, - WIN32_SERVICE_CONTROL_NETBINDDISABLE, - WIN32_SERVICE_CONTROL_NETBINDENABLE, - WIN32_SERVICE_CONTROL_NETBINDREMOVE, - WIN32_SERVICE_CONTROL_PARAMCHANGE, - WIN32_SERVICE_CONTROL_PAUSE, - WIN32_SERVICE_CONTROL_POWEREVENT, - WIN32_SERVICE_CONTROL_PRESHUTDOWN, - WIN32_SERVICE_CONTROL_SESSIONCHANGE, - WIN32_SERVICE_CONTROL_SHUTDOWN, - WIN32_SERVICE_CONTROL_STOP. - - - Si el valor está entre 128 y 255, el código de control es personalizado. - - - - - &reftitle.errors; - - Antes de la versión 1.0.0, si esta función se utiliza fuera del SAPI "cli", se emitirá - un error E_ERROR. - - - A partir de la versión 1.0.0, lanzará una - Win32ServiceException si el SAPI no es - "cli" - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Lanzará una ValueError si un argumento es inválido, - antes &false; era retornado. - - - - PECL win32service 1.0.0 - - Lanzará una Win32ServiceException en caso de error, - antes un - Código de error Win32 - era retornado. - - - - PECL win32service 0.2.0 - - Esta función solo funciona en el SAPI "cli". - - - - - - - - - - &reftitle.seealso; - - - win32_start_service_ctrl_dispatcher - win32_set_service_status - win32_set_service_exit_mode - win32_set_service_exit_code - las constantes de control de mensajes de servicio Win32Service - - - - - - diff --git a/reference/win32service/functions/win32-get-service-env-vars.xml b/reference/win32service/functions/win32-get-service-env-vars.xml deleted file mode 100644 index 757f75cc55..0000000000 --- a/reference/win32service/functions/win32-get-service-env-vars.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - win32_get_service_env_vars - Lee todas las variables de entorno personalizadas del servicio - - - - &reftitle.description; - - arraywin32_get_service_env_vars - stringservicename - - - Lee todas las variables de entorno personalizadas del servicio servicename. - Esta función solo funciona para la máquina local. Los privilegios administrativos son necesarios para que esto tenga éxito. - - - - - &reftitle.parameters; - - - - servicename - - - El nombre del servicio para leer las variables de entorno. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un &array; con el nombre de la variable como clave y el valor de la variable como valor. - - - - - &reftitle.errors; - - Se lanzará una ValueError si el valor del argumento - service está vacío. - - - Se lanzará una Win32ServiceException en caso de error. - - - - - &reftitle.seealso; - - - win32_add_service_env_var - win32_remove_service_env_var - - - - - - - diff --git a/reference/win32service/functions/win32-pause-service.xml b/reference/win32service/functions/win32-pause-service.xml deleted file mode 100644 index ee31581492..0000000000 --- a/reference/win32service/functions/win32-pause-service.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - - - win32_pause_service - Pone en pausa un servicio - - - &reftitle.description; - - voidwin32_pause_service - stringservicename - stringmachine&null; - - - Pone en pausa un servicio. Se requieren privilegios de administrador o - una cuenta con los derechos adecuados definidos en la ACL del servicio. - - - - &reftitle.parameters; - - - - servicename - - - El nombre corto del servicio. - - - - - machine - - - Nombre de la máquina (opcional). Si se omite, se utilizará la máquina local. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - Antes de la versión 1.0.0, &win32service.noerror.false.error; - - - - - &reftitle.errors; - - Se lanzará una ValueError si el valor del argumento - servicename está vacío. - - - - Se lanzará una Win32ServiceException en caso de error. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Lanzará una ValueError si un argumento es inválido, - antes &false; era retornado. - - - - PECL win32service 1.0.0 - - Lanzará una Win32ServiceException en caso de error, - antes un - Código de error Win32 - era retornado. - - - - PECL win32service 1.0.0 - - El tipo de retorno es ahora void, antes era mixed. - - - - PECL win32service 0.3.0 - - Esta función ya no requiere una cuenta de administrador si la ACL - está definida para otra cuenta. - - - - - - - - - - &reftitle.seealso; - - - win32_start_service - win32_stop_service - win32_continue_service - win32_send_custom_control - Los códigos de error Win32 - - - - - - - diff --git a/reference/win32service/functions/win32-query-service-status.xml b/reference/win32service/functions/win32-query-service-status.xml deleted file mode 100644 index 2bfb3453c7..0000000000 --- a/reference/win32service/functions/win32-query-service-status.xml +++ /dev/null @@ -1,233 +0,0 @@ - - - - - - - - win32_query_service_status - Consulta el estado de un servicio - - - &reftitle.description; - - arraywin32_query_service_status - stringservicename - stringmachine&null; - - - Consulta el estado actual de un servicio, devolviendo un array - de información. - - - - - &reftitle.parameters; - - - - servicename - - - El nombre corto del servicio. - - - - - machine - - - El nombre opcional de la máquina. - Si se omite, se utilizará la máquina local. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un array que contiene la siguiente información - en caso de éxito. - - - Antes de la versión 1.0.0&win32service.false.error; - - - - - ServiceType - - - El dwServiceType. Consulte las - máscaras de tipo de - servicio Win32Service. - - - - - CurrentState - - - El dwCurrentState. Consulte las - constantes de estado - de los servicios Win32Service. - - - - - ControlsAccepted - - - Qué controles de servicio son aceptados por el servicio. Consulte - las máscaras - aceptadas para los mensajes de control de servicio Win32Service. - - - - - Win32ExitCode - - - Si el servicio termina, el código de retorno del proceso. Este valor es igual - a WIN32_ERROR_SERVICE_SPECIFIC_ERROR si el modo de salida no es - correcto. Consulte - códigos de error Win32Service - y win32_set_service_exit_mode. - - - - - ServiceSpecificExitCode - - - Si el servicio termina con una condición de error, el código específico del - servicio que se registrará en el registro de eventos es visible aquí. - Este valor es igual al valor definido por - win32_set_service_exit_code. - - - - - CheckPoint - - - Si el servicio se detiene, mantiene el número actual de punto de control. - Esto es utilizado por SCM como una especie de latido para detectar un proceso de - servicio detenido. El valor del punto de control se interpreta mejor en - conjunción con el valor WaitHint. - - - - - WaitHint - - - Si el servicio se detiene, establecerá un WaitHint a un valor de punto de - control que indique la ejecución al 100%. Esto puede ser utilizado para - implementar una barra de progreso. - - - - - ProcessId - - - El identificador de proceso de ventana. Si es 0, el proceso no está en ejecución. - - - - - ServiceFlags - - - El dwServiceFlags. Consulte las - constantes - utilizadas para las banderas de los servicios Win32Service. - - - - - - - - - &reftitle.errors; - - Se lanzará una ValueError si el valor del argumento - servicename está vacío. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Lanzará una ValueError si un argumento es inválido, - antes &false; era retornado. - - - - PECL win32service 1.0.0 - - Lanzará una Win32ServiceException en caso de error, - antes un - Código de error Win32 - era retornado. - - - - PECL win32service 1.0.0 - - El tipo de retorno es ahora array, antes era mixed. - - - - - - - - - - &reftitle.seealso; - - - Las constantes Win32Service predefinidas - - - - - - diff --git a/reference/win32service/functions/win32-read-all-rights-access-service.xml b/reference/win32service/functions/win32-read-all-rights-access-service.xml deleted file mode 100644 index a13278d590..0000000000 --- a/reference/win32service/functions/win32-read-all-rights-access-service.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - win32_read_all_rights_access_service - Lee todos los derechos de acceso al servicio - - - - &reftitle.description; - - arraywin32_read_all_rights_access_service - stringservicename - stringmachine&null; - - - Lee todos los derechos de acceso al servicio servicename. - Se requieren privilegios administrativos para que esto tenga éxito. - - - - - &reftitle.parameters; - - - - servicename - - - El nombre del servicio para leer los derechos de acceso. - - - - - machine - - - El nombre opcional de la máquina en la que se desea crear un servicio. - Si se omite, se utilizará la máquina local. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un &array; de Win32Service\RightInfo - - - - - &reftitle.errors; - - Se lanzará una ValueError si el valor del argumento - service está vacío. - - - Se lanzará una Win32ServiceException en caso de error. - - - - - &reftitle.seealso; - - - win32_read_rights_access_service - win32_add_right_access_service - win32_remove_right_access_service - Constantes de permisos Win32 - - - - - - - diff --git a/reference/win32service/functions/win32-read-right-access-service.xml b/reference/win32service/functions/win32-read-right-access-service.xml deleted file mode 100644 index 04f82319cd..0000000000 --- a/reference/win32service/functions/win32-read-right-access-service.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - win32_read_right_access_service - Lee los derechos de acceso al servicio para un usuario - - - - &reftitle.description; - - Win32Service\RightInfowin32_read_right_access_service - stringservicename - stringusername - stringmachine&null; - - - Lee los derechos de acceso para username en el servicio servicename. - Se requieren privilegios administrativos para que esto tenga éxito. - - - - - &reftitle.parameters; - - - - servicename - - - El nombre del servicio para leer los derechos de acceso. - - - - - username - - - Lee los derechos de acceso para username - - - - - machine - - - El nombre opcional de la máquina en la que se desea crear un servicio. - Si se omite, se utilizará la máquina local. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto Win32Service\RightInfo. - - - - - &reftitle.errors; - - Se lanzará una ValueError si el valor del argumento - service está vacío. - - - Se lanzará una ValueError si el valor del argumento - username está vacío. - - - Se lanzará una Win32ServiceException en caso de error. - - - - - &reftitle.seealso; - - - win32_read_all_rights_access_service - win32_add_right_access_service - win32_remove_right_access_service - Constantes de permisos Win32 - - - - - - - diff --git a/reference/win32service/functions/win32-remove-right-access-service.xml b/reference/win32service/functions/win32-remove-right-access-service.xml deleted file mode 100644 index 13f1829a1d..0000000000 --- a/reference/win32service/functions/win32-remove-right-access-service.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - win32_remove_right_access_service - Elimina los derechos de acceso para un usuario en el servicio - - - - &reftitle.description; - - voidwin32_remove_right_access_service - stringservicename - stringusername - stringmachine&null; - - - Elimina los derechos de acceso para username en el servicio servicename. - Se requieren privilegios administrativos para que esto tenga éxito. - - - - - &reftitle.parameters; - - - - servicename - - - El nombre del servicio del que se eliminan los derechos de acceso. - - - - - username - - - Elimina los derechos de acceso para username. - - - - - machine - - - El nombre opcional de la máquina en la que se desea crear un servicio. - Si se omite, se utilizará la máquina local. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Se lanzará una ValueError si el valor del argumento - service está vacío. - - - Se lanzará una ValueError si el valor del argumento - username está vacío. - - - Se lanzará una Win32ServiceException en caso de error. - - - - - &reftitle.seealso; - - - win32_read_all_rights_access_service - win32_read_rights_access_service - win32_add_right_access_service - - - - - - - diff --git a/reference/win32service/functions/win32-remove-service-env-var.xml b/reference/win32service/functions/win32-remove-service-env-var.xml deleted file mode 100644 index e9b8dea6bb..0000000000 --- a/reference/win32service/functions/win32-remove-service-env-var.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - win32_remove_service_env_var - Elimina una variable de entorno personalizada del servicio - - - - &reftitle.description; - - voidwin32_remove_service_env_var - stringservicename - stringvarname - - - Elimina una variable de entorno personalizada varname del servicio servicename. - Esta función solo funciona para la máquina local. Se requieren privilegios administrativos para que esto tenga éxito. - - - - - &reftitle.parameters; - - - - servicename - - - El nombre del servicio del que se eliminará la variable de entorno. - - - - - varname - - - El nombre de la variable de entorno. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Se lanzará una ValueError si el valor del argumento - service está vacío. - - - Se lanzará una ValueError si el valor del argumento - varname está vacío. - - - Se lanzará una Win32ServiceException en caso de error. - - - - - &reftitle.seealso; - - - win32_get_service_env_vars - win32_add_service_env_var - - - - - - - diff --git a/reference/win32service/functions/win32-send-custom-control.xml b/reference/win32service/functions/win32-send-custom-control.xml deleted file mode 100644 index 11883911b8..0000000000 --- a/reference/win32service/functions/win32-send-custom-control.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - - - win32_send_custom_control - Envía un control personalizado al servicio - - - - &reftitle.description; - - voidwin32_send_custom_control - stringservicename - intcontrol - stringmachine&null; - - - Consulte Microsoft ControlService function para más detalles. - - - - - &reftitle.parameters; - - - servicename - - - El nombre corto del servicio. - - - - - control - - - El valor de control personalizado entre 128 y 255. - - - - - machine - - - Nombre de la máquina opcional. Si se omite, se utilizará la máquina local. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - Antes de la versión 1.0.0, &win32service.noerror.false.error; - - - - - &reftitle.errors; - - Antes de la versión 1.0.0, si el valor de control no está entre 128 y 255, esta función emite - un error de nivel E_ERROR. - - - - Se lanzará una ValueError si el valor del argumento - servicename está vacío. - - - Se lanzará una ValueError si el valor del argumento - control no está entre 128 y 255. - - - Se lanzará una Win32ServiceException en caso de error. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Lanzará una ValueError si un argumento es inválido, - antes &false; era retornado. - - - - PECL win32service 1.0.0 - - Lanzará una Win32ServiceException en caso de error, - antes un - Código de error Win32 - era retornado. - - - - PECL win32service 1.0.0 - - El tipo de retorno es ahora void, antes era mixed. - - - - - - - - - - &reftitle.seealso; - - win32_start_service - win32_stop_service - win32_pause_service - win32_continue_service - Códigos de error Win32 - - - - - - diff --git a/reference/win32service/functions/win32-set-service-exit-code.xml b/reference/win32service/functions/win32-set-service-exit-code.xml deleted file mode 100644 index 3f1a0b0aa8..0000000000 --- a/reference/win32service/functions/win32-set-service-exit-code.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - - win32_set_service_exit_code - Define o devuelve el código de salida para el servicio en ejecución - - - - &reftitle.description; - - intwin32_set_service_exit_code - intexitCode1 - - - Cambia o devuelve el código de salida. El código de salida se utiliza únicamente - si el modo de salida no es correcto. - Si el valor no es cero, la configuración de recuperación puede ser utilizada - después del fallo del servicio. Consulte los - códigos de error del sistema Microsoft para más detalles. - - - - - Esta función solo funciona en el SAPI "cli". En otros SAPI, esta - función está deshabilitada. - - - - - - &reftitle.parameters; - - - exitCode - - - El código de retorno utilizado a la salida. - - - - - - - - &reftitle.returnvalues; - - Devuelve el código de salida actual o el anterior. - - - - - &reftitle.errors; - - Antes de la versión 1.0.0, si esta función se utiliza fuera del SAPI "cli", se emitirá - un error E_ERROR. - - - A partir de la versión 1.0.0, lanzará una - Win32ServiceException si el SAPI no es - "cli" - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Lanzará una ValueError si un argumento es inválido, - antes &false; era retornado. - - - - PECL win32service 1.0.0 - - Lanzará una Win32ServiceException en caso de error, - antes un - Código de error Win32 - era retornado. - - - - - - - - - - &reftitle.seealso; - - win32_start_service_ctrl_dispatcher - win32_set_service_status - win32_set_service_exit_mode - - - - - - diff --git a/reference/win32service/functions/win32-set-service-exit-mode.xml b/reference/win32service/functions/win32-set-service-exit-mode.xml deleted file mode 100644 index e7a4d9f099..0000000000 --- a/reference/win32service/functions/win32-set-service-exit-mode.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - - - win32_set_service_exit_mode - Define o devuelve el modo de salida para el servicio en ejecución - - - - &reftitle.description; - - boolwin32_set_service_exit_mode - boolgracefulModetrue - - - Si se proporciona el argumento gracefulMode, se modifica el modo de - salida. Cuando el modo de salida no es correcto, el código de salida utilizado puede ser definido con la función - win32_set_service_exit_code. - - - - - Esta función solo funciona en el SAPI "cli". En otros SAPI, esta - función está deshabilitada. - - - - - - &reftitle.parameters; - - - gracefulMode - - - &true; para la salida correcta. &false; para la salida con error. - - - - - - - - &reftitle.returnvalues; - - Devuelve el modo de salida actual o anterior. - - - - - &reftitle.errors; - - Antes de la versión 1.0.0, si esta función se utiliza fuera del SAPI "cli", se emitirá - un error E_ERROR. - - - A partir de la versión 1.0.0, lanzará una - Win32ServiceException si el SAPI no es - "cli" - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Lanzará una ValueError si un argumento es inválido, - antes &false; era retornado. - - - - PECL win32service 1.0.0 - - Lanzará una Win32ServiceException en caso de error, - antes un - Código de error Win32 - era retornado. - - - - - - - - - - &reftitle.seealso; - - win32_start_service_ctrl_dispatcher - win32_set_service_status - win32_set_service_exit_code - - - - - - diff --git a/reference/win32service/functions/win32-set-service-pause-resume-state.xml b/reference/win32service/functions/win32-set-service-pause-resume-state.xml deleted file mode 100644 index 31b24b9d0f..0000000000 --- a/reference/win32service/functions/win32-set-service-pause-resume-state.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - win32_set_service_pause_resume_state - Define o devuelve la capacidad de pausa/reanudación para el servicio en ejecución - - - - &reftitle.description; - - boolwin32_set_service_pause_resume_state - boolstatetrue - - - Si se proporciona el argumento state, se modifica la capacidad de pausa/reanudación. - - - - - Esta función solo funciona en el SAPI "cli" y en el contexto de ejecución del servicio de Windows. En otros SAPI, - esta función está deshabilitada. - - - - - - &reftitle.parameters; - - - state - - - &true; para habilitar la capacidad de pausa/reanudación del servicio. &false; para deshabilitar la capacidad de pausa/reanudación del servicio. - - - - - - - - &reftitle.returnvalues; - - Devuelve el estado actual o anterior de la capacidad de pausa/reanudación. - - - - - &reftitle.errors; - - A partir de la versión 1.0.0, si el SAPI no es "cli", esta función emite un error de nivel - E_ERROR. - - - - Desde la versión 1.0.0, lanzará una - Win32ServiceException si el SAPI no es - "cli" - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Lanzará una ValueError sobre datos inválidos en los argumentos, - anteriormente &false; era retornado. - - - - PECL win32service 1.0.0 - - Lanzará una Win32ServiceException en caso de error, - anteriormente un - código de error Win32 - era retornado. - - - - - - - - - - &reftitle.seealso; - - win32_start_service_ctrl_dispatcher - win32_set_service_status - win32_set_service_exit_code - - - - - - diff --git a/reference/win32service/functions/win32-set-service-status.xml b/reference/win32service/functions/win32-set-service-status.xml deleted file mode 100644 index 064267a110..0000000000 --- a/reference/win32service/functions/win32-set-service-status.xml +++ /dev/null @@ -1,177 +0,0 @@ - - - - - - - - win32_set_service_status - Actualiza el estado de un servicio - - - - &reftitle.description; - - voidwin32_set_service_status - intstatus - intcheckpoint0 - - - Informa al SCM del estado actual de un servicio en ejecución. Esta llamada - solo es válida para un proceso de servicio en ejecución. - - - - - Desde la versión 0.2.0, esta función solo funciona en línea de - comandos ("cli" SAPI). Está deshabilitada en otros casos. - - - - - - &reftitle.parameters; - - - - status - - - El código de estado del servicio, uno de - WIN32_SERVICE_RUNNING, - WIN32_SERVICE_STOPPED, - WIN32_SERVICE_STOP_PENDING, - WIN32_SERVICE_START_PENDING, - WIN32_SERVICE_CONTINUE_PENDING, - WIN32_SERVICE_PAUSE_PENDING, - WIN32_SERVICE_PAUSED. - - - - - checkpoint - - - Este valor será incrementado periódicamente por el servicio - para reportar su progreso durante las operaciones de inicio, detención, - pausa o reanudación. Por ejemplo, el servicio incrementará este valor - cuando haya completado cada paso de su inicialización durante el inicio. - - - checkpoint solo es válido cuando - status es una de las siguientes constantes: - WIN32_SERVICE_STOP_PENDING, - WIN32_SERVICE_START_PENDING, - WIN32_SERVICE_CONTINUE_PENDING o - WIN32_SERVICE_PAUSE_PENDING. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - Antes de la versión 1.0.0, &win32service.noerror.false.error; - - - - - &reftitle.errors; - - Antes de la versión 1.0.0, si esta función se utiliza fuera del SAPI "cli", se emitirá - un error E_ERROR. - - - A partir de la versión 1.0.0, lanzará una - Win32ServiceException si el SAPI no es - "cli" - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Lanzará una ValueError si un argumento es inválido, - anteriormente &false; era retornado. - - - - PECL win32service 1.0.0 - - Lanzará una Win32ServiceException en caso de error, - anteriormente un - Código de error Win32 - era retornado. - - - - PECL win32service 1.0.0 - - El tipo de retorno es ahora void, anteriormente era mixed. - - - - PECL win32service 0.2.0 - - Esta función solo funciona en el SAPI "cli". - - - - - - - - - - &reftitle.seealso; - - - win32_start_service_ctrl_dispatcher - win32_get_last_control_message - win32_set_service_exit_mode - win32_set_service_exit_code - Las constantes de estado de los servicios Win32Service - - - - - - - diff --git a/reference/win32service/functions/win32-start-service-ctrl-dispatcher.xml b/reference/win32service/functions/win32-start-service-ctrl-dispatcher.xml deleted file mode 100644 index 3e441594c5..0000000000 --- a/reference/win32service/functions/win32-start-service-ctrl-dispatcher.xml +++ /dev/null @@ -1,211 +0,0 @@ - - - - - - - win32_start_service_ctrl_dispatcher - Registra un script con SCM, por lo que puede ser interpretado como un servicio con el nombre dado - - - - &reftitle.description; - - voidwin32_start_service_ctrl_dispatcher - stringname - boolgracefulModetrue - - - Cuando se ejecuta a través del Gestionador de Control de Servicio, un proceso de - servicio debe "registrarse" con él para establecer un servicio de supervisión y - comunicación eficiente. Esta función realiza el registro iniciando un hilo para - manejar las comunicaciones de bajo nivel con el Gestionador de Control de Servicio. - - - Una vez iniciado, el proceso del servicio debe hacer dos cosas. La primera es - informar al Gestionador de Control de Servicio que el servicio está en ejecución. La segunda - es llamar a la función win32_set_service_status con la constante - WIN32_SERVICE_RUNNING. Si necesita lanzar procesos largos antes - de que el servicio se inicie, puede usar la constante - WIN32_SERVICE_START_PENDING. La segunda es continuar - verificando con el Gestionador de Control de Servicio para determinar si el servicio se - detiene o no. Esto implica llamar periódicamente a la función - win32_get_last_control_message y tratar el código devuelto. - - - - - Desde la versión 0.2.0, esta función solo funciona en línea de - comandos. Está deshabilitada en otros casos. - - - - - - &reftitle.parameters; - - - - name - - - El nombre corto del servicio, como se registra con - win32_create_service. - - - - - gracefulMode - - - &true; para la salida correcta. &false; para la salida con error. Consulte - win32_set_service_exit_mode para más detalles. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - Antes de la versión 1.0.0, &win32service.noerror.false.error; - - - - - &reftitle.errors; - - Antes de la versión 1.0.0, si esta función se utiliza fuera del SAPI "cli", se emitirá - un error E_ERROR. - - - A partir de la versión 1.0.0, lanzará una - Win32ServiceException si el SAPI no es - "cli" - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Lanzará una ValueError si un argumento es inválido, - anteriormente &false; era retornado. - - - - PECL win32service 1.0.0 - - Lanzará una Win32ServiceException en caso de error, - anteriormente un - Código de error Win32 - era retornado. - - - - PECL win32service 1.0.0 - - El tipo de retorno es ahora void, anteriormente era mixed. - - - - PECL win32service 0.4.0 - - Se añadió el argumento gracefulMode. - - - - PECL win32service 0.2.0 - - Esta función solo funciona en el SAPI "cli". - - - - - - - - - - &reftitle.examples; - - - Ejemplo con <function>win32_start_service_ctrl_dispatcher</function> - - Verifica si el servicio funciona bajo SCM. - - - -]]> - - - - - - - &reftitle.seealso; - - - win32_set_service_status - win32_get_last_control_message - win32_set_service_exit_mode - win32_set_service_exit_code - Los códigos de error Win32 - - - - - - - diff --git a/reference/win32service/functions/win32-start-service.xml b/reference/win32service/functions/win32-start-service.xml deleted file mode 100644 index 344cae2f2c..0000000000 --- a/reference/win32service/functions/win32-start-service.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - - - win32_start_service - Inicia un servicio - - - - &reftitle.description; - - voidwin32_start_service - stringservicename - stringmachine&null; - - - Intenta iniciar el servicio nombrado. Se requieren privilegios de administrador o - una cuenta con los derechos adecuados definidos en la ACL del servicio. - - - - - &reftitle.parameters; - - - - servicename - - - El nombre corto del servicio. - - - - - machine - - - El nombre opcional de la máquina. - Si se omite, se utilizará la máquina local. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - Antes de la versión 1.0.0, &win32service.noerror.false.error; - - - - - &reftitle.errors; - - Se lanzará una ValueError si el valor del argumento - servicename está vacío. - - - Se lanzará una Win32ServiceException en caso de error. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL win32service 1.0.0 - - Lanzará una ValueError si un argumento es inválido, - anteriormente &false; era retornado. - - - - PECL win32service 1.0.0 - - Lanzará una Win32ServiceException en caso de error, - anteriormente un - Código de error Win32 - era retornado. - - - - PECL win32service 1.0.0 - - El tipo de retorno es ahora void, anteriormente era mixed. - - - - PECL win32service 0.3.0 - - Esta función ya no requiere una cuenta de administrador si la ACL - está definida para otra cuenta. - - - - - - - - - - &reftitle.seealso; - - - win32_stop_service - win32_pause_service - win32_continue_service - win32_send_custom_control - Códigos de error Win32 - - - - - - - diff --git a/reference/win32service/functions/win32-stop-service.xml b/reference/win32service/functions/win32-stop-service.xml deleted file mode 100644 index 86b7c3616d..0000000000 --- a/reference/win32service/functions/win32-stop-service.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - - win32_stop_service - Detiene un servicio - - - - &reftitle.description; - - voidwin32_stop_service - stringservicename - stringmachine&null; - - - Detiene un servicio nombrado. Requiere privilegios de administrador o - una cuenta con los derechos apropiados definidos en el ACL del servicio. - - - - - &reftitle.parameters; - - - - servicename - - - El nombre corto del servicio. - - - - - machine - - - El nombre opcional de la máquina. - Si se omite, se utilizará la máquina local. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - Antes de la versión 1.0.0, &win32service.noerror.false.error; - - - - - &reftitle.errors; - - Se lanzará un ValueError si el valor del parámetro - servicename está vacío. - - - Se lanzará un Win32ServiceException en caso de error. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - PECL win32service 1.0.0 - - Lanzará un ValueError si un parámetro es inválido, - antes se retornaba &false;. - - - - PECL win32service 1.0.0 - - Lanzará un Win32ServiceException en caso de error, - antes se retornaba un - Código de error Win32 - . - - - - PECL win32service 1.0.0 - - El tipo de retorno es ahora void, antes era mixed. - - - - PECL win32service 0.3.0 - - Esta función ya no requiere una cuenta de administrador si el ACL - está definido para otra cuenta. - - - - - - - - - - &reftitle.seealso; - - - win32_start_service - win32_pause_service - win32_continue_service - win32_send_custom_control - Códigos de error Win32 - - - - - - - diff --git a/reference/win32service/reference.xml b/reference/win32service/reference.xml deleted file mode 100644 index 4ce6e81bf4..0000000000 --- a/reference/win32service/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - &Functions; win32service - - &reference.win32service.entities.functions; - - - - diff --git a/reference/win32service/rightinfo/construct.xml b/reference/win32service/rightinfo/construct.xml deleted file mode 100644 index d3441c3a8b..0000000000 --- a/reference/win32service/rightinfo/construct.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - Win32Service\RightInfo::__construct - Crear un nuevo RightInfo (no utilizado) - - - - &reftitle.description; - - final private Win32Service\RightInfo::__construct - - - - Los objetos Win32Service\RightInfo son retornados como - resultado de win32_read_right_access_service. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.seealso; - - Win32Service\RightInfo::getRights - Win32Service\RightInfo::isGrantAccess - Win32Service\RightInfo::isDenyAccess - Win32Service\RightInfo::getFullUsername - Win32Service\RightInfo::getUsername - Win32Service\RightInfo::getDomain - - - - - - diff --git a/reference/win32service/rightinfo/get-domain.xml b/reference/win32service/rightinfo/get-domain.xml deleted file mode 100644 index 570bcfe64f..0000000000 --- a/reference/win32service/rightinfo/get-domain.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - Win32Service\RightInfo::getDomain - Devuelve el dominio del usuario - - - - &reftitle.description; - - final public stringnull Win32Service\RightInfo::getDomain - - - - Devuelve el dominio del usuario. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el nombre de dominio o &null; si no se encuentra ningún dominio (cuenta local o fallo en la resolución del GUID del usuario). - - - - - &reftitle.seealso; - - Win32Service\RightInfo::__construct - Win32Service\RightInfo::getRights - Win32Service\RightInfo::isGrantAccess - Win32Service\RightInfo::isDenyAccess - Win32Service\RightInfo::getFullUsername - Win32Service\RightInfo::getUsername - - - - - - diff --git a/reference/win32service/rightinfo/get-full-username.xml b/reference/win32service/rightinfo/get-full-username.xml deleted file mode 100644 index f5aa61c45c..0000000000 --- a/reference/win32service/rightinfo/get-full-username.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Win32Service\RightInfo::getFullUsername - Devuelve el dominio y el nombre de usuario - - - - &reftitle.description; - - final public stringnull Win32Service\RightInfo::getFullUsername - - - - Devuelve el dominio y el nombre de usuario separados por una barra invertida \. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el dominio y el nombre de usuario. Si el dominio es &null;, devuelve solo el nombre de usuario; devuelve &null; si no se encuentra ningún nombre de usuario. - - - - - &reftitle.seealso; - - Win32Service\RightInfo::__construct - Win32Service\RightInfo::getRights - Win32Service\RightInfo::isGrantAccess - Win32Service\RightInfo::isDenyAccess - Win32Service\RightInfo::getUsername - - - - - - diff --git a/reference/win32service/rightinfo/get-rights.xml b/reference/win32service/rightinfo/get-rights.xml deleted file mode 100644 index 12fcfc9c6d..0000000000 --- a/reference/win32service/rightinfo/get-rights.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Win32Service\RightInfo::getRights - Devuelve la lista de derechos - - - - &reftitle.description; - - final public array Win32Service\RightInfo::getRights - - - - Devuelve la lista de derechos del usuario. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la lista de derechos del usuario. - - - El array indexado es la máscara de bits del derecho representado por las constantes de permisos. - - - El valor es una cadena con el nombre de la constante de Windows (sin el prefijo WIN32_). - - - - - &reftitle.seealso; - - Win32Service\RightInfo::__construct - Win32Service\RightInfo::isGrantAccess - Win32Service\RightInfo::isDenyAccess - Win32Service\RightInfo::getFullUsername - Win32Service\RightInfo::getUsername - Win32Service\RightInfo::getDomain - Constantes de permisos Win32 - - - - - - diff --git a/reference/win32service/rightinfo/get-username.xml b/reference/win32service/rightinfo/get-username.xml deleted file mode 100644 index 9213ccecc4..0000000000 --- a/reference/win32service/rightinfo/get-username.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - Win32Service\RightInfo::getUsername - Devuelve el nombre de usuario - - - - &reftitle.description; - - final public stringnull Win32Service\RightInfo::getUsername - - - - Devuelve el nombre de usuario. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el nombre de usuario o el GUID si la resolución falla. - - - - - &reftitle.seealso; - - Win32Service\RightInfo::__construct - Win32Service\RightInfo::getRights - Win32Service\RightInfo::isGrantAccess - Win32Service\RightInfo::isDenyAccess - Win32Service\RightInfo::getFullUsername - Win32Service\RightInfo::getDomain - - - - - - diff --git a/reference/win32service/rightinfo/is-deny-access.xml b/reference/win32service/rightinfo/is-deny-access.xml deleted file mode 100644 index 5b4b757933..0000000000 --- a/reference/win32service/rightinfo/is-deny-access.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - Win32Service\RightInfo::isDenyAccess - Devuelve true si el RightInfo se refiere a la denegación de acceso al recurso - - - - &reftitle.description; - - final public bool Win32Service\RightInfo::isDenyAccess - - - - Devuelve &true; si el RightInfo se refiere a la denegación de acceso al recurso, de lo contrario, es &false;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si el RightInfo se refiere a la denegación de acceso al recurso, de lo contrario, es &false;. - - - - - &reftitle.seealso; - - Win32Service\RightInfo::__construct - Win32Service\RightInfo::getRights - Win32Service\RightInfo::isGrantAccess - Win32Service\RightInfo::getFullUsername - Win32Service\RightInfo::getUsername - Win32Service\RightInfo::getDomain - - - - - - diff --git a/reference/win32service/rightinfo/is-grant-access.xml b/reference/win32service/rightinfo/is-grant-access.xml deleted file mode 100644 index a2818eb768..0000000000 --- a/reference/win32service/rightinfo/is-grant-access.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - Win32Service\RightInfo::isGrantAccess - Devuelve true si el RightInfo se refiere al acceso al recurso - - - - &reftitle.description; - - final public bool Win32Service\RightInfo::isGrantAccess - - - - Devuelve &true; si el RightInfo se refiere al acceso al recurso, de lo contrario, es &false;. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si el RightInfo se refiere al acceso al recurso, de lo contrario, es &false;. - - - - - &reftitle.seealso; - - Win32Service\RightInfo::__construct - Win32Service\RightInfo::getRights - Win32Service\RightInfo::isDenyAccess - Win32Service\RightInfo::getFullUsername - Win32Service\RightInfo::getUsername - Win32Service\RightInfo::getDomain - - - - - - diff --git a/reference/win32service/setup.xml b/reference/win32service/setup.xml deleted file mode 100644 index 67532d8ac6..0000000000 --- a/reference/win32service/setup.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - Las versiones de Windows soportadas son las mismas que el paquete redistribuible Visual C++ utilizado para construir PHP. - -
    - - - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;win32service - -
    - - -
    - Consideraciones de seguridad - - Esta extensión requiere privilegios de administrador para ciertas acciones tales como - create, - delete, - start, - stop, - pause y - continue. - Esta exigencia puede causar una elevación de privilegios si el control de - servicio está disponible desde la interfaz Web o el control remoto. - - - La ACL del servicio puede ser definida después de su adición en el SCM para delegar - las tareas de administración actuales a una cuenta no administrador o a una cuenta de servicio. - - - A partir de Win32Service 1.1.0, los derechos de servicio pueden ser gestionados con PHP. Los ACL actuales pueden ser leídos con - win32_read_all_rights_access_service, un derecho de acceso o de denegación puede ser añadido con - win32_add_right_access_service, o un derecho de acceso puede ser eliminado con - win32_remove_right_access_service. - - - Se recomienda actualizar a Win32Service 1.1.0. - Para instrucciones adicionales sobre la gestión de derechos sin la extensión (o con una versión anterior a 1.1.0), consulte la - Base de conocimientos de Microsoft. - -
    - -
    - - diff --git a/reference/win32service/win32serviceexception.xml b/reference/win32service/win32serviceexception.xml deleted file mode 100644 index f88d145938..0000000000 --- a/reference/win32service/win32serviceexception.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - La clase Win32ServiceException - Win32ServiceException - - - - -
    - &reftitle.intro; - - La excepción reemplaza el antiguo mecanismo donde el valor de error debía ser - comparado con las constantes para detectar qué error había sido emitido. El código - de la excepción es igual al valor de la constante de error y el mensaje de - la excepción se basa en el nombre de la constante correspondiente. - -
    - - -
    - &reftitle.classsynopsis; - - - - Win32ServiceException - - - - - Win32ServiceException - - - - extends - Exception - - - - - &InheritedProperties; - - - - - - - - &InheritedMethods; - - - - -
    - -
    - - - -
    - - diff --git a/reference/win32service/win32servicerightinfo.xml b/reference/win32service/win32servicerightinfo.xml deleted file mode 100644 index 7d34c128fc..0000000000 --- a/reference/win32service/win32servicerightinfo.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - La clase Win32Service\RightInfo - Win32Service\RightInfo - - - - -
    - &reftitle.intro; - - La clase interna Win32Service\RightInfo encapsula el resultado de win32_read_right_access_service. - -
    - - -
    - &reftitle.classsynopsis; - - - - Win32Service\RightInfo - - - - final - - Win32Service\RightInfo - - - - - &Methods; - - - - -
    - -
    - - &reference.win32service.entities.rightinfo; - -
    - - diff --git a/reference/wincache/book.xml b/reference/wincache/book.xml deleted file mode 100644 index e48aeec96b..0000000000 --- a/reference/wincache/book.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - Caché de Windows para PHP - WinCache - - - &reftitle.intro; - - La Extensión de Caché de Windows para PHP es un acelerador de PHP utilizado para incrementar la velocidad - de las aplicaciones de PHP que se ejecutan sobre Windows y Windows Server. Una vez que la Extensión de - Caché de Windows para PHP está habilitada y cargada por el motor de PHP, las aplicaciones de PHP se podrán - aprovechar de la funcionalidad sin ninguna modificación en el código. - - - La Extensión de Caché de Windows para PHP incluye 5 tipos diferentes de cachés. A continuación se - describe el propósito de cada tipo de caché y los beneficios que ofrece. - - - - - Caché de opcodes de PHP - PHP es un motor de procesamiento de scripts que - lee un flujo de datos de entrada que contiene texto, instrucciones de PHP, o ambas, y produce - otro flujo de datos, generalmente en formato HTML. Esto significa que, en un servidor web, el motor de - PHP lee, analiza, compila y ejecuta un script de PHP cada vez que es solicitado por un cliente web. - Las operaciones de lectura, análisis y compilación añaden una carga adicional a la CPU del servidor web - y del sistema de ficheros y por tanto afectar al rendimiento global de una aplicación web PHP. - La caché de bytecodes (opcodes) de PHP se utiliza para almacenar, en memoria compartida, el script de - bytecodes ya compilado de manera que pueda ser re-utilizado por el motor de PHP para ejecuciones - posteriores del mismo script. - - - El soporte para el almacenamiento en caché de opcode fue eliminado en Wincache 2.0.0, todos los usuarios que - desean tener un opcache debe utilizar la extensión OPcache - que se incluye en PHP. - - - - - Caché de Fichero - Incluso con la caché de opcodes de PHP activada, en un sistema de - ficheros el motor de PHP, debe acceder a los ficheros de script. - Cuando los script de PHP son almacenados en un UNC remoto de compartición de ficheros, las operaciones - sobre ficheros introducen una considerable sobrecarga de rendimiento. - La Extensión de Caché de Windows para PHP incluye una caché de ficheros que es utilizada para almacenar - los contenidos de los ficheros de script de PHP en memoria compartida, lo que reduce la cantidad de - operaciones en el sistema de ficheros realizado por el motor de PHP. - - - - - Caché de Resolución de Rutas de Ficheros - Los script de PHP a menudo incluyen u - operan con ficheros mediante el uso de rutas relativas. Cada ruta de fichero debe ser normalizada por - el motor de PHP a una ruta de fichero absoluta. Cuando una aplicación de PHP emplea muchos ficheros PHP - y accede a ellos mediante rutas relativas, el tener que resolver las rutas puede afectar de manera - negativa al rendimiento de la aplicación. La Extensión de Caché de Windows para PHP ofrece una caché - de Resolución de Rutas de Ficheros, que se emplea para almacenar los mapeos entre las rutas relativas - de ficheros y las absolutas, reduciendo por tanto la cantidad de resoluciones de rutas que el motor de - PHP tiene que realizar. - - - - - Caché de Usuario (disponible desde la versión 1.1.0) - Los scripts de PHP pueden - aprovecharse de la caché de la memoria compartida mediante el uso del API de la caché de usuario. Los - objetos PHP y las variables se pueden almacenar en la caché de usuario y ser reutilizadas en posteriores - peticiones. Esto se puede emplear para mejorar el rendimiento de los script de PHP y para compartir - datos entre múltiples procesos de PHP. - - - - - Gestor de Sesión (disponible desde la versión 1.1.0) - El gestor de sesión WinCache - se puede emplear para almacenar los datos de la sesión PHP en la memoria compartida. Esto evita - operaciones del sistema de ficheros para leer y escribir datos de sesión, lo que mejora el rendimiento - cuando se almacenan grandes cantidades de datos en la sesión de PHP. - - - - - - &reference.wincache.setup; - &reference.wincache.reference; - &reference.wincache.win32build; - - - - - diff --git a/reference/wincache/functions/wincache-fcache-fileinfo.xml b/reference/wincache/functions/wincache-fcache-fileinfo.xml deleted file mode 100644 index 7dcc185329..0000000000 --- a/reference/wincache/functions/wincache-fcache-fileinfo.xml +++ /dev/null @@ -1,189 +0,0 @@ - - - - - - - - wincache_fcache_fileinfo - - Extrae información sobre los archivos almacenados en la caché de archivos - - - - &reftitle.description; - - arrayfalsewincache_fcache_fileinfo - boolsummaryonly&false; - - - Extrae información sobre el contenido de la caché de archivos y su utilización. - - - - &reftitle.parameters; - - - - summaryonly - - - Controla si el array devuelto debe contener información sobre las entradas individuales del caché además del resumen del caché de archivos. - - - - - - - - &reftitle.returnvalues; - - Array de metadatos sobre la caché de archivos &return.falseforfailure; - - - El array devuelto por esta función contiene los siguientes elementos: - - - - total_cache_uptime - Tiempo total de actividad en segundos de la caché de archivos - - - - - total_file_count - Número total de archivos actualmente en la caché de archivos - - - - - total_hit_count - Número de veces que los archivos han sido servidos desde la caché de archivos - - - - - total_miss_count - Número de veces que los archivos no se encontraron en la caché de archivos - - - - - file_entries - Array que contiene información sobre todos los archivos almacenados en caché: - - - - file_name - Nombre y ruta absoluta del archivo en caché - - - - - add_time - Tiempo en segundos desde que el archivo fue añadido a la caché de archivos - - - - - use_time - Tiempo en segundos desde que el archivo fue consultado en la caché de archivos - - - - - last_check - Tiempo en segundos desde la última verificación de modificaciones - - - - - hit_count - Número de veces que el archivo ha sido servido desde la caché - - - - - file_size - Tamaño en bytes del archivo almacenado en caché - - - - - - - - - - &reftitle.examples; - - - Un ejemplo de <function>wincache_fcache_fileinfo</function> - - - - - -]]> - - &example.outputs; - - 3234 - [total_file_count] => 5 - [total_hit_count] => 0 - [total_miss_count] => 1 - [file_entries] => Array - ( - [1] => Array - ( - [file_name] => c:\inetpub\wwwroot\checkcache.php - [add_time] => 1 - [use_time] => 0 - [last_check] => 1 - [hit_count] => 1 - [file_size] => 2435 - ) - [2] => Array (...iterates for each cached file) - ) -) -]]> - - - - - - - &reftitle.seealso; - - - wincache_fcache_meminfo - wincache_ocache_fileinfo - wincache_ocache_meminfo - wincache_rplist_fileinfo - wincache_rplist_meminfo - wincache_refresh_if_changed - wincache_ucache_meminfo - wincache_ucache_info - wincache_scache_info - wincache_scache_meminfo - - - - - - - diff --git a/reference/wincache/functions/wincache-fcache-meminfo.xml b/reference/wincache/functions/wincache-fcache-meminfo.xml deleted file mode 100644 index 169e35e0d8..0000000000 --- a/reference/wincache/functions/wincache-fcache-meminfo.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - - wincache_fcache_meminfo - - Recupera información sobre el uso de memoria caché de ficheros - - - - &reftitle.description; - - arrayfalsewincache_fcache_meminfo - - - - Recupera información sobre el uso de la memoria caché del fichero. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Array de meta datos sobre el uso de memoria caché de ficheros &return.falseforfailure; - - - El array devuelta por esta función contiene los siguientes elementos: - - - - memory_total - cantidad de memoria en bytes asignados para la caché de ficheros - - - - - memory_free - cantidad de memoria libre en bytes disponibles para la caché de ficheros - - - - - num_used_blks - número de bloques de memoria utilizados por la caché de ficheros - - - - - num_free_blks - número de bloques de memoria libre disponibles para la caché de ficheros - - - - - memory_overhead - cantidad de memoria en bytes utilizados para las estructuras internas de la caché de ficheros - - - - - - - - &reftitle.examples; - - - Un ejemplo de <function>wincache_fcache_meminfo</function> - - - - - -]]> - - &example.outputs; - - 134217728 - [memory_free] => 131339120 - [num_used_blks] => 361 - [num_free_blks] => 3 - [memory_overhead] => 5856 -) -]]> - - - - - - - &reftitle.seealso; - - - wincache_fcache_fileinfo - wincache_ocache_fileinfo - wincache_ocache_meminfo - wincache_rplist_fileinfo - wincache_rplist_meminfo - wincache_refresh_if_changed - wincache_ucache_meminfo - wincache_ucache_info - wincache_scache_info - wincache_scache_meminfo - - - - - - - diff --git a/reference/wincache/functions/wincache-lock.xml b/reference/wincache/functions/wincache-lock.xml deleted file mode 100644 index e117992dd2..0000000000 --- a/reference/wincache/functions/wincache-lock.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - wincache_lock - - Obtiene un bloqueo exclusivo en una clave dada - - - - &reftitle.description; - - boolwincache_lock - stringkey - boolisglobal&false; - - - Obtiene un bloqueo exclusivo sobre una clave dada. La ejecución del script actual quedará en espera que - se pueda obtener el bloqueo. Una vez obtenido el bloqueo, el otro script que intente solicitar dicho bloqueo utilizando la misma - clave quedará en espera, hasta que el script actual libere el bloqueo con wincache_unlock. - - - - El uso de wincache_lock y wincache_unlock puede causar bloqueos de punto muerto al - ejecutar scripts de PHP en un entorno multiproceso como FastCGI. No emplear estas funciones a menos que se esté - absolutamente seguro de que son necesarias. Para la mayoría de las operaciones en la caché de usuario no es necesario - usar estas funciones. - - - - - &reftitle.parameters; - - - - key - - - Nombre de la clave en la caché para adquirir el bloqueo. - - - - - isglobal - - - Controla si el ámbito del bloqueo es a nivel de sistema o local. Los bloqueos locales tienen alcance para la «pool» de la aplicación - en el caso de FastCGI de IIS o a todos los procesos de php que tengan el mismo identificador de proceso padre. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - - Empleo de <function>wincache_lock</function> - - -]]> - - - - - - - &reftitle.seealso; - - - wincache_unlock - wincache_ucache_set - wincache_ucache_get - wincache_ucache_delete - wincache_ucache_clear - wincache_ucache_exists - wincache_ucache_meminfo - wincache_ucache_info - wincache_scache_info - - - - - - - diff --git a/reference/wincache/functions/wincache-ocache-fileinfo.xml b/reference/wincache/functions/wincache-ocache-fileinfo.xml deleted file mode 100644 index 830e4cba88..0000000000 --- a/reference/wincache/functions/wincache-ocache-fileinfo.xml +++ /dev/null @@ -1,201 +0,0 @@ - - - - - - - - wincache_ocache_fileinfo - - Extrae información sobre los archivos almacenados en el caché opcode - - - - &reftitle.description; - - arrayfalsewincache_ocache_fileinfo - boolsummaryonly&false; - - - Extrae información sobre el contenido del caché opcode y su utilización. - - &warn.removed.function-7-0-0; - - - &reftitle.parameters; - - - - summaryonly - - - Controla si el array devuelto debe contener información sobre las entradas individuales del caché además del resumen del caché opcode. - - - - - - - - &reftitle.returnvalues; - - Array de metadatos sobre el caché opcode &return.falseforfailure; - - - El array devuelto por esta función contiene los siguientes elementos: - - - - total_cache_uptime - Tiempo total de actividad en segundos del caché opcode - - - - - total_file_count - Número total de archivos actualmente en el caché opcode - - - - - total_hit_count - Número total de veces que el opcode compilado ha sido servido desde el caché - - - - - total_miss_count - Número de veces que el opcode compilado no se encontró en el caché - - - - - is_local_cache - true si los metadatos del caché son para una instancia de caché local, false si los metadatos son para el caché global. - - - - - file_entries - Array que contiene información sobre todos los archivos almacenados en caché: - - - - file_name - Nombre de archivo absoluto del archivo en caché - - - - - add_time - Tiempo en segundos desde que el archivo fue añadido al caché opcode - - - - - use_time - Tiempo en segundos desde que el archivo fue consultado en el caché opcode - - - - - last_check - Tiempo en segundos desde que el archivo fue verificado para cambios - - - - - hit_count - Número de veces que el archivo ha sido servido desde el caché - - - - - function_count - Número de funciones en el caché - - - - - class_count - Número de clases en el caché - - - - - - - - - - &reftitle.examples; - - - Un ejemplo de <function>wincache_ocache_fileinfo</function> - - - - - -]]> - - &example.outputs; - - 17357 - [total_file_count] => 121 - [total_hit_count] => 36562 - [total_miss_count] => 201 - [file_entries] => Array - ( - [1] => Array - ( - [file_name] => c:\inetpub\wwwroot\checkcache.php - [add_time] => 17356 - [use_time] => 7 - [last_check] => 10 - [hit_count] => 454 - [function_count] => 0 - [class_count] => 1 - ) - [2] => Array (...iterates for each cached file) - ) -) -]]> - - - - - - - &reftitle.seealso; - - - wincache_fcache_fileinfo - wincache_fcache_meminfo - wincache_ocache_meminfo - wincache_rplist_fileinfo - wincache_rplist_meminfo - wincache_refresh_if_changed - wincache_ucache_meminfo - wincache_ucache_info - wincache_scache_info - wincache_scache_meminfo - - - - - - - diff --git a/reference/wincache/functions/wincache-ocache-meminfo.xml b/reference/wincache/functions/wincache-ocache-meminfo.xml deleted file mode 100644 index 13487d78d0..0000000000 --- a/reference/wincache/functions/wincache-ocache-meminfo.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - - - wincache_ocache_meminfo - - Extrae información sobre la utilización del caché opcode - - - - &reftitle.description; - - arrayfalsewincache_ocache_meminfo - - - - Extrae información sobre la utilización de la memoria por el caché opcode. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Tabla de metadatos sobre la utilización de la memoria caché opcode &return.falseforfailure; - - - La tabla devuelta por esta función contiene los siguientes elementos: - - - - memory_total - Cantidad de memoria en bytes, asignada para el caché opcode - - - - - memory_free - Cantidad de memoria libre en bytes, disponible para el caché opcode - - - - - num_used_blks - Número de bloques de memoria utilizados por el caché opcode - - - - - num_free_blks - Número de bloques de memoria libres disponibles para el caché opcode - - - - - memory_overhead - Cantidad de memoria en bytes utilizada para la estructura interna del caché opcode - - - - - &warn.removed.function-7-0-0; - - - - &reftitle.examples; - - - Un ejemplo de <function>wincache_ocache_meminfo</function> - - - - - -]]> - - &example.outputs; - - 134217728 - [memory_free] => 112106972 - [num_used_blks] => 15469 - [num_free_blks] => 4 - [memory_overhead] => 247600 -) -]]> - - - - - - - &reftitle.seealso; - - - wincache_fcache_fileinfo - wincache_fcache_meminfo - wincache_ocache_fileinfo - wincache_rplist_fileinfo - wincache_rplist_meminfo - wincache_refresh_if_changed - wincache_ucache_meminfo - wincache_ucache_info - wincache_scache_info - wincache_scache_meminfo - - - - - - - diff --git a/reference/wincache/functions/wincache-refresh-if-changed.xml b/reference/wincache/functions/wincache-refresh-if-changed.xml deleted file mode 100644 index 529a8c8f22..0000000000 --- a/reference/wincache/functions/wincache-refresh-if-changed.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - - wincache_refresh_if_changed - - Actualiza las entradas del caché para los archivos almacenados en caché - - - - &reftitle.description; - - boolwincache_refresh_if_changed - arrayfilesNULL - - - Actualiza las entradas del caché para los archivos cuyos nombres se han pasado en los - argumentos de entrada. Si no se especifica ningún argumento, entonces se actualizan todas las entradas del caché. - - - - &reftitle.parameters; - - - - files - - - Array de nombres de archivos para los archivos que necesitan ser actualizados. - Se puede usar una ruta de archivo absoluta o relativa. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - WinCache realiza verificaciones regulares en los archivos almacenados en caché para - asegurarse de que, si un archivo ha cambiado, la entrada correspondiente en la memoria caché - se actualice. Por defecto, esta verificación se realiza cada 30 segundos. - Si, por ejemplo, un script PHP actualiza otro script PHP donde se almacenan las configuraciones - de la aplicación, entonces puede ocurrir que, después de que los cambios de configuración se hayan guardado, - la aplicación siga utilizando los parámetros antiguos durante algún tiempo hasta que el caché se actualice. - En este caso, es preferible actualizar el caché justo después de que el archivo haya sido modificado. - El ejemplo siguiente muestra cómo hacerlo. - - Un ejemplo de <function>wincache_refresh_if_changed</function> - -'); -fclose($handle); -wincache_refresh_if_changed(array($filename)); -?> -]]> - - - - - - - &reftitle.seealso; - - - wincache_fcache_fileinfo - wincache_fcache_meminfo - wincache_ocache_fileinfo - wincache_ocache_meminfo - wincache_rplist_fileinfo - wincache_rplist_meminfo - wincache_ucache_meminfo - wincache_ucache_info - - - - - - - diff --git a/reference/wincache/functions/wincache-rplist-fileinfo.xml b/reference/wincache/functions/wincache-rplist-fileinfo.xml deleted file mode 100644 index 8a03911168..0000000000 --- a/reference/wincache/functions/wincache-rplist-fileinfo.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - - - wincache_rplist_fileinfo - Recupera información de la caché sobre una ruta de archivo resuelta - - - &reftitle.description; - - arrayfalsewincache_rplist_fileinfo - boolsummaryonly&false; - - - Recupera información sobre las asignaciones almacenadas en caché entre rutas de archivos relativas y sus correspondencias en rutas de archivos absolutas - - - - - &reftitle.parameters; - - - - summaryonly - - - - - - - - - - - - &reftitle.returnvalues; - - Un array de metadatos con información sobre la caché de una ruta de archivo resuelta &return.falseforfailure; - - - El array devuelto por esta función contiene los siguientes elementos: - - - - total_file_count - número total de rutas de archivos almacenadas en la caché - - - - - rplist_entries - un array que contiene la información sobre las rutas de archivo presentes en la caché: - - - - resolve_path - ruta hacia el archivo - - - - - subkey_data - ruta absoluta correspondiente - - - - - - - - - - - &reftitle.examples; - - - Ejemplo con <function>wincache_rplist_fileinfo</function> - - - - - -]]> - - &example.outputs; - - 5 - [rplist_entries] => Array - ( - [1] => Array - ( - [resolve_path] => checkcache.php - [subkey_data] => c:\inetpub\wwwroot|c:\inetpub\wwwroot\checkcache.php - ) - - [2] => Array (...iterates for each cached file) - ) -) -]]> - - - - - - - &reftitle.seealso; - - - wincache_fcache_meminfo - wincache_fcache_fileinfo - wincache_ocache_fileinfo - wincache_ocache_meminfo - wincache_rplist_meminfo - wincache_refresh_if_changed - wincache_ucache_meminfo - wincache_ucache_info - wincache_scache_info - wincache_scache_meminfo - - - - - - - diff --git a/reference/wincache/functions/wincache-rplist-meminfo.xml b/reference/wincache/functions/wincache-rplist-meminfo.xml deleted file mode 100644 index 30f099a979..0000000000 --- a/reference/wincache/functions/wincache-rplist-meminfo.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - - - wincache_rplist_meminfo - Recupera información sobre el uso de la memoria por la caché de ruta de archivo resuelta - - - &reftitle.description; - - arrayfalsewincache_rplist_meminfo - - - - Recupera información sobre el uso de la memoria por la caché de ruta de archivo resuelta. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un array de metadatos que describe el uso de la memoria - por la caché de ruta de archivo resuelta. &return.falseforfailure; - - - El array devuelto por esta función contiene los siguientes elementos: - - - - memory_total - cantidad de memoria, en bytes, asignada - a la caché de rutas de archivos resueltas - - - - - memory_free - cantidad de memoria libre, en bytes, disponible para la - caché de rutas de archivos resueltas - - - - - num_used_blks - número de bloques de memoria usados por la caché de rutas - de archivos resueltas - - - - - num_free_blks - número de bloques de memoria libres para la caché - de rutas de archivos resueltas - - - - - memory_overhead - cantidad de memoria, en bytes, usada para la - estructura interna de la caché de rutas de archivos resueltas - - - - - - - - &reftitle.examples; - - - Ejemplo con <function>wincache_rplist_meminfo</function> - - - - - -]]> - - &example.outputs; - - 9437184 - [memory_free] => 9416744 - [num_used_blks] => 23 - [num_free_blks] => 1 - [memory_overhead] => 416 -) -]]> - - - - - - - &reftitle.seealso; - - - wincache_fcache_fileinfo - wincache_fcache_meminfo - wincache_ocache_fileinfo - wincache_ocache_meminfo - wincache_rplist_fileinfo - wincache_refresh_if_changed - wincache_ucache_meminfo - wincache_ucache_info - wincache_scache_info - wincache_scache_meminfo - - - - - - - diff --git a/reference/wincache/functions/wincache-scache-info.xml b/reference/wincache/functions/wincache-scache-info.xml deleted file mode 100644 index 2f83f4ff13..0000000000 --- a/reference/wincache/functions/wincache-scache-info.xml +++ /dev/null @@ -1,203 +0,0 @@ - - - - - - - - wincache_scache_info - Recupera información sobre archivos almacenados en el caché de sesión. - - - &reftitle.description; - - arrayfalsewincache_scache_info - boolsummaryonly&false; - - - Recupera información sobre el contenido del caché de sesión y su utilización. - - - - &reftitle.parameters; - - - - summaryonly - - - Controla si el array devuelto debe contener información sobre entradas - individuales del caché además del resumen del caché. - - - - - - - - &reftitle.returnvalues; - - Un array de metadatos sobre el caché para esta sesión - &return.falseforfailure; - - - El array devuelto por esta función contiene los siguientes elementos: - - - - total_cache_uptime - duración total (en segundos) de activación del caché - - - - - total_item_count - número total de elementos contenidos actualmente en el caché - - - - - is_local_cache - &true; si los metadatos del caché son para una instancia - de caché local, &false; si son para un caché global - - - - - total_hit_count - número total de veces que los datos han sido servidos - desde el caché - - - - - total_miss_count - número total de veces que los datos no se encontraron en - el caché - - - - - scache_entries - un array que contiene información sobre los elementos almacenados en caché: - - - - key_name - nombre de la clave usada para almacenar los datos - - - - - value_type - tipo del valor almacenado - - - - - use_time - tiempo, en segundos, desde el último acceso del archivo desde el caché opcode - - - - - last_check - tiempo, en segundos, desde la última vez que el archivo fue verificado - para detectar cambios - - - - - ttl_seconds - tiempo restante antes de la eliminación de los datos del caché, 0 significa que nunca serán eliminados - - - - - age_seconds - tiempo transcurrido desde el momento en que se agregaron los datos en la caché - - - - - hitcount - número de veces que los datos han sido servidos desde el caché - - - - - - - - - - &reftitle.examples; - - - Ejemplo con <function>wincache_scache_info</function> - - - - - -]]> - - &example.outputs; - - 17357 - [total_file_count] => 121 - [total_hit_count] => 36562 - [total_miss_count] => 201 - [scache_entries] => Array - ( - [1] => Array - ( - [file_name] => c:\inetpub\wwwroot\checkcache.php - [add_time] => 17356 - [use_time] => 7 - [last_check] => 10 - [hit_count] => 454 - [function_count] => 0 - [class_count] => 1 - ) - [2] => Array (...iterates for each cached file) - ) -) -]]> - - - - - - - &reftitle.seealso; - - - wincache_fcache_fileinfo - wincache_fcache_meminfo - wincache_ocache_meminfo - wincache_rplist_fileinfo - wincache_rplist_meminfo - wincache_refresh_if_changed - wincache_ucache_meminfo - wincache_ucache_info - wincache_scache_meminfo - - - - - - - diff --git a/reference/wincache/functions/wincache-scache-meminfo.xml b/reference/wincache/functions/wincache-scache-meminfo.xml deleted file mode 100644 index 4874431a2b..0000000000 --- a/reference/wincache/functions/wincache-scache-meminfo.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - - wincache_scache_meminfo - - Recupera información sobre el uso de memoria caché de sesión - - - - &reftitle.description; - - arrayfalsewincache_scache_meminfo - - - - Recupera información sobre el uso de memoria caché de la sesión. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Array de metadatos sobre el uso de la memoria caché de sesión &return.falseforfailure; - - - El array devuelto por esta función contiene los siguientes elementos: - - - - memory_total - cantidad de memoria en bytes asignado para la caché de sesión - - - - - memory_free - cantidad de memoria libre en bytes disponible para la caché de sesión - - - - - num_used_blks - número de bloques de memoria utilizados por el caché de la sesión - - - - - num_free_blks - número de bloques disponibles en la memoria de la caché de sesión - - - - - memory_overhead - cantidad de memoria en bytes utilizado para las estructuras de sesión de caché interna - - - - - - - - &reftitle.examples; - - - Ejemplo de <function>wincache_scache_meminfo</function> - - - - - -]]> - - &example.outputs; - - 5242880 - [memory_free] => 5215056 - [num_used_blks] => 6 - [num_free_blks] => 3 - [memory_overhead] => 176 -) -]]> - - - - - - - &reftitle.seealso; - - - wincache_fcache_fileinfo - wincache_fcache_meminfo - wincache_ocache_fileinfo - wincache_rplist_fileinfo - wincache_rplist_meminfo - wincache_refresh_if_changed - wincache_ucache_info - wincache_scache_info - - - - - - - diff --git a/reference/wincache/functions/wincache-ucache-add.xml b/reference/wincache/functions/wincache-ucache-add.xml deleted file mode 100644 index 08e60edfc8..0000000000 --- a/reference/wincache/functions/wincache-ucache-add.xml +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - - - wincache_ucache_add - - Añade una nueva variable al caché de usuario solo si la variable todavía no existe en el cache - - - - &reftitle.description; - - boolwincache_ucache_add - stringkey - mixedvalue - intttl0 - - - boolwincache_ucache_add - arrayvalues - mixedunusedNULL - intttl0 - - - Añade una variable al caché de usuario, solo si no existe ya en el caché. La variable permanecerá en el caché mientras no se alcance el tiempo de expiración o hasta que no se elimine con la función - wincache_ucache_delete o la función wincache_ucache_clear. - - - - &reftitle.parameters; - - - - key - - - Almacena la variable usando el nombre key. Si una variable - correspondiente a la misma clave ya está presente en el caché, la función - fallará y devolverá &false;. El parámetro key es sensible a mayúsculas y minúsculas. Para sobrescribir este valor, si key está presente, - use la función wincache_ucache_set en su lugar. - key también puede ser un array de pares nombre => valor donde - los nombres serán usados como claves. Este formato puede ser usado para añadir - múltiples valores en el caché en una sola operación. - - - - - value - - - El valor de la variable a almacenar. El parámetro Value - soporta todos los tipos de datos, excepto recursos, como punteros de archivos. - Este parámetro será ignorado si el primer argumento es un array. Generalmente, se debe - pasar el valor &null; al parámetro value cuando se usa un array para el parámetro key. Si el parámetro value - es un objeto, o un array que contiene objetos, entonces los objetos serán serializados. Consulte la función __sleep() - para más detalles sobre la serialización de objetos. - - - - - values - - - Array asociativo de claves y valores. - - - - - ttl - - - Duración de vida de la variable en el caché, en segundos. Después del tiempo especificado - por el parámetro ttl, la variable almacenada será eliminada del caché. Este parámetro toma, como - valor por defecto, cero (0), lo que significa que la variable - permanecerá en el caché hasta que no sea explícitamente eliminada usando la función wincache_ucache_delete - o la función wincache_ucache_clear. - - - - - - - - &reftitle.returnvalues; - - Si el parámetro key es una &string;, la función devuelve - &true; en caso de éxito, &false; si ocurre un error. - - - Si el parámetro key es un array, la función devuelve: - - - - Si todas las parejas nombre => valor del array pueden ser definidas, la función devolverá - un array vacío; - - - - - Si ninguna de las parejas nombre => valor del array puede ser definida, la función devolverá - &false; ; - - - - - Si algunas pueden ser definidas, y otras no, la función devolverá un array de parejas - nombre => valor que no han podido ser definidas en el caché de usuario. - - - - - - - &reftitle.examples; - - - Ejemplo con <function>wincache_ucache_add</function> y el parámetro <parameter>key</parameter> en forma de &string; - - -]]> - - &example.outputs; - - - - - - - - Ejemplo con <function>wincache_ucache_add</function> y el parámetro <parameter>key</parameter> en forma de &array; - - '5', 'Blue' => '6', 'yellow' => '7', 'cyan' => '8'); -var_dump(wincache_ucache_add($colors_array)); -var_dump(wincache_ucache_add($colors_array)); -var_dump(wincache_ucache_get('Blue')); -?> -]]> - - &example.outputs; - - int(-1) - ["Blue"]=> int(-1) - ["yellow"]=> int(-1) - ["cyan"]=> int(-1) -} -string(1) "6" -]]> - - - - - - - &reftitle.seealso; - - - wincache_ucache_set - wincache_ucache_get - wincache_ucache_delete - wincache_ucache_clear - wincache_ucache_exists - wincache_ucache_meminfo - wincache_ucache_info - __sleep() - - - - - - - diff --git a/reference/wincache/functions/wincache-ucache-cas.xml b/reference/wincache/functions/wincache-ucache-cas.xml deleted file mode 100644 index 793ae107ec..0000000000 --- a/reference/wincache/functions/wincache-ucache-cas.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - - - wincache_ucache_cas - - Compara la variable con el valor antiguo y le asigna un nuevo valor a este - - - - &reftitle.description; - - boolwincache_ucache_cas - stringkey - intold_value - intnew_value - - - Compara la variable asociada con la key con old_value - y si coincide entonces asigna el new_value a este. - - - - &reftitle.parameters; - - - - key - - - El parámetro key que se utiliza para almacenar la variable en la caché. - key distingue mayúsculas de minúsculas. - - - - - old_value - - - Valor anterior de la variable apuntada por key en la memoria caché del usuario. - El valor debe ser de tipo long, en caso contrario la función devuelve - &false;. - - - - - new_value - - - El nuevo valor que se asignará a la variable indicada por la key si se - encuentra una coincidencia. El valor debe ser de tipo long, en caso contrario - la función devolverá &false;. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - - Usando <function>wincache_ucache_cas</function> - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - wincache_ucache_inc - wincache_ucache_dec - - - - - - - diff --git a/reference/wincache/functions/wincache-ucache-clear.xml b/reference/wincache/functions/wincache-ucache-clear.xml deleted file mode 100644 index 25e6d2a489..0000000000 --- a/reference/wincache/functions/wincache-ucache-clear.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - wincache_ucache_clear - - Elimina todo el contenido de la caché del usuario - - - - &reftitle.description; - - boolwincache_ucache_clear - - - - Borra o elimina todos los valores almacenados en la caché del usuario. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Usando <function>wincache_ucache_clear</function> - - -]]> - - &example.outputs; - - int(1) - ["red"]=> int(2) - ["orange"]=> int(4) - ["blue"]=> int(8) - ["cyan"]=> int(16) } -bool(true) -bool(false) -]]> - - - - - - - &reftitle.seealso; - - - wincache_ucache_set - wincache_ucache_add - wincache_ucache_delete - wincache_ucache_get - wincache_ucache_exists - wincache_ucache_meminfo - wincache_ucache_info - - - - - - - diff --git a/reference/wincache/functions/wincache-ucache-dec.xml b/reference/wincache/functions/wincache-ucache-dec.xml deleted file mode 100644 index 584149ab13..0000000000 --- a/reference/wincache/functions/wincache-ucache-dec.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - - - wincache_ucache_dec - - Disminuye el valor asociado a la clave - - - - &reftitle.description; - - mixedwincache_ucache_dec - stringkey - intdec_by1 - boolsuccess - - - Disminuye el valor asociado a la key por 1 o como se especifica - por dec_by. - - - - &reftitle.parameters; - - - - key - - - El parámetro key que se utiliza para almacenar la variable en la caché. - key distingue mayúsculas de minúsculas. - - - - - dec_by - - - El valor de la variable asociada por el que conseguirá que key disminuya. - Si el argumento es un número de punto flotante se truncará al integer más cercano. La variable asociada - con la key debe ser de tipo long, en caso contrario - la función falla y devolverá &false;. - - - - - success - - - Será establecido a &true; en caso de éxito y &false; en caso de error. - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor decrementado en caso de éxito y &false; en caso de error. - - - - &reftitle.examples; - - - Usando <function>wincache_ucache_dec</function> - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - wincache_ucache_inc - wincache_ucache_cas - - - - - - - diff --git a/reference/wincache/functions/wincache-ucache-delete.xml b/reference/wincache/functions/wincache-ucache-delete.xml deleted file mode 100644 index 165e174122..0000000000 --- a/reference/wincache/functions/wincache-ucache-delete.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - - - wincache_ucache_delete - - Elimina las variables de la memoria caché del usuario - - - - &reftitle.description; - - boolwincache_ucache_delete - mixedkey - - - Elimina los elementos de la caché del usuario apuntado por key. - - - - &reftitle.parameters; - - - - key - - - El parámetro key que se utiliza para almacenar la variable en la caché. - key distingue mayúsculas de minúsculas. key puede ser un - array de claves. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - Si key es un array, entonces la función devuelve &false; - si cada elemento del array no se borra de la memoria caché del usuario, en caso contrario devuelve un - array que consta de todas las claves que se eliminan. - - - - &reftitle.examples; - - - Usando <function>wincache_ucache_delete</function> con <parameter>key</parameter> como un string - - -]]> - - &example.outputs; - - - - - - - - Using<function>wincache_ucache_delete</function> con <parameter>key</parameter> como un array - - '5', 'blue' => '6', 'yellow' => '7', 'cyan' => '8'); -wincache_ucache_set($array1); -$array2 = array('green', 'blue', 'yellow', 'cyan'); -var_dump(wincache_ucache_delete($array2)); -?> -]]> - - &example.outputs; - - string(5) "green" - [1]=> string(4) "blue" - [2]=> string(6) "yellow" - [3]=> string(4) "cyan" } -]]> - - - - - - Using <function>wincache_ucache_delete</function> con <parameter>key</parameter> como un array donde algunos elementos no se pueden eliminar - - '5', 'blue' => '6', 'yellow' => '7', 'cyan' => '8'); -wincache_ucache_set($array1); -$array2 = array('orange', 'red', 'yellow', 'cyan'); -var_dump(wincache_ucache_delete($array2)); -?> -]]> - - &example.outputs; - - string(6) "yellow" - [1]=> string(4) "cyan" } -]]> - - - - - - &reftitle.seealso; - - - wincache_ucache_set - wincache_ucache_add - wincache_ucache_get - wincache_ucache_clear - wincache_ucache_exists - wincache_ucache_meminfo - wincache_ucache_info - - - - - - - diff --git a/reference/wincache/functions/wincache-ucache-exists.xml b/reference/wincache/functions/wincache-ucache-exists.xml deleted file mode 100644 index fe21dddd47..0000000000 --- a/reference/wincache/functions/wincache-ucache-exists.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - - wincache_ucache_exists - - Comprueba si una variable existe en la caché del usuario - - - - &reftitle.description; - - boolwincache_ucache_exists - stringkey - - - Comprueba si una variable con la key existe en la caché de usuario o no. - - - - &reftitle.parameters; - - - - key - - - La key que se utiliza para almacenar la variable en la caché. - key distingue mayúsculas de minúsculas. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si la variable con la key existe, - en caso contrario devuelve &false;. - - - - &reftitle.examples; - - - Usando <function>wincache_ucache_exists</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - - wincache_ucache_set - wincache_ucache_add - wincache_ucache_get - wincache_ucache_clear - wincache_ucache_delete - wincache_ucache_meminfo - wincache_ucache_info - - - - - - - diff --git a/reference/wincache/functions/wincache-ucache-get.xml b/reference/wincache/functions/wincache-ucache-get.xml deleted file mode 100644 index 7306235d3d..0000000000 --- a/reference/wincache/functions/wincache-ucache-get.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - - - wincache_ucache_get - - Obtiene una variable almacenada en la caché del usuario - - - - &reftitle.description; - - mixedwincache_ucache_get - mixedkey - boolsuccess - - - Obtiene una variable almacenada en la caché del usuario. - - - - &reftitle.parameters; - - - - key - - - La key que se utiliza para almacenar la variable en la caché. - key distingue mayúsculas de minúsculas. key puede ser - un array de claves. En este caso el valor de retorno será un array de valores de cada elemento en - el array key. Si un objeto, o un array que contiene objetos, - es retornado, entonces los objetos serán decodificados. Véase - __wakeup() para más detalles sobre decodificar objetos. - - - - - success - - - Se establecerá en &true; en caso de éxito y &false; en caso de error. - - - - - - - - &reftitle.returnvalues; - - Si key es un string, la función devuelve el valor de la variable almacenada con esa clave. - El parámetro success es establecido a &true; en caso de éxito y - a &false; en caso de error. - - - El parámetro key es un array, el parámetro success - siempre se establece en &true;. El array devuelto (pares nombre => valor) - contendrá sólo aquellos pares nombre => valor en donde la operación de obtención de caché de - usuario se ha realizado correctamente. Si ninguna de las claves del array encuentran una coincidencia - en la caché del usuario, un array vacío será devuelto. - - - - &reftitle.examples; - - - <function>wincache_ucache_get</function> con <parameter>key</parameter> como un string - - -]]> - - &example.outputs; - - - - - - - - <function>wincache_ucache_get</function> con <parameter>key</parameter> como un array - - '5', 'Blue' => '6', 'yellow' => '7', 'cyan' => '8'); -wincache_ucache_set($array1); -$array2 = array('green', 'Blue', 'yellow', 'cyan'); -var_dump(wincache_ucache_get($array2, $success)); -var_dump($success); -?> -]]> - - &example.outputs; - - string(1) "5" - ["Blue"]=> string(1) "6" - ["yellow"]=> string(1) "7" - ["cyan"]=> string(1) "8" } -bool(true) -]]> - - - - - - - &reftitle.seealso; - - - wincache_ucache_add - wincache_ucache_set - wincache_ucache_delete - wincache_ucache_clear - wincache_ucache_exists - wincache_ucache_meminfo - wincache_ucache_info - __wakeup() - - - - - - - diff --git a/reference/wincache/functions/wincache-ucache-inc.xml b/reference/wincache/functions/wincache-ucache-inc.xml deleted file mode 100644 index 69b88d0e88..0000000000 --- a/reference/wincache/functions/wincache-ucache-inc.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - - - wincache_ucache_inc - - Incrementa el valor asociado a la clave - - - - &reftitle.description; - - mixedwincache_ucache_inc - stringkey - intinc_by1 - boolsuccess - - - Incrementa el valor asociado a la key por 1 o como se especifica - por inc_by. - - - - &reftitle.parameters; - - - - key - - - La key que se utiliza para almacenar la variable en la caché. - key distingue mayúsculas de minúsculas. - - - - - inc_by - - - El valor por el cual la variable asociada con la key será incrementada. - Si el argumento es un número de punto flotante se truncará al integer más cercano. La variable - asociada con la key debe ser de tipo long, de lo contrario - la función falla y devuelve &false;. - - - - - success - - - Se establecerá en &true; en caso de éxito y &false; en caso de error. - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor incrementado en caso de éxito y &false; en caso de error. - - - - &reftitle.examples; - - - Usando <function>wincache_ucache_inc</function> - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - wincache_ucache_dec - wincache_ucache_cas - - - - - - - diff --git a/reference/wincache/functions/wincache-ucache-info.xml b/reference/wincache/functions/wincache-ucache-info.xml deleted file mode 100644 index a063225399..0000000000 --- a/reference/wincache/functions/wincache-ucache-info.xml +++ /dev/null @@ -1,215 +0,0 @@ - - - - - - wincache_ucache_info - - Recupera información sobre los datos almacenados en la caché del usuario - - - - &reftitle.description; - - arrayfalsewincache_ucache_info - boolsummaryonly&false; - stringkeyNULL - - - Recupera información sobre los datos almacenados en la caché del usuario. - - - - &reftitle.parameters; - - - - summaryonly - - - Controla si el array devuelto contiene información sobre las entradas de caché individuales - junto con el resumen caché del usuario. - - - - - key - - - La clave de una entrada en la caché del usuario. Si se especifica a continuación, el array - devuelto contendrá información sólo acerca de que la entrada de caché. Si no se especifica y - summaryonly es establecido a &false; entonces el array devuelto contendrá - información sobre todas las entradas en la caché. - - - - - - - - &reftitle.returnvalues; - - Array de metadatos sobre caché de usuario &return.falseforfailure; - - - El array devuelto por esta función contiene los siguientes elementos: - - - - total_cache_uptime - tiempo total en segundos que el caché de usuario ha sido activo - - - - - total_item_count - número total de elementos que están actualmente en la caché del usuario - - - - - is_local_cache - true si el caché es de metadatos para una instancia de caché local, - false si los metadatos es para el la caché global - - - - - total_hit_count - número de veces que los datos se han servido de la memoria caché - - - - - total_miss_count - número de veces que los datos no se han encontrado en la caché - - - - - ucache_entries - un array que contiene la información sobre todos los elementos almacenados en caché: - - - - key_name - nombre de la clave que se utiliza para almacenar los datos - - - - - value_type - tipo de valor almacenado por la clave - - - - - use_time - tiempo en segundos desde el fichero ha sido visitado en la caché de código de operación - - - - - last_check - tiempo en segundos desde el fichero ha sido chequeado para modificaciones - - - - - is_session - indica si los datos son una variable de sesión - - - - - ttl_seconds - el tiempo restante de los datos a vivir en la memoria caché, 0 significa infinito - - - - - age_seconds - tiempo transcurrido desde el momento que los datos han sido añadidos en la caché - - - - - hitcount - número de veces que los datos se han servido de la memoria caché - - - - - - - - - - &reftitle.examples; - - - Usar <function>wincache_ucache_info</function> - - -]]> - - &example.outputs; - - int(0) - ["is_local_cache"] => bool(false) - ["total_item_count"] => int(1) - ["total_hit_count"] => int(3) - ["total_miss_count"] => int(1) - ["ucache_entries"] => Array(1) - ( [1] => Array(6) - ( - ["key_name"] => string(5) "green" - ["value_type"] => string(4) "long" - ["is_session"] => int(0) - ["ttl_seconds"] => int(0) - ["age_seconds"] => int(0) - ["hitcount"] => int(3) - ) - ) -) -]]> - - - - - - - &reftitle.seealso; - - - wincache_fcache_meminfo - wincache_ocache_fileinfo - wincache_ocache_meminfo - wincache_rplist_meminfo - wincache_rplist_fileinfo - wincache_refresh_if_changed - wincache_ucache_meminfo - wincache_scache_info - wincache_scache_meminfo - - - - - - - diff --git a/reference/wincache/functions/wincache-ucache-meminfo.xml b/reference/wincache/functions/wincache-ucache-meminfo.xml deleted file mode 100644 index 3a69433b8f..0000000000 --- a/reference/wincache/functions/wincache-ucache-meminfo.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - - wincache_ucache_meminfo - - Recupera información sobre el uso de memoria caché de usuario - - - - &reftitle.description; - - arrayfalsewincache_ucache_meminfo - - - - Recupera información sobre el uso de memoria caché del usuario. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Array de metadatos sobre el uso de la memoria caché de usuario &return.falseforfailure; - - - El array devuelto por esta función contiene los siguientes elementos: - - - - memory_total - cantidad de memoria en bytes asignado para la caché de usuario - - - - - memory_free - cantidad de memoria libre en bytes disponible para la caché de usuario - - - - - num_used_blks - número de bloques de memoria utilizados por el caché del usuario - - - - - num_free_blks - número de bloques disponibles en la memoria de la caché del usuario - - - - - memory_overhead - cantidad de memoria en bytes utilizado para las estructuras de los usuarios de caché interna - - - - - - - - &reftitle.examples; - - - Ejemplo de <function>wincache_ucache_meminfo</function> - - - - - -]]> - - &example.outputs; - - 5242880 - [memory_free] => 5215056 - [num_used_blks] => 6 - [num_free_blks] => 3 - [memory_overhead] => 176 -) -]]> - - - - - - - &reftitle.seealso; - - - wincache_fcache_fileinfo - wincache_fcache_meminfo - wincache_ocache_fileinfo - wincache_rplist_fileinfo - wincache_rplist_meminfo - wincache_refresh_if_changed - wincache_ucache_info - wincache_scache_info - wincache_scache_meminfo - - - - - - - diff --git a/reference/wincache/functions/wincache-ucache-set.xml b/reference/wincache/functions/wincache-ucache-set.xml deleted file mode 100644 index c2aa63b6b4..0000000000 --- a/reference/wincache/functions/wincache-ucache-set.xml +++ /dev/null @@ -1,209 +0,0 @@ - - - - - - - - wincache_ucache_set - Añade una variable a la caché de usuario y sobrescribe la variable si ya existe en la caché - - - &reftitle.description; - - boolwincache_ucache_set - mixedkey - mixedvalue - intttl0 - - - boolwincache_ucache_set - arrayvalues - mixedunusedNULL - intttl0 - - - Añade una variable a la caché de usuario. Sobrescribe una variable si ya existe - en la caché. La variable así creada o actualizada permanecerá en la caché de usuario - mientras no se alcance el tiempo de expiración o hasta que no se elimine con la función - wincache_ucache_delete o la función wincache_ucache_clear. - - - - &reftitle.parameters; - - - - key - - - Almacena la variable usando la clave key. - Si una variable usando la misma clave key ya está presente, - la función sobrescribirá el valor anterior con el nuevo. El parámetro key - es sensible a mayúsculas y minúsculas. key también puede ser un - array de pares nombre => valor donde los nombres serán usados como claves. Esto puede ser útil - para añadir múltiples valores en la caché en una sola operación, evitando así las condiciones de carrera. - - - - - value - - - Valor de la variable a almacenar. El parámetro Value - soporta todos los tipos de datos, excepto recursos, como punteros de archivos. Este parámetro - es ignorado si el primer argumento es un array. Es convención pasar &null; como - value cuando se usa un array en el parámetro key. - Si el parámetro value es un objeto, o un array que contiene objetos, - entonces todos los objetos serán serializados. Consulte la función __sleep() - para más detalles sobre la serialización de objetos. - - - - - values - - - Array asociativo de claves y valores. - - - - - ttl - - - Tiempo de vida de la variable en la caché, en segundos. Después del tiempo especificado - por el parámetro ttl, la variable almacenada será eliminada de la caché de usuario. - Este parámetro toma por defecto el valor cero (0), lo que significa que la variable - permanecerá en la caché hasta que no sea explícitamente eliminada llamando a la función - wincache_ucache_delete o la función wincache_ucache_clear. - - - - - - - - &reftitle.returnvalues; - - Si key es un &string;, la función devolverá &true; en caso de éxito, - &false; si ocurre un error. - - - Si key es un array, la función devolverá: - - - - Si todas las parejas nombre => valor del array han podido ser definidas, - la función devolverá un array vacío. - - - - - Si ninguna de las parejas nombre => valor del array ha podido ser definida, - la función devolverá &false;. - - - - - Si algunas parejas han sido definidas, y otras no, la función - devolverá un array de parejas nombre => valor que no han podido ser definidas - en la caché de usuario. - - - - - - - &reftitle.examples; - - - Ejemplo con <function>wincache_ucache_set</function> y - el parámetro <parameter>key</parameter> en forma de &string; - - -]]> - - &example.outputs; - - - - - - - - Ejemplo con <function>wincache_ucache_set</function> y - el parámetro <parameter>key</parameter> en forma de &array; - - '5', 'Blue' => '6', 'yellow' => '7', 'cyan' => '8'); -var_dump(wincache_ucache_set($colors_array)); -var_dump(wincache_ucache_set($colors_array)); -var_dump(wincache_ucache_get('Blue')); -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - wincache_ucache_add - wincache_ucache_get - wincache_ucache_delete - wincache_ucache_clear - wincache_ucache_exists - wincache_ucache_meminfo - wincache_ucache_info - __sleep() - - - - - - - diff --git a/reference/wincache/functions/wincache-unlock.xml b/reference/wincache/functions/wincache-unlock.xml deleted file mode 100644 index db5b3544a4..0000000000 --- a/reference/wincache/functions/wincache-unlock.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - - wincache_unlock - - Libera un bloqueo exclusivo sobre una clave dada - - - - &reftitle.description; - - boolwincache_unlock - stringkey - - - Libera un bloqueo exclusivo que se obtuvo en una clave dada mediante wincache_lock. - Si cualquier otro proceso fue bloqueado en espera de el bloqueo en esta clave, este proceso será capaz de - obtener el bloqueo. - - - - Usando wincache_lock y wincache_unlock puede causar bloqueos al - ejecutar los scripts PHP en un entorno de multi-proceso, como FastCGI. No utilice estas funciones a menos - que esté absolutamente seguro de que necesitan para su uso. Para la mayoría de las operaciones en la caché - de usuario no es necesario el uso de estas funciones. - - - - - &reftitle.parameters; - - - - key - - - Nombre de la llave en la caché para liberar el bloqueo. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - - Usar <function>wincache_unlock</function> - - -]]> - - - - - - - &reftitle.seealso; - - - wincache_lock - wincache_ucache_set - wincache_ucache_get - wincache_ucache_delete - wincache_ucache_clear - wincache_ucache_exists - wincache_ucache_meminfo - wincache_ucache_info - wincache_scache_info - - - - - - - diff --git a/reference/wincache/ini.xml b/reference/wincache/ini.xml deleted file mode 100644 index 7e26bd4e94..0000000000 --- a/reference/wincache/ini.xml +++ /dev/null @@ -1,520 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - La siguiente tabla enumera y explica los ajustes de configuración - proporcionados por la extensión WinCache: - - - - Opciones de configuración de WinCache - - - - &Name; - &Default; - Mínimo - Máximo - &Changeable; - &Changelog; - - - - - wincache.fcenabled - "1" - "0" - "1" - INI_ALL - Disponible a partir de WinCache 1.0.0 - - - wincache.fcenabledfilter - "NULL" - "NULL" - "NULL" - INI_SYSTEM - Disponible a partir de WinCache 1.0.0 - - - wincache.fcachesize - "24" - "5" - "255" - INI_SYSTEM - Disponible a partir de WinCache 1.0.0 - - - wincache.fcndetect - "1" - "0" - "1" - INI_SYSTEM - Disponible a partir de WinCache 1.1.0 - - - wincache.maxfilesize - "256" - "10" - "2048" - INI_SYSTEM - Disponible a partir de WinCache 1.0.0 - - - wincache.ocenabled - "1" - "0" - "1" - INI_ALL - Disponible a partir de WinCache 1.0.0. Eliminada a partir de 2.0.0.0 - - - wincache.ocenabledfilter - "NULL" - "NULL" - "NULL" - INI_SYSTEM - Disponible a partir de WinCache 1.0.0. Eliminada a partir de 2.0.0.0 - - - wincache.ocachesize - "96" - "15" - "255" - INI_SYSTEM - Disponible a partir de WinCache 1.0.0. Eliminada a partir de 2.0.0.0 - - - wincache.filecount - "4096" - "1024" - "16384" - INI_SYSTEM - Disponible a partir de WinCache 1.0.0 - - - wincache.chkinterval - "30" - "0" - "300" - INI_SYSTEM - Disponible a partir de WinCache 1.0.0 - - - wincache.ttlmax - "1200" - "0" - "7200" - INI_SYSTEM - Disponible a partir de WinCache 1.0.0 - - - wincache.enablecli - 0 - 0 - 1 - INI_SYSTEM - Disponible a partir de WinCache 1.0.0 - - - wincache.ignorelist - NULL - NULL - NULL - INI_ALL - Disponible a partir de WinCache 1.0.0 - - - wincache.namesalt - NULL - NULL - NULL - INI_SYSTEM - Disponible a partir de WinCache 1.0.0 - - - wincache.ucenabled - 1 - 0 - 1 - INI_SYSTEM - Disponible a partir de WinCache 1.1.0 - - - wincache.ucachesize - 8 - 5 - 85 - INI_SYSTEM - Disponible a partir de WinCache 1.1.0 - - - wincache.scachesize - 8 - 5 - 85 - INI_SYSTEM - Disponible a partir de WinCache 1.1.0 - - - wincache.rerouteini - NULL - NULL - NULL - INI_SYSTEM - Disponible a partir de WinCache 1.2.0. Eliminada a partir de 1.3.7 - - - wincache.reroute_enabled - 1 - 0 - 1 - INI_SYSTEM|INI_PERDIR - Disponible a partir de WinCache 1.3.7 - - - wincache.srwlocks - 1 - 0 - 1 - INI_SYSTEM - Disponible a partir de WinCache 1.3.6.3. Eliminada a partir de 2.0.0.0 - - - wincache.filemapdir - NULL - NULL - NULL - INI_SYSTEM - Disponible a partir de WinCache 1.3.7.4 - - - -
    - &ini.php.constants; -
    - - &ini.descriptions.title; - - - - - - wincache.fcenabled - bool - - - Habilita o deshabilita la caché de ficheros. - - - - - wincache.fcenabledfilter - string - - - - Define una lista separada por comas de identificadores de sitios web de IIS donde debería - habilitarse o deshabilitarse la caché de ficheros. Esta opción funciona junto - con wincache.fcenabled: si wincache.fcenabled - se establece a 1, los sitios enumerados en wincache.fcenabledfilter - tendrán la caché de ficheros desactivada; si wincache.fcenabled - se establece a 0, los sitios enumerados en wincache.fcenabledfilter - tendrán la caché activada. - - - - - - wincache.fcachesize - int - - - - Define el tamaño máximo de memoria (en megabytes) que se asigna a la caché de ficheros. - Si el tamaño total de ficheros en caché excede el valor especificado en este ajuste, - se eliminarán los ficheros más antiguos de la caché de ficheros. - - - - - - wincache.fcndetect - bool - - - - Habilita o deshabilita la detección de notificaciones de cambios en ficheros. Si está soportada - la notificación de cambios en ficheros, se usará para refrescar las entradas de la caché de códigos de operación y de ficheros - en cuanto los ficheros correspondientes sean modificados en un sistema de ficheros. Si la notificación de cambios en ficheros - no está soportada, por ejemplo, al usar la compartición de ficheros en red, wincache hará un sondeo para - los cambios en ficheros en intervalos de tiempo regulares especificados por wincache.chkinterval. - - - - - - wincache.maxfilesize - int - - - - Define el tamaño máximo permitido (en kilobytes) para que un fichero sea almacenado en caché. - Si un fichero excede el valor especificado, no será almacenado en caché. - Este ajuste se aplica solamente a la caché de ficheros. - - - - - - wincache.ocenabled - bool - - - Esta opción ha sido eliminada a partir de 2.0.0.0 - Habilita o deshabilita la caché de códigos de operaciones ("opcodes") - - - - - wincache.ocenabledfilter - string - - - Esta opción ha sido eliminada a partir de 2.0.0.0 - - Define una lista separada por comas de identificadores de sitios web de IIS donde se debería - habilitar o deshabilitar la caché de códigos de operaciones. Este ajuste funciona junto con - wincache.ocenabled: si wincache.ocenabled - se establece a 1, los sitios enumerados en wincache.ocenabledfilter - tendrán la caché de códigos de operaciones desactivada; si wincache.ocenabled - se establece a 0, los sitios enumerados en wincache.ocenabledfilter - tendrán la caché de códigos de operaciones activada. - - - - - - wincache.ocachesize - int - - - Esta opción ha sido eliminada a partir de 2.0.0.0 - - Define el tamaño máximo de memoria (en megabytes) que se asigna a la caché de - códigos de operaciones. Si el tamaño de dicha caché excede el valor especificado - se eliminarán de la caché los códigos de operación más antiguos. Observe que el tamaño - de la caché de códigos de operaciones debe ser al menos tres veces mayor que el tamaño de la caché de ficheros. - Si no fuera así, el tamaño de la caché de códigos de operaciones será aumentada automáticamente. - - - - - - wincache.filecount - int - - - - Define cuántos ficheros se preveen que almacene en caché la extensión, para así asignar el - tamaño de memoria apropiada en el momento del arranque. Si el número de ficheros excede el valor - especificado, WinCache reasignará tanta memoria como sea necesaria. - - - - - - wincache.chkinterval - int - - - - Define la frecuencia (en segundos) con que la extensión comprobará los cambios en ficheros - para refrescar la caché. Si se establece a 0 se deshabilitará el refresco de la caché. - Los cambios en ficheros no se verán reflejados en la caché al menos que la entrada de la caché - para tales ficheros sea eliminada mediante limpieza ("scavenger"), o la provisión ("pool") de aplicaciones - de IIS sea reclicada, o se llame a la función wincache_refresh_if_changed. - - - - - - wincache.ttlmax - int - - - - Define el tiempo máximo de vida (en segundos) para una entrada de caché que no se esté usando. - Si se establece a 0, se desactivará la limpieza de la caché, por lo que las entradas en caché nunca - serán eliminadas durante el tiempo de vida del proceso obrero ("worker") de IIS. - - - - - - wincache.enablecli - bool - - - - Define si la caché se habilita cuando PHP se está ejecutando en modo de línea de comandos (CLI). - - - - - - wincache.ignorelist - string - - - - Define una lista de ficheros que no deberían ser almacenados en caché por la extensión. - La lista de ficheros se especifica empleando solamente nombres de ficheros, separados por - el símbolo tubería - "|". - - Ejemplo de <literal>wincache.ignorelist</literal> - - - - - - - - - - wincache.namesalt - string - - - - Define un string que será usado al nombrar los objetos específicos - de la extensión que están almacenados en la memoria compartida. Se emplea - para evitar conflictos que podrían causarse si otras aplicaciones dentro - de un proceso obrero de IIS intenta acceder a la memoria compartida. La longitud - del sting namesalt no puede exceder de 8 caracteres. - - - - - - wincache.ucenabled - bool - - - - Habilita o deshabilita la caché de usuarios. - - - - - - wincache.ucachesize - int - - - - Define el tamaño máximo de memoria en megabytes que se asigna para la caché de usuario. Si el tamaño - total de las variables almacenadas en la caché de usuario excede el valor especificado, se eliminarán - las variables más antiguas de la caché. - - - - - - wincache.scachesize - int - - - - Define el tamaño máximo de memoria en megabytes que se asigna para la caché de sesión. Si el tamaño - total de los datos almacenados en la caché de sesión excede el valor especificado, se eliminarán - los datos más antiguos de la caché. - - - - - - wincache.rerouteini - string - - - - Esta opción ha sido eliminada a partir de 1.3.7. - Véase wincache.reroute_enabled para una funcionalidad similar a partir de 1.3.7. - - - Especifica una ruta absoluta o relativa al fichero reroute.ini que contiene la lista de funciones de PHP - cuya implementación debería ser remplazada con las funciones equivalentes de WinCache. Si se especifica una ruta relativa, - se asume que sea relativa a la ubicación del fichero php-cgi.exe. - - - - - - wincache.reroute_enabled - bool - - - - Habilita o deshabilita el redireccionamiento de varias funciones de E/S de ficheros a través de la caché de ficheros. - - - - - - wincache.srwlocks - bool - - - Esta opción ha sido eliminada a partir de 2.0.0.0 - - Habilita o deshabilita el uso de bloqueos ("locks) de lectura/escritura compartidos. La deshabilitación es útil cuando se dan condiciones de problemas de punto muerto ("deadlock") en WinCache. - - - - - - wincache.filemapdir - string - - - - Especifica una ruta absoluta al directorio donde WinCache almacenará los ficheros temporales empleados para segmentos de memoria compartida. - - - Este directorio debe estar en la máquina local y no en un sistema de ficheros en la red. - - - Si no se especifica este directorio, WinCache utilizará el fichero de paginación de Windows para todos los segmentos de memoria compartida. - - - - - -
    - - diff --git a/reference/wincache/reference.xml b/reference/wincache/reference.xml deleted file mode 100644 index ee424f1644..0000000000 --- a/reference/wincache/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - &Functions; de WinCache - - &reference.wincache.entities.functions; - - - - diff --git a/reference/wincache/setup.xml b/reference/wincache/setup.xml deleted file mode 100644 index b1375cd64f..0000000000 --- a/reference/wincache/setup.xml +++ /dev/null @@ -1,345 +0,0 @@ - - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - La extensión actualmente solo es compatible con las siguientes configuraciones: - - Sistema Operativo Windows: - - - Windows XP SP3 con IIS 5.1 y la Extensión FastCGI - - - Windows Server 2003 con IIS 6.0 y la Extensión FastCGI - - - Windows Vista SP1 con IIS 7.0 y el módulo FastCGI - - - Windows Server 2008 con IIS 7.0 y el módulo FastCGI - - - Windows 7 con IIS 7.5 y el módulo FastCGI - - - Windows Server 2008 R2 con IIS 7.5 y el módulo FastCGI - - - PHP: - - - PHP 5.2.X, compilación no segura para subprocesos - - - PHP 5.3 X86, compilación VC9 no segura para subprocesos - - - - - La extensión WinCache solo puede ser utilizada cuando IIS está configurado para ejecutar PHP a través de FastCGI. - - -
    -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;wincache. - - - Hay dos paquetes para esta extensión: un paquete es para las versiones PHP 5.2.X, - y el otro paquete es para PHP 5.3.X. Elija el paquete adecuado para la versión de PHP - que esté utilizando. - - - Para instalar y activar la extensión, siga estos pasos: - - - - - Descomprima el paquete en una ubicación temporal. - - - - - Copie el archivo php_wincache.dll en la carpeta de extensiones PHP. - Generalmente, esta carpeta se llama "ext" y está ubicada en el mismo directorio que todos - los archivos binarios de PHP. Por ejemplo: C:\Program Files\PHP\ext. - - - - - Con un editor de texto, abra el archivo php.ini, que generalmente se encuentra en el mismo - directorio que todos los archivos binarios de PHP. Por ejemplo: - C:\Program Files\PHP\php.ini. - - - - - Agregue la siguiente línea al final del archivo php.ini: - extension = php_wincache.dll. - - - - - Guarde y cierre el archivo php.ini. - - - - - Reinicie el grupo de aplicaciones IIS para que PHP recoja los cambios de configuración. Para verificar que la extensión se ha activado, cree un archivo llamado - phpinfo.php que contenga una llamada a la función - phpinfo. - - - - - Guarde el archivo phpinfo.php en el directorio raíz de un - sitio web IIS que utilice PHP, luego abra un navegador y realice una solicitud a - http://localhost/phpinfo.php. Busque una sección llamada wincache - en la página devuelta. Si la extensión está activada, la salida de - phpinfo listará los parámetros de configuración - proporcionados por WinCache. - - - - - - No olvide eliminar el archivo phpinfo.php del directorio raíz después de haber verificado que la extensión se ha activado. - - -
    - &reference.wincache.ini; - -
    - Script de estadísticas WinCache - - El paquete de instalación para WinCache incluye un script PHP, - wincache.php, que puede ser utilizado para obtener información y estadísticas sobre la caché. - - - Si la extensión WinCache se instaló a través del instalador de Microsoft Web Platform, - entonces este script se encuentra en - %SystemDrive%\Program Files\IIS\Windows Cache for PHP\. - En una versión de 64 bits del sistema operativo Windows Server, el script se encuentra en - %SystemDrive%\Program Files (x86)\IIS\Windows Cache for PHP. - Si la extensión se instaló manualmente, entonces el archivo wincache.php - estará ubicado en el mismo directorio desde el cual se extrajo el contenido del paquete de instalación. - - - Para usar wincache.php, cópielo en el directorio raíz de un sitio web o - en cualquier subdirectorio. Para proteger el script, ábralo en cualquier editor y - reemplace los valores de las constantes USERNAME y PASSWORD. Si alguna otra autenticación IIS está habilitada en el servidor, entonces siga las instrucciones - en los comentarios: - - Configuración de la autenticación para <filename>wincache.php</filename> - - -]]> - - - - - Siempre proteja el script wincache.php utilizando el mecanismo de autenticación integrado o el mecanismo de autenticación del servidor. Dejar este script sin protección puede comprometer la seguridad de su aplicación web - y del servidor. - - - -
    -
    - Manejador de sesiones WinCache - - El manejador de sesiones WinCache (disponible desde WinCache 1.1.0) puede ser utilizado - para configurar PHP para almacenar los datos de sesión en la memoria compartida del caché de sesión. - El uso de la memoria compartida en lugar de la sesión predeterminada ayuda a mejorar el rendimiento - de las aplicaciones PHP que almacenan grandes cantidades de datos en objetos de sesión. - El caché de sesión Wincache utiliza archivos basados en memoria compartida, lo que - asegura que los datos de sesión no se perderán durante el reciclaje de la cola de aplicaciones IIS. - - - Para configurar PHP para usar el manejador de sesiones WinCache, establezca el parámetro - session.save_handler del archivo - php.ini a wincache. - De forma predeterminada, la ubicación donde se almacenan los archivos temporales en Windows se usa - para almacenar los datos de sesión. Para cambiar esta ubicación, use la directiva - session.save_path. - - Activar el manejador de sesiones WinCache - - - - - -
    -
    - Redirecciones de funciones WinCache - - NOTA: - wincache.rerouteini - fue eliminado con WinCache 1.3.7.0. Esto ha sido reemplazado por el redireccionamiento automático de funciones. Ver: - wincache.reroute_enabled - - - Las funcionalidades de redireccionamiento de funciones de WinCache (disponibles - desde WinCache 1.2.0, eliminadas desde WinCache 1.3.7.0) pueden ser utilizadas para reemplazar funciones PHP nativas por sus equivalentes optimizados para casos particulares. La extensión - Wincache incluye implementaciones de funciones PHP optimizadas para Windows, - especialmente en casos de acceso a red o sistema de archivos. - Las siguientes funciones están involucradas: - - - - - file_exists - - - - - file_get_contents - - - - - readfile - - - - - is_readable - - - - - is_writable - - - - - is_dir - - - - - realpath - - - - - filesize - - - - - Para configurar el redireccionamiento de funciones con Wincache, use el archivo - reroute.ini incluido en el paquete. Cópielo en el directorio - donde se encuentra php.ini. Luego, agregue wincache.rerouteini en - php.ini y especifique la ruta absoluta o relativa a - reroute.ini. - - Activación de las funcionalidades de redireccionamiento de funciones de WinCache - - - - - - - - Si está habilitado, se recomienda aumentar el tamaño del caché de archivos. Esto se puede hacer - usando el parámetro wincache.fcachesize. - - - - El archivo reroute.ini contiene la correspondencia entre la función PHP nativa y - el equivalente de Wincache. Cada línea en el archivo define una correspondencia. Aquí está la sintaxis: - - - <Nombre de la función PHP>:[<número de parámetros de la función>]=<nombre de la función wincache> - - - A continuación se muestra un ejemplo de archivo. En este ejemplo, las llamadas a las funciones PHP - file_get_contents serán reemplazadas por wincache_file_get_contents - solo si el número de parámetros pasados a la función es menor o igual a dos. Es útil especificar el número de parámetros cuando la función de reemplazo no está diseñada para usar todos ellos. - - Reroute.ini - - - - - -
    -
    - - diff --git a/reference/wincache/win32build.xml b/reference/wincache/win32build.xml deleted file mode 100644 index dd0dea49e4..0000000000 --- a/reference/wincache/win32build.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - Compilación en Windows -
    - Prerrequisitos - - Para compilar la extensión WinCache, se necesitará: - - - - el código fuente de PHP - - - un entorno de compilación PHP - - - el código fuente de WinCache - - - - Para completar los dos primeros pasos, siga la guía paso a paso - Compilar PHP en Windows. - - - Para obtener el código fuente de WinCache, siga las instrucciones descritas - en Descargar extensiones PECL. - -
    -
    - Compilar y construir - - Los siguientes pasos describen cómo compilar y construir WinCache en Windows: - - - - Abra una ventana de comandos utilizada para compilar PHP - - - Vaya al directorio raíz donde se encuentran las fuentes de PHP - - - - Ejecute el comando: - - - - - - - - Ejecute el comando: - - - - La salida contendrá una nueva opción --enable-wincache. - - - - - Ejecute el comando: - - - - --enable-wincache es la única opción adicional requerida - para asegurarse de que la extensión WinCache se compile correctamente. - Esta opción permite construir WinCache y enlazarlo estáticamente con la - DLL de PHP. Para construir la extensión como una DLL externa, use la - opción --enable-wincache=shared. - - - - - Ejecute el comando: - - - - - - -
    -
    - Verificar la compilación - - Los siguientes pasos describen cómo verificar que WinCache se ha compilado correctamente: - - - - - Vaya al directorio donde se construyen los archivos PHP. - - - - - Ejecute el comando: - - - - Si WinCache se ha compilado correctamente, la salida de este comando listará - las directivas INI y las funciones soportadas por WinCache. - - - -
    -
    - - diff --git a/reference/wkhtmltox/book.xml b/reference/wkhtmltox/book.xml deleted file mode 100644 index 41309bcf51..0000000000 --- a/reference/wkhtmltox/book.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - - - - wkhtmltox - wkhtmltox - - - &reftitle.intro; - - libwkhtmltox es una librería LGPLv3 de código abierto para renderizar HTML en PDF y varios formatos de - imagen usando el motor de renderización QtWebKit. - - - - &reference.wkhtmltox.setup; - - &reference.wkhtmltox.wkhtmltox.pdf.converter; - &reference.wkhtmltox.wkhtmltox.pdf.object; - - &reference.wkhtmltox.wkhtmltox.image.converter; - - diff --git a/reference/wkhtmltox/configure.xml b/reference/wkhtmltox/configure.xml deleted file mode 100644 index 76049b44ed..0000000000 --- a/reference/wkhtmltox/configure.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - -
    - &reftitle.install; - - - Use al compilar PHP. - - - -
    - - - diff --git a/reference/wkhtmltox/ini.xml b/reference/wkhtmltox/ini.xml deleted file mode 100644 index 4c7122abf5..0000000000 --- a/reference/wkhtmltox/ini.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - -
    - &reftitle.runtime; - &extension.runtime; - - - wkhtmltox &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - wkhtmltox.graphics - Off - INI_SYSTEM|INI_PERDIR - >= 0.3.2 - - - -
    - &ini.php.constants; -
    - -&ini.descriptions.title; - - - - - - wkhtmltox.graphics - bool - - - - Permite que libwkhtmltox utilice gráficos. - - - - - -
    - - diff --git a/reference/wkhtmltox/setup.xml b/reference/wkhtmltox/setup.xml deleted file mode 100644 index 5339e2495f..0000000000 --- a/reference/wkhtmltox/setup.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - La fuente de libwkhtmltox y las liberaciones binarias se distribuyen en wkhtmltopdf.org. - - - - Los usuarios de Windows necesitan dar el paso adicional de añadir wkhtmltox.dll a su PATH. - - -
    - -
    - &reftitle.install; - - El código fuente de esta extensión, y los binarios para Windows están alojados en github, - - - Buscando el código fuente y construyendo la extensión: - - - - - - Buscando actualizaciones y reconstruyendo la extensión: - - - - -
    - - &reference.wkhtmltox.ini; -
    - - diff --git a/reference/wkhtmltox/wkhtmltox.image.converter.xml b/reference/wkhtmltox/wkhtmltox.image.converter.xml deleted file mode 100644 index 9eda4f70ca..0000000000 --- a/reference/wkhtmltox/wkhtmltox.image.converter.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - - La clase wkhtmltox\Image\Converter - wkhtmltox\Image\Converter - - - - -
    - &reftitle.intro; - - Convierte una entrada HTML en varios formatos de imagen - -
    - - -
    - &reftitle.classsynopsis; - - - - wkhtmltox\Image\Converter - - - - - wkhtmltox\Image\Converter - - - - - Constructor - - - &Methods; - - - - -
    - -
    - - &reference.wkhtmltox.wkhtmltox.image.entities.converter; - -
    - - diff --git a/reference/wkhtmltox/wkhtmltox.pdf.converter.xml b/reference/wkhtmltox/wkhtmltox.pdf.converter.xml deleted file mode 100644 index 6766ca5cad..0000000000 --- a/reference/wkhtmltox/wkhtmltox.pdf.converter.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - - La clase wkhtmltox\PDF\Converter - wkhtmltox\PDF\Converter - - - - -
    - &reftitle.intro; - - Convierte una entrada HTML, o un conjunto de entradas HTML, en una salida PDF - -
    - - -
    - &reftitle.classsynopsis; - - - - wkhtmltox\PDF\Converter - - - - - wkhtmltox\PDF\Converter - - - - - Constructor - - - &Methods; - - - - -
    - -
    - - &reference.wkhtmltox.wkhtmltox.pdf.entities.converter; - -
    - - diff --git a/reference/wkhtmltox/wkhtmltox.pdf.object.xml b/reference/wkhtmltox/wkhtmltox.pdf.object.xml deleted file mode 100644 index 1bb1849f04..0000000000 --- a/reference/wkhtmltox/wkhtmltox.pdf.object.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - La clase wkhtmltox\PDF\Object - wkhtmltox\PDF\Object - - - - -
    - &reftitle.intro; - - Representa un documento HTML, convertidor de entrada a PDF - -
    - - -
    - &reftitle.classsynopsis; - - - - wkhtmltox\PDF\Object - - - - - wkhtmltox\PDF\Object - - - - - Constructor - - - - - - -
    - -
    - - &reference.wkhtmltox.wkhtmltox.pdf.entities.object; - -
    - - diff --git a/reference/wkhtmltox/wkhtmltox/image/converter/construct.xml b/reference/wkhtmltox/wkhtmltox/image/converter/construct.xml deleted file mode 100644 index ec4a25e268..0000000000 --- a/reference/wkhtmltox/wkhtmltox/image/converter/construct.xml +++ /dev/null @@ -1,196 +0,0 @@ - - - - - - - - wkhtmltox\Image\Converter::__construct - Crea un nuevo convertidor de imágenes - - - - &reftitle.description; - - public wkhtmltox\Image\Converter::__construct - stringbuffer - arraysettings - - - Crea un convertidor de imágenes, utilizando opcionalmente un buffer de entrada - así como una configuración - - - - - &reftitle.parameters; - - - buffer - - - HTML - - - - - settings - - - - - - - - Nombre - Descripción - Valor - Registro de cambios - - - - - in - URL o ruta del archivo de entrada, si se usa la salida "-" - /ruta/hacia/marcado.html - >= 0.1.0 - - - out - Ruta del archivo de salida, si es "-" se usa stdout; por omisión, se usa un buffer interno - /ruta/hacia/salida.png - >= 0.1.0 - - - fmt - Formato de salida a usar - -
    - - - - - "" - predeterminado - - - jpg - salida como JPEG - - - png - salida como PNG - - - bmp - salida como mapa de bits - - - svg - salida como SVG - - - -
    - - >= 0.1.0 - - - transparent - En la salida PNG o SVG, hace el fondo transparente - booleano - >= 0.1.0 - - - screenWidth - El ancho de pantalla a usar para el renderizado en píxeles - 800 - >= 0.1.0 - - - smartWidth - Cuando es &true;, el ancho de la pantalla se extiende al ancho del contenido - booleano - >= 0.1.0 - - - quality - Factor de compresión a usar cuando la salida es una imagen JPEG - 94 - >= 0.1.0 - - - crop.left - Izquierda/coordenada X de la ventana a capturar, en píxeles - 200 - >= 0.1.0 - - - crop.top - Arriba/coordenada Y de la ventana a capturar, en píxeles - 200 - >= 0.1.0 - - - crop.width - Ancho de la ventana a capturar, en píxeles - 200 - >= 0.1.0 - - - crop.height - Altura de la ventana a capturar, en píxeles - 200 - >= 0.1.0 - - - load.cookieJar - Ruta del archivo utilizado para cargar y almacenar las cookies. - /tmp/cookies.txt - >= 0.1.0 - - - - - -
    -
    -
    -
    -
    - - - -
    - - diff --git a/reference/wkhtmltox/wkhtmltox/image/converter/convert.xml b/reference/wkhtmltox/wkhtmltox/image/converter/convert.xml deleted file mode 100644 index b249d104ee..0000000000 --- a/reference/wkhtmltox/wkhtmltox/image/converter/convert.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - wkhtmltox\Image\Converter::convert - Realiza la conversión de la imagen - - - - &reftitle.description; - - public stringnullwkhtmltox\Image\Converter::convert - - - - Realiza la conversión de la memoria intermedia de entrada - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Cuando se utilice el valor de retorno, se rellenará con el contenido de la memoria intermedia de conversión - - - - - - - diff --git a/reference/wkhtmltox/wkhtmltox/image/converter/getversion.xml b/reference/wkhtmltox/wkhtmltox/image/converter/getversion.xml deleted file mode 100644 index d0df468cdf..0000000000 --- a/reference/wkhtmltox/wkhtmltox/image/converter/getversion.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - wkhtmltox\Image\Converter::getVersion - Determina la versión del convertidor - - - - &reftitle.description; - - public stringwkhtmltox\Image\Converter::getVersion - - - - Determina la versión del convertidor según lo informado por libwkhtmltox - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un string de versión - - - - Esto todavía no se ha implementado por libwkhtmltox - - - - - - - diff --git a/reference/wkhtmltox/wkhtmltox/pdf/converter/add.xml b/reference/wkhtmltox/wkhtmltox/pdf/converter/add.xml deleted file mode 100644 index 9369ab190f..0000000000 --- a/reference/wkhtmltox/wkhtmltox/pdf/converter/add.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - wkhtmltox\PDF\Converter::add - Añade un objeto para su conversión - - - - &reftitle.description; - - public voidwkhtmltox\PDF\Converter::add - wkhtmltox\PDF\Objectobject - - - Añade el objeto dado a la conversión - - - - - &reftitle.parameters; - - - object - - - El objeto a añadir - - - - - - - - - - - diff --git a/reference/wkhtmltox/wkhtmltox/pdf/converter/construct.xml b/reference/wkhtmltox/wkhtmltox/pdf/converter/construct.xml deleted file mode 100644 index 78383cda65..0000000000 --- a/reference/wkhtmltox/wkhtmltox/pdf/converter/construct.xml +++ /dev/null @@ -1,250 +0,0 @@ - - - - - - - - wkhtmltox\PDF\Converter::__construct - Crea un nuevo conversor de PDF - - - - &reftitle.description; - - public wkhtmltox\PDF\Converter::__construct - arraysettings - - - Crea un nuevo conversor de PDF, utilizando opcionalmente una configuración. - - - - - &reftitle.parameters; - - - settings - - - - - - - - Nombre - Descripción - Valores - Registro de cambios - - - - - size.pageSize - Tamaño del papel del documento final - A4 - >= 0.1.0 - - - size.width - Ancho del documento final - 210mm - >= 0.1.0 - - - size.height - Altura del documento final - 297mm - >= 0.1.0 - - - orientation - Orientación del documento final - -
    - - - - - Landscape - - - Portrait - - - -
    - - >= 0.1.0 - - - colorMode - Modo de color del documento final - - - - - - - Color - - - Greyscale - - - -
    -
    - >= 0.1.0 -
    - - resolution - Resolución del documento final - La mayoría de las veces, no tiene ningún efecto - >= 0.1.0 - - - dpi - DPI a usar al imprimir - 80 - >= 0.1.0 - - - pageOffset - Entero a añadir a los números de página generados para el encabezado, - el pie de página y el índice - - >= 0.1.0 - - - copies - - - >= 0.1.0 - - - collate - Si se deben intercalar las copias - booleano - >= 0.1.0 - - - outline - Genera un índice PDF - booleano - >= 0.1.0 - - - outlineDepth - Profundidad máxima del índice - - >= 0.1.0 - - - dumpOutline - Ruta del archivo para extraer el índice XML - - >= 0.1.0 - - - out - Ruta para el archivo final, si es "-" se usa stdout - - >= 0.1.0 - - - documentTitle - Título del documento final - - >= 0.1.0 - - - useCompression - Activa o desactiva la compresión sin pérdida - booleano - >= 0.1.0 - - - margin.top - Tamaño del margen superior - 2cm - >= 0.1.0 - - - margin.bottom - Tamaño del margen inferior - 2cm - >= 0.1.0 - - - margin.left - Tamaño del margen izquierdo - 2cm - >= 0.1.0 - - - margin.right - Tamaño del margen derecho - 2cm - >= 0.1.0 - - - imageDPI - DPI máximo para las imágenes en el documento final - - >= 0.1.0 - - - imageQuality - El factor de compresión jpeg para las imágenes en el documento final - 94 - >= 0.1.0 - - - load.cookieJar - Ruta hacia el archivo utilizado para cargar y almacenar las cookies - /tmp/cookies.txt - >= 0.1.0 - - - - -
    -
    -
    -
    -
    - - - -
    - - diff --git a/reference/wkhtmltox/wkhtmltox/pdf/converter/convert.xml b/reference/wkhtmltox/wkhtmltox/pdf/converter/convert.xml deleted file mode 100644 index 8e65c5f14d..0000000000 --- a/reference/wkhtmltox/wkhtmltox/pdf/converter/convert.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - wkhtmltox\PDF\Converter::convert - Realiza la conversión a PDF - - - - &reftitle.description; - - public stringnullwkhtmltox\PDF\Converter::convert - - - - Realiza la conversión de todos los objetos añadidos anteriormente - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Donde se utiliza el valor de retorno, se llenará con el contenido del buffer de conversión - - - - - - - diff --git a/reference/wkhtmltox/wkhtmltox/pdf/converter/getversion.xml b/reference/wkhtmltox/wkhtmltox/pdf/converter/getversion.xml deleted file mode 100644 index 41da860c46..0000000000 --- a/reference/wkhtmltox/wkhtmltox/pdf/converter/getversion.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - wkhtmltox\PDF\Converter::getVersion - Determina la versión del convertidor - - - - &reftitle.description; - - public stringwkhtmltox\PDF\Converter::getVersion - - - - Determina la versión del convertidor según lo informado por libwkhtmltox - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un string de versión - - - - - - diff --git a/reference/wkhtmltox/wkhtmltox/pdf/object/construct.xml b/reference/wkhtmltox/wkhtmltox/pdf/object/construct.xml deleted file mode 100644 index 6da5578d45..0000000000 --- a/reference/wkhtmltox/wkhtmltox/pdf/object/construct.xml +++ /dev/null @@ -1,438 +0,0 @@ - - - - - - - - wkhtmltox\PDF\Object::__construct - Crea un nuevo objeto PDF - - - - &reftitle.description; - - public wkhtmltox\PDF\Object::__construct - stringbuffer - arraysettings - - - Crea un nuevo objeto PDF desde el buffer proporcionado, - y las configuraciones opcionales. - - - - - - &reftitle.parameters; - - - buffer - - - HTML - - - - - settings - - - - - - - - Nombre - Descripción - Valor - Registro de cambios - - - - - page - URL o ruta del archivo HTML a - convertir - - >= 0.1.0 - - - useExternalLinks - Establecer en &true; para convertir los enlaces externos - enlaces PDF en la salida - booleano - >= 0.1.0 - - - useLocalLinks - Establecer en &true; para convertir los enlaces internos - en los datos de entrada en enlaces PDF en la salida - booleano - >= 0.1.0 - - - produceForms - Establecer en &true; para convertir los formularios - HTML en formularios PDF - booleano - >= 0.1.0 - - - replacements - no documentado - - >= 0.1.0 - - - includeInOutline - Establecer en &true; para incluir las secciones - de este objeto en el contorno y la tabla de contenidos - booleano - >= 0.1.0 - - - pagesCount - Establecer en &true; para incluir en la tabla de contenidos el número - de páginas de este objeto - booleano - >= 0.1.0 - - - tocXsl - Establecer en hoja de estilo para convertir este objeto en un objeto de tabla de contenidos - - >= 0.1.0 - - - toc.useDottedLines - Establecer en &true; para usar líneas de puntos - en la tabla de contenidos - booleano - >= 0.1.0 - - - toc.captionText - El pie de ilustración para la tabla de contenidos - - >= 0.1.0 - - - toc.forwardLinks - Establecer en &true; para crear enlaces - desde la tabla de contenidos hacia el contenido - booleano - >= 0.1.0 - - - toc.backLinks - Establecer en &true; para crear enlaces - desde el contenido hacia la tabla de contenidos - booleano - >= 0.1.0 - - - toc.indentation - La indentación para la tabla de contenidos - 2em - >= 0.1.0 - - - toc.fontScale - El factor para reducir la fuente de caracteres - en todos los niveles de la tabla de contenidos - 0.8 - >= 0.1.0 - - - header.fontSize - El tamaño de la fuente de caracteres a usar en el encabezado - 13 - >= 0.1.0 - - - header.fontName - El nombre de la fuente de caracteres a usar en el encabezado - times - >= 0.1.0 - - - header.left - El texto para el lado izquierdo del encabezado - - >= 0.1.0 - - - header.center - El texto para el centro del encabezado - - >= 0.1.0 - - - header.right - El texto para el lado derecho del encabezado - - >= 0.1.0 - - - header.line - Activa o desactiva la regla horizontal bajo el encabezado - booleano - >= 0.1.0 - - - header.spacing - El espacio entre el encabezado y el contenido - 1.8 - >= 0.1.0 - - - header.htmlUrl - URL o la ruta hacia el archivo HTML a usar - en el encabezado - - >= 0.1.0 - - - footer.fontSize - El tamaño de la fuente de caracteres a usar en el pie de página - 13 - >= 0.1.0 - - - footer.fontName - El nombre de la fuente de caracteres a usar en el pie de página - times - >= 0.1.0 - - - footer.left - El texto para el lado izquierdo del pie de página - - >= 0.1.0 - - - footer.center - El texto para el centro del pie de página - - >= 0.1.0 - - - footer.right - El texto para el lado derecho del pie de página - - >= 0.1.0 - - - footer.line - Activa o desactiva la regla horizontal bajo el pie de página - booleano - >= 0.1.0 - - - footer.spacing - El espacio entre el pie de página y el contenido - 1.8 - >= 0.1.0 - - - footer.htmlUrl - URL o la ruta del archivo HTML a usar en el - pie de página - - >= 0.1.0 - - - load.username - nombre de usuario a utilizar al conectarse a un sitio web - bart - >= 0.1.0 - - - load.password - contraseña a utilizar al conectarse a un sitio web - elbarto - >= 0.1.0 - - - load.jsdelay - el tiempo en milisegundos a esperar después de cargar una página antes de capturarla - 1200 - >= 0.1.0 - - - load.zoomFactor - cuánto zoom debe aplicarse al contenido - 2.2 - >= 0.1.0 - - - load.customHeaders - encabezados personalizados a enviar al solicitar la página web principal - - >= 0.1.0 - - - load.repertCustomHeaders - establecer en true para enviar con todas las solicitudes - booleano - >= 0.1.0 - - - load.cookies - cookie a enviar al solicitar la página web principal - - >= 0.1.0 - - - load.post - string a enviar al realizar una solicitud post a la página web principal - - >= 0.1.0 - - - load.blockLocalFileAccess - impide que los archivos locales y los archivos de tubería accedan a otros archivos locales - booleano - >= 0.1.0 - - - load.stopSlowScript - detiene los scripts lentos de javascript - booleano - - - - load.debugJavascript - permite que javascript lance advertencias - booleano - >= 0.1.0 - - - load.loadErrorHandling - define la estrategia de manejo de errores - -
    - - - - - abort - aborta el proceso de conversión - - - skip - no añade el objeto a la salida final - - - ignore - intenta añadir el objeto a la salida final - - - -
    - - >= 0.1.0 - - - load.proxy - - - >= 0.1.0 - - - web.background - incluye una imagen de fondo en la salida - booleano - >= 0.1.0 - - - web.loadImages - incluye imágenes en la salida - booleano - >= 0.1.0 - - - web.enableJavascript - activa o desactiva javascript - booleano - >= 0.1.0 - - - web.enableIntelligentShrinking - activa el intento de poner más contenido en la página, se aplica solo a la salida PDF - booleano - >= 0.1.0 - - - web.minimumFontSize - el tamaño de fuente mínimo permitido - 9 - >= 0.1.0 - - - web.printMediaType - muestra el contenido usando el tipo de medio de impresión en lugar del tipo de medio de pantalla - booleano - >= 0.1.0 - - - web.defaultEncoding - el contenido a usar cuando no se especifica ninguna codificación - utf-8 - >= 0.1.0 - - - web.userStyleSheet - URL o ruta hacia una hoja de estilo de usuario especificada - /ruta/hacia/estilo.css - >= 0.1.0 - - - web.enablePlugins - activa o desactiva los plugins NS - booleano - >= 0.1.0 - - - - -
    -
    -
    -
    -
    - - - -
    - - diff --git a/reference/xattr/book.xml b/reference/xattr/book.xml deleted file mode 100644 index 38e7aab104..0000000000 --- a/reference/xattr/book.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - xattr - - - - &reftitle.intro; - - La extensión xattr permite la manipulación de los atributos extendidos de un sistema de archivos. - - - - - &reference.xattr.setup; - &reference.xattr.constants; - &reference.xattr.reference; - - - - - diff --git a/reference/xattr/configure.xml b/reference/xattr/configure.xml deleted file mode 100644 index f23c24caf6..0000000000 --- a/reference/xattr/configure.xml +++ /dev/null @@ -1,36 +0,0 @@ - - - - - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;xattr. - - - &pecl.windows.download; - -
    - - diff --git a/reference/xattr/constants.xml b/reference/xattr/constants.xml deleted file mode 100644 index 27617f58a9..0000000000 --- a/reference/xattr/constants.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - &reftitle.constants; - &extension.constants; - - - - XATTR_ROOT - (int) - - - - Establece atributos en la raíz (segura) de espacio de nombres. Requiere privilegios de - administrador. - - - - - - XATTR_DONTFOLLOW - (int) - - - - No sigue el enlace simbólico pero se puede operar en este. - - - - - - XATTR_CREATE - (int) - - - - La función falla si el atributo extendido ya existe. - - - - - - XATTR_REPLACE - (int) - - - - La función falla si el atributo extendido no existe. - - - - - - - diff --git a/reference/xattr/functions/xattr-get.xml b/reference/xattr/functions/xattr-get.xml deleted file mode 100644 index d719895768..0000000000 --- a/reference/xattr/functions/xattr-get.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - xattr_get - - Obtener un atributo extendido - - - - &reftitle.description; - - stringfalsexattr_get - stringfilename - stringname - intflags0 - - - Esta función obtiene el valor de un atributo extendido del archivo. - - &xattr.namespace; - - - &reftitle.parameters; - - - - filename - - - El archivo de la cual obtenemos el atributo. - - - - - name - - - El nombre del atributo. - - - - - flags - - - - Banderas xattr soportadas - - - - XATTR_DONTFOLLOW - No sigue el enlace simbólico pero se puede operar en este. - - - XATTR_ROOT - - Establece atributos en la raíz (segura) de espacio de nombres. - Requiere privilegios de administrador. - - - - -
    -
    -
    -
    -
    -
    -
    - - &reftitle.returnvalues; - - Devuelve un string que contiene el valor o &false; si el atributo - no existe. - - - - &reftitle.examples; - - - Comprueba si el administrador del sistema firmó el archivo - - -]]> - - - - - - &reftitle.seealso; - - - xattr_list - xattr_set - xattr_remove - - - -
    - - diff --git a/reference/xattr/functions/xattr-list.xml b/reference/xattr/functions/xattr-list.xml deleted file mode 100644 index 85f96299bf..0000000000 --- a/reference/xattr/functions/xattr-list.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - - xattr_list - - Obtener una lista de atributos extendidos - - - - &reftitle.description; - - arrayxattr_list - stringfilename - intflags0 - - - Esta función obtiene una lista de nombres de los atributos extendidos de un archivo. - - &xattr.namespace; - - - &reftitle.parameters; - - - - filename - - - La ruta del archivo. - - - - - flags - - - - Banderas xattr soportadas - - - - XATTR_DONTFOLLOW - No sigue el enlace simbólico pero se puede operar en este. - - - XATTR_ROOT - - Establece atributos en la raíz (segura) de espacio de nombres. - Requiere privilegios de administrador. - - - - -
    -
    -
    -
    -
    -
    -
    - - &reftitle.returnvalues; - - Esta función devuelve un array con los nombres de los atributos extendidos. - - - - &reftitle.examples; - - - Imprime los nombres de todos los atributos extendidos del archivo - - -]]> - - - - - - &reftitle.seealso; - - - xattr_get - - - -
    - - diff --git a/reference/xattr/functions/xattr-remove.xml b/reference/xattr/functions/xattr-remove.xml deleted file mode 100644 index 6eb208205d..0000000000 --- a/reference/xattr/functions/xattr-remove.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - - xattr_remove - - Elimina un atributo extendido - - - - &reftitle.description; - - boolxattr_remove - stringfilename - stringname - intflags0 - - - Esta función elimina un atributo extendido del archivo. - - &xattr.namespace; - - - &reftitle.parameters; - - - - filename - - - El archivo del que se elimina el atributo. - - - - - name - - - El nombre del atributo a eliminar. - - - - - flags - - - - Banderas xattr soportadas - - - - XATTR_DONTFOLLOW - No sigue el enlace simbólico pero se puede operar en este. - - - XATTR_ROOT - - Establece atributos en la raíz (segura) de espacio de nombres. Requiere privilegios de - administrador. - - - - -
    -
    -
    -
    -
    -
    -
    - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - - Elimina todos los atributos extendidos de un archivo - - -]]> - - - - - - &reftitle.seealso; - - - xattr_list - xattr_set - xattr_get - - - -
    - - diff --git a/reference/xattr/functions/xattr-set.xml b/reference/xattr/functions/xattr-set.xml deleted file mode 100644 index e938065b93..0000000000 --- a/reference/xattr/functions/xattr-set.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - - xattr_set - - Establece un atributo extendido - - - - &reftitle.description; - - boolxattr_set - stringfilename - stringname - stringvalue - intflags0 - - - Esta función establece el valor de un atributo extendido del archivo. - - &xattr.namespace; - - - &reftitle.parameters; - - - - filename - - - El archivo en el que se establece el atributo. - - - - - name - - - El nombre del atributo extendido. Este atributo se crea si no existe - o reemplazado si ya existe. Puede cambiar este comportamiento mediante - el uso de los parámetros flags. - - - - - value - - - El valor del atributo. - - - - - flags - - - - Banderas xattr soportadas - - - - XATTR_CREATE - La función falla si el atributo extendido ya existe. - - - XATTR_REPLACE - La función falla si el atributo extendido no existe. - - - XATTR_DONTFOLLOW - No sigue el enlace simbólico pero se puede operar en este. - - - XATTR_ROOT - - Establece atributos en la raíz (segura) de espacio de nombres. - Requiere privilegios de administrador. - - - - -
    -
    -
    -
    -
    -
    -
    - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - - Establece atributos extendidos en archivo <filename>.wav</filename> - - -]]> - - - - - - &reftitle.seealso; - - - xattr_get - xattr_remove - - - -
    - - diff --git a/reference/xattr/functions/xattr-supported.xml b/reference/xattr/functions/xattr-supported.xml deleted file mode 100644 index 58c21fc65a..0000000000 --- a/reference/xattr/functions/xattr-supported.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - xattr_supported - - Comprueba si soporta los atributos extendidos del sistema de archivos - - - - &reftitle.description; - - boolxattr_supported - stringfilename - intflags0 - - - Esta función comprueba si el sistema de archivos que contenía el fichero dado soporta - los atributos extendidos. Es necesario tener acceso de lectura al archivo. - - - - &reftitle.parameters; - - - - filename - - - La ruta del archivo de prueba. - - - - - flags - - - - Banderas xattr soportadas - - - - XATTR_DONTFOLLOW - No sigue el enlace simbólico pero se puede operar en este. - - - -
    -
    -
    -
    -
    -
    -
    - - &reftitle.returnvalues; - - Esta función devuelve &true; si sistema de archivo soporta los atributos extendidos, - &false; si no soporta y &null; si no se puede determinar (Por ejemplo - ruta incorrecta o le faltan permisos al archivo). - - - - &reftitle.examples; - - - Ejemplo de <function>xattr_supported</function> - - El siguiente código comprueba si se pueden utilizar los atributos extendidos. - - - -]]> - - - - - - &reftitle.seealso; - - - xattr_get - xattr_list - - - -
    - - diff --git a/reference/xattr/reference.xml b/reference/xattr/reference.xml deleted file mode 100644 index a83cd0097b..0000000000 --- a/reference/xattr/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - &Functions; de xattr - - &reference.xattr.entities.functions; - - - - diff --git a/reference/xattr/setup.xml b/reference/xattr/setup.xml deleted file mode 100644 index 75f0cddc71..0000000000 --- a/reference/xattr/setup.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - Para utilizar xattr, se necesita tener libattr instalado. Este está - disponible en &url.xattr;. - - - - Estas funciones sólo funcionan en sistemas de archivos que soportan - atributos extendidos, y haya activado durante la instalación. Algunos sistemas - de ficheros comunes que soportan atributos extendidos son ext2, ext3, - reiserfs, jfs, y xfs. - - -
    - - - - &reference.xattr.configure; - - -
    - - - diff --git a/reference/xdiff/book.xml b/reference/xdiff/book.xml deleted file mode 100644 index f12ad11881..0000000000 --- a/reference/xdiff/book.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - xdiff - - - - &reftitle.intro; - - La extensión xdiff permite crear y aplicar archivos parche que contienen - diferencias entre diferentes revisiones de archivos. - - - Esta extensión soporta dos modos de funcionamiento - sobre cadenas y sobre archivos, así como - dos formatos de parches diferentes - unificado y binario. Los parches unificados son excelentes - para archivos de texto, ya que son legibles y fáciles de revisar. Para los archivos binarios como - archivos o imágenes, los parches binarios serán la opción adecuada, ya que ellos son binary safe y - manejan caracteres no imprimibles. - - - A partir de la versión 1.5.0 hay dos diferentes conjuntos de funciones para la generación de - parches binarios. Las nuevas funciones - xdiff_string_rabdiff - xdiff_file_rabdiff generan salidas compatibles con funciones más antiguas - pero suelen ser más rápidas y generan resultados más pequeños. Para más detalles sobre los métodos de - la generación de parches binarios y diferencias entre ellos, por favor consulte el sitio web - libxdiff. - - - Esta extensión utiliza libxdiff para implementar estas funciones. Consulte - &url.xdiff; para mayor información. - - - - - &reference.xdiff.setup; - &reference.xdiff.constants; - &reference.xdiff.reference; - - - - - diff --git a/reference/xdiff/configure.xml b/reference/xdiff/configure.xml deleted file mode 100644 index fae2564c2a..0000000000 --- a/reference/xdiff/configure.xml +++ /dev/null @@ -1,36 +0,0 @@ - - - - - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;xdiff. - - - &pecl.windows.download.avail; - -
    - - diff --git a/reference/xdiff/constants.xml b/reference/xdiff/constants.xml deleted file mode 100644 index 96251fe5bb..0000000000 --- a/reference/xdiff/constants.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - &reftitle.constants; - &extension.constants; - - - - XDIFF_PATCH_NORMAL - (int) - - - - Este indicador indica que las funciones xdiff_string_patch y - xdiff_file_patch deben crear el resultado de - aplicar el parche al contenido original, creando así una versión más reciente del archivo. Este es el - modo por defecto de funcionamiento. - - - - - - XDIFF_PATCH_REVERSE - (int) - - - - Este indicador indica que las funciones xdiff_string_patch y - xdiff_file_patch deben crear el resultado de - revertir el parche de modificación desde el nuevo contenido, creando así la versión original. - - - - - - - diff --git a/reference/xdiff/functions/xdiff-file-bdiff-size.xml b/reference/xdiff/functions/xdiff-file-bdiff-size.xml deleted file mode 100644 index 99833fdbac..0000000000 --- a/reference/xdiff/functions/xdiff-file-bdiff-size.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - - - xdiff_file_bdiff_size - Lee el tamaño de un archivo creado tras aplicar una diferencia binaria - - - - &reftitle.description; - - intxdiff_file_bdiff_size - stringfile - - - Devuelve el tamaño de un archivo resultado que se creó después de aplicar el parche binario desde el archivo - file a el archivo original. - - - - - &reftitle.parameters; - - - - file - - - La ruta al parche binario creado por la función xdiff_string_bdiff o - xdiff_string_rabdiff. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el tamaño del archivo que se creará. - - - - - &reftitle.examples; - - - Ejemplo de <function>xdiff_file_bdiff_size</function> - - El siguiente código lee el tamaño de un archivo que se creará - tras realizar una diferencia binaria. - - - -]]> - - - - - - - &reftitle.seealso; - - - xdiff_file_bdiff - xdiff_file_rabdiff - xdiff_file_bpatch - - - - - - diff --git a/reference/xdiff/functions/xdiff-file-bdiff.xml b/reference/xdiff/functions/xdiff-file-bdiff.xml deleted file mode 100644 index e36a1ab23f..0000000000 --- a/reference/xdiff/functions/xdiff-file-bdiff.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - - - - xdiff_file_bdiff - Realiza una diferencia binaria de dos archivos - - - - &reftitle.description; - - boolxdiff_file_bdiff - stringold_file - stringnew_file - stringdest - - - Hace una diferencia binaria de dos archivos y almacena el resultado en un archivo de revisión. - Esta función trabaja con archivos de texto y binarios. El archivo parche - resultante puede ser aplicado posteriormente utilizando xdiff_file_bpatch/xdiff_string_bpatch. - - - - - &reftitle.parameters; - - - - old_file - - - Ruta a el primer archivo. Este archivo actúa como "viejo" archivo. - - - - - new_file - - - Ruta a el segundo archivo. Este archivo actúa como "nuevo" archivo. - - - - - dest - - - Ruta de el archivo parche resultante. El archivo resultante contiene diferencias - entre los archivos "viejo" y "nuevo". Este será en formato binario y no leible por humanos. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Ejemplo de <function>xdiff_file_bdiff</function> - - El siguiente código hace una diferencia binaria de dos archivos. - - - -]]> - - - - - - - &reftitle.notes; - - - Ambos archivos serán cargados en memoria así que asegúrese que el valor de memory_limit es - lo suficientemente alto. - - - - - - &reftitle.seealso; - - - xdiff_file_bpatch - - - - - - - diff --git a/reference/xdiff/functions/xdiff-file-bpatch.xml b/reference/xdiff/functions/xdiff-file-bpatch.xml deleted file mode 100644 index 6b7cc08423..0000000000 --- a/reference/xdiff/functions/xdiff-file-bpatch.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - - - - xdiff_file_bpatch - Parchea un archivo con una diferencia binaria - - - - &reftitle.description; - - boolxdiff_file_bpatch - stringfile - stringpatch - stringdest - - - Parchea un file con un - patch binario y almacena el resultado en un archivo dest. - Esta función acepta parches creados tanto a través de la funciones xdiff_file_bdiff - y xdiff_file_rabdiff como de sus equivalentes de cadena. - - - - - &reftitle.parameters; - - - - file - - - El archivo original. - - - - - patch - - - El archivo parche binario. - - - - - dest - - - La ruta del archivo resultante. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Ejemplo de <function>xdiff_file_bpatch</function> - - El siguiente código aplica una diferencia binaria a un archivo. - - - -]]> - - - - - - - &reftitle.notes; - - - Ambos archivos (file y patch) - serán cargados en memoria así que asegúrese que el valor de memory_limit es - lo suficientemente alto. - - - - - - &reftitle.seealso; - - - xdiff_file_bdiff - xdiff_file_rabdiff - - - - - - - diff --git a/reference/xdiff/functions/xdiff-file-diff-binary.xml b/reference/xdiff/functions/xdiff-file-diff-binary.xml deleted file mode 100644 index 95ef0abf5e..0000000000 --- a/reference/xdiff/functions/xdiff-file-diff-binary.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - - - xdiff_file_diff_binary - &Alias; xdiff_file_bdiff - - - - &reftitle.description; - - boolxdiff_file_diff_binary - stringold_file - stringnew_file - stringdest - - - Hace una diferencia binaria de dos archivos y almacena el resultado en un archivo de revisión. - Esta función trabaja con archivos de texto y binarios. El archivo parche resultante - puede ser posteriormente aplicado con xdiff_file_bpatch. - - - Desde la versión 1.5.0 de esta función es un alias de xdiff_file_bdiff. - - - - - &reftitle.parameters; - - - - old_file - - - Ruta a el primer archivo. Este archivo actúa como "viejo" archivo. - - - - - new_file - - - Ruta a el segundo archivo. Este archivo actúa como "nuevo" archivo. - - - - - dest - - - Ruta de el archivo parche resultante. El archivo resultante contiene diferencias - entre los archivos "viejo" y "nuevo". Este será en formato binario y no legible por humanos. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Ejemplo de <function>xdiff_file_diff_binary</function> - - El siguiente código hace una diferencia binaria de dos archivos. - - - -]]> - - - - - - - &reftitle.notes; - - - Ambos archivos serán cargados en memoria así que asegúrese que el valor de memory_limit es - lo suficientemente alto. - - - - - - &reftitle.seealso; - - - xdiff_file_bdiff - xdiff_file_bpatch - - - - - - - diff --git a/reference/xdiff/functions/xdiff-file-diff.xml b/reference/xdiff/functions/xdiff-file-diff.xml deleted file mode 100644 index 96b6020b7c..0000000000 --- a/reference/xdiff/functions/xdiff-file-diff.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - - - - - xdiff_file_diff - Hacer un diff unificado de dos archivos - - - - &reftitle.description; - - boolxdiff_file_diff - stringold_file - stringnew_file - stringdest - intcontext3 - boolminimal&false; - - - Hace un diff unificado que contiene las diferencias entre old_file y - new_file y almacena este en el archivo dest. El - archivo resultante es legible. Un parámetro opcional context - especifica el número de líneas de contexto que hay que añadir alrededor de cada cambio. - Establecer el parámetro minimal a true dará como resultado de salida el archivo - parche más corto posible (puede tomar algo de tiempo). - - - - - &reftitle.parameters; - - - - old_file - - - Ruta a el primer archivo. Este archivo actúa como "viejo" archivo. - - - - - new_file - - - Ruta a el segundo archivo. Este archivo actúa como "nuevo" archivo. - - - - - dest - - - Ruta del archivo parche resultante. - - - - - context - - - Indica el número de líneas de contexto que desea incluir en el resultado - diff. - - - - - minimal - - - Establezca este parámetro a &true; si desea reducir el tamaño del resultado - (puede tomar algo de tiempo). - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Ejemplo de <function>xdiff_file_diff</function> - - El siguiente código hace un diff unificado de dos archivos php con una longitud de contexto de 2. - - - -]]> - - - - - - - &reftitle.notes; - - - Esta función no funciona bien con archivos binarios. Para hacer una diferencia binaria de - archivos utilice la xdiff_file_bdiff/xdiff_file_rabdiff. - - - - - - &reftitle.seealso; - - - xdiff_file_patch - - - - - - diff --git a/reference/xdiff/functions/xdiff-file-merge3.xml b/reference/xdiff/functions/xdiff-file-merge3.xml deleted file mode 100644 index 494354db2d..0000000000 --- a/reference/xdiff/functions/xdiff-file-merge3.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - - - - xdiff_file_merge3 - Une 3 archivos en uno - - - - &reftitle.description; - - mixedxdiff_file_merge3 - stringold_file - stringnew_file1 - stringnew_file2 - stringdest - - - Une tres archivos en uno y almacena el resultado en un archivo dest. - El old_file es una versión original mientras new_file1 - y new_file2 son versiones modificadas de un original. - - - - - &reftitle.parameters; - - - - old_file - - - Ruta a el primer archivo. Este archivo actúa como "viejo" archivo. - - - - - new_file1 - - - Ruta a el segundo archivo. Este actúa como una versión modificada de old_file. - - - - - new_file2 - - - Ruta a el tercer archivo. Este actúa como una versión modificada de old_file. - - - - - dest - - - La ruta del archivo resultante, contiene la unión modificada de new_file1 y - new_file2. - - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si la unión fue satisfactoria, una cadena con fragmento erróneo si - esta no lo fue o &false; si ocurrió un error interno. - - - - - &reftitle.examples; - - - Ejemplo de <function>xdiff_file_merge3</function> - - El código siguiente combina tres archivos en uno. - - - -]]> - - - - - - - &reftitle.seealso; - - - xdiff_string_merge3 - - - - - - diff --git a/reference/xdiff/functions/xdiff-file-patch-binary.xml b/reference/xdiff/functions/xdiff-file-patch-binary.xml deleted file mode 100644 index ff60a42047..0000000000 --- a/reference/xdiff/functions/xdiff-file-patch-binary.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - - xdiff_file_patch_binary - &Alias; xdiff_file_bpatch - - - - &reftitle.description; - - boolxdiff_file_patch_binary - stringfile - stringpatch - stringdest - - - Parchea un file con un - patch binario y almacena el resultado en un archivo dest. - Esta función acepta parches creados tanto a través de funciones xdiff_file_bdiff - o xdiff_file_rabdiff como de sus equivalentes de cadena. - - - Desde la versión 1.5.0 esta función es un alias de xdiff_file_bpatch. - - - - - &reftitle.parameters; - - - - file - - - El archivo original. - - - - - patch - - - El archivo parche binario. - - - - - dest - - - La ruta de el archivo resultante. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Ejemplo de <function>xdiff_file_patch_binary</function> - - El siguiente código aplica una diferencia binaria a un archivo. - - - -]]> - - - - - - - &reftitle.notes; - - - Ambos archivos (file y patch) - serán cargados en memoria así que asegúrese que el valor de memory_limit es - lo suficientemente alto. - - - - - - &reftitle.seealso; - - - xdiff_string_patch_binary - - - - - - - diff --git a/reference/xdiff/functions/xdiff-file-patch.xml b/reference/xdiff/functions/xdiff-file-patch.xml deleted file mode 100644 index fbdf929269..0000000000 --- a/reference/xdiff/functions/xdiff-file-patch.xml +++ /dev/null @@ -1,163 +0,0 @@ - - - - - - - - - xdiff_file_patch - Parchea un archivo con un diff unificado - - - - &reftitle.description; - - mixedxdiff_file_patch - stringfile - stringpatch - stringdest - intflagsDIFF_PATCH_NORMAL - - - Parchea un file con un patch y almacena el resultado en un archivo. - patch tiene que ser un diff unificado creado por la función - xdiff_file_diff/xdiff_string_diff. - Un parámetro opcional flags especifica el modo de operación. - - - - - &reftitle.parameters; - - - - file - - - El archivo original. - - - - - patch - - - El archivo de revisión unificado. Este tiene que ser creado con las funciones xdiff_string_diff, - xdiff_file_diff o herramientas compatibles. - - - - - dest - - - Ruta de el archivo resultante. - - - - - flags - - - Puede ser XDIFF_PATCH_NORMAL (modo por defecto, - parche normal) o XDIFF_PATCH_REVERSE (parche - invertido). - - - A partir de la versión 1.5.0, también puede utilizar binario OR para habilitar el indicador - XDIFF_PATCH_IGNORESPACE. - - - - - - - - - &reftitle.returnvalues; - - Devuelve &false; si ocurrió un error interno, una cadena con fragmento erróneo - si el parche no pudo ser aplicado o &true; si el parche fue aplicado con éxito. - - - - - &reftitle.examples; - - - Ejemplo de <function>xdiff_file_patch</function> - - El siguiente código aplica un diff unificado a un archivo. - - - -]]> - - - - Ejemplo de parche invertido - - El código siguiente invierte un parche. - - - -]]> - - - - - - - &reftitle.seealso; - - - xdiff_file_diff - - - - - - - diff --git a/reference/xdiff/functions/xdiff-file-rabdiff.xml b/reference/xdiff/functions/xdiff-file-rabdiff.xml deleted file mode 100644 index 4520671019..0000000000 --- a/reference/xdiff/functions/xdiff-file-rabdiff.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - - - - xdiff_file_rabdiff - Hacer una diferencia binaria de dos archivos utilizando el algoritmo polinomial de huella digital (fingerprinting) de Rabin - - - - &reftitle.description; - - boolxdiff_file_rabdiff - stringold_file - stringnew_file - stringdest - - - Hace una diferencia binaria de dos archivos y almacena el resultado en un archivo de revisión. - La diferencia entre esta función y xdiff_file_bdiff es el diferente - algoritmo que se utiliza que debería traducirse en una ejecución más rápida y un diff producido menor. - Esta función trabaja con archivos de texto y binarios. El archivo parche resultante - puede ser posteriormente aplicado utilizando xdiff_file_bpatch/xdiff_string_bpatch. - - - Para obtener más información sobre las diferencias entre el algoritmo utilizado por favor vea - el sitio web libxdiff - - - - - &reftitle.parameters; - - - - old_file - - - Ruta a el primer archivo. Este archivo actúa como "viejo" archivo. - - - - - new_file - - - Ruta a el segundo archivo. Este archivo actúa como "nuevo" archivo. - - - - - dest - - - Ruta de el archivo parche resultante. El archivo resultante contiene diferencias - entre los archivos "viejo" y "nuevo". Este será en formato binario y no legible por humanos. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Ejemplo de <function>xdiff_file_rabdiff</function> - - El siguiente código hace una diferencia binaria de dos archivos. - - - -]]> - - - - - - - &reftitle.notes; - - - Ambos archivos serán cargados en memoria así que asegúrese que el valor de memory_limit es - lo suficientemente alto. - - - - - - &reftitle.seealso; - - - xdiff_file_bpatch - - - - - - - diff --git a/reference/xdiff/functions/xdiff-string-bdiff-size.xml b/reference/xdiff/functions/xdiff-string-bdiff-size.xml deleted file mode 100644 index 5c136679c6..0000000000 --- a/reference/xdiff/functions/xdiff-string-bdiff-size.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - - - xdiff_string_bdiff_size - Lee el tamaño de un archivo creado tras aplicar una diferencia binaria - - - - &reftitle.description; - - intxdiff_string_bdiff_size - stringpatch - - - Devuelve el tamaño de un archivo resultante que será creado tras aplicar el patch binario a - el archivo original. - - - - - &reftitle.parameters; - - - - patch - - - El parche binario creado por la función xdiff_string_bdiff o - xdiff_string_rabdiff. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el tamaño del archivo que fue creado. - - - - - &reftitle.examples; - - - Ejemplo de <function>xdiff_string_bdiff_size</function> - - El siguiente código lee el tamaño de un archivo que fue creado - tras aplicar una diferencia binaria. - - - -]]> - - - - - - - &reftitle.seealso; - - - xdiff_string_bdiff - xdiff_string_rabdiff - xdiff_string_bpatch - - - - - - diff --git a/reference/xdiff/functions/xdiff-string-bdiff.xml b/reference/xdiff/functions/xdiff-string-bdiff.xml deleted file mode 100644 index 2a49a2de3b..0000000000 --- a/reference/xdiff/functions/xdiff-string-bdiff.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - - xdiff_string_bdiff - Hacer una diferencia binaria de dos cadenas - - - - &reftitle.description; - - stringxdiff_string_bdiff - stringold_data - stringnew_data - - - Hace una diferencia binaria de dos cadenas y devuelve el resultado. - Esta función trabaja con texto y datos binarios. El parche resultante - puede ser posteriormente aplicado utilizando xdiff_string_bpatch/xdiff_file_bpatch. - - - - - &reftitle.parameters; - - - - old_data - - - Primera cadena con información binaria. Esta actúa como "vieja" información. - - - - - new_data - - - Segunda cadena con información binaria. Esta actúa como "nueva" información. - - - - - - - - - &reftitle.returnvalues; - - Devuelve la cadena con la diferencia binaria conteniendo las diferencias entre "vieja" y "nueva" - información o &false; si se producido un error interno. - - - - - &reftitle.seealso; - - - xdiff_string_bpatch - - - - - - - diff --git a/reference/xdiff/functions/xdiff-string-bpatch.xml b/reference/xdiff/functions/xdiff-string-bpatch.xml deleted file mode 100644 index 6a9feff8ff..0000000000 --- a/reference/xdiff/functions/xdiff-string-bpatch.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - - - xdiff_string_bpatch - Parchear una cadena con una diferencia binaria - - - - &reftitle.description; - - stringxdiff_string_bpatch - stringstr - stringpatch - - - Parchea una cadena str con un patch binario. - Esta función acepta parches creados tanto a través de las funciones xdiff_string_bdiff - y xdiff_string_rabdiff o su archivo homólogo equivalente. - - - - - &reftitle.parameters; - - - - str - - - La cadena binaria original. - - - - - patch - - - La cadena parche binaria. - - - - - - - - - &reftitle.returnvalues; - - Devuelve la cadena parcheada, o &false; en caso de error. - - - - - &reftitle.seealso; - - - xdiff_string_bdiff - xdiff_string_rabdiff - - - - - - - diff --git a/reference/xdiff/functions/xdiff-string-diff-binary.xml b/reference/xdiff/functions/xdiff-string-diff-binary.xml deleted file mode 100644 index bfed641abf..0000000000 --- a/reference/xdiff/functions/xdiff-string-diff-binary.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - xdiff_string_diff_binary - &Alias; xdiff_string_bdiff - - - - &reftitle.description; - - stringxdiff_string_bdiff - stringold_data - stringnew_data - - - Hace una diferencia binaria de dos cadenas y devuelve el resultado. - Esta función trabaja con texto y datos binarios. El parche resultante - puede ser posteriormente aplicado utilizando xdiff_string_bpatch/xdiff_file_bpatch. - - - Desde la versión 1.5.0 esta función es un alias de xdiff_string_bdiff. - - - - - &reftitle.parameters; - - - - old_data - - - Primera cadena con información binaria. Esta actúa como "vieja" información. - - - - - new_data - - - Segunda cadena con información binaria. Esta actúa como "nueva" información. - - - - - - - - - &reftitle.returnvalues; - - Devuelve cadena con resultado o &false; si se produce un error interno. - - - - - &reftitle.seealso; - - - xdiff_string_bdiff - xdiff_string_bpatch - - - - - - - diff --git a/reference/xdiff/functions/xdiff-string-diff.xml b/reference/xdiff/functions/xdiff-string-diff.xml deleted file mode 100644 index 12fbfa92d9..0000000000 --- a/reference/xdiff/functions/xdiff-string-diff.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - - - xdiff_string_diff - Hacer un diff unificado de dos strings - - - - &reftitle.description; - - stringxdiff_string_diff - stringold_data - stringnew_data - intcontext3 - boolminimal&false; - - - Hace un diff unificado que contiene diferencias entre el string old_data y - el string new_data y devuelve este. El diff resultante es legible. - Un parámetro opcional context especifica el número de líneas de contexto que hay que añadir - alrededor de cada cambio. Establecer el parámetro minimal - a true dará como resultado de salida el archivo parche más corto posible (puede tomar algo de tiempo). - - - - - &reftitle.parameters; - - - - old_data - - - Primera cadena con información. Esta actúa como "vieja" información. - - - - - new_data - - - Segundo string con información. Esta actúa como "nueva" información. - - - - - context - - - Indica el número de líneas de contexto que desea incluir en el diff - resultado. - - - - - minimal - - - Establezca este parámetro a &true; si desea reducir el tamaño del - resultado (puede tomar algo de tiempo). - - - - - - - - - &reftitle.returnvalues; - - Devuelve un string con el resultado diff o &false; si ocurriera un error interno. - - - - - &reftitle.examples; - - - Ejemplo de <function>xdiff_string_diff</function> - - El siguiente código hace un diff unificado de dos artículos. - - - -]]> - - - - - - - &reftitle.notes; - - - Esta función no funciona bien con string binarios. Para hacer un diff de string binario - utilice xdiff_string_bdiff/xdiff_string_rabdiff. - - - - - - &reftitle.seealso; - - - xdiff_string_patch - - - - - - diff --git a/reference/xdiff/functions/xdiff-string-merge3.xml b/reference/xdiff/functions/xdiff-string-merge3.xml deleted file mode 100644 index b508adc5a3..0000000000 --- a/reference/xdiff/functions/xdiff-string-merge3.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - - - xdiff_string_merge3 - Unir tres cadenas en una - - - - &reftitle.description; - - mixedxdiff_string_merge3 - stringold_data - stringnew_data1 - stringnew_data2 - stringerror - - - Une tres cadenas en una y devuelve el resultado. - El parámetro old_data es una versión original de los datos - mientras new_data1 y new_data2 son versiones - modificadas de un original. El parámetro opcional error es utilizado para admitir cualquier - fragmento erróneo durante el proceso de unión. - - - - - &reftitle.parameters; - - - - old_data - - - Primera cadena con información. Esta actúa como "vieja" información. - - - - - new_data1 - - - Segunda cadena con información. Esta actúa como versión modificada del old_data. - - - - - new_data2 - - - La tercera cadena con información. Esta actúa como versión modificada del old_data. - - - - - error - - - Si se produce algún fragmento erróneo entonces se almacenan dentro de esta variable. - - - - - - - - - &reftitle.returnvalues; - - Devuelve la cadena unida, &false; si se produce un error interno, o &true; - si la cadena unida está vacía. - - - - - &reftitle.seealso; - - - xdiff_file_merge3 - - - - - - - diff --git a/reference/xdiff/functions/xdiff-string-patch-binary.xml b/reference/xdiff/functions/xdiff-string-patch-binary.xml deleted file mode 100644 index 0dc30f4cb6..0000000000 --- a/reference/xdiff/functions/xdiff-string-patch-binary.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - - xdiff_string_patch_binary - &Alias; xdiff_string_bpatch - - - - &reftitle.description; - - stringxdiff_string_patch_binary - stringstr - stringpatch - - - Parchea una cadena str con un patch binario. - Esta función acepta parches creados tanto a través de las funciones xdiff_string_bdiff - y xdiff_string_rabdiff o de su archivo homólogo equivalente. - - - Desde la versión 1.5.0 esta función es un alias de xdiff_string_bpatch. - - - - - &reftitle.parameters; - - - - str - - - La cadena binaria original. - - - - - patch - - - La cadena parche binaria. - - - - - - - - - &reftitle.returnvalues; - - Devuelve la cadena parcheada, o &false; en caso de error. - - - - - &reftitle.seealso; - - - xdiff_string_bpatch - xdiff_string_bdiff - xdiff_string_rabdiff - - - - - - - diff --git a/reference/xdiff/functions/xdiff-string-patch.xml b/reference/xdiff/functions/xdiff-string-patch.xml deleted file mode 100644 index 4e49bfa708..0000000000 --- a/reference/xdiff/functions/xdiff-string-patch.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - - - - xdiff_string_patch - Parchear una cadena con un diff unificado - - - - &reftitle.description; - - stringxdiff_string_patch - stringstr - stringpatch - intflags - stringerror - - - Parchea una cadena str con un parche unificado en parámetro patch - y devuelve el resultado. patch tiene que ser un diff unificado creado por la función - xdiff_file_diff/xdiff_string_diff. - Un parámetro opcional flags especifica el modo de operación. Cualquier - fragmento erróneo del parche será almacenado en el interior de la variable error si - si esta es proporcionada. - - - - - &reftitle.parameters; - - - - str - - - La cadena original. - - - - - patch - - - La cadena parche unificada. Esta tiene que ser creada utilizando las funciones xdiff_string_diff, - xdiff_file_diff o herramientas compatibles. - - - - - flags - - - flags uede ser - XDIFF_PATCH_NORMAL (modo por defecto, parche normal) - o XDIFF_PATCH_REVERSE (parche invertido). - - - A partir de la versión 1.5.0, también se puede utilizar binario OR para habilitar el indicador - XDIFF_PATCH_IGNORESPACE. - - - - - error - - - Si se proporciona entonces los fragmentos erróneos se almacenan dentro de esta variable. - - - - - - - - - &reftitle.returnvalues; - - Devuelve la cadena parcheada, o &false; en caso de error. - - - - - &reftitle.examples; - - - Ejemplo de <function>xdiff_string_patch</function> - - El siguiente código aplica cambios en algún artículo. - - - -]]> - - - - - - - &reftitle.seealso; - - - xdiff_string_diff - - - - - - diff --git a/reference/xdiff/functions/xdiff-string-rabdiff.xml b/reference/xdiff/functions/xdiff-string-rabdiff.xml deleted file mode 100644 index f78547fe51..0000000000 --- a/reference/xdiff/functions/xdiff-string-rabdiff.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - xdiff_string_rabdiff - - Hace una comparación binaria de dos strings utilizando el algoritmo polinomial de huella digital (fingerprinting) de Rabin - - - - - &reftitle.description; - - stringfalsexdiff_string_rabdiff - stringold_data - stringnew_data - - - Hace una comparación binaria de dos strings utilizando el algoritmo de huella digital polinomial de Rabin implementado por - libxdiff. En comparación con - xdiff_string_bdiff, este algoritmo generalmente produce diferencias más pequeñas y opera más rápido, - manteniendo la compatibilidad total con xdiff_string_bpatch y - xdiff_file_bpatch para la aplicación de parches. - - - Esta función puede utilizarse tanto con datos de texto como binarios. Los datos de comparación pueden aplicarse posteriormente - para recrear la nueva versión a partir de la anterior. - - - Para obtener más información sobre el algoritmo, vea la - documentación de libxdiff. - - - - - &reftitle.parameters; - - - - old_data - - - El primer string que contiene los datos binarios "antiguos". - - - - - new_data - - - El segundo string que contiene los "nuevos" datos binarios. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un string binario de comparación que contiene las diferencias entre los datos antiguos y nuevos, &return.falseforfailure;. - - - - - &reftitle.examples; - - - Creación de una diferencia binaria entre dos cadenas - - -]]> - - - - - - - &reftitle.seealso; - - - xdiff_string_bdiff - xdiff_string_bpatch - xdiff_file_bpatch - - - - - - - diff --git a/reference/xdiff/reference.xml b/reference/xdiff/reference.xml deleted file mode 100644 index fb208c8734..0000000000 --- a/reference/xdiff/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - &Functions; de xdiff - - &reference.xdiff.entities.functions; - - - - diff --git a/reference/xdiff/setup.xml b/reference/xdiff/setup.xml deleted file mode 100644 index 124cd26f8c..0000000000 --- a/reference/xdiff/setup.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - Para usar xdiff, es necesario contar con libxdiff instalado, disponible - en la web de libxdiff &url.xdiff;. - - - - Para que estas funciones tengan en cuenta la directiva memory_limit es necesario contar con, al menos, libxdiff 0.7. - - -
    - - - - &reference.xdiff.configure; - - -
    - - - diff --git a/reference/xhprof/book.xml b/reference/xhprof/book.xml deleted file mode 100644 index 21befbb6d5..0000000000 --- a/reference/xhprof/book.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - Perfilador jerárquico - Xhprof - - - &reftitle.intro; - - El XHProf es un perfilador ligero jerárquico y basado en la instrumentación. - Durante la fase de recopilación de datos, lleva un registro de los recuentos de llamadas e incluso - métricas para los arcos en el calibre dinámico de un programa. Calcula las exclusivas - métricas en la fase de reporte/procesamiento posterior, como el tiempo de espera (transcurrido), - El tiempo de la CPU y el uso de la memoria. Un perfil de funciones puede ser dividido por los llamantes - o llamadas. El XHProf maneja funciones recursivas detectando ciclos en la - caligrafía en el propio momento de la recogida de datos y evitar los ciclos dando - nombres calificados de profundidad para las invocaciones recursivas. - - - XHProf incluye una sencilla interfaz de usuario basada en HTML (escrita en PHP). El navegador basado en - La interfaz de usuario para ver los resultados de los perfiles hace que sea fácil ver los resultados o compartirlos. - con los compañeros. También se admite una vista de imagen de caligrafía. - - - Los informes del XHProf a menudo pueden ser útiles para entender la estructura del código - siendo ejecutado. La naturaleza jerárquica de los informes puede ser utilizada para determinar, - por ejemplo, qué cadena de llamadas llevó a que se llamara a una función en particular. - - - El XHProf permite comparar dos ejecuciones (también conocidas como informes "diff") o agregar - datos de múltiples ejecuciones. Informes diferenciales y agregados, muy parecidos a los informes de una sola ejecución, - ofrecen vistas "planas" y "jerárquicas" del perfil. - - - Se puede encontrar documentación adicional a través del - sitio facebook xhprof. - - - - &reference.xhprof.setup; - &reference.xhprof.constants; - &reference.xhprof.examples; - &reference.xhprof.reference; - - - - diff --git a/reference/xhprof/configure.xml b/reference/xhprof/configure.xml deleted file mode 100644 index 21f7e43531..0000000000 --- a/reference/xhprof/configure.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;xhprof - - -
    - - - diff --git a/reference/xhprof/constants.xml b/reference/xhprof/constants.xml deleted file mode 100644 index 13e351b9fe..0000000000 --- a/reference/xhprof/constants.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - &reftitle.constants; - &extension.constants; - - - - XHPROF_FLAGS_NO_BUILTINS - (int) - - - - Se utiliza para saltar todas las funciones incorporadas (internas) - - - - - - XHPROF_FLAGS_CPU - (int) - - - - Se utiliza para agregar información de la CPU a la salida. - - - - - - XHPROF_FLAGS_MEMORY - (int) - - - - Se utiliza para agregar información de la memoria a la salida. - - - - - - - diff --git a/reference/xhprof/examples.xml b/reference/xhprof/examples.xml deleted file mode 100644 index e1423a5b37..0000000000 --- a/reference/xhprof/examples.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - &reftitle.examples; - - Ejemplo Xhprof con interfaz gráfica de usuario opcional - - En este ejemplo se inicia y detiene el perfilador, a continuación, utiliza - interfaz gráfica de usuario para guardar y analizar los resultados. En otras palabras, el - código de la extensión se termina en la llamada a - xhprof_disable . - - -save_run($xhprof_data, "xhprof_testing"); - -echo "http://localhost/xhprof/xhprof_html/index.php?run={$run_id}&source=xhprof_testing\n"; - -?> -]]> - - &example.outputs.similar; - - - - - - - diff --git a/reference/xhprof/functions/xhprof-disable.xml b/reference/xhprof/functions/xhprof-disable.xml deleted file mode 100644 index e7efcdafe2..0000000000 --- a/reference/xhprof/functions/xhprof-disable.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - - xhprof_disable - Detiene el perfilado xhprof - - - - &reftitle.description; - - arraynullxhprof_disable - - - - Detiene el perfilado y devuelve los datos xhprof correspondientes a su ejecución. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un array de datos xhprof, procedentes de su ejecución. - Devuelve &null; si el perfilado no está activado. - - - - - &reftitle.examples; - - Ejemplo con <function>xhprof_disable</function> - - -]]> - - &example.outputs.similar; - -strlen] => Array - ( - [ct] => 1 - [wt] => 279 - ) - - [main()==>xhprof_disable] => Array - ( - [ct] => 1 - [wt] => 9 - ) - - [main()] => Array - ( - [ct] => 1 - [wt] => 610 - ) - -) -]]> - - - - - - - diff --git a/reference/xhprof/functions/xhprof-enable.xml b/reference/xhprof/functions/xhprof-enable.xml deleted file mode 100644 index 2e6f77cf61..0000000000 --- a/reference/xhprof/functions/xhprof-enable.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - xhprof_enable - Inicia perfil xhprof - - - - &reftitle.description; - - voidxhprof_enable - intflags0 - arrayoptions - - - Inicia perfiles xhprof. - - - - - &reftitle.parameters; - - - - flags - - - Flags opcionales para añadir información adicional a la creación de perfiles. Véase las - constantes XHprof Para obtener más información - acerca de estos flags, p. ej., XHPROF_FLAGS_MEMORY - para permitir perfiles de memoria. - - - - - options - - - Un array de opciones opcionales, es decir, la opción - 'ignored_functions' para pasar en las funciones que se ignoraron - durante el perfilado. - - - - - - - - - &reftitle.returnvalues; - - &null; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - PECL xhprof 0.9.2 - - El parámetro opcional options fué agregado. - - - - - - - - - - &reftitle.examples; - - Ejemplos de <function>xhprof_enable</function> - - array('call_user_func', - 'call_user_func_array'))); - -// 3. tiempo transcurrido + perfil de memoria; ignorando call_user_func* durante el perfilado -xhprof_enable( - XHPROF_FLAGS_MEMORY, - array('ignored_functions' => array('call_user_func', - 'call_user_func_array'))); -?> -]]> - - - - - - &reftitle.seealso; - - xhprof_disable - xhprof_sample_enable - memory_get_usage - getrusage - - - - - diff --git a/reference/xhprof/functions/xhprof-sample-disable.xml b/reference/xhprof/functions/xhprof-sample-disable.xml deleted file mode 100644 index edfb1f25d6..0000000000 --- a/reference/xhprof/functions/xhprof-sample-disable.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - xhprof_sample_disable - Detiene el perfilado xhprof por muestreo - - - - &reftitle.description; - - arraynullxhprof_sample_disable - - - - Detiene el perfilado xhprof por muestreo y devuelve la información de perfilado. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un array de datos de muestreo xhprof, procedentes de su ejecución. - Devuelve &null; si el perfilado no está activado. - - - - - &reftitle.examples; - - Ejemplo con <function>xhprof_sample_disable</function> - - -]]> - - &example.outputs.similar; - - main() - [1272935300.900000] => main() -) -]]> - - - - - - - diff --git a/reference/xhprof/functions/xhprof-sample-enable.xml b/reference/xhprof/functions/xhprof-sample-enable.xml deleted file mode 100644 index cfe5a51c9d..0000000000 --- a/reference/xhprof/functions/xhprof-sample-enable.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - xhprof_sample_enable - Iniciar el analisis de XHProf en modo de muestreo - - - - &reftitle.description; - - voidxhprof_sample_enable - - - - Inicia la creación de perfiles en modo de muestra, que es una versión más ligera de peso - de xhprof_enable . El intervalo de muestreo es - 0,1 segundos, y las muestras de registro de la pila de llamadas de función completa. El - caso de uso principal es en gastos indirectos más bajos se requiere cuando se hace - la supervisión del rendimiento y de diagnóstico. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &null; - - - - - &reftitle.seealso; - - xhprof_sample_disable - xhprof_enable - memory_get_usage - getrusage - - - - - diff --git a/reference/xhprof/ini.xml b/reference/xhprof/ini.xml deleted file mode 100644 index 6ddc88570c..0000000000 --- a/reference/xhprof/ini.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - -
    - &reftitle.runtime; - &extension.runtime; - - - Xhprof &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - xhprof.output_dir - "" - INI_ALL - - - - -
    -
    - - &ini.descriptions.title; - - - - - xhprof.output_dir - string - - - - Directorio utilizado por la aplicación por defecto de la interfaz iXHProfRuns - (es decir, la clase XHProfRuns_Default) para el almacenamiento XHProf. - - - - -
    - - diff --git a/reference/xhprof/reference.xml b/reference/xhprof/reference.xml deleted file mode 100644 index 17bc2da2d8..0000000000 --- a/reference/xhprof/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - Xhprof &Functions; - - &reference.xhprof.entities.functions; - - - - diff --git a/reference/xhprof/setup.xml b/reference/xhprof/setup.xml deleted file mode 100644 index c077d8fece..0000000000 --- a/reference/xhprof/setup.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Aunque no es obligatorio, xhprof incluye una interfaz que está escrito en PHP. - Se utiliza para guardar y mostrar los datos reseñados en una forma utilizable, donde la observación - se realiza mediante un navegador web. Por lo tanto, un servidor web PHP activado probablemente mejorará - la experiencia xhprof. - - - También hay un "fork" (bifurcación del desarrollo) de la interfaz gráfica de usuario en - &url.xhprof.gui.fork1; - -
    - - &reference.xhprof.configure; - &reference.xhprof.ini; - -
    - - diff --git a/reference/xlswriter/book.xml b/reference/xlswriter/book.xml deleted file mode 100644 index 6254a1cf74..0000000000 --- a/reference/xlswriter/book.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - - XLSWriter - - - - &reftitle.intro; - - Una eficiente y rápida extensión de exportación de archivos xlsx. - - - - - &reference.xlswriter.setup; - &reference.xlswriter.xlsx-kernel; - &reference.xlswriter.xlsx-format; - - - - diff --git a/reference/xlswriter/configure.xml b/reference/xlswriter/configure.xml deleted file mode 100644 index 1707587068..0000000000 --- a/reference/xlswriter/configure.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - - - -
    - &reftitle.install; - - El soporte XML-RPC en PHP no está habilitado por defecto. Necesitará usar la - opción de configuración - al compilar PHP para habilitar el soporte XML-RPC. - -
    - - - diff --git a/reference/xlswriter/setup.xml b/reference/xlswriter/setup.xml deleted file mode 100644 index 13ebc79f25..0000000000 --- a/reference/xlswriter/setup.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - XLSWriter requiere PHP 7.0 y superior. - -
    - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;xlswriter - -
    - -
    - &reftitle.resources; - - Hay un recurso utilizado por la versión de procedimiento de la extensión - XLSWriter: devuelto por fileName o - \Vtiful\Kernel\Format. - -
    - -
    - - - diff --git a/reference/xlswriter/xlsx-format.xml b/reference/xlswriter/xlsx-format.xml deleted file mode 100644 index 50facb79ab..0000000000 --- a/reference/xlswriter/xlsx-format.xml +++ /dev/null @@ -1,289 +0,0 @@ - - - - - - - - La clase Vtiful\Kernel\Format - Vtiful\Kernel\Format - - - - -
    - &reftitle.intro; - - Crea un objeto con formato de celda - -
    - - -
    - &reftitle.classsynopsis; - - - - Vtiful\Kernel\Format - - - - - Vtiful\Kernel\Format - - - - - &Constants; - - const - int - Vtiful\Kernel\Format::FORMAT_ALIGN_LEFT - 1 - - - const - int - Vtiful\Kernel\Format::FORMAT_ALIGN_CENTER - 2 - - - const - int - Vtiful\Kernel\Format::FORMAT_ALIGN_RIGHT - 3 - - - const - int - Vtiful\Kernel\Format::FORMAT_ALIGN_FILL - 4 - - - const - int - Vtiful\Kernel\Format::FORMAT_ALIGN_JUSTIFY - 5 - - - const - int - Vtiful\Kernel\Format::FORMAT_ALIGN_CENTER_ACROSS - 6 - - - const - int - Vtiful\Kernel\Format::FORMAT_ALIGN_DISTRIBUTED - 7 - - - const - int - Vtiful\Kernel\Format::FORMAT_ALIGN_VERTICAL_TOP - 8 - - - const - int - Vtiful\Kernel\Format::FORMAT_ALIGN_VERTICAL_BOTTOM - 9 - - - const - int - Vtiful\Kernel\Format::FORMAT_ALIGN_VERTICAL_CENTER - 10 - - - const - int - Vtiful\Kernel\Format::FORMAT_ALIGN_VERTICAL_JUSTIFY - 11 - - - const - int - Vtiful\Kernel\Format::FORMAT_ALIGN_VERTICAL_DISTRIBUTED - 12 - - - const - int - Vtiful\Kernel\Format::UNDERLINE_SINGLE - 1 - - - const - int - Vtiful\Kernel\Format::UNDERLINE_DOUBLE - 2 - - - const - int - Vtiful\Kernel\Format::UNDERLINE_SINGLE_ACCOUNTING - 3 - - - const - int - Vtiful\Kernel\Format::UNDERLINE_DOUBLE_ACCOUNTING - 4 - - - &Methods; - - - - - -
    - - -
    - &reftitle.constants; - - - - 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 - - - - - - -
    - - -
    - - &reference.xlswriter.entities.xlsx-format; - -
    - - diff --git a/reference/xlswriter/xlsx-format/align.xml b/reference/xlswriter/xlsx-format/align.xml deleted file mode 100644 index ba89ba2785..0000000000 --- a/reference/xlswriter/xlsx-format/align.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - - Vtiful\Kernel\Format::align - Vtiful\Kernel\Format align - - - - &reftitle.description; - - public Vtiful\Kernel\Format::align - resourcehandle - intstyle - - - establece la alineación de la celda - - - - - &reftitle.parameters; - - - handle - - - manejador de archivos xlsx - - - - - style - - - constante Vtiful\Kernel\Format - - - - - - - - &reftitle.returnvalues; - - Recurso - - - - - &reftitle.examples; - - Ejemplo de estilo de alineación - - './tests' -]; - -$excel = new \Vtiful\Kernel\Excel($config); -$excel->fileName('tutorial01.xlsx'); - -$format = new \Vtiful\Kernel\Format($excel->getHandle()); -$alignStyle = $format->align(\Vtiful\Kernel\Format::FORMAT_ALIGN_LEFT)->toResource(); - -$excel->header(['name', 'age']) - ->data([['viest', 21]]) - ->setColumn('A:A', 200, $alignStyle) - ->output(); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-format/bold.xml b/reference/xlswriter/xlsx-format/bold.xml deleted file mode 100644 index c73450a2bc..0000000000 --- a/reference/xlswriter/xlsx-format/bold.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - - Vtiful\Kernel\Format::bold - Vtiful\Kernel\Format bold - - - - &reftitle.description; - - public Vtiful\Kernel\Format::bold - resourcehandle - - - Vtiful\Kernel\Format formato en negrita - - - - - &reftitle.parameters; - - - handle - - - manejador de archivos xlsx - - - - - - - - &reftitle.returnvalues; - - Recurso - - - - - &reftitle.examples; - - Ejemplo de estilo negrita - - './tests' -]; - -$excel = new \Vtiful\Kernel\Excel($config); -$excel->fileName('tutorial01.xlsx'); - -$format = new \Vtiful\Kernel\Format($excel->getHandle()); -$boldStyle = $format->bold()->toResource(); - -$excel->header(['name', 'age']) - ->data([['viest', 21]]) - ->setColumn('A:A', 200, $boldStyle) - ->output(); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-format/italic.xml b/reference/xlswriter/xlsx-format/italic.xml deleted file mode 100644 index 41d6dc6674..0000000000 --- a/reference/xlswriter/xlsx-format/italic.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - - Vtiful\Kernel\Format::italic - Vtiful\Kernel\Format italic - - - - &reftitle.description; - - public Vtiful\Kernel\Format::italic - resourcehandle - - - Vtiful\Kernel\Format formato cursivo - - - - - &reftitle.parameters; - - - handle - - - manejador de archivos xlsx - - - - - - - - &reftitle.returnvalues; - - Recurso - - - - - &reftitle.examples; - - Ejemplo de estilo cursiva - - './tests' -]; - -$excel = new \Vtiful\Kernel\Excel($config); -$excel->fileName('tutorial01.xlsx'); - -$format = new \Vtiful\Kernel\Format($excel->getHandle()); -$italicStyle = $format->italic()->toResource(); - -$excel->header(['name', 'age']) - ->data([['viest', 21]]) - ->setColumn('A:A', 200, $italicStyle) - ->output(); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-format/underline.xml b/reference/xlswriter/xlsx-format/underline.xml deleted file mode 100644 index 97105dec70..0000000000 --- a/reference/xlswriter/xlsx-format/underline.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - - Vtiful\Kernel\Format::underline - Vtiful\Kernel\Format underline - - - - &reftitle.description; - - public Vtiful\Kernel\Format::underline - resourcehandle - intstyle - - - Vtiful\Kernel\Format formato subrayado - - - - - &reftitle.parameters; - - - handle - - - manejador de archivos xlsx - - - - - style - - - constante Vtiful\Kernel\Format - - - - - - - - &reftitle.returnvalues; - - Recurso - - - - - &reftitle.examples; - - Ejemplo de estilo subrayado - - './tests' -]; - -$excel = new \Vtiful\Kernel\Excel($config); -$excel->fileName('tutorial01.xlsx'); - -$format = new \Vtiful\Kernel\Format($excel->getHandle()); -$underlineStyle = $format->underline(\Vtiful\Kernel\Format::UNDERLINE_SINGLE)->toResource(); - -$excel->header(['name', 'age']) - ->data([['viest', 21]]) - ->setColumn('A:A', 200, $underlineStyle) - ->output(); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel.xml b/reference/xlswriter/xlsx-kernel.xml deleted file mode 100644 index def23122fd..0000000000 --- a/reference/xlswriter/xlsx-kernel.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - La clase Vtiful\Kernel\Excel - Vtiful\Kernel\Excel - - - - -
    - &reftitle.intro; - - Crea archivos xlsx y fija las celdas y produce los archivos xlsx - -
    - - -
    - &reftitle.classsynopsis; - - - - Vtiful\Kernel\Excel - - - - - Vtiful\Kernel\Excel - - - - - &Methods; - - - - - - - - - -
    - -
    - - &reference.xlswriter.entities.xlsx-kernel; - -
    - - diff --git a/reference/xlswriter/xlsx-kernel/add-sheet.xml b/reference/xlswriter/xlsx-kernel/add-sheet.xml deleted file mode 100644 index 447cf95e79..0000000000 --- a/reference/xlswriter/xlsx-kernel/add-sheet.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - - Vtiful\Kernel\Excel::addSheet - Vtiful\Kernel\Excel addSheet - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::addSheet - stringsheetName - - - Crea una nueva hoja de trabajo en el archivo xlsx. - - - - - &reftitle.parameters; - - - sheetName - - - Nombre de la hoja de trabajo - - - - - - - - &reftitle.returnvalues; - - instancia Vtiful\Kernel\Excel - - - - - &reftitle.examples; - - ejemplo - - './tests' -]; - -$fileObject = new \Vtiful\Kernel\Excel($config); - -$file = $fileObject->fileName('tutorial.xlsx', 'sheet_one') - ->header(['name', 'age']) - ->data([ - ['viest', 23], - ['wjx', 23] - ]); - -$file->addSheet('sheet_two') - ->header(['name', 'age']) - ->data([ - ['james', 33], - ['king', 33] - ]); - -$file->output(); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/auto-filter.xml b/reference/xlswriter/xlsx-kernel/auto-filter.xml deleted file mode 100644 index a51d900422..0000000000 --- a/reference/xlswriter/xlsx-kernel/auto-filter.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - - Vtiful\Kernel\Excel::autoFilter - Vtiful\Kernel\Excel autoFilter - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::autoFilter - stringscope - - - Añade el autofiltro a una hoja de trabajo. - - - - - &reftitle.parameters; - - - scope - - - Celda de inicio y final de la cadena de coordenadas. - - - - - - - - &reftitle.returnvalues; - - instancia Vtiful\Kernel\Excel - - - - - &reftitle.examples; - - ejemplo - - './tests' -]; - -$fileObject = new \Vtiful\Kernel\Excel($config); - -$file = $fileObject->fileName('test.xlsx') - ->header(['name', 'age']) - ->data($data) - ->autoFilter('A1:B11') // auto filter - ->output(); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/const-memory.xml b/reference/xlswriter/xlsx-kernel/const-memory.xml deleted file mode 100644 index 8c73b2b64d..0000000000 --- a/reference/xlswriter/xlsx-kernel/const-memory.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - Vtiful\Kernel\Excel::constMemory - Vtiful\Kernel\Excel constMemory - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::constMemory - stringfileName - stringsheetName - - - Escribe un archivo grande con un uso constante de la memoria. - - - - - &reftitle.parameters; - - - fileName - - - Nombre del archivo XLSX - - - - - sheetName - - - Nombre de la hoja de trabajo - - - - - - - - &reftitle.returnvalues; - - instancia Vtiful\Kernel\Excel - - - - - &reftitle.examples; - - ejemplo - - '/home/viest' -]; - -$fileObject = new \Vtiful\Kernel\Excel($config); - -$file = $fileObject->constMemory('tutorial.xlsx', 'sheet'); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/construct.xml b/reference/xlswriter/xlsx-kernel/construct.xml deleted file mode 100644 index 40bc3560d6..0000000000 --- a/reference/xlswriter/xlsx-kernel/construct.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - Vtiful\Kernel\Excel::__construct - Vtiful\Kernel\Excel constructor - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::__construct - arrayconfig - - - Vtiful\Kernel\Excel constructor, crea un objeto de clase. - - - - - &reftitle.parameters; - - - config - - - Configuración de la exportación de archivos XLSX - - - - - - - - &reftitle.examples; - - ejemplo - - '/home/viest' -]; - -$excelObject = new \Vtiful\Kernel\Excel($config); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/data.xml b/reference/xlswriter/xlsx-kernel/data.xml deleted file mode 100644 index c8dec92137..0000000000 --- a/reference/xlswriter/xlsx-kernel/data.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - - - Vtiful\Kernel\Excel::data - Vtiful\Kernel\Excel data - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::data - arraydata - - - Escribe un dato en la hoja de trabajo. - - - - - &reftitle.parameters; - - - data - - - datos de la hoja de trabajo - - - - - - - - &reftitle.returnvalues; - - instancia Vtiful\Kernel\Excel - - - - - &reftitle.examples; - - ejemplo - - './tests' -]; - -$fileObject = new \Vtiful\Kernel\Excel($config); - -$file = $fileObject->fileName('tutorial.xlsx', 'sheet_one') - ->header(['name', 'age']) - ->data([ - ['viest', 23], - ['wjx', 23], - ]); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/file-name.xml b/reference/xlswriter/xlsx-kernel/file-name.xml deleted file mode 100644 index 9db3883bf1..0000000000 --- a/reference/xlswriter/xlsx-kernel/file-name.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - Vtiful\Kernel\Excel::fileName - Vtiful\Kernel\Excel fileName - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::fileName - stringfileName - stringsheetName - - - Crear un nuevo archivo xlsx y crea una hoja de trabajo. - - - - - &reftitle.parameters; - - - fileName - - - Nombre del archivo XLSX - - - - - sheetName - - - Nombre de la hoja de trabajo - - - - - - - - &reftitle.returnvalues; - - instancia Vtiful\Kernel\Excel - - - - - &reftitle.examples; - - ejemplo - - '/home/viest' -]; - -$fileObject = new \Vtiful\Kernel\Excel($config); - -$file = $fileObject->fileName('tutorial.xlsx', 'sheet'); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/get-handle.xml b/reference/xlswriter/xlsx-kernel/get-handle.xml deleted file mode 100644 index ffb4f0f418..0000000000 --- a/reference/xlswriter/xlsx-kernel/get-handle.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - Vtiful\Kernel\Excel::getHandle - Vtiful\Kernel\Excel getHandle - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::getHandle - - - - Consigue el manejo de los recursos de texto xlsx. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Recurso - - - - - &reftitle.examples; - - ejemplo - - './tests' -]; - -$fileObject = new \Vtiful\Kernel\Excel($config); - -$file = $fileObject->fileName('tutorial.xlsx', 'sheet_one') - ->header(['name', 'age']); - -$handle = $file->getHandle(); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/header.xml b/reference/xlswriter/xlsx-kernel/header.xml deleted file mode 100644 index 3d0ae1485c..0000000000 --- a/reference/xlswriter/xlsx-kernel/header.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - - Vtiful\Kernel\Excel::header - Vtiful\Kernel\Excel header - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::header - arrayheaderData - - - Escribe un encabezado en la hoja de trabajo. - - - - - &reftitle.parameters; - - - headerData - - - datos de la cabecera de la hoja de trabajo - - - - - - - - &reftitle.returnvalues; - - instancia Vtiful\Kernel\Excel - - - - - &reftitle.examples; - - ejemplo - - './tests' -]; - -$fileObject = new \Vtiful\Kernel\Excel($config); - -$file = $fileObject->fileName('tutorial.xlsx', 'sheet_one') - ->header(['name', 'age']); -?> -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/insert-formula.xml b/reference/xlswriter/xlsx-kernel/insert-formula.xml deleted file mode 100644 index 0e55cad4b7..0000000000 --- a/reference/xlswriter/xlsx-kernel/insert-formula.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - - Vtiful\Kernel\Excel::insertFormula - Vtiful\Kernel\Excel insertFormula - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::insertFormula - introw - intcolumn - stringformula - - - Inserta la fórmula de cálculo. - - - - - &reftitle.parameters; - - - row - - - fila de celdas - - - - - column - - - columna de celdas - - - - - formula - - - Cadena de fórmula - - - - - - - - &reftitle.returnvalues; - - instancia Vtiful\Kernel\Excel - - - - - &reftitle.examples; - - ejemplo - - './tests' -]; - -$excel = new \Vtiful\Kernel\Excel($config); - -$file = $excel->fileName("free.xlsx") - ->header(['name', 'money']); - -for($index = 1; $index < 10; $index++) { - $file->insertText($index, 0, 'viest'); - $file->insertText($index, 1, 10); -} - -$file->insertText(12, 0, "Total"); -$file->insertFormula(12, 1, '=SUM(B2:B11)'); // insertar la fórmula - -$file->output(); -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/insert-image.xml b/reference/xlswriter/xlsx-kernel/insert-image.xml deleted file mode 100644 index ad52919e5d..0000000000 --- a/reference/xlswriter/xlsx-kernel/insert-image.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - - - Vtiful\Kernel\Excel::insertImage - Vtiful\Kernel\Excel insertImage - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::insertImage - introw - intcolumn - stringlocalImagePath - - - Inserta una imagen local en la celda. - - - - - &reftitle.parameters; - - - row - - - fila de celdas - - - - - column - - - columna de celdas - - - - - localImagePath - - - ruta de la imagen local - - - - - - - - &reftitle.returnvalues; - - instancia Vtiful\Kernel\Excel - - - - - &reftitle.examples; - - ejemplo - - './tests' -]; - -$excel = new \Vtiful\Kernel\Excel($config); - -$file = $excel->fileName("free.xlsx"); - -$file->insertImage(5, 0, '/vagrant/ASW-G-66.jpg'); - -$file->output(); -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/insert-text.xml b/reference/xlswriter/xlsx-kernel/insert-text.xml deleted file mode 100644 index c1fe3b6b37..0000000000 --- a/reference/xlswriter/xlsx-kernel/insert-text.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - Vtiful\Kernel\Excel::insertText - Vtiful\Kernel\Excel insertText - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::insertText - introw - intcolumn - intfloatstringdata - stringformat - - - Escribe texto en una celda. - - - - - &reftitle.parameters; - - - row - - - fila de celdas - - - - - column - - - columna de celdas - - - - - data - - - los datos que se escribirán - - - - - format - - - Cadena de formato - - - - - - - - &reftitle.returnvalues; - - instancia Vtiful\Kernel\Excel - - - - - &reftitle.examples; - - ejemplo - - './tests' -]; - -$excel = new \Vtiful\Kernel\Excel($config); - -$file = $excel->fileName("free.xlsx") - ->header(['name', 'money']); - -for ($index = 0; $index < 10; $index++) { - $file->insertText($index+1, 0, 'viest'); - $file->insertText($index+1, 1, 10000, '#,##0'); -} - -$file->output(); -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/merge-cells.xml b/reference/xlswriter/xlsx-kernel/merge-cells.xml deleted file mode 100644 index b1ec2fa9ec..0000000000 --- a/reference/xlswriter/xlsx-kernel/merge-cells.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - - Vtiful\Kernel\Excel::mergeCells - Vtiful\Kernel\Excel mergeCells - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::mergeCells - stringscope - stringdata - - - Combinar Celdas. - - - - - &reftitle.parameters; - - - scope - - - Cadenas de coordenadas de inicio y fin de la celda - - - - - data - - - Cadena de datos - - - - - - - - &reftitle.returnvalues; - - instancia Vtiful\Kernel\Excel - - - - - &reftitle.examples; - - ejemplo - - './tests' -]; - -$excel = new \Vtiful\Kernel\Excel($config); - -$excel->fileName("test.xlsx") - ->mergeCells('A1:C1', 'Merge cells') - ->output(); -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/output.xml b/reference/xlswriter/xlsx-kernel/output.xml deleted file mode 100644 index 0ece316250..0000000000 --- a/reference/xlswriter/xlsx-kernel/output.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - Vtiful\Kernel\Excel::output - Vtiful\Kernel\Excel output - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::output - - - - Salida del archivo xlsx al disco. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Ruta de archivo XLSX; - - - - - &reftitle.examples; - - ejemplo - - './tests' -]; - -$fileObject = new \Vtiful\Kernel\Excel($config); - -$file = $fileObject->fileName('tutorial.xlsx', 'sheet_one') - ->header(['name', 'age']) - ->data([ - ['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 deleted file mode 100644 index f3443fb74e..0000000000 --- a/reference/xlswriter/xlsx-kernel/set-column.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - - Vtiful\Kernel\Excel::setColumn - Vtiful\Kernel\Excel setColumn - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::setColumn - stringrange - floatwidth - resourceformat - - - Establece el formato de la columna. - - - - - &reftitle.parameters; - - - range - - - Las cadenas de coordenadas de inicio y fin de la celda - - - - - width - - - ancho de la columna - - - - - format - - - recurso de formato de celdas - - - - - - - - &reftitle.returnvalues; - - instancia Vtiful\Kernel\Excel - - - - - &reftitle.examples; - - Ejemplo de setColumn - - './tests' -]; - -$excel = new \Vtiful\Kernel\Excel($config); -$excel->fileName('tutorial01.xlsx'); - -$format = new \Vtiful\Kernel\Format($excel->getHandle()); -$boldStyle = $format->bold()->toResource(); - -$excel->header(['name', 'age']) - ->data([['viest', 21]]) - ->setColumn('A:A', 200, $boldStyle) - ->output(); -]]> - - - - - - - diff --git a/reference/xlswriter/xlsx-kernel/set-row.xml b/reference/xlswriter/xlsx-kernel/set-row.xml deleted file mode 100644 index 77d968f7ef..0000000000 --- a/reference/xlswriter/xlsx-kernel/set-row.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - - Vtiful\Kernel\Excel::setRow - Vtiful\Kernel\Excel setRow - - - - &reftitle.description; - - public Vtiful\Kernel\Excel::setRow - stringrange - floatheight - resourceformat - - - Establece el formato de la fila. - - - - - &reftitle.parameters; - - - range - - - Las cadenas de coordenadas de inicio y fin de la celda - - - - - height - - - altura de la fila - - - - - format - - - recurso de formato de celdas - - - - - - - - &reftitle.returnvalues; - - instancia Vtiful\Kernel\Excel - - - - - &reftitle.examples; - - Ejemplo de setRow - - './tests' -]; - -$excel = new \Vtiful\Kernel\Excel($config); -$excel->fileName('tutorial01.xlsx'); - -$format = new \Vtiful\Kernel\Format($excel->getHandle()); -$boldStyle = $format->bold()->toResource(); - -$excel->header(['name', 'age']) - ->data([['viest', 21]]) - ->setRow('A1', 20, $boldStyle) - ->output(); -]]> - - - - - - - diff --git a/reference/xmldiff/book.xml b/reference/xmldiff/book.xml deleted file mode 100644 index fd0aee717f..0000000000 --- a/reference/xmldiff/book.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - Diferencias y fusión de documentos XML - XMLDiff - - - &reftitle.intro; - - Esta extensión es capaz de calcular las diferencias de dos documentos XML y luego aplicarlas en el documento de origen. El diff es un documento XML que contiene en sus nodos, en formato legible por humanos, las instruciones para copiar/insertar/eliminar. Objetos del tipo DOMDocument, ficheros locales y cadenas en memoria pueden ser procesados. - - - - &reference.xmldiff.setup; - - - &reference.xmldiff.xmldiff.base; - &reference.xmldiff.xmldiff.dom; - &reference.xmldiff.xmldiff.memory; - &reference.xmldiff.xmldiff.file; - &reference.xmldiff.xmldiff.exception; - - - - diff --git a/reference/xmldiff/configure.xml b/reference/xmldiff/configure.xml deleted file mode 100644 index 7650ac746d..0000000000 --- a/reference/xmldiff/configure.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - -
    - &reftitle.install; - - - Usar al compilar PHP. - - - - Los usuarios Windows deben incluir php_xmldiff.dll en &php.ini; - - -
    - - diff --git a/reference/xmldiff/reference.xml b/reference/xmldiff/reference.xml deleted file mode 100644 index 42e7da2b9b..0000000000 --- a/reference/xmldiff/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - &Functions; de Xmldiff - - - - - - diff --git a/reference/xmldiff/setup.xml b/reference/xmldiff/setup.xml deleted file mode 100644 index 17a1a7c8fc..0000000000 --- a/reference/xmldiff/setup.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - &reftitle.setup; - -
    - &reftitle.required; - libdiffmark - la versión 0.10 se incluye con la extensión. Si diffmark está disponible en los paquetes del sistema, su uso es altamente recomendado. - Extensión libxml - Extensión DOM -
    - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;xmldiff. - -
    - - - -
    - - diff --git a/reference/xmldiff/xmldiff-base/construct.xml b/reference/xmldiff/xmldiff-base/construct.xml deleted file mode 100644 index 70e72be0c9..0000000000 --- a/reference/xmldiff/xmldiff-base/construct.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - XMLDiff\Base::__construct - Constructor - - - - &reftitle.description; - - public XMLDiff\Base::__construct - stringnsname - - - Constructor base para todas las clases de trabajadores en la extensión Xmldiff. - - - - - - &reftitle.parameters; - - - nsname - - - Nombre del espacio de nombres personalizado para el documento de diferencias. El espacio de nombres por defecto es http://www.locus.cz/diffmark y eso es suficiente para evitar conflictos de nombres. Usa este parámetro si quieres cambiarlo por alguna razón. - - - - - - - - - diff --git a/reference/xmldiff/xmldiff-base/diff.xml b/reference/xmldiff/xmldiff-base/diff.xml deleted file mode 100644 index 85411531a6..0000000000 --- a/reference/xmldiff/xmldiff-base/diff.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - XMLDiff\Base::diff - Produce diferencias de dos documentos XML - - - - &reftitle.description; - - abstract public mixedXMLDiff\Base::diff - mixedfrom - mixedto - - - Método abstracto diferencial para ser aplicado por las clases hereditarias. - - - El propósito básico de este método es producir diferencias entre dos documentos. El orden paramétrico importa y producirá diferentes resultados. - - - - - - &reftitle.parameters; - - - from - - - Documento fuente XML. - - - - - to - - - Documento XML de destino. - - - - - - - - &reftitle.returnvalues; - - Depende de la implementación. - - - - - - - diff --git a/reference/xmldiff/xmldiff-base/merge.xml b/reference/xmldiff/xmldiff-base/merge.xml deleted file mode 100644 index 2f1e41e494..0000000000 --- a/reference/xmldiff/xmldiff-base/merge.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - XMLDiff\Base::merge - Produce un nuevo documento XML basado en diferencias - - - - &reftitle.description; - - abstract public mixedXMLDiff\Base::merge - mixedsrc - mixeddiff - - - Método de fusión abstracta para ser implementado por las clases hereditarias. - - - Básicamente el propósito del método es producir un nuevo documento XML basado en la información diferencial. - - - - - &reftitle.parameters; - - - src - - - Documento fuente XML. - - - - - diff - - - Documento producido por el método diferencial. - - - - - - - - &reftitle.returnvalues; - - Depende de la implementación. - - - - - - - diff --git a/reference/xmldiff/xmldiff-dom/diff.xml b/reference/xmldiff/xmldiff-dom/diff.xml deleted file mode 100644 index d34d83c3cc..0000000000 --- a/reference/xmldiff/xmldiff-dom/diff.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - XMLDiff\DOM::diff - Diferencia dos objetos DOMDocument - - - - &reftitle.description; - - public DOMDocumentXMLDiff\DOM::diff - DOMDocumentfrom - DOMDocumentto - - - Diferencia dos instancias de DOMDocument y produce la nueva que contiene la información de la diferencia. - - - - - &reftitle.parameters; - - - from - - - Fuente del objeto DOMDocument. - - - - - to - - - Objeto de destino DOMDocument. - - - - - - - - &reftitle.returnvalues; - - DOMDocument con la información de diferencia o NULL. - - - - - - - diff --git a/reference/xmldiff/xmldiff-dom/merge.xml b/reference/xmldiff/xmldiff-dom/merge.xml deleted file mode 100644 index 46aa1c2256..0000000000 --- a/reference/xmldiff/xmldiff-dom/merge.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - XMLDiff\DOM::merge - Produce DOMDocument unido - - - - &reftitle.description; - - public DOMDocumentXMLDiff\DOM::merge - DOMDocumentsrc - DOMDocumentdiff - - - Crear un nuevo DOMDocument basado en las diferencias. - - - - - &reftitle.parameters; - - - src - - - Objeto fuente DOMDocument. - - - - - diff - - - Objeto DOMDocument que contiene la información de diferencias. - - - - - - - - &reftitle.returnvalues; - - DOMDocument unido o NULL. - - - - - - - diff --git a/reference/xmldiff/xmldiff-file/diff.xml b/reference/xmldiff/xmldiff-file/diff.xml deleted file mode 100644 index 91d075d734..0000000000 --- a/reference/xmldiff/xmldiff-file/diff.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - XMLDiff\File::diff - Diferencia dos archivos XML - - - - &reftitle.description; - - public stringXMLDiff\File::diff - stringfrom - stringto - - - Diferencia dos archivos XML locales y produce una cadena con la información de diferenciación. - - - - - &reftitle.parameters; - - - from - - - Ruta al documento fuente. - - - - - to - - - Ruta al documento fuente. - - - - - - - - &reftitle.returnvalues; - - Cadena con el documento XML que contiene la información diferencial o NULL. - - - - - - - diff --git a/reference/xmldiff/xmldiff-file/merge.xml b/reference/xmldiff/xmldiff-file/merge.xml deleted file mode 100644 index 35aee7fdf3..0000000000 --- a/reference/xmldiff/xmldiff-file/merge.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - XMLDiff\File::merge - Produce un documento XML unido - - - - &reftitle.description; - - public stringXMLDiff\File::merge - stringsrc - stringdiff - - - Crea un nuevo documento XML basado en diferencias y documento fuente. - - - - - &reftitle.parameters; - - - src - - - Ruta al documento XML de origen. - - - - - diff - - - Ruta al documento XML con la información de diferencia. - - - - - - - - &reftitle.returnvalues; - - Cadena con el nuevo documento XML o NULL. - - - - - - - diff --git a/reference/xmldiff/xmldiff-memory/diff.xml b/reference/xmldiff/xmldiff-memory/diff.xml deleted file mode 100644 index ef15db6272..0000000000 --- a/reference/xmldiff/xmldiff-memory/diff.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - XMLDiff\Memory::diff - Diferenciar dos documentos XML - - - - &reftitle.description; - - public stringXMLDiff\Memory::diff - stringfrom - stringto - - - Diferenciar dos cadenas que contienen documentos XML y producir la información diferencial. - - - - - &reftitle.parameters; - - - from - - - Documento fuente XML. - - - - - to - - - Documento XML de destino. - - - - - - - - &reftitle.returnvalues; - - Cadena con el documento XML que contiene la información del diferencia o NULL. - - - - - - - diff --git a/reference/xmldiff/xmldiff-memory/merge.xml b/reference/xmldiff/xmldiff-memory/merge.xml deleted file mode 100644 index 1b7c6a4071..0000000000 --- a/reference/xmldiff/xmldiff-memory/merge.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - - XMLDiff\Memory::merge - Produce un documento XML unido - - - - &reftitle.description; - - public stringXMLDiff\Memory::merge - stringsrc - stringdiff - - - Crear un nuevo documento XML basado en diferencias y documento fuente. - - - - - &reftitle.parameters; - - - src - - - Documento fuente XML. - - - - - diff - - - Documento XML que contiene información de diferencias. - - - - - - - - &reftitle.returnvalues; - - Cadena con el nuevo documento XML o NULL. - - - - - - - diff --git a/reference/xmldiff/xmldiff.base.xml b/reference/xmldiff/xmldiff.base.xml deleted file mode 100644 index 2c45920bd4..0000000000 --- a/reference/xmldiff/xmldiff.base.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - La clase XMLDiff\Base - XMLDiff\Base - - - - -
    - &reftitle.intro; - - Clase abstracta, base para todas las clases de comparación en la extensión. - -
    - - -
    - &reftitle.classsynopsis; - - - - XMLDiff\Base - - - - - XMLDiff\Base - - - - - &Methods; - - - - - - - - - -
    - -
    - - &reference.xmldiff.entities.xmldiff-base; - -
    - - diff --git a/reference/xmldiff/xmldiff.dom.xml b/reference/xmldiff/xmldiff.dom.xml deleted file mode 100644 index 8e9e305c3b..0000000000 --- a/reference/xmldiff/xmldiff.dom.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - La clase XMLDiff\DOM - XMLDiff\DOM - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - XMLDiff\DOM - - - - - XMLDiff\DOM - - - - extends - XMLDiff\Base - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.xmldiff.entities.xmldiff-dom; - -
    - - diff --git a/reference/xmldiff/xmldiff.exception.xml b/reference/xmldiff/xmldiff.exception.xml deleted file mode 100644 index 0dfc5bdf22..0000000000 --- a/reference/xmldiff/xmldiff.exception.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - La clase XMLDiff\Exception - XMLDiff\Exception - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - XMLDiff\Exception - - - - - XMLDiff\Exception - - - - extends - Exception - - - - &InheritedProperties; - - - - &InheritedMethods; - - - - - -
    - -
    - -
    - - diff --git a/reference/xmldiff/xmldiff.file.xml b/reference/xmldiff/xmldiff.file.xml deleted file mode 100644 index 03467fc7dd..0000000000 --- a/reference/xmldiff/xmldiff.file.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - La clase XMLDiff\File - XMLDiff\File - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - XMLDiff\File - - - - - XMLDiff\File - - - - extends - XMLDiff\Base - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.xmldiff.entities.xmldiff-file; - -
    - - diff --git a/reference/xmldiff/xmldiff.memory.xml b/reference/xmldiff/xmldiff.memory.xml deleted file mode 100644 index 2f9fa051bb..0000000000 --- a/reference/xmldiff/xmldiff.memory.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - La clase XMLDiff\Memory - XMLDiff\Memory - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - XMLDiff\Memory - - - - - XMLDiff\Memory - - - - extends - XMLDiff\Base - - - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.xmldiff.entities.xmldiff-memory; - -
    - - diff --git a/reference/xmlrpc/book.xml b/reference/xmlrpc/book.xml deleted file mode 100644 index 8b06a389b6..0000000000 --- a/reference/xmlrpc/book.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - - - XML-RPC - - - - &reftitle.intro; - - Estas funciones se pueden usar para escribir servidores y clientes XML-RPC. - Se puede encontrar más información acerca de XML-RPC en - &url.xmlrpc;, y más - documentación sobre esta extensión y sus funciones en - &url.xmlrpc-epi;. - - &warn.experimental; - - - - &reference.xmlrpc.setup; - &reference.xmlrpc.reference; - - - - - diff --git a/reference/xmlrpc/configure.xml b/reference/xmlrpc/configure.xml deleted file mode 100644 index 0c119b2934..0000000000 --- a/reference/xmlrpc/configure.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - -
    - &reftitle.install; - - El XML-RPC soportado en PHP no está activado por defecto. Se necesita - usar la opción configuración de - cuando es compilado el PHP para activar el soporte a XML-RPC. - -
    - - - diff --git a/reference/xmlrpc/functions/xmlrpc-decode-request.xml b/reference/xmlrpc/functions/xmlrpc-decode-request.xml deleted file mode 100644 index 249cfe2f0e..0000000000 --- a/reference/xmlrpc/functions/xmlrpc-decode-request.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - xmlrpc_decode_request - Decodifica el XML en los tipos de PHP nativos - - - &reftitle.description; - - mixedxmlrpc_decode_request - stringxml - stringmethod - stringencoding - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-decode.xml b/reference/xmlrpc/functions/xmlrpc-decode.xml deleted file mode 100644 index 889a9ec4b4..0000000000 --- a/reference/xmlrpc/functions/xmlrpc-decode.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - xmlrpc_decode - Decodifica el XML en los tipos de PHP nativos - - - &reftitle.description; - - mixedxmlrpc_decode - stringxml - stringencoding"iso-8859-1" - - &warn.experimental.func; - - - - &reftitle.parameters; - - - - xml - - - La respuesta XML devuelta por el método XMLRPC. - - - - - encoding - - - Entrada de codificación que admite iconv. - - - - - - - - - &reftitle.returnvalues; - - Devuelve o un arreglo, o un entero, o una cadena, o un booleano conforme - a la respuesta devuelta por el método XMLRPC. - - - - - &reftitle.examples; - - Ver el ejemplo de xmlrpc_encode_request. - - - - - &reftitle.seealso; - - - xmlrpc_encode_request - xmlrpc_is_fault - - - - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-encode-request.xml b/reference/xmlrpc/functions/xmlrpc-encode-request.xml deleted file mode 100644 index 6bc43b07cf..0000000000 --- a/reference/xmlrpc/functions/xmlrpc-encode-request.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - - xmlrpc_encode_request - Genera el XML para un método - - - &reftitle.description; - - stringxmlrpc_encode_request - stringmethod - mixedparams - arrayoutput_options - - &warn.experimental.func; - - - - &reftitle.parameters; - - - - method - - - Nombre del método a llamar. - - - - - params - - - Argumentos del método, compatibles con la firma del método. - - - - - output_options - - - Array que especifica las opciones de salida que puede contener (los valores - por omisión están en negrita): - - output_type: php, xml - verbosity: no_white_space, newlines_only, pretty - escaping: cdata, non-ascii, non-print, markup - (puede ser una cadena con un valor o un array con varios valores) - version: simple, xmlrpc, soap 1.1, auto - encoding: iso-8859-1, otros juegos de caracteres soportados por iconv - - - - - - - - - - &reftitle.returnvalues; - - Devuelve una cadena que contiene la representación XML de la solicitud. - - - - - &reftitle.examples; - - - Ejemplo con XMLRPC - - [ - 'method' => "POST", - 'header' => "Content-Type: text/xml", - 'content' => $request, - ] -]); -$file = file_get_contents("http://www.example.com/xmlrpc", false, $context); -$response = xmlrpc_decode($file); -if ($response && xmlrpc_is_fault($response)) { - trigger_error("xmlrpc: $response[faultString] ($response[faultCode])"); -} else { - print_r($response); -} -?> -]]> - - - - - - - &reftitle.seealso; - - - stream_context_create - file_get_contents - xmlrpc_decode - - - - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-encode.xml b/reference/xmlrpc/functions/xmlrpc-encode.xml deleted file mode 100644 index ea6a84f63e..0000000000 --- a/reference/xmlrpc/functions/xmlrpc-encode.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - - - - xmlrpc_encode - Genera XML para un valor PHP - - - &reftitle.description; - - stringxmlrpc_encode - mixedvalue - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-get-type.xml b/reference/xmlrpc/functions/xmlrpc-get-type.xml deleted file mode 100644 index bcf8a4ea2c..0000000000 --- a/reference/xmlrpc/functions/xmlrpc-get-type.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - xmlrpc_get_type - Obtiene el tipo del xmlrpc para un valor PHP - - - &reftitle.description; - - stringxmlrpc_get_type - mixedvalue - - &warn.experimental.func; - - Ésta función es específicamente útil para la base64 y las cadenas fecha-hora. - - - - - &reftitle.parameters; - - - - value - - - valor de PHP - - - - - - - - - &reftitle.returnvalues; - - Devuelve el tipo de XML-RPC. - - - - - &reftitle.examples; - - - Ejemplo de tipo de XML-RPC - - -]]> - - - - - - - &reftitle.seealso; - - - xmlrpc_set_type - - - - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-is-fault.xml b/reference/xmlrpc/functions/xmlrpc-is-fault.xml deleted file mode 100644 index 8c3e3796c4..0000000000 --- a/reference/xmlrpc/functions/xmlrpc-is-fault.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - xmlrpc_is_fault - Determina si el valor de un arreglo representa una falla del XMLRPC - - - &reftitle.description; - - boolxmlrpc_is_fault - arrayarg - - &warn.experimental.func; - - - - &reftitle.parameters; - - - - arg - - - El arreglo devuelto por xmlrpc_decode. - - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si embargo si el argumento significa fallo retorna, &false;. La descripción de - la falla o falta está disponible en $arg["faultString"], y - el código de fallo está en $arg["faultCode"]. - - - - - &reftitle.examples; - - Ver ejemplo dexmlrpc_encode_request. - - - - - &reftitle.seealso; - - - xmlrpc_decode - - - - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-parse-method-descriptions.xml b/reference/xmlrpc/functions/xmlrpc-parse-method-descriptions.xml deleted file mode 100644 index f739a8bf64..0000000000 --- a/reference/xmlrpc/functions/xmlrpc-parse-method-descriptions.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - - - - xmlrpc_parse_method_descriptions - Decodifica el XML en una lista de las descripciones del método - - - &reftitle.description; - - arrayxmlrpc_parse_method_descriptions - stringxml - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-server-add-introspection-data.xml b/reference/xmlrpc/functions/xmlrpc-server-add-introspection-data.xml deleted file mode 100644 index 1b26a5ac8b..0000000000 --- a/reference/xmlrpc/functions/xmlrpc-server-add-introspection-data.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - xmlrpc_server_add_introspection_data - Agrega una documentación introspectiva - - - &reftitle.description; - - intxmlrpc_server_add_introspection_data - resourceserver - arraydesc - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-server-call-method.xml b/reference/xmlrpc/functions/xmlrpc-server-call-method.xml deleted file mode 100644 index faa9361f0e..0000000000 --- a/reference/xmlrpc/functions/xmlrpc-server-call-method.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - xmlrpc_server_call_method - Analiza los requerimientos del XML y las llamadas de los métodos - - - &reftitle.description; - - stringxmlrpc_server_call_method - resourceserver - stringxml - mixeduser_data - arrayoutput_options - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-server-create.xml b/reference/xmlrpc/functions/xmlrpc-server-create.xml deleted file mode 100644 index f700a69383..0000000000 --- a/reference/xmlrpc/functions/xmlrpc-server-create.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - - - - xmlrpc_server_create - Crea un servidor xmlrpc - - - &reftitle.description; - - resourcexmlrpc_server_create - - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-server-destroy.xml b/reference/xmlrpc/functions/xmlrpc-server-destroy.xml deleted file mode 100644 index 74d380aa58..0000000000 --- a/reference/xmlrpc/functions/xmlrpc-server-destroy.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - xmlrpc_server_destroy - Destruye los recursos del servidor - - - &reftitle.description; - - boolxmlrpc_server_destroy - resourceserver - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-server-register-introspection-callback.xml b/reference/xmlrpc/functions/xmlrpc-server-register-introspection-callback.xml deleted file mode 100644 index bcd11f1897..0000000000 --- a/reference/xmlrpc/functions/xmlrpc-server-register-introspection-callback.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - xmlrpc_server_register_introspection_callback - Registra una función PHP para generar la documentación - - - &reftitle.description; - - boolxmlrpc_server_register_introspection_callback - resourceserver - stringfunction - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-server-register-method.xml b/reference/xmlrpc/functions/xmlrpc-server-register-method.xml deleted file mode 100644 index 32cee47252..0000000000 --- a/reference/xmlrpc/functions/xmlrpc-server-register-method.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - xmlrpc_server_register_method - Registra una función PHP para que el recurso del método coincida con method_name - - - &reftitle.description; - - boolxmlrpc_server_register_method - resourceserver - stringmethod_name - stringfunction - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/xmlrpc/functions/xmlrpc-set-type.xml b/reference/xmlrpc/functions/xmlrpc-set-type.xml deleted file mode 100644 index 0c65ead9f0..0000000000 --- a/reference/xmlrpc/functions/xmlrpc-set-type.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - xmlrpc_set_type - Establece el tipo del xmlrpc, base64 o fecha-hora, para un valor de cadena PHP - - - &reftitle.description; - - boolxmlrpc_set_type - stringvalue - stringtype - - - Establece el tipo del xmlrpc, base64 o fecha-hora, para un valor de cadena PHP. - - &warn.experimental.func; - - - - &reftitle.parameters; - - - - value - - - Valor para establecer el tipo - - - - - type - - - 'base64' o 'datetime' - - - - - - - - - &reftitle.returnvalues; - - &return.success; - Si tiene éxito, value se convierte en un objeto. - - - - - &reftitle.errors; - - Emite un E_WARNING con un tipo no soportado por XMLRPC. - - - - - &reftitle.examples; - - - Ejemplo de <function>xmlrpc_set_type</function> - - - - -]]> - - &example.outputs.similar; - - - - - - 20090322T23:43:03 - - - -]]> - - - - - - - - diff --git a/reference/xmlrpc/reference.xml b/reference/xmlrpc/reference.xml deleted file mode 100644 index ae26bcc462..0000000000 --- a/reference/xmlrpc/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - &Functions; de XML-RPC - -&reference.xmlrpc.entities.functions; - - - - diff --git a/reference/xmlrpc/setup.xml b/reference/xmlrpc/setup.xml deleted file mode 100644 index 3d8f49ce24..0000000000 --- a/reference/xmlrpc/setup.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - &reftitle.setup; - - -
    - &reftitle.required; - &libxml.required; -
    - - - - &reference.xmlrpc.configure; - - - -
    - &reftitle.resources; - - Ésta extensión define un recurso de servicio de XML-RPC devuelto por - xmlrpc_server_create. - -
    - - -
    - - - diff --git a/reference/xpass/book.xml b/reference/xpass/book.xml deleted file mode 100644 index befba8661c..0000000000 --- a/reference/xpass/book.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - Xpass - Xpass - - - &reftitle.intro; - - Esta extensión proporciona algoritmos hash de contraseñas utilizados por las - distribuciones de Linux, utilizando la biblioteca extendida crypt. - - - También proporciona funciones libxcrypt adicionales que faltan en PHP. - - - - &reference.xpass.setup; - &reference.xpass.constants; - &reference.xpass.reference; - - - diff --git a/reference/xpass/constants.xml b/reference/xpass/constants.xml deleted file mode 100644 index da5adca42e..0000000000 --- a/reference/xpass/constants.xml +++ /dev/null @@ -1,338 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - La extensión Xpass proporciona diversos conjuntos de constantes. - Métodos de hash (CRYPT_PREFIX_*) para el - parámetro prefix de crypt_gensalt. - Códigos de error (CRYPT_SALT_*) devueltos por - crypt_checksalt. - Algoritmos de contraseña (PASSWORD_*) para el - parámetro algo de password_hash. - - - - Métodos de hash - - - CRYPT_PREFIX_STD_DES - (string) - - - - El método de hash original de Unix V7, basado en el cifrado por bloques DES. - Dado que DES es poco costoso en el hardware moderno, - solo hay 4096 salts posibles y 2**56 contraseñas distintas, - que se truncan a 8 caracteres, - es posible encontrar cualquier contraseña hasheada con este método. - No debería usarse excepto para soportar sistemas operativos antiguos - que no soportan ningún otro algoritmo de generación de hash, debido a la debilidad de los hashes DES. - - - - - - CRYPT_PREFIX_EXT_DES - (string) - - - - Una extensión del DES tradicional, que elimina el límite de longitud, - aumenta el tamaño del salt y hace el costo temporal ajustable. - Proviene de BSDI BSD/OS y también está disponible en al menos NetBSD, - OpenBSD y FreeBSD debido al uso de la biblioteca FreeSec de David Burren. - Es mucho mejor que los hashes DES tradicionales y bigcrypt, - pero aún no debería usarse para nuevos hashes. - - - - - - CRYPT_PREFIX_MD5 - (string) - - - - Un hash basado en el algoritmo MD5, desarrollado originalmente por Poul-Henning Kamp para FreeBSD. - Soportado en la mayoría de los Unix libres y versiones más recientes de Solaris. - No tan débil como los hashes basados en DES, - pero MD5 es tan poco costoso en el hardware moderno que no debería usarse para nuevos hashes. - El costo de procesamiento no es ajustable. - - - - - - CRYPT_PREFIX_BLOWFISH - (string) - - - - Un hash basado en el cifrado por bloques Blowfish, modificado para tener un calendario de claves extra-costoso. - Desarrollado originalmente por Niels Provos y David Mazieres para OpenBSD y también soportado en versiones recientes - de FreeBSD y NetBSD, en Solaris 10 y más reciente, y en varias distribuciones GNU/*/Linux. - - - - - - CRYPT_PREFIX_SHA256 - (string) - - - - Un hash basado en SHA-2 con una salida de 256 bits, desarrollado originalmente por Ulrich Drepper para GNU libc. - Soportado en Linux pero no común en otros lugares. - Aceptable para nuevos hashes. - El parámetro de costo de procesamiento por defecto es 5000, - lo cual es demasiado bajo para el hardware moderno. - - - - - - CRYPT_PREFIX_SHA512 - (string) - - - - Un hash basado en SHA-2 con una salida de 512 bits, desarrollado originalmente por Ulrich Drepper para GNU libc. - Soportado en Linux pero no común en otros lugares. - Aceptable para nuevos hashes. - El parámetro de costo de procesamiento por defecto es 5000, - lo cual es demasiado bajo para el hardware moderno. - - - - - - CRYPT_PREFIX_SCRYPT - (string) - - - - Scrypt es una función de derivación de clave basada en contraseña creada por Colin Percival, - originalmente para el servicio de respaldo en línea Tarsnap. - El algoritmo fue diseñado específicamente para hacer costosas las ataques de hardware - personalizados a gran escala al requerir grandes cantidades de memoria. - En 2016, el algoritmo scrypt fue publicado por el IETF como RFC 7914. - - - - - - CRYPT_PREFIX_GOST_YESCRYPT - (string) - - - - Gost-yescrypt usa la salida de yescrypt como mensaje de entrada para HMAC con - la función de hash GOST R 34.11-2012 (Streebog) con un resumen de 256 bits. - Así, las propiedades criptográficas de yescrypt son suplantadas por las de la función de hash GOST. - Este método de hash es útil en aplicaciones que requieren un hash de contraseña moderno, - pero deben basarse en algoritmos GOST. - La función de hash GOST R 34.11-2012 (Streebog) fue publicada por el IETF como RFC 6986. - Aceptable para nuevos hashes si es necesario. - - - - - - CRYPT_PREFIX_YESCRYPT - (string) - - - - Yescrypt es un esquema de hash de contraseña escalable diseñado por Solar Designer, - que se basa en el scrypt de Colin Percival. - Aunque la fuerza de yescrypt contra los ataques de adivinación de contraseñas proviene de su diseño de algoritmo, - su seguridad criptográfica está garantizada por su uso de SHA-256 en la capa externa. - La función de hash SHA-256 fue publicada por el NIST en el FIPS PUB 180-2 - (y sus revisiones posteriores como el FIPS PUB 180-4) y por el IETF como RFC 4634 - (y posteriormente RFC 6234). - Recomendado para nuevos hashes. - - - - - - CRYPT_PREFIX_SM3CRYPT - (string) - - - - Un hash basado en la función de hash ShangMi 3 con una salida de 256 bits, - que usa el mismo diseño que sha256crypt y/o sha512crypt. - Soportado en EulerOS, Kylin, openEuler y openKylin, pero no es común - en otros lugares. Aceptable para nuevos hashes si es necesario. El parámetro - de costo de procesamiento por defecto es 5000, lo cual es demasiado bajo para el hardware moderno. - - - Disponible a partir de 1.2.0 con libcxcrypt >= 4.5.0. - - - - - - CRYPT_PREFIX_SM3_YESCRYPT - (string) - - - - Sm3-yescrypt usa la salida de yescrypt como mensaje de entrada para HMAC - con la función de hash ShangMi 3 con un resumen de 256 bits. Así, las propiedades - criptográficas de yescrypt son suplantadas por las de la función de hash ShangMi 3. - Este método de hash es útil en aplicaciones que necesitan un hash de contraseña moderno, - pero deben basarse en algoritmos aprobados por la Oficina de Administración de - Criptografía Comercial del Estado de China (OSCCA). La función de hash ShangMi 3 - ha sido publicada en la Parte 3: "Dedicated hash-functions" de la ISO/IEC 10118-3:2018. - Aceptable para nuevos hashes si es necesario. - - - Disponible a partir de 1.2.0 con libcxcrypt >= 4.5.0. - - - - - - - Códigos de error - - - CRYPT_SALT_OK - (int) - - - - No hay error. - - - - - - CRYPT_SALT_INVALID - (int) - - - - Método de hash desconocido o parámetros inválidos. - - - - - - CRYPT_SALT_METHOD_DISABLED - (int) - - - - El método de hash ya no está permitido para ser usado. - - - - - - CRYPT_SALT_METHOD_LEGACY - (int) - - - - El método de hash ya no se considera lo suficientemente fuerte. - - - - - - CRYPT_SALT_TOO_CHEAP - (int) - - - - El costo de los parámetros se considera demasiado bajo. - - - - - - - Algoritmos de contraseña - - - PASSWORD_SHA512 - (string) - - - - PASSWORD_SHA512 se usa para crear nuevos hashes - de contraseña usando el algoritmo CRYPT_PREFIX_SHA512. - - - - - - PASSWORD_YESCRYPT - (string) - - - - PASSWORD_YESCRYPT se usa para crear nuevos hashes - de contraseña usando el algoritmo CRYPT_PREFIX_YESCRYPT. - - - - - - PASSWORD_SM3CRYPT - (string) - - - - PASSWORD_SM3CRYPT se usa para crear nuevos hashes - de contraseña usando el algoritmo CRYPT_PREFIX_SM3CRYPT. - - - Disponible a partir de 1.2.0 con libcxcrypt >= 4.5.0. - - - - - - PASSWORD_SM3_YESCRYPT - (string) - - - - PASSWORD_SM3_YESCRYPT se usa para crear nuevos hashes - de contraseña usando el algoritmo CRYPT_PREFIX_SM3_YESCRYPT. - - - Disponible a partir de 1.2.0 con libcxcrypt >= 4.5.0. - - - - - - diff --git a/reference/xpass/functions/crypt-checksalt.xml b/reference/xpass/functions/crypt-checksalt.xml deleted file mode 100644 index 5a7852841d..0000000000 --- a/reference/xpass/functions/crypt-checksalt.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - crypt_checksalt - Valida un parámetro de hash de contraseña - - - - &reftitle.description; - - stringnullcrypt_checksalt - stringsalt - - - Verifica si la cadena de sal cumple con la configuración del sistema y señala si - el método de hash y los parámetros que especifica son aceptables. Está destinado a ser utilizado - para determinar si la contraseña del usuario debe ser rehasheada utilizando el método de hash - actualmente preferido. - - - - - &reftitle.parameters; - - - salt - - - La cadena de sal a verificar. - - - - - - - - &reftitle.returnvalues; - - Devuelve una de las constantes - CRYPT_SALT_* - como int. - - - - - &reftitle.examples; - - Un ejemplo de <function>crypt_checksalt</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - crypt_gensalt - - - - - diff --git a/reference/xpass/functions/crypt-gensalt.xml b/reference/xpass/functions/crypt-gensalt.xml deleted file mode 100644 index 7a2bed7390..0000000000 --- a/reference/xpass/functions/crypt-gensalt.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - crypt_gensalt - Compila una cadena para usar como argumento de sal para crypt - - - - &reftitle.description; - - stringnullcrypt_gensalt - stringprefix&null; - intcount0 - - - Compila una cadena para usar como argumento de sal para crypt. - - - - - &reftitle.parameters; - - - prefix - - - El método de hash a usar. - Una de las constantes CRYPT_PREFIX_*. - Si es &null;, se seleccionará el mejor método de hash disponible. - - - - - count - - - Controla el costo de procesamiento del hash; - el rango válido y el significado exacto de count dependen del método de hash, - pero números más grandes corresponden a hashes más costosos en - términos de tiempo de CPU y posiblemente de uso de memoria. - Si count es 0, se seleccionará un costo bajo por defecto. - - - - - - - - &reftitle.returnvalues; - - Devuelve una cadena con el parámetro, o &null; en caso de error. - - - - - &reftitle.examples; - - Un ejemplo de <function>crypt_gensalt</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - crypt_preferred_method - crypt - hash_equals - - - - - diff --git a/reference/xpass/functions/crypt-preferred-method.xml b/reference/xpass/functions/crypt-preferred-method.xml deleted file mode 100644 index a642a56439..0000000000 --- a/reference/xpass/functions/crypt-preferred-method.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - crypt_preferred_method - Devuelve el prefijo del método de hash preferido - - - - &reftitle.description; - - stringnullcrypt_preferred_method - - - - Devuelve el prefijo del método de hash preferido. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve una cadena con el prefijo, o &null; en caso de error. - - - - - &reftitle.examples; - - Un ejemplo de <function>crypt_preferred_method</function> - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - crypt_gensalt - - - - - diff --git a/reference/xpass/reference.xml b/reference/xpass/reference.xml deleted file mode 100644 index 29aa68577a..0000000000 --- a/reference/xpass/reference.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - &Functions; Xpass - - &reference.xpass.entities.functions; - - - diff --git a/reference/xpass/setup.xml b/reference/xpass/setup.xml deleted file mode 100644 index d9542a7154..0000000000 --- a/reference/xpass/setup.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Esta extensión requiere - libxcrypt - versión 4.4 o superior. - -
    - -
    - Instalación vía PECL - - &pecl.info; - &url.pecl.package;xpass. - -
    - -
    - diff --git a/reference/yac/book.xml b/reference/yac/book.xml deleted file mode 100644 index 7c10d7d476..0000000000 --- a/reference/yac/book.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Yac - Yac - - - &reftitle.intro; - - Yac (Yet Another Cache) es una caché de datos de usuario en memoria - compartida y sin bloqueos, que puede utilizarse para reemplazar a APC - o a un memcached local. - - - Yac almacena los datos en memoria compartida, lo que los hace visibles - para todos los procesos de trabajo de PHP de la misma máquina sin - ninguna comunicación entre procesos. En lugar de bloqueos, Yac se basa - en actualizaciones atómicas de las ranuras junto con unos pocos sondeos - de colisión, de modo que un fallo de caché nunca bloquea una petición y - una escritura concurrente puede provocar, en el peor de los casos, un - almacenamiento fallido o una lectura perdida que quien la invoca puede - simplemente reintentar. - - - Al no haber bloqueos ni comunicación entre procesos en la ruta de - acceso, una lectura es esencialmente una búsqueda hash en memoria - compartida. Como resultado, Yac es extremadamente rápida, con una - latencia de lectura del orden de microsegundos, y su rendimiento puede - escalar con el número de procesos de trabajo mientras las escrituras se - repartan entre distintas claves; véanse los - tests de rendimiento. - - - Dado que Yac sacrifica garantías de corrección a cambio de velocidad y - rendimiento, resulta más adecuada para datos que son costosos de - producir pero fáciles de recrear: fragmentos de página, instantáneas de - configuración, respuestas pequeñas de servicios y otras cachés locales. - No debería utilizarse como almacén de referencia para datos - irremplazables. - - - A partir de yac 2.4.0, los valores escalares pequeños — - NULL, booleanos, la mayoría de los enteros (los que - caben en 60 bits con signo en compilaciones de 64 bits), cadenas de hasta - 7 bytes y arrays vacíos — se almacenan directamente dentro de la ranura - hash en lugar de en un bloque de valor separado («valores - incrustados»), lo que elimina la reserva de memoria del valor y la - copia del bloque en cada acceso, mejorando significativamente el - rendimiento al tiempo que reduce el uso de memoria. La versión 2.4.0 - también cambió el motor de compresión de FastLZ a LZ4, haciendo que las - lecturas comprimidas sean varias veces más rápidas. - - - - La memoria compartida solo es visible dentro de una misma máquina. - Para compartir una caché entre varios servidores, se debe utilizar en - su lugar una caché en red como Memcached o Redis. - - - - - &reference.yac.setup; - &reference.yac.memory; - &reference.yac.constants; - - &reference.yac.yac; - - - - diff --git a/reference/yac/constants.xml b/reference/yac/constants.xml deleted file mode 100644 index b775232c9d..0000000000 --- a/reference/yac/constants.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - - &reftitle.constants; - &extension.constants; - - - - - YAC_VERSION - (string) - - - - La versión de la extensión como cadena. - - - - - - YAC_MAX_KEY_LEN - (int) - - - - Longitud máxima de una clave en bytes: 48. El prefijo de una instancia - cuenta para este límite. - - - - - - YAC_MAX_VALUE_RAW_LEN - (int) - - - - Longitud máxima de un valor antes de la serialización, en bytes: - 67 108 863 ((1 << 26) - 1). Los valores - mayores son rechazados. - - - - - - YAC_MAX_RAW_COMPRESSED_LEN - (int) - - - - Tamaño máximo de una entrada almacenada, en bytes: 1 048 576 (1M). Los - valores que no caben ni siquiera después de comprimirse son rechazados. - - - - - - YAC_SERIALIZER_PHP - (int) - - - - Utiliza el formato serialize de PHP como serializador (el valor - predeterminado). - - - - - - YAC_SERIALIZER_JSON - (int) - - - - Utiliza JSON como serializador. Requiere que la extensión se compile con - . - - - - - - YAC_SERIALIZER_IGBINARY - (int) - - - - Utiliza igbinary como serializador. Requiere que la extensión se compile - con . - - - - - - YAC_SERIALIZER_MSGPACK - (int) - - - - Utiliza msgpack como serializador. Requiere que la extensión se compile - con . - - - - - - YAC_SERIALIZER - (string) - - - - El serializador utilizado actualmente por la extensión. - - - - - - - - diff --git a/reference/yac/ini.xml b/reference/yac/ini.xml deleted file mode 100644 index 18d0481ebc..0000000000 --- a/reference/yac/ini.xml +++ /dev/null @@ -1,213 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - - Yac &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - yac.compress_threshold - 4K - INI_SYSTEM - - - - yac.debug - 0 - INI_ALL - - - - yac.enable - 1 - INI_SYSTEM - - - - yac.enable_cli - 0 - INI_SYSTEM - - - - yac.keys_memory_size - 8M - INI_SYSTEM - - - - yac.serializer - php - INI_SYSTEM - - - - yac.values_memory_size - 64M - INI_SYSTEM - - - - -
    -
    - - &ini.descriptions.title; - - - - - - yac.compress_threshold - int - - - - Los valores serializados que superan este número de bytes se - comprimen (con LZ4, desde Yac 2.4.0) antes de almacenarse. - Los valores que superan el límite de 1M por entrada - almacenada (YAC_MAX_RAW_COMPRESSED_LEN) se - comprimen siempre, sea cual sea esta directiva, porque no pueden - almacenarse sin comprimir. El valor predeterminado de - 4K activa la compresión; -1 la - desactiva para los valores por debajo del límite por entrada - almacenada, y los demás valores positivos se ajustan al rango - 1024..1M. - Comprimir valores grandes ahorra memoria compartida a costa de algo de - CPU tanto al almacenar como al recuperar. - - - - - - yac.debug - int - - - - Reservada para depuración. A partir de Yac 2.4.0 esta directiva - está registrada pero no tiene ningún efecto. - - - - - - yac.enable - int - - - - Indica si Yac está activado. Si está desactivado, crear una - instancia de Yac lanza una excepción. - - - - - - yac.enable_cli - int - - - - Indica si Yac está activado al ejecutarse bajo la SAPI - CLI. Está desactivado de forma predeterminada - porque los scripts de línea de comandos suelen iniciarse y - detenerse de inmediato, y el segmento de memoria compartida se - crearía en vano. - - - - - - yac.keys_memory_size - string - - - - Cantidad de memoria compartida para la tabla de claves. Limita cuántas - entradas pueden existir a la vez: el valor predeterminado de - 8M permite unas 65 536 entradas. Conviene aumentarlo - cuando la tasa de aciertos baja y kicks sube; véase - para saber cómo se comporta una - tabla llena y cuándo eso importa realmente. - - - - - - yac.values_memory_size - string - - - - Cantidad de memoria compartida para almacenar los valores. Los valores - se reservan mediante un asignador lineal sobre segmentos de 4M cada uno; - cuando ningún segmento tiene sitio para un valor nuevo, el cursor del - asignador vuelve al principio y los valores más antiguos se sobrescriben - silenciosamente («reciclados»). Sus lecturas pasan entonces a ser - fallos de caché, detectados por un control de integridad. Conviene - ampliarlo si recycles sube mientras las ranuras - todavía tienen sitio, o activar - yac.compress_threshold - para reducir las cargas útiles grandes. Véase - . - - - - - - yac.serializer - string - - - - Serializador utilizado para convertir valores PHP arbitrarios en - bytes antes de almacenarlos. Los valores permitidos son - php (el predeterminado), - json, igbinary y - msgpack. Los tres últimos requieren que la - extensión se haya compilado con el soporte correspondiente. Los - serializadores binarios, como igbinary y - msgpack, suelen ser más rápidos y producen - datos más pequeños que php. - - - - - - - -
    - - diff --git a/reference/yac/memory.xml b/reference/yac/memory.xml deleted file mode 100644 index 953d90f692..0000000000 --- a/reference/yac/memory.xml +++ /dev/null @@ -1,256 +0,0 @@ - - - - - - Gestión de la memoria - - - Yac guarda sus datos en dos reservas de memoria compartida independientes, - configuradas con - yac.keys_memory_size - y - yac.values_memory_size. - Se llenan y se liberan de maneras distintas, por lo que conviene saber a qué - reserva pertenece un síntoma antes de tocar cualquiera de los dos ajustes. - - -
    - Qué contiene cada reserva - - Las dos reservas almacenan mitades distintas de una entrada. La reserva de - claves contiene las claves: una ranura por clave en caché, que lleva la - propia clave (hasta 48 bytes) junto con su hash, su TTL, su número de - aciertos y su fecha de último acceso; el valor solo se referencia mediante - un puntero a la reserva de valores. La reserva de valores contiene los - valores: cada valor almacenado ocupa un bloque de bytes serializados, en su - forma comprimida cuando la entrada ha pasado por - yac.compress_threshold. - - - La única excepción son los valores incrustados: los escalares pequeños - (&null;, &true;, &false;, la mayoría de los enteros —los que caben en - 60 bits con signo en compilaciones de 64 bits—, las cadenas de hasta - 7 bytes y los arrays vacíos) se almacenan directamente dentro de la ranura, - en el puntero que de otro modo referenciaría un bloque. Esos valores no - ocupan espacio alguno en la reserva de valores; solo lo hace su clave. - - - Como guía aproximada de dimensionamiento: - - - - la reserva de claves contiene unas 8 000 claves por MB, así que hay que - dimensionar - yac.keys_memory_size - como el número de claves distintas dividido entre 8 000 por MB, - redondeando al entero superior: el valor predeterminado de - 8M contiene unas 64 000 claves; - - - - - la reserva de valores debe contener todos los valores que todavía puedan - leerse, así que hay que dimensionar - yac.values_memory_size - como el número de valores vivos multiplicado por su tamaño serializado - medio (después de la compresión), y prever aproximadamente el doble: la - reserva es un anillo, y un valor no muere hasta que el cursor del - asignador vuelve a pasar por encima de él. - - - - Los valores incrustados ocupan una ranura como cualquier otra entrada, pero - no consumen espacio en la reserva de valores, así que hay que dejarlos - fuera del segundo cálculo. - -
    - -
    - La reserva de claves (ranuras) - - yac.keys_memory_size - contiene una tabla de ranuras de tamaño fijo: el valor predeterminado de - 8M proporciona unas 65 536 ranuras. Cada clave - almacenada ocupa exactamente una ranura, de modo que esta reserva limita el - número de entradas que pueden existir a la vez; a diferencia de la reserva - de valores, las ranuras nunca se liberan individualmente. Una ranura - caducada —más allá de su TTL, o el marcador de borrado que deja - Yac::delete— se recicla sin coste cuando una clave - nueva la necesita. Solo cuando las cuatro ranuras candidatas de un camino - de sondeo contienen entradas vivas se expulsa una de ellas para hacer - sitio: un kick (el contador - kicks de Yac::info). - - - La expulsión elige únicamente entre las cuatro candidatas vivas del camino - de sondeo en colisión: - - - - se expulsa la usada menos recientemente (el atime más - antiguo); - - - - - en caso de empate, la entrada con menos aciertos y, después, la primera - posición de sondeo. - - - - - - Un punto de confusión frecuente: que slots_used alcance - slots_size no es una condición de - error. Una caché cuyo conjunto de trabajo de claves sea mayor que la tabla - de ranuras simplemente funciona al 100 % de ocupación a partir de ese - momento, expulsando y reinsertando según haga falta. Lo único que indica si - la reserva de claves está bien dimensionada es la tasa de aciertos - (hits / (hits + miss), calculada sobre las diferencias - entre dos instantáneas de Yac::info y no sobre la - media desde el arranque). Un contador kicks alto no - significa por sí mismo que haya un problema: sencillamente la distribución - de las claves no es uniforme y algunos caminos de sondeo colisionan más que - otros. Solo cuando la tasa de aciertos y - kicks son ambos malos la tabla es demasiado pequeña para - el conjunto de claves, y el remedio es un - yac.keys_memory_size mayor. - - - Una segunda consecuencia de que las ranuras nunca se liberen: las entradas - sin TTL (ttl = 0) que ya no vuelven a leerse siguen - ocupando una ranura hasta que una expulsión da la casualidad de elegirlas. - Si una aplicación almacena grandes cantidades de datos de un solo uso, - conviene darles un TTL para que caduquen y puedan reciclarse sin desplazar - entradas vivas, o dimensionar la reserva de claves para el conjunto - completo de claves. - -
    - -
    - La reserva de valores (segmentos) - - yac.values_memory_size - se divide en segmentos de 4M cada uno, gestionados como anillos: las - escrituras hacen avanzar un cursor por segmento y el espacio nunca se - libera por entrada. Cuando una asignación ya no cabe, el cursor vuelve al - principio de un segmento: un recycle (el contador - recycles de Yac::info). Un - reciclado no invalida el segmento de inmediato: los valores sobrescritos - siguen siendo legibles hasta que el cursor que ha dado la vuelta los - sobrescribe realmente, momento en el que sus lecturas no superan el control - de integridad y se convierten en fallos de caché. - - - Para esta reserva importan dos tamaños: el total de - yac.values_memory_size - debe contener el conjunto de trabajo de los valores vivos, y una única - entrada puede ocupar como mucho 1 MB una vez almacenada - (YAC_MAX_RAW_COMPRESSED_LEN). Por eso los valores - mayores se comprimen siempre antes de almacenarse; un valor que no puede - reducirse por debajo de 1 MB —lo más habitual, porque son datos - aleatorios— es rechazado e incrementa el contador - fails. El límite absoluto sobre el valor en sí es mucho - más alto: los valores serializados por encima de 64 MB - (YAC_MAX_VALUE_RAW_LEN, es decir - (1 << 26) - 1 bytes) se rechazan de plano. - -
    - -
    - Dimensionamiento y qué vigilar - - Conviene empezar con los valores predeterminados y vigilar los contadores de - Yac::info: se acumulan desde - start_time, así que hay que comparar dos instantáneas - tomadas con cierta separación en el tiempo: - - - - - tasa de aciertos saludable (por ejemplo >= 90 %): la caché está bien; - no hay nada que hacer, sea lo que sea que muestren los demás contadores; - - - - - tasa de aciertos baja y kicks en aumento: la reserva de - claves es demasiado pequeña para el conjunto de claves, las entradas vivas - se expulsan antes de volver a leerse. Hay que aumentar - yac.keys_memory_size; - - - - - recycles frecuentes: esto sí es un problema real, no un - contador inofensivo. Un reciclado significa que el asignador de valores ha - dado la vuelta y está a punto de sobrescribir entradas: todo lo - sobrescrito muere antes de poder volver a leerse, de modo que los bytes - gastados en almacenarlo se han desperdiciado y la tasa de aciertos se - resiente. La reserva de valores es demasiado pequeña para el volumen de - datos vivos. Por orden de impacto: - - - - hay que dar un TTL a las entradas. Los valores escritos con - ttl = 0 siguen vivos para siempre, de modo que - ocupan la reserva y obligan al cursor a dar la vuelta antes. Un TTL - limita cuánto puede vivir cada entrada y reduce el conjunto de trabajo - vivo que la reserva debe contener; - - - - - hay que aumentar - yac.values_memory_size - para que la reserva contenga todo el conjunto de valores vivos (hay que - recordar prever aproximadamente el doble de la huella viva: un valor no - muere hasta que el cursor vuelve a pasar por encima de él); - - - - - hay que almacenar menos por entrada y bajar - yac.compress_threshold - si está por encima del mínimo de 1024, para que las - cargas útiles grandes se compriman, y recortar los valores que no - necesitan almacenarse por completo; - - - - - - - - fails en aumento: valores que no han podido - almacenarse, casi siempre un único valor mayor que el límite de 1 MB de - tamaño almacenado incluso después de comprimirlo; hay que dividir el - valor. - - - -
    - -
    - - diff --git a/reference/yac/setup.xml b/reference/yac/setup.xml deleted file mode 100644 index d82d2c5d19..0000000000 --- a/reference/yac/setup.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - No se requiere ninguna biblioteca externa. - -
    - - -
    - &reftitle.install; - - Yac se puede instalar de tres maneras: mediante PECL, mediante PIE o - compilándolo a partir del código fuente. - - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;yac. - - - &pecl.windows.download.avail; - - - Instalación de Yac con PECL - - - - - - A partir de Yac 2.3.2, la extensión se puede instalar con - &link.pie;, el instalador de extensiones de PHP, ejecutando lo - siguiente en la línea de comandos. - - - Instalación de Yac con PIE - - - - - - Los serializadores opcionales se pueden activar en el momento de la instalación: - - - Instalación de Yac con PIE y un serializador - - - - - - El código fuente está alojado en - GitHub. Para - compilar la extensión a partir del código fuente, se debe ejecutar lo - siguiente en la línea de comandos, sustituyendo las rutas por las de la - instalación local de PHP. - - - Compilación de Yac a partir del código fuente - - - - - - Están disponibles las siguientes opciones de configure: - - - Los valores se comprimen con LZ4 antes de ser almacenados. El motor de - compresión LZ4 se introdujo en Yac 2.4.0, en sustitución del anterior - FastLZ. De forma predeterminada, Yac utiliza la copia de LZ4 incluida con la - extensión; no se necesita ningún indicador adicional. Para enlazar en su lugar - con la biblioteca LZ4 del sistema, se utiliza la opción - , que - requiere que estén instalados la cabecera lz4.h y - liblz4. - - - Se pueden compilar serializadores alternativos con - , - o - , que registran la - extensión correspondiente como una dependencia opcional. El serializador - utilizado en tiempo de ejecución se selecciona con la directiva ini - yac.serializer. - -
    - - - - &reference.yac.ini; - - -
    - &reftitle.resources; - - Esta extensión no define ningún tipo de recurso. - -
    - -
    - - diff --git a/reference/yac/yac.xml b/reference/yac/yac.xml deleted file mode 100644 index 802246d894..0000000000 --- a/reference/yac/yac.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - La clase Yac - Yac - - - - -
    - &reftitle.intro; - - La clase Yac es la interfaz para el caché. - Cada instancia en el mismo host es un identificador ligero hacia un - caché compartido: todas las instancias leen y escriben las mismas entradas, - y crear una no supone ninguna asignación más allá del propio identificador. - - - El prefijo opcional pasado a - Yac::__construct se antepone a cada - clave, de modo que varias instancias (o aplicaciones) pueden compartir un - mismo caché sin que sus claves colisionen. Además de las operaciones - clásicas de caché - (Yac::add, - Yac::set, - Yac::get, - Yac::delete y - Yac::flush), la clase proporciona - Yac::info y - Yac::dump para inspeccionar el caché, y - sobrecarga el acceso a propiedades para que leer o escribir una propiedad - de objeto lea o escriba una entrada del caché. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yac - - - - - Yac - - - - &Properties; - - protected - _prefix - - - - &Methods; - - - - - -
    - - - -
    - &reftitle.properties; - - - _prefix - - - El prefijo de clave definido mediante - Yac::__construct. Se antepone a - cada clave usada con la instancia; no se inserta ningún separador, - así que inclúyalo en el prefijo cuando sea necesario. El prefijo no - puede superar YAC_MAX_KEY_LEN (48) bytes. - - - - -
    - - - -
    - - &reference.yac.entities.yac; - -
    - - diff --git a/reference/yac/yac/add.xml b/reference/yac/yac/add.xml deleted file mode 100644 index 3ae8c60b0e..0000000000 --- a/reference/yac/yac/add.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - - Yac::add - Almacena un valor sin sobrescribir uno existente - - - - &reftitle.description; - - public boolYac::add - stringarraykey - mixedvalue - intttl0 - - - public boolYac::add - arrayvalues - intttl0 - - - Almacena un valor en la caché. A diferencia de Yac::set, - no sobrescribe una entrada existente que siga siendo válida; en ese caso el - almacenamiento es rechazado. - - - - - &reftitle.parameters; - - - key - - - Una clave de tipo string, o un array de pares - clave => valor que se almacenan en una sola llamada. - - - - - value - - - El valor a almacenar. Puede almacenarse cualquier tipo de PHP excepto - resource. Solo se utiliza en la forma de clave única; cuando - key es un array, este argumento es en su lugar el - parámetro opcional ttl. - - - - - ttl - - - Tiempo de vida en segundos. 0 significa que la entrada - nunca expira por tiempo. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; en caso de éxito, &false; en caso de fallo. El almacenamiento - también es rechazado (devolviendo &false;) cuando la clave ya existe y no ha - expirado. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yac::add</methodname> - -add("foo", "bar")); // bool(true) -var_dump($yac->add("foo", "baz")); // bool(false): "foo" ya existe -?> -]]> - - - - Añadir una entrada con un TTL - -add("short-lived", "value", 5); -sleep(6); -var_dump($yac->get("short-lived")); // bool(false): expirado -?> -]]> - - - - Añadir varias entradas en una sola llamada - - valor en una sola llamada, con un ttl -$yac->add(array("a" => 1, "b" => 2), 60); -?> -]]> - - - - - - &reftitle.seealso; - - - Yac::set - Yac::get - Yac::delete - - - - - - - diff --git a/reference/yac/yac/construct.xml b/reference/yac/yac/construct.xml deleted file mode 100644 index fee8d80a42..0000000000 --- a/reference/yac/yac/construct.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - Yac::__construct - Constructor - - - - &reftitle.description; - - public Yac::__construct - stringprefix"" - - - Crea una nueva instancia de Yac. El - prefix opcional se antepone a cada clave que almacena - esta instancia, lo que permite que varias aplicaciones o cachés en la misma - máquina utilicen nombres de clave coincidentes sin que colisionen. - - - - - &reftitle.parameters; - - - prefix - - - Un prefijo de clave, de hasta 48 bytes (YAC_MAX_KEY_LEN). - - - - - - - - &reftitle.errors; - - Lanza una Exception si la caché está - deshabilitada (yac.enable=0), o si - prefix supera los 48 bytes de longitud. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yac::__construct</methodname> - -set("foo", "bar"); - -$other = new Yac("app2_"); -var_dump($other->get("foo")); // bool(false): espacio de nombres diferente -$other->set("foo", "baz"); // almacenado como "app2_foo" -?> -]]> - - - - - - &reftitle.seealso; - - - Yac::set - Yac::get - - - - - - - diff --git a/reference/yac/yac/delete.xml b/reference/yac/yac/delete.xml deleted file mode 100644 index ff7b6521d2..0000000000 --- a/reference/yac/yac/delete.xml +++ /dev/null @@ -1,166 +0,0 @@ - - - - - - Yac::delete - Elimina elementos de la caché - - - - &reftitle.description; - - public boolYac::delete - stringarraykey - intdelay0 - - - Elimina uno o varios elementos de la caché. - - - - La eliminación se implementa marcando la entrada como caducada en lugar - de liberar su ranura: la entrada deja de poder leerse de inmediato, pero - la ranura permanece ocupada hasta que se almacena de nuevo la misma clave - o hasta que una escritura posterior recupera dicha ranura. Como - consecuencia, el número de ranuras usadas que informa - Yac::info no disminuye tras una eliminación, y - Yac::dump sigue mostrando la entrada eliminada - hasta que su ranura se recicla; un valor ttl distinto - de cero situado en el pasado indica una entrada eliminada o caducada, por - lo que, al examinar la salida de Yac::dump, tales - entradas deben ser filtradas por el llamador. - - - - - - &reftitle.parameters; - - - key - - - Una clave de tipo string, o un array de claves - que serán eliminadas. - - - - - delay - - - Número de segundos antes de que el elemento deje de ser válido. Si se - omite o vale 0, el elemento se invalida de inmediato. - Un valor positivo mantiene el elemento legible durante ese número de - segundos antes de que caduque. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; en caso de éxito, o &false; si la clave no estaba presente - en la caché. Dado que una eliminación solo marca la entrada como caducada, - una clave que ha sido eliminada pero aún no sobrescrita se sigue - considerando presente: eliminar de nuevo la misma clave devuelve &true;. - - - Cuando se proporciona un array de claves, se devuelve &true; - únicamente si todas las claves estaban presentes; si falta alguna clave, se - devuelve &false;. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yac::delete</methodname> - -set("foo", "bar"); - -var_dump($yac->delete("foo")); // bool(true): marcada como caducada -var_dump($yac->get("foo")); // bool(false): a partir de ahora, un fallo -var_dump($yac->delete("foo")); // bool(true) de nuevo: la ranura aún no - // ha sido sobrescrita -var_dump($yac->delete("never")); // bool(false): nunca fue almacenada - -// una eliminación no libera la ranura: slots_used no disminuye, y -// la entrada caducada sigue apareciendo en el volcado -var_dump($yac->info()["slots_used"]); // int(1) -print_r($yac->dump()); // "foo" sigue apareciendo; su ttl - // está en el pasado -?> -]]> - - - - Eliminación retardada - -set("tmp", "value"); -var_dump($yac->delete("tmp", 60)); // bool(true) -?> -]]> - - - - Eliminar varias claves en una sola llamada - -set("tmp", "value"); - -// devuelve true solo cuando todas las claves estaban presentes -var_dump($yac->delete(array("tmp", "nope"))); // bool(false): falta "nope" -?> -]]> - - - - - - &reftitle.seealso; - - - Yac::set - Yac::flush - Yac::info - Yac::dump - - - - - - - diff --git a/reference/yac/yac/dump.xml b/reference/yac/yac/dump.xml deleted file mode 100644 index b7024c5ab4..0000000000 --- a/reference/yac/yac/dump.xml +++ /dev/null @@ -1,301 +0,0 @@ - - - - - - Yac::dump - Vuelca las entradas de la caché para su inspección - - - - &reftitle.description; - - public arrayYac::dump - intlimit100 - intoffset0 - - - Vuelca los metadatos de las entradas almacenadas actualmente en la caché. - Los valores en sí no son devueltos. - - - - - &reftitle.parameters; - - - limit - - - Número máximo de entradas a devolver. - - - Pasar -1 como limit vuelca - todas las entradas que la caché contiene en ese momento. Es de tener en - cuenta que construir la lista completa puede consumir una cantidad - considerable de memoria en una caché grande; cuando la memoria importa, - es preferible recorrer las entradas por páginas con - limit y offset. - - - - - offset - - - Número de entradas a omitir antes de empezar a recopilar. Este parámetro - está disponible a partir de PECL yac 2.4.0; las versiones anteriores - siempre comienzan por la primera entrada. Combinado con - limit, permite recorrer por páginas una caché que - contiene más entradas de las que una sola llamada puede devolver. - - - - - - - - &reftitle.returnvalues; - - Un array con un elemento por cada entrada volcada. Cada - elemento es a su vez un array que describe la entrada: - - - - index - - El índice de la ranura de la entrada en la tabla hash. - - - - hash - - El hash de 64 bits de la clave, utilizado para el sondeo de ranuras. - - - - crc - - La suma de comprobación CRC32 del valor almacenado, utilizada para - detectar lecturas inconsistentes. 0 para las entradas - empotradas, que no tienen bloque de valor. - - - - ttl - - La marca de tiempo de expiración (tiempo Unix). 0 - significa que la entrada nunca expira por tiempo. Es de tener en cuenta - que Yac::delete solamente marca una entrada como - expirada, por lo que las entradas eliminadas pueden seguir apareciendo en - el volcado; un ttl distinto de cero situado en el - pasado indica una entrada expirada o eliminada. - - - - k_len - - La longitud de la clave, en bytes. - - - - v_len - - La longitud del valor, en bytes. Para las entradas comprimidas se trata de - la longitud del valor original antes de la compresión - (a partir de yac 2.4.0; las versiones anteriores informaban de la longitud - almacenada, ya comprimida). - - - - c_len - - Presente únicamente para las entradas comprimidas (a partir de yac 2.4.0): - la longitud de la carga útil comprimida realmente almacenada en la memoria - compartida, en bytes. Comparar c_len con - v_len muestra cuánto ahorra la compresión en cada - entrada. - - - - size - - El tamaño asignado al bloque de valor en la memoria compartida, en bytes. - 0 para las entradas empotradas. - - - - atime - - La hora del último acceso (tiempo Unix), actualizada en cada - Yac::get con éxito. Cuando la caché está llena, la - entrada con el atime más antiguo de entre las ranuras - candidatas es la primera en ser desalojada (a partir de yac 2.4.0). - - - - hits - - Un contador de aciertos por entrada, incrementado en cada - Yac::get con éxito y reiniciado cuando la entrada - es sobrescrita por un nuevo Yac::set o - Yac::add (a partir de yac 2.4.0). - - - - embedded - - Indica si el valor se almacena directamente dentro de la ranura en lugar de - en un bloque de valor separado (a partir de yac 2.4.0). Los valores - pequeños — NULL, booleanos, enteros pequeños, cadenas - de hasta 7 bytes y arrays vacíos — se incrustan de esta forma y no reservan - memoria de valor alguna; para ellos crc y - size se indican como 0. - - - - key - - La clave de la caché, sin ningún prefijo de instancia. - - - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yac::dump</methodname> - -set("foo", "bar"); -$yac->set("baz", "qux"); - -print_r($yac->dump()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [index] => 12345 - [hash] => 14463105906481965911 - [crc] => 0 - [ttl] => 0 - [k_len] => 3 - [v_len] => 3 - [size] => 0 - [atime] => 1725955200 - [hits] => 0 - [embedded] => 1 - [key] => foo - ) - - [1] => Array - ( - [index] => 12987 - [hash] => 15132029420525657053 - [crc] => 0 - [ttl] => 0 - [k_len] => 3 - [v_len] => 3 - [size] => 0 - [atime] => 1725955200 - [hits] => 0 - [embedded] => 1 - [key] => baz - ) - -) -]]> - - - Las entradas se listan en el orden de las ranuras, no en el orden en que - fueron almacenadas. Las entradas empotradas (escalares cortos conservados - dentro de la propia ranura) tienen crc y - size a cero; las entradas almacenadas en un bloque de - valor separado llevan su suma de comprobación y el tamaño del bloque, y las - entradas comprimidas llevan además c_len. - - - - Recorrido por páginas de una caché grande - - limit limita cuántas entradas devuelve una sola - llamada, y offset omite esa cantidad de entradas - antes de empezar a recopilar, de modo que ambos pueden combinarse para - recorrer por páginas una caché que contiene más entradas de las que una sola - llamada puede devolver. - - -set("key$i", $i); -} - -$page_size = 100; -$page_num = 2; - -// omite las 100 primeras entradas y devuelve las 100 siguientes (página 2) -$page = $yac->dump($page_size, $page_size * ($page_num - 1)); - -var_dump(count($page)); -?> -]]> - - &example.outputs.similar; - - - - - Se devuelven menos entradas de las solicitadas cuando la caché contiene - menos entradas de las que abarca la página pedida, y se devuelve un array - vacío en cuanto el desplazamiento apunta más allá de la última ranura - ocupada. - - - - - - &reftitle.seealso; - - - Yac::info - - - - - - - diff --git a/reference/yac/yac/flush.xml b/reference/yac/yac/flush.xml deleted file mode 100644 index 9f5f917e03..0000000000 --- a/reference/yac/yac/flush.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Yac::flush - Vacía la caché - - - - &reftitle.description; - - public boolYac::flush - - - - Elimina todos los valores almacenados en caché. Dado que la caché es - compartida por todos los procesos de la misma máquina, esto vacía la - caché de forma global; el prefijo de clave proporcionado a - Yac::__construct no limita lo que se elimina. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true;. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yac::flush</methodname> - -set("foo", "bar"); - -$other = new Yac("app2_"); -$other->set("baz", "qux"); - -// flush vacía la caché completa: las entradas de todas las instancias, -// independientemente del prefijo utilizado al almacenarlas -$yac->flush(); - -var_dump($yac->get("foo")); // bool(false) -var_dump($other->get("baz")); // bool(false) -?> -]]> - - - - - - &reftitle.seealso; - - - Yac::delete - Yac::info - - - - - - - diff --git a/reference/yac/yac/get.xml b/reference/yac/yac/get.xml deleted file mode 100644 index e9dd1536c0..0000000000 --- a/reference/yac/yac/get.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - Yac::get - Recupera valores de la caché - - - - &reftitle.description; - - public mixedYac::get - stringarraykey - mixeddefault&null; - - - Recupera valores de la caché - - - - - &reftitle.parameters; - - - key - - - Una clave de tipo string, o un array de claves. - - - - - default - - - El valor que se devuelve cuando la clave (o las claves) solicitada no - está presente en la caché, disponible a partir de yac 2.4.0. Si se - omite, un fallo de caché devuelve &false;. - - - - Antes de yac 2.4.0, esta posición de argumento contenía un token - $cas por referencia en lugar de un valor por - defecto. El código que pasaba ese token o dependía de él debe - actualizarse al migrar a la versión 2.4.0. - - - - - - - - - &reftitle.returnvalues; - - Para una clave de tipo string, devuelve el valor almacenado en - caché si se encuentra, y en caso contrario el valor de - default (o &false; si no se indicó ningún valor por - defecto). - - - Para un array de claves, devuelve un array que contiene los - valores encontrados indexados por sus claves. Las claves que no están - presentes en la caché se omiten del resultado a partir de yac 2.4.0, o se - rellenan con el valor de default si se indicó uno; - antes de la versión 2.4.0, se insertaba un marcador &false; por cada clave - ausente. - - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yac::get</methodname> - -set("foo", "bar"); -var_dump($yac->get("foo")); // string(3) "bar" -var_dump($yac->get("missing")); // bool(false): un fallo de caché -?> -]]> - - - - Distinguir un false almacenado de un fallo de caché - -set("flag", false); -var_dump($yac->get("flag")); // bool(false): el valor almacenado -var_dump($yac->get("missing", false)); // bool(false): un fallo de caché, misma forma -var_dump($yac->get("flag", "__NONE__")); // bool(false): el valor almacenado -var_dump($yac->get("missing", "__NONE__")); // string(8) "__NONE__": un fallo de caché -?> -]]> - - - - Recuperar varias claves en una sola llamada - -set("foo", "bar"); -$yac->set("foo2", "bar2"); - -// con un array de claves, solo las claves encontradas están presentes en el resultado -var_dump($yac->get(array("foo", "foo2", "missing"))); -// array(2) { ["foo"]=> string(3) "bar" ["foo2"]=> string(4) "bar2" } -?> -]]> - - - - - - &reftitle.seealso; - - - Yac::set - Yac::__get - - - - - - - diff --git a/reference/yac/yac/getter.xml b/reference/yac/yac/getter.xml deleted file mode 100644 index 5424d770e1..0000000000 --- a/reference/yac/yac/getter.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Yac::__get - Recupera un valor usando la sintaxis de propiedades - - - - &reftitle.description; - - public mixedYac::__get - stringkey - - - Recupera un valor de la caché; se invoca al leer una propiedad de una - instancia de Yac: $yac->foo es - equivalente a $yac->get("foo"). - - - - - &reftitle.parameters; - - - key - - - El nombre de la propiedad, utilizado como clave de la caché. - - - - - - - - &reftitle.returnvalues; - - El valor almacenado en caso de acierto, &null; cuando la clave no está - presente en la caché. - - - - A diferencia de Yac::get, la sintaxis de - propiedades no puede distinguir un &null; almacenado de una clave - ausente, y solo admite claves individuales. - - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yac::__get</methodname> - -set("foo", "bar"); - -var_dump($yac->foo); // string(3) "bar" -var_dump($yac->missing); // NULL -?> -]]> - - - - - - &reftitle.seealso; - - - Yac::get - Yac::__set - - - - - - - \ No newline at end of file diff --git a/reference/yac/yac/info.xml b/reference/yac/yac/info.xml deleted file mode 100644 index 136b749428..0000000000 --- a/reference/yac/yac/info.xml +++ /dev/null @@ -1,193 +0,0 @@ - - - - - - Yac::info - Estado del caché - - - - &reftitle.description; - - public arrayYac::info - - - - Obtiene el estado del sistema de caché - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un array con las siguientes claves: - - - - memory_size - - Memoria compartida total en uso, en bytes: la tabla de slots más los - bloques de valores. - - - - slots_memory_size - - Memoria reservada para la tabla de slots hash, en bytes. - - - - values_memory_size - - Memoria reservada para los valores almacenados, en bytes. - - - - segment_size - - Tamaño de un segmento de memoria de valores, en bytes. - - - - segment_num - - Número de segmentos de memoria de valores. - - - - miss - - Número de fallos de caché: búsquedas que no encontraron nada o que - encontraron una entrada expirada. - - - - hits - - Número de aciertos de caché: búsquedas satisfactorias. - - - - fails - - Número de almacenamientos fallidos: almacenamientos que no pudieron - asignar un bloque de valor. - - - - kicks - - Número de expulsiones: cuántas veces hubo que expulsar una entrada - existente porque la ruta de slots candidata estaba llena. - - - - recycles - - Número de veces que el asignador llegó al final de un segmento y - volvió a su comienzo. - - - - start_time - - La marca de tiempo Unix en la que se inicializó el caché en memoria - compartida. - - - - slots_size - - Número total de slots hash. - - - - slots_used - - Número de slots hash ocupados actualmente. - - - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yac::info</methodname> - -set("foo", "bar"); - -print_r($yac->info()); -?> -]]> - - &example.outputs.similar; - - 75497472 - [slots_memory_size] => 8388608 - [values_memory_size] => 67108864 - [segment_size] => 4194304 - [segment_num] => 16 - [miss] => 0 - [hits] => 0 - [fails] => 0 - [kicks] => 0 - [recycles] => 0 - [start_time] => 1725955200 - [slots_size] => 65536 - [slots_used] => 1 -) -]]> - - - La tasa de aciertos puede calcularse como - hits / (hits + miss); un contador - kicks o fails creciente indica - que el caché está bajo presión de memoria. - - - - - - &reftitle.seealso; - - - Yac::dump - - - - - - - diff --git a/reference/yac/yac/set.xml b/reference/yac/yac/set.xml deleted file mode 100644 index 97ecd4c995..0000000000 --- a/reference/yac/yac/set.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - Yac::set - Almacena un valor en la caché - - - - &reftitle.description; - - public boolYac::set - stringarraykey - mixedvalue - intttl0 - - - public boolYac::set - arrayvalues - intttl0 - - - Almacena un valor en la caché. Si la clave ya existe, la entrada - existente se sobrescribe, independientemente de si ha expirado. - - - - - &reftitle.parameters; - - - key - - - Una clave de tipo string, o un array de - pares clave => valor que almacenar en una sola llamada. - - - - - value - - - El valor que almacenar. Se puede almacenar cualquier tipo de PHP excepto - resource. Solo se utiliza en la forma de clave única; cuando - key es un array, este argumento es en su lugar el - parámetro opcional ttl. - - - - - ttl - - - Tiempo de vida en segundos. 0 significa que la entrada - nunca expira por tiempo. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; en caso de éxito, &false; en caso de error. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yac::set</methodname> - -set("foo", "bar"); // almacena un único valor -$yac->set("foo", "baz"); // sobrescribe la entrada existente -?> -]]> - - - - Almacenar una entrada con un TTL - -set("short-lived", "value", 5); -sleep(6); -var_dump($yac->get("short-lived")); // bool(false): ha expirado -?> -]]> - - - - Almacenar varias entradas en una sola llamada - - valor con una sola llamada -$yac->set(array("a" => 1, "b" => 2)); -?> -]]> - - - - - - &reftitle.seealso; - - - Yac::add - Yac::get - Yac::__set - - - - - - - diff --git a/reference/yac/yac/setter.xml b/reference/yac/yac/setter.xml deleted file mode 100644 index 7346b6fb80..0000000000 --- a/reference/yac/yac/setter.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Yac::__set - Almacena un valor utilizando la sintaxis de propiedades - - - - &reftitle.description; - - public mixedYac::__set - stringkey - mixedvalue - - - Almacena un valor en la caché; se invoca al escribir una propiedad de una - instancia de Yac: $yac->foo = "bar" - es equivalente a $yac->set("foo", "bar"), sin - ttl. - - - - - &reftitle.parameters; - - - key - - - El nombre de la propiedad, utilizado como clave de la caché. - - - - - value - - - El valor a almacenar. Se puede almacenar cualquier tipo de PHP excepto - resource. - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor almacenado. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yac::__set</methodname> - -foo = "bar"; // almacenado sin ttl -var_dump($yac->get("foo")); // string(3) "bar" -?> -]]> - - - - - - &reftitle.seealso; - - - Yac::set - Yac::__get - - - - - - - diff --git a/reference/yaconf/book.xml b/reference/yaconf/book.xml deleted file mode 100644 index ad633b73da..0000000000 --- a/reference/yaconf/book.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Yaconf - Yaconf - - - &reftitle.intro; - - Yet Another Configurations Container - (Yaconf) es un contenedor de configuraciones. Analiza - los archivos INI cuando PHP se inicia y conserva el - resultado en memoria persistente durante todo el ciclo de vida de PHP, - de modo que cada recuperación es una rápida búsqueda en una tabla hash, - sin E/S de archivos y sin análisis por petición. - - - Yaconf almacena todas las configuraciones como cadenas internalizadas o - arrays inmutables. No están sujetas al conteo de referencias, por lo que - recuperar una configuración de Yaconf es, en la práctica, una operación - sin copia. Desde Yaconf 1.2.0, todo el árbol de configuración analizado - se compacta además en un único bloque contiguo, lo que reduce el consumo - de memoria y mejora la localidad de caché. - - - La configuración analizada reside en memoria persistente compartida por - todos los procesos de trabajo de PHP-FPM mediante copia al escribir: - mientras un archivo de configuración no cambie, los procesos de trabajo - comparten las mismas páginas físicas de memoria sin importar cuántos - estén en ejecución. - - - Yaconf admite secciones y herencia de secciones en los archivos INI. En - las compilaciones no ZTS también recarga los archivos automáticamente - cuando cambian; en las compilaciones ZTS (seguras para hilos), las - configuraciones se cargan al inicio y es necesario reiniciar para tener - en cuenta los cambios. - - - Desde Yaconf 1.2.0, los subdirectorios del directorio configurado se - cargan de forma recursiva (hasta 16 niveles de profundidad) y se - referencian usando el nombre del directorio como un nivel de clave: por - ejemplo, Yaconf::get("users.database.master") lee la - clave master del archivo - database.ini situado en el subdirectorio - users/. - - - Almacenar las configuraciones sensibles fuera del árbol web también - reduce la superficie de ataque. Los archivos de configuración situados - bajo la raíz web pueden ser recuperados por un atacante, por ejemplo a - través de una vulnerabilidad de divulgación de archivos. Con Yaconf, los - archivos .ini pueden colocarse en su lugar en un - directorio legible únicamente por root, como - /etc/yaconf: el proceso maestro de PHP-FPM carga las - configuraciones cuando el servicio arranca, mientras que los procesos de - trabajo derivados —que se ejecutan con un usuario sin privilegios y son - los que atienden las peticiones web— no necesitan, y no reciben, acceso a - ese directorio. - - - Yaconf requiere PHP 7.0 o superior. - - - - &reference.yaconf.setup; - &reference.yaconf.yaconf; - - - - diff --git a/reference/yaconf/configure.xml b/reference/yaconf/configure.xml deleted file mode 100644 index 6a149f7b16..0000000000 --- a/reference/yaconf/configure.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;yaconf - - - -
    - - - diff --git a/reference/yaconf/ini.xml b/reference/yaconf/ini.xml deleted file mode 100644 index bf89afcd96..0000000000 --- a/reference/yaconf/ini.xml +++ /dev/null @@ -1,147 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - - Yaconf &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - yaconf.directory - "" - INI_SYSTEM - - - - yaconf.check_delay - 300 - INI_SYSTEM - - - - -
    -
    - - &ini.descriptions.title; - - - - - - yaconf.directory - string - - - - El directorio donde se encuentran todos los archivos de configuración - INI. Solo se cargan los archivos con la extensión - .ini. Los subdirectorios se cargan de forma - recursiva (hasta 16 niveles de profundidad); cada uno actúa como un - nivel de clave, de modo que un archivo - database.ini situado en el subdirectorio - users/ se referencia como - "users.database". Disponible desde Yaconf 1.2.0; - antes de esa versión solo se cargaban los archivos situados - directamente en el directorio. - - - Los ejemplos siguientes suponen el archivo - database.ini mostrado a continuación, situado en - el directorio configurado, junto a un archivo - features.ini que contiene los ajustes de cada - funcionalidad. - - - Sintaxis de un archivo INI - - - - - - Ejemplo de secciones INI - - - - - - - - - yaconf.check_delay - int - - - - El intervalo, en segundos, con el que Yaconf comprueba si alguno de - los archivos INI cargados ha cambiado y recarga los que hayan - cambiado (el cambio se detecta comparando las fechas de modificación - del directorio). Establecerlo a 0 hace que Yaconf - compruebe en cada petición. - - - - Esta directiva solo se registra en las compilaciones no ZTS. En las - compilaciones ZTS (seguras para hilos), las configuraciones se cargan - al inicio y la recarga automática no está disponible; hay que - reiniciar PHP para tener en cuenta los cambios. - - - - - - -
    - - diff --git a/reference/yaconf/setup.xml b/reference/yaconf/setup.xml deleted file mode 100644 index 36dde3c389..0000000000 --- a/reference/yaconf/setup.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Yaconf requiere PHP 7.0 y superior. - -
    - -
    - &reftitle.install; - - Yaconf puede instalarse de tres maneras: mediante PECL, mediante PIE o - compilándolo a partir del código fuente. - - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;yaconf. - - - &pecl.windows.download.avail; - - - Instalación de Yaconf con PECL - - - - - - Desde Yaconf 1.2.0, la extensión puede instalarse con &link.pie;, el - instalador de extensiones de PHP, ejecutando lo siguiente en la línea de - órdenes. - - - Instalación de Yaconf con PIE - - - - - - El código fuente está alojado en - GitHub. Para - compilar la extensión a partir del código fuente, hay que ejecutar lo - siguiente en la línea de órdenes, reemplazando las rutas por las de la - instalación local de PHP. - - - Compilación de Yaconf a partir del código fuente - - - - -
    - - &reference.yaconf.ini; - -
    - &reftitle.resources; - - - -
    - -
    - - diff --git a/reference/yaconf/yaconf.xml b/reference/yaconf/yaconf.xml deleted file mode 100644 index c27ac5fa12..0000000000 --- a/reference/yaconf/yaconf.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - - La clase Yaconf - Yaconf - - - - -
    - &reftitle.intro; - - Yaconf es un contenedor de configuraciones, - analiza los archivos del INI, almacena el resultado en - cuando PHP se inicia, el resultado vive - con todo el ciclo de vida de PHP. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaconf - - - - - Yaconf - - - - - &Methods; - - - - -
    - -
    - - &reference.yaconf.entities.yaconf; - -
    - - diff --git a/reference/yaconf/yaconf/get.xml b/reference/yaconf/yaconf/get.xml deleted file mode 100644 index 1f61f39d09..0000000000 --- a/reference/yaconf/yaconf/get.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - Yaconf::get - Recupera un valor de configuración por su nombre - - - - &reftitle.description; - - public static mixedYaconf::get - stringname - mixeddefault&null; - - - Recupera el valor de configuración almacenado bajo - name. Los nombres emplean la notación de punto - para recorrer las claves anidadas: "app" hace - referencia al archivo app.ini analizado por - completo, "app.name" a una clave dentro de él y, desde - Yaconf 1.2.0, "users.database.master" a una clave del - archivo database.ini situado en el subdirectorio - users/. La notación de punto admite hasta 64 niveles - de anidamiento. - - - - - &reftitle.parameters; - - - name - - - El nombre de configuración a buscar, empleando la notación de punto - para recorrer las claves anidadas, por ejemplo - "app.name", "app.features.1" - o, desde Yaconf 1.2.0, "users.database.master" - para los archivos en subdirectorios. - - - - - default - - - El valor a devolver cuando no se encuentra - name. Si se omite, se devuelve &null;. - - - - - - - - &reftitle.returnvalues; - - El valor de configuración almacenado, un string o un - array, cuando name existe; en caso - contrario, default (o &null; si no se indicó - ningún valor por defecto). - - - - - &reftitle.examples; - - Los ejemplos siguientes suponen los dos archivos mostrados a - continuación, situados en el directorio configurado con - yaconf.directory. - - - - - - - - - Ejemplo de <methodname>Yaconf::get</methodname> - - -]]> - - - - - - &reftitle.seealso; - - - Yaconf::has - Yaconf::__debug_info - - - - - - - diff --git a/reference/yaconf/yaconf/has.xml b/reference/yaconf/yaconf/has.xml deleted file mode 100644 index 4f9aad44db..0000000000 --- a/reference/yaconf/yaconf/has.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - Yaconf::has - Comprueba si existe un valor de configuración - - - - &reftitle.description; - - public static boolYaconf::has - stringname - - - Determina si existe un valor de configuración bajo - name, que emplea la misma notación de punto que - Yaconf::get: por ejemplo, - "app.name" o, desde Yaconf 1.2.0, - "users.database.master" para los archivos en - subdirectorios. - - - - - &reftitle.parameters; - - - name - - - El nombre de configuración a buscar, empleando la notación de punto - para recorrer las claves anidadas, por ejemplo - "app.name" o - "users.database.master". - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si existe un valor de configuración en - name, &false; en caso contrario. - - - - - &reftitle.examples; - - Los ejemplos siguientes suponen un archivo - app.ini situado en el directorio configurado con - yaconf.directory, que contiene las claves - name="shop" y debug=0. - - - Ejemplo de <methodname>Yaconf::has</methodname> - - -]]> - - - - - - &reftitle.seealso; - - - Yaconf::get - Yaconf::__debug_info - - - - - - - diff --git a/reference/yaf/appconfig.xml b/reference/yaf/appconfig.xml deleted file mode 100644 index 1d5e929e8b..0000000000 --- a/reference/yaf/appconfig.xml +++ /dev/null @@ -1,433 +0,0 @@ - - - - - Configuración de la Aplicación - - Se debería proporcionar una array de configuración o una ruta a un fichero de configuración ini (véase - Yaf_Config_Ini) a - Yaf_Application::__construct. - - - Yaf fusionará las configuraciones de la aplicación y del usuario - automáticamente. Las configuraciones de la aplicación tienen el prefijo "yaf." o - "application.". Si existen ambos prefijos, "yaf." y "application.", "application." - tendrá preferencia. - - Un ejemplo de array de PHP - - array( - "directory" => dirname(__FILE__), - "dispatcher" => array( - "catchException" => 0, - ), - "view" => array( - "ext" => "phtml", - ), - ), -); - -$app = new Yaf_Application($configs); - -?> -]]> - - - - Un ejemplo de un fichero ini - - - - - - - Cuando la configuración crece, Yaf_Config_Ini, que - analiza el fichero ini en cada petición, supone una sobrecarga apreciable. - Yaconf analiza todos los - ficheros ini de un directorio una sola vez al arrancar PHP y mantiene los - valores analizados en memoria compartida. Basta con establecer - yaconf.directory a la carpeta que contiene la - configuración y pasar el array devuelto a - Yaf_Application::__construct: - - - -]]> - - - Un fichero que contiene cabeceras [section] se expone - como una entrada por sección (con la herencia, por ejemplo - [product : yaf], ya resuelta). Para recuperar una sola - sección se usa un punto, - Yaconf::get("application.product"), y se pasa ese array - en su lugar; sus claves son exactamente las entradas fusionadas de esa - sección. - - - - - - Configuración de la Aplicación Yaf - - - - &Name; - &Default; - &Changelog; - - - - - application.directory - - - - - application.ext - "php" - - - - application.view.ext - "phtml" - - - - application.modules - "index" - - - - application.library - application.directory . "/library" - - - - application.library.directory - application.directory . "/library" - - - - application.library.namespace - "" - - - - application.bootstrap - application.directory . "/Bootstrap" . application.ext - - - - application.baseUri - "" - - - - application.dispatcher.defaultRoute - - - - - application.dispatcher.throwException - 1 - - - - application.dispatcher.catchException - 0 - - - - application.dispatcher.defaultModule - "index" - - - - application.dispatcher.defaultController - "index" - - - - application.dispatcher.defaultAction - "index" - - - - application.system - - - - - -
    -
    - - &ini.descriptions.title; - - - - - - application.directory - string - - - - El directorio de la aplicación, que es la caperta que contiene las - carpetas "controllers", "views", "models", "plugins". - - - - - Esta entrada de configuración es la única que no tiene un valor por omisión - Se debería definir siempre manualmente. - - - - - - - - application.ext - string - - - - La extensión de fichero del script de PHP, usado en la autocarga de clases - (Yaf_Loader). - - - - - - application.view.ext - string - - - - La extensión de fichero de los script de plantilla de vistas. - - - - - - application.modules - string - - - - Una lista separada por comas de los módulos registrados, usada en el proceso de - enrutamiento, especialmente mientras existan más de tres segmentos en PATH_INFO, - - - Yaf necesita una forma de averiguar si el primer segmento es un nombre de módulo o no. - - - - - - application.library - string - - - - El directorio de bibliotecas local, véase Yaf_Loader y - yaf.library. - - - - Después de Yaf 2.1.6, esta entrada de configuración puede ser un array. La ruta de la biblioteca - intentará emplear los ítems establecidos en application.library.directory - - - - - - - application.library.directory - string - - - - Alias de application.library. Introducido - en Yaf 2.1.6 - - - - - - application.library.namespace - string - - - - Un prefijo separado por comas de nombres de espacios de bibliotecas locales. - - - Introducido en Yaf 2.1.6 - - - - - - application.bootstrap - string - - - - Una ruta absoluta del script de la clase Bootstrap. - - - - - - application.baseUri - string - - - - Usado para eliminar un prefijo fijo de un uri de petición en el proceso de enrutamiento. - Como ejemplo, una petición con la uri de petición - "/prefix/controller/action". Si se establece application.baseUri a - "/prefix", solamente se tomará "/controller/action" como PATH_INFO en - el proceso de enrutamiento. - - - En general, no hay necesidad de establecer este valor. - - - - - - application.dispatcher.throwException - bool - - - - Si es On, Yaf lanzará una excepción mientras ocurra algún error. - Véase también Yaf_Dispatcher::throwException. - - - - - - application.dispatcher.catchException - bool - - - - Si es On, Yaf remitirá al controlador/acción de errores mientras - exista una excepción no capturada. Véase también - Yaf_Dispatcher::catchException. - - - - - - application.dispatcher.defaultRoute - string - - - - El enrutamiento por omisión, si no se especifica se usará un enrutamiento estático - como por omisión. Véase - Yaf_Router::addRoute. - - - - - - application.dispatcher.defaultModule - string - - - - El nombre de módulo por omisión, véase también - Yaf_Dispatcher::setDefaultModule. - - - - - - application.dispatcher.defaultController - string - - - - El nombre de controlador por omisión, véase también - Yaf_Dispatcher::setDefaultController. - - - - - - application.dispatcher.defaultAction - string - - - - El nombre de acción por omisión, véase también - Yaf_Dispatcher::setDefaultAction. - - - - - - - application.system - string - - - - Establecer la configuración en tiempo de ejecuc de yaf en application.ini, como: - application.system.lowcase_path - - - Solamente las configuraciones de INI_ALL se pueden establecer de esta manera. - - - - - - - - -
    - - diff --git a/reference/yaf/book.xml b/reference/yaf/book.xml deleted file mode 100644 index e6e5155b94..0000000000 --- a/reference/yaf/book.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - Yet Another Framework - Yaf - - - &reftitle.intro; - - La extensión Yet Another Framework - (Yaf) es un framework de PHP usado para desarrollar - aplicaciones web. - - - A diferencia de los frameworks PHP típicos, Yaf está escrito en C y - compilado como extensión: las clases del framework, el autocargador, el - router y el bucle de despacho se ejecutan en código compilado, por lo que - la sobrecarga del framework por petición se mide en microsegundos en lugar - de milisegundos, y no hay ficheros PHP del framework que cargar. Está - diseñado para aplicaciones de alto tráfico donde el coste de arranque - importa, y para entornos de ejecución de servicios de larga duración (como - Swoole) donde cada petición necesita un ciclo de despacho limpio. - - - Yaf implementa la arquitectura MVC clásica con un único - script de entrada, un fichero de configuración con secciones de entorno, - hooks de bootstrap, un sistema de plugins con siete hooks de despacho, - seis tipos de rutas integrados, un autocargador de estilo PSR-0 - (Yaf_Loader) y una vista de plantilla PHP ligera - (Yaf_View_Simple). - - - Se puede encontrar una comparativa sencilla de Yaf en - Rendimiento de Yaf. Para una - guía rápida, consulte la sección Tutoriales. - - - - Yaf requiere PHP 7.0 o posterior (la rama master de su repositorio - fuente); una rama php5 soporta PHP 5.2 y posterior. - - - - - &reference.yaf.setup; - &reference.yaf.constants; - &reference.yaf.tutorials; - &reference.yaf.appconfig; - &reference.yaf.yaf-application; - &reference.yaf.yaf-bootstrap-abstract; - &reference.yaf.yaf-dispatcher; - &reference.yaf.yaf-config-abstract; - &reference.yaf.yaf-config-ini; - &reference.yaf.yaf-config-simple; - &reference.yaf.yaf-controller-abstract; - &reference.yaf.yaf-action-abstract; - &reference.yaf.yaf-view-interface; - &reference.yaf.yaf-view-simple; - &reference.yaf.yaf-loader; - &reference.yaf.yaf-plugin-abstract; - &reference.yaf.yaf-registry; - &reference.yaf.yaf-request-abstract; - &reference.yaf.yaf-request-http; - &reference.yaf.yaf-request-simple; - &reference.yaf.yaf-response-abstract; - &reference.yaf.yaf-response-cli; - &reference.yaf.yaf-response-http; - &reference.yaf.yaf-route-interface; - &reference.yaf.yaf-route-map; - &reference.yaf.yaf-route-regex; - &reference.yaf.yaf-route-rewrite; - &reference.yaf.yaf-router; - &reference.yaf.yaf-route-simple; - &reference.yaf.yaf-route-static; - &reference.yaf.yaf-route-supervar; - &reference.yaf.yaf-session; - &reference.yaf.yaf-exception; - &reference.yaf.yaf-exception-typeerror; - &reference.yaf.yaf-exception-startuperror; - &reference.yaf.yaf-exception-dispatchfailed; - &reference.yaf.yaf-exception-routerfailed; - &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; - - - - diff --git a/reference/yaf/configure.xml b/reference/yaf/configure.xml deleted file mode 100644 index c20bc59a0d..0000000000 --- a/reference/yaf/configure.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;yaf - - - -
    - - - diff --git a/reference/yaf/constants.xml b/reference/yaf/constants.xml deleted file mode 100644 index 8ea03667eb..0000000000 --- a/reference/yaf/constants.xml +++ /dev/null @@ -1,215 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - Cuando se produce un error durante el arranque, el enrutamiento, el - despacho o la carga automática, Yaf lanza una subclase de - Yaf_Exception cuyo código de excepción es - una de las constantes YAF_ERR_*, o desencadena un error - PHP del tipo correspondiente; véase - Yaf_Dispatcher::throwException y - Yaf_Application::getLastErrorNo. - - - - - - YAF_VERSION - (string) - - - - La versión de la extensión Yaf cargada, por ejemplo - "3.3.8". - - - - - - YAF_ENVIRON - (string) - - - - El valor de la directiva - yaf.environ - en el momento en que se inició la extensión, usado por - Yaf_Application para seleccionar la sección de - configuración. Por omisión, "product". - - - - - - YAF_ERR_STARTUP_FAILED - (int) - - - - Fallo de arranque, valor 512. Se lanza como - Yaf_Exception_StartupError cuando - Yaf_Application no ha podido arrancar, por - ejemplo porque falta el directorio de la aplicación o la configuración - no es válida. - - - - - - YAF_ERR_ROUTE_FAILED - (int) - - - - Fallo de enrutamiento, valor 513. Se lanza como - Yaf_Exception_RouterFailed cuando ninguna ruta - ha podido enrutar la petición. - - - - - - YAF_ERR_DISPATCH_FAILED - (int) - - - - Fallo de despacho, valor 514. Se lanza como - Yaf_Exception_DispatchFailed cuando la petición - no ha podido despacharse, por ejemplo cuando se supera - yaf.forward_limit. - - - - - - YAF_ERR_NOTFOUND_MODULE - (int) - - - - No se ha encontrado el módulo, valor 515. Se lanza - como Yaf_Exception_LoadFailed_Module. - - - - - - YAF_ERR_NOTFOUND_CONTROLLER - (int) - - - - No se ha encontrado el controlador, valor 516. Se - lanza como - Yaf_Exception_LoadFailed_Controller. - - - - - - YAF_ERR_NOTFOUND_ACTION - (int) - - - - No se ha encontrado la acción, valor 517. Se lanza - como Yaf_Exception_LoadFailed_Action. - - - - - - YAF_ERR_NOTFOUND_VIEW - (int) - - - - No se ha encontrado el script de vista, valor 518. - Se lanza como Yaf_Exception_LoadFailed_View. - - - - - - YAF_ERR_CALL_FAILED - (int) - - - - Ha fallado la llamada a un método, valor 519. Se usa - cuando no ha podido invocarse un método de acción u otro callable. - - - - - - YAF_ERR_AUTOLOAD_FAILED - (int) - - - - Ha fallado la carga automática, valor 520. Lo - desencadena Yaf_Loader cuando no puede cargarse - el fichero de una clase, por ejemplo porque la ruta resuelta es - demasiado larga. - - - - - - YAF_ERR_TYPE_ERROR - (int) - - - - Se ha producido un error de tipo, valor 521. Se - lanza como Yaf_Exception_TypeError - cuando un argumento o una definición de clase tiene un tipo - inesperado, por ejemplo un controlador que no es una clase que extienda - Yaf_Controller_Abstract. - - - - - - YAF_ERR_ACCESS_ERROR - (int) - - - - El acceso no está permitido, valor 522. Se usa, por - ejemplo, al intentar llamar a un método de acción que no es público. - - - (Disponible a partir de Yaf 3.2.0.) - - - - - - - - diff --git a/reference/yaf/ini.xml b/reference/yaf/ini.xml deleted file mode 100644 index 10108212f8..0000000000 --- a/reference/yaf/ini.xml +++ /dev/null @@ -1,313 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - - &ConfigureOptions; de Yaf - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - yaf.library - "" - INI_ALL - - - - yaf.environ - "product" - INI_SYSTEM - - - - yaf.forward_limit - 5 - INI_ALL - - - - yaf.use_namespace - 0 - INI_ALL - - - - yaf.action_prefer - 0 - INI_ALL - - - - yaf.lowcase_path - 0 - INI_ALL - - - - yaf.use_spl_autoload - 0 - INI_ALL - - - - yaf.name_suffix - 1 - INI_ALL - - - - yaf.name_separator - "" - INI_ALL - - - - -
    -
    - - &ini.descriptions.title; - - - - - La directiva yaf.cache_config existía en Yaf 2.x, - donde almacenaba en caché el resultado analizado del fichero de - configuración INI dentro del proceso PHP. Fue eliminada en Yaf 3.0.0 y - ya no se reconoce. - - - - - - - - - yaf.library - string - - - - El directorio de la biblioteca global. - Yaf_Loader busca en este directorio las clases - que no encuentra en la biblioteca local de la aplicación (ver - application.library). - - - Ver también Yaf_Loader::getLibraryPath y - Yaf_Loader::setLibraryPath. - - - - - - yaf.environ - string - - - - El nombre del entorno, "product" por omisión. Lo - usa Yaf_Application para elegir la sección del - fichero de configuración INI (su primer argumento de constructor) que - se convierte en la configuración de la aplicación. - - - Por ejemplo, si este valor es "product", Yaf usará - la sección llamada [product] del fichero de - configuración INI como configuración final del - Yaf_Application. El nombre del entorno también - puede sustituirse por aplicación pasando el segundo argumento del - constructor a Yaf_Application::__construct. - - - - - - yaf.forward_limit - int - - - - El número máximo de veces que - Yaf_Controller_Abstract::forward puede - encadenarse en una sola petición, 5 por omisión. - - - Es una protección frente a bucles recursivos de - Yaf_Controller_Abstract::forward; cuando se - supera el límite, se lanza una - Yaf_Exception_DispatchFailed. Los valores no - positivos se ajustan al valor por omisión. - - - - - - yaf.use_namespace - int - - - - Cuando está activado, todas las clases declaradas por Yaf se nombran - al estilo de los namespaces: - - - \Yaf\Route\Rewrite -Yaf_Request_Http => \Yaf\Request\Http -]]> - - - Hay una excepción para las clases cuyo último componente es una - palabra reservada de PHP y no puede usarse por tanto como nombre de - clase; esas clases conservan el guion bajo en su último componente: - - - \Yaf\Controller_Abstract -Yaf_Route_Static => \Yaf\Route_Static -]]> - - - - Solo se registra uno de los dos estilos de nombres cuando arranca la - extensión, así que esta directiva debe establecerse antes de cargar - la extensión; no puede alternarse por petición de ninguna forma - útil. - - - - - - - yaf.action_prefer - int - - - - Cuando solo hay una parte en el PATH_INFO, decide - si debe considerarse un nombre de controlador o un nombre de acción. - - - Si esta directiva está activada, el único segmento se considera un - nombre de acción, y el nombre del controlador recurre al controlador - por omisión; en caso contrario se considera un nombre de controlador. - - - - - - yaf.lowcase_path - int - - - - Si se deben pasar a minúsculas todos los componentes de la ruta - durante la carga automática de clases. - - - - - - yaf.use_spl_autoload - int - - - - Cuando este valor está activado, si Yaf_Loader - no encuentra una clase, devuelve &false;, dando la oportunidad de que - se llame a otras funciones de carga automática. - - - Cuando está desactivado (lo que ocurre por omisión), si - Yaf_Loader no encuentra una clase, devuelve - &true;, y la carga automática de la clase falla inmediatamente: en - ese modo Yaf_Loader::autoload devuelve - siempre &true;. - - - - Yaf registra su cargador durante la instanciación de un - Yaf_Application, por lo que cualquier otro - cargador automático registrado antes de la instanciación se llamará - antes que Yaf_Loader::autoload. - - - - - - - yaf.name_suffix - int - - - - Cuando está activado (lo que ocurre por omisión), - Yaf_Loader identifica una clase MVC por su - sufijo para decidir si es una clase de controlador o de acción: - IndexController, - IndexAction. - - - Cuando está desactivado, Yaf_Loader se fija en - el prefijo del nombre de la clase: - Controller_Index, Action_Index. - - - - - - yaf.name_separator - string - - - - Cuando no está vacío, Yaf_Loader identifica - las clases MVC por este separador en lugar del guion bajo que separa - el nombre y el sufijo MVC. - - - Por ejemplo, cuando este valor es "_" y - yaf.name_suffix está - activado, Yaf_Loader tomará - Index_Controller como clase de controlador, - mientras que IndexController se considera una - clase normal. Cuando está vacío (lo que ocurre por omisión), se usa - el guion bajo. - - - - - -
    - - diff --git a/reference/yaf/setup.xml b/reference/yaf/setup.xml deleted file mode 100644 index 553623a292..0000000000 --- a/reference/yaf/setup.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - &reftitle.setup; - - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;yaf. - - - Yaf no tiene dependencias externas. Instálelo con: - - - - A partir de la versión 3.3.8, Yaf también puede instalarse con &link.pie;, el - instalador de extensiones PHP: - - - - - - El código fuente está alojado en - GitHub. Para compilar - la extensión desde las fuentes: - - - - y cargarlo añadiendo la siguiente línea al fichero - php.ini: - - - - - - &pecl.windows.download.avail; - -
    - - - - &reference.yaf.ini; - - -
    - - diff --git a/reference/yaf/tutorials.xml b/reference/yaf/tutorials.xml deleted file mode 100644 index 867c0e1484..0000000000 --- a/reference/yaf/tutorials.xml +++ /dev/null @@ -1,409 +0,0 @@ - - - - - &reftitle.examples; - -
    - Inicio rápido - - - Estructura de directorios típica de una aplicación - - - - - Configure el DocumentRoot del servidor web apuntando al directorio - public, de modo que solo los recursos públicos sean accesibles desde la web. - - - - - Estructura de directorios para una aplicación multi-módulo - - - - - En una aplicación multi-módulo, cada módulo tiene sus propios directorios - controllers y views bajo - application/modules/<NombreModulo>/. Los módulos - registrados se declaran en - application.modules. - - - - - Punto de entrada - - El fichero index.php del directorio public es el único punto - de entrada de la aplicación; hay que redirigir todas las peticiones hacia él - (se puede usar .htaccess en Apache + mod_php, o el equivalente - en el servidor web utilizado; véase más abajo). - - -bootstrap() //llama a los métodos bootstrap definidos en Bootstrap.php - ->run(); -?> -]]> - - - - - Regla de reescritura - - "/index.php/$1", - ) -} -]]> - - - - - Bootstrap - - Todo método de la clase Bootstrap cuyo nombre - comience por _init es llamado automáticamente, en orden - de definición, por - Yaf_Application::bootstrap. Cada uno de estos métodos - recibe la instancia de Yaf_Dispatcher como argumento. - Los métodos con otros nombres no se llaman automáticamente. - - - -]]> - - - - - Configuración de la aplicación - - application.ini es el fichero de configuración de la aplicación. - Se pueden usar en él las constantes definidas en index.php, - y las secciones pueden heredar unas de otras. - - - - - - - - Configuración de la aplicación como array PHP - - Además de un fichero de configuración INI, también se puede pasar un array PHP simple - a Yaf_Application::__construct como configuración. - - - array( - "directory" => APPLICATION_PATH . "/application/", - ), -); - -$app = new Yaf_Application($config); -?> -]]> - - - - - Controlador por omisión - - En Yaf, el controlador por omisión se llama - IndexController: - - -getView()->content = "Hello World"; - } -} -?> -]]> - - - - - Plantilla de vista por omisión - - El script de vista para el controlador/acción por omisión es - application/views/index/index.phtml. Yaf incluye - un pequeño motor de vistas llamado Yaf_View_Simple, - cuyas plantillas son scripts PHP simples. - - - - - Hello World - - - - - -]]> - - - - - Ejecutar la aplicación - - Al apuntar el navegador al dominio configurado - (p. ej. http://www.example.com), la respuesta será similar a: - - &example.outputs.similar; - - - - Hello World - - - hello world - - -]]> - - - - El ejemplo mínimo anterior también puede generarse con el generador de código de Yaf - (tools/cg/yaf_cg), que se distribuye con el - repositorio - fuente de Yaf: - - - - - - yaf_cg genera un esqueleto más completo y comentado que el mostrado - en este tutorial: un punto de entrada public/ con reglas de - reescritura, un Bootstrap con configuración, plugin y configuración de rutas - personalizadas, un modelo de ejemplo, un controlador de errores y plantillas de vista. - Es un buen punto de partida para una aplicación real. - - - - -
    - -
    - Rutas personalizadas - - - Rutas personalizadas - - Además de la ruta Yaf_Route_Static por omisión, - se pueden registrar rutas personalizadas en la pila de rutas de - Yaf_Router, normalmente en un método - _initRoute del Bootstrap, mediante - Yaf_Router::addRoute. Las rutas también pueden - declararse en ficheros de configuración y cargarse con - Yaf_Router::addConfig. - - -getRouter(); - - // /user/123 -> controller=user, action=index, id=123 - $router->addRoute("user", new Yaf_Route_Rewrite( - "/user/:id", - array("controller" => "user", "action" => "index") - )); - } -} -?> -]]> - - - -
    - -
    - Plugins - - - Plugins - - Un plugin se integra en el ciclo de despacho extendiendo - Yaf_Plugin_Abstract y sobreescribiendo uno o más - de sus seis métodos de enganche; luego se registra en el despachador con - Yaf_Dispatcher::registerPlugin, normalmente en el Bootstrap: - - -registerPlugin(new UserPlugin()); - } -} -?> -]]> - - - -
    - -
    - diff --git a/reference/yaf/yaf-action-abstract.xml b/reference/yaf/yaf-action-abstract.xml deleted file mode 100644 index 61f03600f2..0000000000 --- a/reference/yaf/yaf-action-abstract.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - La clase Yaf_Action_Abstract - Yaf_Action_Abstract - - - - -
    - &reftitle.intro; - - Una acción puede ser definida en un fichero aparte en Yaf (véase - Yaf_Controller_Abstract). Es decir, un método de acción - también puede ser una clase Yaf_Action_Abstract. - - - Dado que debe haber un punto de entrada que pueda ser llamado por Yaf, - debe implementar el método abstracto - Yaf_Action_Abstract::execute en la clase de - acción personalizada. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Action_Abstract - - - - - Yaf_Action_Abstract - - - - extends - Yaf_Controller_Abstract - - - - &Properties; - - protected - _controller - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.properties; - - - _controller - - - La instancia del controlador propietario de esta acción, accesible - mediante Yaf_Action_Abstract::getController. - - - - -
    - - -
    - - &reference.yaf.entities.yaf-action-abstract; - -
    - - diff --git a/reference/yaf/yaf-application.xml b/reference/yaf/yaf-application.xml deleted file mode 100644 index d1d9fc4b39..0000000000 --- a/reference/yaf/yaf-application.xml +++ /dev/null @@ -1,190 +0,0 @@ - - - - - - La clase Yaf_Application - Yaf_Application - - - - -
    - &reftitle.intro; - - Yaf_Application proporciona una característica de arranque - de aplicaciones que provee de recursos reusables, clases de arranque comunes y - basadas en módulos y verificación de dependencia. - - - - Yaf_Application implementa el patrón singleton, - y Yaf_Application no puede ser serializada o - deserializada, lo que causará problemas al intentar usar PHPUnit para - escribir casos de prueba para Yaf. - - - Se puede usar la anotación @backupGlobals de PHPUnit - para controlar las operaciones de copia de respaldo y restauración de - variables globales, solucionando así este problema. - - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Application - - - - - final - Yaf_Application - - - - &Properties; - - protected - config - - - protected - dispatcher - - - protected - static - _app - - - protected - _modules - - - protected - _running - - - protected - _environ - - - protected - _err_no - - - protected - _err_msg - - - &Methods; - - - - - -
    - - -
    - &reftitle.properties; - - - config - - - El objeto de configuración de la aplicación. - - - - - dispatcher - - - La instancia de Yaf_Dispatcher que usa esta - aplicación. - - - - - _app - - - Referencia estática a la única instancia de la aplicación en ejecución. - - - - - _modules - - - La lista de nombres de módulos registrados, obtenida de - application.modules. - - - - - _running - - - Si la aplicación se está ejecutando actualmente. - - - - - _environ - - - El nombre del entorno de la aplicación; por omisión, - "product". - - - - - _err_no - - El código del último error, una de las constantes - YAF_ERR_*. - - - - _err_msg - - El mensaje del último error. - - - -
    - - -
    - - &reference.yaf.entities.yaf-application; - -
    - - diff --git a/reference/yaf/yaf-bootstrap-abstract.xml b/reference/yaf/yaf-bootstrap-abstract.xml deleted file mode 100644 index 9a60721b0b..0000000000 --- a/reference/yaf/yaf-bootstrap-abstract.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - - - La clase Yaf_Bootstrap_Abstract - Yaf_Bootstrap_Abstract - - - - -
    - &reftitle.intro; - - El arranque (bootstrap) es un mecanismo usado para realizar una configuración inicial antes - de ejecutar una Aplicación. - - - Los usuarios puede definir su propia clase Bootstrap heredando la clase - Yaf_Bootstrap_Abstract - - - Cualquier método declarado en la clase Arranque al que se le anteponga "_init" será - llamado uno a uno por el método Yaf_Application::bootstrap - según su orden de definición. - -
    - - -
    - &reftitle.examples; - - Ejemplo de arranque - - array( - "directory" => dirname(__FILE__) . "/application/", - ), - ); - - $app = new Yaf_Application($config); - $app->bootstrap(); -?> -]]> - - &example.outputs.similar; - - - - -
    - -
    - &reftitle.classsynopsis; - - - - Yaf_Bootstrap_Abstract - - - - - abstract - Yaf_Bootstrap_Abstract - - - &Properties; - - &Methods; - - - -
    - -
    - -
    - - diff --git a/reference/yaf/yaf-config-abstract.xml b/reference/yaf/yaf-config-abstract.xml deleted file mode 100644 index cee7709e99..0000000000 --- a/reference/yaf/yaf-config-abstract.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - La clase Yaf_Config_Abstract - Yaf_Config_Abstract - - - - -
    - &reftitle.intro; - - Yaf_Config_Abstract es la clase base de los - adaptadores de configuración. Proporciona una forma uniforme de acceder a - un conjunto de valores de configuración mediante la sintaxis de - propiedades anidadas ($config->section->key), el - acceso como array y la iteración. Las implementaciones concretas son - Yaf_Config_Ini (de solo lectura, ficheros INI con - herencia entre secciones) y Yaf_Config_Simple - (arrays de PHP, modificables). - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Config_Abstract - - - - - abstract - Yaf_Config_Abstract - - - - &Properties; - - protected - _config - - - protected - _readonly - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - _config - - - - - - _readonly - - - - - -
    - - -
    - - &reference.yaf.entities.yaf-config-abstract; - -
    - - diff --git a/reference/yaf/yaf-config-ini.xml b/reference/yaf/yaf-config-ini.xml deleted file mode 100644 index 44675a5e4e..0000000000 --- a/reference/yaf/yaf-config-ini.xml +++ /dev/null @@ -1,198 +0,0 @@ - - - - - - La clase Yaf_Config_Ini - Yaf_Config_Ini - - - - -
    - &reftitle.intro; - - Yaf_Config_Ini permite a los desarrolladores - almacenar la información de configuración en el familiar formato INI y - leerla en la aplicación mediante la sintaxis de propiedades de objeto - anidadas. El formato INI soporta jerarquías de claves de configuración - (separadas por punto, ".") y herencia entre secciones - (con ":" seguido del nombre de la sección padre). - - - - Yaf_Config_Ini utiliza la función - parse_ini_file de PHP. Consulte su documentación - para conocer sus comportamientos específicos, que se propagan a - Yaf_Config_Ini, como el manejo de los valores - especiales "&true;", "&false;", "yes", "no" y "&null;". - - - - - Yaf_Config_Ini analiza el fichero de configuración - en cada petición. Si una aplicación gestiona una gran cantidad de - configuración (mayormente estática), conviene considerar la extensión - Yaconf: mantiene la configuración en - memoria compartida durante todo el ciclo de vida de PHP, de modo que solo - se analiza una vez y se accede de forma mucho más eficiente. Yaconf - entiende exactamente la misma sintaxis INI (claves separadas por puntos y - herencia entre secciones mediante - "[section : parent]"), por lo que el - application.ini existente puede ser servido por - Yaconf tal cual; solo cambia la forma de pasarlo a - Yaf_Application::__construct (ver el consejo en - Application Configuration). - - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Config_Ini - - - - - Yaf_Config_Ini - - - - extends - Yaf_Config_Abstract - - - - Iterator - - - - ArrayAccess - - - - Countable - - - - &Properties; - - &Methods; - - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.properties; - - - _config - - - - - - _readonly - - - - - -
    - - -
    - &reftitle.examples; - - Ejemplo de <function>Yaf_Config_Ini</function> - - Este ejemplo ilustra el uso básico de la clase Yaf_Config_Ini para cargar - la información de configuración desde un fichero INI. En este ejemplo existe - información de configuración para el sistema de producción y el sistema de pruebas (staging). - Ya que la información de configuración del sistema de pruebas es similar a la - de producción, la sección de pruebas hereda de la sección de producción. - En este caso, la decisión es arbitraria y podría haber sido escrito - a la inversa, con la sección de producción heredando de la sección - de pruebas, aunque este puede no ser el caso para situaciones más complejas. - Suponga que la información de configuración siguiente está contenida en - /ruta/a/config.ini: - - - - - -database->params->host); -var_dump($config->database->params->dbname); -var_dump($config->get("database.params.username")); -?> -]]> - - &example.outputs.similar; - - - - -
    - -
    - - &reference.yaf.entities.yaf-config-ini; - -
    - - diff --git a/reference/yaf/yaf-config-simple.xml b/reference/yaf/yaf-config-simple.xml deleted file mode 100644 index 292d3cbf2e..0000000000 --- a/reference/yaf/yaf-config-simple.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - LA clase Yaf_Config_Simple - Yaf_Config_Simple - - - - -
    - &reftitle.intro; - - Yaf_Config_Simple es un adaptador de configuración - respaldado por un array de PHP (u, opcionalmente, un fichero INI). A - diferencia de Yaf_Config_Ini, es modificable por - omisión: los valores pueden cambiarse en tiempo de ejecución, lo que lo - hace adecuado tanto para configuraciones construidas por programa como - para configuraciones que necesitan ajustarse durante la petición. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Config_Simple - - - - - Yaf_Config_Simple - - - - extends - Yaf_Config_Abstract - - - - Iterator - - - - ArrayAccess - - - - Countable - - - - &Properties; - - protected - _readonly - - - &Methods; - - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.properties; - - - _config - - - - - - _readonly - - - - - -
    - - -
    - - &reference.yaf.entities.yaf-config-simple; - -
    - - diff --git a/reference/yaf/yaf-controller-abstract.xml b/reference/yaf/yaf-controller-abstract.xml deleted file mode 100644 index 571f45c33d..0000000000 --- a/reference/yaf/yaf-controller-abstract.xml +++ /dev/null @@ -1,231 +0,0 @@ - - - - - - La clase Yaf_Controller_Abstract - Yaf_Controller_Abstract - - - - -
    - &reftitle.intro; - - Yaf_Controller_Abstract es el corazón del sistema - de Yaf. MVC significa Modelo Vista Controlador (Model-View-Controller en inglés) y es un - patrón de diseño cuyo objetivo es separar la lógica de aplicación de la lógica de vista. - - - Cada controlador personalizado heredará de la clase - Yaf_Controller_Abstract. - - - Dado que Yaf_Controller_Abstract::__construct - es llamado por Yaf sin argumentos, - Yaf_Controller_Abstract proporciona un gancho - alternativo similar al constructor: - Yaf_Controller_Abstract::init. - - - Si se ha definido un método init() en el controlador personalizado, será - llamado en cuanto el controlador se instancie. - - - Las acciones pueden tener argumentos. Al recibir una petición, si en los - parámetros de la petición existen variables con el mismo nombre (véase - Yaf_Request_Abstract::getParam) tras el - enrutamiento, Yaf los pasará al método de acción (véase - Yaf_Action_Abstract::execute). - - - Estos argumentos se obtienen directamente sin filtrado; deben - procesarse con cuidado antes de usarlos. - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Controller_Abstract - - - - - abstract - Yaf_Controller_Abstract - - - - &Properties; - - public - actions - - - protected - _module - - - protected - _name - - - protected - _request - - - protected - _response - - - protected - _invoke_args - - - protected - _view - - - &Methods; - - - - - -
    - - -
    - &reftitle.properties; - - - actions - - - También se puede definir un método de acción en un script de PHP por separado usando - esta propiedad y la clase Yaf_Action_Abstract. - - Definir una acción en un fichero aparte - - "actions/Dummy_action.php", - ); - - /* el método de acción puede tener argumentos */ - public function indexAction($name, $id) { - /* $name e $id son datos no seguros sin tratar */ - assert($nombre == $this->getRequest()->getParam("nombre")); - assert($id == $this->_request->getParam("id")); - } -} -?> -]]> - - - - Dummy_action.php - - -]]> - - - - - - - _module - - - El nombre del módulo - - - - - _name - - - El nombre del controlador - - - - - _request - - - El objeto de petición actual - - - - - _response - - - El objeto respuesta actual - - - - - _invoke_args - - - Los argumentos de invocación pasados a la acción mediante - Yaf_Controller_Abstract::forward, como un - array indexado por el nombre del argumento. - - - - - _view - - - El objeto de motor de vistas - - - - -
    - - -
    - - &reference.yaf.entities.yaf-controller-abstract; - -
    - - diff --git a/reference/yaf/yaf-dispatcher.xml b/reference/yaf/yaf-dispatcher.xml deleted file mode 100644 index ff20ac35f6..0000000000 --- a/reference/yaf/yaf-dispatcher.xml +++ /dev/null @@ -1,231 +0,0 @@ - - - - - - La clase Yaf_Dispatcher - Yaf_Dispatcher - - - - -
    - &reftitle.intro; - - El propósito de la clase Yaf_Dispatcher es inicializar - el entorno de peticiones, enrutar las peticiones entrantes, y despachar - cualquier acción encontrada; agrega las respuestas y las devuelve cuando - el proceso está completado. - - - Yaf_Dispatcher también implementa el patrón Singleton, - lo que significa que solamente puede estar disponible una instancia de la misma - a la vez. Esto le permite actuar también como un registro en el que los demás - objetos del proceso de despacho pueden apoyarse. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Dispatcher - - - - - final - Yaf_Dispatcher - - - - &Properties; - - protected - _router - - - protected - _view - - - protected - _request - - - protected - _plugins - - - protected - static - _instance - - - protected - _auto_render - - - protected - _return_response - - - protected - _instantly_flush - - - protected - _default_module - - - protected - _default_controller - - - protected - _default_action - - - &Methods; - - - - - -
    - - -
    - &reftitle.properties; - - - _router - - - La instancia de Yaf_Router que usa el - despachador para enrutar las peticiones. - - - - - _view - - - La implementación de Yaf_View_Interface usada - para renderizar las vistas, inicializada de forma perezosa en el primer - despacho. - - - - - _request - - - El objeto de petición que se está despachando. - - - - - _plugins - - - La lista de plugins registrados con - Yaf_Dispatcher::registerPlugin. - - - - - _instance - - - Referencia estática a la única instancia del despachador. - - - - - _auto_render - - - Si el despachador renderiza automáticamente la vista después del - despacho. Por omisión, &true;. - - - - - _return_response - - - Si Yaf_Application::run devuelve el objeto de - respuesta en lugar de enviarlo directamente. Por omisión, &false;. - - - - - _instantly_flush - - - Si el cuerpo de la respuesta se vuelca en cuanto se establece. Por - omisión, &true;. - - - - - _default_module - - - El nombre del módulo por omisión, tomado de la entrada de configuración - application.dispatcher.defaultModule. - - - - - _default_controller - - - El nombre del controlador por omisión, tomado de la entrada de - configuración - application.dispatcher.defaultController. - - - - - _default_action - - - El nombre de la acción por omisión, tomado de la entrada de - configuración application.dispatcher.defaultAction. - - - - -
    - - -
    - - &reference.yaf.entities.yaf-dispatcher; - -
    - - diff --git a/reference/yaf/yaf-exception-dispatchfailed.xml b/reference/yaf/yaf-exception-dispatchfailed.xml deleted file mode 100644 index 0696797c8a..0000000000 --- a/reference/yaf/yaf-exception-dispatchfailed.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - La clase Yaf_Exception_DispatchFailed - Yaf_Exception_DispatchFailed - - - - -
    - &reftitle.intro; - - Yaf_Exception_DispatchFailed se lanza cuando el - despachador no consigue despachar la petición enrutada a una acción de - controlador. Su código de error es 514. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Exception_DispatchFailed - - - - - Yaf_Exception_DispatchFailed - - - - extends - Yaf_Exception - - - - &Properties; - - &Methods; - - &InheritedMethods; - - - - - -
    - - - - -
    - -
    - - diff --git a/reference/yaf/yaf-exception-loadfailed-action.xml b/reference/yaf/yaf-exception-loadfailed-action.xml deleted file mode 100644 index d1a7caf924..0000000000 --- a/reference/yaf/yaf-exception-loadfailed-action.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - La clase Yaf_Exception_LoadFailed_Action - Yaf_Exception_LoadFailed_Action - - - - -
    - &reftitle.intro; - - Yaf_Exception_LoadFailed_Action se lanza cuando la - acción solicitada no puede encontrarse o cargarse. Su código de error es - 517. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Exception_LoadFailed_Action - - - - - Yaf_Exception_LoadFailed_Action - - - - extends - Yaf_Exception_LoadFailed - - - - &Properties; - - &Methods; - - &InheritedMethods; - - - - - -
    - - - - -
    - -
    - - diff --git a/reference/yaf/yaf-exception-loadfailed-controller.xml b/reference/yaf/yaf-exception-loadfailed-controller.xml deleted file mode 100644 index 603ccae4ce..0000000000 --- a/reference/yaf/yaf-exception-loadfailed-controller.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - La clase Yaf_Exception_LoadFailed_Controller - Yaf_Exception_LoadFailed_Controller - - - - -
    - &reftitle.intro; - - Yaf_Exception_LoadFailed_Controller se lanza cuando - el controlador solicitado no puede encontrarse o cargarse. Su código de - error es 516. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Exception_LoadFailed_Controller - - - - - Yaf_Exception_LoadFailed_Controller - - - - extends - Yaf_Exception_LoadFailed - - - - &Properties; - - &Methods; - - &InheritedMethods; - - - - -
    - - - - -
    - -
    - - diff --git a/reference/yaf/yaf-exception-loadfailed-module.xml b/reference/yaf/yaf-exception-loadfailed-module.xml deleted file mode 100644 index 81c6ba1099..0000000000 --- a/reference/yaf/yaf-exception-loadfailed-module.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - La clase Yaf_Exception_LoadFailed_Module - Yaf_Exception_LoadFailed_Module - - - - -
    - &reftitle.intro; - - Yaf_Exception_LoadFailed_Module se lanza cuando el - módulo solicitado no puede encontrarse o cargarse. Su código de error es - 515. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Exception_LoadFailed_Module - - - - - Yaf_Exception_LoadFailed_Module - - - - extends - Yaf_Exception_LoadFailed - - - - &Properties; - - &Methods; - - &InheritedMethods; - - - - - -
    - - - - -
    - -
    - - diff --git a/reference/yaf/yaf-exception-loadfailed-view.xml b/reference/yaf/yaf-exception-loadfailed-view.xml deleted file mode 100644 index be698eed93..0000000000 --- a/reference/yaf/yaf-exception-loadfailed-view.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - La clase Yaf_Exception_LoadFailed_View - Yaf_Exception_LoadFailed_View - - - - -
    - &reftitle.intro; - - Yaf_Exception_LoadFailed_View se lanza cuando el - script de vista (plantilla) solicitado no puede encontrarse o cargarse. Su - código de error es 518. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Exception_LoadFailed_View - - - - - Yaf_Exception_LoadFailed_View - - - - extends - Yaf_Exception_LoadFailed - - - - &Properties; - - &Methods; - - &InheritedMethods; - - - - - -
    - - - - -
    - -
    - - diff --git a/reference/yaf/yaf-exception-loadfailed.xml b/reference/yaf/yaf-exception-loadfailed.xml deleted file mode 100644 index 76728a300a..0000000000 --- a/reference/yaf/yaf-exception-loadfailed.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - La clase Yaf_Exception_LoadFailed - Yaf_Exception_LoadFailed - - - - -
    - &reftitle.intro; - - Yaf_Exception_LoadFailed se lanza cuando el - cargador no consigue cargar un script necesario. Su código de error es - 520. Los fallos más específicos están representados por - sus subclases Yaf_Exception_LoadFailed_Module, - Yaf_Exception_LoadFailed_Controller, - Yaf_Exception_LoadFailed_Action y - Yaf_Exception_LoadFailed_View. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Exception_LoadFailed - - - - - Yaf_Exception_LoadFailed - - - - extends - Yaf_Exception - - - - &Properties; - - &Methods; - - &InheritedMethods; - - - - - -
    - - - - -
    - -
    - - diff --git a/reference/yaf/yaf-exception-routerfailed.xml b/reference/yaf/yaf-exception-routerfailed.xml deleted file mode 100644 index a8d65f3b67..0000000000 --- a/reference/yaf/yaf-exception-routerfailed.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - La clase Yaf_Exception_RouterFailed - Yaf_Exception_RouterFailed - - - - -
    - &reftitle.intro; - - Yaf_Exception_RouterFailed se lanza cuando falla el - enrutamiento, por ejemplo cuando ninguna ruta registrada coincide con la - petición entrante. Su código de error es 513. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Exception_RouterFailed - - - - - Yaf_Exception_RouterFailed - - - - extends - Yaf_Exception - - - - &Properties; - - &Methods; - - &InheritedMethods; - - - - - -
    - - - - -
    - -
    - - diff --git a/reference/yaf/yaf-exception-startuperror.xml b/reference/yaf/yaf-exception-startuperror.xml deleted file mode 100644 index 938d2c97f2..0000000000 --- a/reference/yaf/yaf-exception-startuperror.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - La clase Yaf_Exception_StartupError - Yaf_Exception_StartupError - - - - -
    - &reftitle.intro; - - Yaf_Exception_StartupError se lanza cuando la - aplicación no consigue arrancar, es decir, cuando se produce un error - durante la inicialización de Yaf_Application antes - de que comience el enrutamiento. Su código de error es - 512. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Exception_StartupError - - - - - Yaf_Exception_StartupError - - - - extends - Yaf_Exception - - - - &Properties; - - &Methods; - - &InheritedMethods; - - - - - -
    - - - - -
    - -
    - - diff --git a/reference/yaf/yaf-exception-typeerror.xml b/reference/yaf/yaf-exception-typeerror.xml deleted file mode 100644 index f83b411c72..0000000000 --- a/reference/yaf/yaf-exception-typeerror.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - La clase Yaf_Exception_TypeError - Yaf_Exception_TypeError - - - - -
    - &reftitle.intro; - - Yaf_Exception_TypeError se lanza cuando un - argumento pasado a un método de Yaf es de un tipo inesperado o tiene un - valor no válido. Su código de error es 521. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Exception_TypeError - - - - - Yaf_Exception_TypeError - - - - extends - Yaf_Exception - - - - &Properties; - - &Methods; - - &InheritedMethods; - - - - - -
    - - - - -
    - -
    - - diff --git a/reference/yaf/yaf-exception.xml b/reference/yaf/yaf-exception.xml deleted file mode 100644 index 54e34b423a..0000000000 --- a/reference/yaf/yaf-exception.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - La clase Yaf_Exception - Yaf_Exception - - - - -
    - &reftitle.intro; - - Yaf_Exception es la clase base de todas - las excepciones lanzadas por Yaf. Todas las demás clases de excepción de - Yaf la extienden. - - - Extiende RuntimeException cuando la - extensión SPL está cargada, y la clase integrada - Exception en caso contrario. Las - excepciones lanzadas por Yaf llevan un código de error que identifica el - tipo de fallo. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Exception - - - - - Yaf_Exception - - - - extends - Exception - - - - &InheritedProperties; - - - &Methods; - - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.yaf.entities.yaf-exception; - -
    - - diff --git a/reference/yaf/yaf-loader.xml b/reference/yaf/yaf-loader.xml deleted file mode 100644 index e44598418e..0000000000 --- a/reference/yaf/yaf-loader.xml +++ /dev/null @@ -1,299 +0,0 @@ - - - - - - La clase Yaf_Loader - Yaf_Loader - - - - -
    - &reftitle.intro; - - Yaf_Loader introduce una solución completa de - autocarga para Yaf. - - - La primera vez que se recupera una instancia de la clase Yaf_Application, - Yaf_Loader instanciará un singleton, y se registrará a sí mismo con - spl_autoload. Se recupera una instancia usando el método Yaf_Loader::getInstance - - - Yaf_Loader intenta cargar una clase sólo una vez, y si - falla, dependiendo de yaf.use_spl_autoload, si esta configuración - es "On" Yaf_Loader::autoload devolverá - &false;, y así dará otra oportunidad a otra función de autocarga; si es "Off" - (por omisión), Yaf_Loader::autoload devolverá - &true;, y lo que es más importante: emitirá una advertencia muy útil - (muy útil para averiguar por qué no se cargó una clase). - - - Por favor, mantenga yaf.use_spl_autoload en "Off" a menos que exista una biblioteca que - tenga su propio mecanismo de autocarga y sea imposible reescribirlo. - - - - - Por omisión, Yaf_Loader asume que todas las bibliotecas (las clases - definidas en el script) se almacenan en el directorio de clases - global, el cual está definido en php.ini (yaf.library). - - - - Si quiere que Yaf_Loader busque algunas - clases (bibliotecas) en el directorio de - clases local (el cual está definido en application.ini, y por omisión - es application.directory . "/libraray"), - debería registrar el prefijo de clases usando el método - Yaf_Loader::registerLocalNameSpace - - - - Veamos algunos ejemplos (asumiendo que APPLICATION_PATH es application.directory): - - Ejemplo de configuración - - - - - - Se asume que el siguiente namespace local está registrado: - - Registrar el namespace local - -registerLocalNameSpace(array("Foo", "Bar")); - } -} -?> -]]> - - - - Ahora los ejemplos de autocarga: - - Ejemplo de carga de clases - - - // APPLICATION_PATH/library/Foo/Bar/Test.php - -class GLO_Name => - // /global_dir/Glo/Name.php - -class BarNon_Test - // /global_dir/Barnon/Test.php -]]> - - - - - Ejemplo de carga de una clase en el namespace - - - // APPLICATION_PATH/library/Foo/Bar/Dummy.php - -class \FooBar\Bar\Dummy => - // /global_dir/FooBar/Bar/Dummy.php -]]> - - - - - - Se puede observar que todas las carpetas tienen la primera letra en mayúsculas, se pueden ponerlas - en minúsculas estableciendo yaf.lowcase_path = On en php.ini - - - - Yaf_Loader también está diseñada para cargar las clases MVC, - y la regla es: - - Ejemplo de carga de clase MVC - - -// APPLICATION_PATH/controllers/ - -Model Classes => -// APPLICATION_PATH/models/ - -Plugin Classes => -// APPLICATION_PATH/plugins/ -]]> - - - - Yaf identifica un sufijo de clases (por omisión, se puede cambiar - el sufijo cambiando la opción de configuración yaf.name_suffix) para decidir si - es una clase MVC: - - Distinciones de clases MVC - - - // ***Controller - -Model Classes => - // ***Model - -Plugin Classes => - // ***Plugin -]]> - - - - algunos ejemplos: - - Ejemplo de carga MVC - - - // APPLICATION_PATH/models/Data.php - -class DummyPlugin => - // APPLICATION_PATH/plugins/Dummy.php - -class A_B_TestModel => - // APPLICATION_PATH/models/A/B/Test.php -]]> - - - - - - A partir de 2.1.18, Yaf admite que los Controllers se autocarguen para el lado del scrpt cliente, - (lo que significa que la autocarga se desencadena por el script del usuario de php, p.ej., acceder a una - propiedad de un Controller estático en Bootstrap o Plugins), - aunque el autocargador solamente intenta localizar el controlador bajo la carpeta del - módulo por omisión, que es "APPLICATION_PATH/controllers/". - - - - también, el directorio será afectado por yaf.lowcase_path. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Loader - - - - - Yaf_Loader - - - - &Properties; - - protected - _local_ns - - - protected - _library - - - protected - _global_library - - - static - _instance - - - &Methods; - - - - - -
    - - -
    - &reftitle.properties; - - - _local_ns - - - - - - _library - - - Por omisión, este valor es application.directory . "/library", - se puede cambiar en application.ini (application.library) o llamando al método - Yaf_Loader::setLibraryPath - - - - - _global_library - - - - - - _instance - - - - - -
    - - -
    - - &reference.yaf.entities.yaf-loader; - -
    - - diff --git a/reference/yaf/yaf-plugin-abstract.xml b/reference/yaf/yaf-plugin-abstract.xml deleted file mode 100644 index 0423b23b5c..0000000000 --- a/reference/yaf/yaf-plugin-abstract.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - La clase Yaf_Plugin_Abstract - Yaf_Plugin_Abstract - - - - -
    - &reftitle.intro; - - Los plugins permiten extender y personalizar el framework de forma sencilla. - Un plugin es una clase que extiende - Yaf_Plugin_Abstract y sobreescribe uno o más - métodos gancho, que se llaman automáticamente en puntos fijos del ciclo de - despacho: antes y después del enrutamiento, antes y después del bucle de - despacho, y antes y después de cada despacho individual. - - - Un plugin se registra en el despachador con - Yaf_Dispatcher::registerPlugin, normalmente en el - Bootstrap. Después del registro, todos los métodos gancho que implementa el - plugin se llaman en el momento adecuado, recibiendo cada uno las instancias - actuales de Yaf_Request_Abstract y - Yaf_Response_Abstract. - -
    - - -
    - &reftitle.examples; - - Plugin example - -registerPlugin(new TestPlugin()); - } - } - - /* la clase complemento debería estar ubicada bajo ./application/plugins/ */ - class TestPlugin extends Yaf_Plugin_Abstract { - public function routerStartup(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) { - /* antes del enrutador - en este hook, el usuario puede hacer alguna reescritura de la url */ - var_dump("routerStartup"); - } - public function routerShutdown(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) { - /* router complete - en este hook, el usuario puede hacer un control de acceso */ - var_dump("routerShutdown"); - } - public function dispatchLoopStartup(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) { - var_dump("dispatchLoopStartup"); - } - public function preDispatch(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) { - var_dump("preDispatch"); - } - public function postDispatch(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) { - var_dump("postDispatch"); - } - public function dispatchLoopShutdown(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) { - /* último hook - en este hook el usuario puede hacer el registro o implementar el diseño */ - var_dump("dispatchLoopShutdown"); - } - } - - Class IndexController extends Yaf_Controller_Abstract { - public function indexAction() { - return FALSE; //prevent rendering - } - } - - $config = array( - "application" => array( - "directory" => dirname(__FILE__) . "/application/", - ), - ); - - $app = new Yaf_Application($config); - $app->bootstrap()->run(); -?> -]]> - - &example.outputs.similar; - - - - -
    - -
    - &reftitle.classsynopsis; - - - - Yaf_Plugin_Abstract - - - - - Yaf_Plugin_Abstract - - - - - &Methods; - - - - -
    - -
    - - &reference.yaf.entities.yaf-plugin-abstract; - -
    - - diff --git a/reference/yaf/yaf-registry.xml b/reference/yaf/yaf-registry.xml deleted file mode 100644 index dcc9ce9a0f..0000000000 --- a/reference/yaf/yaf-registry.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - La clase Yaf_Registry - Yaf_Registry - - - - -
    - &reftitle.intro; - - Yaf_Registry es un almacén global de clave-valor. - Todos sus métodos son estáticos, lo que lo hace universalmente accesible y - proporciona la capacidad de obtener o establecer cualquier dato - personalizado desde cualquier parte del código cuando sea necesario. - - - Normalmente se usa para mantener objetos inicializados en el Bootstrap - (una conexión a base de datos, un registrador, la configuración - compartida) de modo que los controladores, acciones y plugins puedan - recuperarlos sin pasarlos como parámetros. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Registry - - - - - Yaf_Registry - - - - &Properties; - - static - _instance - - - protected - _entries - - - &Methods; - - - - - -
    - - -
    - &reftitle.properties; - - - _instance - - - - - - _entries - - - - - -
    - - -
    - - &reference.yaf.entities.yaf-registry; - -
    - - diff --git a/reference/yaf/yaf-request-abstract.xml b/reference/yaf/yaf-request-abstract.xml deleted file mode 100644 index 9a0505fe6e..0000000000 --- a/reference/yaf/yaf-request-abstract.xml +++ /dev/null @@ -1,233 +0,0 @@ - - - - - - La clase Yaf_Request_Abstract - Yaf_Request_Abstract - - - - -
    - &reftitle.intro; - - Yaf_Request_Abstract es la clase base de los - objetos de petición. Encapsula el entorno de la petición: el módulo, - el controlador y la acción resueltos por el enrutamiento, los parámetros - de la petición y accesores para las superglobales (cadena de consulta, - POST, cookie, servidor, entorno y ficheros subidos). - - - Se proporcionan dos implementaciones concretas: - Yaf_Request_Http, inicializada desde una petición - web real, y Yaf_Request_Simple, una petición - sintética usada en pruebas y scripts CLI. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Request_Abstract - - - - - Yaf_Request_Abstract - - - - &Constants; - - const - string - Yaf_Request_Abstract::SCHEME_HTTP - http - - - const - string - Yaf_Request_Abstract::SCHEME_HTTPS - https - - - &Properties; - - public - module - - - public - controller - - - public - action - - - public - method - - - protected - params - - - protected - language - - - protected - _exception - - - protected - _base_uri - - - protected - uri - - - protected - dispatched - - - protected - routed - - - &Methods; - - - - -
    - - -
    - &reftitle.properties; - - - module - - - - - - controller - - - - - - action - - - - - - method - - - - - - params - - - - - - language - - - - - - _exception - - - - - - _base_uri - - - - - - uri - - - - - - dispatched - - - - - - routed - - - - - -
    - - - -
    - &reftitle.constants; - - - - Yaf_Request_Abstract::SCHEME_HTTP - - - - - - - Yaf_Request_Abstract::SCHEME_HTTPS - - - - - - -
    - - -
    - - &reference.yaf.entities.yaf-request-abstract; - -
    - - diff --git a/reference/yaf/yaf-request-http.xml b/reference/yaf/yaf-request-http.xml deleted file mode 100644 index c3b7cf9206..0000000000 --- a/reference/yaf/yaf-request-http.xml +++ /dev/null @@ -1,171 +0,0 @@ - - - - - - La clase Yaf_Request_Http - Yaf_Request_Http - - - - -
    - &reftitle.intro; - - Cualquier petición de un cliente se inicializa como un - Yaf_Request_Http. - Se puede obtener la información de la petición, como la consulta de URI y - los parámetros de POST, mediante los métodos de esta clase. - - - Por seguridad, $_GET/$_POST son de solo lectura en Yaf, lo que significa - que si se establece un valor en estas variables globales, este no se podrá obtener desde - Yaf_Request_Http::getQuery o - Yaf_Request_Http::getPost. - - - Aunque si fuera necesaria tal característica, como en las pruebas unitarias, - Yaf se puede construir con --enable-yaf-debug, la cual permite a Yaf leer el - valor establecido por el usuario mediante script. - - - En tal caso, Yaf lanzará un aviso E_STRICT para recordarlo: - Strict Standards: you are running yaf in debug mode - - - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Request_Http - - - - - Yaf_Request_Http - - - - extends - Yaf_Request_Abstract - - - - &Properties; - - &Methods; - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.properties; - - - module - - - - - - controller - - - - - - action - - - - - - method - - - - - - params - - - - - - language - - - - - - _exception - - - - - - _base_uri - - - - - - uri - - - - - - dispatched - - - - - - routed - - - - - -
    - - -
    - - &reference.yaf.entities.yaf-request-http; - -
    - - diff --git a/reference/yaf/yaf-request-simple.xml b/reference/yaf/yaf-request-simple.xml deleted file mode 100644 index b0a6dd2f2d..0000000000 --- a/reference/yaf/yaf-request-simple.xml +++ /dev/null @@ -1,189 +0,0 @@ - - - - - - La clase Yaf_Request_Simple - Yaf_Request_Simple - - - - -
    - &reftitle.intro; - - Yaf_Request_Simple se utiliza en particular para propósitos - de pruebas. Es decir, simula alguna petición especial bajo el modo CLI. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Request_Simple - - - - - Yaf_Request_Simple - - - - extends - Yaf_Request_Abstract - - - - &Constants; - - const - string - Yaf_Request_Simple::SCHEME_HTTP - http - - - const - string - Yaf_Request_Simple::SCHEME_HTTPS - https - - - &Properties; - - &Methods; - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.properties; - - - module - - - - - - controller - - - - - - action - - - - - - method - - - - - - params - - - - - - language - - - - - - _exception - - - - - - _base_uri - - - - - - uri - - - - - - dispatched - - - - - - routed - - - - - -
    - - - -
    - &reftitle.constants; - - - - Yaf_Request_Simple::SCHEME_HTTP - - - - - - - Yaf_Request_Simple::SCHEME_HTTPS - - - - - - -
    - - -
    - - &reference.yaf.entities.yaf-request-simple; - -
    - - diff --git a/reference/yaf/yaf-response-abstract.xml b/reference/yaf/yaf-response-abstract.xml deleted file mode 100644 index 6cdab5a92e..0000000000 --- a/reference/yaf/yaf-response-abstract.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - La clase Yaf_Response_Abstract - Yaf_Response_Abstract - - - - -
    - &reftitle.intro; - - Yaf_Response_Abstract es la clase base del objeto - de respuesta, que contiene las cabeceras y los bloques de contenido a - enviar al cliente. Es instanciada por - Yaf_Dispatcher; se accede a ella con - Yaf_Dispatcher::getResponse, normalmente dentro - de controladores, acciones o plugins. - - - Las subclases concretas son Yaf_Response_Http - (usada en SAPIs web, que envía realmente las cabeceras HTTP) y - Yaf_Response_Cli (usada en línea de comandos). - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Response_Abstract - - - - - Yaf_Response_Abstract - - - - &Constants; - - const - string - Yaf_Response_Abstract::DEFAULT_BODY - "content" - - - &Properties; - - protected - _header - - - protected - _body - - - protected - _sendheader - - - &Methods; - - - - - -
    - - -
    - &reftitle.properties; - - - _header - - - Las cabeceras HTTP establecidas hasta el momento, como un array de - pares nombre/valor de cabecera. Solo tiene sentido para - Yaf_Response_Http. - - - - - _body - - - Los bloques de contenido, indexados por la clave del contenido (por - omisión content, es decir - Yaf_Response_Abstract::DEFAULT_BODY). - - - - - _sendheader - - - Si las cabeceras deben enviarse junto con el contenido. En - Yaf_Response_Http también registra si las - cabeceras ya se han enviado. - - - - -
    - - -
    - - &reference.yaf.entities.yaf-response-abstract; - -
    - - diff --git a/reference/yaf/yaf-response-cli.xml b/reference/yaf/yaf-response-cli.xml deleted file mode 100644 index b6a3524f03..0000000000 --- a/reference/yaf/yaf-response-cli.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - La clase Yaf_Response_Cli - Yaf_Response_Cli - - - - -
    - &reftitle.intro; - - Yaf_Response_Cli es el adaptador de respuesta usado - para las peticiones de línea de órdenes (CLI). A diferencia de su homólogo - HTTP, no envía cabeceras, sino que simplemente acumula el cuerpo de la - respuesta y lo muestra directamente cuando termina el ciclo de despacho. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Response_Cli - - - - - Yaf_Response_Cli - - - - extends - Yaf_Response_Abstract - - - - &Properties; - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.properties; - - - _header - - - - - - _body - - - - - - _sendheader - - - - - -
    - - -
    - -
    - - diff --git a/reference/yaf/yaf-response-http.xml b/reference/yaf/yaf-response-http.xml deleted file mode 100644 index c52b01e32a..0000000000 --- a/reference/yaf/yaf-response-http.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - La clase Yaf_Response_Http - Yaf_Response_Http - - - - -
    - &reftitle.intro; - - Yaf_Response_Http es el adaptador de respuesta - usado para las peticiones web. Acumula las cabeceras y el cuerpo - establecidos durante el ciclo de despacho y los envía al cliente cuando el - despacho termina, salvo que - Yaf_Dispatcher::returnResponse esté activado. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Response_Http - - - - - Yaf_Response_Http - - - - extends - Yaf_Response_Abstract - - - - &Properties; - - protected - _sendheader - - - protected - _response_code - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.properties; - - - _header - - - - - - _body - - - - - - _sendheader - - - - - - _response_code - - - - - -
    - - -
    - -
    - - diff --git a/reference/yaf/yaf-route-interface.xml b/reference/yaf/yaf-route-interface.xml deleted file mode 100644 index 66869c4d0d..0000000000 --- a/reference/yaf/yaf-route-interface.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - La clase Yaf_Route_Interface - Yaf_Route_Interface - - - - -
    - &reftitle.intro; - - Yaf_Route_Interface define el contrato que toda - ruta debe implementar: Yaf_Route_Interface::route, - que inspecciona la petición y la reclama estableciendo el módulo, el - controlador y la acción (y opcionalmente los parámetros de la petición), y - Yaf_Route_Interface::assemble, que construye una - URL a partir de la información de la ruta. - - - Implemente esta interfaz para definir una ruta personalizada y regístrela - en el router con Yaf_Router::addRoute. Las - clases de ruta integradas - (Yaf_Route_Static, - Yaf_Route_Simple, - Yaf_Route_Supervar, - Yaf_Route_Rewrite, - Yaf_Route_Regex y - Yaf_Route_Map) todas la implementan. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Route_Interface - - - - - Yaf_Route_Interface - - - - - &Methods; - - - - -
    - -
    - - &reference.yaf.entities.yaf-route-interface; - -
    - - diff --git a/reference/yaf/yaf-route-map.xml b/reference/yaf/yaf-route-map.xml deleted file mode 100644 index a4ae81a7b8..0000000000 --- a/reference/yaf/yaf-route-map.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - La clase Yaf_Route_Map - Yaf_Route_Map - - - - -
    - &reftitle.intro; - - Yaf_Route_Map es una ruta integrada que convierte - todo el extremo del URI (la parte que va después del URI base; véase - Yaf_Request_Abstract::setBaseUri) en un único - nombre de controlador o de acción, según el primer argumento pasado a - Yaf_Route_Map::__construct. Los segmentos de la - ruta se unen con guiones bajos: - - - A => A - A/B/C => A_B_C - A/B/C/D/E => A_B_C_D_E - - - Cuando el mapeo va a un nombre de controlador, su primera letra se - convierte a mayúscula. - - - Si se especifica el segundo argumento de - Yaf_Route_Map::__construct, solo la parte del - URI anterior al delimitador se usa para el enrutamiento, mientras que la - parte posterior se analiza como parámetros de la petición (véase la - sección de ejemplos de Yaf_Route_Map::__construct). - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Route_Map - - - - - Yaf_Route_Map - - - - Yaf_Route_Interface - - - - &Properties; - - protected - _ctl_router - - - protected - _delimiter - - - &Methods; - - - - - -
    - - -
    - &reftitle.properties; - - - _ctl_router - - - - - - _delimiter - - - - - -
    - - -
    - - &reference.yaf.entities.yaf-route-map; - -
    - - diff --git a/reference/yaf/yaf-route-regex.xml b/reference/yaf/yaf-route-regex.xml deleted file mode 100644 index c8ecb0bd6b..0000000000 --- a/reference/yaf/yaf-route-regex.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - La clase Yaf_Route_Regex - Yaf_Route_Regex - - - - -
    - &reftitle.intro; - - Yaf_Route_Regex es la ruta más flexible entre - las rutas integradas de Yaf: hace coincidir el URI de la petición con - una expresión regular. Cuando el patrón coincide, se usan el módulo, el - controlador y la acción por omisión, y los subpatrones capturados se - asignan a los parámetros de la petición mediante un mapa numérico. - - - Es similar a Yaf_Route_Rewrite, pero en lugar de - un patrón amigable para humanos acepta un patrón PCRE completo, lo que - le permite expresar reglas de coincidencia que las demás rutas integradas - no pueden. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Route_Regex - - - - - Yaf_Route_Regex - - - - extends - Yaf_Route_Interface - - - - Yaf_Route_Interface - - - - &Properties; - - protected - _route - - - protected - _default - - - protected - _maps - - - protected - _verify - - - &Methods; - - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.properties; - - - _route - - - - - - _default - - - - - - _maps - - - - - - _verify - - - - - -
    - - -
    - - &reference.yaf.entities.yaf-route-regex; - -
    - - diff --git a/reference/yaf/yaf-route-rewrite.xml b/reference/yaf/yaf-route-rewrite.xml deleted file mode 100644 index b929c34c50..0000000000 --- a/reference/yaf/yaf-route-rewrite.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - La clase Yaf_Route_Rewrite - Yaf_Route_Rewrite - - - - -
    - &reftitle.intro; - - Yaf_Route_Rewrite es una ruta integrada que - asigna un patrón de ruta fijo a un módulo, un controlador y una acción. - El patrón puede contener marcadores de posición con nombre - (:nombre, cuyo valor se establece como parámetro de - la petición) y un comodín final * que captura los - segmentos restantes como pares clave/valor. - - - Para su uso, véase la sección de ejemplos de - Yaf_Route_Rewrite::__construct. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Route_Rewrite - - - - - Yaf_Route_Rewrite - - - - extends - Yaf_Route_Interface - - - - Yaf_Route_Interface - - - - &Properties; - - protected - _route - - - protected - _default - - - protected - _verify - - - &Methods; - - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.properties; - - - _route - - - - - - _default - - - - - - _verify - - - - - -
    - - -
    - - &reference.yaf.entities.yaf-route-rewrite; - -
    - - diff --git a/reference/yaf/yaf-route-simple.xml b/reference/yaf/yaf-route-simple.xml deleted file mode 100644 index c089dfdae3..0000000000 --- a/reference/yaf/yaf-route-simple.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - La clase Yaf_Route_Simple - Yaf_Route_Simple - - - - -
    - &reftitle.intro; - - Yaf_Route_Simple resuelve la información de la - ruta a partir de la cadena de consulta. Solo es necesario indicarle qué - clave de $_GET es el módulo, cuál es el controlador y - cuál es la acción. - - - Yaf_Route_Simple::route reclama la petición - (devuelve &true;) en cuanto al menos una de esas claves está presente en - la cadena de consulta, por lo que las rutas registradas después en la - pila no se intentarán para dicha petición. Solo pasa (devuelve &false;) - cuando ninguna de las claves configuradas aparece. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Route_Simple - - - - - Yaf_Route_Simple - - - - Yaf_Route_Interface - - - - &Properties; - - protected - controller - - - protected - module - - - protected - action - - - &Methods; - - - - - -
    - - -
    - &reftitle.properties; - - - controller - - - - - - module - - - - - - action - - - - - -
    - - -
    - - &reference.yaf.entities.yaf-route-simple; - -
    - - diff --git a/reference/yaf/yaf-route-static.xml b/reference/yaf/yaf-route-static.xml deleted file mode 100644 index b5311fef79..0000000000 --- a/reference/yaf/yaf-route-static.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - La clase Yaf_Route_Static - Yaf_Route_Static - - - - -
    - &reftitle.intro; - - Yaf_Route_Static es la ruta por omisión de - Yaf_Router: analiza la ruta del URI como segmentos - /módulo/controlador/acción y está diseñada para - satisfacer la mayoría de las necesidades de enrutamiento sin configuración - adicional. - - - - No es necesario instanciar un Yaf_Route_Static, - ni añadirlo a la pila de rutas de Yaf_Router: - siempre hay uno presente en la pila y siempre se intenta el último. - - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Route_Static - - - - - Yaf_Route_Static - - - - Yaf_Router - - - - - &Methods; - - - - -
    - -
    - - &reference.yaf.entities.yaf-route-static; - -
    - - diff --git a/reference/yaf/yaf-route-supervar.xml b/reference/yaf/yaf-route-supervar.xml deleted file mode 100644 index 4cbc09c110..0000000000 --- a/reference/yaf/yaf-route-supervar.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - La clase Yaf_Route_Supervar - Yaf_Route_Supervar - - - - -
    - &reftitle.intro; - - Yaf_Route_Supervar es una ruta interna que resuelve - el destino de la petición a partir de un único parámetro GET (la - supervariable). El valor de ese parámetro se analiza igual que - PATH_INFO, de modo que una petición como - /?r=/user/list se asocia al controlador - user y a la acción list cuando el - nombre de la supervariable es r. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Route_Supervar - - - - - Yaf_Route_Supervar - - - - Yaf_Route_Interface - - - - &Properties; - - protected - _var_name - - - &Methods; - - - - - -
    - - -
    - &reftitle.properties; - - - _var_name - - - - - -
    - - -
    - - &reference.yaf.entities.yaf-route-supervar; - -
    - - diff --git a/reference/yaf/yaf-router.xml b/reference/yaf/yaf-router.xml deleted file mode 100644 index c69abaf551..0000000000 --- a/reference/yaf/yaf-router.xml +++ /dev/null @@ -1,239 +0,0 @@ - - - - - - La clase Yaf_Router - Yaf_Router - - - - -
    - &reftitle.intro; - - Yaf_Router es el enrutador estándar del framework. Enrutar es - el proceso de tomar un extremo de un URI (la parte del URI que va - antes del URL base: véase Yaf_Request_Abstract::setBaseUri) - y descomponerlo en parámetros para determinar qué módulo, controlador, y - acción de ese controlador deberían recibir la petición. Estos valores de módulo, - controlador, acción y demás parámetros, son empaquetados en un - objeto Yaf_Request_Abstract que es procesado por - Yaf_Dispatcher. El enrutamiento sucede sólo una vez: cuando la petición - es recibida inicialmente y antes de que el primer controlador sea despachado. - - La clase Yaf_Router está diseñada para tener en cuenta una funcionalidad parecida a la directiva - mod_rewrite usando simples estructuras de PHP. Está basada indirectamente en el enrutamiento de - Ruby on Rails y no requiere ningún conocimiento previo de la reescritura de URL del - servidor web. Está diseñada para funcionar con una simple regla de la directiva mod_rewrite de Apache - (una de): - - Regla de reescritura para Apache - - - - - o (preferible): - - Regla de reescritura para Apache - - - - - Si se usa Lighttpd, la siguiente regla de reescritura es válida: - - Regla de reescritura para Lighttpd - - "/index.php?$1", - ".*\.(js|ico|gif|jpg|png|css|html)$" => "$0", - "" => "/index.php" -) -]]> - - - Si se usa Nginx, utilice la siguiente regla de reescritura: - - Regla de reescritura para Nginx - - - - - -
    - - -
    - Enrutamiento por omisión - - Yaf_Router comes viene preconfigurada con un enrutamiento - Yaf_Route_Static por omisión, el cual comparará URIs en la - forma de controlador/acción. Además, se puede especificar un nombre de módulo como el - primer elemento de la ruta, permitiendo URIs de la forma módulo/controlador/acción. - Finalmente, también comparará cualquier parámetro adicional añadido al URI por omisión - - controlador/acción/variable1/valor1/variable2/valor2. - - - El nombre del módulo debe estar definido en la configuración, considerando application.module="Index,Foo,Bar", - en este caso, solamente index, foo y bar pueden ser considerados como un nombre de módulo; - si no está configurado, sólo existe un nombre de módulo llamado "Index". - - - - - - Algunos ejemplos de cómo tales enrutamientos son comparados: - - Ejemplo de <classname>Yaf_Route_Static</classname> (ruta por omisión) - - array( - "modules" => "Index,Blog", - ), -); - -Solamente el controlador: -http://example/news - controller == news -Solamente la acción (al definir yaf.action_prefer=1 en php.ini) - action == news - -Un módulo inválido mapea el nombre del controlador: -http://example/foo - controller == foo - -Módulo + controlador: -http://example/blog/archive - module == blog - controller == archive - -Módulo + controlador + acción: -http://example/blog/archive/list - module == blog - controller == archive - action == list - -Módulo + controlador + acción + parámetros: -http://example/blog/archive/list/sort/alpha/date/desc - module == blog - controller == archive - action == list - sort == alpha - date == desc -]]> - - - - -
    - -
    - &reftitle.classsynopsis; - - - - Yaf_Router - - - - - Yaf_Router - - - - &Properties; - - protected - _routes - - - protected - _current - - - &Methods; - - - - - -
    - - -
    - &reftitle.properties; - - - _routes - - - Pila de rutas registradas - - - - - _current - - - Después de la fase de enrutamiento, esto indica el nombre de la ruta - a usar para enrutar la petición actual. - - Se puede obtener este nombre mediante - Yaf_Router::getCurrentRoute. - - - - -
    - - -
    - - &reference.yaf.entities.yaf-router; - -
    - - diff --git a/reference/yaf/yaf-session.xml b/reference/yaf/yaf-session.xml deleted file mode 100644 index ed4f4ed47e..0000000000 --- a/reference/yaf/yaf-session.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - La clase Yaf_Session - Yaf_Session - - - - -
    - &reftitle.intro; - - Yaf_Session es un envoltorio con espacios de - nombres alrededor del soporte nativo de sesión de PHP. Se accede a él - como singleton mediante Yaf_Session::getInstance - y trabaja directamente sobre $_SESSION: los datos de - sesión escritos a través de una interfaz son visibles en la otra. - - - Las entradas de sesión pueden ser accedidas y manipuladas mediante - sintaxis de propiedades, llamadas a métodos - (Yaf_Session::get, - Yaf_Session::set, - Yaf_Session::del, - Yaf_Session::has), acceso de array - (ArrayAccess), iteración - (Iterator) y count(). - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_Session - - - - - Yaf_Session - - - - Iterator - - - - ArrayAccess - - - - Countable - - - - &Properties; - - protected - static - _instance - - - protected - _session - - - protected - _started - - - &Methods; - - - - - -
    - - -
    - &reftitle.properties; - - - _instance - - - - - - _session - - - - - - _started - - - - - -
    - - -
    - - &reference.yaf.entities.yaf-session; - -
    - - diff --git a/reference/yaf/yaf-view-interface.xml b/reference/yaf/yaf-view-interface.xml deleted file mode 100644 index 1a4c8cb926..0000000000 --- a/reference/yaf/yaf-view-interface.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - - La clase Yaf_View_Interface - Yaf_View_Interface - - - - -
    - &reftitle.intro; - - Yaf proporciona a los desarrolladores la capacidad de usar un motor de vistas personalizado - en lugar del motor integrado Yaf_View_Simple. Hay - un ejemplo que explica cómo realizar esto, por favor, veáse - Yaf_Dispatcher::setView. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_View_Interface - - - - - Yaf_View_Interface - - - - - &Methods; - - - - -
    - -
    - - &reference.yaf.entities.yaf-view-interface; - -
    - - diff --git a/reference/yaf/yaf-view-simple.xml b/reference/yaf/yaf-view-simple.xml deleted file mode 100644 index 456a9b7919..0000000000 --- a/reference/yaf/yaf-view-simple.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - - La clase Yaf_View_Simple - Yaf_View_Simple - - - - -
    - &reftitle.intro; - - Yaf_View_Simple es el motor de plantillas incorporade de - Yaf. Es un motor de plantillas sencillo pero rápido, y sólo soporta plantillas de script - de PHP. - -
    - - -
    - &reftitle.classsynopsis; - - - - Yaf_View_Simple - - - - - Yaf_View_Simple - - - - Yaf_View_Interface - - - - &Properties; - - protected - _tpl_vars - - - protected - _tpl_dir - - - - &Methods; - - - - - -
    - - - -
    - &reftitle.properties; - - - _tpl_vars - - - - - - _tpl_dir - - - - - -
    - - - -
    - - &reference.yaf.entities.yaf-view-simple; - -
    - - diff --git a/reference/yaf/yaf_action_abstract/execute.xml b/reference/yaf/yaf_action_abstract/execute.xml deleted file mode 100644 index 9f45c80aad..0000000000 --- a/reference/yaf/yaf_action_abstract/execute.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - Yaf_Action_Abstract::execute - Punto de entrada de una acción - - - - &reftitle.description; - - abstract publicmixedYaf_Action_Abstract::execute - mixedargs - - - El usuario debería definir siempre este método para un acción, este es el punto de entrada - de la misma. - Yaf_Action_Abstract::execute podría tener argumentos. - - - El valor recuperado desde la petición no es seguro. Se debería filtrar - el trabajo antes de usarlo. - - - - - - - &reftitle.parameters; - - - args - - - - - - - - - - - &reftitle.returnvalues; - - Yaf no utiliza el valor de retorno del método de la acción; la salida se escribe directamente o la recoge el motor de vistas. - - - - - &reftitle.examples; - - Ejemplo de <function>Yaf_Action_Abstract::execute</function> - - "actions/Index.php", - ); -} -?> -]]> - - - - Ejemplo de <function>Yaf_Action_Abstract::execute</function> - -getRequest()->getParam("name")); - assert($id == $this->getRequest()->getParam("id")); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getParam - Yaf_Controller_Abstract::forward - - - - - - diff --git a/reference/yaf/yaf_action_abstract/getcontroller.xml b/reference/yaf/yaf_action_abstract/getcontroller.xml deleted file mode 100644 index 5ebc77eb08..0000000000 --- a/reference/yaf/yaf_action_abstract/getcontroller.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Yaf_Action_Abstract::getController - Recupera el objeto controlador - - - - &reftitle.description; - - publicYaf_Controller_AbstractnullYaf_Action_Abstract::getController - - - - Recupera el objeto controlador actual. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Una instancia de Yaf_Controller_Abstract - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Action_Abstract::getController</methodname> - -getController(); - var_dump($controller instanceof Yaf_Controller_Abstract); - - // por ejemplo, para llegar a su motor de vistas - $controller->getView()->assign("products", array("yaf", "php")); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Action_Abstract::getControllerName - Yaf_Controller_Abstract - - - - - - - diff --git a/reference/yaf/yaf_action_abstract/getcontrollername.xml b/reference/yaf/yaf_action_abstract/getcontrollername.xml deleted file mode 100644 index d0284ce87a..0000000000 --- a/reference/yaf/yaf_action_abstract/getcontrollername.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Yaf_Action_Abstract::getControllerName - Obtener el nombre del controlador - - - - &reftitle.description; - - public stringnullYaf_Action_Abstract::getControllerName - - - - obtener el nombre del controlador - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &string;, nombre del controlador - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Action_Abstract::getControllerName</methodname> - -getControllerName()); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Action_Abstract::getController - Yaf_Controller_Abstract::getName - - - - - - - diff --git a/reference/yaf/yaf_application/app.xml b/reference/yaf/yaf_application/app.xml deleted file mode 100644 index f38b5d2eb1..0000000000 --- a/reference/yaf/yaf_application/app.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - Yaf_Application::app - Recuperar una instancia de la clase Application - - - - &reftitle.description; - - public static Yaf_ApplicationnullYaf_Application::app - - - - Recuperar la instancia de la clase Yaf_Application. - De forma alternativa se podría utilizar el método - Yaf_Dispatcher::getApplication. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Una instancia de la clase Yaf_Application, o &null; si no se inicializó - antes ninguna instancia de Yaf_Application. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Application::app</methodname> - -bootstrap()->run(); -?> -]]> - - - - Recuperar la instancia de la aplicación desde otro sitio - -environ()); - var_dump(Yaf_Application::getInstance() === $app); - - return false; - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::getApplication - - - - - - - diff --git a/reference/yaf/yaf_application/bootstrap.xml b/reference/yaf/yaf_application/bootstrap.xml deleted file mode 100644 index 1cdb944ddf..0000000000 --- a/reference/yaf/yaf_application/bootstrap.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - Yaf_Application::bootstrap - Llamar al arranque - - - - &reftitle.description; - - public Yaf_ApplicationfalseYaf_Application::bootstrap - - - - Ejecuta un Arranque, todos los métodos definidos en el Arranque y prefijados con - "_init" serán llamados según su orden de declaración. Si no se proporciona el parámetro bootstrap, Yaf buscará - un Arranque en application.directory. - - - La clase Bootstrap debe llamarse Bootstrap y extender - Yaf_Bootstrap_Abstract. Si aún no está definida, - se carga desde Bootstrap.php en el directorio de la aplicación; - la entrada de configuración application.bootstrap sobreescribe su ubicación. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Una instancia de la clase Yaf_Application - - - - &reftitle.errors; - - Lanza un error YAF_ERR_TYPE_ERROR si la clase encontrada no es una subclase de Yaf_Bootstrap_Abstract, o una advertencia E_WARNING si el fichero de bootstrap o la clase Bootstrap no se puede encontrar. - - - - - &reftitle.examples; - - Un ejemplo de Bootstrap - - -]]> - - - - Ejemplo de <function>Yaf_Application::bootstrap</function> - -bootstrap(); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Bootstrap_Abstract - Yaf_Application::run - - - - - - - diff --git a/reference/yaf/yaf_application/clearlasterror.xml b/reference/yaf/yaf_application/clearlasterror.xml deleted file mode 100644 index 404329b815..0000000000 --- a/reference/yaf/yaf_application/clearlasterror.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Yaf_Application::clearLastError - Limpiar la información del último error - - - - &reftitle.description; - - public Yaf_ApplicationnullYaf_Application::clearLastError - - - - Limpia el código y el mensaje del último error, restableciéndolos a - 0 y a una cadena vacía. Esto resulta útil en los - gestores de errores, donde un error ya tratado no debe volver a informarse. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el Yaf_Application en caso de éxito, o &null; si la aplicación no está correctamente inicializada. - - - - - &reftitle.examples; - - Ejemplo de <function>Yaf_Application::clearLastError</function> - -clearLastError(); - var_dump(Yaf_Application::app()->getLastErrorNo()); -} - -$config = array( - "application" => array( - "directory" => "/tmp/noexiste", - "dispatcher" => array( - "throwException" => 0, //provocar un error en vez de lanzar una excepción cuando ocurra un error - ), - ), -); - -$app = new Yaf_Application($config); -$app->getDispatcher()->setErrorHandler("error_handler", E_RECOVERABLE_ERROR); -$app->run(); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Application::getLastErrorNo - Yaf_Application::getLastErrorMsg - - - - - - - diff --git a/reference/yaf/yaf_application/construct.xml b/reference/yaf/yaf_application/construct.xml deleted file mode 100644 index 81dc7dba3a..0000000000 --- a/reference/yaf/yaf_application/construct.xml +++ /dev/null @@ -1,163 +0,0 @@ - - - - - - Yaf_Application::__construct - El constructor de la clase Yaf_Application - - - - &reftitle.description; - - public Yaf_Application::__construct - stringarrayconfig - stringnullenvironnull - - - Instancia un objeto de la clase Yaf_Application. - - - - - - &reftitle.parameters; - - - config - - - La ruta de un fichero de configuración ini, o un array de configuración - - - Si es un fichero ini de configuración, debería existir una sección con el mismo nombre que una - definida por yaf.environ, la cual - es "product" por omisión. - - - Las entradas de configuración de la aplicación (y sus valores por omisión) están - documentadas en Application Configuration: - - - Y la entrada de configuración (y el valor por omisión) listada abajo: - - A ini config file example - - - - - - - - - environ - - - Qué sección se cargará como configuración final. Si no se indica, se usa - el valor de la directiva - yaf.environ. - - - - - - - - &reftitle.errors; - - Lanza una Yaf_Exception_StartupError (o genera un error YAF_ERR_STARTUP_FAILED, cuando Yaf_Dispatcher::throwException está desactivado) si ya se ha instanciado un Yaf_Application, o si la configuración no es válida. - - - - - &reftitle.examples; - - Ejemplo de <function>Yaf_Application::__construct</function> - -bootstrap()->run(); -?> -]]> - - - - Ejemplo de <function>Yaf_Application::__construct</function> - - array( - "directory" => realpath(dirname(__FILE__)) . "/application", - ), -); - -/** Yaf_Application */ -$application = new Yaf_Application($config); -$application->bootstrap()->run(); -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Config_Ini - Application Configuration - - - - - - - diff --git a/reference/yaf/yaf_application/environ.xml b/reference/yaf/yaf_application/environ.xml deleted file mode 100644 index b98097ff5c..0000000000 --- a/reference/yaf/yaf_application/environ.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Yaf_Application::environ - Recuperar el entorno - - - - &reftitle.description; - - public stringnullYaf_Application::environ - - - - Recupera el nombre del entorno de la aplicación, definido por la directiva - yaf.environ (o por el parámetro - environ del constructor), y cuyo valor por omisión - es "product". - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El nombre del entorno de la aplicación. - - - - - &reftitle.examples; - - Ejemplo de <function>Yaf_Application::environ</function> - - array( - "directory" => realpath(dirname(__FILE__)) . "/application", - ), -); - -/** Yaf_Application */ -$application = new Yaf_Application($config); -print_r($application->environ()); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/yaf/yaf_application/execute.xml b/reference/yaf/yaf_application/execute.xml deleted file mode 100644 index 87222edfc4..0000000000 --- a/reference/yaf/yaf_application/execute.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - Yaf_Application::execute - Ejecutar una llamada de retorno - - - - &reftitle.description; - - public mixedYaf_Application::execute - callablecallback - mixedargs - - - Este método normalmente se usa para ejecutar Yaf_Application en un trabajo de crontab. - Hacer el trabajo de contrab también puede usar el autocargador y el mecanismo de arranque. - - - - - &reftitle.parameters; - - - entry - - - Una llamada de retorno válida - - - - - args - - - Los parámetros de se le pasarán a la llamada de retorno - - - - - - - - &reftitle.returnvalues; - - Devuelve lo que devuelva la función de retrollamada, o &false; si la llamada a la función de retrollamada falla. - - - - - &reftitle.examples; - - Ejemplo de <function>Yaf_Application::execute</function> - - array( - "directory" => realpath(dirname(__FILE__)) . "/application", - ), -); - -/** Yaf_Application */ -$application = new Yaf_Application($config); -$application->execute("main", $argc, $argv); -?> -]]> - - &example.outputs.similar; - - - string(11) "execute.php" - [1]=> - string(3) "arg" -} -]]> - - - - - - &reftitle.seealso; - - - Yaf_Application::bootstrap - - - - - - - diff --git a/reference/yaf/yaf_application/getappdirectory.xml b/reference/yaf/yaf_application/getappdirectory.xml deleted file mode 100644 index 1cf342e915..0000000000 --- a/reference/yaf/yaf_application/getappdirectory.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - Yaf_Application::getAppDirectory - Obtener el directorio de la aplicación - - - - &reftitle.description; - - public stringnullYaf_Application::getAppDirectory - - - - Obtiene el directorio de la aplicación, bajo el cual Yaf busca los - controladores, las vistas y los módulos. Se establece mediante la entrada - de configuración application.directory, o mediante - Yaf_Application::setAppDirectory. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La ruta absoluta del directorio de la aplicación, o &null; si la aplicación - no está correctamente inicializada. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Application::getAppDirectory</methodname> - -getAppDirectory()); -var_dump(Yaf_Application::app()->getAppDirectory()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Application::setAppDirectory - - - - - - - diff --git a/reference/yaf/yaf_application/getconfig.xml b/reference/yaf/yaf_application/getconfig.xml deleted file mode 100644 index 7f4ddcbf32..0000000000 --- a/reference/yaf/yaf_application/getconfig.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - Yaf_Application::getConfig - Recuperar la instancia de configuración - - - - &reftitle.description; - - public Yaf_Config_AbstractnullYaf_Application::getConfig - - - - Recupera la instancia de Yaf_Config_Abstract que - contiene la configuración de la aplicación pasada al constructor. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Una instancia de la clase Yaf_Config_Abstract - - - - - &reftitle.examples; - - Ejemplo de <function>Yaf_Application::getConfig</function> - - array( - "directory" => realpath(dirname(__FILE__)) . "/application", - ), -); - -/** Yaf_Application */ -$application = new Yaf_Application($config); -print_r($application->getConfig()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [application] => Array - ( - [directory] => /home/laruence/local/www/htdocs/application - ) - - ) - - [_readonly:protected] => 1 -) -]]> - - - - - - - diff --git a/reference/yaf/yaf_application/getdispatcher.xml b/reference/yaf/yaf_application/getdispatcher.xml deleted file mode 100644 index d6e98b9289..0000000000 --- a/reference/yaf/yaf_application/getdispatcher.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - Yaf_Application::getDispatcher - Obtener la instancia de la clase Yaf_Dispatcher - - - - &reftitle.description; - - public Yaf_DispatchernullYaf_Application::getDispatcher - - - - Recupera la instancia de Yaf_Dispatcher que usa esta - aplicación. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La instancia de Yaf_Dispatcher, o &null; si la aplicación no está correctamente inicializada. - - - - - &reftitle.examples; - - Ejemplo de <function>Yaf_Application::getDispatcher</function> - - array( - "directory" => realpath(dirname(__FILE__)) . "/application", - ), -); - -/** Yaf_Application */ -$application = new Yaf_Application($config); -print_r($application->getDispatcher()); -?> -]]> - - &example.outputs.similar; - - Yaf_Router Object - ( - [_routes:protected] => Array - ( - [_default] => Yaf_Route_Static Object - ( - ) - - ) - - [_current:protected] => - ) - - [_view:protected] => - [_request:protected] => Yaf_Request_Http Object - ( - [method] => Cli - ) - - [_plugins:protected] => Array - ( - ) - - [_auto_render:protected] => 1 - [_return_response:protected] => - [_instantly_flush:protected] => 1 - [_default_module:protected] => Index - [_default_controller:protected] => Index - [_default_action:protected] => index -) -]]> - - - - - - - diff --git a/reference/yaf/yaf_application/getlasterrormsg.xml b/reference/yaf/yaf_application/getlasterrormsg.xml deleted file mode 100644 index 1eb9f07c3d..0000000000 --- a/reference/yaf/yaf_application/getlasterrormsg.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - Yaf_Application::getLastErrorMsg - Obtener el mensaje del último error ocurrido - - - - &reftitle.description; - - public stringnullYaf_Application::getLastErrorMsg - - - - Obtiene el mensaje del último error ocurrido durante el despacho. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El mensaje del último error producido, una cadena vacía si todavía no se ha - producido ningún error, o &null; si la aplicación no está correctamente - inicializada. - - - - - &reftitle.examples; - - Ejemplo de <function>Yaf_Application::getLastErrorMsg</function> - -getLastErrorMsg()); -} - -$config = array( - "application" => array( - "directory" => "/tmp/notexists", - "dispatcher" => array( - "throwException" => 0, //provocar un error en lugar de lanzar una excepción cuando ocurra un error - ), - ), -); - -$app = new Yaf_Application($config); -$app->getDispatcher()->setErrorHandler("error_handler", E_RECOVERABLE_ERROR); -$app->run(); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Application::getLastErrorNo - Yaf_Application::clearLastError - - - - - - - diff --git a/reference/yaf/yaf_application/getlasterrorno.xml b/reference/yaf/yaf_application/getlasterrorno.xml deleted file mode 100644 index 4d62c0940c..0000000000 --- a/reference/yaf/yaf_application/getlasterrorno.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Yaf_Application::getLastErrorNo - Pbetner el código del último error ocurrido - - - - &reftitle.description; - - public intnullYaf_Application::getLastErrorNo - - - - Obtiene el código del último error ocurrido durante el despacho, una de las - constantes YAF_ERR_*. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El código del último error producido, 0 si todavía no se - ha producido ningún error, o &null; si la aplicación no está correctamente - inicializada. - - - - &reftitle.examples; - - Ejemplo de <function>Yaf_Application::getLastErrorNo</function> - -getLastErrorNo()); - var_dump(Yaf_Application::app()->getLastErrorNo() == YAF_ERR_NOTFOUND_CONTROLLER); -} - -$config = array( - "application" => array( - "directory" => "/tmp/notexists", - "dispatcher" => array( - "throwException" => 0, //provocar un error en lugar de lanzar una excepción cuando ocurra un error - ), - ), -); - -$app = new Yaf_Application($config); -$app->getDispatcher()->setErrorHandler("error_handler", E_RECOVERABLE_ERROR); -$app->run(); -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/yaf/yaf_application/getmodules.xml b/reference/yaf/yaf_application/getmodules.xml deleted file mode 100644 index 8e9e8fc9a1..0000000000 --- a/reference/yaf/yaf_application/getmodules.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - Yaf_Application::getModules - Obtener los nombres de los modulos definidos - - - - &reftitle.description; - - public arraynullYaf_Application::getModules - - - - Obtiene los nombres de los módulos definidos en la entrada de configuración - application.modules. Si no - se ha definido ninguno, siempre habrá un único módulo llamado - "Index". - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un array de nombres de módulos, o &null; si la aplicación no está - correctamente inicializada. - - - - - &reftitle.examples; - - Ejemplo de <function>Yaf_Application::getModules</function> - - array( - "directory" => realpath(dirname(__FILE__)) . "/application", - ), -); - -/** Yaf_Application */ -$application = new Yaf_Application($config); -print_r($application->getModules()); -?> -]]> - - &example.outputs.similar; - - Index -) -]]> - - - - - - - diff --git a/reference/yaf/yaf_application/run.xml b/reference/yaf/yaf_application/run.xml deleted file mode 100644 index b1575df455..0000000000 --- a/reference/yaf/yaf_application/run.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - Yaf_Application::run - Iniciar una instancia de la clase Yaf_Application - - - - &reftitle.description; - - public Yaf_Response_AbstractfalseYaf_Application::run - - - - Ejecuta una instancia de la clase Yaf_Application, permite a esta instancia aceptar una petición, y enviar - dicha petición, despacha el controlador/acción, e renderiza la respuesta. Finalmente - devuelve la respuesta al cliente. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el Yaf_Response_Abstract en caso de éxito, o &false; en caso de error (por ejemplo si la aplicación ya está en ejecución). - - - - &reftitle.errors; - - Lanza un error YAF_ERR_STARTUP_FAILED si la aplicación ya estaba iniciada. - - - - - &reftitle.examples; - - Ejemplo de <function>Yaf_Application::run</function> - -bootstrap()->run(); -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Application::bootstrap - Yaf_Dispatcher::dispatch - - - - - - - diff --git a/reference/yaf/yaf_application/setappdirectory.xml b/reference/yaf/yaf_application/setappdirectory.xml deleted file mode 100644 index 4dc54df0ec..0000000000 --- a/reference/yaf/yaf_application/setappdirectory.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - Yaf_Application::setAppDirectory - Cambiar el directorio de la aplicación - - - - &reftitle.description; - - public Yaf_ApplicationnullfalseYaf_Application::setAppDirectory - stringdirectory - - - Cambia el directorio de la aplicación, bajo el cual Yaf busca los - controladores, las vistas y los módulos. El nuevo directorio debe ser una - ruta absoluta. - - - - - - &reftitle.parameters; - - - directory - - - La ruta absoluta del nuevo directorio de la aplicación. - - - - - - - - &reftitle.returnvalues; - - Devuelve el Yaf_Application en caso de éxito, &false; si directory está vacío o no es una ruta absoluta, o &null; si la aplicación no está correctamente inicializada. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Application::setAppDirectory</methodname> - -setAppDirectory("/srv/legacy/mvc/app")); -var_dump($app->getAppDirectory()); - -/* una ruta vacía o relativa se rechaza */ -var_dump($app->setAppDirectory("")); -var_dump($app->setAppDirectory("relative/path")); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Application::getAppDirectory - - - - - - - diff --git a/reference/yaf/yaf_config_abstract/get.xml b/reference/yaf/yaf_config_abstract/get.xml deleted file mode 100644 index de03eec3e6..0000000000 --- a/reference/yaf/yaf_config_abstract/get.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - Yaf_Config_Abstract::get - Consultor - - - - &reftitle.description; - - public mixedYaf_Config_Abstract::get - stringnameNULL - - - Recupera un valor de configuración por su nombre. Si se omite - name o es &null;, se devuelve el propio objeto de - configuración, que puede usarse para iterar sobre todos los valores. - - - - - - &reftitle.parameters; - - - name - - La clave de configuración. Se puede usar la notación de puntos (p.ej. database.host) para acceder a valores anidados. - - - - - - - &reftitle.returnvalues; -El valor asociado con name. Los arrays se envuelven en un Yaf_Config_Abstract. Devuelve &null; si la clave no existe, o la configuración completa si name es &null;. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Config_Abstract::get</methodname> - -get('database.host'), "\n"; - -$simple = new Yaf_Config_Simple([ - 'database' => ['host' => '127.0.0.1'], -]); - -// Array values are exposed as Yaf_Config_Abstract instances -echo $simple->get('database')->host, "\n"; - -var_dump($config->get('missing.key')); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Abstract::set - Yaf_Config_Ini::get - Yaf_Config_Simple::get - - - - - - diff --git a/reference/yaf/yaf_config_abstract/readonly.xml b/reference/yaf/yaf_config_abstract/readonly.xml deleted file mode 100644 index 2a72d07324..0000000000 --- a/reference/yaf/yaf_config_abstract/readonly.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Yaf_Config_Abstract::readonly - Buscar si una configuración es de sólo lectura - - - - &reftitle.description; - - abstract public boolYaf_Config_Abstract::readonly - - - - Comprueba si la configuración es de solo lectura. Este método es abstracto - y debe implementarse en las subclases. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -Devuelve &true; si la configuración es de solo lectura, &false; en caso contrario. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Config_Abstract::readonly</methodname> - -readonly()); // Yaf_Config_Ini is always read-only - -$writable = new Yaf_Config_Simple(['env' => 'development']); -var_dump($writable->readonly()); - -$frozen = new Yaf_Config_Simple(['env' => 'development'], true); -var_dump($frozen->readonly()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Abstract::set - Yaf_Config_Ini::readonly - Yaf_Config_Simple::readonly - - - - - - diff --git a/reference/yaf/yaf_config_abstract/set.xml b/reference/yaf/yaf_config_abstract/set.xml deleted file mode 100644 index 5926bb9498..0000000000 --- a/reference/yaf/yaf_config_abstract/set.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - Yaf_Config_Abstract::set - Modificador - - - - &reftitle.description; - - abstract public boolYaf_Config_Abstract::set - stringname - mixedvalue - - - Establece un valor de configuración. Este método es abstracto y debe - implementarse en las subclases. Las configuraciones de solo lectura - rechazan las modificaciones. - - - - - - &reftitle.parameters; - - - name - - La clave de configuración a establecer. - - - - value - - El valor a asignar. - - - - - - - &reftitle.returnvalues; -Devuelve &true; en caso de éxito, o &false; en caso de error (por ejemplo, cuando la configuración es de solo lectura). - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Config_Abstract::set</methodname> - - 'development']); -var_dump($config->set('env', 'production')); -echo $config->env, "\n"; - -// Las implementaciones de solo lectura rechazan la modificación -$ini = new Yaf_Config_Ini('/etc/myapp/application.ini', 'common'); -var_dump($ini->set('env', 'production')); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Abstract::get - Yaf_Config_Abstract::readonly - - - - - - diff --git a/reference/yaf/yaf_config_abstract/toarray.xml b/reference/yaf/yaf_config_abstract/toarray.xml deleted file mode 100644 index 3d78afec39..0000000000 --- a/reference/yaf/yaf_config_abstract/toarray.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Yaf_Config_Abstract::toArray - Convertir en un array - - - - &reftitle.description; - - public arrayYaf_Config_Abstract::toArray - - - - Devuelve la configuración completa como un array de PHP. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -Los datos de configuración como array, o &null; si no hay datos de configuración cargados. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Config_Abstract::toArray</methodname> - - ['name' => 'MyApp'], - 'database' => ['host' => 'localhost'], -]); - -print_r($config->toArray()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => MyApp - ) - - [database] => Array - ( - [host] => localhost - ) - -) -]]> - - - - - - &reftitle.seealso; - - Yaf_Config_Abstract::get - Yaf_Config_Ini::toArray - Yaf_Config_Simple::toArray - - - - - - diff --git a/reference/yaf/yaf_config_ini/construct.xml b/reference/yaf/yaf_config_ini/construct.xml deleted file mode 100644 index e013b22e6c..0000000000 --- a/reference/yaf/yaf_config_ini/construct.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - Yaf_Config_Ini::__construct - Constructor de Yaf_Config_Ini - - - - &reftitle.description; - - public Yaf_Config_Ini::__construct - mixedconfig_file - stringsectionNULL - - - El constructor de Yaf_Config_Ini - - - - - &reftitle.parameters; - - - config_file - - - Ruta al fichero de configuración INI - - - - - section - - - Qué sección en cual fichero INI se quiere analizar - - - - - - - - &reftitle.returnvalues; -No se devuelve ningún valor. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Config_Ini::__construct</methodname> - -application->name, "\n"; -echo $config->database->host, "\n"; -echo $config->log->level, "\n"; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::get - Yaf_Config_Ini::set - Yaf_Config_Ini::readonly - - - - - diff --git a/reference/yaf/yaf_config_ini/count.xml b/reference/yaf/yaf_config_ini/count.xml deleted file mode 100644 index 02b1dfb1f4..0000000000 --- a/reference/yaf/yaf_config_ini/count.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Yaf_Config_Ini::count - Contar todos los elementos en Yaf_Config.ini - - - - &reftitle.description; - - public intYaf_Config_Ini::count - - - - Devuelve el número de entradas de configuración de primer nivel. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -El número de entradas de primer nivel, como entero. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Config_Ini::count</methodname> - -count()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::get - Yaf_Config_Ini::toArray - - - - - - diff --git a/reference/yaf/yaf_config_ini/current.xml b/reference/yaf/yaf_config_ini/current.xml deleted file mode 100644 index d2271e3687..0000000000 --- a/reference/yaf/yaf_config_ini/current.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Yaf_Config_Ini::current - Recuperar el valor actual - - - - &reftitle.description; - - public mixedYaf_Config_Ini::current - - - - Devuelve el valor de la entrada de configuración actual durante la - iteración. Los valores de tipo array se envuelven en un objeto - Yaf_Config_Abstract. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -El valor de la entrada actual, o &false; si la posición no es válida. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Config_Ini::current</methodname> - -rewind(); -while ($config->valid()) { - $value = $config->current(); - if ($value instanceof Yaf_Config_Abstract) { - echo $config->key(), " => \n"; - } else { - echo $config->key(), " => ", $value, "\n"; - } - $config->next(); -} -?> -]]> - - &example.outputs.similar; - - -version => 1.0 -]]> - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::key - Yaf_Config_Ini::next - Yaf_Config_Ini::rewind - Yaf_Config_Ini::valid - - - - - - diff --git a/reference/yaf/yaf_config_ini/get.xml b/reference/yaf/yaf_config_ini/get.xml deleted file mode 100644 index 0e0ea192e4..0000000000 --- a/reference/yaf/yaf_config_ini/get.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - Yaf_Config_Ini::__get - Recuperar un elemento - - - - &reftitle.description; - - public mixedYaf_Config_Ini::get - stringnameNULL - - - Recupera un valor de configuración por su nombre. Puede usarse la notación - de punto (por ejemplo database.host) para acceder a - valores anidados. Si se omite name o es &null;, se - devuelve el propio objeto de configuración. - - - - - - &reftitle.parameters; - - - name - - - La clave de configuración, opcionalmente usando la notación de punto - para el acceso anidado. - - - - - - - - &reftitle.returnvalues; -El valor asociado con name. Los arrays se envuelven en un Yaf_Config_Ini. Devuelve &null; si la clave no existe, o la configuración completa si name es &null;. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Config_Ini::get</methodname> - -get('database.host'), "\n"; - -// Array values are wrapped in a Yaf_Config_Ini object -echo $config->get('database')->port, "\n"; - -// Sin argumento: se devuelve el propio objeto de configuración -echo $config->get()->application->name, "\n"; - -var_dump($config->get('missing.key')); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::set - Yaf_Config_Ini::toArray - - - - - - diff --git a/reference/yaf/yaf_config_ini/isset.xml b/reference/yaf/yaf_config_ini/isset.xml deleted file mode 100644 index 27a613e59d..0000000000 --- a/reference/yaf/yaf_config_ini/isset.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - Yaf_Config_Ini::__isset - Determinar si existe una clave - - - - &reftitle.description; - - public boolYaf_Config_Ini::__isset - stringname - - - Comprueba si existe una clave de configuración. Este método se invoca - cuando se usa isset sobre un objeto de configuración. - - - - - - &reftitle.parameters; - - - name - - - La clave de configuración a comprobar. - - - - - - - - &reftitle.returnvalues; -Devuelve &true; si the key exists, &false; en caso contrario. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Config_Ini::__isset</methodname> - -database)); -var_dump($config->__isset('database')); -var_dump(isset($config->cache)); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::get - Yaf_Config_Ini::offsetExists - - - - - - diff --git a/reference/yaf/yaf_config_ini/key.xml b/reference/yaf/yaf_config_ini/key.xml deleted file mode 100644 index 4617f7e2f7..0000000000 --- a/reference/yaf/yaf_config_ini/key.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - Yaf_Config_Ini::key - Buscar la clave del elemento actual - - - - &reftitle.description; - - public mixedYaf_Config_Ini::key - - - - Devuelve la clave de la entrada de configuración actual durante la - iteración. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -La clave de la entrada actual (cadena o entero), o &false; si la posición no es válida. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Config_Ini::key</methodname> - -rewind(); $config->valid(); $config->next()) { - echo $config->key(), "\n"; -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::current - Yaf_Config_Ini::next - Yaf_Config_Ini::rewind - Yaf_Config_Ini::valid - - - - - - diff --git a/reference/yaf/yaf_config_ini/next.xml b/reference/yaf/yaf_config_ini/next.xml deleted file mode 100644 index 94931b91a7..0000000000 --- a/reference/yaf/yaf_config_ini/next.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Yaf_Config_Ini::next - Avanzar el puntero interno - - - - &reftitle.description; - - public voidYaf_Config_Ini::next - - - - Desplaza el iterador interno a la siguiente entrada de configuración. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -No se devuelve ningún valor. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Config_Ini::next</methodname> - -rewind(); -echo $config->key(), "\n"; - -$config->next(); -echo $config->key(), "\n"; - -$config->next(); // past the last entry -var_dump($config->valid()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::current - Yaf_Config_Ini::key - Yaf_Config_Ini::rewind - Yaf_Config_Ini::valid - - - - - - diff --git a/reference/yaf/yaf_config_ini/offsetexists.xml b/reference/yaf/yaf_config_ini/offsetexists.xml deleted file mode 100644 index 817ef7f0c8..0000000000 --- a/reference/yaf/yaf_config_ini/offsetexists.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - Yaf_Config_Ini::offsetExists - El propósito de offsetExists - - - - &reftitle.description; - - public boolYaf_Config_Ini::offsetExists - mixedname - - - Comprueba si existe una clave de configuración. Este método es un alias de - Yaf_Config_Ini::__isset y se llama cuando se usa - isset con la sintaxis de array sobre un objeto de - configuración. - - - - - - &reftitle.parameters; - - - name - - - La clave de configuración a comprobar. - - - - - - - - &reftitle.returnvalues; -Devuelve &true; si the key exists, &false; en caso contrario. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Config_Ini::offsetExists</methodname> - -offsetExists('database')); -var_dump(isset($config['cache'])); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::get - Yaf_Config_Ini::__isset - - - - - - diff --git a/reference/yaf/yaf_config_ini/offsetget.xml b/reference/yaf/yaf_config_ini/offsetget.xml deleted file mode 100644 index 1d30a34391..0000000000 --- a/reference/yaf/yaf_config_ini/offsetget.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - Yaf_Config_Ini::offsetGet - El propósito de offsetGet - - - - &reftitle.description; - - public mixedYaf_Config_Ini::offsetGet - mixedname - - - Recupera un valor de configuración por su clave. Este método es un alias de - Yaf_Config_Ini::get y se llama cuando se usa la - sintaxis de array para leer un objeto de configuración. - - - - - - &reftitle.parameters; - - - name - - - La clave de configuración a recuperar. - - - - - - - - &reftitle.returnvalues; -El valor asociado con name, o &null; si la clave no existe. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Config_Ini::offsetGet</methodname> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::get - Yaf_Config_Ini::offsetSet - Yaf_Config_Ini::offsetUnset - - - - - - diff --git a/reference/yaf/yaf_config_ini/offsetset.xml b/reference/yaf/yaf_config_ini/offsetset.xml deleted file mode 100644 index 63aa9a2afc..0000000000 --- a/reference/yaf/yaf_config_ini/offsetset.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - Yaf_Config_Ini::offsetSet - El propósito de offsetSet - - - - &reftitle.description; - - public voidYaf_Config_Ini::offsetSet - mixedname - mixedvalue - - - Intenta establecer un valor de configuración usando la sintaxis de array. - Este método es un alias de Yaf_Config_Ini::set. - Como Yaf_Config_Ini es siempre de solo lectura, - siempre falla y emite una advertencia. - - - - - - &reftitle.parameters; - - - name - - - La clave de configuración a establecer. - - - - - value - - - El valor a asignar. - - - - - - - - &reftitle.returnvalues; -No se devuelve ningún valor. Se emite una advertencia, porque Yaf_Config_Ini es de solo lectura. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Config_Ini::offsetSet</methodname> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::set - Yaf_Config_Ini::offsetGet - Yaf_Config_Ini::readonly - - - - - - diff --git a/reference/yaf/yaf_config_ini/offsetunset.xml b/reference/yaf/yaf_config_ini/offsetunset.xml deleted file mode 100644 index 27dc162df6..0000000000 --- a/reference/yaf/yaf_config_ini/offsetunset.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - Yaf_Config_Ini::offsetUnset - El propósito de offsetUnset - - - - &reftitle.description; - - public voidYaf_Config_Ini::offsetUnset - mixedname - - - Elimina una entrada de configuración por su clave. Este método se llama - cuando se usa unset con la sintaxis de array sobre un - objeto de configuración. - - - - - - &reftitle.parameters; - - - name - - - La clave de configuración a eliminar. - - - - - - - - &reftitle.returnvalues; -No se devuelve ningún valor. Se emite una advertencia si la configuración es de solo lectura. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Config_Ini::offsetUnset</methodname> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::offsetGet - Yaf_Config_Ini::offsetSet - - - - - - diff --git a/reference/yaf/yaf_config_ini/readonly.xml b/reference/yaf/yaf_config_ini/readonly.xml deleted file mode 100644 index 57b29a8f90..0000000000 --- a/reference/yaf/yaf_config_ini/readonly.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Yaf_Config_Ini::readonly - El propósito de readonly - - - - &reftitle.description; - - public boolYaf_Config_Ini::readonly - - - - Comprueba si la configuración es de solo lectura. - Yaf_Config_Ini es siempre de solo lectura. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -Siempre devuelve &true;. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Config_Ini::readonly</methodname> - -readonly()); - -// Los intentos de escritura se rechazan (y se emite una advertencia) -var_dump($config->set('version', '2.0')); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::set - - - - - - diff --git a/reference/yaf/yaf_config_ini/rewind.xml b/reference/yaf/yaf_config_ini/rewind.xml deleted file mode 100644 index 6b68bfede6..0000000000 --- a/reference/yaf/yaf_config_ini/rewind.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - Yaf_Config_Ini::rewind - El propósito de rewind - - - - &reftitle.description; - - public voidYaf_Config_Ini::rewind - - - - Rebobina el iterador interno hasta la primera entrada de configuración. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -No se devuelve ningún valor. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Config_Ini::rewind</methodname> - -next(); -echo $config->key(), "\n"; - -$config->rewind(); -echo $config->key(), "\n"; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::current - Yaf_Config_Ini::key - Yaf_Config_Ini::next - Yaf_Config_Ini::valid - - - - - - diff --git a/reference/yaf/yaf_config_ini/set.xml b/reference/yaf/yaf_config_ini/set.xml deleted file mode 100644 index 034900b0d0..0000000000 --- a/reference/yaf/yaf_config_ini/set.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - Yaf_Config_Ini::__set - El propósito de __set - - - - &reftitle.description; - - public boolYaf_Config_Ini::set - stringname - mixedvalue - - - Intenta establecer un valor de configuración. Como - Yaf_Config_Ini es siempre de solo lectura, este - método siempre falla y emite una advertencia. - - - - - - &reftitle.parameters; - - - name - - - La clave de configuración a establecer. - - - - - value - - - El valor a asignar. - - - - - - - - &reftitle.returnvalues; -Siempre devuelve &false; y emite una advertencia, porque Yaf_Config_Ini es de solo lectura. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Config_Ini::set</methodname> - -set('database.host', '192.0.2.10')); - -echo $config->get('database.host'), "\n"; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::get - Yaf_Config_Ini::readonly - - - - - - diff --git a/reference/yaf/yaf_config_ini/toarray.xml b/reference/yaf/yaf_config_ini/toarray.xml deleted file mode 100644 index 925a076d46..0000000000 --- a/reference/yaf/yaf_config_ini/toarray.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Yaf_Config_Ini::toArray - Devuelve la configuración como un array PHP - - - - &reftitle.description; - - public arrayYaf_Config_Ini::toArray - - - - Devuelve un array de PHP desde el Yaf_Config_Ini - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -Los datos de configuración como array. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Config_Ini::toArray</methodname> - -toArray()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => MyApp - ) - - [database] => Array - ( - [host] => localhost - [port] => 3306 - ) - -) -]]> - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::get - - - - - diff --git a/reference/yaf/yaf_config_ini/valid.xml b/reference/yaf/yaf_config_ini/valid.xml deleted file mode 100644 index 13ebccfd49..0000000000 --- a/reference/yaf/yaf_config_ini/valid.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Yaf_Config_Ini::valid - El propósito de valid - - - - &reftitle.description; - - public boolYaf_Config_Ini::valid - - - - Comprueba si la posición actual del iterador es válida. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -Devuelve &true; si la posición actual es válida, &false; en caso contrario. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Config_Ini::valid</methodname> - -rewind(); -var_dump($config->valid()); - -$config->next(); -var_dump($config->valid()); - -$config->next(); // past the last entry -var_dump($config->valid()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Ini::current - Yaf_Config_Ini::key - Yaf_Config_Ini::next - Yaf_Config_Ini::rewind - - - - - - diff --git a/reference/yaf/yaf_config_simple/construct.xml b/reference/yaf/yaf_config_simple/construct.xml deleted file mode 100644 index 73ff5ce4a2..0000000000 --- a/reference/yaf/yaf_config_simple/construct.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - Yaf_Config_Simple::__construct - El propósito de __construct - - - - &reftitle.description; - - public Yaf_Config_Simple::__construct - arrayconfigs - boolreadonlyfalse - - - Crea una nueva instancia de Yaf_Config_Simple a - partir de un array de valores de configuración. - - - - - - &reftitle.parameters; - - - configs - - - Un array de valores de configuración. - - - - - readonly - - - Si la configuración debe ser de solo lectura. Por omisión, &false; - (modificable). - - - - - - - - &reftitle.returnvalues; -No se devuelve ningún valor. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Config_Simple::__construct</methodname> - - ['name' => 'MyApp', 'env' => 'production'], - 'database' => ['host' => 'localhost', 'port' => 3306], -]); - -echo $config->application->name, "\n"; -echo $config->database->host, "\n"; - -// El segundo argumento, opcional, hace que la configuración sea de solo lectura -$frozen = new Yaf_Config_Simple(['env' => 'testing'], true); -var_dump($frozen->readonly()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::get - Yaf_Config_Simple::set - Yaf_Config_Simple::readonly - - - - - - diff --git a/reference/yaf/yaf_config_simple/count.xml b/reference/yaf/yaf_config_simple/count.xml deleted file mode 100644 index 8c399427a1..0000000000 --- a/reference/yaf/yaf_config_simple/count.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - Yaf_Config_Simple::count - El propósito de count - - - - &reftitle.description; - - public intYaf_Config_Simple::count - - - - Devuelve el número de entradas de configuración de primer nivel. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -El número de entradas de primer nivel, como entero. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Config_Simple::count</methodname> - - ['name' => 'MyApp'], - 'database' => ['host' => 'localhost'], -]); - -// Solo se cuentan las entradas de primer nivel ("application" y "database") -var_dump(count($config)); -var_dump($config->count()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::get - Yaf_Config_Simple::toArray - - - - - - diff --git a/reference/yaf/yaf_config_simple/current.xml b/reference/yaf/yaf_config_simple/current.xml deleted file mode 100644 index 2798b22b65..0000000000 --- a/reference/yaf/yaf_config_simple/current.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Yaf_Config_Simple::current - El propósito de current - - - - &reftitle.description; - - public mixedYaf_Config_Simple::current - - - - Devuelve el valor de la entrada de configuración actual durante la - iteración. Los valores de tipo array se envuelven en un objeto - Yaf_Config_Abstract. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -El valor de la entrada actual, o &false; si la posición no es válida. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Config_Simple::current</methodname> - - ['name' => 'MyApp'], - 'version' => '1.0', -]); - -$config->rewind(); -while ($config->valid()) { - $value = $config->current(); - if ($value instanceof Yaf_Config_Abstract) { - echo $config->key(), " => \n"; - } else { - echo $config->key(), " => ", $value, "\n"; - } - $config->next(); -} -?> -]]> - - &example.outputs.similar; - - -version => 1.0 -]]> - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::key - Yaf_Config_Simple::next - Yaf_Config_Simple::rewind - Yaf_Config_Simple::valid - - - - - - diff --git a/reference/yaf/yaf_config_simple/get.xml b/reference/yaf/yaf_config_simple/get.xml deleted file mode 100644 index e8aa1a3c4d..0000000000 --- a/reference/yaf/yaf_config_simple/get.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Yaf_Config_Simple::__get - El propósito de __get - - - - &reftitle.description; - - public mixedYaf_Config_Simple::get - stringnameNULL - - - Recupera un valor de configuración por su nombre. Si se omite - name o es &null;, se devuelve el propio objeto de - configuración. - - - - - - &reftitle.parameters; - - - name - - - La clave de configuración a recuperar. - - - - - - - - &reftitle.returnvalues; -El valor asociado con name. Los arrays se envuelven en un Yaf_Config_Simple. Devuelve &null; si la clave no existe, o la configuración completa si name es &null;. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Config_Simple::get</methodname> - - ['name' => 'MyApp'], - 'database' => ['host' => 'localhost'], -]); - -// Array values are wrapped in a Yaf_Config_Simple object -echo $config->get('database')->host, "\n"; -echo $config->get('application')->name, "\n"; -var_dump($config->get('missing')); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::set - Yaf_Config_Simple::toArray - - - - - - diff --git a/reference/yaf/yaf_config_simple/isset.xml b/reference/yaf/yaf_config_simple/isset.xml deleted file mode 100644 index 8bf7bc23dc..0000000000 --- a/reference/yaf/yaf_config_simple/isset.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Yaf_Config_Simple::__isset - El propósito de __isset - - - - &reftitle.description; - - public boolYaf_Config_Simple::__isset - stringname - - - Comprueba si existe una clave de configuración. Este método se invoca - cuando se usa isset sobre un objeto de configuración. - - - - - - &reftitle.parameters; - - - name - - - La clave de configuración a comprobar. - - - - - - - - &reftitle.returnvalues; -Devuelve &true; si the key exists, &false; en caso contrario. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Config_Simple::__isset</methodname> - - ['name' => 'MyApp'], - 'database' => ['host' => 'localhost'], -]); - -var_dump(isset($config->application)); -var_dump($config->__isset('application')); -var_dump(isset($config->cache)); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::get - Yaf_Config_Simple::offsetExists - - - - - - diff --git a/reference/yaf/yaf_config_simple/key.xml b/reference/yaf/yaf_config_simple/key.xml deleted file mode 100644 index 1ebbd6125a..0000000000 --- a/reference/yaf/yaf_config_simple/key.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - Yaf_Config_Simple::key - El propósito de key - - - - &reftitle.description; - - public mixedYaf_Config_Simple::key - - - - Devuelve la clave de la entrada de configuración actual durante la - iteración. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -La clave de la entrada actual (cadena o entero), o &false; si la posición no es válida. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Config_Simple::key</methodname> - - ['name' => 'MyApp'], - 'database' => ['host' => 'localhost'], -]); - -for ($config->rewind(); $config->valid(); $config->next()) { - echo $config->key(), "\n"; -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::current - Yaf_Config_Simple::next - Yaf_Config_Simple::rewind - Yaf_Config_Simple::valid - - - - - - diff --git a/reference/yaf/yaf_config_simple/next.xml b/reference/yaf/yaf_config_simple/next.xml deleted file mode 100644 index 90bda5a58d..0000000000 --- a/reference/yaf/yaf_config_simple/next.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - Yaf_Config_Simple::next - El propósito de next - - - - &reftitle.description; - - public voidYaf_Config_Simple::next - - - - Desplaza el iterador interno a la siguiente entrada de configuración. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -No se devuelve ningún valor. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Config_Simple::next</methodname> - - ['name' => 'MyApp'], - 'database' => ['host' => 'localhost'], -]); - -$config->rewind(); -echo $config->key(), "\n"; - -$config->next(); -echo $config->key(), "\n"; - -$config->next(); // past the last entry -var_dump($config->valid()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::current - Yaf_Config_Simple::key - Yaf_Config_Simple::rewind - Yaf_Config_Simple::valid - - - - - - diff --git a/reference/yaf/yaf_config_simple/offsetexists.xml b/reference/yaf/yaf_config_simple/offsetexists.xml deleted file mode 100644 index da0e59b201..0000000000 --- a/reference/yaf/yaf_config_simple/offsetexists.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Yaf_Config_Simple::offsetExists - El propósito de offsetExists - - - - &reftitle.description; - - public boolYaf_Config_Simple::offsetExists - mixedname - - - Comprueba si existe una clave de configuración. Este método es un alias de - Yaf_Config_Simple::__isset y se llama cuando se - usa isset con la sintaxis de array sobre un objeto de - configuración. - - - - - - &reftitle.parameters; - - - name - - - La clave de configuración a comprobar. - - - - - - - - &reftitle.returnvalues; -Devuelve &true; si the key exists, &false; en caso contrario. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Config_Simple::offsetExists</methodname> - - ['name' => 'MyApp'], - 'database' => ['host' => 'localhost'], -]); - -var_dump(isset($config['database'])); -var_dump($config->offsetExists('database')); -var_dump(isset($config['cache'])); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::get - Yaf_Config_Simple::__isset - - - - - - diff --git a/reference/yaf/yaf_config_simple/offsetget.xml b/reference/yaf/yaf_config_simple/offsetget.xml deleted file mode 100644 index ab744e1ae0..0000000000 --- a/reference/yaf/yaf_config_simple/offsetget.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Yaf_Config_Simple::offsetGet - El propósito de offsetGet - - - - &reftitle.description; - - public mixedYaf_Config_Simple::offsetGet - mixedname - - - Recupera un valor de configuración por su clave. Este método es un alias de - Yaf_Config_Simple::get y se llama cuando se usa la - sintaxis de array para leer un objeto de configuración. - - - - - - &reftitle.parameters; - - - name - - - La clave de configuración a recuperar. - - - - - - - - &reftitle.returnvalues; -El valor asociado con name, o &null; si la clave no existe. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Config_Simple::offsetGet</methodname> - - ['name' => 'MyApp'], - 'database' => ['host' => 'localhost'], -]); - -// Array values are wrapped in a Yaf_Config_Simple object -echo $config['application']->name, "\n"; -echo $config['database']['host'], "\n"; -var_dump($config['missing']); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::get - Yaf_Config_Simple::offsetSet - Yaf_Config_Simple::offsetUnset - - - - - - diff --git a/reference/yaf/yaf_config_simple/offsetset.xml b/reference/yaf/yaf_config_simple/offsetset.xml deleted file mode 100644 index b6a40bf823..0000000000 --- a/reference/yaf/yaf_config_simple/offsetset.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - Yaf_Config_Simple::offsetSet - El propósito de offsetSet - - - - &reftitle.description; - - public voidYaf_Config_Simple::offsetSet - mixedname - mixedvalue - - - Establece un valor de configuración usando la sintaxis de array. Este - método es un alias de Yaf_Config_Simple::set. La - asignación falla silenciosamente si la configuración es de solo lectura. - - - - - - &reftitle.parameters; - - - name - - - La clave de configuración a establecer. - - - - - value - - - El valor a asignar. - - - - - - - - &reftitle.returnvalues; -No se devuelve ningún valor. La asignación falla si la configuración es de solo lectura. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Config_Simple::offsetSet</methodname> - - 'development']); - -// Writable by default -$config['env'] = 'production'; -$config['cache'] = ['enable' => true]; -echo $config['env'], "\n"; -var_dump($config['cache']['enable']); - -// Las asignaciones a una configuración de solo lectura fallan silenciosamente -$frozen = new Yaf_Config_Simple(['env' => 'development'], true); -$frozen['env'] = 'production'; -echo $frozen['env'], "\n"; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::set - Yaf_Config_Simple::offsetGet - Yaf_Config_Simple::offsetUnset - - - - - - diff --git a/reference/yaf/yaf_config_simple/offsetunset.xml b/reference/yaf/yaf_config_simple/offsetunset.xml deleted file mode 100644 index cd6d3d5b6d..0000000000 --- a/reference/yaf/yaf_config_simple/offsetunset.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - Yaf_Config_Simple::offsetUnset - El propósito de offsetUnset - - - - &reftitle.description; - - public voidYaf_Config_Simple::offsetUnset - mixedname - - - Elimina una entrada de configuración por su clave. Este método se llama - cuando se usa unset con la sintaxis de array sobre un - objeto de configuración. - - - - - - &reftitle.parameters; - - - name - - - La clave de configuración a eliminar. - - - - - - - - &reftitle.returnvalues; -No se devuelve ningún valor. Se emite una advertencia si la configuración es de solo lectura. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Config_Simple::offsetUnset</methodname> - - ['enable' => true], - 'env' => 'development', -]); - -unset($config['cache']); -var_dump(isset($config['cache'])); - -// Las configuraciones de solo lectura no se pueden modificar: se emite una advertencia -$frozen = new Yaf_Config_Simple(['env' => 'development'], true); -unset($frozen['env']); -var_dump(isset($frozen['env'])); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::offsetGet - Yaf_Config_Simple::offsetSet - - - - - - diff --git a/reference/yaf/yaf_config_simple/readonly.xml b/reference/yaf/yaf_config_simple/readonly.xml deleted file mode 100644 index 9aa2714f55..0000000000 --- a/reference/yaf/yaf_config_simple/readonly.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Yaf_Config_Simple::readonly - El propósito de readonly - - - - &reftitle.description; - - public boolYaf_Config_Simple::readonly - - - - Comprueba si la configuración es de solo lectura. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -Devuelve &true; si la configuración es de solo lectura, &false; en caso contrario. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Config_Simple::readonly</methodname> - - 'development']); -var_dump($writable->readonly()); - -$frozen = new Yaf_Config_Simple(['env' => 'development'], true); -var_dump($frozen->readonly()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::set - - - - - - diff --git a/reference/yaf/yaf_config_simple/rewind.xml b/reference/yaf/yaf_config_simple/rewind.xml deleted file mode 100644 index b42042146b..0000000000 --- a/reference/yaf/yaf_config_simple/rewind.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Yaf_Config_Simple::rewind - El propósito de rewind - - - - &reftitle.description; - - public voidYaf_Config_Simple::rewind - - - - Rebobina el iterador interno hasta la primera entrada de configuración. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -No se devuelve ningún valor. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Config_Simple::rewind</methodname> - - ['name' => 'MyApp'], - 'database' => ['host' => 'localhost'], -]); - -$config->next(); -echo $config->key(), "\n"; - -$config->rewind(); -echo $config->key(), "\n"; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::current - Yaf_Config_Simple::key - Yaf_Config_Simple::next - Yaf_Config_Simple::valid - - - - - - diff --git a/reference/yaf/yaf_config_simple/set.xml b/reference/yaf/yaf_config_simple/set.xml deleted file mode 100644 index 8cf7673c13..0000000000 --- a/reference/yaf/yaf_config_simple/set.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - Yaf_Config_Simple::__set - El propósito de __set - - - - &reftitle.description; - - public boolYaf_Config_Simple::set - stringname - mixedvalue - - - Establece un valor de configuración. Falla y devuelve &false; si la - configuración es de solo lectura. - - - - - - &reftitle.parameters; - - - name - - - La clave de configuración a establecer. - - - - - value - - - El valor a asignar. - - - - - - - - &reftitle.returnvalues; -Devuelve &true; en caso de éxito, o &false; si la configuración es de solo lectura. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Config_Simple::set</methodname> - - 'development']); - -var_dump($config->set('env', 'production')); -echo $config->env, "\n"; - -// Las configuraciones de solo lectura rechazan la modificación -$frozen = new Yaf_Config_Simple(['env' => 'development'], true); -var_dump($frozen->set('env', 'production')); -echo $frozen->env, "\n"; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::get - Yaf_Config_Simple::readonly - - - - - - diff --git a/reference/yaf/yaf_config_simple/toarray.xml b/reference/yaf/yaf_config_simple/toarray.xml deleted file mode 100644 index 42c5c8f084..0000000000 --- a/reference/yaf/yaf_config_simple/toarray.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - Yaf_Config_Simple::toArray - Devuelve un array de PHP - - - - &reftitle.description; - - public arrayYaf_Config_Simple::toArray - - - - Devuelve un array de PHP desde el Yaf_Config_Simple - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -Los datos de configuración como array. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Config_Simple::toArray</methodname> - - ['name' => 'MyApp'], - 'database' => ['host' => 'localhost', 'port' => 3306], -]); - -print_r($config->toArray()); -?> -]]> - - &example.outputs.similar; - - Array - ( - [name] => MyApp - ) - - [database] => Array - ( - [host] => localhost - [port] => 3306 - ) - -) -]]> - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::get - - - - - - diff --git a/reference/yaf/yaf_config_simple/valid.xml b/reference/yaf/yaf_config_simple/valid.xml deleted file mode 100644 index 3f91c154cd..0000000000 --- a/reference/yaf/yaf_config_simple/valid.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - Yaf_Config_Simple::valid - El propósito de valid - - - - &reftitle.description; - - public boolYaf_Config_Simple::valid - - - - Comprueba si la posición actual del iterador es válida. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -Devuelve &true; si la posición actual es válida, &false; en caso contrario. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Config_Simple::valid</methodname> - - ['name' => 'MyApp'], - 'database' => ['host' => 'localhost'], -]); - -$config->rewind(); -var_dump($config->valid()); - -$config->next(); -var_dump($config->valid()); - -$config->next(); // past the last entry -var_dump($config->valid()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Config_Simple::current - Yaf_Config_Simple::key - Yaf_Config_Simple::next - Yaf_Config_Simple::rewind - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/construct.xml b/reference/yaf/yaf_controller_abstract/construct.xml deleted file mode 100644 index 74e28ddf58..0000000000 --- a/reference/yaf/yaf_controller_abstract/construct.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - Yaf_Controller_Abstract::__construct - Constructor de Yaf_Controller_Abstract - - - - &reftitle.description; - - public Yaf_Controller_Abstract::__construct - - - - Yaf_Controller_Abstract::__construct es final, - lo que significa que no puede ser sobrescrito. - Véase en su lugar - Yaf_Controller_Abstract::init. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - No se devuelve ningún valor. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Controller_Abstract::__construct</methodname> - -getRequest() instanceof Yaf_Request_Abstract); - var_dump($this->getResponse() instanceof Yaf_Response_Abstract); - var_dump($this->getView() instanceof Yaf_View_Interface); - } - - public function indexAction() { - // ... - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::init - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/display.xml b/reference/yaf/yaf_controller_abstract/display.xml deleted file mode 100644 index a815193c1f..0000000000 --- a/reference/yaf/yaf_controller_abstract/display.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - Yaf_Controller_Abstract::display - El propósito de display - - - - &reftitle.description; - - protected boolnullYaf_Controller_Abstract::display - stringtpl - arraynullparameters - - - Renderiza el script de vista tpl y envía el - resultado directamente, a diferencia de - Yaf_Controller_Abstract::render, que en su lugar - devuelve la salida renderizada. El renderizado automático de la plantilla - de la acción por omisión se controla con - Yaf_Dispatcher::autoRender. - - - - - &reftitle.parameters; - - - tpl - - - El nombre del script de vista, relativo a la ruta de vistas. - - - - - parameters - - - Un array asociativo de variables a exportar al script de vista para este - renderizado, que tienen prioridad sobre las asignadas mediante el motor - de vistas. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; en caso de éxito, or &false; / &null; en caso de error. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Controller_Abstract::display</methodname> - -display("product/list.phtml", array( - "products" => array("yaf", "php"), - )); - } -} -?> -]]> - - - - Ejemplo de Template - - -
      - -
    • - -
    -]]> -
    - &example.outputs.similar; - - -
  • yaf
  • -
  • php
  • - -]]> -
    -
    -
    - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::render - Yaf_Dispatcher::autoRender - - - - -
    - - diff --git a/reference/yaf/yaf_controller_abstract/forward.xml b/reference/yaf/yaf_controller_abstract/forward.xml deleted file mode 100644 index 13a806bdac..0000000000 --- a/reference/yaf/yaf_controller_abstract/forward.xml +++ /dev/null @@ -1,160 +0,0 @@ - - - - - - Yaf_Controller_Abstract::forward - Avanza a la siguiente acción - - - - &reftitle.description; - - public boolnullYaf_Controller_Abstract::forward - stringaction - arraynullparameters - - - public boolnullYaf_Controller_Abstract::forward - stringcontroller - stringaction - arraynullparameters - - - public boolnullYaf_Controller_Abstract::forward - stringmodule - stringcontroller - stringaction - arraynullparameters - - - Avanza el proceso de ejecución actual a otra acción. El destino se - determina por el número y tipo de los argumentos: - - - Solo action: avanza a otra acción del controlador actual. - controller y action: avanza a otro controlador. - module, controller y action: avanza a otro módulo. - El array opcional parameters lleva argumentos de invocación recuperables con Yaf_Request_Abstract::getParam. - - - - Este método no cambia a la acción destino de inmediato; - el cambio tiene lugar después de que el flujo actual finalice. - - - - - - &reftitle.parameters; - - - module - - - El nombre del módulo destino. Si es NULL, se asume el nombre del - módulo por omisión - - - - - controller - - - El nombre del controlador destino - - - - - action - - - El nombre de la acción destino - - - - - paramters - - - Argumentos de llamada - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Ejemplo de <function>Yaf_Controller_Abstract::forward</function> - -forward("login", array("from" => "Index")); // reenvía a la acción login - return false; // esto es importante, termina el flujo actual - // y le indica a Yaf que no haga el auto-renderizado - } - - // otros procesos - } - - public function loginAction() { - echo "login, redirected from ", $this->_request->getParam("from") , " action"; - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Request_Abstract::getParam - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/getinvokearg.xml b/reference/yaf/yaf_controller_abstract/getinvokearg.xml deleted file mode 100644 index b3d0d0564e..0000000000 --- a/reference/yaf/yaf_controller_abstract/getinvokearg.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - Yaf_Controller_Abstract::getInvokeArg - El propósito de getInvokeArg - - - - &reftitle.description; - - public stringnullYaf_Controller_Abstract::getInvokeArg - stringname - - - Devuelve un único argumento de invocación de la acción actual, dado su - nombre. Los argumentos de invocación se pasan a la acción mediante - Yaf_Controller_Abstract::forward. - - - - - &reftitle.parameters; - - - name - - - El nombre del argumento de invocación a recuperar. - - - - - - - - &reftitle.returnvalues; - - El valor del argumento, o &null; si no existe. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Controller_Abstract::getInvokeArg</methodname> - -forward("profile", array("name" => "laruence")); - return false; // ends the current flow - } - - public function profileAction() { - // retrieve one invocation argument by name - var_dump($this->getInvokeArg("name")); - var_dump($this->getInvokeArg("missing")); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::getInvokeArgs - Yaf_Controller_Abstract::forward - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/getinvokeargs.xml b/reference/yaf/yaf_controller_abstract/getinvokeargs.xml deleted file mode 100644 index 8e08e9cacb..0000000000 --- a/reference/yaf/yaf_controller_abstract/getinvokeargs.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Yaf_Controller_Abstract::getInvokeArgs - El propósito de getInvokeArgs - - - - &reftitle.description; - - public arraynullYaf_Controller_Abstract::getInvokeArgs - - - - Devuelve todos los argumentos de invocación de la acción actual, como un - array indexado por el nombre del argumento. Los argumentos de invocación se - pasan a la acción mediante - Yaf_Controller_Abstract::forward. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un array de argumentos de invocación, o &null; si no se proporcionó ninguno. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Controller_Abstract::getInvokeArgs</methodname> - -forward("list", array("category" => "book", "page" => 2)); - return false; // ends the current flow - } - - public function listAction() { - // todos los argumentos de invocación de la acción actual - var_dump($this->getInvokeArgs()); - } -} -?> -]]> - - &example.outputs.similar; - - - string(4) "book" - ["page"]=> - int(2) -} -]]> - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::getInvokeArg - Yaf_Controller_Abstract::forward - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/getmodulename.xml b/reference/yaf/yaf_controller_abstract/getmodulename.xml deleted file mode 100644 index befa8d409d..0000000000 --- a/reference/yaf/yaf_controller_abstract/getmodulename.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Yaf_Controller_Abstract::getModuleName - Obtiene el nombre del módulo - - - - &reftitle.description; - - public stringnullYaf_Controller_Abstract::getModuleName - - - - Obtiene el nombre del módulo del controlador. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El nombre del módulo como &string;, o &null; si no está definido. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Controller_Abstract::getModuleName</methodname> - -getModuleName()); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::getName - Yaf_Request_Abstract::getModuleName - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/getname.xml b/reference/yaf/yaf_controller_abstract/getname.xml deleted file mode 100644 index 30b5d4551d..0000000000 --- a/reference/yaf/yaf_controller_abstract/getname.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - Yaf_Controller_Abstract::getName - Obtener el nombre propio - - - - &reftitle.description; - - public stringnullYaf_Controller_Abstract::getName - - - - obtiene el nombre del controlador - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &string;, nombre del controlador - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Controller_Abstract::getName</methodname> - -getName()); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::getModuleName - Yaf_Request_Abstract::getControllerName - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/getrequest.xml b/reference/yaf/yaf_controller_abstract/getrequest.xml deleted file mode 100644 index df56ceb42d..0000000000 --- a/reference/yaf/yaf_controller_abstract/getrequest.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Yaf_Controller_Abstract::getRequest - Recupera el objeto petición actual - - - - &reftitle.description; - - public Yaf_Request_AbstractnullYaf_Controller_Abstract::getRequest - - - - Recupera el objeto petición actual - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Una instancia de Yaf_Request_Abstract - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Controller_Abstract::getRequest</methodname> - -getRequest(); - var_dump($request->getModuleName()); - var_dump($request->getControllerName()); - var_dump($request->getActionName()); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::getResponse - Yaf_Request_Abstract - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/getresponse.xml b/reference/yaf/yaf_controller_abstract/getresponse.xml deleted file mode 100644 index 9613ba5e75..0000000000 --- a/reference/yaf/yaf_controller_abstract/getresponse.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Yaf_Controller_Abstract::getResponse - Recupera el objeto respuesta actual - - - - &reftitle.description; - - public Yaf_Response_AbstractnullYaf_Controller_Abstract::getResponse - - - - Recupera el objeto respuesta actual - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Una instancia de Yaf_Response_Abstract - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Controller_Abstract::getResponse</methodname> - -disableView(); - - $response = $this->getResponse(); - $response->setHeader("Content-Type", "application/json"); - $response->setBody(json_encode(array("name" => "yaf"))); - // Yaf envía el cuerpo cuando termina el bucle de despacho - } -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::getRequest - Yaf_Response_Abstract - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/getview.xml b/reference/yaf/yaf_controller_abstract/getview.xml deleted file mode 100644 index 7799e2a3e6..0000000000 --- a/reference/yaf/yaf_controller_abstract/getview.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Yaf_Controller_Abstract::getView - Recupera el motor de vistas - - - - &reftitle.description; - - public Yaf_View_InterfacenullYaf_Controller_Abstract::getView - - - - Recupera el motor de vistas. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A Yaf_View_Interface instancia, o &null; si no view engine is available. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Controller_Abstract::getView</methodname> - -getView(); - - // exporta $products a la plantilla product/index.phtml - $view->assign("products", array("yaf", "php")); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::initView - Yaf_View_Interface - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/getviewpath.xml b/reference/yaf/yaf_controller_abstract/getviewpath.xml deleted file mode 100644 index cbf6064a07..0000000000 --- a/reference/yaf/yaf_controller_abstract/getviewpath.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Yaf_Controller_Abstract::getViewpath - El propósito de getViewpath - - - - &reftitle.description; - - public stringnullYaf_Controller_Abstract::getViewpath - - - - Devuelve el directorio de plantillas que usa el motor de vistas asociado a - este controlador. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El directorio de plantillas de vista, como &string;. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Controller_Abstract::getViewpath</methodname> - -getViewpath()); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::setViewpath - Yaf_Controller_Abstract::initView - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/init.xml b/reference/yaf/yaf_controller_abstract/init.xml deleted file mode 100644 index 2e8ed7023b..0000000000 --- a/reference/yaf/yaf_controller_abstract/init.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - Yaf_Controller_Abstract::init - Inicializador del controlador - - - - &reftitle.description; - - public voidYaf_Controller_Abstract::init - - - - Yaf_Controller_Abstract::__construct es final, - lo que significa que los usuarios no puede sobrescribirlo, - aunque pueden definir - Yaf_Controller_Abstract::init, que será invocado - después de que el objeto controlador sea instanciado. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - No se devuelve ningún valor. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Controller_Abstract::init</methodname> - -getView()->assign("sitename", "Yaf Tutorial"); - } - - public function indexAction() { - // ... - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Controller_Abstract::__construct - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/initview.xml b/reference/yaf/yaf_controller_abstract/initview.xml deleted file mode 100644 index 7c663646ea..0000000000 --- a/reference/yaf/yaf_controller_abstract/initview.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Yaf_Controller_Abstract::initView - El propósito de initView - - - - &reftitle.description; - - public Yaf_View_InterfacenullYaf_Controller_Abstract::initView - arraynulloptions - - - Devuelve el motor de vistas asociado a este controlador. El motor de vistas - lo inicializa el Yaf_Dispatcher durante el despacho, - usando la ruta de plantillas establecida para el controlador actual. - - - - - &reftitle.parameters; - - - options - - - Opciones pasadas al motor de vistas, ver - Yaf_View_Simple::__construct. - - - - - - - - &reftitle.returnvalues; - - A Yaf_View_Interface instance en caso de éxito, o &null; en caso de error. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Controller_Abstract::initView</methodname> - -initView(); - $view->assign("products", array("yaf", "php")); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::getView - Yaf_View_Interface - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/redirect.xml b/reference/yaf/yaf_controller_abstract/redirect.xml deleted file mode 100644 index 4bc2a4bc20..0000000000 --- a/reference/yaf/yaf_controller_abstract/redirect.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - Yaf_Controller_Abstract::redirect - Redirige a un URL - - - - &reftitle.description; - - public boolnullYaf_Controller_Abstract::redirect - stringurl - - - Redirige a un URL enviando una cabecera 302 - - - - - &reftitle.parameters; - - - url - - - Un URL - - - - - - - - &reftitle.returnvalues; - - bool - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Controller_Abstract::redirect</methodname> - -getRequest()->getParam("user")) { - // send a Location header with HTTP status 302 - $this->redirect("http://www.example.com/account/login/"); - return false; // skip auto-rendering - } - } -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::forward - Yaf_Response_Abstract::setRedirect - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/render.xml b/reference/yaf/yaf_controller_abstract/render.xml deleted file mode 100644 index 5c1954dd00..0000000000 --- a/reference/yaf/yaf_controller_abstract/render.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - Yaf_Controller_Abstract::render - Renderiza una plantilla de vista - - - - &reftitle.description; - - protected stringboolnullYaf_Controller_Abstract::render - stringtpl - arraynullparameters - - - Renderiza el script de vista tpl y devuelve la - salida, a diferencia de - Yaf_Controller_Abstract::display. - - - - - &reftitle.parameters; - - - tpl - - - El nombre del script de vista, relativo a la ruta de vistas. - - - - - parameters - - - Un array asociativo de variables a exportar al script de vista para este - renderizado. - - - - - - - - &reftitle.returnvalues; - - La salida renderizada como &string; en caso de éxito, o &false; en caso de - error. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Controller_Abstract::render</methodname> - -disableView(); - - // renderiza product/index.phtml y devuelve la salida - // en lugar de enviarla directamente (como haría display()) - $html = $this->render("product/index.phtml", array( - "products" => array("yaf", "php"), - )); - - // se post-procesa y se establece como cuerpo de la respuesta - $this->getResponse()->setBody($html); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::display - Yaf_Dispatcher::autoRender - - - - - - - diff --git a/reference/yaf/yaf_controller_abstract/setviewpath.xml b/reference/yaf/yaf_controller_abstract/setviewpath.xml deleted file mode 100644 index 7393307972..0000000000 --- a/reference/yaf/yaf_controller_abstract/setviewpath.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - Yaf_Controller_Abstract::setViewpath - El propósito de setViewpath - - - - &reftitle.description; - - public boolnullYaf_Controller_Abstract::setViewpath - stringview_directory - - - Establece el directorio de plantillas del motor de vistas asociado a este - controlador. - - - - - &reftitle.parameters; - - - view_directory - - - El directorio que contiene las plantillas de vista. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; en caso de éxito, or &false; / &null; en caso de error. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Controller_Abstract::setViewpath</methodname> - -setViewpath(APPLICATION_PATH . "/themes/dark/views"); - } - - public function indexAction() { - // renders application/themes/dark/views/product/index.phtml - $this->display("product/index.phtml"); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Controller_Abstract::getViewpath - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/autorender.xml b/reference/yaf/yaf_dispatcher/autorender.xml deleted file mode 100644 index 1f9a68f77b..0000000000 --- a/reference/yaf/yaf_dispatcher/autorender.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - Yaf_Dispatcher::autoRender - Activa/desactiva la auto-renderizado - - - - &reftitle.description; - - public Yaf_DispatcherboolYaf_Dispatcher::autoRender - boolnullflagnull - - - Ya que Yaf_Dispatcher realizará el renderizado automáticamente después - de despachar una petición entrante, se puede evitar el renderizado llamando - a este método con el parámetro flag establecido a &true;. - - - - Se puede devolver simplemente &false; en una acción para evitar la auto-renderizado de - dicha acción. - - - - - - &reftitle.parameters; - - - flag - - - Si se habilita la auto-renderizado. - - - - Desde 2.2.0, si no se proporciona este parámetro, será devuelto - el estado actual - - - - - - - - - &reftitle.returnvalues; - - Devuelve el propio objeto Yaf_Dispatcher cuando se - indica flag, o un &boolean; que indica si el renderizado automático está activado cuando no - se indica. - - - - - &reftitle.examples; - - Ejemplo de <function>Yaf_Dispatcher::autoRender</function> - -getRequest()->isXmlHttpRequest()) { - //no se llama a render para una petición ajax - //se va a mostrar una cadena JSON - Yaf_Dispatcher::getInstance()->autoRender(FALSE); - } - } - -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::flushInstantly - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/catchexception.xml b/reference/yaf/yaf_dispatcher/catchexception.xml deleted file mode 100644 index b0f797eec6..0000000000 --- a/reference/yaf/yaf_dispatcher/catchexception.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - Yaf_Dispatcher::catchException - Activar/desactivar la captura de excepciones - - - - &reftitle.description; - - public Yaf_DispatcherboolYaf_Dispatcher::catchException - boolnullflagnull - - - Mientras - application.dispatcher.throwException - esté activado (lo que también puede habilitarse llamando a - Yaf_Dispatcher::throwException), Yaf lanza una - excepción en lugar de emitir un error cuando se producen errores. - - - Si además se habilita la captura de excepciones mediante este método (o - mediante - application.dispatcher.catchException), - todas las excepciones no capturadas se capturan y se despachan a - ErrorController::error, si se ha definido. - - - - - &reftitle.parameters; - - - flag - - - Si Yaf debe capturar las excepciones no detectadas y distribuirlas a - ErrorController::error. - - - - Desde Yaf 2.2.0, si no se proporciona este parámetro, se devuelve el estado actual. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el propio objeto Yaf_Dispatcher cuando se - indica flag, o un &boolean; que indica si la captura de excepciones está activada cuando no - se indica. - - - - - &reftitle.examples; - - Ejemplo de <function>Yaf_Dispatcher::catchException</function> - -getCode()) { - case YAF_ERR_NOTFOUND_MODULE: - case YAF_ERR_NOTFOUND_CONTROLLER: - case YAF_ERR_NOTFOUND_ACTION: - case YAF_ERR_NOTFOUND_VIEW: - echo 404, ":", $exception->getMessage(); - break; - default : - $message = $exception->getMessage(); - echo 0, ":", $exception->getMessage(); - break; - } - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::throwException - Yaf_Dispatcher::setErrorHandler - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/construct.xml b/reference/yaf/yaf_dispatcher/construct.xml deleted file mode 100644 index e9442ecaec..0000000000 --- a/reference/yaf/yaf_dispatcher/construct.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - Yaf_Dispatcher::__construct - Constructor de la clase Yaf_Dispatcher - - - - &reftitle.description; - - public Yaf_Dispatcher::__construct - - - - Yaf_Dispatcher implementa el patrón singleton, por - lo que el constructor es privado. Se usa - Yaf_Dispatcher::getInstance para recuperar la - instancia del despachador, que crea Yaf_Application. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - <classname>Yaf_Dispatcher</classname> is a singleton - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::getInstance - Yaf_Application::getDispatcher - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/disableview.xml b/reference/yaf/yaf_dispatcher/disableview.xml deleted file mode 100644 index 7a33890e27..0000000000 --- a/reference/yaf/yaf_dispatcher/disableview.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Yaf_Dispatcher::disableView - Deshabilita el renderizado de vistas - - - - &reftitle.description; - - public Yaf_DispatchernullYaf_Dispatcher::disableView - - - - Deshabilita el motor de vistas, usado en algunas aplicaciones donde se generan por sí mismas. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el Yaf_Dispatcher en caso de éxito, o &null; si la aplicación no está inicializada. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Dispatcher::disableView</methodname> - -disableView(); - -$app->run(); -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::enableView - Yaf_Dispatcher::autoRender - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/dispatch.xml b/reference/yaf/yaf_dispatcher/dispatch.xml deleted file mode 100644 index 758d7b5912..0000000000 --- a/reference/yaf/yaf_dispatcher/dispatch.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - Yaf_Dispatcher::dispatch - Despachar una petición - - - - &reftitle.description; - - public Yaf_Response_AbstractnullfalseYaf_Dispatcher::dispatch - Yaf_Request_Abstractrequest - - - Este método realiza el trabajo duro de la clase - Yaf_Dispatcher. Toma un objeto de petición. - - - El proceso de despachamiento posee tres eventos distintos: - - Enrutamiento - Despachamiento - Respuesta - - El enrutamiento ocurre exactamente una vez, usando los valores del objeto de petición - al llamar a Yaf_Dispatcher::dispatch. El despachamiento tiene lugar en un bucle; una petición puede - indicar o múltiples acciones a despachar, o el controlador, o un plugin - puede reiniciar el objeto de petición para forzar acciones adicionales a despachar (véase - la clase Yaf_Plugin_Abstract. Cuando todo ha sido realizado, la clase - Yaf_Dispatcher devuelve una respuesta. - - - - - - &reftitle.parameters; - - - request - - - Una instancia de Yaf_Request_Abstract a - despachar. - - - - - - - - &reftitle.returnvalues; - - La instancia de Yaf_Response_Abstract en caso de éxito, &false; en caso de error, o &null; si la aplicación no está inicializada. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Dispatcher::dispatch</methodname> - -bootstrap(); - -// Se construye una petición que apunta a ProductController::detailAction y -// se despacha manualmente. -$request = new Yaf_Request_Http("/product/detail/id/42"); - -$response = Yaf_Dispatcher::getInstance()->dispatch($request); - -if ($response instanceof Yaf_Response_Abstract) { - $response->response(); -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Application::run - Yaf_Plugin_Abstract - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/enableview.xml b/reference/yaf/yaf_dispatcher/enableview.xml deleted file mode 100644 index 59ab7777d0..0000000000 --- a/reference/yaf/yaf_dispatcher/enableview.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - Yaf_Dispatcher::enableView - Habilita el renderizado de vistas - - - - &reftitle.description; - - public Yaf_DispatchernullYaf_Dispatcher::enableView - - - - Activa el renderizado de vistas. Es lo contrario de - Yaf_Dispatcher::disableView. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el Yaf_Dispatcher en caso de éxito, o &null; si la aplicación no está inicializada. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Dispatcher::enableView</methodname> - -getModuleName() === "Api") { - // API actions emit JSON themselves, no view rendering wanted - $dispatcher->disableView(); - } else { - $dispatcher->enableView(); - } - } -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::disableView - Yaf_Dispatcher::autoRender - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/flushinstantly.xml b/reference/yaf/yaf_dispatcher/flushinstantly.xml deleted file mode 100644 index 560358a948..0000000000 --- a/reference/yaf/yaf_dispatcher/flushinstantly.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - Yaf_Dispatcher::flushInstantly - Activa/desactiva el vaciado instantáneo - - - - &reftitle.description; - - public Yaf_DispatcherboolYaf_Dispatcher::flushInstantly - boolnullflagnull - - - Activa o desactiva el volcado inmediato. Cuando está activado (lo que - ocurre por omisión), el cuerpo de la respuesta se vuelca al cliente en - cuanto lo establece - Yaf_Response_Abstract::setBody. - - - - - - &reftitle.parameters; - - - flag - - - Si se descarga el cuerpo de la respuesta de forma instantánea. - - - - Desde 2.2.0, si no se proporciona este parámetro, será devuelto - el estado actual - - - - - - - - - &reftitle.returnvalues; - - Devuelve el propio objeto Yaf_Dispatcher cuando se - indica flag, o un &boolean; que indica el estado actual cuando no - se indica. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Dispatcher::flushInstantly</methodname> - -flushInstantly(false); - -// A partir de Yaf 2.2.0, llamarlo sin argumentos consulta el estado actual -var_dump($dispatcher->flushInstantly()); - -$app->run(); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::returnResponse - Yaf_Response_Abstract::setBody - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/getapplication.xml b/reference/yaf/yaf_dispatcher/getapplication.xml deleted file mode 100644 index 74b5deeb5d..0000000000 --- a/reference/yaf/yaf_dispatcher/getapplication.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Yaf_Dispatcher::getApplication - Recupera la aplicación - - - - &reftitle.description; - - public Yaf_ApplicationnullYaf_Dispatcher::getApplication - - - - Recupera la instancia de la clase Yaf_Application. Hace lo mismo que - el método Yaf_Application::app. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La instancia de Yaf_Application, or &null; si aún no se ha inicializado ninguna aplicación. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Dispatcher::getApplication</methodname> - -getApplication() === Yaf_Application::app()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Application::app - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/getdefaultaction.xml b/reference/yaf/yaf_dispatcher/getdefaultaction.xml deleted file mode 100644 index 6afe1451e0..0000000000 --- a/reference/yaf/yaf_dispatcher/getdefaultaction.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Yaf_Dispatcher::getDefaultAction - Recupera el nombre de la acción por omisión - - - - &reftitle.description; - - public stringnullYaf_Dispatcher::getDefaultAction - - - - obtiene el nombre de la acción por omisión. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &string;, nombre de la acción por omisión, por omisión es "index" - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Dispatcher::getDefaultAction</methodname> - -getDefaultAction()); - -$dispatcher->setDefaultAction("main"); -var_dump($dispatcher->getDefaultAction()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::setDefaultAction - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/getdefaultcontroller.xml b/reference/yaf/yaf_dispatcher/getdefaultcontroller.xml deleted file mode 100644 index 91d676b88f..0000000000 --- a/reference/yaf/yaf_dispatcher/getdefaultcontroller.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Yaf_Dispatcher::getDefaultController - Recupera el nombre del controlador por omisión - - - - &reftitle.description; - - public stringnullYaf_Dispatcher::getDefaultController - - - - obtiene el nombre del controlador por omisión - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &string;, nombre del controlador por omisión, por omisión es "Index" - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Dispatcher::getDefaultController</methodname> - -getDefaultController()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::setDefaultController - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/getdefaultmodule.xml b/reference/yaf/yaf_dispatcher/getdefaultmodule.xml deleted file mode 100644 index 97eb794e7e..0000000000 --- a/reference/yaf/yaf_dispatcher/getdefaultmodule.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Yaf_Dispatcher::getDefaultModule - Recupera el nombre del módulo por omisión - - - - &reftitle.description; - - public stringnullYaf_Dispatcher::getDefaultModule - - - - obtiene el nombre del módulo por omisión - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &string;, nombre del módulo, por omisión es "Index" - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Dispatcher::getDefaultModule</methodname> - -getDefaultModule()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::setDefaultModule - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/getinstance.xml b/reference/yaf/yaf_dispatcher/getinstance.xml deleted file mode 100644 index f96993e856..0000000000 --- a/reference/yaf/yaf_dispatcher/getinstance.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Yaf_Dispatcher::getInstance - Recupeara la instancia despachadora - - - - &reftitle.description; - - public static Yaf_DispatchernullYaf_Dispatcher::getInstance - - - - Recupera la única instancia de Yaf_Dispatcher. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La instancia de Yaf_Dispatcher, or &null; si aún no se ha inicializado ninguna Yaf_Application. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Dispatcher::getInstance</methodname> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Application::getDispatcher - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/getrequest.xml b/reference/yaf/yaf_dispatcher/getrequest.xml deleted file mode 100644 index ecad7884e4..0000000000 --- a/reference/yaf/yaf_dispatcher/getrequest.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - Yaf_Dispatcher::getRequest - Recupera la instancia de petición - - - - &reftitle.description; - - public Yaf_Request_AbstractnullYaf_Dispatcher::getRequest - - - - Recupera el objeto de petición que mantiene el despachador. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La instancia de Yaf_Request_Abstract, o &null; si la aplicación no está inicializada. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Dispatcher::getRequest</methodname> - -getRequest(); - - // El despachador mantiene exactamente el mismo objeto de petición que - // se pasa al controlador - var_dump($request === $this->getRequest()); - - return false; - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::setRequest - Yaf_Request_Abstract - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/getresponse.xml b/reference/yaf/yaf_dispatcher/getresponse.xml deleted file mode 100644 index 5758b108a5..0000000000 --- a/reference/yaf/yaf_dispatcher/getresponse.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Yaf_Dispatcher::getResponse - Obtener el objeto de respuesta - - - - &reftitle.description; - - public Yaf_Response_AbstractnullYaf_Dispatcher::getResponse - - - - Obtiene la instancia de Yaf_Response_Abstract utilizada - por el despachador. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La instancia de Yaf_Response_Abstract, o &null; si - la aplicación no está inicializada. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Dispatcher::getResponse</methodname> - -getResponse()->setHeader( - "Content-Type", "text/html; charset=utf-8" - ); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::setResponse - Yaf_Response_Abstract - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/getrouter.xml b/reference/yaf/yaf_dispatcher/getrouter.xml deleted file mode 100644 index 5cc044190b..0000000000 --- a/reference/yaf/yaf_dispatcher/getrouter.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Yaf_Dispatcher::getRouter - Recuperar la instancia de envío - - - - &reftitle.description; - - public Yaf_RouternullYaf_Dispatcher::getRouter - - - - Recupera la instancia de Yaf_Router que usa el - despachador para enrutar las peticiones. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - La instancia de Yaf_Router, o &null; si la aplicación no está inicializada. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Dispatcher::getRouter</methodname> - -getRouter(); - - // Route /product/42 to ProductController::detailAction - $router->addRoute("product", new Yaf_Route_Rewrite( - "product/:id", - array("controller" => "product", "action" => "detail") - )); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Router - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/initview.xml b/reference/yaf/yaf_dispatcher/initview.xml deleted file mode 100644 index 31fcc3f2bc..0000000000 --- a/reference/yaf/yaf_dispatcher/initview.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - Yaf_Dispatcher::initView - Inicializa una vista y la devuelve - - - - &reftitle.description; - - public Yaf_View_InterfacenullfalseYaf_Dispatcher::initView - stringtemplates_dir - arraynulloptionsnull - - - Inicializa y devuelve una instancia de - Yaf_View_Simple asociada al despachador, usando el - directorio de plantillas indicado. - - - - - - &reftitle.parameters; - - - templates_dir - - - El directorio que contiene las plantillas de vista. - - - - - options - - - Opciones pasadas al motor de vistas, ver - Yaf_View_Simple::__construct. - - - - - - - - &reftitle.returnvalues; - - A Yaf_View_Interface instance en caso de éxito, or &false; / &null; en caso de error. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Dispatcher::initView</methodname> - -initView( - dirname(__FILE__) . "/application/views", - array("tpl_suffix" => ".html") -); - -$view->assign("title", "Home"); -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::setView - Yaf_View_Simple - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/registerplugin.xml b/reference/yaf/yaf_dispatcher/registerplugin.xml deleted file mode 100644 index f71c81a4b5..0000000000 --- a/reference/yaf/yaf_dispatcher/registerplugin.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Yaf_Dispatcher::registerPlugin - Registra un plugin - - - - &reftitle.description; - - public Yaf_DispatchernullfalseYaf_Dispatcher::registerPlugin - Yaf_Plugin_Abstractplugin - - - Registra un plugin (véase Yaf_Plugin_Abstract). - Generalmente se registran plugins en el Arranque (véase la clase - Yaf_Bootstrap_Abstract). - - - - - - &reftitle.parameters; - - - plugin - - - Una instancia de Yaf_Plugin_Abstract. - - - - - - - - &reftitle.returnvalues; - - Devuelve el Yaf_Dispatcher en caso de éxito, or &false; / &null; en caso de error. - - - - - &reftitle.examples; - - Ejemplo de <function>Yaf_Dispatcher::registerPlugin</function> - -registerPlugin($user); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Plugin_Abstract - Yaf_Bootstrap_Abstract - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/returnresponse.xml b/reference/yaf/yaf_dispatcher/returnresponse.xml deleted file mode 100644 index 65a2f9141b..0000000000 --- a/reference/yaf/yaf_dispatcher/returnresponse.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - Yaf_Dispatcher::returnResponse - El propósito de returnResponse - - - - &reftitle.description; - - public Yaf_DispatcherboolYaf_Dispatcher::returnResponse - boolflagfalse - - - Determina si Yaf_Application::run devuelve el - objeto de respuesta en lugar de enviarlo directamente al cliente. Cuando - está activado, $response = $app->run() proporciona la - instancia de Yaf_Response_Abstract, de modo que - puede manipularse después. Disponible a partir de Yaf 3.2.2. - - - - - - &reftitle.parameters; - - - flag - - - Si se devuelve la respuesta en lugar de enviarla. - - - - Si no se proporciona este parámetro, se devuelve el estado actual. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el propio objeto Yaf_Dispatcher cuando se - indica flag, o un &boolean; que indica el estado actual cuando no - se indica. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Dispatcher::returnResponse</methodname> - -returnResponse(true); - -// $app->run() devuelve ahora la respuesta en lugar de volcarla -$response = $app->run(); - -$response->setHeader("X-Generator", "Yaf"); -$response->response(); -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Application::run - Yaf_Response_Abstract - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/setdefaultaction.xml b/reference/yaf/yaf_dispatcher/setdefaultaction.xml deleted file mode 100644 index e925ca0853..0000000000 --- a/reference/yaf/yaf_dispatcher/setdefaultaction.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - Yaf_Dispatcher::setDefaultAction - Cambia el nombre de la acción por omisión - - - - &reftitle.description; - - public Yaf_DispatchernullfalseYaf_Dispatcher::setDefaultAction - stringaction - - - Cambia el nombre de la acción que se usa cuando no puede extraerse un - nombre de acción del URI de la petición. El nombre se normaliza a - minúsculas. - - - - - - &reftitle.parameters; - - - action - - - El nombre de la acción. - - - - - - - - &reftitle.returnvalues; - - Devuelve el Yaf_Dispatcher en caso de éxito, or &false; si la aplicación no está inicializada. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Dispatcher::setDefaultAction</methodname> - -setDefaultAction("main"); - -$app->run(); -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::setDefaultModule - Yaf_Dispatcher::setDefaultController - Yaf_Dispatcher::getDefaultAction - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/setdefaultcontroller.xml b/reference/yaf/yaf_dispatcher/setdefaultcontroller.xml deleted file mode 100644 index 8b3847bbc7..0000000000 --- a/reference/yaf/yaf_dispatcher/setdefaultcontroller.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - Yaf_Dispatcher::setDefaultController - Cambia el nombre del controlador por omisión - - - - &reftitle.description; - - public Yaf_DispatchernullfalseYaf_Dispatcher::setDefaultController - stringcontroller - - - Cambia el nombre del controlador que se usa cuando no puede extraerse un - nombre de controlador del URI de la petición. El nombre se normaliza - poniendo la primera letra en mayúscula. - - - - - - &reftitle.parameters; - - - controller - - - El nombre del controlador. - - - - - - - - &reftitle.returnvalues; - - Devuelve el Yaf_Dispatcher en caso de éxito, or &false; si la aplicación no está inicializada. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Dispatcher::setDefaultController</methodname> - -setDefaultController("home"); - -$app->run(); -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::setDefaultModule - Yaf_Dispatcher::setDefaultAction - Yaf_Dispatcher::getDefaultController - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/setdefaultmodule.xml b/reference/yaf/yaf_dispatcher/setdefaultmodule.xml deleted file mode 100644 index 15a6d81760..0000000000 --- a/reference/yaf/yaf_dispatcher/setdefaultmodule.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Yaf_Dispatcher::setDefaultModule - Cambia el nombre del módulo por omisión - - - - &reftitle.description; - - public Yaf_DispatchernullfalseYaf_Dispatcher::setDefaultModule - stringmodule - - - Cambia el nombre del módulo que se usa cuando no puede extraerse un nombre - de módulo del URI de la petición. El módulo debe estar registrado, ver - Yaf_Application::getModules. - - - - - - &reftitle.parameters; - - - module - - - El nombre de un módulo registrado. - - - - - - - - &reftitle.returnvalues; - - Devuelve el Yaf_Dispatcher en caso de éxito, &false; si el módulo dado no está registrado (y se genera un YAF_ERR_TYPE_ERROR) o si la aplicación no está inicializada, o &null; en caso contrario. - - - - &reftitle.errors; - - Lanza un error YAF_ERR_TYPE_ERROR si - module no es el nombre de un módulo registrado. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Dispatcher::setDefaultModule</methodname> - -setDefaultModule("Home"); - -$app->run(); -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::setDefaultController - Yaf_Dispatcher::setDefaultAction - Yaf_Dispatcher::getDefaultModule - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/seterrorhandler.xml b/reference/yaf/yaf_dispatcher/seterrorhandler.xml deleted file mode 100644 index 7e08a6f690..0000000000 --- a/reference/yaf/yaf_dispatcher/seterrorhandler.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - Yaf_Dispatcher::setErrorHandler - Establece el gestor de errores - - - - &reftitle.description; - - public Yaf_DispatchernullfalseYaf_Dispatcher::setErrorHandler - mixedcallback - interror_types0 - - - Establece el gestor de errores de Yaf. Cuando application.dispatcher.throwException - está desactivada, Yaf provocará errores capturables mientras ocurran errores inesperados. - - - Por lo tanto, este gestor de errores será invocado mientras se produce el error. - - - - - &reftitle.parameters; - - - callback - - - Una llamada de retorno de tipo callable. - - - - - error_types - - - Los tipos de error a tratar, igual que el parámetro - error_levels de - set_error_handler. Por omisión, se tratan todos los - tipos de error. - - - - - - - - &reftitle.returnvalues; - - Devuelve el Yaf_Dispatcher en caso de éxito, &false; si la llamada a set_error_handler falló, o &null; si la aplicación no está inicializada. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Dispatcher::setErrorHandler</methodname> - -setErrorHandler(function ($errno, $errstr) { - // Route errors to ErrorController::errorAction - $request = Yaf_Dispatcher::getInstance()->getRequest(); - $request->setControllerName("Error"); - $request->setActionName("error"); -}); - -$app->run(); -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::throwException - Yaf_Application::getLastErrorNo - Yaf_Application::getLastErrorMsg - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/setrequest.xml b/reference/yaf/yaf_dispatcher/setrequest.xml deleted file mode 100644 index d1b2359499..0000000000 --- a/reference/yaf/yaf_dispatcher/setrequest.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - Yaf_Dispatcher::setRequest - El propósito de setRequest - - - - &reftitle.description; - - public Yaf_DispatchernullYaf_Dispatcher::setRequest - Yaf_Request_Abstractrequest - - - Establece el objeto de petición que usa el despachador. Esto permite usar - una implementación de petición personalizada en lugar de las incorporadas - Yaf_Request_Http o - Yaf_Request_Simple. - - - - - - &reftitle.parameters; - - - plugin - - - Una instancia de Yaf_Request_Abstract. - - - - - - - - &reftitle.returnvalues; - - Devuelve el Yaf_Dispatcher en caso de éxito, o &null; si la aplicación no está inicializada. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Dispatcher::setRequest</methodname> - -setRequest($request); - -$app->run(); -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::getRequest - Yaf_Request_Abstract - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/setresponse.xml b/reference/yaf/yaf_dispatcher/setresponse.xml deleted file mode 100644 index c2c24d782c..0000000000 --- a/reference/yaf/yaf_dispatcher/setresponse.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - Yaf_Dispatcher::setResponse - Establecer el objeto de respuesta - - - - &reftitle.description; - - public Yaf_DispatchernullYaf_Dispatcher::setResponse - Yaf_Response_Abstractresponse - - - Establece el objeto de respuesta utilizado por el despachador. Permite usar - una implementación de respuesta personalizada en lugar de las integradas. - - - - - &reftitle.parameters; - - - response - - - Una instancia de Yaf_Response_Abstract. - - - - - - - - &reftitle.returnvalues; - - Devuelve el propio objeto Yaf_Dispatcher en caso de - éxito, o &null; si la aplicación no está inicializada. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Dispatcher::setResponse</methodname> - -setResponse(new ApiResponse()); - -$app->run(); -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::getResponse - Yaf_Dispatcher::setRequest - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/setview.xml b/reference/yaf/yaf_dispatcher/setview.xml deleted file mode 100644 index 9b91c7da2e..0000000000 --- a/reference/yaf/yaf_dispatcher/setview.xml +++ /dev/null @@ -1,254 +0,0 @@ - - - - - - Yaf_Dispatcher::setView - Establecer un motor de vistas personalizado - - - - &reftitle.description; - - public Yaf_DispatchernullYaf_Dispatcher::setView - Yaf_View_Interfaceview - - - Este método ofrece una solución si desea utilizar una vista personalizada - en lugar de Yaf_View_Simple. - - - - - - &reftitle.parameters; - - - view - - - Una instancia de Yaf_View_Interface - - - - - - - - &reftitle.returnvalues; - - Devuelve el Yaf_Dispatcher en caso de éxito, o &null; si la aplicación no está inicializada. - - - - - &reftitle.examples; - - Ejemplo de un motor de Vistas personalizado - -_smarty = new Smarty; - - if (null !== $tmplPath) { - $this->setScriptPath($tmplPath); - } - - foreach ($extraParams as $clave => $valor) { - $this->_smarty->$clave = $valor; - } - } - - /** - * Establecer la ruta a las plantillas - * - * @param string $ruta El directorio a establecer como ruta. - * @return void - */ - public function setScriptPath($ruta) - { - if (is_readable($ruta)) { - $this->_smarty->template_dir = $ruta; - return; - } - - throw new Exception('La ruta proporcionada no es válida'); - } - - /** - * Asignar una variable a la plantilla - * - * @param string $clave El nombre de la variable. - * @param mixed $valor El valor de la variable. - * @return void - */ - public function __set($clave, $valor) - { - $this->_smarty->assign($clave, $valor); - } - - /** - * Permite que funcionen las pruebas con empty() y isset() - * - * @param string $clave - * @return boolean - */ - public function __isset($clave) - { - return (null !== $this->_smarty->get_template_vars($clave)); - } - - /** - * Permite que funcione unset() con las propiedades de los objetos - * - * @param string $clave - * @return void - */ - public function __unset($clave) - { - $this->_smarty->clear_assign($clave); - } - - /** - * Asignar variables a la plantilla - * - * Permite establecer una clave específica para el valor especificado, O pasar - * un array de parejas clave => valor para establecer masivamente. - * - * @see __set() - * @param string|array $spec La estrategia de asignación a utilizar (clave o - * array de parejas clave => valor) - * @param mixed $valor (Opcional) Si se asigna una variable con nombre, - * este es el valor a usar. - * @return void - */ - public function assign($spec, $valor = null) { - if (is_array($spec)) { - $this->_smarty->assign($spec); - return; - } - - $this->_smarty->assign($spec, $valor); - } - - /** - * Limpiar todas las variables asignadas - * - * Limpia todas las variables asignadas a Yaf_View mediante - * {@link assign()} o con sobrecarga de propiedades - * ({@link __get()}/{@link __set()}). - * - * @return void - */ - public function clearVars() { - $this->_smarty->clear_all_assign(); - } - - /** - * Procesa una plantilla y devuelve la salida. - * - * @param string $nombre La plantilla a procesar. - * @return string La salida. - */ - public function render($nombre, $valor = NULL) { - return $this->_smarty->fetch($nombre); - } - - public function display($nombre, $valor = NULL) { - echo $this->_smarty->fetch($nombre); - } - -} -?> -]]> - - - - Ejemplo de <function>Yaf_Dispatcher::setView</function> - -getConfig(); - Yaf_Registry::set("config", $config); - } - - public function _initLocalName() { - /** ponemos la clase Smarty_Adapter bajo el directorio de bibliotecas local */ - Yaf_Loader::getInstance()->registerLocalNamespace('Smarty'); - } - - public function _initSmarty(Yaf_Dispatcher $despachador) { - $smarty = new Smarty_Adapter(null, Yaf_Registry::get("config")->get("smarty")); - $despachador->setView($smarty); - /* ahora el motor de vistas de Smarty se convierte en el motor de vistas predeterminado de Yaf */ - } -} -?> -]]> - - - - - - &reftitle.seealso; - - - Yaf_View_Interface - Yaf_View_Simple - - - - - - - diff --git a/reference/yaf/yaf_dispatcher/throwexception.xml b/reference/yaf/yaf_dispatcher/throwexception.xml deleted file mode 100644 index 2bd87a9802..0000000000 --- a/reference/yaf/yaf_dispatcher/throwexception.xml +++ /dev/null @@ -1,147 +0,0 @@ - - - - - - Yaf_Dispatcher::throwException - Activa/desactiva el lanzamiento de excepciones - - - - &reftitle.description; - - public Yaf_DispatcherboolYaf_Dispatcher::throwException - boolnullflagnull - - - Activa/desactiva el lanzamiento de excepciones mientras ocurran errores inesperados. - Cuando está activado, Yaf lanzará excepciones en lugar de provocar - errores capturables. - - - También se puede usar - application.dispatcher.throwException para el mismo - propósito. - - - - - &reftitle.parameters; - - - flag - - - Si Yaf debe lanzar excepciones en caso de error. - - - - Desde Yaf 2.2.0, si no se proporciona este parámetro, se devuelve el estado actual. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el propio objeto Yaf_Dispatcher cuando se - indica flag, o un &boolean; que indica si el lanzamiento de excepciones está activado cuando no - se indica. - - - - - &reftitle.examples; - - Ejemplo de <function>Yaf_Dispatcher::throwexception</function> - - array( - 'directory' => dirname(__FILE__), - ), -); -$app = new Yaf_Application($config); - -$app->getDispatcher()->throwException(true); - -try { - $app->run(); -} catch (Yaf_Exception $e) { - var_dump($e->getMessage()); -} -?> -]]> - - &example.outputs.similar; - - - - - - Ejemplo de <function>Yaf_Dispatcher::throwexception</function> - - array( - 'directory' => dirname(__FILE__), - ), -); -$app = new Yaf_Application($config); - -$app->getDispatcher()->throwException(false); - -$app->run(); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - Yaf_Dispatcher::catchException - Yaf_Exception - - - - - - - diff --git a/reference/yaf/yaf_exception/construct.xml b/reference/yaf/yaf_exception/construct.xml deleted file mode 100644 index b91035031d..0000000000 --- a/reference/yaf/yaf_exception/construct.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - Yaf_Exception::__construct - El propósito de __construct - - - - &reftitle.description; - - public Yaf_Exception::__construct - stringmessage"" - intcode0 - - Construye una nueva Yaf_Exception. El code lleva el código de error de Yaf que identifica el tipo de fallo, y está disponible mediante Exception::getCode. - - - - &reftitle.parameters; - - - message - - El mensaje de la excepción. - - - - code - - El código de error de Yaf. - - - - - - - &reftitle.returnvalues; - No se devuelve ningún valor. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Exception::__construct</methodname> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Exception - Yaf_Exception::getPrevious - Yaf_Exception_RouterFailed - - - - - - diff --git a/reference/yaf/yaf_exception/getprevious.xml b/reference/yaf/yaf_exception/getprevious.xml deleted file mode 100644 index fe6c213c21..0000000000 --- a/reference/yaf/yaf_exception/getprevious.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Yaf_Exception::getPrevious - El propósito de getPrevious - - - - &reftitle.description; - - public ThrowableYaf_Exception::getPrevious - - - - Este método se hereda de la jerarquía base de - Throwable y devuelve la excepción encadenada como - anterior, si la hay. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - Devuelve el previous Throwable if available, &null; en caso contrario. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Exception::getPrevious</methodname> - -getCode()); - $prev = $e->getPrevious(); - var_dump(get_class($prev)); - var_dump($prev->getMessage()); - var_dump($prev->getCode()); -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Exception::__construct - Yaf_Exception - - - - - - diff --git a/reference/yaf/yaf_loader/autoload.xml b/reference/yaf/yaf_loader/autoload.xml deleted file mode 100644 index 1d1ad6468e..0000000000 --- a/reference/yaf/yaf_loader/autoload.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - Yaf_Loader::autoload - Carga automáticamente una clase - - - - &reftitle.description; - - public boolYaf_Loader::autoload - stringclass_name - - - Carga una clase por su nombre. El nombre de la clase se convierte en una - ruta de fichero: los guiones bajos y los separadores de namespace se - convierten en separadores de directorio. - - - Las clases MVC (aquellas cuyo nombre contiene _Controller, - _Action o _Plugin) se buscan dentro del - directorio de la aplicación, mientras que las demás clases se buscan en los - directorios de bibliotecas: la biblioteca local para los prefijos de clase - registrados localmente, y en caso contrario la biblioteca global. - - - - - &reftitle.parameters; - - - class_name - - El nombre de la clase a cargar. - - - - - - - &reftitle.returnvalues; -Devuelve &true; en caso de éxito, o &false; en caso de error. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Loader::autoload</methodname> - -autoload("Catalog_PriceService"); - -/* las clases MVC se buscan dentro del directorio de la aplicación */ -$loader->autoload("ProductController"); -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Loader::import - Yaf_Loader::registerLocalNamespace - - - - - - diff --git a/reference/yaf/yaf_loader/clearlocalnamespace.xml b/reference/yaf/yaf_loader/clearlocalnamespace.xml deleted file mode 100644 index 77ceb09b67..0000000000 --- a/reference/yaf/yaf_loader/clearlocalnamespace.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - Yaf_Loader::clearLocalNamespace - El propósito de clearLocalNamespace - - - - &reftitle.description; - - public boolYaf_Loader::clearLocalNamespace - - - - Limpia todos los namespaces locales registrados. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -Devuelve &true; en caso de éxito. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Loader::clearLocalNamespace</methodname> - -registerLocalNamespace(array("Models", "Services")); -var_dump(count($loader->getLocalNamespace())); - -$loader->clearLocalNamespace(); -var_dump(count($loader->getLocalNamespace())); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Loader::registerLocalNamespace - Yaf_Loader::getLocalNamespace - - - - - - diff --git a/reference/yaf/yaf_loader/construct.xml b/reference/yaf/yaf_loader/construct.xml deleted file mode 100644 index 321b34966b..0000000000 --- a/reference/yaf/yaf_loader/construct.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - Yaf_Loader::__construct - El propósito de __construct - - - - &reftitle.description; - - private Yaf_Loader::__construct - - - - Construye un nuevo cargador. El constructor es privado; - Yaf_Loader es un singleton. Se usa - Yaf_Loader::getInstance para obtener la instancia. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -No se devuelve ningún valor. - - - - - &reftitle.examples; - - Obtener el singleton <classname>Yaf_Loader</classname> - -getMessage(), PHP_EOL; -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Loader::getInstance - - - - - - diff --git a/reference/yaf/yaf_loader/getinstance.xml b/reference/yaf/yaf_loader/getinstance.xml deleted file mode 100644 index cfedad8711..0000000000 --- a/reference/yaf/yaf_loader/getinstance.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - Yaf_Loader::getInstance - Recupera la instancia de Yaf_Loader - - - - &reftitle.description; - - public static Yaf_LoaderfalseYaf_Loader::getInstance - stringlocal_library_pathnull - stringglobal_library_pathnull - - - Recupera la instancia única (singleton) de - Yaf_Loader. - - - Si se indican las rutas de las bibliotecas, se aplican a la instancia - existente. - - - - - &reftitle.parameters; - - - local_library_path - - - El directorio de la biblioteca local, habitualmente el mismo que la - directiva ini application.library.directory. - - - - - global_library_path - - - El directorio de la biblioteca global. Si no se indica, se usa el local. - - - - - - - - &reftitle.returnvalues; -La instancia de Yaf_Loader, o &false; si el cargador no ha sido inicializado (lo cual se realiza normalmente mediante Yaf_Application). - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Loader::getInstance</methodname> - -registerNamespace("Vendor", APPLICATION_PATH . "/library/Vendor"); -?> -]]> - - - - <methodname>Yaf_Loader::getInstance</methodname> antes de la inicialización - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Loader::setLibraryPath - Yaf_Loader::getLibraryPath - - - - - - diff --git a/reference/yaf/yaf_loader/getlibrarypath.xml b/reference/yaf/yaf_loader/getlibrarypath.xml deleted file mode 100644 index f0947b0972..0000000000 --- a/reference/yaf/yaf_loader/getlibrarypath.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - Yaf_Loader::getLibraryPath - Obtener la ruta de la biblioteca - - - - &reftitle.description; - - public stringYaf_Loader::getLibraryPath - boolis_globalfalse - - - Recupera el directorio de la biblioteca. - - - - - &reftitle.parameters; - - - is_global - - - Si se debe recuperar el directorio de la biblioteca global en lugar del - local. - - - - - - - - &reftitle.returnvalues; - - El directorio de la biblioteca como cadena, o una cadena vacía cuando se - solicita el directorio de la biblioteca global pero no está definido. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Loader::getLibraryPath</methodname> - -getLibraryPath(), PHP_EOL; - -/* el directorio de la biblioteca global */ -echo $loader->getLibraryPath(true), PHP_EOL; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Loader::setLibraryPath - - - - - - diff --git a/reference/yaf/yaf_loader/getlocalnamespace.xml b/reference/yaf/yaf_loader/getlocalnamespace.xml deleted file mode 100644 index df226e03f6..0000000000 --- a/reference/yaf/yaf_loader/getlocalnamespace.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - Yaf_Loader::getLocalNamespace - El propósito de getLocalNamespace - - - - &reftitle.description; - - public arrayYaf_Loader::getLocalNamespace - - - - Recupera todos los namespaces locales registrados y sus rutas. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Un array de los namespaces locales registrados, indexado por el - prefijo del namespace, o un array vacío si no hay ninguno - registrado. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Loader::getLocalNamespace</methodname> - -registerLocalNamespace("Models"); -$loader->registerLocalNamespace("Vendor", APPLICATION_PATH . "/library/Vendor"); - -print_r($loader->getLocalNamespace()); -?> -]]> - - &example.outputs.similar; - - /var/www/shop/application/library - [Vendor] => /var/www/shop/application/library/Vendor -) -]]> - - - - - - &reftitle.seealso; - - Yaf_Loader::registerLocalNamespace - Yaf_Loader::clearLocalNamespace - - - - - - diff --git a/reference/yaf/yaf_loader/getnamespacepath.xml b/reference/yaf/yaf_loader/getnamespacepath.xml deleted file mode 100644 index 414da63828..0000000000 --- a/reference/yaf/yaf_loader/getnamespacepath.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Yaf_Loader::getNamespacePath - Recupera el directorio de la biblioteca en el que se buscaría una clase - - - - &reftitle.description; - - public stringYaf_Loader::getNamespacePath - stringclass_name - - - Recupera el directorio de la biblioteca en el que se buscaría una clase. - - - - - &reftitle.parameters; - - - class_name - - - El nombre de la clase cuyo directorio de biblioteca se solicita. - - - - - - - - &reftitle.returnvalues; - - El directorio de la biblioteca local si la clase pertenece a un namespace - local registrado; en caso contrario, el directorio de la biblioteca global - (recurriendo al local cuando el global no está definido). - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Loader::getNamespacePath</methodname> - -registerLocalNamespace("Models"); -$loader->setLibraryPath("/usr/local/share/yaf/library", true); - -/* "Models" es un namespace local registrado */ -echo $loader->getNamespacePath("Models_Product"), PHP_EOL; - -/* las demás clases recurren al directorio de la biblioteca global */ -echo $loader->getNamespacePath("Vendor_Payment"), PHP_EOL; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Loader::isLocalName - Yaf_Loader::getLibraryPath - - - - - - diff --git a/reference/yaf/yaf_loader/getnamespaces.xml b/reference/yaf/yaf_loader/getnamespaces.xml deleted file mode 100644 index 795ceb4ed0..0000000000 --- a/reference/yaf/yaf_loader/getnamespaces.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - Yaf_Loader::getLocalNamespace - Recupera toda la información de los namespaces - - - - &reftitle.description; - - public arrayYaf_Loader::getNamespaces - - - - Obtiene la información de los namespaces registrados. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &array; - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Loader::getNamespaces</methodname> - -registerLocalNamespace(array("Models", "Services")); - -/* getNamespaces() es un alias de getLocalNamespace() */ -var_dump($loader->getNamespaces() === $loader->getLocalNamespace()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Loader::getLocalNamespace - - - - - - diff --git a/reference/yaf/yaf_loader/import.xml b/reference/yaf/yaf_loader/import.xml deleted file mode 100644 index 65d59d1cc5..0000000000 --- a/reference/yaf/yaf_loader/import.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - Yaf_Loader::import - Carga un script PHP - - - - &reftitle.description; - - public static boolYaf_Loader::import - stringfile - - - Carga un fichero de script PHP una sola vez. Si el fichero no es una ruta - absoluta, se busca dentro del directorio de la biblioteca local. - - - Un fichero solo se incluye una vez; llamar de nuevo a - Yaf_Loader::import con el mismo fichero devuelve - &true; sin volver a incluirlo. - - - - - &reftitle.parameters; - - - file - - El fichero a cargar. - - - - - - - &reftitle.returnvalues; - - Devuelve &true; en caso de éxito (incluso cuando el fichero ya estaba - cargado), o &false; en caso de error. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Loader::import</methodname> - - -]]> - - - - Un fichero solo se importa una vez - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Loader::autoload - - - - - - diff --git a/reference/yaf/yaf_loader/islocalname.xml b/reference/yaf/yaf_loader/islocalname.xml deleted file mode 100644 index fd7a726e3f..0000000000 --- a/reference/yaf/yaf_loader/islocalname.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - Yaf_Loader::isLocalName - Indica si una clase es local - - - - &reftitle.description; - - public boolYaf_Loader::isLocalName - stringclass_name - - - Determina si un nombre de clase debe buscarse en el directorio de la - biblioteca local, es decir, si su prefijo pertenece a un namespace local - registrado. - - - - - &reftitle.parameters; - - - class_name - - El nombre de la clase a comprobar. - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si el nombre de la clase pertenece a un namespace local - registrado, &false; en caso contrario. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Loader::isLocalName</methodname> - -registerLocalNamespace(array("Models", "Services")); - -var_dump($loader->isLocalName("Models_Product")); -var_dump($loader->isLocalName("Vendor_Session")); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Loader::registerLocalNamespace - Yaf_Loader::getNamespacePath - - - - - - diff --git a/reference/yaf/yaf_loader/registerlocalnamespace.xml b/reference/yaf/yaf_loader/registerlocalnamespace.xml deleted file mode 100644 index 19a4eaec95..0000000000 --- a/reference/yaf/yaf_loader/registerlocalnamespace.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - Yaf_Loader::registerLocalNamespace - Registrar un namespace local - - - - &reftitle.description; - - public Yaf_LoaderfalseYaf_Loader::registerLocalNamespace - stringarraynamespace - stringpath&null; - - Registra un namespace local. Las clases cuyo prefijo pertenezca a un namespace local se buscan bajo la ruta indicada (o el directorio de biblioteca local si no se especifica ruta) en lugar del directorio global. - Esto permite colocar las propias clases en el directorio de biblioteca local, mientras que las clases compartidas residen en el directorio de biblioteca global (véase el parámetro yaf.library en php.ini). - - - - &reftitle.parameters; - - - namespace - - Una cadena de prefijo de namespace, o un array de pares prefijo/ruta (cuando el valor es una cadena de ruta) o cadenas de prefijos. - Un prefijo solo coincide en un límite de guión bajo o barra invertida: registrar Models hace que Models_User y Models sean locales, pero no ModelsUser. Se ignora la barra invertida inicial, y un nombre de clase escrito con barras invertidas se busca como si fueran guiones bajos. - - - - path - - El directorio en el que buscar el namespace. Si no se indica, se utiliza el directorio de biblioteca local. - - - - - - - &reftitle.returnvalues; - Devuelve la instancia del cargador en caso de éxito, o &false; si se proporciona un parámetro no válido. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Loader::registerLocalNamespace</methodname> - -registerLocalNamespace("Models"); - - /* se registran varios prefijos a la vez, cada uno con su - * propio directorio de búsqueda */ - $loader->registerLocalNamespace(array( - "Services" => APPLICATION_PATH . "/services", - "Vendor" => APPLICATION_PATH . "/vendor", - )); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Loader::getLocalNamespace - Yaf_Loader::clearLocalNamespace - Yaf_Loader::isLocalName - - - - - - diff --git a/reference/yaf/yaf_loader/registernamespace.xml b/reference/yaf/yaf_loader/registernamespace.xml deleted file mode 100644 index 9ac20c4dd7..0000000000 --- a/reference/yaf/yaf_loader/registernamespace.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - Yaf_Loader::registerNamespace - Alias de registerLocalNamespace - - - - &reftitle.description; - - public Yaf_LoaderfalseYaf_Loader::registerNamespace - stringarraynamespace - stringpath&null; - - Alias de Yaf_Loader::registerLocalNamespace. - - - - &reftitle.parameters; - - - namespace - - Una cadena de prefijo de namespace, o un array de pares prefijo/ruta (cuando el valor es una cadena de ruta) o cadenas de prefijos. - - - - path - - El directorio en el que buscar el namespace. Si no se indica, se utiliza el directorio de biblioteca local. - - - - - - - &reftitle.returnvalues; - Devuelve la instancia del cargador en caso de éxito, o &false; si se proporciona un parámetro no válido. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Loader::registerNamespace</methodname> - -registerNamespace( - "Vendor", - APPLICATION_PATH . "/library/Vendor" - ); - } -} - -/* new Vendor_Payment_Gateway() se busca ahora en - * APPLICATION_PATH/library/Vendor/Payment/Gateway.php */ -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Loader::registerLocalNamespace - - - - - - diff --git a/reference/yaf/yaf_loader/setlibrarypath.xml b/reference/yaf/yaf_loader/setlibrarypath.xml deleted file mode 100644 index ad6129c05a..0000000000 --- a/reference/yaf/yaf_loader/setlibrarypath.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - Yaf_Loader::setLibraryPath - Cambia la ruta de la biblioteca - - - - &reftitle.description; - - public Yaf_LoaderYaf_Loader::setLibraryPath - stringlibrary_path - boolis_globalfalse - - - Cambia el directorio de la biblioteca. - - - - - &reftitle.parameters; - - - library_path - - El nuevo directorio de la biblioteca. - - - - is_global - - - Si se debe cambiar el directorio de la biblioteca global en lugar del - local. - - - - - - - - &reftitle.returnvalues; -Devuelve el loader instance . - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Loader::setLibraryPath</methodname> - -setLibraryPath("/var/www/shop/application/library"); - -/* cambia el directorio de la biblioteca global */ -$loader->setLibraryPath("/usr/local/share/yaf/library", true); - -echo $loader->getLibraryPath(), PHP_EOL; -echo $loader->getLibraryPath(true), PHP_EOL; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Loader::getLibraryPath - - - - - - diff --git a/reference/yaf/yaf_plugin_abstract/dispatchloopshutdown.xml b/reference/yaf/yaf_plugin_abstract/dispatchloopshutdown.xml deleted file mode 100644 index af54064bc5..0000000000 --- a/reference/yaf/yaf_plugin_abstract/dispatchloopshutdown.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - Yaf_Plugin_Abstract::dispatchLoopShutdown - El propósito de dispatchLoopShutdown - - - - &reftitle.description; - - public voidYaf_Plugin_Abstract::dispatchLoopShutdown - Yaf_Request_Abstractrequest - Yaf_Response_Abstractresponse - - - Este enganche se dispara una sola vez, después de que el bucle de despacho - haya terminado y todas las acciones se hayan ejecutado, pero antes de que - la respuesta se envíe al cliente. Se usa habitualmente para el registro de - trazas o para tareas de limpieza. - - - - - &reftitle.parameters; - - - request - - - La instancia de Yaf_Request_Abstract que se está - despachando. - - - - - response - - La instancia de Yaf_Response_Abstract. - - - - - - - &reftitle.returnvalues; -No se devuelve ningún valor. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Plugin_Abstract::dispatchLoopShutdown</methodname> - -getRequestUri(), - $request->getControllerName(), - $request->getActionName() - )); - } -} - -/* los plugins se registran en el bootstrap */ -class Bootstrap extends Yaf_Bootstrap_Abstract -{ - public function _initPlugin(Yaf_Dispatcher $dispatcher) - { - $dispatcher->registerPlugin(new AccessLogPlugin()); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Plugin_Abstract::routerStartup - Yaf_Plugin_Abstract::routerShutdown - Yaf_Plugin_Abstract::dispatchLoopStartup - Yaf_Plugin_Abstract::preDispatch - Yaf_Plugin_Abstract::postDispatch - Yaf_Plugin_Abstract::preResponse - - - - - - diff --git a/reference/yaf/yaf_plugin_abstract/dispatchloopstartup.xml b/reference/yaf/yaf_plugin_abstract/dispatchloopstartup.xml deleted file mode 100644 index b136354f8e..0000000000 --- a/reference/yaf/yaf_plugin_abstract/dispatchloopstartup.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - Yaf_Plugin_Abstract::dispatchLoopStartup - Enganchar antes del bucle de envío - - - - &reftitle.description; - - public voidYaf_Plugin_Abstract::dispatchLoopStartup - Yaf_Request_Abstractrequest - Yaf_Response_Abstractresponse - - - Este enganche se dispara una sola vez, justo antes de que comience el bucle - de despacho y se inicialice el motor de vistas. - - - - - &reftitle.parameters; - - - request - - - La instancia de Yaf_Request_Abstract que se está - despachando. - - - - - response - - - La instancia de Yaf_Response_Abstract. - - - - - - - - &reftitle.returnvalues; -No se devuelve ningún valor. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Plugin_Abstract::dispatchLoopStartup</methodname> - -registerPlugin(new BenchmarkPlugin()); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Plugin_Abstract::routerStartup - Yaf_Plugin_Abstract::routerShutdown - Yaf_Plugin_Abstract::preDispatch - Yaf_Plugin_Abstract::postDispatch - Yaf_Plugin_Abstract::dispatchLoopShutdown - Yaf_Plugin_Abstract::preResponse - - - - - - diff --git a/reference/yaf/yaf_plugin_abstract/postdispatch.xml b/reference/yaf/yaf_plugin_abstract/postdispatch.xml deleted file mode 100644 index 8e39b0a0b1..0000000000 --- a/reference/yaf/yaf_plugin_abstract/postdispatch.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - Yaf_Plugin_Abstract::postDispatch - El propósito de postDispatch - - - - &reftitle.description; - - public voidYaf_Plugin_Abstract::postDispatch - Yaf_Request_Abstractrequest - Yaf_Response_Abstractresponse - - - Este enganche se dispara después de que termine cada iteración de despacho, - es decir, después de que la acción se haya ejecutado. Al igual que - Yaf_Plugin_Abstract::preDispatch, puede llamarse - más de una vez por petición. - - - - - - &reftitle.parameters; - - - request - - - La instancia de Yaf_Request_Abstract que se está - despachando. - - - - - response - - - La instancia de Yaf_Response_Abstract. - - - - - - - - &reftitle.returnvalues; -No se devuelve ningún valor. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Plugin_Abstract::postDispatch</methodname> - -appendBody(sprintf( - "\n", - $elapsed - )); - } -} - -/* los plugins se registran en el bootstrap */ -class Bootstrap extends Yaf_Bootstrap_Abstract -{ - public function _initPlugin(Yaf_Dispatcher $dispatcher) - { - $dispatcher->registerPlugin(new BenchmarkPlugin()); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Plugin_Abstract::routerStartup - Yaf_Plugin_Abstract::routerShutdown - Yaf_Plugin_Abstract::dispatchLoopStartup - Yaf_Plugin_Abstract::preDispatch - Yaf_Plugin_Abstract::dispatchLoopShutdown - Yaf_Plugin_Abstract::preResponse - - - - - - diff --git a/reference/yaf/yaf_plugin_abstract/predispatch.xml b/reference/yaf/yaf_plugin_abstract/predispatch.xml deleted file mode 100644 index b0db7a5d0e..0000000000 --- a/reference/yaf/yaf_plugin_abstract/predispatch.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - Yaf_Plugin_Abstract::preDispatch - El propósito de preDispatch - - - - &reftitle.description; - - public voidYaf_Plugin_Abstract::preDispatch - Yaf_Request_Abstractrequest - Yaf_Response_Abstractresponse - - - Este enganche se dispara antes de cada iteración del bucle de despacho. Un - bucle de despacho puede ejecutar varias iteraciones, por lo que este - enganche puede llamarse más de una vez por petición. - - - - - - &reftitle.parameters; - - - request - - - La instancia de Yaf_Request_Abstract que se está - despachando. - - - - - response - - - La instancia de Yaf_Response_Abstract. - - - - - - - - &reftitle.returnvalues; -No se devuelve ningún valor. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Plugin_Abstract::preDispatch</methodname> - -getView(); - if ($request->getModuleName() == "Admin") { - $view->setScriptPath(APPLICATION_PATH . "/modules/admin/views"); - } - } -} - -/* los plugins se registran en el bootstrap */ -class Bootstrap extends Yaf_Bootstrap_Abstract -{ - public function _initPlugin(Yaf_Dispatcher $dispatcher) - { - $dispatcher->registerPlugin(new LayoutPlugin()); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Plugin_Abstract::routerStartup - Yaf_Plugin_Abstract::routerShutdown - Yaf_Plugin_Abstract::dispatchLoopStartup - Yaf_Plugin_Abstract::postDispatch - Yaf_Plugin_Abstract::dispatchLoopShutdown - Yaf_Plugin_Abstract::preResponse - - - - - - diff --git a/reference/yaf/yaf_plugin_abstract/preresponse.xml b/reference/yaf/yaf_plugin_abstract/preresponse.xml deleted file mode 100644 index 822ba59c1a..0000000000 --- a/reference/yaf/yaf_plugin_abstract/preresponse.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - Yaf_Plugin_Abstract::preResponse - El propósito de preResponse - - - - &reftitle.description; - - public voidYaf_Plugin_Abstract::preResponse - Yaf_Request_Abstractrequest - Yaf_Response_Abstractresponse - - - Este enganche está pensado para dispararse antes de que la respuesta se - envíe al cliente. - - - - A partir de esta versión este enganche no se llama nunca: está registrado - en Yaf_Plugin_Abstract pero no está conectado al - flujo de despacho. Sobrescribirlo no tiene ningún efecto. - - - - - - &reftitle.parameters; - - - request - - - La instancia de Yaf_Request_Abstract que se está - despachando. - - - - - response - - La instancia de Yaf_Response_Abstract. - - - - - - - &reftitle.returnvalues; -No se devuelve ningún valor. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Plugin_Abstract::preResponse</methodname> - -setBody( - preg_replace("/>\s+<", $response->getBody()) - ); - } -} - -/* los plugins se registran en el bootstrap */ -class Bootstrap extends Yaf_Bootstrap_Abstract -{ - public function _initPlugin(Yaf_Dispatcher $dispatcher) - { - $dispatcher->registerPlugin(new MinifyPlugin()); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Plugin_Abstract::routerStartup - Yaf_Plugin_Abstract::routerShutdown - Yaf_Plugin_Abstract::dispatchLoopStartup - Yaf_Plugin_Abstract::preDispatch - Yaf_Plugin_Abstract::postDispatch - Yaf_Plugin_Abstract::dispatchLoopShutdown - - - - - - diff --git a/reference/yaf/yaf_plugin_abstract/routershutdown.xml b/reference/yaf/yaf_plugin_abstract/routershutdown.xml deleted file mode 100644 index 6fff5f8d1d..0000000000 --- a/reference/yaf/yaf_plugin_abstract/routershutdown.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - Yaf_Plugin_Abstract::routerShutdown - El propósito de routerShutdown - - - - &reftitle.description; - - public voidYaf_Plugin_Abstract::routerShutdown - Yaf_Request_Abstractrequest - Yaf_Response_Abstractresponse - - - Este enganche se dispara una vez terminado el proceso de enrutamiento y - resueltos los nombres del controlador y de la acción, pero antes de que - comience el bucle de despacho. Se usa habitualmente para comprobaciones de - control de acceso, como la verificación de identificación, porque el - controlador y la acción de destino ya se conocen. - - - - - &reftitle.parameters; - - - request - - - La instancia de Yaf_Request_Abstract que se está - despachando. - - - - - response - - La instancia de Yaf_Response_Abstract. - - - - - - - &reftitle.returnvalues; -No se devuelve ningún valor. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Plugin_Abstract::routerShutdown</methodname> - - array("index"), "User" => array("login")); - - $controller = $request->getControllerName(); - $action = $request->getActionName(); - - if (isset($public[$controller]) && in_array($action, $public[$controller])) { - return; - } - - if (!Yaf_Session::getInstance()->has("login")) { - $response->setRedirect("/user/login"); - $request->setDispatched(true); // no despachar la petición - } - } -} - -/* los plugins se registran en el bootstrap */ -class Bootstrap extends Yaf_Bootstrap_Abstract -{ - public function _initPlugin(Yaf_Dispatcher $dispatcher) - { - $dispatcher->registerPlugin(new AuthPlugin()); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Plugin_Abstract::routerStartup - Yaf_Plugin_Abstract::dispatchLoopStartup - Yaf_Plugin_Abstract::preDispatch - Yaf_Plugin_Abstract::postDispatch - Yaf_Plugin_Abstract::dispatchLoopShutdown - Yaf_Plugin_Abstract::preResponse - - - - - - diff --git a/reference/yaf/yaf_plugin_abstract/routerstartup.xml b/reference/yaf/yaf_plugin_abstract/routerstartup.xml deleted file mode 100644 index e0b77f4762..0000000000 --- a/reference/yaf/yaf_plugin_abstract/routerstartup.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - Yaf_Plugin_Abstract::routerStartup - Enganche deEl propósito de routerStartup - - - - &reftitle.description; - - public voidYaf_Plugin_Abstract::routerStartup - Yaf_Request_Abstractrequest - Yaf_Response_Abstractresponse - - - Este enganche se dispara justo antes de que se enrute la petición. Es el - primer enganche del flujo de despacho, por lo que se usa habitualmente para - la reescritura de URL o para decisiones de enrutamiento que deben tomarse - antes de que se ejecute Yaf_Router::route. - - - - - &reftitle.parameters; - - - request - - - La instancia de Yaf_Request_Abstract que se está - despachando. - - - - - response - - La instancia de Yaf_Response_Abstract. - - - - - - - &reftitle.returnvalues; -No se devuelve ningún valor. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Plugin_Abstract::routerStartup</methodname> - -getRequestUri(); - if (preg_match("#^/[a-z]+$#", $uri)) { - $request->setRequestUri("/page" . $uri); - } - } -} - -/* los plugins se registran en el bootstrap */ -class Bootstrap extends Yaf_Bootstrap_Abstract -{ - public function _initPlugin(Yaf_Dispatcher $dispatcher) - { - $dispatcher->registerPlugin(new RewritePlugin()); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Plugin_Abstract::routerShutdown - Yaf_Plugin_Abstract::dispatchLoopStartup - Yaf_Plugin_Abstract::preDispatch - Yaf_Plugin_Abstract::postDispatch - Yaf_Plugin_Abstract::dispatchLoopShutdown - Yaf_Plugin_Abstract::preResponse - - - - - - diff --git a/reference/yaf/yaf_registry/construct.xml b/reference/yaf/yaf_registry/construct.xml deleted file mode 100644 index 9b847a5bad..0000000000 --- a/reference/yaf/yaf_registry/construct.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Yaf_Registry::__construct - Yaf_Registry implementa «singleton» - - - - &reftitle.description; - - private Yaf_Registry::__construct - - - - El constructor es privado: Yaf_Registry implementa - el patrón singleton y no puede instanciarse directamente. Se usan los - métodos estáticos para leer y escribir las entradas del registro. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -No se devuelve ningún valor. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Registry::__construct</methodname> - - El constructor es privado, así que la instanciación directa se rechaza: - - - -]]> - - &example.outputs.similar; - - - - - - Uso de <classname>Yaf_Registry</classname> mediante sus métodos estáticos - -getConfig()->application->version); -var_dump(Yaf_Registry::get("version")); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Registry::set - Yaf_Registry::get - Yaf_Registry::has - - - - - - diff --git a/reference/yaf/yaf_registry/del.xml b/reference/yaf/yaf_registry/del.xml deleted file mode 100644 index d5f414508f..0000000000 --- a/reference/yaf/yaf_registry/del.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Yaf_Registry::del - Elimina un elemento del registro - - - - &reftitle.description; - - public static boolYaf_Registry::del - stringname - - - Elimina un elemento del registro. - - - - - &reftitle.parameters; - - - name - - - El nombre de la entrada del registro. - - - - - - - - &reftitle.returnvalues; -Siempre devuelve &true;. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Registry::del</methodname> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Registry::get - Yaf_Registry::set - Yaf_Registry::has - - - - - - diff --git a/reference/yaf/yaf_registry/get.xml b/reference/yaf/yaf_registry/get.xml deleted file mode 100644 index 8989c8e3df..0000000000 --- a/reference/yaf/yaf_registry/get.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - Yaf_Registry::get - Recupera un elemento del registro - - - - &reftitle.description; - - public static mixedYaf_Registry::get - stringname - - - Recupera un elemento del registro. - - - - - &reftitle.parameters; - - - name - - - El nombre de la entrada del registro. - - - - - - - - &reftitle.returnvalues; -El valor almacenado bajo name, o &null; si no existe ninguna entrada con ese nombre. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Registry::get</methodname> - -getView()->assign("visits", $redis->get("site:visits")); - - return true; - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Registry::set - Yaf_Registry::has - Yaf_Registry::del - - - - - - diff --git a/reference/yaf/yaf_registry/has.xml b/reference/yaf/yaf_registry/has.xml deleted file mode 100644 index 6aca6c9879..0000000000 --- a/reference/yaf/yaf_registry/has.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Yaf_Registry::has - Comprueba si existe un elemento - - - - &reftitle.description; - - public static boolYaf_Registry::has - stringname - - - Comprueba si existe un elemento. - - - - - &reftitle.parameters; - - - name - - - El nombre de la entrada del registro. - - - - - - - - &reftitle.returnvalues; -Devuelve &true; si existe una entrada con el nombre indicado, &false; en caso contrario. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Registry::has</methodname> - -getConfig()->redis; - - $redis = new Redis(); - $redis->connect($config->host, $config->port); - - Yaf_Registry::set("redis", $redis); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Registry::get - Yaf_Registry::set - Yaf_Registry::del - - - - - - diff --git a/reference/yaf/yaf_registry/set.xml b/reference/yaf/yaf_registry/set.xml deleted file mode 100644 index 2f1af8edeb..0000000000 --- a/reference/yaf/yaf_registry/set.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - Yaf_Registry::set - Añade un elemento al registro - - - - &reftitle.description; - - public static boolYaf_Registry::set - stringname - mixedvalue - - - Añade un elemento al registro. - - - - - &reftitle.parameters; - - - name - - - El nombre de la entrada del registro. - - - - - value - - - El valor a almacenar; puede ser de cualquier tipo, incluidos objetos. - - - - - - - - &reftitle.returnvalues; -Devuelve &true; en caso de éxito, o &false; en caso de error. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Registry::set</methodname> - -getConfig()->redis; - - $redis = new Redis(); - $redis->connect($config->host, $config->port); - - /* la conexión está ahora disponible para toda la aplicación */ - Yaf_Registry::set("redis", $redis); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Registry::get - Yaf_Registry::has - Yaf_Registry::del - - - - - - diff --git a/reference/yaf/yaf_request_abstract/clearparams.xml b/reference/yaf/yaf_request_abstract/clearparams.xml deleted file mode 100644 index a91f1db732..0000000000 --- a/reference/yaf/yaf_request_abstract/clearparams.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Yaf_Request_Abstract::clearParams - Eliminar todos los parámetros - - - - &reftitle.description; - - public Yaf_Request_AbstractnullYaf_Request_Abstract::clearParams - - - - Eliminar todos los parámetros establecidos por el router, o Yaf_Request_Abstract::setParam - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &boolean; - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::clearParams</methodname> - -getRequest(); - - $request->setParam("referrer", "newsletter"); - var_dump($request->getParam("referrer")); - - $request->clearParams(); - var_dump($request->getParam("referrer")); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::setParam - Yaf_Request_Abstract::getParam - Yaf_Request_Abstract::getParams - - - - - - diff --git a/reference/yaf/yaf_request_abstract/get.xml b/reference/yaf/yaf_request_abstract/get.xml deleted file mode 100644 index 02e951821f..0000000000 --- a/reference/yaf/yaf_request_abstract/get.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - Yaf_Request_Abstract::get - Obtener una variable de la petición - - - - &reftitle.description; - - public mixedYaf_Request_Abstract::get - stringname - mixeddefault - - Obtiene una variable de la petición. El orden de búsqueda es: parámetros de la petición definidos por Yaf_Request_Abstract::setParam, luego POST, GET, COOKIE, SERVER. - - - - &reftitle.parameters; - - - name - - El nombre de la variable. - - - - default - - El valor a devolver si la variable no se encuentra. - - - - - - - &reftitle.returnvalues; - El valor si se encuentra, o default si se proporcionó, &null; en caso contrario. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::get</methodname> - -getRequest(); - - // Suponiendo que la petición es /search?keyword=yaf&page=2 - $keyword = $request->get("keyword"); - $page = (int) $request->get("page", 1); - $sort = $request->get("sort", "relevance"); - - var_dump($keyword, $page, $sort); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getQuery - Yaf_Request_Abstract::getRequest - Yaf_Request_Abstract::getPost - Yaf_Request_Abstract::getCookie - Yaf_Request_Abstract::getFiles - Yaf_Request_Abstract::getParam - - - - - - diff --git a/reference/yaf/yaf_request_abstract/getactionname.xml b/reference/yaf/yaf_request_abstract/getactionname.xml deleted file mode 100644 index 4bdc182153..0000000000 --- a/reference/yaf/yaf_request_abstract/getactionname.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Yaf_Request_Abstract::getActionName - El propósito de getActionName - - - - &reftitle.description; - - public stringnullYaf_Request_Abstract::getActionName - - - - Recupera el nombre de la acción. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -El nombre de la acción, o &null; si no está definido. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::getActionName</methodname> - -getRequest()->getActionName()); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getModuleName - Yaf_Request_Abstract::getControllerName - Yaf_Request_Abstract::getActionName - Yaf_Request_Abstract::setModuleName - Yaf_Request_Abstract::setControllerName - Yaf_Request_Abstract::setActionName - - - - - - diff --git a/reference/yaf/yaf_request_abstract/getbaseuri.xml b/reference/yaf/yaf_request_abstract/getbaseuri.xml deleted file mode 100644 index 6053e86d6f..0000000000 --- a/reference/yaf/yaf_request_abstract/getbaseuri.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - Yaf_Request_Abstract::getBaseUri - El propósito de getBaseUri - - - - &reftitle.description; - - public stringnullYaf_Request_Abstract::getBaseUri - - - - Recupera el URI base. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -El URI base, o una cadena vacía si no está definido. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::getBaseUri</methodname> - -getRequest(); - - // Suponiendo que la aplicación se sirve bajo /myapp, - // y que la petición es /myapp/product/view - var_dump($request->getBaseUri()); - var_dump($request->getRequestUri()); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::setBaseUri - Yaf_Request_Abstract::getRequestUri - Yaf_Request_Abstract::setRequestUri - - - - - - diff --git a/reference/yaf/yaf_request_abstract/getcontrollername.xml b/reference/yaf/yaf_request_abstract/getcontrollername.xml deleted file mode 100644 index 23cee0c448..0000000000 --- a/reference/yaf/yaf_request_abstract/getcontrollername.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Yaf_Request_Abstract::getControllerName - El propósito de getControllerName - - - - &reftitle.description; - - public stringnullYaf_Request_Abstract::getControllerName - - - - Recupera el nombre del controlador. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -El nombre del controlador, o &null; si no está definido. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::getControllerName</methodname> - -getRequest()->getControllerName()); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getModuleName - Yaf_Request_Abstract::getControllerName - Yaf_Request_Abstract::getActionName - Yaf_Request_Abstract::setModuleName - Yaf_Request_Abstract::setControllerName - Yaf_Request_Abstract::setActionName - - - - - - diff --git a/reference/yaf/yaf_request_abstract/getcookie.xml b/reference/yaf/yaf_request_abstract/getcookie.xml deleted file mode 100644 index b53b2a0b0c..0000000000 --- a/reference/yaf/yaf_request_abstract/getcookie.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - Yaf_Request_Abstract::getCookie - Obtener una variable COOKIE - - - - &reftitle.description; - - public mixedYaf_Request_Abstract::getCookie - stringname - mixeddefault - - Obtiene una variable de $_COOKIE. - - - - &reftitle.parameters; - - - name - - El nombre de la variable. Si se omite, se devuelve el array completo. - - - - default - - El valor a devolver si la variable no se encuentra. - - - - - - - &reftitle.returnvalues; - El valor de la cookie, o default si no está definida. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::getCookie</methodname> - -getRequest(); - - $theme = $request->getCookie("theme", "light"); - $sessionId = $request->getCookie("sid"); - - var_dump($theme, $sessionId); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getQuery - Yaf_Request_Abstract::getRequest - Yaf_Request_Abstract::getPost - Yaf_Request_Abstract::getCookie - Yaf_Request_Abstract::getFiles - Yaf_Request_Abstract::getParam - - - - - - diff --git a/reference/yaf/yaf_request_abstract/getenv.xml b/reference/yaf/yaf_request_abstract/getenv.xml deleted file mode 100644 index a62e238520..0000000000 --- a/reference/yaf/yaf_request_abstract/getenv.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - Yaf_Request_Abstract::getEnv - Recupera la variable ENV - - - - &reftitle.description; - - public mixedYaf_Request_Abstract::getEnv - stringname - mixeddefault - - - Recupera la variable ENV. - - - - - &reftitle.parameters; - - - name - - - El nombre de la varaible. - - - - - default - - - Si se proporciona este parámetro, se devolverá si la variable no puede - ser encontrada. - - - - - - - - &reftitle.returnvalues; - - Devuelve un string - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::getEnv</methodname> - -getRequest()->getEnv("APPLICATION_ENV", "production"); - - var_dump($env); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getQuery - Yaf_Request_Abstract::getRequest - Yaf_Request_Abstract::getPost - Yaf_Request_Abstract::getCookie - Yaf_Request_Abstract::getFiles - Yaf_Request_Abstract::getParam - - - - - - diff --git a/reference/yaf/yaf_request_abstract/getexception.xml b/reference/yaf/yaf_request_abstract/getexception.xml deleted file mode 100644 index 96b9d4e642..0000000000 --- a/reference/yaf/yaf_request_abstract/getexception.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - Yaf_Request_Abstract::getException - El propósito de getException - - - - &reftitle.description; - - public ExceptionnullYaf_Request_Abstract::getException - - - - Recupera la excepción capturada durante el despacho. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - La Exception capturada durante el despacho, o &null; si no hay ninguna. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::getException</methodname> - -catchException(true); - -class ErrorController extends Yaf_Controller_Abstract -{ - public function errorAction($exception) - { - var_dump($this->getRequest()->getException() === $exception); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Dispatcher::catchException - - - - - - diff --git a/reference/yaf/yaf_request_abstract/getfiles.xml b/reference/yaf/yaf_request_abstract/getfiles.xml deleted file mode 100644 index e914e37ef9..0000000000 --- a/reference/yaf/yaf_request_abstract/getfiles.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - Yaf_Request_Abstract::getFiles - Obtener los ficheros subidos - - - - &reftitle.description; - - public mixedYaf_Request_Abstract::getFiles - stringname - mixeddefault - - Obtiene una variable de $_FILES. - - - - &reftitle.parameters; - - - name - - El nombre de la variable. Si se omite, se devuelve el array completo. - - - - default - - El valor a devolver si la variable no se encuentra. - - - - - - - &reftitle.returnvalues; - El array de ficheros subidos, o default si no está definido. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::getFiles</methodname> - -getRequest()->getFiles("avatar"); - - if (is_array($file) && $file["error"] === UPLOAD_ERR_OK) { - move_uploaded_file( - $file["tmp_name"], - "/var/www/uploads/" . basename($file["name"]) - ); - } - } -} -?>]]> - - - - Ejemplo de <methodname>Yaf_Request_Abstract::getFiles</methodname> - -getRequest()->getFiles("avatar")); - } -} -?>]]> - - &example.outputs.similar; - - - string(9) "photo.jpg" - ["type"]=> - string(10) "image/jpeg" - ["tmp_name"]=> - string(14) "/tmp/phpXvBXqZ" - ["error"]=> - int(0) - ["size"]=> - int(12455) -} -]]> - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getQuery - Yaf_Request_Abstract::getRequest - Yaf_Request_Abstract::getPost - Yaf_Request_Abstract::getCookie - Yaf_Request_Abstract::getFiles - Yaf_Request_Abstract::getParam - - - - - - diff --git a/reference/yaf/yaf_request_abstract/getlanguage.xml b/reference/yaf/yaf_request_abstract/getlanguage.xml deleted file mode 100644 index e7b8dd3c24..0000000000 --- a/reference/yaf/yaf_request_abstract/getlanguage.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - Yaf_Request_Abstract::getLanguage - Recupera el lenguaje preferido del cliente - - - - &reftitle.description; - - public stringnullYaf_Request_Abstract::getLanguage - - - - Recuperar el lenguaje preferido del cliente - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un string - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::getLanguage</methodname> - -getRequest()->getLanguage(); - - var_dump($language); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getServer - Yaf_Request_Abstract::getEnv - - - - - - diff --git a/reference/yaf/yaf_request_abstract/getmethod.xml b/reference/yaf/yaf_request_abstract/getmethod.xml deleted file mode 100644 index a9cc0b9f59..0000000000 --- a/reference/yaf/yaf_request_abstract/getmethod.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - Yaf_Request_Abstract::getMethod - Recupera el método de solicitud - - - - &reftitle.description; - - public stringnullYaf_Request_Abstract::getMethod - - - - Recuperar el método de solicitud - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un string, como "POST", "GET", etc. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::getMethod</methodname> - -getRequest(); - - // Suponiendo que la petición se ha enviado con POST /order/save - var_dump($request->getMethod()); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::isGet - Yaf_Request_Abstract::isPost - Yaf_Request_Abstract::isPut - Yaf_Request_Abstract::isHead - Yaf_Request_Abstract::isOptions - Yaf_Request_Abstract::isDelete - Yaf_Request_Abstract::isPatch - Yaf_Request_Abstract::isCli - Yaf_Request_Abstract::isXmlHttpRequest - - - - - - diff --git a/reference/yaf/yaf_request_abstract/getmodulename.xml b/reference/yaf/yaf_request_abstract/getmodulename.xml deleted file mode 100644 index 6f41aa586e..0000000000 --- a/reference/yaf/yaf_request_abstract/getmodulename.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Yaf_Request_Abstract::getModuleName - El propósito de getModuleName - - - - &reftitle.description; - - public stringnullYaf_Request_Abstract::getModuleName - - - - Recupera el nombre del módulo. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -El nombre del módulo, o &null; si no está definido. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::getModuleName</methodname> - -getRequest()->getModuleName()); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getModuleName - Yaf_Request_Abstract::getControllerName - Yaf_Request_Abstract::getActionName - Yaf_Request_Abstract::setModuleName - Yaf_Request_Abstract::setControllerName - Yaf_Request_Abstract::setActionName - - - - - - diff --git a/reference/yaf/yaf_request_abstract/getparam.xml b/reference/yaf/yaf_request_abstract/getparam.xml deleted file mode 100644 index 305bd07ffc..0000000000 --- a/reference/yaf/yaf_request_abstract/getparam.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - Yaf_Request_Abstract::getParam - Recupera el parámetro de llamada - - - - &reftitle.description; - - public mixedYaf_Request_Abstract::getParam - stringname - mixeddefault - - - Recuperar el parámetro de llamada - - - - - - &reftitle.parameters; - - - name - - - El nombre del argumento. - - - - - default - - - El valor a devolver si el argumento no está definido. - - - - - - - - &reftitle.returnvalues; -El valor del parámetro, o default si se proporcionó, &null; en caso contrario. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::getParam</methodname> - -getRequest(); - - // Suponiendo que la petición es /product/view/id/17 - $id = (int) $request->getParam("id"); - $referrer = $request->getParam("referrer", "direct"); - - var_dump($id, $referrer); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::setParam - Yaf_Request_Abstract::getParams - Yaf_Request_Abstract::clearParams - Yaf_Request_Abstract::get - - - - - - diff --git a/reference/yaf/yaf_request_abstract/getparams.xml b/reference/yaf/yaf_request_abstract/getparams.xml deleted file mode 100644 index e0d7533037..0000000000 --- a/reference/yaf/yaf_request_abstract/getparams.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Yaf_Request_Abstract::getParams - Recupera todos los parámetros de llamada - - - - &reftitle.description; - - public arraynullYaf_Request_Abstract::getParams - - - - Recuperar todos los parámetros de llamada - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -Un array con todos los parámetros, o &null; si no hay ninguno. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::getParams</methodname> - -getRequest()->getParams()); - } -} -?>]]> - - &example.outputs.similar; - - - string(2) "17" - ["sort"]=> - string(5) "price" -} -]]> - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::setParam - Yaf_Request_Abstract::getParam - Yaf_Request_Abstract::clearParams - - - - - - diff --git a/reference/yaf/yaf_request_abstract/getpost.xml b/reference/yaf/yaf_request_abstract/getpost.xml deleted file mode 100644 index 47d89fe72f..0000000000 --- a/reference/yaf/yaf_request_abstract/getpost.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - Yaf_Request_Abstract::getPost - Obtener un parámetro POST - - - - &reftitle.description; - - public mixedYaf_Request_Abstract::getPost - stringname - mixeddefault - - Obtiene una variable de $_POST. - - - - &reftitle.parameters; - - - name - - El nombre de la variable. Si se omite, se devuelve el array completo. - - - - default - - El valor a devolver si la variable no se encuentra. - - - - - - - &reftitle.returnvalues; - El valor del parámetro POST, o default si no está definido. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::getPost</methodname> - -getRequest()->isPost()) { - $username = $this->getRequest()->getPost("username"); - $remember = $this->getRequest()->getPost("remember", "no"); - - var_dump($username, $remember); - } - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getQuery - Yaf_Request_Abstract::getRequest - Yaf_Request_Abstract::getPost - Yaf_Request_Abstract::getCookie - Yaf_Request_Abstract::getFiles - Yaf_Request_Abstract::getParam - - - - - - diff --git a/reference/yaf/yaf_request_abstract/getquery.xml b/reference/yaf/yaf_request_abstract/getquery.xml deleted file mode 100644 index 96126503cb..0000000000 --- a/reference/yaf/yaf_request_abstract/getquery.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - Yaf_Request_Abstract::getQuery - Obtener un parámetro de la cadena de consulta - - - - &reftitle.description; - - public mixedYaf_Request_Abstract::getQuery - stringname - mixeddefault - - Obtiene una variable de $_GET. - - - - &reftitle.parameters; - - - name - - El nombre de la variable. Si se omite, se devuelve el array completo. - - - - default - - El valor a devolver si la variable no se encuentra. - - - - - - - &reftitle.returnvalues; - El valor del parámetro de consulta, o default si no está definido. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::getQuery</methodname> - -getRequest()->getQuery("keyword"); - $page = (int) $this->getRequest()->getQuery("page", 1); - - var_dump($keyword, $page); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getQuery - Yaf_Request_Abstract::getRequest - Yaf_Request_Abstract::getPost - Yaf_Request_Abstract::getCookie - Yaf_Request_Abstract::getFiles - Yaf_Request_Abstract::getParam - - - - - - diff --git a/reference/yaf/yaf_request_abstract/getraw.xml b/reference/yaf/yaf_request_abstract/getraw.xml deleted file mode 100644 index 5fb707d140..0000000000 --- a/reference/yaf/yaf_request_abstract/getraw.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - Yaf_Request_Abstract::getRaw - Obtener el cuerpo sin procesar de la petición - - - - &reftitle.description; - - public stringnullYaf_Request_Abstract::getRaw - - - Obtiene el cuerpo sin procesar de la petición. - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - El cuerpo sin procesar de la petición como cadena, o &null; en caso de error. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::getRaw</methodname> - -getRequest()->getRaw(); - $data = json_decode($raw, true); - - var_dump($data); - } -} -?>]]> - - &example.outputs.similar; - - - string(3) "yaf" - ["version"]=> - int(3) -} -]]> - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getQuery - Yaf_Request_Abstract::getRequest - Yaf_Request_Abstract::getPost - Yaf_Request_Abstract::getCookie - Yaf_Request_Abstract::getFiles - Yaf_Request_Abstract::getParam - - - - - - diff --git a/reference/yaf/yaf_request_abstract/getrequest.xml b/reference/yaf/yaf_request_abstract/getrequest.xml deleted file mode 100644 index 543058058a..0000000000 --- a/reference/yaf/yaf_request_abstract/getrequest.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - Yaf_Request_Abstract::getRequest - Obtener una variable REQUEST - - - - &reftitle.description; - - public mixedYaf_Request_Abstract::getRequest - stringname - mixeddefault - - Obtiene una variable de $_REQUEST. - - - - &reftitle.parameters; - - - name - - El nombre de la variable. Si se omite, se devuelve el array completo. - - - - default - - El valor a devolver si la variable no se encuentra. - - - - - - - &reftitle.returnvalues; - El valor de la variable $_REQUEST, o default si no está definida. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::getRequest</methodname> - -getRequest()->getRequest("keyword"); - $source = $this->getRequest()->getRequest("source", "web"); - - var_dump($keyword, $source); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getQuery - Yaf_Request_Abstract::getRequest - Yaf_Request_Abstract::getPost - Yaf_Request_Abstract::getCookie - Yaf_Request_Abstract::getFiles - Yaf_Request_Abstract::getParam - - - - - - diff --git a/reference/yaf/yaf_request_abstract/getrequesturi.xml b/reference/yaf/yaf_request_abstract/getrequesturi.xml deleted file mode 100644 index 440eadebd8..0000000000 --- a/reference/yaf/yaf_request_abstract/getrequesturi.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Yaf_Request_Abstract::getRequestUri - El propósito de getRequestUri - - - - &reftitle.description; - - public stringnullYaf_Request_Abstract::getRequestUri - - - - Recupera el URI de la petición. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -El URI de la petición, o una cadena vacía si no está definido. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::getRequestUri</methodname> - -getRequest()->getRequestUri()); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::setRequestUri - Yaf_Request_Abstract::getBaseUri - Yaf_Request_Abstract::setBaseUri - - - - - - diff --git a/reference/yaf/yaf_request_abstract/getserver.xml b/reference/yaf/yaf_request_abstract/getserver.xml deleted file mode 100644 index 8b7647b317..0000000000 --- a/reference/yaf/yaf_request_abstract/getserver.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - Yaf_Request_Abstract::getServer - Recupera la variable SERVER - - - - &reftitle.description; - - public mixedYaf_Request_Abstract::getServer - stringname - mixeddefault - - - Recupera la variable SERVER. - - - - - &reftitle.parameters; - - - name - - - El nombre de la variable - - - - - default - - - Si se proporciona este parámetro, se devolverá si la variable no puede - ser encontrada. - - - - - - - - &reftitle.returnvalues; -El valor de la variable, o default si no se encuentra. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::getServer</methodname> - -getRequest(); - - $host = $request->getServer("HTTP_HOST"); - $protocol = $request->getServer("SERVER_PROTOCOL", "HTTP/1.1"); - - var_dump($host, $protocol); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getQuery - Yaf_Request_Abstract::getRequest - Yaf_Request_Abstract::getPost - Yaf_Request_Abstract::getCookie - Yaf_Request_Abstract::getFiles - Yaf_Request_Abstract::getParam - - - - - - diff --git a/reference/yaf/yaf_request_abstract/iscli.xml b/reference/yaf/yaf_request_abstract/iscli.xml deleted file mode 100644 index e57a29b1e8..0000000000 --- a/reference/yaf/yaf_request_abstract/iscli.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - Yaf_Request_Abstract::isCli - Determina si la solicitud es una solicitud CLI - - - - &reftitle.description; - - public boolYaf_Request_Abstract::isCli - - - - Determinar si la solicitud es una solicitud CLI - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - boolean - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::isCli</methodname> - -isCli()); -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::isGet - Yaf_Request_Abstract::isPost - Yaf_Request_Abstract::isPut - Yaf_Request_Abstract::isHead - Yaf_Request_Abstract::isOptions - Yaf_Request_Abstract::isDelete - Yaf_Request_Abstract::isPatch - Yaf_Request_Abstract::isXmlHttpRequest - - - - - - diff --git a/reference/yaf/yaf_request_abstract/isdelete.xml b/reference/yaf/yaf_request_abstract/isdelete.xml deleted file mode 100644 index 30cdb2bc2c..0000000000 --- a/reference/yaf/yaf_request_abstract/isdelete.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - Yaf_Request_Abstract::isDelete - Determinar si la petición es de tipo DELETE - - - - &reftitle.description; - - public boolYaf_Request_Abstract::isDelete - - - Comprueba si la petición fue enviada con el método DELETE. - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - Devuelve &true; si el método de la petición es DELETE, &false; en caso contrario. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::isDelete</methodname> - -getRequest()->isDelete()); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::isGet - Yaf_Request_Abstract::isPost - Yaf_Request_Abstract::isPut - Yaf_Request_Abstract::isHead - Yaf_Request_Abstract::isOptions - Yaf_Request_Abstract::isPatch - Yaf_Request_Abstract::isCli - Yaf_Request_Abstract::isXmlHttpRequest - - - - - - diff --git a/reference/yaf/yaf_request_abstract/isdispatched.xml b/reference/yaf/yaf_request_abstract/isdispatched.xml deleted file mode 100644 index c3d2e9656a..0000000000 --- a/reference/yaf/yaf_request_abstract/isdispatched.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - Yaf_Request_Abstract::isDispatched - Determina si la solicitud es enviada - - - - &reftitle.description; - - public boolYaf_Request_Abstract::isDispatched - - - - Determinar si la solicitud es enviada - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - boolean - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::isDispatched</methodname> - -getRequest()->setDispatched(); - - var_dump($this->getRequest()->isDispatched()); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Dispatcher::dispatch - Yaf_Request_Abstract::setDispatched - - - - - - diff --git a/reference/yaf/yaf_request_abstract/isget.xml b/reference/yaf/yaf_request_abstract/isget.xml deleted file mode 100644 index 1808640b41..0000000000 --- a/reference/yaf/yaf_request_abstract/isget.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - Yaf_Request_Abstract::isGet - Determina si la solicitud es una solicitud GET - - - - &reftitle.description; - - public boolYaf_Request_Abstract::isGet - - - - Determinar si la solicitud es una solicitud GET - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - boolean - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::isGet</methodname> - -getRequest(); - - // Suponiendo que la petición se ha enviado con GET /index - var_dump($request->isGet(), $request->isPost()); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::isPost - Yaf_Request_Abstract::isPut - Yaf_Request_Abstract::isHead - Yaf_Request_Abstract::isOptions - Yaf_Request_Abstract::isDelete - Yaf_Request_Abstract::isPatch - Yaf_Request_Abstract::isCli - Yaf_Request_Abstract::isXmlHttpRequest - - - - - - diff --git a/reference/yaf/yaf_request_abstract/ishead.xml b/reference/yaf/yaf_request_abstract/ishead.xml deleted file mode 100644 index 081a87f646..0000000000 --- a/reference/yaf/yaf_request_abstract/ishead.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Yaf_Request_Abstract::isHead - Determina si la solicitud es una solicitud HEAD - - - - &reftitle.description; - - public boolYaf_Request_Abstract::isHead - - - - Comprueba si la petición se ha enviado con el método HEAD. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - boolean - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::isHead</methodname> - -getRequest()->isHead()) { - // solo cabeceras, se omite el renderizado del cuerpo - return false; - } - } -} -?>]]> - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::isGet - Yaf_Request_Abstract::isPost - Yaf_Request_Abstract::isPut - Yaf_Request_Abstract::isOptions - Yaf_Request_Abstract::isDelete - Yaf_Request_Abstract::isPatch - Yaf_Request_Abstract::isCli - Yaf_Request_Abstract::isXmlHttpRequest - - - - - - diff --git a/reference/yaf/yaf_request_abstract/isoptions.xml b/reference/yaf/yaf_request_abstract/isoptions.xml deleted file mode 100644 index dc63d114a3..0000000000 --- a/reference/yaf/yaf_request_abstract/isoptions.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - Yaf_Request_Abstract::isOptions - Determina si la solicitud es una solicitud de OPCIONES - - - - &reftitle.description; - - public boolYaf_Request_Abstract::isOptions - - - - Comprueba si la petición se ha enviado con el método OPTIONS. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - boolean - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::isOptions</methodname> - -getRequest()->isOptions()) { - $this->getResponse() - ->setHeader("Allow", "GET, POST, OPTIONS") - ->setBody(""); - return false; - } - } -} -?>]]> - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::isGet - Yaf_Request_Abstract::isPost - Yaf_Request_Abstract::isPut - Yaf_Request_Abstract::isHead - Yaf_Request_Abstract::isDelete - Yaf_Request_Abstract::isPatch - Yaf_Request_Abstract::isCli - Yaf_Request_Abstract::isXmlHttpRequest - - - - - - diff --git a/reference/yaf/yaf_request_abstract/ispatch.xml b/reference/yaf/yaf_request_abstract/ispatch.xml deleted file mode 100644 index 21de552862..0000000000 --- a/reference/yaf/yaf_request_abstract/ispatch.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - Yaf_Request_Abstract::isPatch - Determinar si la petición es de tipo PATCH - - - - &reftitle.description; - - public boolYaf_Request_Abstract::isPatch - - - Comprueba si la petición fue enviada con el método PATCH. - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - Devuelve &true; si el método de la petición es PATCH, &false; en caso contrario. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::isPatch</methodname> - -getRequest()->isPatch()); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::isGet - Yaf_Request_Abstract::isPost - Yaf_Request_Abstract::isPut - Yaf_Request_Abstract::isHead - Yaf_Request_Abstract::isOptions - Yaf_Request_Abstract::isDelete - Yaf_Request_Abstract::isCli - Yaf_Request_Abstract::isXmlHttpRequest - - - - - - diff --git a/reference/yaf/yaf_request_abstract/ispost.xml b/reference/yaf/yaf_request_abstract/ispost.xml deleted file mode 100644 index 512d0284d1..0000000000 --- a/reference/yaf/yaf_request_abstract/ispost.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Yaf_Request_Abstract::isPost - Determina si la solicitud es una solicitud POST - - - - &reftitle.description; - - public boolYaf_Request_Abstract::isPost - - - - Determinar si la solicitud es una solicitud POST - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - boolean - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::isPost</methodname> - -getRequest()->isPost()); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::isGet - Yaf_Request_Abstract::isPut - Yaf_Request_Abstract::isHead - Yaf_Request_Abstract::isOptions - Yaf_Request_Abstract::isDelete - Yaf_Request_Abstract::isPatch - Yaf_Request_Abstract::isCli - Yaf_Request_Abstract::isXmlHttpRequest - - - - - - diff --git a/reference/yaf/yaf_request_abstract/isput.xml b/reference/yaf/yaf_request_abstract/isput.xml deleted file mode 100644 index df8a07e2bd..0000000000 --- a/reference/yaf/yaf_request_abstract/isput.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - Yaf_Request_Abstract::isPut - Determina si la solicitud es una solicitud PUT - - - - &reftitle.description; - - public boolYaf_Request_Abstract::isPut - - - - Determinar si la solicitud es una solicitud PUT - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - boolean - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::isPut</methodname> - -getRequest()->isPut()) { - $payload = $this->getRequest()->getRaw(); - } - - var_dump($this->getRequest()->isPut()); - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::isGet - Yaf_Request_Abstract::isPost - Yaf_Request_Abstract::isHead - Yaf_Request_Abstract::isOptions - Yaf_Request_Abstract::isDelete - Yaf_Request_Abstract::isPatch - Yaf_Request_Abstract::isCli - Yaf_Request_Abstract::isXmlHttpRequest - - - - - - diff --git a/reference/yaf/yaf_request_abstract/isrouted.xml b/reference/yaf/yaf_request_abstract/isrouted.xml deleted file mode 100644 index 43cb71bb16..0000000000 --- a/reference/yaf/yaf_request_abstract/isrouted.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Yaf_Request_Abstract::isRouted - Determina si la solicitud ha sido enrutada - - - - &reftitle.description; - - public boolYaf_Request_Abstract::isRouted - - - - Determinar si la solicitud ha sido enrutada - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - boolean - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::isRouted</methodname> - -isRouted()) { - return false; - } - - if (0 === strpos($request->getRequestUri(), "/api/")) { - $request->setControllerName("Api") - ->setActionName("handle"); - return true; - } - - return false; - } - - public function assemble(array $info, array $query = null) {} -} -?>]]> - - - - - - &reftitle.seealso; - - Yaf_Router::route - Yaf_Request_Abstract::setRouted - - - - - - diff --git a/reference/yaf/yaf_request_abstract/isxmlhttprequest.xml b/reference/yaf/yaf_request_abstract/isxmlhttprequest.xml deleted file mode 100644 index ffc2841eb3..0000000000 --- a/reference/yaf/yaf_request_abstract/isxmlhttprequest.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - Yaf_Request_Abstract::isXmlHttpRequest - Determina si la solicitud es una solicitud AJAX - - - - &reftitle.description; - - public boolYaf_Request_Abstract::isXmlHttpRequest - - - - Comprueba si la petición es una petición Ajax inspeccionando la cabecera de - petición HTTP_X_REQUESTED_WITH. - - - - Yaf_Request_Simple sobrescribe este método y - devuelve siempre &false;, ya que las peticiones de línea de órdenes nunca - son peticiones Ajax. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si la petición es una petición Ajax (la cabecera - X-Requested-With es igual a - XMLHttpRequest), &false; en caso contrario. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::isXmlHttpRequest</methodname> - -getRequest()->isXmlHttpRequest()) { - $this->getResponse() - ->setHeader("Content-Type", "application/json") - ->setBody(json_encode(["id" => 17, "name" => "Yaf in Action"])); - return false; - } - } -} -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::isGet - Yaf_Request_Abstract::isPost - Yaf_Request_Abstract::isPut - Yaf_Request_Abstract::isHead - Yaf_Request_Abstract::isOptions - Yaf_Request_Abstract::isDelete - Yaf_Request_Abstract::isPatch - Yaf_Request_Abstract::isCli - - - - - - diff --git a/reference/yaf/yaf_request_abstract/setactionname.xml b/reference/yaf/yaf_request_abstract/setactionname.xml deleted file mode 100644 index 6e91711fe5..0000000000 --- a/reference/yaf/yaf_request_abstract/setactionname.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - Yaf_Request_Abstract::setActionName - Establece el nombre de la acción - - - - &reftitle.description; - - public Yaf_Request_AbstractnullYaf_Request_Abstract::setActionName - stringaction - boolformat_nametrue - - - Establecer el nombre de la acción a solicitar, esto es usualmente usado por el enrutador personalizado para establecer el nombre del controlador de resultado de ruta. - - - - - &reftitle.parameters; - - - action - - - nombre de la acción como &string;, debe ser en minúsculas, como "index" o "foo_bar" - - - - - format_name - - - esto se introduce en Yaf 3.2.0, por omisión Yaf formateará el nombre en minúsculas, - si este se establece a &false; , Yaf pondrá el nombre original a la petición. - - - - - - - - &reftitle.returnvalues; - - Devuelve el propio objeto de la petición en caso de éxito, o &null; en caso - de error. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::setActionName</methodname> - -getRequestUri(), "/api")) { - $request->setControllerName("Api") - ->setActionName("orders"); - return true; - } - - return false; - } - - public function assemble(array $info, array $query = null) {} -} -?>]]> - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::setControllerName - Yaf_Request_Abstract::setModuleName - Yaf_Request_Abstract::getActionName - - - - - - diff --git a/reference/yaf/yaf_request_abstract/setbaseuri.xml b/reference/yaf/yaf_request_abstract/setbaseuri.xml deleted file mode 100644 index d6bec961d1..0000000000 --- a/reference/yaf/yaf_request_abstract/setbaseuri.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - Yaf_Request_Abstract::setBaseUri - Establecer el URI base - - - - &reftitle.description; - - public Yaf_Request_AbstractfalseYaf_Request_Abstract::setBaseUri - stringuir - - - Establece el URI base. El URI base se usa al enrutar. En la fase de enrutamiento, el - URI solicitado se usa para enrutar una petición, mientras que es URI base para saltar la - parte anterior(URI base) del URI solicitado. - - Esto es, si viene una petición con un URI solicitado como a/b/c, si se establece el URI - base a "a/b", se usará solamente "/c" en la fase de enrutamiento. - - - Generalmente, no es necesario establecer esto, Yaf lo determinará automáticamente. - - - - - - - - &reftitle.parameters; - - - uir - - - El URI base - - - - - - - - &reftitle.returnvalues; - - Devuelve el propio objeto de la petición en caso de éxito, o &false; en caso - de error. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::setBaseUri</methodname> - -setBaseUri("/myapp"); -$request->setRequestUri("/myapp/product/view"); - -var_dump($request->getBaseUri()); -var_dump($request->getRequestUri()); -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getBaseUri - Yaf_Request_Abstract::setRequestUri - Yaf_Request_Abstract::getRequestUri - - - - - - diff --git a/reference/yaf/yaf_request_abstract/setcontrollername.xml b/reference/yaf/yaf_request_abstract/setcontrollername.xml deleted file mode 100644 index d76af0c0ad..0000000000 --- a/reference/yaf/yaf_request_abstract/setcontrollername.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - Yaf_Request_Abstract::setControllerName - Establecer el nombre del controlador - - - - &reftitle.description; - - public Yaf_Request_AbstractnullYaf_Request_Abstract::setControllerName - stringcontroller - boolformat_nametrue - - - Establecer el nombre del controlador a la petición, esto es generalmente - utilizado por el enrutador personalizado para establecer el nombre del - controlador resultante de la ruta. - - - - - - &reftitle.parameters; - - - controller - - - &string;, nombre del controlador, debe ser en estilo camel, como "Index" o "Foo_Bar". - - - - - format_name - - - esto se introduce en Yaf 3.2.0, por omisión Yaf formateará el nombre en modo camel, - si esto se establece a &false;, Yaf establecerá el nombre original a la petición. - - - - - - - - &reftitle.returnvalues; - - Devuelve el propio objeto de la petición en caso de éxito, o &null; en caso - de error. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::setControllerName</methodname> - -getRequestUri(), "/api")) { - // Los nombres se formatean en estilo camel por omisión, - // así que "order_item" se convierte en "Order_Item" - $request->setControllerName("order_item") - ->setActionName("list"); - return true; - } - - return false; - } - - public function assemble(array $info, array $query = null) {} -} -?>]]> - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::setModuleName - Yaf_Request_Abstract::setActionName - Yaf_Request_Abstract::getControllerName - - - - - - diff --git a/reference/yaf/yaf_request_abstract/setdispatched.xml b/reference/yaf/yaf_request_abstract/setdispatched.xml deleted file mode 100644 index afaed58241..0000000000 --- a/reference/yaf/yaf_request_abstract/setdispatched.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - Yaf_Request_Abstract::setDispatched - El propósito de setDispatched - - - - &reftitle.description; - - final public Yaf_Request_AbstractYaf_Request_Abstract::setDispatched - boolflagtrue - - Marca la petición como despachada. - - Esto lo llama el despachador después de ejecutar una acción; detiene el - bucle de despacho. Puede llamarse manualmente, por ejemplo para omitir las - iteraciones de despacho restantes. - - - - - &reftitle.parameters; - - - flag - - El estado a establecer. Por omisión, &true;. - - - - - - - &reftitle.returnvalues; -Devuelve el propio objeto de la petición. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::setDispatched</methodname> - -setDispatched(); - $response->setRedirect("/account/login"); - } - } -} -?>]]> - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::isDispatched - Yaf_Dispatcher::dispatch - - - - - - diff --git a/reference/yaf/yaf_request_abstract/setmodulename.xml b/reference/yaf/yaf_request_abstract/setmodulename.xml deleted file mode 100644 index f643eb33c0..0000000000 --- a/reference/yaf/yaf_request_abstract/setmodulename.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - Yaf_Request_Abstract::setModuleName - Establecer el nombre del módulo - - - - &reftitle.description; - - public Yaf_Request_AbstractnullYaf_Request_Abstract::setModuleName - stringmodule - boolformat_nametrue - - - Establecer el nombre del módulo a la petición, esto se utiliza generalmente - por un enrutador personalizado para establecer el nombre del módulo - resultante de la ruta. - - - - - - &reftitle.parameters; - - - module - - - &string; nombre del módulo, debe estar en estilo camel, como "Index" o "Foo_Bar" - - - - - format_name - - - Esto se introdujo en Yaf 3.2.0, por omisión Yaf formateará el nombre en modo camel, - si esto se establece como &false;, Yaf establecerá el nombre original a la petición. - - - - - - - - &reftitle.returnvalues; - - Devuelve el propio objeto de la petición en caso de éxito, o &null; en caso - de error. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::setModuleName</methodname> - -getRequestUri(), "/admin")) { - $request->setModuleName("Admin") - ->setControllerName("Dashboard") - ->setActionName("index"); - return true; - } - - return false; - } - - public function assemble(array $info, array $query = null) {} -} -?>]]> - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::setControllerName - Yaf_Request_Abstract::setActionName - Yaf_Request_Abstract::getModuleName - - - - - - diff --git a/reference/yaf/yaf_request_abstract/setparam.xml b/reference/yaf/yaf_request_abstract/setparam.xml deleted file mode 100644 index 27409ee602..0000000000 --- a/reference/yaf/yaf_request_abstract/setparam.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - Yaf_Request_Abstract::setParam - Establecer un argumento de llamada a una petición - - - - &reftitle.description; - - public Yaf_Request_AbstractboolnullYaf_Request_Abstract::setParam - mixedname - mixedvalue - - - Establece un argumento en la petición, que puede recuperarse mediante - Yaf_Request_Abstract::getParam. - - - Si se llama con un único argumento de tipo array, cada par clave/valor se - establece como un argumento. - - - - - &reftitle.parameters; - - - name - - - El nombre del argumento, o un array de pares clave/valor. - - - - - value - - - El valor del argumento. Obligatorio salvo que name - sea un array. - - - - - - - - &reftitle.returnvalues; -Devuelve el en caso de éxito, o &false; en caso de error. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::setParam</methodname> - -getRequest(); - - $request->setParam("referrer", "newsletter"); - $request->setParam(["source" => "email", "campaign" => "spring"]); - - var_dump($request->getParam("referrer")); - var_dump($request->getParams()); - } -} -?>]]> - - &example.outputs.similar; - - - string(10) "newsletter" - ["source"]=> - string(5) "email" - ["campaign"]=> - string(6) "spring" -} -]]> - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getParam - Yaf_Request_Abstract::getParams - Yaf_Request_Abstract::clearParams - - - - - - diff --git a/reference/yaf/yaf_request_abstract/setrequesturi.xml b/reference/yaf/yaf_request_abstract/setrequesturi.xml deleted file mode 100644 index 64dff75c0d..0000000000 --- a/reference/yaf/yaf_request_abstract/setrequesturi.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - Yaf_Request_Abstract::setRequestUri - El propósito de setRequestUri - - - - &reftitle.description; - - public Yaf_Request_AbstractYaf_Request_Abstract::setRequestUri - stringuri - - - Establece el URI de la petición, sustituyendo al detectado a partir del - entorno. - - - Esto resulta útil al despachar manualmente, por ejemplo en pruebas, con un - URI distinto del real. - - - - - &reftitle.parameters; - - - uri - - El URI de la petición a establecer. - - - - - - - &reftitle.returnvalues; -Devuelve el propio objeto de la petición. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::setRequestUri</methodname> - -setRequestUri("/product/view/id/17"); - -var_dump($request->getRequestUri()); -?>]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::getRequestUri - Yaf_Request_Abstract::setBaseUri - Yaf_Request_Abstract::getBaseUri - - - - - - diff --git a/reference/yaf/yaf_request_abstract/setrouted.xml b/reference/yaf/yaf_request_abstract/setrouted.xml deleted file mode 100644 index d753810260..0000000000 --- a/reference/yaf/yaf_request_abstract/setrouted.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Yaf_Request_Abstract::setRouted - El propósito de setRouted - - - - &reftitle.description; - - final public Yaf_Request_AbstractYaf_Request_Abstract::setRouted - boolflagtrue - - Marca la petición como enrutada. - - Esto lo llama el enrutador una vez que el enrutamiento ha tenido éxito. - Llamarlo manualmente puede impedir que los enrutadores personalizados se - ejecuten después. - - - - - &reftitle.parameters; - - - flag - - El estado a establecer. Por omisión, &true;. - - - - - - - &reftitle.returnvalues; -Devuelve el propio objeto de la petición. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Abstract::setRouted</methodname> - -getRequestUri(), "/api/")) { - return false; - } - - $request->setControllerName("Api") - ->setActionName("handle"); - - // Impide que se ejecuten los enrutadores registrados después de este - $request->setRouted(); - - return true; - } - - public function assemble(array $info, array $query = null) {} -} -?>]]> - - - - - - &reftitle.seealso; - - Yaf_Request_Abstract::isRouted - Yaf_Router::route - - - - - - diff --git a/reference/yaf/yaf_request_http/construct.xml b/reference/yaf/yaf_request_http/construct.xml deleted file mode 100644 index 0156809633..0000000000 --- a/reference/yaf/yaf_request_http/construct.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - Yaf_Request_Http::__construct - Constructor de Yaf_Request_Http - - - - &reftitle.description; - - public Yaf_Request_Http::__construct - stringrequest_uri - stringbase_uri - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Http::__construct</methodname> - -getMethod()); -var_dump($request->getRequestUri()); -var_dump($request->getBaseUri()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Simple - Yaf_Request_Abstract::getMethod - Yaf_Request_Abstract::getRequestUri - - - - - - diff --git a/reference/yaf/yaf_request_simple/construct.xml b/reference/yaf/yaf_request_simple/construct.xml deleted file mode 100644 index a00e10d941..0000000000 --- a/reference/yaf/yaf_request_simple/construct.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - Yaf_Request_Simple::__construct - Constructor de Yaf_Request_Simple - - - - &reftitle.description; - - public Yaf_Request_Simple::__construct - stringmethod - stringmodule - stringcontroller - stringaction - arrayparams - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Request_Simple::__construct</methodname> - - 10) // request parameters -); - -var_dump($request->isRouted()); /* las peticiones con nombres MVC vienen ya enrutadas */ -var_dump($request->getModuleName()); -var_dump($request->getControllerName()); -var_dump($request->getActionName()); -var_dump($request->getParam("id")); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Request_Http - Yaf_Request_Abstract::isRouted - Yaf_Request_Abstract::getParam - - - - - - diff --git a/reference/yaf/yaf_response_abstract/appendbody.xml b/reference/yaf/yaf_response_abstract/appendbody.xml deleted file mode 100644 index 47e8093be7..0000000000 --- a/reference/yaf/yaf_response_abstract/appendbody.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - Yaf_Response_Abstract::appendBody - Añadir contenido al cuerpo de respuesta - - - - &reftitle.description; - - public Yaf_Response_AbstractfalsenullYaf_Response_Abstract::appendBody - stringbody - stringkey - - - Añade contenido a un bloque de contenido existente. - - - - - &reftitle.parameters; - - - body - - - La cadena con el contenido. - - - - - key - - - la clave del contenido. Si no se especifica, se usará - Yaf_Response_Abstract::DEFAULT_BODY. - - - - - - - - &reftitle.returnvalues; - - Un valor de tipo booleano. - - - - - &reftitle.examples; - - Ejemplo de <function>Yaf_Response_Abstract::appendBody</function> - -setBody("Hola")->appendBody(" Mundo"); - -echo $respuesta; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Response_Abstract::getBody - Yaf_Response_Abstract::setBody - Yaf_Response_Abstract::prependBody - Yaf_Response_Abstract::clearBody - - - - - - diff --git a/reference/yaf/yaf_response_abstract/clearbody.xml b/reference/yaf/yaf_response_abstract/clearbody.xml deleted file mode 100644 index 074498ed30..0000000000 --- a/reference/yaf/yaf_response_abstract/clearbody.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - Yaf_Response_Abstract::clearBody - Descarta todo el cuerpo de respuesta existente - - - - &reftitle.description; - - public Yaf_Response_AbstractfalsenullYaf_Response_Abstract::clearBody - stringkey - - - Limpia el contenido existente. - - - - - &reftitle.parameters; - - - key - - - La clave del contenido. Si se especifica, solo se limpia ese bloque de - contenido; en caso contrario, se limpian todos los bloques de contenido. - - - - - - - - &reftitle.returnvalues; -Devuelve el en caso de éxito, o &null; en caso de error. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Response_Abstract::clearBody</methodname> - -getResponse(); - - $response->setBody("Hello", "intro"); - $response->setBody("World"); - - $response->clearBody("intro"); // drop only the "intro" block - var_dump($response->getBody(null)); - - $response->clearBody(); // drop every body block - var_dump($response->getBody(null)); - } -} -?> -]]> - - &example.outputs.similar; - - - string(5) "World" -} -array(0) { -}]]> - - - - - - &reftitle.seealso; - - Yaf_Response_Abstract::setBody - Yaf_Response_Abstract::appendBody - Yaf_Response_Abstract::prependBody - Yaf_Response_Abstract::getBody - - - - - - diff --git a/reference/yaf/yaf_response_abstract/clearheaders.xml b/reference/yaf/yaf_response_abstract/clearheaders.xml deleted file mode 100644 index 0bd76cf1ba..0000000000 --- a/reference/yaf/yaf_response_abstract/clearheaders.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - Yaf_Response_Abstract::clearHeaders - Descarta todas las cabeceras establecidas - - - - &reftitle.description; - - public Yaf_Response_AbstractfalsenullYaf_Response_Abstract::clearHeaders - - - - Elimina todas las cabeceras de respuesta HTTP que se hayan establecido. - - Este método solo está implementado por completo en la subclase Yaf_Response_Http. En la clase abstracta es un esbozo. - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el propio objeto de la respuesta en caso de éxito, o &false; en - caso de error. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Response_Abstract::clearHeaders</methodname> - -getResponse(); - - $response->setHeader("Content-Type", "application/json"); - $response->clearHeaders(); - - var_dump($response->getHeader()); // array(0) { } - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Response_Abstract::setHeader - Yaf_Response_Abstract::getHeader - Yaf_Response_Abstract::setAllHeaders - - - - - - diff --git a/reference/yaf/yaf_response_abstract/construct.xml b/reference/yaf/yaf_response_abstract/construct.xml deleted file mode 100644 index ddc0a8f2da..0000000000 --- a/reference/yaf/yaf_response_abstract/construct.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Yaf_Response_Abstract::__construct - El propósito de __construct - - - - &reftitle.description; - - public Yaf_Response_Abstract::__construct - - - - Construye un objeto de respuesta. El constructor no recibe argumentos; las - subclases concretas como Yaf_Response_Http y - Yaf_Response_Cli inicializan sus propios valores por - omisión (una respuesta HTTP empieza con el código de respuesta - 200, por ejemplo). - - - - Habitualmente no es necesario construir un objeto de respuesta a mano: - Yaf_Dispatcher::getResponse devuelve el que ha - creado el despachador. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - No se devuelve ningún valor. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Response_Abstract::__construct</methodname> - -getResponse(); - -/* construirla directamente resulta útil sobre todo en pruebas */ -$response = new Yaf_Response_Http(); -$response->setBody("Hello World"); - -echo $response; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Dispatcher::getResponse - Yaf_Response_Abstract::response - - - - - - diff --git a/reference/yaf/yaf_response_abstract/getbody.xml b/reference/yaf/yaf_response_abstract/getbody.xml deleted file mode 100644 index 0cec6f1f0e..0000000000 --- a/reference/yaf/yaf_response_abstract/getbody.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - Yaf_Response_Abstract::getBody - Recupera un contenido existente - - - - &reftitle.description; - - public mixedYaf_Response_Abstract::getBody - stringkey - - - Recupera un contenido existente. - - - - - &reftitle.parameters; - - - key - - - La clave del contenido. Si no se especifica, se usa el bloque - DEFAULT_BODY; se pasa &null; para obtener todos los - bloques de contenido como un array. - - - - - - - - &reftitle.returnvalues; -La cadena de contenido, o un array de todos los bloques de contenido cuando key es &null;. Devuelve una cadena vacía si el bloque no está definida. - - - - - &reftitle.examples; - - Ejemplo de <function>Yaf_Response_Abstract::getBody</function> - -setBody("Hola")->setBody(" Mundo", "footer"); - -var_dump($respuesta->getBody()); // predeterminado -var_dump($respuesta->getBody(Yaf_Response_Abstract::DEFAULT_BODY)); // lo mismo que arriba -var_dump($respuesta->getBody("footer")); -var_dump($respuesta->getBody(NULL)); // obtener todo -?> -]]> - - &example.outputs.similar; - - - string(4) "Hola" - ["footer"]=> - string(6) " Mundo" -} -]]> - - - - - - &reftitle.seealso; - - Yaf_Response_Abstract::setBody - Yaf_Response_Abstract::appendBody - Yaf_Response_Abstract::prependBody - Yaf_Response_Abstract::clearBody - - - - - - diff --git a/reference/yaf/yaf_response_abstract/getheader.xml b/reference/yaf/yaf_response_abstract/getheader.xml deleted file mode 100644 index ffa8fa055f..0000000000 --- a/reference/yaf/yaf_response_abstract/getheader.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - Yaf_Response_Abstract::getHeader - El propósito de getHeader - - - - &reftitle.description; - - public stringarraynullYaf_Response_Abstract::getHeader - stringname - - Recupera una cabecera de respuesta HTTP. - Este método solo está implementado por completo en la subclase Yaf_Response_Http. En la clase abstracta es un esbozo. - - - - &reftitle.parameters; - - - name - - - El nombre de la cabecera. Si se omite, se devuelven todas las cabeceras - como un array. - - - - - - - - &reftitle.returnvalues; - - El valor de la cabecera como cadena, o un array con todas las cabeceras - cuando se omite el nombre. Devuelve &null; si la cabecera solicitada no - está definida. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Response_Abstract::getHeader</methodname> - -getResponse(); - $response->setHeader("Content-Type", "application/json"); - - var_dump($response->getHeader("Content-Type")); - var_dump($response->getHeader()); // todas las cabeceras - var_dump($response->getHeader("X-Missing")); - } -} -?> -]]> - - &example.outputs.similar; - - - string(16) "application/json" -} -NULL]]> - - - - - - &reftitle.seealso; - - Yaf_Response_Abstract::setHeader - Yaf_Response_Abstract::clearHeaders - Yaf_Response_Abstract::setAllHeaders - - - - - - diff --git a/reference/yaf/yaf_response_abstract/prependbody.xml b/reference/yaf/yaf_response_abstract/prependbody.xml deleted file mode 100644 index cea26487e3..0000000000 --- a/reference/yaf/yaf_response_abstract/prependbody.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - Yaf_Response_Abstract::prependBody - El propósito de prependBody - - - - &reftitle.description; - - public Yaf_Response_AbstractfalsenullYaf_Response_Abstract::prependBody - stringbody - stringkey - - - Antepone un contenido a un bloque de contenido existente - - - - - &reftitle.parameters; - - - body - - - La cadena con el contenido. - - - - - key - - - la clave del contenido. Si no se especifica, se usará - Yaf_Response_Abstract::DEFAULT_BODY. - - - - - - - - &reftitle.returnvalues; - - Un valor de tipo booleano. - - - - - &reftitle.examples; - - Ejemplo de <function>Yaf_Response_Abstract::prependBody</function> - -setBody("Mundo")->prependBody("Hola "); - -echo $respuesta; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Response_Abstract::getBody - Yaf_Response_Abstract::setBody - Yaf_Response_Abstract::appendBody - Yaf_Response_Abstract::clearBody - - - - - - diff --git a/reference/yaf/yaf_response_abstract/response.xml b/reference/yaf/yaf_response_abstract/response.xml deleted file mode 100644 index 99240b82c2..0000000000 --- a/reference/yaf/yaf_response_abstract/response.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Yaf_Response_Abstract::response - Envía una respuesta - - - - &reftitle.description; - - public boolnullYaf_Response_Abstract::response - - - - Envía una respuesta. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -Devuelve &true; en caso de éxito, o &null; en caso de error. - - - - - &reftitle.examples; - - Ejemplo de <function>Yaf_Response_Abstract::response</function> - -setBody("Hola")->setBody(" Mundo", "footer"); - -$respuesta->response(); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Response_Abstract::setBody - Yaf_Response_Abstract::clearBody - - - - - - diff --git a/reference/yaf/yaf_response_abstract/setallheaders.xml b/reference/yaf/yaf_response_abstract/setallheaders.xml deleted file mode 100644 index 3f965170fd..0000000000 --- a/reference/yaf/yaf_response_abstract/setallheaders.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - Yaf_Response_Abstract::setAllHeaders - El propósito de setAllHeaders - - - - &reftitle.description; - - public boolYaf_Response_Abstract::setAllHeaders - arrayheaders - - - Establece todas las cabeceras de respuesta HTTP de una sola vez. - - Este método solo está implementado por completo en la subclase Yaf_Response_Http. En la clase abstracta es un esbozo. - - - - &reftitle.parameters; - - - headers - - - Un array de pares nombre/valor de cabecera. Cualquier cabecera existente - con el mismo nombre se sustituye. - - - - - - - - &reftitle.returnvalues; -Devuelve &true;. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Response_Abstract::setAllHeaders</methodname> - -getResponse()->setAllHeaders(array( - "Content-Type" => "application/json; charset=utf-8", - "Cache-Control" => "no-cache", - "X-Request-Id" => "7f3c2d91", - )); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Response_Abstract::setHeader - Yaf_Response_Abstract::getHeader - Yaf_Response_Abstract::clearHeaders - - - - - - diff --git a/reference/yaf/yaf_response_abstract/setbody.xml b/reference/yaf/yaf_response_abstract/setbody.xml deleted file mode 100644 index 95a2480eee..0000000000 --- a/reference/yaf/yaf_response_abstract/setbody.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - Yaf_Response_Abstract::setBody - Establece el contenido de una respuesta - - - - &reftitle.description; - - public Yaf_Response_AbstractfalsenullYaf_Response_Abstract::setBody - stringbody - stringkey - - - Establece el contenido de una respuesta. - - - - - &reftitle.parameters; - - - body - - - La cadena con el contenido. - - - - - key - - - la clave del contenido. Si no se especifica, se usará - Yaf_Response_Abstract::DEFAULT_BODY. - - - - - - - - &reftitle.returnvalues; -Devuelve el en caso de éxito, o &false; en caso de error. - - - - - &reftitle.examples; - - Ejemplo de <function>Yaf_Response_Abstract::setBody</function> - -setBody("Hola")->setBody(" Mundo", "footer"); - -print_r($respuesta); -echo $respuesta; -?> -]]> - - &example.outputs.similar; - - Array - ( - ) - - [_body:protected] => Array - ( - [content] => Hola - [footer] => Mundo - ) - - [_sendheader:protected] => 1 - [_response_code:protected] => 200 -) -Hola Mundo -]]> - - - - - - &reftitle.seealso; - - Yaf_Response_Abstract::getBody - Yaf_Response_Abstract::appendBody - Yaf_Response_Abstract::prependBody - Yaf_Response_Abstract::clearBody - - - - - - diff --git a/reference/yaf/yaf_response_abstract/setheader.xml b/reference/yaf/yaf_response_abstract/setheader.xml deleted file mode 100644 index e59ef774b6..0000000000 --- a/reference/yaf/yaf_response_abstract/setheader.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - Yaf_Response_Abstract::setHeader - Establece cabecera de respuesta - - - - &reftitle.description; - - public boolYaf_Response_Abstract::setHeader - stringname - stringvalue - boolreplacefalse - intresponse_code0 - - Establece una cabecera de respuesta HTTP. - Este método solo está implementado por completo en la subclase Yaf_Response_Http. En la clase abstracta es un esbozo. - - - - &reftitle.parameters; - - - name - - El nombre de la cabecera. - - - - value - - El valor de la cabecera. - - - - replace - - - Si se debe sustituir cualquier cabecera existente con el mismo nombre. Si - es &false;, el nuevo valor se añade al existente, separado por una coma. - Es de notar que, aunque el valor por omisión declarado es &false;, la - implementación actual sustituye la cabecera existente cuando se omite - este parámetro. - - - - - response_code - - - Si no es cero, el código de respuesta HTTP a establecer en la respuesta. - - - - - - - - &reftitle.returnvalues; -Devuelve &true; en caso de éxito, o &false; en caso de error. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Response_Abstract::setHeader</methodname> - -getResponse(); - - $response->setHeader("Content-Type", "application/json"); - - /* envía un 401 y pide credenciales */ - $response->setHeader("WWW-Authenticate", 'Basic realm="Member Area"', true, 401); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Response_Abstract::getHeader - Yaf_Response_Abstract::clearHeaders - Yaf_Response_Abstract::setAllHeaders - - - - - - diff --git a/reference/yaf/yaf_response_abstract/setredirect.xml b/reference/yaf/yaf_response_abstract/setredirect.xml deleted file mode 100644 index 265ad24753..0000000000 --- a/reference/yaf/yaf_response_abstract/setredirect.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - Yaf_Response_Abstract::setRedirect - El propósito de setRedirect - - - - &reftitle.description; - - public boolnullYaf_Response_Abstract::setRedirect - stringurl - - - Redirige al cliente a otra URL (envía una cabecera - Location). - - - - - - &reftitle.parameters; - - - url - - - dirección redirigida a - - - - - - - - &reftitle.returnvalues; -Devuelve &true; en caso de éxito, o &null; en caso de error. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Response_Abstract::setRedirect</methodname> - -has("login")) { - /* envía una cabecera Location que apunta a la página de identificación */ - $this->getResponse()->setRedirect("/account/login"); - return false; // nothing to render here - } - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Controller_Abstract::redirect - - - - - - diff --git a/reference/yaf/yaf_response_abstract/tostring.xml b/reference/yaf/yaf_response_abstract/tostring.xml deleted file mode 100644 index 2a301db165..0000000000 --- a/reference/yaf/yaf_response_abstract/tostring.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Yaf_Response_Abstract::__toString - Recupera todo el cuerpo como un string - - - - &reftitle.description; - - private stringYaf_Response_Abstract::__toString - - - - Recuperar todo el cuerpo como un string - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El cuerpo de la respuesta como cadena. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Response_Abstract::__toString</methodname> - -setBody("Hello")->setBody(" World", "footer"); - -/* usar la respuesta en un contexto de cadena renderiza todos los bloques del cuerpo */ -echo $response; -var_dump((string) $response); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Response_Abstract::getBody - Yaf_Response_Abstract::setBody - Yaf_Response_Abstract::response - - - - - - diff --git a/reference/yaf/yaf_route_interface/assemble.xml b/reference/yaf/yaf_route_interface/assemble.xml deleted file mode 100644 index 068205f58a..0000000000 --- a/reference/yaf/yaf_route_interface/assemble.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - Yaf_Route_Interface::assemble - Ensamblar una petición - - - - &reftitle.description; - - abstract public stringYaf_Route_Interface::assemble - arrayinfo - arrayquery - - - Este método devuelve un URL según el argumento info info, y pospone - los string de consultas al URL según el argumento query. - - - Una ruta debería implementar este método según sus propias reglas de ruta, y - realizar un progreso inverso. - - - - - &reftitle.parameters; - - - info - - - - - - - - - query - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Route_Interface::assemble</methodname> - -_match = $match; - $this->_route = $route; - } - - public function route(Yaf_Request_Abstract $request): bool { - if (!preg_match($this->_match, $request->getRequestUri(), $matches)) { - return false; - } - - foreach ($this->_route as $key => $value) { - if (is_string($value) && ':' === $value[0]) { - $value = $matches[substr($value, 1)]; - } - $request->setParam($key, $value); - } - $request->setRouted(); - - return true; - } - - /* reconstruye una URL a partir de las reglas de la ruta */ - public function assemble(array $info, ?array $query = null): string { - $url = "/product"; - if (isset($info[':name'])) { - $url .= "/" . $info[':name']; - } - - if (!empty($query)) { - $url .= "?" . http_build_query($query); - } - - return $url; - } -} - -$router = new Yaf_Router(); -$router->addRoute("custom", - new RewriteRoute("#^/product#", array("controller" => "product")) -); - -var_dump($router->getRoute("custom")->assemble( - array(':name' => 'book'), - array('page' => 2) -)); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Route_Interface::route - Yaf_Route_Rewrite::assemble - Yaf_Route_Map::assemble - - - - - - diff --git a/reference/yaf/yaf_route_interface/route.xml b/reference/yaf/yaf_route_interface/route.xml deleted file mode 100644 index 869e9b2d6f..0000000000 --- a/reference/yaf/yaf_route_interface/route.xml +++ /dev/null @@ -1,174 +0,0 @@ - - - - - - Yaf_Route_Interface::route - Enruta una petición - - - - &reftitle.description; - - abstract public boolYaf_Route_Interface::route - Yaf_Request_Abstractrequest - - - Yaf_Route_Interface::route es el único método - que debería implementar un enrutamiento personalizado. - - - Desde la 2.3.0, hay otro método que también debería ser implementado, - ver Yaf_Route_Interface::assemble. - - - - - Si este método devuelve &true;, el proceso de enrutamiento terminará, de otro modo - Yaf_Router llamará a la siguiente ruta de la pila de enrutamiento - para enrutar la petición. - - - - Este método establecería el resultado del enrutamiento al parámetro request, - llamando a los métodos Yaf_Request_Abstract::setControllerName, - Yaf_Request_Abstract::setActionName y - Yaf_Request_Abstract::setModuleName. - - - - Este método debería también llamar al método - Yaf_Request_Abstract::setRouted para realizar al fin - la petición enrutada. - - - - - - &reftitle.parameters; - - - request - - - Una instancia de la clase Yaf_Request_Abstract. - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Route_Interface::route</methodname> - -_prefix = $prefix; - } - - public function route(Yaf_Request_Abstract $request): bool { - $uri = $request->getRequestUri(); - if (0 !== strpos($uri, $this->_prefix)) { - /* no es cosa nuestra, que el enrutador pruebe la siguiente ruta */ - return false; - } - - /* analiza el URI "/api/user/list" en controlador/acción */ - $segments = explode("/", ltrim(substr($uri, strlen($this->_prefix)), "/")); - $controller = isset($segments[0]) ? ucfirst($segments[0]) : NULL; - $action = isset($segments[1]) ? $segments[1] : NULL; - - if (empty($controller)) { - return false; - } - - $request->setModuleName("index"); - $request->setControllerName($controller); - $request->setActionName($action); - $request->setRouted(); /* el proceso de enrutamiento termina aquí */ - - return true; - } - - public function assemble(array $info, ?array $query = null): string { - $uri = $this->_prefix . "/" . strtolower($info[':c']); - if (isset($info[':a'])) { - $uri .= "/" . $info[':a']; - } - - if (!empty($query)) { - $uri .= "?" . http_build_query($query); - } - - return $uri; - } -} - -/** - * se registra la ruta personalizada - */ -Yaf_Dispatcher::getInstance()->getRouter()->addRoute("api", new ApiRoute("/api")); -?> -]]> - - &example.outputs.similar; - - "index", - "controller" => "User", - "action" => "list", -) -]]> - - - - - - &reftitle.seealso; - - Yaf_Route_Interface::assemble - Yaf_Router::addRoute - Yaf_Request_Abstract::setRouted - - - - - - diff --git a/reference/yaf/yaf_route_map/assemble.xml b/reference/yaf/yaf_route_map/assemble.xml deleted file mode 100644 index 0ea80480fd..0000000000 --- a/reference/yaf/yaf_route_map/assemble.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - - - Yaf_Route_Map::assemble - Ensamblar un URL - - - - &reftitle.description; - - public stringYaf_Route_Map::assemble - arrayinfo - arrayquery - - - Ensamblar un URL. - - - - - &reftitle.parameters; - - - info - - - - - - - - query - - - - - - - - - - - &reftitle.returnvalues; - - Devuelve &string; en caso de éxito o &null; en caso de fallo. - - - - - &reftitle.errors; - - Puede lanzar Yaf_Exception_TypeError. - - - - - &reftitle.examples; - - Ejemplo de <function>Yaf_Route_Map::assemble</function> - -addRoute("map", $route); - -var_dump($router->getRoute('map')->assemble( - array( - ':c' => 'foo_bar' - ), - array( - 'tkey1' => 'tval1', - 'tkey2' => 'tval2' - ) - ) -); - -$route = new Yaf_Route_Map(true, '_'); -$router->addRoute("map", $route); - -var_dump($router->getRoute('map')->assemble( - array( - ':a' => 'foo_bar' - ), - array( - 'tkey1' => 'tval1', - 'tkey2' => 'tval2' - ) - ) -); -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/yaf/yaf_route_map/construct.xml b/reference/yaf/yaf_route_map/construct.xml deleted file mode 100644 index 7cf30102de..0000000000 --- a/reference/yaf/yaf_route_map/construct.xml +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - Yaf_Route_Map::__construct - El propósito de __construct - - - - &reftitle.description; - - public Yaf_Route_Map::__construct - stringcontroller_prefer&false; - stringdelimiter"" - - - Construye una ruta map. Una ruta map asocia el URI completo a un nombre de - controlador o a un nombre de acción. - - - - - - &reftitle.parameters; - - - controller_prefer - - - Si el resultado debería considerarse un controlador o una acción - - - - - delimiter - - - El delimitador usado para separar en el URI el nombre asociado de los - argumentos de la petición. Si aparece como un segmento de ruta precedido - de una barra, todo lo que va después se analiza como argumentos de la - petición en lugar de formar parte del nombre asociado. Si está vacío, - durante el enrutamiento no se produce esa división. - - - - - - - - &reftitle.returnvalues; -No se devuelve ningún valor. - - - - - &reftitle.examples; - - Ejemplo de <classname>Yaf_Route_Map</classname> - -getRouter()->addRoute("name", - new Yaf_Route_Map()); -?> -]]> - - &example.outputs.similar; - - "product_foo_bar", -) -]]> - - - - Ejemplo de <classname>Yaf_Route_Map</classname> - -getRouter()->addRoute("name", - new Yaf_Route_Map(true, "_")); -?> -]]> - - &example.outputs.similar; - - "User_List", -) - -/** - * y los parámetros de petición: - */ -array( - "foo" => "22", -) -]]> - - - - Ejemplo de <classname>Yaf_Route_Map</classname> - - array( - "type" => "map", // ruta Yaf_Route_Map - "controllerPrefer" => FALSE, - "delimiter" => "#!", - ), -); -Yaf_Dispatcher::getInstance()->getRouter()->addConfig( - new Yaf_Config_Simple($config)); -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Route_Map::route - Yaf_Route_Map::assemble - - - - - - diff --git a/reference/yaf/yaf_route_map/route.xml b/reference/yaf/yaf_route_map/route.xml deleted file mode 100644 index 3c673d5e3c..0000000000 --- a/reference/yaf/yaf_route_map/route.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - Yaf_Route_Map::route - El propósito de route - - - - &reftitle.description; - - public boolYaf_Route_Map::route - Yaf_Request_Abstractrequest - - - Enruta la petición asociando el URI completo a un nombre de controlador o a - un nombre de acción: los segmentos de ruta del URI se unen con guiones bajos - para formar el nombre. - - - Cuando la ruta se ha construido con el indicador de preferencia de - controlador activado, el resultado se establece como nombre del controlador; - en caso contrario, como nombre de la acción. - - - - - &reftitle.parameters; - - - request - - - La instancia de Yaf_Request_Abstract a enrutar. - - - - - - - - &reftitle.returnvalues; - - Siempre devuelve &true;. Es de notar que la ruta map captura la petición - incluso cuando el URI está vacío, en cuyo caso no se establece ningún - nombre. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Route_Map::route</methodname> - -setRequestUri("/product/foo/bar"); - -$route = new Yaf_Route_Map(); -var_dump($route->route($request)); -var_dump($request->getActionName()); -?> -]]> - - &example.outputs.similar; - - - - - - Ejemplo de <methodname>Yaf_Route_Map::route</methodname> - -setRequestUri("/user/list/_/foo/22"); - -$route = new Yaf_Route_Map(true, "_"); -var_dump($route->route($request)); -var_dump($request->getControllerName()); -var_dump($request->getParam("foo")); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Route_Map::__construct - Yaf_Route_Map::assemble - - - - - - diff --git a/reference/yaf/yaf_route_regex/assemble.xml b/reference/yaf/yaf_route_regex/assemble.xml deleted file mode 100644 index 732da9327e..0000000000 --- a/reference/yaf/yaf_route_regex/assemble.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - - Yaf_Route_Regex::assemble - Ensamblar un URL - - - - &reftitle.description; - - public stringnullYaf_Route_Regex::assemble - arrayinfo - arrayquery - - - Ensamblar un URL - - - - - &reftitle.parameters; - - - info - - - - - - - - query - - - - - - - - - - - &reftitle.returnvalues; - - Devuelve &string; en caso de éxito o &null; en caso de fallo. - - - - - &reftitle.examples; - - Ejemplo de <function>Yaf_Route_Regex::assemble</function> - - "product", //route to product controller, - ), - array(), - array(), - '/:m/:c/:a' - ); - -$router->addRoute("regex", $route); - -var_dump($router->getRoute('regex')->assemble( - array( - ':m' => 'module', - ':c' => 'controller', - ':a' => 'action' - ), - array( - 'tkey1' => 'tval1', - 'tkey2' => - 'tval2' - ) - ) - ); -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/yaf/yaf_route_regex/construct.xml b/reference/yaf/yaf_route_regex/construct.xml deleted file mode 100644 index cce9553f33..0000000000 --- a/reference/yaf/yaf_route_regex/construct.xml +++ /dev/null @@ -1,247 +0,0 @@ - - - - - - Yaf_Route_Regex::__construct - Constructor de Yaf_Route_Regex - - - - &reftitle.description; - - public Yaf_Route_Regex::__construct - stringmatch - arrayroute - arraynullmap&null; - arraynullverify&null; - stringnullreverse&null; - - - Construye una ruta Yaf_Route_Regex, que enruta una URI - de petición que coincide con una expresión regular hacia un módulo, un controlador - y una acción. - - - - - - &reftitle.parameters; - - - match - - - Un patrón de expresión regular completo, utilizado para hacer coincidir la URI - de la petición. Cuando no coincide, Yaf_Route_Regex::route - devuelve &false; y el router pasa a la siguiente ruta. - - - - - route - - - Cuando el patrón coincide con la URI de la petición, este &array; determina - el módulo, el controlador y la acción a los que enrutar. - - - Cada una de las tres entradas es opcional; cuando no se proporciona, se usa - el valor por omisión. Una entrada cuyo valor comienza con : - se resuelve contra los parámetros producidos por map. - - - - - map - - - Un &array; que asigna índices de grupos de captura a nombres de parámetros. - Solo las capturas enumeradas aquí se convierten en parámetros de la petición; - una captura numérica no enumerada se descarta. - - - Los grupos de captura con nombre siempre se añaden bajo su propio nombre - y no necesitan ser enumerados. - - - - - verify - - - Aceptado y almacenado en la ruta, pero no utilizado: la implementación actual - nunca lo consulta durante el enrutamiento. - - - - - reverse - - - Una &string; utilizada para ensamblar la URL; véase - Yaf_Route_Regex::assemble. - - - Este parámetro fue introducido en la versión 2.3.0. - - - - - - - - - - &reftitle.returnvalues; - No se devuelve ningún valor. - - - - &reftitle.examples; - - <classname>Yaf_Route_Regex</classname> mediante <methodname>Yaf_Router::addRoute</methodname> - -getRouter()->addRoute( - "name", - new Yaf_Route_Regex( - "#^/product/([^/]+)/([^/]+)#", // coincide con una URI que empieza por "/product" - array( - 'controller' => "product", // enruta al controlador product - ), - array( - 1 => "name", // $request->getParam("name") contiene la primera captura - 2 => "id", // y $request->getParam("id") la segunda - ) - ) -); -?> -]]> - - - - <classname>Yaf_Route_Regex</classname> usando una captura como nombre de controlador - -getRouter()->addRoute( - "name", - new Yaf_Route_Regex( - "#^/product/([^/]+)/([^/]+)#i", // coincide con una URI que empieza por "/product" - array( - 'controller' => ":name", // la captura "name" (véase map) se convierte en el controlador - ), - array( - 1 => "name", // $request->getParam("name") contiene la primera captura - 2 => "id", // y $request->getParam("id") la segunda - ) - ) -); -?> -]]> - - - - <classname>Yaf_Route_Regex</classname> usando un grupo de captura con nombre - -getRouter()->addRoute( - "name", - new Yaf_Route_Regex( - "#^/product/(?[^/]+)/([^/]+)#i", // coincide con una URI que empieza por "/product" - array( - 'controller' => ":name", // la captura "name" se convierte en el controlador - ), - array( - 2 => "id", // el grupo 1 tiene nombre, solo el grupo 2 necesita una entrada en map - ) - ) -); -?> -]]> - - - - <classname>Yaf_Route_Regex</classname> mediante <methodname>Yaf_Router::addConfig</methodname> - - array( - "type" => "regex", // una ruta Yaf_Route_Regex - "match" => "#(.*)#", // coincide con cualquier URI de petición - "route" => array( - 'controller' => "product", // enruta al controlador product - 'action' => "dummy", // y a la acción dummy - ), - "map" => array( - 1 => "uri", // $request->getParam("uri") contiene la URI coincidente - ), - ), -); - -Yaf_Dispatcher::getInstance()->getRouter()->addConfig( - new Yaf_Config_Simple($config) -); -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Route_Regex::route - Yaf_Route_Regex::assemble - Yaf_Router::addRoute - Yaf_Router::addConfig - Yaf_Route_Static - Yaf_Route_Supervar - Yaf_Route_Simple - Yaf_Route_Rewrite - Yaf_Route_Map - - - - - - diff --git a/reference/yaf/yaf_route_regex/route.xml b/reference/yaf/yaf_route_regex/route.xml deleted file mode 100644 index b85302fff4..0000000000 --- a/reference/yaf/yaf_route_regex/route.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - Yaf_Route_Regex::route - El propósito de route - - - - &reftitle.description; - - public boolYaf_Route_Regex::route - Yaf_Request_Abstractrequest - - - Enruta una petición entrante. - - - - - - &reftitle.parameters; - - - request - - - La instancia de Yaf_Request_Abstract a enrutar. - - - - - - - - &reftitle.returnvalues; - - Si el patrón dado por el primer parámetro de - Yaf_Route_Regex::_construct coincide con el URI - solicitado, devuelve &true;, si no devuelve &false;. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Route_Regex::route</methodname> - - "product", // route to the product controller - ), - array( - 1 => "name", // $request->getParam("name") will be "php-book" - ) -); - -var_dump($route->route($request)); - -var_dump($request->getControllerName()); -var_dump($request->getParam("name")); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Route_Regex::__construct - Yaf_Route_Regex::match - Yaf_Route_Regex::assemble - - - - - - diff --git a/reference/yaf/yaf_route_rewrite/assemble.xml b/reference/yaf/yaf_route_rewrite/assemble.xml deleted file mode 100644 index fb56cda074..0000000000 --- a/reference/yaf/yaf_route_rewrite/assemble.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - - Yaf_Route_Rewrite::assemble - Ensamblar un URL - - - - &reftitle.description; - - public stringYaf_Route_Rewrite::assemble - arrayinfo - arrayquery - - - Ensamblar un URL. - - - - - &reftitle.parameters; - - - info - - - - - - - - query - - - - - - - - - - - &reftitle.returnvalues; - - Devuelve &string;. - - - - - &reftitle.examples; - - Ejemplo de <function>Yaf_Route_Rewrite::assemble</function> - - "product", - ), - array() -); - -$router->addRoute("rewrite", $route); - -var_dump($router->getRoute('rewrite')->assemble( - array( - ':name' => 'foo', - ':id' => 'bar', - ':tmpkey1' => 'tmpval1' - ), - array( - 'tkey1' => 'tval1', - 'tkey2' => 'tval2' - ) - ) -); - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/yaf/yaf_route_rewrite/construct.xml b/reference/yaf/yaf_route_rewrite/construct.xml deleted file mode 100644 index 0bf232ee29..0000000000 --- a/reference/yaf/yaf_route_rewrite/construct.xml +++ /dev/null @@ -1,242 +0,0 @@ - - - - - - - - Yaf_Route_Rewrite::__construct - Constructor de Yaf_Route_Rewrite - - - - &reftitle.description; - - public Yaf_Route_Rewrite::__construct - stringmatch - arrayroute - arrayverify - - - - - - - - &reftitle.parameters; - - - match - - - Un patrón de expresión regular completo, se usará para comparar un URI solicitado, si - no coincide, Yaf_Route_Regex devolverá - &false;. - - - Se puede usar el stilo :name para nombrar segmentos a buscar. y * para - encontrar el resto de segmentos. - - - - - route - - - Cuando el patrón de comparación coincida con el URI solicitado, - Yaf_Route_Regex lo usará para decidir qué - módulo/ccontrolador/acción enrutar. - - - Cada módulo/ccontrolador/acción en este array es opcional, si no se asigna un - valor específico, será enrutada al valor predeterminado. - - - - - verify - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo de <classname>Yaf_Route_Rewrite</classname> - -getRouter()->addRoute("name", - new Yaf_Route_Rewrite( - "/product/:name/:id/*", //match request uri leading "/product" - array( - 'controller' => "product", //route to product controller, - ), - ) - ); -?> -]]> - - &example.outputs.similar; - - "product", - "module" => "index", //(default) - "action" => "index", //(default) -) - -/** - * y los parámetros de petición: - */ -array( - "name" => "foo", - "id" => 22, - "foo" => bar -) -]]> - - - - Ejemplo de <classname>Yaf_Route_Rewrite</classname> - - array( - "type" => "rewrite", //Yaf_Route_Rewrite route - "match" => "/user-list/:id", //match only /user/list/?/ - "route" => array( - 'controller' => "user", //route to user controller, - 'action' => "list", //route to list action - ), - ), - ); - Yaf_Dispatcher::getInstance()->getRouter()->addConfig( - new Yaf_Config_Simple($config)); -?> -]]> - - &example.outputs.similar; - - "user", - "action" => "list", - "module" => "index", //(default) -) - -/** - * y los parámetros de petición: - */ -array( - "id" => 22, -) -]]> - - - - Ejemplo de <classname>Yaf_Route_Rewrite</classname> (como en 2.3.0) - - array( - "type" => "rewrite", - "match" => "/user-list/:a/:id", //coincidir solo /user-list/* - "route" => array( - 'controller' => "user", //ruta a user controller, - 'action' => ":a", //ruta a acción :a - ), - ), - ); - Yaf_Dispatcher::getInstance()->getRouter()->addConfig( - new Yaf_Config_Simple($config)); -?> -]]> - - &example.outputs.similar; - - "user", - "action" => "list", - "module" => "index", //(default) -) - -/** - * y los parámetros de petición: - */ -array( - "id" => 22, -) -]]> - - - - - - &reftitle.seealso; - - Yaf_Router::addRoute - Yaf_Router::addConfig - Yaf_Route_Static - Yaf_Route_Supervar - Yaf_Route_Simple - Yaf_Route_Regex - Yaf_Route_Map - - - - - - diff --git a/reference/yaf/yaf_route_rewrite/route.xml b/reference/yaf/yaf_route_rewrite/route.xml deleted file mode 100644 index bb3658f549..0000000000 --- a/reference/yaf/yaf_route_rewrite/route.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - Yaf_Route_Rewrite::route - El propósito de route - - - - &reftitle.description; - - public boolYaf_Route_Rewrite::route - Yaf_Request_Abstractrequest - - - Enruta la petición comparando el URI con el patrón - match indicado al constructor. Cuando coincide, el - módulo, el controlador y la acción se toman del array - route, donde un valor que empieza por dos puntos se - resuelve a partir de las variables capturadas. - - - - - - &reftitle.parameters; - - - request - - - La instancia de Yaf_Request_Abstract a enrutar. - - - - - - - - &reftitle.returnvalues; - Devuelve &true; si el URI coincide, &false; en caso contrario, lo que hace que el enrutador pruebe la siguiente ruta. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Route_Rewrite::route</methodname> - - "product", // route to the product controller - ), - array() // no default values -); - -var_dump($route->route($request)); - -var_dump($request->getControllerName()); -var_dump($request->getParam("name")); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Route_Rewrite::__construct - Yaf_Route_Rewrite::match - Yaf_Route_Rewrite::assemble - - - - - - diff --git a/reference/yaf/yaf_route_simple/assemble.xml b/reference/yaf/yaf_route_simple/assemble.xml deleted file mode 100644 index 780147bd58..0000000000 --- a/reference/yaf/yaf_route_simple/assemble.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - - Yaf_Route_Simple::assemble - Ensamblar un URL - - - - &reftitle.description; - - public stringYaf_Route_Simple::assemble - arrayinfo - arrayquery - - - Ensamblar un URL. - - - - - &reftitle.parameters; - - - info - - - - - - - - query - - - - - - - - - - - &reftitle.returnvalues; - - Devuelve un &string;. - - - - - &reftitle.errors; - - Lanza Yaf_Exception_TypeError si las claves ':c' o ':a' de info no están establecidas. - - - - - &reftitle.examples; - - Ejemplo de <function>Yaf_Route_Simple::assemble</function> - -addRoute("simple", $route); - -var_dump($router->getRoute('simple')->assemble( - array( - ':a' => 'yafaction', - 'tkey' => 'tval', - ':c' => 'yafcontroller', - ':m' => 'yafmodule' - ), - array( - 'tkey1' => 'tval1', - 'tkey2' => 'tval2' - ) - )); -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/yaf/yaf_route_simple/construct.xml b/reference/yaf/yaf_route_simple/construct.xml deleted file mode 100644 index 6d91fb9917..0000000000 --- a/reference/yaf/yaf_route_simple/construct.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - Yaf_Route_Simple::__construct - El constructor de la clase Yaf_Route_Simple - - - - &reftitle.description; - - public Yaf_Route_Simple::__construct - stringmodule_name - stringcontroller_name - stringaction_name - - - Construye una ruta simple. Una ruta simple lee los nombres del módulo, del - controlador y de la acción a partir de las variables de consulta indicadas - por los tres argumentos. Por ejemplo, con los argumentos del constructor - module, controller y - action, la ruta captura una petición como - /?module=foo&controller=bar&action=list. - - - - - &reftitle.parameters; - - - module_name - - - El nombre de la variable de consulta que lleva el nombre del módulo. - - - - - controller_name - - - El nombre de la variable de consulta que lleva el nombre del controlador. - - - - - action_name - - - El nombre de la variable de consulta que lleva el nombre de la acción. - - - - - - - - &reftitle.returnvalues; - No se devuelve ningún valor. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Route_Simple::__construct</methodname> - -getRouter()->addRoute("simple", - new Yaf_Route_Simple("m", "c", "a") -); -?> -]]> - - &example.outputs.similar; - - "main", - "controller" => "product", - "action" => "detail", -) -]]> - - - - - - &reftitle.seealso; - - Yaf_Route_Simple::route - Yaf_Route_Simple::assemble - - - - - - diff --git a/reference/yaf/yaf_route_simple/route.xml b/reference/yaf/yaf_route_simple/route.xml deleted file mode 100644 index f36a40452c..0000000000 --- a/reference/yaf/yaf_route_simple/route.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Yaf_Route_Simple::route - Enviar una petición - - - - &reftitle.description; - - public boolYaf_Route_Simple::route - Yaf_Request_Abstractrequest - - - Véase Yaf_Route_Simple::__construct - - - - - - &reftitle.parameters; - - - request - - - La instancia de Yaf_Request_Abstract a enrutar. - - - - - - - - &reftitle.returnvalues; - - Siempre es &true; - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Route_Simple::route</methodname> - -route($request)); - -var_dump($request->getModuleName()); -var_dump($request->getControllerName()); -var_dump($request->getActionName()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Route_Simple::__construct - Yaf_Route_Simple::assemble - - - - - - diff --git a/reference/yaf/yaf_route_static/assemble.xml b/reference/yaf/yaf_route_static/assemble.xml deleted file mode 100644 index afa1a18cd9..0000000000 --- a/reference/yaf/yaf_route_static/assemble.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - - - Yaf_Route_Static::assemble - Ensamblar un URL - - - - &reftitle.description; - - public stringYaf_Route_Static::assemble - arrayinfo - arrayquery - - - Ensamblar un URL. - - - - - &reftitle.parameters; - - - info - - - - - - - - query - - - - - - - - - - - &reftitle.returnvalues; - - Devuelve un &string;. - - - - - &reftitle.errors; - - Lanza Yaf_Exception_TypeError si las claves ':c' y ':a' de info no están establecidas. - - - - - &reftitle.examples; - - Ejemplo de <function>Yaf_Route_Static::assemble</function> - -addRoute("static", $route); - -var_dump($router->getRoute('static')->assemble( - array( - ':a' => 'yafaction', - 'tkey' => 'tval', - ':c' => 'yafcontroller', - ':m' => 'yafmodule' - ), - ) -); - -var_dump($router->getRoute('static')->assemble( - array( - ':a' => 'yafaction', - 'tkey' => 'tval', - ':c' => 'yafcontroller', - ':m' => 'yafmodule' - ), - array( - 'tkey1' => 'tval1', - 'tkey2' => 'tval2' - ) - ) -); - -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/yaf/yaf_route_static/match.xml b/reference/yaf/yaf_route_static/match.xml deleted file mode 100644 index d97a54da26..0000000000 --- a/reference/yaf/yaf_route_static/match.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - Yaf_Route_Static::match - El propósito de match - - - - &reftitle.description; - - public boolYaf_Route_Static::match - stringuri - - - Determina si la ruta estática coincide con un URI. Como la ruta estática - coincide con cualquier URI, este método devuelve siempre &true;. - - - - - - &reftitle.parameters; - - - uri - - - El URI a comprobar. - - - - - - - - &reftitle.returnvalues; -Siempre devuelve &true;. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Route_Static::match</methodname> - -match("/product/detail/id/10")); -var_dump($route->match("/")); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Route_Static::route - - - - - - diff --git a/reference/yaf/yaf_route_static/route.xml b/reference/yaf/yaf_route_static/route.xml deleted file mode 100644 index d698d76f24..0000000000 --- a/reference/yaf/yaf_route_static/route.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - Yaf_Route_Static::route - Enviar una petición - - - - &reftitle.description; - - public boolYaf_Route_Static::route - Yaf_Request_Abstractrequest - - - Enruta la petición según el URI de estilo PATH_INFO: el primer segmento de - ruta se trata como nombre de módulo solo si es uno de los módulos - registrados; en caso contrario, los segmentos se asocian por orden al - controlador y a la acción. Los segmentos restantes se convierten en - argumentos de la petición. - - - Por ejemplo, sin ningún módulo llamado foo, - /foo/bar/age/10 enruta al controlador - Foo y a la acción bar, con un - argumento age de valor 10. - - - - - &reftitle.parameters; - - - request - - - La instancia de Yaf_Request_Abstract a enrutar. - - - - - - - - &reftitle.returnvalues; - Siempre devuelve &true;. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Route_Static::route</methodname> - -getRouter()->getRoute("_default"); -var_dump($route->route($request)); - -var_dump($request->getControllerName()); -var_dump($request->getActionName()); -var_dump($request->getParam("id")); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Route_Static::match - Yaf_Route_Static::assemble - - - - - - diff --git a/reference/yaf/yaf_route_supervar/assemble.xml b/reference/yaf/yaf_route_supervar/assemble.xml deleted file mode 100644 index f0b36a18c7..0000000000 --- a/reference/yaf/yaf_route_supervar/assemble.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - - - Yaf_Route_Supervar::assemble - Ensamblar un URL - - - - &reftitle.description; - - public stringYaf_Route_Supervar::assemble - arrayinfo - arrayquery - - - Ensamblar un URL. - - - - - &reftitle.parameters; - - - info - - - - - - - - query - - - - - - - - - - - &reftitle.returnvalues; - - Devuelve un &string;. - - - - - &reftitle.errors; - - Lanza Yaf_Exception_TypeError si las claves ':c' y ':a' de info no están establecidas. - - - - - &reftitle.examples; - - Ejemplo de <function>Yaf_Route_Supervar::assemble</function> - -addRoute("supervar", $route); - -var_dump($router->getRoute('supervar')->assemble( - array( - ':a' => 'yafaction', - 'tkey' => 'tval', - ':c' => 'yafcontroller', - ':m' => 'yafmodule' - ), - array( - 'tkey1' => 'tval1', - 'tkey2' => 'tval2' - ) -)); - -try { -var_dump($router->getRoute('supervar')->assemble( - array( - ':a' => 'yafaction', - 'tkey' => 'tval', - ':m' => 'yafmodule' - ), - array( - 'tkey1' => 'tval1', - 'tkey2' => 'tval2', - 1 => array(), - ) -)); -} catch (Exception $e) { - var_dump($e->getMessage()); -} -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/yaf/yaf_route_supervar/construct.xml b/reference/yaf/yaf_route_supervar/construct.xml deleted file mode 100644 index f25ab160be..0000000000 --- a/reference/yaf/yaf_route_supervar/construct.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - Yaf_Route_Supervar::__construct - El propósito de __construct - - - - &reftitle.description; - - public Yaf_Route_Supervar::__construct - stringsupervar_name - - - Yaf_Route_Supervar es similar a - Yaf_Route_Static, con la diferencia de que - Yaf_Route_Supervar buscará información de ruta en la cadena - de consulta, y el parámetro supervar_name es la clave. - - - - - - &reftitle.parameters; - - - supervar_name - - - El nombre de la clave - - - - - - - - &reftitle.returnvalues; -No se devuelve ningún valor. - - - - - &reftitle.examples; - - Ejemplo de <classname>Yaf_Route_Supervar</classname> - -getRouter()->addRoute("supervar", - new Yaf_Route_Supervar("_url") -); -?> -]]> - - &example.outputs.similar; - - "product", - "module" => "index", //(por omisión) - "action" => "detail", //(por omisión) -) - -/** - * y los parámetros de petición: - */ -array( - "id" => 10 -) -]]> - - - - - - &reftitle.seealso; - - Yaf_Route_Supervar::route - Yaf_Route_Supervar::assemble - - - - - - diff --git a/reference/yaf/yaf_route_supervar/route.xml b/reference/yaf/yaf_route_supervar/route.xml deleted file mode 100644 index 0261598d57..0000000000 --- a/reference/yaf/yaf_route_supervar/route.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - Yaf_Route_Supervar::route - El propósito de route - - - - &reftitle.description; - - public boolYaf_Route_Supervar::route - Yaf_Request_Abstractrequest - - - Enruta la petición con una supervariable: se espera que la variable de - consulta cuyo nombre se ha indicado al constructor lleve un URI de estilo - PATH_INFO, que se analiza después igual que hace - Yaf_Route_Static. - - - - - - &reftitle.parameters; - - - request - - - La instancia de Yaf_Request_Abstract a enrutar. - - - - - - - - &reftitle.returnvalues; - - Si existe una clave (la cual fue definida en - Yaf_Route_Supervar::__construct) en $_GET, devuelve &true;, - si no devuelve &false;. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Route_Supervar::route</methodname> - -route($request)); - -var_dump($request->getControllerName()); -var_dump($request->getActionName()); -var_dump($request->getParam("id")); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Route_Supervar::__construct - Yaf_Route_Supervar::assemble - - - - - - diff --git a/reference/yaf/yaf_router/addconfig.xml b/reference/yaf/yaf_router/addconfig.xml deleted file mode 100644 index e4eea0e9a5..0000000000 --- a/reference/yaf/yaf_router/addconfig.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - - - Yaf_Router::addConfig - Añadir rutas definidas en configuración al Enrutador - - - - &reftitle.description; - - public boolYaf_Router::addConfig - Yaf_Config_Abstractconfig - - - Añade rutas definidas mediante configuraciones en - la pila de rutas de Yaf_Router - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Una instancia de Yaf_Config_Abstract, la cual debería - contener una o más configuraciones de rutas válidas. - - - - - &reftitle.examples; - - Ejemplo de <function>application.ini</function> - - - - - - Ejemplo de <function>Yaf_Dispatcher::autoConfig</function> - -getConfig(); - Yaf_Registry::set("config", $config); - } - - public function _initRoute(Yaf_Dispatcher $dispatcher) { - $router = $dispatcher->getRouter(); - /** - * podemos añadir algunas rutas predefinidas en application.ini - */ - $router->addConfig(Yaf_Registry::get("config")->routes); - } - -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Router::addRoute - Yaf_Route_Static - Yaf_Route_Supervar - Yaf_Route_Simple - 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 deleted file mode 100644 index e1c9d7be51..0000000000 --- a/reference/yaf/yaf_router/addroute.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - - Yaf_Router::addRoute - Añadir una nueva ruta al Enrutador - - - - &reftitle.description; - - public boolYaf_Router::addRoute - stringname - Yaf_Route_Abstractroute - - - Por defecto, Yaf_Router usa un Yaf_Route_Static como su ruta predeterminada. - Se pueden añadir nuevas rutas a la pila de rutas del Enrutador llamando a este método. - - - La ruta más nueva será llamada antes que la más antigua (pila de rutas), y si la ruta más nueva devuelve - &true;, el proceso de enrutamiento finalizará. De otro modo, será llamada la ruta más - antigua. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo de <function>Yaf_Dispatcher::autoRender</function> - -getConfig(); - Yaf_Registry::set("config", $config); - } - - public function _initRoute(Yaf_Dispatcher $dispatcher) { - $router = $dispatcher->getRouter(); - /** - * podemos añadir algunas rutas predefinidas en application.ini - */ - $router->addConfig(Yaf_Registry::get("config")->routes); - /** - * 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] => - * [controller] => product - * [action] => info - * [method] => GET - * [params:protected] => Array - * ( - * [id] => 22 - * [name] => foo - * ) - * - */ - $route = new Yaf_Route_Rewrite( - "/product/list/:id/:name", - array( - "controller" => "product", - "action" => "info", - ) - ); - - $router->addRoute('dummy', $route); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Router::addConfig - Yaf_Route_Static - Yaf_Route_Supervar - Yaf_Route_Simple - 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 deleted file mode 100644 index 4e31c30ba5..0000000000 --- a/reference/yaf/yaf_router/construct.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Yaf_Router::__construct - El constructor de Yaf_Router - - - - &reftitle.description; - - public Yaf_Router::__construct - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Router::__construct</methodname> - - En el uso habitual el enrutador no se construye manualmente, pertenece al - despachador: - - -getRouter(); -var_dump($router); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Dispatcher::getRouter - Yaf_Router::addRoute - - - - - - diff --git a/reference/yaf/yaf_router/getcurrentroute.xml b/reference/yaf/yaf_router/getcurrentroute.xml deleted file mode 100644 index 7285831505..0000000000 --- a/reference/yaf/yaf_router/getcurrentroute.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - Yaf_Router::getCurrentRoute - Obtener el nombre de la ruta efectiva - - - - &reftitle.description; - - public stringYaf_Router::getCurrentRoute - - - - Obtiene el nombre de la ruta efectiva del proceso de enrutamiento. - - - Se debería llamar a este método después de que finalice el proceso de enrutamiento, ya que - si se hace antes, este método devolverá siempre &null;. - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Una cadena, el nombre de la ruta efectiva. - - - - - &reftitle.examples; - - Registrar algunas rutas en el Arranque - -getConfig(); - Yaf_Registry::set("config", $config); - } - - public function _initRoute(Yaf_Dispatcher $dispatcher) { - $router = $dispatcher->getRouter(); - $rewrite_route = new Yaf_Route_Rewrite( - "/product/list/:page", - array( - "controller" => "product", - "action" => "list", - ) - ); - - $regex_route = new Yaf_Route_Rewrite( - "#^/product/info/(\d+)", - array( - "controller" => "product", - "action" => "info", - ) - ); - - $router->addRoute('rewrite', $rewrite_route)->addRoute('regex', $regex_route); - } - - /** - * registrar un complemento - */ - public function __initPlugins(Yaf_Dispatcher $dispatcher) { - $dispatcher->registerPlugin(new DummyPlugin()); - } -} -?> -]]> - - - - Plugin Dummy.php (bajo <link - linkend="configuration.yaf.directory">application.directory</link>/plugins) - -getRouter()->getCurrentRoute()); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - 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 deleted file mode 100644 index c4ea70629a..0000000000 --- a/reference/yaf/yaf_router/getroute.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Yaf_Router::getRoute - Recupera una ruta por su nombre - - - - &reftitle.description; - - public Yaf_Route_InterfaceYaf_Router::getRoute - stringname - - - Recupera una ruta por su nombre. Véase también - Yaf_Router::getCurrentRoute - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Router::getRoute</methodname> - -getRouter(); - - $router->addRoute("rewrite", new Yaf_Route_Rewrite( - "/product/:id", - ["controller" => "product", "action" => "detail"] - )); - - /* se comprueba lo que se registró con un nombre dado */ - var_dump($router->getRoute("rewrite")); - - /* un nombre desconocido devuelve NULL */ - var_dump($router->getRoute("unknown")); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Bootstrap_Abstract - 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 deleted file mode 100644 index b6c530a890..0000000000 --- a/reference/yaf/yaf_router/getroutes.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Yaf_Router::getRoutes - Recupera las rutas registradas - - - - &reftitle.description; - - public mixedYaf_Router::getRoutes - - - - Recupera las rutas registradas. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Router::getRoutes</methodname> - -getRouter(); - - $router->addRoute("rewrite", new Yaf_Route_Rewrite( - "/product/:id", - ["controller" => "product", "action" => "detail"] - )); - - /* además de la personalizada, la ruta interna "_default" - también forma parte de la tabla de rutas */ - var_dump(array_keys($router->getRoutes())); - } -} -?> -]]> - - &example.outputs.similar; - - - string(8) "_default" - [1]=> - string(7) "rewrite" -} -]]> - - - - - - &reftitle.seealso; - - Yaf_Router::getRoute - Yaf_Router::addRoute - Yaf_Dispatcher::getRouter - - - - - - diff --git a/reference/yaf/yaf_router/route.xml b/reference/yaf/yaf_router/route.xml deleted file mode 100644 index 49e17ef245..0000000000 --- a/reference/yaf/yaf_router/route.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - Yaf_Router::route - El propósito de route - - - - &reftitle.description; - - public boolnullYaf_Router::route - Yaf_Request_Abstractrequest - - Enruta la petición con las rutas registradas. - - Las rutas se prueban en orden inverso al de registro. Gana la primera ruta - que captura la petición; la petición se marca entonces como enrutada (ver - Yaf_Request_Abstract::setRouted) y se registra el - nombre de la ruta ganadora, que puede recuperarse mediante - Yaf_Router::getCurrentRoute. - - - La ruta por omisión, registrada como _default, es - Yaf_Route_Static, salvo que se configure una ruta por - omisión personalizada. - - - - - &reftitle.parameters; - - - request - - - La instancia de Yaf_Request_Abstract a enrutar. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; si la petición ha sido enrutada, o &false; si ninguna ruta - ha coincidido (por ejemplo, un URI mal formado), lo que hace que el - despachador se detenga. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Router::route</methodname> - -getRouter(); - - $router->addRoute("rewrite", new Yaf_Route_Rewrite( - "/product/:id", - ["controller" => "product", "action" => "detail"] - )); - - /* enruta una petición construida a mano, por ejemplo en una prueba unitaria */ - $request = new Yaf_Request_Simple("CLI", null, "index.php", - "/product/123", null); - - if ($router->route($request)) { - var_dump($router->getCurrentRoute()); - var_dump($request->getControllerName()); - var_dump($request->getActionName()); - var_dump($request->getParam("id")); - } else { - /* no route matched */ - } - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Router::addRoute - Yaf_Router::getCurrentRoute - Yaf_Dispatcher::dispatch - - - - - - diff --git a/reference/yaf/yaf_session/construct.xml b/reference/yaf/yaf_session/construct.xml deleted file mode 100644 index 9d064372ab..0000000000 --- a/reference/yaf/yaf_session/construct.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Yaf_Session::__construct - Constructor de Yaf_Session - - - - &reftitle.description; - - private Yaf_Session::__construct - - - - El constructor es privado: Yaf_Session implementa el - patrón singleton y no puede instanciarse directamente. Se usa - Yaf_Session::getInstance para obtener la instancia - de la sesión. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -No se devuelve ningún valor. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Session::__construct</methodname> - -start(); - -$session->set("user_id", 42); -echo $session->get("user_id"); -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Session::getInstance - Yaf_Session::start - - - - - - diff --git a/reference/yaf/yaf_session/count.xml b/reference/yaf/yaf_session/count.xml deleted file mode 100644 index 3ebaac079b..0000000000 --- a/reference/yaf/yaf_session/count.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Yaf_Session::count - El propósito de count - - - - &reftitle.description; - - public intYaf_Session::count - - - - Devuelve el número de entradas de la sesión. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -El número de entradas de la sesión, como entero. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Session::count</methodname> - -start(); - -$session->set("user_id", 42); -$session->set("cart_items", 3); - -var_dump(count($session)); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Session::get - Yaf_Session::has - - - - - - diff --git a/reference/yaf/yaf_session/current.xml b/reference/yaf/yaf_session/current.xml deleted file mode 100644 index b42e2fe4d0..0000000000 --- a/reference/yaf/yaf_session/current.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - Yaf_Session::current - El propósito de current - - - - &reftitle.description; - - public mixedYaf_Session::current - - - - Devuelve el valor de la entrada de sesión actual durante la iteración. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -El valor de la entrada de sesión actual. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Session::current</methodname> - -start(); - -$session->set("user_id", 42); -$session->set("is_vip", true); - -foreach ($session as $key => $value) { - // Yaf_Session::current() yields each value while iterating - echo "$key => "; - var_dump($value); -} -?> -]]> - - &example.outputs.similar; - - int(42) -is_vip => bool(true) -]]> - - - - - - &reftitle.seealso; - - Yaf_Session::key - Yaf_Session::next - Yaf_Session::rewind - Yaf_Session::valid - - - - - - diff --git a/reference/yaf/yaf_session/del.xml b/reference/yaf/yaf_session/del.xml deleted file mode 100644 index 89d463d134..0000000000 --- a/reference/yaf/yaf_session/del.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Yaf_Session::del - El propósito de del - - - - &reftitle.description; - - public boolYaf_Session::del - stringname - - - Elimina una clave de sesión y su valor. - - - - - - &reftitle.parameters; - - - name - - - La clave de sesión a eliminar. - - - - - - - - &reftitle.returnvalues; -Devuelve &true; en caso de éxito, o &false; en caso de error. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Session::del</methodname> - -start(); - - $expected = $session->get("captcha_code"); - - // código de un solo uso: se elimina justo después de usarlo - $session->del("captcha_code"); - - if ($expected === null - || $this->getRequest()->getPost("code") !== $expected) { - echo "invalid captcha"; - } - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Session::get - Yaf_Session::set - Yaf_Session::has - - - - - - diff --git a/reference/yaf/yaf_session/get.xml b/reference/yaf/yaf_session/get.xml deleted file mode 100644 index 6cf4160380..0000000000 --- a/reference/yaf/yaf_session/get.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Yaf_Session::__get - El propósito de __get - - - - &reftitle.description; - - public mixedYaf_Session::get - stringnameNULL - - - Recupera un valor de sesión por su nombre. Si se omite - name o es &null;, se devuelve el array completo de - la sesión. - - - - - - &reftitle.parameters; - - - name - - - La clave de sesión a recuperar, o &null; para obtener todos los datos de - la sesión. - - - - - - - - &reftitle.returnvalues; -El valor de la sesión, o &null; si la clave no existe. Cuando name es &null;, se devuelve el array completo de la sesión. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Session::get</methodname> - -start(); - - $userId = $session->get("user_id"); - if ($userId === null) { - return $this->redirect("/account/login"); - } - - echo "welcome back, user #", $userId; - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Session::set - Yaf_Session::has - Yaf_Session::del - - - - - - diff --git a/reference/yaf/yaf_session/getinstance.xml b/reference/yaf/yaf_session/getinstance.xml deleted file mode 100644 index e68cc538cb..0000000000 --- a/reference/yaf/yaf_session/getinstance.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Yaf_Session::getInstance - El propósito de getInstance - - - - &reftitle.description; - - public static Yaf_SessionYaf_Session::getInstance - - - - Devuelve la instancia única de Yaf_Session, - creándola si es necesario. La sesión se inicia automáticamente en el primer - acceso. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -The Yaf_Session singleton instance, o &null; si no se pudo iniciar la sesión. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Session::getInstance</methodname> - -start(); -$session->set("user_id", 42); - -// ... later, elsewhere in the application -$same = Yaf_Session::getInstance(); - -var_dump($same === $session); -var_dump($same->get("user_id")); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Session::start - Yaf_Session::get - Yaf_Session::set - - - - - - diff --git a/reference/yaf/yaf_session/has.xml b/reference/yaf/yaf_session/has.xml deleted file mode 100644 index 217bd92261..0000000000 --- a/reference/yaf/yaf_session/has.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Yaf_Session::has - El propósito de has - - - - &reftitle.description; - - public boolYaf_Session::has - stringname - - - Comprueba si existe una clave de sesión. - - - - - - &reftitle.parameters; - - - name - - - La clave de sesión a comprobar. - - - - - - - - &reftitle.returnvalues; -Devuelve &true; si the key exists, &false; en caso contrario. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Session::has</methodname> - -start(); - - if (!$session->has("user_id")) { - $this->redirect("/account/login"); - return false; - } - - return true; - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Session::get - Yaf_Session::set - Yaf_Session::del - - - - - - diff --git a/reference/yaf/yaf_session/isset.xml b/reference/yaf/yaf_session/isset.xml deleted file mode 100644 index 542a02b746..0000000000 --- a/reference/yaf/yaf_session/isset.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Yaf_Session::__isset - El propósito de __isset - - - - &reftitle.description; - - public boolYaf_Session::__isset - stringname - - - Comprueba si existe una clave de sesión. Este método es un alias de - Yaf_Session::has y se llama cuando se usa - isset sobre un objeto de sesión. - - - - - - &reftitle.parameters; - - - name - - - La clave de sesión a comprobar. - - - - - - - - &reftitle.returnvalues; -Devuelve &true; si the key exists, &false; en caso contrario. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Session::__isset</methodname> - -start(); - -$session->user_id = 42; - -var_dump(isset($session->user_id)); -var_dump(isset($session->user_name)); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Session::has - Yaf_Session::get - - - - - - diff --git a/reference/yaf/yaf_session/key.xml b/reference/yaf/yaf_session/key.xml deleted file mode 100644 index 4d57e8556f..0000000000 --- a/reference/yaf/yaf_session/key.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - Yaf_Session::key - El propósito de key - - - - &reftitle.description; - - public mixedYaf_Session::key - - - - Devuelve la clave de la entrada de sesión actual durante la iteración. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -La clave de la entrada de sesión actual. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Session::key</methodname> - -start(); - -$session->set("user_id", 42); -$session->set("lang", "en"); - -for ($session->rewind(); $session->valid(); $session->next()) { - echo $session->key(), " => ", var_export($session->current(), true), PHP_EOL; -} -?> -]]> - - &example.outputs.similar; - - 42 -lang => 'en' -]]> - - - - - - &reftitle.seealso; - - Yaf_Session::current - Yaf_Session::next - Yaf_Session::rewind - Yaf_Session::valid - - - - - - diff --git a/reference/yaf/yaf_session/next.xml b/reference/yaf/yaf_session/next.xml deleted file mode 100644 index 61ef2b9aac..0000000000 --- a/reference/yaf/yaf_session/next.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - Yaf_Session::next - El propósito de next - - - - &reftitle.description; - - public voidYaf_Session::next - - - - Desplaza el iterador interno a la siguiente entrada de la sesión. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -No se devuelve ningún valor. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Session::next</methodname> - -start(); - -$session->set("user_id", 42); -$session->set("lang", "en"); - -$session->rewind(); -echo $session->key(), PHP_EOL; - -$session->next(); -echo $session->key(), PHP_EOL; -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Session::current - Yaf_Session::key - Yaf_Session::rewind - Yaf_Session::valid - - - - - - diff --git a/reference/yaf/yaf_session/offsetexists.xml b/reference/yaf/yaf_session/offsetexists.xml deleted file mode 100644 index d7a43dd904..0000000000 --- a/reference/yaf/yaf_session/offsetexists.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Yaf_Session::offsetExists - El propósito de offsetExists - - - - &reftitle.description; - - public boolYaf_Session::offsetExists - mixedname - - - Comprueba si existe una clave de sesión. Este método es un alias de - Yaf_Session::has y se llama cuando se usa - isset con la sintaxis de array. - - - - - - &reftitle.parameters; - - - name - - - La clave de sesión a comprobar. - - - - - - - - &reftitle.returnvalues; -Devuelve &true; si the key exists, &false; en caso contrario. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Session::offsetExists</methodname> - -start(); - -$session["user_id"] = 42; - -var_dump(isset($session["user_id"])); -var_dump(isset($session["user_name"])); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Session::has - Yaf_Session::offsetGet - - - - - - diff --git a/reference/yaf/yaf_session/offsetget.xml b/reference/yaf/yaf_session/offsetget.xml deleted file mode 100644 index f2dfddb770..0000000000 --- a/reference/yaf/yaf_session/offsetget.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - Yaf_Session::offsetGet - El propósito de offsetGet - - - - &reftitle.description; - - public mixedYaf_Session::offsetGet - mixedname - - - Recupera un valor de sesión por su clave. Este método es un alias de - Yaf_Session::get y se llama cuando se usa la - sintaxis de array para leer un objeto de sesión. - - - - - - &reftitle.parameters; - - - name - - - La clave de sesión a recuperar. - - - - - - - - &reftitle.returnvalues; -El valor de la sesión, o &null; si la clave no existe. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Session::offsetGet</methodname> - -start(); - - // reading with array syntax calls offsetGet() - $userId = $session["user_id"]; - if ($userId === null) { - return $this->redirect("/account/login"); - } - - echo "logged in as user #", $userId; - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Session::get - Yaf_Session::offsetSet - Yaf_Session::offsetUnset - - - - - - diff --git a/reference/yaf/yaf_session/offsetset.xml b/reference/yaf/yaf_session/offsetset.xml deleted file mode 100644 index 5e395a485e..0000000000 --- a/reference/yaf/yaf_session/offsetset.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - Yaf_Session::offsetSet - El propósito de offsetSet - - - - &reftitle.description; - - public voidYaf_Session::offsetSet - mixedname - mixedvalue - - - Establece un valor de sesión. Este método se llama cuando se usa la - sintaxis de array para escribir en un objeto de sesión. - - - - - - &reftitle.parameters; - - - name - - - La clave de sesión a establecer. - - - - - value - - - El valor a almacenar. - - - - - - - - &reftitle.returnvalues; -No se devuelve ningún valor. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Session::offsetSet</methodname> - -start(); - - // writing with array syntax calls offsetSet() - $session["user_id"] = $user->getId(); - $session["login_time"] = time(); - - return $this->redirect("/dashboard"); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Session::set - Yaf_Session::offsetGet - Yaf_Session::offsetUnset - - - - - - diff --git a/reference/yaf/yaf_session/offsetunset.xml b/reference/yaf/yaf_session/offsetunset.xml deleted file mode 100644 index 2e5a7eb058..0000000000 --- a/reference/yaf/yaf_session/offsetunset.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - Yaf_Session::offsetUnset - El propósito de offsetUnset - - - - &reftitle.description; - - public voidYaf_Session::offsetUnset - mixedname - - - Elimina una clave de sesión y su valor. Este método se llama cuando se usa - unset con la sintaxis de array sobre un objeto de - sesión. - - - - - - &reftitle.parameters; - - - name - - - La clave de sesión a eliminar. - - - - - - - - &reftitle.returnvalues; -No se devuelve ningún valor. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Session::offsetUnset</methodname> - -start(); - -$session["captcha_code"] = "8X2Q"; - -// ... tras verificar el captcha, se elimina el código de un solo uso -unset($session["captcha_code"]); - -var_dump(isset($session["captcha_code"])); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Session::del - Yaf_Session::offsetGet - Yaf_Session::offsetSet - - - - - - diff --git a/reference/yaf/yaf_session/rewind.xml b/reference/yaf/yaf_session/rewind.xml deleted file mode 100644 index eaa2ee7bac..0000000000 --- a/reference/yaf/yaf_session/rewind.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Yaf_Session::rewind - El propósito de rewind - - - - &reftitle.description; - - public voidYaf_Session::rewind - - - - Rebobina el iterador interno hasta la primera entrada de la sesión. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -No se devuelve ningún valor. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Session::rewind</methodname> - -start(); - -$session->set("user_id", 42); -$session->set("lang", "en"); - -foreach ($session as $key => $value) { - echo "$key => $value", PHP_EOL; -} - -// a new foreach implicitly calls rewind() again -foreach ($session as $key => $value) { - echo "$key => $value", PHP_EOL; -} -?> -]]> - - &example.outputs.similar; - - 42 -lang => en -user_id => 42 -lang => en -]]> - - - - - - &reftitle.seealso; - - Yaf_Session::current - Yaf_Session::key - Yaf_Session::next - Yaf_Session::valid - - - - - - diff --git a/reference/yaf/yaf_session/set.xml b/reference/yaf/yaf_session/set.xml deleted file mode 100644 index ebf78673c1..0000000000 --- a/reference/yaf/yaf_session/set.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - Yaf_Session::__set - El propósito de __set - - - - &reftitle.description; - - public boolYaf_Session::set - stringname - mixedvalue - - - Establece un valor de sesión. - - - - - - &reftitle.parameters; - - - name - - - La clave de sesión a establecer. - - - - - value - - - El valor a almacenar. - - - - - - - - &reftitle.returnvalues; -Devuelve &true; en caso de éxito, o &false; en caso de error. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Session::set</methodname> - -start(); - - $session->set("user_id", $user->getId()); - $session->set("login_time", time()); - - return $this->redirect("/dashboard"); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Session::get - Yaf_Session::has - Yaf_Session::del - - - - - - diff --git a/reference/yaf/yaf_session/start.xml b/reference/yaf/yaf_session/start.xml deleted file mode 100644 index ca4aadac40..0000000000 --- a/reference/yaf/yaf_session/start.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - Yaf_Session::start - El propósito de start - - - - &reftitle.description; - - public Yaf_SessionYaf_Session::start - - - - Inicia la sesión si todavía no se ha iniciado. Esto invoca el mecanismo - nativo de inicio de sesión de PHP. Llamar a este método varias veces no - supone ningún problema. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -Devuelve el Yaf_Session instance. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Session::start</methodname> - -start(); - -$session->set("user_id", 42); -echo $session->get("user_id"); -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_Session::getInstance - - - - - - diff --git a/reference/yaf/yaf_session/unset.xml b/reference/yaf/yaf_session/unset.xml deleted file mode 100644 index 71bb62fd84..0000000000 --- a/reference/yaf/yaf_session/unset.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Yaf_Session::__unset - El propósito de __unset - - - - &reftitle.description; - - public voidYaf_Session::__unset - stringname - - - Elimina una clave de sesión y su valor. Este método se llama cuando se usa - unset sobre una propiedad de un objeto de sesión. - - - - - - &reftitle.parameters; - - - name - - - La clave de sesión a eliminar. - - - - - - - - &reftitle.returnvalues; -No se devuelve ningún valor. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Session::__unset</methodname> - -start(); - -$session->user_id = 42; - -// ... cuando el usuario cierra la sesión -unset($session->user_id); - -var_dump(isset($session->user_id)); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Session::del - Yaf_Session::offsetUnset - - - - - - diff --git a/reference/yaf/yaf_session/valid.xml b/reference/yaf/yaf_session/valid.xml deleted file mode 100644 index b36bc0587a..0000000000 --- a/reference/yaf/yaf_session/valid.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Yaf_Session::valid - El propósito de valid - - - - &reftitle.description; - - public boolYaf_Session::valid - - - - Comprueba si la posición actual del iterador de la sesión es válida. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -Devuelve &true; si la posición actual es válida, &false; en caso contrario. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_Session::valid</methodname> - -start(); - -$session->set("user_id", 42); - -$session->rewind(); -var_dump($session->valid()); - -$session->next(); -// pasado el último elemento, la posición ya no es válida -var_dump($session->valid()); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_Session::current - Yaf_Session::key - Yaf_Session::next - Yaf_Session::rewind - - - - - - diff --git a/reference/yaf/yaf_view_interface/assign.xml b/reference/yaf/yaf_view_interface/assign.xml deleted file mode 100644 index e9558516b2..0000000000 --- a/reference/yaf/yaf_view_interface/assign.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - Yaf_View_Interface::assign - Asignar valores al motor de Vistas - - - - &reftitle.description; - - abstract public boolYaf_View_Interface::assign - mixedname - mixedvalueNULL - - - Asigna valores al motor de Vistas, después se pueden acceder a los valores directamente mediante su nombre en la plantilla. - - - - - - &reftitle.parameters; - - - name - - - El nombre con el que la variable queda disponible en la plantilla. - - - - - value - - - El valor a asignar. - - - - - - - - &reftitle.returnvalues; -El valor de retorno está definido por la implementación concreta. Yaf_View_Simple, el motor de vistas por omisión, devuelve la instancia de la vista. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_View_Interface::assign</methodname> - -tpl_dir = $template_dir; - } - - public function assign($name, $value = null) - { - $this->vars[$name] = $value; - return true; - } - - public function display($tpl, $tpl_vars = null) - { - echo $this->render($tpl, $tpl_vars); - return true; - } - - public function render($tpl, $tpl_vars = null) - { - extract($this->vars); - if ($tpl_vars !== null) { - extract($tpl_vars); - } - ob_start(); - include $this->tpl_dir . "/" . $tpl; - return ob_get_clean(); - } - - public function setScriptPath($template_dir) - { - $this->tpl_dir = $template_dir; - return $this; - } - - public function getScriptPath() - { - return $this->tpl_dir; - } -} - -/* se conecta el motor de vistas personalizado al despachador en el bootstrap */ -class Bootstrap extends Yaf_Bootstrap_Abstract -{ - public function _initView(Yaf_Dispatcher $dispatcher) - { - $dispatcher->setView(new MyView(APPLICATION_PATH . "/views")); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_View_Interface::display - Yaf_View_Interface::render - Yaf_View_Interface::setScriptPath - Yaf_View_Interface::getScriptPath - - - - - - diff --git a/reference/yaf/yaf_view_interface/display.xml b/reference/yaf/yaf_view_interface/display.xml deleted file mode 100644 index 30381ace47..0000000000 --- a/reference/yaf/yaf_view_interface/display.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - Yaf_View_Interface::display - Renderiza e imprime una plantilla - - - - &reftitle.description; - - abstract public boolYaf_View_Interface::display - stringtpl - arraytpl_varsNULL - - - Renderiza e imprime el resultado inmediatamente. - - - - - - &reftitle.parameters; - - - tpl - - - La ruta de la plantilla, relativa al directorio de plantillas. - - - - - tpl_vars - - - Variables opcionales a asignar solo para esta plantilla; tienen - prioridad sobre las variables asignadas con el mismo nombre. - - - - - - - - &reftitle.returnvalues; -Devuelve &true; en caso de éxito, o &false; en caso de error. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_View_Interface::display</methodname> - -tpl_dir = $template_dir; - } - - public function assign($name, $value = null) - { - $this->vars[$name] = $value; - return true; - } - - public function display($tpl, $tpl_vars = null) - { - echo $this->render($tpl, $tpl_vars); - return true; - } - - public function render($tpl, $tpl_vars = null) - { - extract($this->vars); - if ($tpl_vars !== null) { - extract($tpl_vars); - } - ob_start(); - include $this->tpl_dir . "/" . $tpl; - return ob_get_clean(); - } - - public function setScriptPath($template_dir) - { - $this->tpl_dir = $template_dir; - return $this; - } - - public function getScriptPath() - { - return $this->tpl_dir; - } -} - -/* se conecta el motor de vistas personalizado al despachador en el bootstrap */ -class Bootstrap extends Yaf_Bootstrap_Abstract -{ - public function _initView(Yaf_Dispatcher $dispatcher) - { - $dispatcher->setView(new MyView(APPLICATION_PATH . "/views")); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_View_Interface::render - Yaf_View_Interface::assign - Yaf_View_Interface::setScriptPath - Yaf_View_Interface::getScriptPath - - - - - - diff --git a/reference/yaf/yaf_view_interface/getscriptpath.xml b/reference/yaf/yaf_view_interface/getscriptpath.xml deleted file mode 100644 index 8ab118bb86..0000000000 --- a/reference/yaf/yaf_view_interface/getscriptpath.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - Yaf_View_Interface::getScriptPath - El propósito de getScriptPath - - - - &reftitle.description; - - abstract public stringYaf_View_Interface::getScriptPath - - - - Obtiene el directorio en el que se buscan las plantillas. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -El directorio de plantillas como cadena, o &null; si aún no ha sido definido. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_View_Interface::getScriptPath</methodname> - -tpl_dir = $template_dir; - } - - public function assign($name, $value = null) - { - $this->vars[$name] = $value; - return true; - } - - public function display($tpl, $tpl_vars = null) - { - echo $this->render($tpl, $tpl_vars); - return true; - } - - public function render($tpl, $tpl_vars = null) - { - extract($this->vars); - if ($tpl_vars !== null) { - extract($tpl_vars); - } - ob_start(); - include $this->tpl_dir . "/" . $tpl; - return ob_get_clean(); - } - - public function setScriptPath($template_dir) - { - $this->tpl_dir = $template_dir; - return $this; - } - - public function getScriptPath() - { - return $this->tpl_dir; - } -} - -/* se conecta el motor de vistas personalizado al despachador en el bootstrap */ -class Bootstrap extends Yaf_Bootstrap_Abstract -{ - public function _initView(Yaf_Dispatcher $dispatcher) - { - $dispatcher->setView(new MyView(APPLICATION_PATH . "/views")); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_View_Interface::setScriptPath - Yaf_View_Interface::render - Yaf_View_Interface::display - - - - - - diff --git a/reference/yaf/yaf_view_interface/render.xml b/reference/yaf/yaf_view_interface/render.xml deleted file mode 100644 index 7aef0f56fb..0000000000 --- a/reference/yaf/yaf_view_interface/render.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - Yaf_View_Interface::render - Renderiza una plantilla - - - - &reftitle.description; - - abstract public stringYaf_View_Interface::render - stringtpl - arraytpl_varsNULL - - - Renderiza una plantilla y devuelve el resultado. - - - - - - &reftitle.parameters; - - - tpl - - - La ruta de la plantilla, relativa al directorio de plantillas. - - - - - tpl_vars - - - Variables opcionales a asignar solo para esta plantilla; tienen - prioridad sobre las variables asignadas con el mismo nombre. - - - - - - - - &reftitle.returnvalues; -El resultado renderizado como cadena, o &false; en caso de error. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_View_Interface::render</methodname> - -tpl_dir = $template_dir; - } - - public function assign($name, $value = null) - { - $this->vars[$name] = $value; - return true; - } - - public function display($tpl, $tpl_vars = null) - { - echo $this->render($tpl, $tpl_vars); - return true; - } - - public function render($tpl, $tpl_vars = null) - { - extract($this->vars); - if ($tpl_vars !== null) { - extract($tpl_vars); - } - ob_start(); - include $this->tpl_dir . "/" . $tpl; - return ob_get_clean(); - } - - public function setScriptPath($template_dir) - { - $this->tpl_dir = $template_dir; - return $this; - } - - public function getScriptPath() - { - return $this->tpl_dir; - } -} - -/* se conecta el motor de vistas personalizado al despachador en el bootstrap */ -class Bootstrap extends Yaf_Bootstrap_Abstract -{ - public function _initView(Yaf_Dispatcher $dispatcher) - { - $dispatcher->setView(new MyView(APPLICATION_PATH . "/views")); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_View_Interface::display - Yaf_View_Interface::assign - Yaf_View_Interface::setScriptPath - Yaf_View_Interface::getScriptPath - - - - - - diff --git a/reference/yaf/yaf_view_interface/setscriptpath.xml b/reference/yaf/yaf_view_interface/setscriptpath.xml deleted file mode 100644 index 9a8be4d4d4..0000000000 --- a/reference/yaf/yaf_view_interface/setscriptpath.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - Yaf_View_Interface::setScriptPath - El propósito de setScriptPath - - - - &reftitle.description; - - abstract public Yaf_View_InterfaceYaf_View_Interface::setScriptPath - stringtemplate_dir - - - Establece el directorio base de plantillas. Normalmente es llamado por - Yaf_Dispatcher - - - - - - &reftitle.parameters; - - - template_dir - - - El directorio donde se guardan los scripts de plantilla. - - - - - - - - &reftitle.returnvalues; -Devuelve la instancia de la vista, o &false; si template_dir no es una ruta absoluta. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_View_Interface::setScriptPath</methodname> - -tpl_dir = $template_dir; - } - - public function assign($name, $value = null) - { - $this->vars[$name] = $value; - return true; - } - - public function display($tpl, $tpl_vars = null) - { - echo $this->render($tpl, $tpl_vars); - return true; - } - - public function render($tpl, $tpl_vars = null) - { - extract($this->vars); - if ($tpl_vars !== null) { - extract($tpl_vars); - } - ob_start(); - include $this->tpl_dir . "/" . $tpl; - return ob_get_clean(); - } - - public function setScriptPath($template_dir) - { - $this->tpl_dir = $template_dir; - return $this; - } - - public function getScriptPath() - { - return $this->tpl_dir; - } -} - -/* se conecta el motor de vistas personalizado al despachador en el bootstrap */ -class Bootstrap extends Yaf_Bootstrap_Abstract -{ - public function _initView(Yaf_Dispatcher $dispatcher) - { - $dispatcher->setView(new MyView(APPLICATION_PATH . "/views")); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_View_Interface::getScriptPath - Yaf_View_Interface::render - Yaf_View_Interface::display - - - - - - diff --git a/reference/yaf/yaf_view_simple/assign.xml b/reference/yaf/yaf_view_simple/assign.xml deleted file mode 100644 index e5a06179bc..0000000000 --- a/reference/yaf/yaf_view_simple/assign.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - Yaf_View_Simple::assign - Asignar valores - - - - &reftitle.description; - - public boolYaf_View_Simple::assign - mixedname - mixedvalueNULL - - - Asigna una variable a la vista. Las variables asignadas están disponibles - en la plantilla bajo sus nombres. - Cuando se llama con un único argumento de tipo array, se asigna cada par - clave/valor, y las claves pasan a ser los nombres de las variables. - - - - - &reftitle.parameters; - - - name - - - El nombre con el que la variable queda disponible en la plantilla, o un - array de variables a asignar. - - - - - value - - El valor a asignar. - - - - - - - &reftitle.returnvalues; -Devuelve &true;. - - - - &reftitle.examples; - - Ejemplo de <function>Yaf_View_Simple::assign</function> - -getView()->assign("foo", "bar"); - $this->_view->assign(array("key" => "value", "name" => "value")); - } -} -?> -]]> - - - - Ejemplo de template - - - - <?php echo $foo; ?> - - - _tpl_vars as $name => $value) { - echo $$name; // o echo $this->_tpl_vars[$name]; - } - ?> - - -]]> - - - - - - &reftitle.seealso; - - Yaf_View_Simple::assignRef - Yaf_View_Simple::clear - Yaf_View_Simple::get - - - - - - diff --git a/reference/yaf/yaf_view_simple/assignref.xml b/reference/yaf/yaf_view_simple/assignref.xml deleted file mode 100644 index 1c66271cf6..0000000000 --- a/reference/yaf/yaf_view_simple/assignref.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - Yaf_View_Simple::assignRef - El propósito de assignRef - - - - &reftitle.description; - - public boolYaf_View_Simple::assignRef - stringname - mixedvalue - - - A diferencia de Yaf_View_Simple::assign, este método - asigna un valor de referencia al motor. - - - - - &reftitle.parameters; - - - name - - - Un nombre como cadena que será usado para acceder al valor de la plantilla. - - - - - value - - - Valor mixto - - - - - - - - &reftitle.returnvalues; -Devuelve &true;. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_View_Simple::assignRef</methodname> - -getView()->assignRef("foo", $value); - - /* los cambios posteriores de $value son visibles en la plantilla, - * porque la variable se ha asignado por referencia */ - $value = "changed"; - - //evita el auto-renderizado - Yaf_Dispatcher::getInstance()->autoRender(false); - } -} -?> -]]> - - - - Ejemplo de plantilla - - - - <?php echo $foo; ?> - - - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_View_Simple::assign - Yaf_View_Simple::clear - Yaf_View_Simple::get - - - - - - diff --git a/reference/yaf/yaf_view_simple/clear.xml b/reference/yaf/yaf_view_simple/clear.xml deleted file mode 100644 index 2ae81a9a09..0000000000 --- a/reference/yaf/yaf_view_simple/clear.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - Yaf_View_Simple::clear - Limpiar valores asignados - - - - &reftitle.description; - - public boolYaf_View_Simple::clear - stringnameNULL - - - Elimina de la vista una variable asignada. - Cuando se llama sin argumento, se eliminan todas las variables asignadas. - - - - - &reftitle.parameters; - - - name - - - El nombre de la variable a eliminar; si se omite o es &null;, se eliminan - todas las variables asignadas. - - - - - - - - &reftitle.returnvalues; -Devuelve &true;. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_View_Simple::clear</methodname> - -getView()->clear("foo")->clear("bar"); // limpia "foo" y "bar" - $this->_view->clear(); // limpia todas las variables asignadas - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_View_Simple::assign - Yaf_View_Simple::get - - - - - - diff --git a/reference/yaf/yaf_view_simple/construct.xml b/reference/yaf/yaf_view_simple/construct.xml deleted file mode 100644 index 65f54b79cd..0000000000 --- a/reference/yaf/yaf_view_simple/construct.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - Yaf_View_Simple::__construct - El constructor de Yaf_View_Simple - - - - &reftitle.description; - - publicYaf_View_Simple::__construct - stringtemplate_dir - arrayoptionsNULL - - - Yaf_View_Simple es el motor de vistas por omisión y - el único que Yaf admite de serie. El Yaf_Dispatcher - crea una instancia automáticamente al arrancar la aplicación; instanciarlo - directamente solo hace falta para renderizar plantillas fuera del flujo de - despacho. - - - El argumento template_dir debe apuntar a un - directorio existente que contenga los scripts de vista; pasa a ser la ruta - de scripts de la vista y puede cambiarse después con - Yaf_View_Simple::setScriptPath. - - - - - &reftitle.parameters; - - - template_dir - - - El directorio donde se guardan los scripts de plantilla. - - - - - options - - - Opciones opcionales de la vista como array. Reservado para - implementaciones personalizadas de motores de vistas; el motor incorporado - lo acepta pero no lo utiliza. - - - - - - - - &reftitle.returnvalues; - No se devuelve ningún valor. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_View_Simple::__construct</methodname> - -assign("name", "world"); -echo $view->render("greeting.phtml"); -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_View_Simple::render - Yaf_View_Simple::display - Yaf_View_Simple::setScriptPath - - - - - - diff --git a/reference/yaf/yaf_view_simple/display.xml b/reference/yaf/yaf_view_simple/display.xml deleted file mode 100644 index 831652dbc0..0000000000 --- a/reference/yaf/yaf_view_simple/display.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - Yaf_View_Simple::display - Renderiza y muestra una plantilla - - - - &reftitle.description; - - public boolYaf_View_Simple::display - stringtpl - arrayvarsNULL - - - Renderiza una plantilla y añade el resultado al cuerpo de - Yaf_Response_Abstract. - - - - A diferencia de Yaf_View_Simple::render, el - resultado no se devuelve sino que se almacena en la respuesta, y - Yaf_Application lo envía cuando se emite la - respuesta. - - - - - - &reftitle.parameters; - - - tpl - - - La ruta de la plantilla, relativa al directorio de plantillas - establecido por Yaf_View_Simple::setScriptPath - o por application.view.directory. - - - - - tpl_vars - - - Variables opcionales a asignar solo para esta plantilla; tienen - prioridad sobre las variables asignadas con el mismo nombre. - - - - - - - - &reftitle.returnvalues; -Devuelve &true; en caso de éxito, o &false; en caso de error. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_View_Simple::display</methodname> - -getView()->assign("title", "My Homepage"); - - /* renderiza index/index.phtml y almacena el resultado - * en el cuerpo de la respuesta */ - $this->getView()->display("index/index.phtml"); - - return false; // we rendered ourselves, skip auto-rendering - } -} -?> -]]> - - - - Ejemplo de Template - - - - <?php echo $title; ?> - - -]]> - - - - - - &reftitle.seealso; - - Yaf_View_Simple::render - Yaf_View_Simple::assign - - - - - - diff --git a/reference/yaf/yaf_view_simple/eval.xml b/reference/yaf/yaf_view_simple/eval.xml deleted file mode 100644 index 6b3b76bbe2..0000000000 --- a/reference/yaf/yaf_view_simple/eval.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - Yaf_View_Simple::eval - Renderiza una plantilla - - - - &reftitle.description; - - public stringYaf_View_Simple::eval - stringtpl_content - arrayvarsNULL - - - Renderiza una plantilla dada como cadena y devuelve el resultado. - - - - Al no intervenir ningún fichero de plantilla, no se consulta el directorio - de plantillas. - - - - - - &reftitle.parameters; - - - tpl_content - - - La plantilla de tipo string - - - - - tpl_vars - - - Variables opcionales a asignar para este renderizado; tienen prioridad - sobre las variables asignadas con el mismo nombre. - - - - - - - - &reftitle.returnvalues; -El resultado renderizado como cadena, o &false; en caso de error. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_View_Simple::eval</methodname> - -"; - - /* renderiza la cadena de plantilla sin tocar el sistema de ficheros */ - $html = $this->getView()->eval($template, array("title" => "Breaking News")); - - $this->getResponse()->setBody($html); - return false; // skip auto-rendering - } -} -?> -]]> - - &example.outputs.similar; - -Breaking News]]> - - - - - - &reftitle.seealso; - - Yaf_View_Simple::render - Yaf_View_Simple::display - - - - - - diff --git a/reference/yaf/yaf_view_simple/get.xml b/reference/yaf/yaf_view_simple/get.xml deleted file mode 100644 index 95d2a0682f..0000000000 --- a/reference/yaf/yaf_view_simple/get.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - Yaf_View_Simple::__get - Recupera una variable asignada - - - - &reftitle.description; - - public mixedYaf_View_Simple::get - stringnameNULL - - - Obtiene una variable asignada previamente a la vista. - Cuando se llama sin argumento, se devuelven todas las variables asignadas. - - - - - &reftitle.parameters; - - - name - - - El nombre de la variable a recuperar; si se omite o es &null;, se - recuperan todas las variables asignadas. - - - - - - - - &reftitle.returnvalues; - - El valor asignado bajo name, o &null; si no existe - ninguna variable con ese nombre. Cuando se llama sin argumento, se devuelve - un array con todas las variables asignadas. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_View_Simple::get</methodname> - -getView(); - $view->assign("foo", "bar"); - - var_dump($view->get("foo")); - var_dump($view->get()); // todas las variables asignadas - } -} -?> -]]> - - &example.outputs.similar; - - - string(3) "bar" -}]]> - - - - - - &reftitle.seealso; - - Yaf_View_Simple::assign - Yaf_View_Simple::clear - - - - - - diff --git a/reference/yaf/yaf_view_simple/getscriptpath.xml b/reference/yaf/yaf_view_simple/getscriptpath.xml deleted file mode 100644 index 361d10f0f1..0000000000 --- a/reference/yaf/yaf_view_simple/getscriptpath.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - Yaf_View_Simple::getScriptPath - Obtiene el directorio de plantillas - - - - &reftitle.description; - - public stringYaf_View_Simple::getScriptPath - - - - Obtiene el directorio en el que se buscan las plantillas. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; -El directorio de plantillas como cadena, o &null; si aún no ha sido definido. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_View_Simple::getScriptPath</methodname> - -getView()->getScriptPath(); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_View_Simple::setScriptPath - - - - - - diff --git a/reference/yaf/yaf_view_simple/isset.xml b/reference/yaf/yaf_view_simple/isset.xml deleted file mode 100644 index f2867e1f5c..0000000000 --- a/reference/yaf/yaf_view_simple/isset.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - Yaf_View_Simple::__isset - El propósito de __isset - - - - &reftitle.description; - - public boolYaf_View_Simple::__isset - stringname - - - Comprueba si una variable está asignada a la vista. Este método se llama - cuando se usa isset sobre un objeto de vista. - - - - - &reftitle.parameters; - - - name - - - El nombre de la variable a comprobar. - - - - - - - - &reftitle.returnvalues; -Devuelve &true; si a variable is assigned under name, &false; en caso contrario. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_View_Simple::__isset</methodname> - -getView(); - $view->assign("title", "Welcome"); - - var_dump(isset($view->title)); - var_dump(isset($view->unknown)); - } -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yaf_View_Simple::assign - Yaf_View_Simple::get - Yaf_View_Simple::clear - - - - - - diff --git a/reference/yaf/yaf_view_simple/render.xml b/reference/yaf/yaf_view_simple/render.xml deleted file mode 100644 index 4355563ab5..0000000000 --- a/reference/yaf/yaf_view_simple/render.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - Yaf_View_Simple::render - Renderiza una plantilla - - - - &reftitle.description; - - public stringYaf_View_Simple::render - stringtpl - arrayvarsNULL - - - Renderiza una plantilla y devuelve el resultado como cadena. La plantilla - se incluye como un script PHP normal, por lo que se ejecuta cualquier código - PHP que contenga, y las variables asignadas están disponibles bajo sus - nombres. - - - - A diferencia de Yaf_View_Simple::display, el - resultado se devuelve en lugar de añadirse al cuerpo de - Yaf_Response_Abstract. - - - - - - &reftitle.parameters; - - - tpl - - - La ruta de la plantilla, relativa al directorio de plantillas - establecido por Yaf_View_Simple::setScriptPath - o por application.view.directory. - - - - - tpl_vars - - - Variables opcionales a asignar para este renderizado; tienen prioridad - sobre las variables asignadas con el mismo nombre. - - - - - - - - &reftitle.returnvalues; -El resultado renderizado como cadena, o &false; en caso de error. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_View_Simple::render</methodname> - -getView()->render("product/detail.phtml", array( - "name" => "Yaf in Action", - "price" => "29.90", - )); - - $this->getResponse()->setBody($html); - return false; // skip auto-rendering - } -} -?> -]]> - - - - Ejemplo de Template - - -

    Price: EUR

    -]]> -
    - &example.outputs.similar; - -Yaf in Action -

    Price: 29.90 EUR

    ]]> -
    -
    -
    - - - &reftitle.seealso; - - Yaf_View_Simple::display - Yaf_View_Simple::eval - Yaf_View_Simple::assign - - - -
    - - diff --git a/reference/yaf/yaf_view_simple/set.xml b/reference/yaf/yaf_view_simple/set.xml deleted file mode 100644 index 955ec2aa51..0000000000 --- a/reference/yaf/yaf_view_simple/set.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - Yaf_View_Simple::__set - Establece el valor para el motor - - - - &reftitle.description; - - public voidYaf_View_Simple::__set - stringname - mixedvalue - - - Esta es una manera alternativa y más sencilla de usar - Yaf_View_Simple::assign. - - - - - &reftitle.parameters; - - - name - - - Un nombre de valor de tipo string. - - - - - value - - - Valor mixto. - - - - - - - - &reftitle.returnvalues; -No se devuelve ningún valor. - - - - - &reftitle.examples; - - Ejemplo de <function>Yaf_View_Simple::__set</function> - -getView()->foo = "bar"; // es lo mismo que assign("foo", "bar"); - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_View_Simple::assignRef - Yaf_View_Interface::assign - - - - - - diff --git a/reference/yaf/yaf_view_simple/setscriptpath.xml b/reference/yaf/yaf_view_simple/setscriptpath.xml deleted file mode 100644 index 8dde4fa76c..0000000000 --- a/reference/yaf/yaf_view_simple/setscriptpath.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - Yaf_View_Simple::setScriptPath - Establece el directorio de plantillas - - - - &reftitle.description; - - public Yaf_View_SimpleYaf_View_Simple::setScriptPath - stringtemplate_dir - - - Establece el directorio en el que se buscan las plantillas. - - - - - &reftitle.parameters; - - - template_dir - - - El directorio donde se guardan los scripts de plantilla. - - - - - - - - &reftitle.returnvalues; -Devuelve la instancia de la vista, o &false; si template_dir no es una ruta absoluta. - - - - &reftitle.examples; - - Ejemplo de <methodname>Yaf_View_Simple::setScriptPath</methodname> - -getView()->setScriptPath(APPLICATION_PATH . "/modules/admin/views"); - - $this->getView()->display("dashboard/index.phtml"); - - return false; // we rendered ourselves, skip auto-rendering - } -} -?> -]]> - - - - - - &reftitle.seealso; - - Yaf_View_Simple::getScriptPath - - - - - - diff --git a/reference/yaml/book.xml b/reference/yaml/book.xml deleted file mode 100644 index 10a5d5e04f..0000000000 --- a/reference/yaml/book.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - - Serialización de datos YAML - Yaml - - - - &reftitle.intro; - - Esta extensión implementa el estándar de serialización de datos - YAML Ain't Markup Language (YAML). El análisis y - la creación son manejados por la biblioteca - LibYAML. - - - - - &reference.yaml.setup; - &reference.yaml.constants; - &reference.yaml.examples; - &reference.yaml.callbacks; - &reference.yaml.reference; - - - - - diff --git a/reference/yaml/callbacks.xml b/reference/yaml/callbacks.xml deleted file mode 100644 index 1b42387f44..0000000000 --- a/reference/yaml/callbacks.xml +++ /dev/null @@ -1,163 +0,0 @@ - - - - - - Callbacks - -
    - Análisis de callbacks - - Los análisis de callables son invocados por las funciones - yaml_parse, yaml_parse_file o - yaml_parse_url cuando encuentran una etiqueta YAML - registrada. Al callback se le pasa el valor de la entidad de la etiqueta, la etiqueta, - y los flags que indican el estilo escalar de la entidad. El callback debe - devolver los datos que el convertidor YAML debe emitir para esta entidad. - - - Ejemplo de análisis de callback - - 'tag_callback', - )); - -var_dump($resultado); -?> -]]> - - &example.outputs.similar; - - - string(5) "Mundo" - [1]=> - string(14) "!ejemplo/hola" - [2]=> - int(1) -} -array(1) { - ["saludo"]=> - string(11) "Hola Mundo" -} -]]> - - -
    - -
    - Emitir callbacks - - Las emisiones de callbacks son invocadas cuando una instancia de una clase registrada es - emitida por la función yaml_emit o la función - yaml_emit_file. El callback se pasa al objeto a - ser emitido. El callback debe devolver un array que contenga dos claves: - "tag" y "data". - El valor asociado con la clave "tag" debe - ser un string a ser usado como la etiqueta YAML en la salida. El valor asociado - con la clave "data" será encodeado como YAML - y será emitido en lugar del objeto interceptado. - - - Ejemplo de emisión de callback - -data = $d; - } - - /** - * Yaml emite la función de callback, referida a la llamada yaml_emit por el nombre de la clase. - * - * Se espera que devuelva un array con 2 valores: - * - 'tag': etiqueta personalizada para esta serialización - * - 'data': valor que se convierte a yaml (ya sea array, string, bool, número) - * - * @param object $obj Objeto a ser emitido - * @return array Etiqueta y datos sustitutivos a emitir - */ - public static function yamlEmit (EmitExample $obj) { - return array( - 'tag' => '!example/emit', - 'data' => $obj->data, - ); - } -} - -$emit_callbacks = array( - 'EmitExample' => array('EmitExample', 'yamlEmit') -); - -$t = new EmitExample(array('a','b','c')); -$yaml = yaml_emit( - array( - 'example' => $t, - ), - YAML_ANY_ENCODING, - YAML_ANY_BREAK, - $emit_callbacks -); -var_dump($yaml); -?> -]]> - - &example.outputs.similar; - - - - -
    - -
    - - diff --git a/reference/yaml/constants.xml b/reference/yaml/constants.xml deleted file mode 100644 index 6a2c39da38..0000000000 --- a/reference/yaml/constants.xml +++ /dev/null @@ -1,298 +0,0 @@ - - - - - - &reftitle.constants; - &extension.constants; - - - - - Estilos de entidad escalar utilizables por los métodos - de retrollamada de <function>yaml_parse</function> - - - YAML_ANY_SCALAR_STYLE - (int) - - - - - - - - - YAML_PLAIN_SCALAR_STYLE - (int) - - - - - - - - - YAML_SINGLE_QUOTED_SCALAR_STYLE - (int) - - - - - - - - - YAML_DOUBLE_QUOTED_SCALAR_STYLE - (int) - - - - - - - - - YAML_LITERAL_SCALAR_STYLE - (int) - - - - - - - - - YAML_FOLDED_SCALAR_STYLE - (int) - - - - - - - - - - Etiquetas comunes utilizables por los métodos - de retrollamada de <function>yaml_parse</function>. - - - YAML_NULL_TAG - (string) - - - - "tag:yaml.org,2002:null" - - - - - - YAML_BOOL_TAG - (string) - - - - "tag:yaml.org,2002:bool" - - - - - - YAML_STR_TAG - (string) - - - - "tag:yaml.org,2002:str" - - - - - - YAML_INT_TAG - (string) - - - - "tag:yaml.org,2002:int" - - - - - - YAML_FLOAT_TAG - (string) - - - - "tag:yaml.org,2002:float" - - - - - - YAML_TIMESTAMP_TAG - (string) - - - - "tag:yaml.org,2002:timestamp" - - - - - - YAML_SEQ_TAG - (string) - - - - "tag:yaml.org,2002:seq" - - - - - - YAML_MAP_TAG - (string) - - - - "tag:yaml.org,2002:map" - - - - - - YAML_PHP_TAG - (string) - - - - "!php/object" - - - - - - - Tipos de codificación para <function>yaml_emit</function> - - - YAML_ANY_ENCODING - (int) - - - - Dejar que el emisor elija una codificación. - - - - - - YAML_UTF8_ENCODING - (int) - - - - Codificar como UTF8. - - - - - - YAML_UTF16LE_ENCODING - (int) - - - - Codificar como UTF16LE. - - - - - - YAML_UTF16BE_ENCODING - (int) - - - - Codificar como UTF16BE. - - - - - - - Tipos de saltos de línea para <function>yaml_emit</function> - - - YAML_ANY_BREAK - (int) - - - - Dejar que el emisor elija el carácter de salto de línea. - - - - - - YAML_CR_BREAK - (int) - - - - Usar \r como carácter de salto (al estilo de Mac). - - - - - - YAML_LN_BREAK - (int) - - - - Usar \n como carácter de salto (al estilo de Unix). - - - - - - YAML_CRLN_BREAK - (int) - - - - Usar \r\n como cáracter de salto (al estilo de DOS). - - - - - - - - - diff --git a/reference/yaml/examples.xml b/reference/yaml/examples.xml deleted file mode 100644 index a15d9a8543..0000000000 --- a/reference/yaml/examples.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - &reftitle.examples; - - Ejemplo de Yaml - - "Chris", - "family"=> "Dumars", - "address"=> array( - "lines"=> "458 Walkman Dr. - Suite #292", - "city"=> "Royal Oak", - "state"=> "MI", - "postal"=> 48046, - ), - ); -$invoice = array ( - "invoice"=> 34843, - "date"=> "2001-01-23", - "bill-to"=> $addr, - "ship-to"=> $addr, - "product"=> array( - array( - "sku"=> "BL394D", - "quantity"=> 4, - "description"=> "Basketball", - "price"=> 450, - ), - array( - "sku"=> "BL4438H", - "quantity"=> 1, - "description"=> "Super Hoop", - "price"=> 2392, - ), - ), - "tax"=> 251.42, - "total"=> 4443.52, - "comments"=> "Late afternoon is best. Backup contact is Nancy Billsmer @ 338-4338.", - ); - -// genera un representación de la factura en YAML -$yaml = yaml_emit($invoice); -var_dump($yaml); - -// convierte lo anterior en YAML a una variable PHP -$parsed = yaml_parse($yaml); - -// verifica que la comprobación de ida y vuelta a una extructura equivalente -var_dump($parsed == $invoice); -?> -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/yaml/functions/yaml-emit-file.xml b/reference/yaml/functions/yaml-emit-file.xml deleted file mode 100644 index 42c0ed54fc..0000000000 --- a/reference/yaml/functions/yaml-emit-file.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - - yaml_emit_file - Enviar la representación YAML de un valor a un fichero - - - - &reftitle.description; - - boolyaml_emit_file - stringfilename - mixeddata - intencodingYAML_ANY_ENCODING - intlinebreakYAML_ANY_BREAK - arraycallbacks&null; - - - Genera una representación YAML de data proporcionada - en el filename. - - - - - &reftitle.parameters; - - - - filename - - - Ruta a el fichero. - - - - - data - - - La data se codifica. Puede ser de cualquier tipo excepto - un resource. - - - - - encoding - - - Salida de codificación de caracteres seleccionando entre - YAML_ANY_ENCODING, - YAML_UTF8_ENCODING, - YAML_UTF16LE_ENCODING, - YAML_UTF16BE_ENCODING. - - - - - linebreak - - - Salida del estilo de salto de línea seleccionando entre - YAML_ANY_BREAK, - YAML_CR_BREAK, - YAML_LN_BREAK, - YAML_CRLN_BREAK. - - - - - callbacks - - - Manejadores de contenido para emitir nodos YAML. array - asociativo de nombre de clase de asignaciones => callable. Véase - emitir llamadas de retorno para más - detalles. - - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; en caso de éxito. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL yaml 1.1.0 - - El parámetro callbacks fue añadido. - - - - - - - - - - &reftitle.seealso; - - - yaml_emit - yaml_parse - - - - - - - diff --git a/reference/yaml/functions/yaml-emit.xml b/reference/yaml/functions/yaml-emit.xml deleted file mode 100644 index 9f5ec8e577..0000000000 --- a/reference/yaml/functions/yaml-emit.xml +++ /dev/null @@ -1,231 +0,0 @@ - - - - - - - yaml_emit - Devuelve la representación de un valor YAML - - - - &reftitle.description; - - stringyaml_emit - mixeddata - intencodingYAML_ANY_ENCODING - intlinebreakYAML_ANY_BREAK - arraycallbacks&null; - - - Genera una representación YAML de los datos en data proporcionados. - - - - - &reftitle.parameters; - - - - data - - - La data se codifica. Puede ser de cualquier tipo excepto - un resource. - - - - - encoding - - - Salida de codificación de caracteres elegidos desde - YAML_ANY_ENCODING, - YAML_UTF8_ENCODING, - YAML_UTF16LE_ENCODING, - YAML_UTF16BE_ENCODING. - - - - - linebreak - - - Estilo de salida de línea de salto desde: - YAML_ANY_BREAK, - YAML_CR_BREAK, - YAML_LN_BREAK, - YAML_CRLN_BREAK. - - - - - callbacks - - - Gestores de contenido para emitir nodos YAML. array asociativo - de referenciaciones de nombres de clase => callable. Véase - emitir llamadas de retorno para más - detalles. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un string de YAML codificado si es correcto. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - PECL yaml 1.1.0 - - Se añadió el parámetro callbacks. - - - - - - - - - - &reftitle.examples; - - - Ejemplo de <function>yaml_emit</function> - - "Chris", - "family"=> "Dumars", - "address"=> array( - "lines"=> "458 Walkman Dr. - Suite #292", - "city"=> "Royal Oak", - "state"=> "MI", - "postal"=> 48046, - ), - ); -$invoice = array ( - "invoice"=> 34843, - "date"=> 980208000, - "bill-to"=> $addr, - "ship-to"=> $addr, - "product"=> array( - array( - "sku"=> "BL394D", - "quantity"=> 4, - "description"=> "Basketball", - "price"=> 450, - ), - array( - "sku"=> "BL4438H", - "quantity"=> 1, - "description"=> "Super Hoop", - "price"=> 2392, - ), - ), - "tax"=> 251.42, - "total"=> 4443.52, - "comments"=> "Late afternoon is best. Backup contact is Nancy Billsmer @ 338-4338.", - ); -var_dump(yaml_emit($invoice)); -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - yaml_emit_file - yaml_parse - - - - - - - diff --git a/reference/yaml/functions/yaml-parse-file.xml b/reference/yaml/functions/yaml-parse-file.xml deleted file mode 100644 index 42b376ce28..0000000000 --- a/reference/yaml/functions/yaml-parse-file.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - - yaml_parse_file - Analiza una secuencia de texto en formato YAML desde un fichero - - - - &reftitle.description; - - mixedyaml_parse_file - stringfilename - intpos0 - intndocs - arraycallbacks&null; - - - Convierte toda o parte de una secuencia de texto en YAML a una variable en PHP. - - - - - &reftitle.parameters; - - - - filename - - - Ruta del nombre del fichero. - - - - - pos - - - Documento YAML a extraer desde la secuencia de texto (-1 para analizar todos - los documentos, 0 solo para el primer documento, etc). - - - - - ndocs - - - Si se facilita ndocs, se completará con el - número de documentos encontrados en la secuencia de texto. - - - - - callbacks - - - Controlador de contenido para los nodos YAML. Es un array asociativo de - etiquetas YAML => asociando sus callable correspondientes. Ver - Analizar callbacks para más - información. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor codificado de filename en el tipo - apropiado de PHP. - - - En caso de error, se devuelve una cadena que contiene un mensaje de error. - - - Si pos es -1, se devolverá un - array con una entrada por cada documento encontrado en el flujo. - - - - - &reftitle.notes; - - - El procesamiento de las entradas de los usuarios no confiables con yaml_parse_file - es peligroso si el uso de unserialize está habilitado para - los nodos usando la etiqueta !php/object. Este comportamiento puede ser - desactivado por el uso de el ajuste ini yaml.decode_php. - - - - - - &reftitle.seealso; - - - yaml_parse - yaml_parse_url - yaml_emit - - - - - - - diff --git a/reference/yaml/functions/yaml-parse-url.xml b/reference/yaml/functions/yaml-parse-url.xml deleted file mode 100644 index 0343c51a48..0000000000 --- a/reference/yaml/functions/yaml-parse-url.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - - - yaml_parse_url - Analiza una secuencia de texto Yaml desde una URL - - - - &reftitle.description; - - mixedyaml_parse_url - stringurl - intpos0 - intndocs - arraycallbacks&null; - - - Convierte toda o parte de una secuencia de texto en YAML a una variable en PHP. - - - - - &reftitle.parameters; - - - - url - - - La dirección url debe tener el formato "scheme://...". PHP - buscará el controlador de protocolos (también conocido como wrapper) para el - esquema especificado. Si no hay wrappers registrados para este protocolo, PHP lanzará - un aviso para ayudar a indentificar posibles problemas con el script y - continuar como si el nombre del fichero hiciera referencia a un fichero normal. - - - - - pos - - - Documento YAML a extraer desde la secuencia de texto (-1 para analizar todos - los documentos, 0 solo para el primer documento, etc). - - - - - ndocs - - - Si se facilita ndocs, se completará con el - número de documentos encontrados en la secuencia de texto. - - - - - callbacks - - - Controlador de contenido para los nodos YAML. Es un array asociativo de - etiquetas YAML => asociando sus callable correspondientes. Ver - Analizar callbacks para más información - - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor codificado de url en el formato - apropiado de PHP&return.falseforfailure;. Si el valor de pos es -1 devolverá un - array con una entrada por cada documento encontrado en el texto. - - - - - &reftitle.notes; - - - El procesamiento de entradas de usuario no confiables con yaml_parse_url - es peligroso si el uso de unserialize está habilitado para - nodos que utilizan la etiqueta !php/object. Este comportamiento puede ser - deshabilitado utilizando la configuración ini yaml.decode_php. - - - - - - &reftitle.seealso; - - - yaml_parse - yaml_parse_file - yaml_emit - - - - - - - diff --git a/reference/yaml/functions/yaml-parse.xml b/reference/yaml/functions/yaml-parse.xml deleted file mode 100644 index 8a334f5862..0000000000 --- a/reference/yaml/functions/yaml-parse.xml +++ /dev/null @@ -1,249 +0,0 @@ - - - - - - - yaml_parse - Analiza una secuencia de texto en formato YAML - - - - &reftitle.description; - - mixedyaml_parse - stringinput - intpos0 - intndocs - arraycallbacks&null; - - - Convierte toda o parte de una secuencia de texto en YAML a una variable en PHP. - - - - - &reftitle.parameters; - - - - input - - - La secuencia de texto (string) a analizar en formato YAML. - - - - - pos - - - Documento YAML a extraer desde la secuencia de texto (-1 para analizar todos - los documentos, 0 solo para el primer documento, etc). - - - - - ndocs - - - Si se facilita ndocs, se completará con el - número de documentos encontrados en la secuencia de texto. - - - - - callbacks - - - Controlador de contenido para los nodos YAML. Es un array asociativo de - etiquetas YAML => asociando sus callable correspondientes. Ver - Analizar callbacks para más - información. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor codificado de input en el formato - apropiado de PHP&return.falseforfailure;. Si el valor de pos es -1 devolverá un - array con una entrada por cada documento encontrado en el texto. - - - - &reftitle.examples; - - - Ejemplo de <function>yaml_parse</function> - - -]]> - - &example.outputs.similar; - - - int(34843) - ["date"]=> - string(10) "2001-01-23" - ["bill-to"]=> - &array(3) { - ["given"]=> - string(5) "Chris" - ["family"]=> - string(6) "Dumars" - ["address"]=> - array(4) { - ["lines"]=> - string(34) "458 Walkman Dr. - Suite #292" - ["city"]=> - string(9) "Royal Oak" - ["state"]=> - string(2) "MI" - ["postal"]=> - int(48046) - } - } - ["ship-to"]=> - &array(3) { - ["given"]=> - string(5) "Chris" - ["family"]=> - string(6) "Dumars" - ["address"]=> - array(4) { - ["lines"]=> - string(34) "458 Walkman Dr. - Suite #292" - ["city"]=> - string(9) "Royal Oak" - ["state"]=> - string(2) "MI" - ["postal"]=> - int(48046) - } - } - ["product"]=> - array(2) { - [0]=> - array(4) { - ["sku"]=> - string(6) "BL394D" - ["quantity"]=> - int(4) - ["description"]=> - string(10) "Basketball" - ["price"]=> - int(450) - } - [1]=> - array(4) { - ["sku"]=> - string(7) "BL4438H" - ["quantity"]=> - int(1) - ["description"]=> - string(10) "Super Hoop" - ["price"]=> - int(2392) - } - } - ["tax"]=> - float(251.42) - ["total"]=> - float(4443.52) - ["comments"]=> - string(68) "Late afternoon is best. Backup contact is Nancy Billsmer @ 338-4338." -} -]]> - - - - - - - &reftitle.notes; - - - El procesamiento de las entradas de los usuarios no confiables con yaml_parse - es peligroso si el uso de unserialize está habilitado para - los nodos usando la etiqueta !php/object. Este comportamiento puede ser - desactivado por el uso de el ajuste ini yaml.decode_php. - - - - - - &reftitle.seealso; - - - yaml_parse_file - yaml_parse_url - yaml_emit - - - - - - - diff --git a/reference/yaml/ini.xml b/reference/yaml/ini.xml deleted file mode 100644 index d5042fa9ba..0000000000 --- a/reference/yaml/ini.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - -
    - &reftitle.runtime; - &extension.runtime; - - - &ConfigureOptions; de Yaml - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - yaml.decode_binary - 0 - INI_ALL - - - - yaml.decode_php - 0 - INI_ALL - Añadido en 1.2.0, antes de 2.0.0 el valor predeterminado era 1 - - - yaml.decode_timestamp - 0 - INI_ALL - - - - yaml.output_canonical - 0 - INI_ALL - - - - yaml.output_indent - 2 - INI_ALL - - - - yaml.output_width - 80 - INI_ALL - - - - -
    -
    - - &ini.descriptions.title; - - - - - - yaml.decode_binary - bool - - - - Off por omisión, pero puede estar activado el uso de entidades base64 codificadas binariamente que tenga explicitamente el tag "tag:yaml.org,2002:binary" para ser decodificado. - - - - - - yaml.decode_php - bool - - - - Desactivado por omisión, pero puede ser configurado como activado para que los objetos PHP serializados que tienen la etiqueta explícita "!php/object" sean deserializados. - - - - - - yaml.decode_timestamp - int - - - - Controla la decodificación de los escalares "tag:yaml.org,2002:timestamp" tanto implícitos como explícitos - en el flujo del documento YAML. La configuración predeterminada de 0 no aplicará ninguna - decodificación. Una configuración de 1 utilizará strtotime - para analizar el valor de la marca de tiempo como una marca de tiempo Unix. Una configuración - de 2 utilizará date_create para analizar el valor de la marca - de tiempo como un objeto DateTime. - - - - - - yaml.output_canonical - bool - - - - Off por omisión, pero puede estar activado de manera convencional desde su salida. - - - - - - yaml.output_indent - int - - - - Números de espacios para la identación. El valor debe comprender entre - 1 y 10. - - - - - - yaml.output_width - int - - - - Establece el ancho de línea de preferencia. -1 significa sin límite. - - - - - -
    diff --git a/reference/yaml/reference.xml b/reference/yaml/reference.xml deleted file mode 100644 index e705cb3b2a..0000000000 --- a/reference/yaml/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - &Functions; de Yaml - - &reference.yaml.entities.functions; - - - - - diff --git a/reference/yaml/setup.xml b/reference/yaml/setup.xml deleted file mode 100644 index b1139f5872..0000000000 --- a/reference/yaml/setup.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Esta extensión requiere la LibYAML C - library versión 0.1.0 o superior instalada. - -
    - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;yaml. - -
    - - - &reference.yaml.ini; - - -
    - - - diff --git a/reference/yar/book.xml b/reference/yar/book.xml deleted file mode 100644 index 4b429d7695..0000000000 --- a/reference/yar/book.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - Yet Another RPC Framework - Yar - - - &reftitle.intro; - - Yar (Yet another RPC framework) es un framework RPC ligero y concurrente - cuyo objetivo es proporcionar una manera simple y sencilla de establecer - la comunicación entre aplicaciones PHP. También puede emitir varias - llamadas a servicios remotos de forma concurrente. - - - Yar es una extensión nativa de PHP, no una biblioteca de espacio de - usuario. Utiliza un protocolo binario compacto sobre HTTP, HTTPS o TCP y - se distribuye con tres empaquetadores integrados (php, - json y, cuando se compila con - , - msgpack), por lo que no se requiere ningún paquete - adicional ni proceso proxy. - - - El protocolo es independiente del lenguaje, por lo que los servicios - pueden ser consumidos por cualquier lenguaje; véase - El protocolo Yar para más detalles. - - - - &reference.yar.protocol; - &reference.yar.setup; - &reference.yar.constants; - &reference.yar.examples; - &reference.yar.yar-server; - &reference.yar.yar-client; - &reference.yar.yar-concurrent-client; - &reference.yar.yar-server-exception; - &reference.yar.yar-server-output-exception; - &reference.yar.yar-server-packager-exception; - &reference.yar.yar-server-protocol-exception; - &reference.yar.yar-server-request-exception; - - &reference.yar.yar-client-exception; - &reference.yar.yar-client-packager-exception; - &reference.yar.yar-client-protocol-exception; - &reference.yar.yar-client-transport-exception; - - - - diff --git a/reference/yar/configure.xml b/reference/yar/configure.xml deleted file mode 100644 index 35087c3cfa..0000000000 --- a/reference/yar/configure.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;yar - - -
    - - - diff --git a/reference/yar/constants.xml b/reference/yar/constants.xml deleted file mode 100644 index 3d3c3fb24d..0000000000 --- a/reference/yar/constants.xml +++ /dev/null @@ -1,351 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - YAR_VERSION - (string) - - - - La versión de la extensión Yar, por ejemplo - "2.4.0". - - - - - - YAR_HAS_MSGPACK - (int) - - - - 1 cuando Yar se compiló con - , en caso contrario - 0. - - - - - - YAR_CLIENT_PROTOCOL_HTTP - (int) - - - - Identifica el protocolo HTTP, expuesto a través de la propiedad de solo - lectura _protocol de - Yar_Client. - - - - - - YAR_CLIENT_PROTOCOL_TCP - (int) - - - - Identifica el protocolo TCP, expuesto a través de la propiedad de solo - lectura _protocol de - Yar_Client. - - - - - - YAR_CLIENT_PROTOCOL_UNIX - (int) - - - - Identifica el protocolo de sockets Unix, expuesto a través de la propiedad - de solo lectura _protocol de - Yar_Client. - - - - - - YAR_OPT_PACKAGER - (int) - - - - Opción del cliente que reemplaza la directiva - yar.packager - para un único cliente. El valor debe ser uno de - php, json o - msgpack. - - - - - - YAR_OPT_PERSISTENT - (int) - - - - Opción del cliente que activa las conexiones persistentes. Cuando se - establece a un valor verdadero, se utiliza el keep-alive de HTTP, de modo - que las llamadas repetidas al mismo servidor reutilizan la conexión - durante el resto del ciclo de vida de la petición PHP. - - - - - - YAR_OPT_TIMEOUT - (int) - - - - Opción del cliente que reemplaza la directiva - yar.timeout, en - milisegundos. - - - - - - YAR_OPT_CONNECT_TIMEOUT - (int) - - - - Opción del cliente que reemplaza la directiva - yar.connect_timeout, - en milisegundos. - - - - - - YAR_OPT_HEADER - (int) - - - - Opción del cliente para añadir cabeceras HTTP personalizadas. El valor - debe ser un array de cadenas como - "X-Custom: valor". Solo es efectiva con los - protocolos HTTP y HTTPS. Disponible a partir de Yar 2.0.4. - - - - - - YAR_OPT_RESOLVE - (int) - - - - Opción del cliente que reemplaza la resolución de nombres de host para las - llamadas HTTP. El valor debe ser un array de cadenas con el formato - HOST:PORT:ADDRESS, siguiendo la sintaxis de - CURLOPT_RESOLVE de curl. Requiere libcurl - >= 7.21.3. Disponible a partir de Yar 2.1.0. - - - - - - YAR_OPT_PROXY - (int) - - - - Opción del cliente para encaminar las llamadas HTTP a través de un proxy - HTTP. El valor debe ser una cadena como 127.0.0.1:8888. - Disponible a partir de Yar 2.2.0. - - - - - - YAR_OPT_PROVIDER - (int) - - - - Opción del cliente que transporta la identidad del proveedor enviada con - cada petición. El valor debe ser una cadena de 32 bytes como máximo, que - se pasa al método mágico __auth del lado del servidor. - Disponible a partir de Yar 2.3.0. - - - - - - YAR_OPT_TOKEN - (int) - - - - Opción del cliente que transporta el token de autenticación enviado con - cada petición. El valor debe ser una cadena de 32 bytes como máximo, que - se pasa al método mágico __auth del lado del servidor. - Disponible a partir de Yar 2.3.0. - - - - - - YAR_PACKAGER_PHP - (string) - - - - El identificador del empaquetador php, - "PHP". - - - - - - YAR_PACKAGER_JSON - (string) - - - - El identificador del empaquetador json, - "JSON". - - - - - - YAR_PACKAGER_MSGPACK - (string) - - - - El identificador del empaquetador msgpack, - "MSGPACK". - - - - - - YAR_ERR_OKEY - (int) - - - - Ningún error; la petición se procesó correctamente. - - - - - - YAR_ERR_PACKAGER - (int) - - - - Un error del empaquetador, por ejemplo un cuerpo que no se ha podido - desempaquetar. - - - - - - YAR_ERR_PROTOCOL - (int) - - - - Un error de protocolo, por ejemplo una cabecera Yar mal formada. - - - - - - YAR_ERR_REQUEST - (int) - - - - Un error de petición, por ejemplo una llamada a un método no definido o no - público. - - - - - - YAR_ERR_OUTPUT - (int) - - - - Un error de salida, por ejemplo el servidor no ha podido iniciar su búfer - de salida. - - - - - - YAR_ERR_TRANSPORT - (int) - - - - Un error de transporte, por ejemplo un fallo de conexión o un tiempo de - espera agotado. - - - - - - YAR_ERR_EXCEPTION - (int) - - - - El servicio remoto lanzó una excepción durante el procesamiento de la - petición. - - - - - - YAR_ERR_FORBIDDEN - (int) - - - - La petición fue rechazada por la autenticación del servidor - (véanse los campos provider y - token de la - cabecera del protocolo Yar). - - - - - - - diff --git a/reference/yar/examples.xml b/reference/yar/examples.xml deleted file mode 100644 index 9a6bc2b8c6..0000000000 --- a/reference/yar/examples.xml +++ /dev/null @@ -1,230 +0,0 @@ - - - - - &reftitle.examples; - - Los ejemplos siguientes recorren un servicio completo: un servidor que - expone algunos métodos aritméticos, un cliente síncrono que los llama, - un cliente que lanza varias llamadas de forma concurrente y un cliente - que se comunica con un servidor por TCP. - - - - Ejemplo de servidor Yar - - Un servicio Yar no es más que una clase PHP normal envuelta por - Yar_Server. Cada método público del objeto se - convierte en un punto de acceso RPC; los métodos protegidos y privados, - así como los métodos cuyo nombre empieza por un guion bajo, permanecen - ocultos para los clientes. Los comentarios de documentación de los - métodos públicos se recopilan y se muestran en la página de información - del servicio. - - - Las peticiones RPC llegan como peticiones HTTP POST que transportan una - carga útil binaria del protocolo Yar, por lo que el script suele - asociarse a un URI de un servidor web normal. - - -_add($a, $b); - } - - /** - * Resta - */ - public function sub($a, $b) { - return $a - $b; - } - - /** - * Multiplicación - */ - public function mul($a, $b) { - return $a * $b; - } - - /** - * Los métodos protegidos no se exponen - * @param integer - * @return integer - */ - protected function _add($a, $b) { - return $a + $b; - } -} - -$server = new Yar_Server(new Operator()); -$server->handle(); -?> -]]> - - - - - Acceso al servidor desde el navegador (petición GET) - - Cuando se emite una petición GET al URI del servicio, por ejemplo al - abrirlo en un navegador, Yar no realiza una llamada RPC, sino que - muestra una página de información que lista todos los métodos públicos - del objeto ejecutor junto con su comentario de documentación. Esto se - controla con la directiva - yar.expose_info; cuando está - desactivada, la petición GET falla en su lugar. - - &example.outputs.similar; - - Yar Server Info - - - - - - - - Ejemplo de cliente Yar - - Un Yar_Client está asociado a una única dirección - de servicio. Llamar a cualquier método no definido sobre él se convierte - de forma transparente en una llamada RPC síncrona, de modo que los - métodos remotos se ven y se usan como si fueran locales; - Yar_Client::call hace lo mismo indicando el - nombre de forma explícita. - - - Los métodos protegidos no se exponen: llamar a uno de ellos falla con - una Yar_Client_Exception cuyo código es - YAR_ERR_REQUEST. - - -add(1, 2)); - -/* llamada mediante call() */ -var_dump($client->call("add", array(3, 2))); - -/* _add no se puede llamar: no es público */ -var_dump($client->_add(1, 2)); -?> -]]> - - &example.outputs.similar; - - - - - - - Ejemplo de cliente concurrente Yar - - En lugar de llamar a los servicios uno tras otro, - Yar_Concurrent_Client registra primero varias - llamadas y luego las envía todas a la vez con - Yar_Concurrent_Client::loop. Las respuestas se - pasan al callback en el orden en que llegan, no en el orden en que se - registraron las llamadas. - - - Justo después de que se hayan enviado todas las peticiones, el callback - se invoca una vez con argumentos &null; para que quien lo llama sepa que - no queda ninguna petición pendiente; el ejemplo siguiente comprueba esta - notificación. - - - -]]> - - &example.outputs.similar; - - - - - - - Ejemplo de cliente TCP Yar - - Además de HTTP, Yar_Client puede comunicarse con - servidores compatibles con Yar a través de TCP o de sockets Unix, por - ejemplo con un servicio implementado con el - framework Yar en C, - que sirve el mismo protocolo binario de Yar que usa el servidor PHP. - - -add(1, 2)); -?> -]]> - - - - - - diff --git a/reference/yar/ini.xml b/reference/yar/ini.xml deleted file mode 100644 index 71a6335d08..0000000000 --- a/reference/yar/ini.xml +++ /dev/null @@ -1,213 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - - Yar &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - yar.connect_timeout - 1000 - INI_ALL - - - - yar.content_type - application/octet-stream - INI_ALL - - - - yar.debug - Off - INI_ALL - - - - yar.expose_info - On - INI_PERDIR - - - - yar.packager - php - INI_PERDIR - - - - yar.ssl_verify - Off - INI_ALL - - - - yar.timeout - 5000 - INI_ALL - - - - -
    -
    - - &ini.descriptions.title; - - - - - - yar.connect_timeout - int - - - - Tiempo de espera de conexión, en milisegundos, para las llamadas HTTP - emitidas por Yar_Client y - Yar_Concurrent_Client. - - - - Este valor se interpreta en milisegundos. Antes de Yar 1.2.1 se medía - en segundos (el valor predeterminado era - 1). - - - - - - - yar.content_type - string - - - - El valor de la cabecera de respuesta Content-Type - enviada por Yar_Server. Yar utiliza un protocolo - binario, por lo que el valor predeterminado es - application/octet-stream. - - - - - - yar.debug - bool - - - - Activa el modo de depuración. Cuando está activo, Yar emite mensajes - E_WARNING con detalles a nivel de protocolo para - cada petición y cada respuesta, precedidos de - [Debug Yar_Server] o - [Debug Yar_Client] y de una marca de tiempo. - - - - - - yar.expose_info - bool - - - - Indica si Yar_Server::handle muestra la página - de información del servicio para las peticiones que no son POST - (habitualmente GET). Cuando esta directiva está desactivada, dichas - peticiones lanzan en su lugar una - Yar_Server_Exception. - - - - - - yar.packager - string - - - - El empaquetador predeterminado utilizado para serializar los cuerpos de - las peticiones y de las respuestas. Los valores válidos son - php (serialización de PHP), - json y - msgpack (únicamente cuando Yar se ha compilado con - ). - - - Cuando Yar se compila con soporte de msgpack, el valor predeterminado - pasa a ser msgpack. - - - Este valor puede reemplazarse en cada cliente mediante la opción - YAR_OPT_PACKAGER. - - - - - - yar.ssl_verify - bool - - - - Indica si se verifica el certificado TLS de los servidores HTTPS. Cuando - está activa, el transporte curl establece - CURLOPT_SSL_VERIFYPEER y - CURLOPT_SSL_VERIFYHOST, y las peticiones a - servidores con certificados no válidos fallan. Desactivada de forma - predeterminada por compatibilidad hacia atrás. Disponible a partir de - Yar 2.4.0. - - - - - - yar.timeout - int - - - - Tiempo de espera, en milisegundos, para las llamadas RPC emitidas por - Yar_Client y - Yar_Concurrent_Client. - - - - - - -
    - - diff --git a/reference/yar/protocol.xml b/reference/yar/protocol.xml deleted file mode 100644 index 59ad2d2a58..0000000000 --- a/reference/yar/protocol.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - El protocolo Yar - - Yar no depende de un esquema ni de un fichero IDL: todo se intercambia - por la red como bytes sin formato. Cualquier lenguaje capaz de leer y - escribir bytes puede comunicarse con un servicio Yar, sin instalar - ningún framework —basta con construir una cabecera binaria de tamaño - fijo y un cuerpo de petición serializado, enviarlos al URI del servicio - y analizar la respuesta. - - - Un mensaje consta de una cabecera de tamaño fijo de 82 bytes seguida de - un cuerpo. La cabecera tiene exactamente la disposición de la siguiente - estructura C, empaquetada sin relleno, y se escribe en la red campo a - campo en el orden de declaración: - - - - - - Los campos id, magic_num, - reserved y body_len se almacenan - en el orden de bytes de red (big-endian); los campos restantes son - bytes sin formato. - - - El cuerpo comienza con un identificador de empaquetador de 8 bytes - —PHP, JSON o - MSGPACK, rellenado con ceros— que indica al receptor - cómo se ha codificado el resto, seguido del propio contenido - serializado. - - - - - El cuerpo de la petición se decodifica en un array con las claves - i (el identificador de la transacción), - m (el método invocado) y p (la - lista de parámetros). - - - - - El cuerpo de la respuesta se decodifica en un array con las claves - i (el identificador de la transacción), - s (el estado, uno de los códigos - YAR_ERR_*), r (el valor - devuelto), o (la salida producida por el método - del servicio) y e (el error o la excepción, cuando - la llamada ha fallado). - - - - - Sobre HTTP, el mensaje se envía como cuerpo de una petición POST, y la - respuesta llega como cuerpo de la contestación; sobre TCP o sockets - Unix se escribe directamente en el flujo. - - - Llamada a un servicio Yar sin la extensión - - El siguiente script autónomo construye una petición Yar válida para el - empaquetador php únicamente con sockets estándar, la - envía al URI de un servicio y muestra la respuesta decodificada. Al - ejecutarlo contra el servicio Operator de los - ejemplos, muestra - int(3). - - - 1, "m" => "add", "p" => array(1, 2))); -$body = str_pad("PHP", 8, "\0") . $serialized; - -/* 2. la cabecera: 82 bytes, enteros multibyte en orden de bytes de red */ -$header = pack("N", 1) /* id */ - . pack("v", 0) /* versión */ - . pack("N", 0x80DFEC60) /* número mágico */ - . pack("N", 0) /* reservado */ - . str_pad("", 32, "\0") /* proveedor */ - . str_pad("", 32, "\0") /* token */ - . pack("N", strlen($body)); /* longitud del cuerpo */ - -/* 3. se envía como cuerpo de una petición POST */ -$stream = stream_context_create(array("http" => array( - "method" => "POST", - "header" => "Content-Type: application/octet-stream\r\n", - "content" => $header . $body, -))); -$reply = file_get_contents($uri, false, $stream); - -/* 4. se analiza la respuesta: cabecera de 82 bytes, luego el cuerpo */ -$response = unserialize(substr($reply, 82 + 8)); -var_dump($response["r"]); -?> -]]> - - - - En el directorio tools/ del - repositorio de código - fuente de Yar se encuentra una implementación de cliente más - completa en PHP puro, que además decodifica la cabecera de la respuesta - y admite llamadas concurrentes. - - - - diff --git a/reference/yar/setup.xml b/reference/yar/setup.xml deleted file mode 100644 index 042b99b3f2..0000000000 --- a/reference/yar/setup.xml +++ /dev/null @@ -1,172 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - La biblioteca cURL es necesaria para los transportes HTTP y HTTPS. El - transporte TCP está implementado con sockets simples y no necesita - ninguna biblioteca adicional. - - - Se requiere la extensión JSON, que se - incluye con PHP y está siempre disponible a partir de PHP 8.0.0. - - - Para utilizar el empaquetador msgpack, la extensión - msgpack debe estar - instalada y Yar debe compilarse con la opción de configuración - . - -
    - - -
    - &reftitle.install; - - Yar se puede instalar de tres maneras: mediante PECL, mediante PIE o - compilándolo a partir del código fuente. - - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;yar. - - - &pecl.windows.download.avail; - - - Instalación de Yar con PECL - - - - - - A partir de Yar 2.4.0, la extensión se puede instalar con - &link.pie;, el instalador de extensiones de PHP, ejecutando lo - siguiente en la línea de comandos. - - - Instalación de Yar con PIE - - - - - - El empaquetador msgpack se puede activar en el momento de la instalación: - - - Instalación de Yar con PIE y msgpack - - - - - - El código fuente está alojado en - GitHub. Para - compilar la extensión a partir del código fuente, se debe ejecutar lo - siguiente en la línea de comandos, sustituyendo las rutas por las de la - instalación local de PHP. - - - Compilación de Yar a partir del código fuente - - - - - - Están disponibles las siguientes opciones de configure: - - - - - - - - - Ubicación de la instalación de cURL, si no se encuentra en las rutas - de inclusión predeterminadas. - - - - - - - - - - Activa el empaquetador msgpack y convierte la - extensión msgpack en una dependencia opcional. - Cuando Yar se compila con esta opción, el valor predeterminado de - yar.packager pasa a ser - msgpack. - - - - - - - - - - Utiliza epoll de Linux en lugar de - select() para la multiplexación de E/S, disponible - a partir de Yar 2.1.2. Esto puede mejorar el rendimiento de - Yar_Concurrent_Client con una concurrencia - elevada. Solo tiene efecto en Linux; en las demás plataformas se - ignora silenciosamente. - - - - -
    - - - - &reference.yar.ini; - - -
    - &reftitle.resources; - - Esta extensión no define ningún tipo de recurso. - -
    - -
    - - diff --git a/reference/yar/yar-client-exception.xml b/reference/yar/yar-client-exception.xml deleted file mode 100644 index 770e61eb4a..0000000000 --- a/reference/yar/yar-client-exception.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - La clase Yar_Client_Exception - Yar_Client_Exception - - - - -
    - &reftitle.intro; - - Clase base de las excepciones lanzadas cuando una petición falla antes, - durante o después de alcanzar el servicio remoto: se lanza una subclase - u otra según el lugar en el que se haya producido el fallo. El código de - la excepción es una de las constantes YAR_ERR_*. - -
    - - -
    - &reftitle.classsynopsis; - - - - - Yar_Client_Exception - - - - extends - Exception - - - &InheritedProperties; - - - &Methods; - - - &InheritedMethods; - - - - - -
    - -
    - - &reference.yar.entities.yar-client-exception; - -
    - - diff --git a/reference/yar/yar-client-packager-exception.xml b/reference/yar/yar-client-packager-exception.xml deleted file mode 100644 index 80256a95af..0000000000 --- a/reference/yar/yar-client-packager-exception.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - La clase Yar_Client_Packager_Exception - Yar_Client_Packager_Exception - - - -
    - &reftitle.intro; - - Se lanza cuando el cuerpo de la respuesta no se puede desempaquetar con el empaquetador solicitado (código de excepción YAR_ERR_PACKAGER). - -
    - -
    - &reftitle.classsynopsis; - - - - Yar_Client_Packager_Exception - - - - extends - Yar_Client_Exception - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - -
    - -
    - - diff --git a/reference/yar/yar-client-protocol-exception.xml b/reference/yar/yar-client-protocol-exception.xml deleted file mode 100644 index 676c9ad35d..0000000000 --- a/reference/yar/yar-client-protocol-exception.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - La clase Yar_Client_Protocol_Exception - Yar_Client_Protocol_Exception - - - -
    - &reftitle.intro; - - Se lanza cuando la respuesta del servicio RPC viola el protocolo Yar, por ejemplo una dirección de protocolo no soportada o una cabecera de respuesta mal formada (código de excepción YAR_ERR_PROTOCOL). - - - A partir de Yar 2.4.0 esto incluye también una respuesta cuyo id de - transacción no coincide con el id de la petición a la que responde. El - cliente valida el campo i de cada respuesta; una - respuesta que lleve un id de transacción distinto y no nulo (por ejemplo, - una desviada por un proxy) se rechaza. Las respuestas con un id de - transacción igual a cero o ausente se siguen aceptando por compatibilidad - con servidores más antiguos. - -
    - -
    - &reftitle.classsynopsis; - - - - Yar_Client_Protocol_Exception - - - - extends - Yar_Client_Exception - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - -
    - -
    - - diff --git a/reference/yar/yar-client-transport-exception.xml b/reference/yar/yar-client-transport-exception.xml deleted file mode 100644 index e0074a6ace..0000000000 --- a/reference/yar/yar-client-transport-exception.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - La clase Yar_Client_Transport_Exception - Yar_Client_Transport_Exception - - - -
    - &reftitle.intro; - - Se lanza cuando falla la conexión con el servicio RPC: conexión rechazada, tiempo de espera agotado o respuesta vacía (código de excepción YAR_ERR_TRANSPORT). - -
    - -
    - &reftitle.classsynopsis; - - - - Yar_Client_Transport_Exception - - - - extends - Yar_Client_Exception - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - -
    - -
    - - diff --git a/reference/yar/yar-client.xml b/reference/yar/yar-client.xml deleted file mode 100644 index 78dcaabff7..0000000000 --- a/reference/yar/yar-client.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - La clase Yar_Client - Yar_Client - - - - -
    - &reftitle.intro; - - El lado cliente del framework RPC Yar. Un cliente está vinculado a una - única dirección de servicio; invocar sobre él cualquier método no - definido emite una llamada remota con ese nombre de método y los - argumentos indicados. - -
    - - -
    - &reftitle.classsynopsis; - - - - - Yar_Client - - - &Properties; - - protected - int - _protocol - - - protected - string - _uri - - - protected - arraynull - _options - - - protected - bool - _running - - - &Methods; - - - - - -
    - - -
    - &reftitle.properties; - - - _protocol - - - Solo lectura. El protocolo derivado de la dirección del servicio: una - de las constantes YAR_CLIENT_PROTOCOL_HTTP, - YAR_CLIENT_PROTOCOL_TCP o - YAR_CLIENT_PROTOCOL_UNIX. - - - - - _uri - - - Solo lectura. La dirección de servicio con la que se creó el cliente. - - - - - _options - - - Solo lectura. Un &array; con las opciones establecidas en este - cliente, indexado por las constantes YAR_OPT_*, o - &null; si no se estableció ninguna. - - - - - _running - - - Solo lectura. Indica si hay una llamada emitida por este cliente - actualmente en curso. - - - - -
    - - -
    - - &reference.yar.entities.yar-client; - -
    - - diff --git a/reference/yar/yar-concurrent-client.xml b/reference/yar/yar-concurrent-client.xml deleted file mode 100644 index 0848f3b753..0000000000 --- a/reference/yar/yar-concurrent-client.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - La clase Yar_Concurrent_Client - Yar_Concurrent_Client - - - - -
    - &reftitle.intro; - - Un ayudante estático que agrupa llamadas RPC remotas. Las llamadas - registradas con Yar_Concurrent_Client::call no - se envían inmediatamente; todas se despachan a la vez, en paralelo, - mediante Yar_Concurrent_Client::loop. - - - La clase está pensada para aplicaciones que necesitan los resultados de - varias llamadas remotas. Solo las llamadas independientes — aquellas que - no necesitan los resultados de las demás — pueden agruparse de esta - manera; cuando una llamada depende del resultado de otra, ambas tienen - que ejecutarse secuencialmente. Mediante - Yar_Client las llamadas se envían una tras otra, y - cada una paga su tiempo completo de ida y vuelta; con el cliente - concurrente se envían al mismo tiempo, por lo que el tiempo de espera - total se reduce a la duración de la llamada más lenta. - - - - Solo se admiten servicios HTTP(S) para las llamadas concurrentes. Se - envían de forma concurrente mediante la interfaz multi-handle de curl, - que el transporte por sockets TCP/Unix no implementa. - - -
    - - -
    - &reftitle.classsynopsis; - - - - - Yar_Concurrent_Client - - - &Methods; - - - - -
    - -
    - - &reference.yar.entities.yar-concurrent-client; - -
    - - diff --git a/reference/yar/yar-server-exception.xml b/reference/yar/yar-server-exception.xml deleted file mode 100644 index 12fbd9c029..0000000000 --- a/reference/yar/yar-server-exception.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - La clase Yar_Server_Exception - Yar_Server_Exception - - - - -
    - &reftitle.intro; - - Se lanza en el lado del cliente cuando la petición RPC ha fallado en el - servidor. Si el propio método del servicio remoto lanzó una excepción, - su mensaje, código, fichero, línea y nombre de clase se transmiten, y - Yar_Server_Exception::getType devuelve el - nombre de clase de la excepción original. - -
    - - -
    - &reftitle.classsynopsis; - - - - - Yar_Server_Exception - - - - extends - Exception - - - &Properties; - - protected - string - _type - "Yar_Exception_Server" - - - &InheritedProperties; - - - &Methods; - - - &InheritedMethods; - - - - - -
    - - -
    - &reftitle.properties; - - - _type - - - El nombre de clase de la excepción lanzada por el servicio remoto, o - "Yar_Exception_Server" si el error no fue causado - por una excepción del código de usuario. Se lee mediante - Yar_Server_Exception::getType. - - - - -
    - - -
    - - &reference.yar.entities.yar-server-exception; - -
    - - diff --git a/reference/yar/yar-server-output-exception.xml b/reference/yar/yar-server-output-exception.xml deleted file mode 100644 index 4f82f61b3e..0000000000 --- a/reference/yar/yar-server-output-exception.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - La clase Yar_Server_Output_Exception - Yar_Server_Output_Exception - - - -
    - &reftitle.intro; - - Se lanza cuando el servidor no puede capturar la salida del método del servicio (código de excepción YAR_ERR_OUTPUT). - -
    - -
    - &reftitle.classsynopsis; - - - - Yar_Server_Output_Exception - - - - extends - Yar_Server_Exception - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - -
    - -
    - - diff --git a/reference/yar/yar-server-packager-exception.xml b/reference/yar/yar-server-packager-exception.xml deleted file mode 100644 index 36878c1ed6..0000000000 --- a/reference/yar/yar-server-packager-exception.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - La clase Yar_Server_Packager_Exception - Yar_Server_Packager_Exception - - - -
    - &reftitle.intro; - - Se lanza cuando el cuerpo de la petición no se puede desempaquetar con el empaquetador anunciado en la petición (código de excepción YAR_ERR_PACKAGER). - -
    - -
    - &reftitle.classsynopsis; - - - - Yar_Server_Packager_Exception - - - - extends - Yar_Server_Exception - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - -
    - -
    - - diff --git a/reference/yar/yar-server-protocol-exception.xml b/reference/yar/yar-server-protocol-exception.xml deleted file mode 100644 index 09b68a5edd..0000000000 --- a/reference/yar/yar-server-protocol-exception.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - La clase Yar_Server_Protocol_Exception - Yar_Server_Protocol_Exception - - - -
    - &reftitle.intro; - - Se lanza cuando la petición entrante viola el protocolo Yar, por ejemplo una cabecera de petición mal formada (código de excepción YAR_ERR_PROTOCOL). - -
    - -
    - &reftitle.classsynopsis; - - - - Yar_Server_Protocol_Exception - - - - extends - Yar_Server_Exception - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - -
    - -
    - - diff --git a/reference/yar/yar-server-request-exception.xml b/reference/yar/yar-server-request-exception.xml deleted file mode 100644 index 9573dfd794..0000000000 --- a/reference/yar/yar-server-request-exception.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - La clase Yar_Server_Request_Exception - Yar_Server_Request_Exception - - - -
    - &reftitle.intro; - - Se lanza cuando el método remoto solicitado no existe en el objeto del servidor, o no es público (código de excepción YAR_ERR_REQUEST). - -
    - -
    - &reftitle.classsynopsis; - - - - Yar_Server_Request_Exception - - - - extends - Yar_Server_Exception - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
    - -
    - -
    - - diff --git a/reference/yar/yar-server.xml b/reference/yar/yar-server.xml deleted file mode 100644 index c2ae943b73..0000000000 --- a/reference/yar/yar-server.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - La clase Yar_Server - Yar_Server - - - - -
    - &reftitle.intro; - - Envuelve un objeto y expone todos sus métodos públicos como un servicio - remoto, servido a través de HTTP por - Yar_Server::handle. - - - La extensión de PHP solo proporciona un servidor HTTP. Un servidor TCP y - de sockets Unix que emplea el mismo protocolo Yar lo proporciona el - framework Yar en C. - -
    - - -
    - &reftitle.classsynopsis; - - - - - Yar_Server - - - &Properties; - - protected - object - _executor - null - - - &Methods; - - - - - -
    - - -
    - &reftitle.properties; - - - _executor - - - El objeto cuyos métodos públicos se exponen como servicios RPC. - - - - -
    - - -
    - - &reference.yar.entities.yar-server; - -
    - - diff --git a/reference/yar/yar_client/call.xml b/reference/yar/yar_client/call.xml deleted file mode 100644 index c767dd70cb..0000000000 --- a/reference/yar/yar_client/call.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - Yar_Client::call - Llama a un servicio remoto - - - - &reftitle.description; - - public mixedYar_Client::call - stringmethod - arrayarguments - - - Emite una llamada RPC al método remoto method. Esto - es exactamente lo que ocurre cuando se invoca un método inexistente sobre - un objeto Yar_Client (a través del método mágico - __call de PHP); - Yar_Client::call solo existe para que los métodos - remotos llamados literalmente call o - __call sigan siendo accesibles. - - - - - &reftitle.parameters; - - - method - - - El nombre del método del servicio remoto. - - - - - arguments - - - La lista de argumentos pasados al método remoto. - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor de retorno del método del servicio remoto. - - - - - &reftitle.errors; - - Cuando el método remoto no existe en el servidor, o no es público, el - cliente lanza una - Yar_Client_Exception con el código - YAR_ERR_REQUEST. Véase - Yar_Client_Exception - para los demás fallos del lado del cliente y sus clases de excepción. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yar_Client::call</methodname> - -add(1, 2)); - -/* Equivalente: llamar al método explícitamente por su nombre */ -var_dump($client->call("add", array(1, 2))); - -/* Solo es necesario cuando el servicio remoto expone literalmente un método - * llamado call (o __call), al que el __call mágico no puede acceder */ -var_dump($client->call("call", array($some_argument))); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yar_Client::setOpt - - - - - - diff --git a/reference/yar/yar_client/construct.xml b/reference/yar/yar_client/construct.xml deleted file mode 100644 index 237f522f7d..0000000000 --- a/reference/yar/yar_client/construct.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - Yar_Client::__construct - Crea un cliente - - - - &reftitle.description; - - final public Yar_Client::__construct - stringuri - arraynulloptionsnull - - - Crea un Yar_Client para el servicio RPC situado - en uri. - - - - - &reftitle.parameters; - - - uri - - - Dirección del servicio RPC. El protocolo se deriva del esquema: - http:// y https:// seleccionan el - transporte HTTP, tcp:// selecciona el transporte TCP - y unix:// selecciona el transporte por socket Unix. - - - - - options - - - Un &array; de opciones del cliente, indexado por las constantes - YAR_OPT_*, equivalente a llamar a - Yar_Client::setOpt para cada entrada. Las - opciones no válidas se omiten silenciosamente. - - - - - - - - &reftitle.returnvalues; - - Una nueva instancia de Yar_Client. - - - - - &reftitle.errors; - - Si la URI no comienza por un esquema soportado, se lanza una - Yar_Client_Protocol_Exception. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yar_Client::__construct</methodname> - - 1000, - YAR_OPT_PACKAGER => "json", -]); -?> -]]> - - - - - - &reftitle.seealso; - - Yar_Client::call - Yar_Client::setOpt - - - - - - diff --git a/reference/yar/yar_client/getopt.xml b/reference/yar/yar_client/getopt.xml deleted file mode 100644 index 0168b034f1..0000000000 --- a/reference/yar/yar_client/getopt.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Yar_Client::getOpt - Lee una opción del cliente - - - - &reftitle.description; - - public mixedYar_Client::getOpt - intname - - - Devuelve el valor establecido previamente con - Yar_Client::setOpt, o con el parámetro - options de - Yar_Client::__construct. - - - - - &reftitle.parameters; - - - name - - - Una de las constantes YAR_OPT_*, véase - Yar_Client::setOpt. - - - - - - - - &reftitle.returnvalues; - - El valor de la opción, o &false; si la opción no se ha establecido en este - cliente o el nombre de la opción es desconocido. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yar_Client::getOpt</methodname> - -setOpt(YAR_OPT_TIMEOUT, 1000); - -var_dump($client->getOpt(YAR_OPT_TIMEOUT)); -var_dump($client->getOpt(YAR_OPT_PACKAGER)); -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yar_Client::setOpt - - - - - - diff --git a/reference/yar/yar_client/setopt.xml b/reference/yar/yar_client/setopt.xml deleted file mode 100644 index 5b081b8798..0000000000 --- a/reference/yar/yar_client/setopt.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - Yar_Client::setOpt - Establece opciones del cliente - - - - &reftitle.description; - - public Yar_ClientboolYar_Client::setOpt - intname - mixedvalue - - - Establece una opción en el cliente. Las opciones se evalúan cuando se - emite una llamada, por lo que pueden cambiarse entre llamadas. - - - - - &reftitle.parameters; - - - name - - - Una de las constantes YAR_OPT_*: - - - YAR_OPT_PACKAGER — un nombre de empaquetador: php, json o, si se ha compilado con soporte para msgpack, msgpack - YAR_OPT_PERSISTENT — un indicador booleano de conexión persistente (keep-alive de HTTP) - YAR_OPT_TIMEOUT — un tiempo de espera en milisegundos, que prevalece sobre yar.timeout - YAR_OPT_CONNECT_TIMEOUT — un tiempo de espera de conexión en milisegundos, que prevalece sobre yar.connect_timeout - YAR_OPT_HEADER (a partir de 2.0.4) — un &array; de líneas de cabecera HTTP adicionales - YAR_OPT_RESOLVE (a partir de 2.1.0) — un &array; de entradas de resolución de nombres de host - YAR_OPT_PROXY (a partir de 2.2.0) — una dirección de proxy HTTP - YAR_OPT_PROVIDER (a partir de 2.3.0) — la identidad del proveedor, hasta 32 bytes - YAR_OPT_TOKEN (a partir de 2.3.0) — el token de autenticación, hasta 32 bytes - - - - - value - - - El valor de la opción. Un valor no válido genera una advertencia y hace - que la llamada devuelva &false;. - - - - - - - - &reftitle.returnvalues; - - Devuelve el propio objeto cliente, lo que permite una interfaz fluida, o - &false; cuando el nombre de la opción es desconocido, el valor no es - válido o la opción no se aplica al protocolo con el que se creó el - cliente. - - - - - &reftitle.errors; - - Las condiciones que hacen que la llamada devuelva &false; generan también - una advertencia: - - - - - YAR_OPT_HEADER, - YAR_OPT_RESOLVE y - YAR_OPT_PROXY solo funcionan con el protocolo HTTP; - usarlas con un cliente tcp:// o - unix:// genera una advertencia. - - - - - YAR_OPT_RESOLVE requiere además libcurl - >= 7.21.3. - - - - - Cada opción espera un tipo de valor concreto (cadena, booleano, entero o - array), descrito en la página de - constantes. - - - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yar_Client::setOpt</methodname> - -setOpt(YAR_OPT_TIMEOUT, 1000); - -/* Establece el empaquetador en JSON */ -$client->setOpt(YAR_OPT_PACKAGER, "json"); - -/* Establece cabeceras personalizadas */ -$client->setOpt(YAR_OPT_HEADER, ["X-Api-Key: value"]); - -/* Enruta a través de un proxy HTTP */ -$client->setOpt(YAR_OPT_PROXY, "127.0.0.1:8888"); - -/* llama al servicio remoto */ -$result = $client->some_method("parameter"); -?> -]]> - - - - - - &reftitle.seealso; - - Yar_Client::getOpt - Yar_Client::call - - - - - - diff --git a/reference/yar/yar_client_exception/gettype.xml b/reference/yar/yar_client_exception/gettype.xml deleted file mode 100644 index 5461c880b1..0000000000 --- a/reference/yar/yar_client_exception/gettype.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - Yar_Client_Exception::getType - Obtiene el tipo de la excepción - - - - &reftitle.description; - - public stringYar_Client_Exception::getType - - - - Devuelve el tipo de la excepción. Las excepciones del lado del cliente - las lanza el propio cliente (fallos de transporte, errores de protocolo, - etc.), por lo que el tipo es siempre la cadena fija - "Yar_Exception_Client". Se puede usar - Exception::getCode para distinguir cada fallo - concreto; el código es una de las constantes - YAR_ERR_*. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve "Yar_Exception_Client". - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yar_Client_Exception::getType</methodname> - -some_method("parameter"); -} catch (Yar_Client_Exception $e) { - var_dump($e->getType()); - var_dump($e->getCode()); -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yar_Server_Exception::getType - - - - - - diff --git a/reference/yar/yar_concurrent_client/call.xml b/reference/yar/yar_concurrent_client/call.xml deleted file mode 100644 index ce19084fe9..0000000000 --- a/reference/yar/yar_concurrent_client/call.xml +++ /dev/null @@ -1,190 +0,0 @@ - - - - - - Yar_Concurrent_Client::call - Registra una llamada concurrente - - - - &reftitle.description; - - public static intfalsenullYar_Concurrent_Client::call - stringuri - stringmethod - arraynullparametersnull - callablenullcallbacknull - callablenullerror_callbacknull - arraynulloptionsnull - - - Registra una llamada RPC remota. La petición no se envía inmediatamente; - todas las llamadas registradas se envían juntas mediante - Yar_Concurrent_Client::loop, y las respuestas se - tratan a medida que llegan. - - - - Solo se admiten URIs HTTP y HTTPS. Las llamadas concurrentes se envían - simultáneamente utilizando la interfaz multi-handle de curl, y el - transporte por sockets TCP/Unix no proporciona esta facilidad. - - - - - - &reftitle.parameters; - - - uri - - - Dirección del servicio RPC, que comienza por - http:// o https://. - - - - - method - - - El nombre del método del servicio remoto. - - - - - parameters - - - La lista de argumentos pasados al método remoto. - - - - - callback - - - Un callable invocado cuando llega la respuesta de esta - llamada, con dos argumentos: el valor de la respuesta y un - &array; callinfo que describe la llamada: - - - sequence — el número de secuencia devuelto - cuando se registró la llamada - uri — la dirección del servicio - method — el nombre del método remoto - - - Si se omite, se utiliza el callback de - Yar_Concurrent_Client::loop; - véase ese método para saber qué ocurre cuando no se indica ninguno. - - - - - error_callback - - - Un callable invocado cuando esta llamada falla, con tres - argumentos: el tipo de error (uno de los códigos - YAR_ERR_*), el mensaje de error y el - &array; callinfo descrito anteriormente. Si se - omite, se utiliza el error_callback de - Yar_Concurrent_Client::loop; - véase ese método para saber qué ocurre cuando no se indica ninguno. - - - - - options - - - Un &array; de opciones del cliente, indexado por las constantes - YAR_OPT_*, véase - Yar_Client::setOpt. Se aplica únicamente a - esta llamada. - - - - - - - - &reftitle.returnvalues; - - Devuelve el número de secuencia de la llamada registrada, un ID único que - empieza en 1 y que identifica la llamada. Devuelve - &false; cuando el cliente concurrente ya se encuentra dentro de - Yar_Concurrent_Client::loop o cuando se alcanza - el máximo de 128 llamadas registradas; en ambos casos - se emite una advertencia. Devuelve &null; si la URI o el nombre del - método están vacíos, o si la URI no es una dirección HTTP(S), con una - advertencia. - - - - - &reftitle.examples; - - - "json")); - -/* Tiempo de espera personalizado */ -Yar_Concurrent_Client::call("http://api.example.com/operator.php", "some_method", array("parameters"), "callback", NULL, array(YAR_OPT_TIMEOUT => 1000)); - -/* Las peticiones todavía no se han enviado */ -]]> - - - - - - &reftitle.seealso; - - Yar_Concurrent_Client::loop - Yar_Concurrent_Client::reset - - - - - - diff --git a/reference/yar/yar_concurrent_client/loop.xml b/reference/yar/yar_concurrent_client/loop.xml deleted file mode 100644 index da152df6d9..0000000000 --- a/reference/yar/yar_concurrent_client/loop.xml +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - Yar_Concurrent_Client::loop - Envía todas las llamadas registradas y espera su respuesta - - - - &reftitle.description; - - public static boolnullYar_Concurrent_Client::loop - callablenullcallbacknull - callablenullerror_callbacknull - arraynulloptionsnull - - - Envía en paralelo todas las llamadas registradas con - Yar_Concurrent_Client::call y bloquea hasta que - todas las respuestas hayan llegado y hayan sido tratadas. La lista de - llamadas se vacía cuando este método retorna. - - - Como las llamadas se ejecutan simultáneamente, el bucle solo dura lo que - dura la llamada más lenta, en lugar de la suma de todas las llamadas. Sin - embargo, los callbacks no se invocan en el orden en que se registraron las - llamadas: un callback se dispara en cuanto llega su respuesta. Para saber a - qué llamada corresponde una respuesta, se debe comparar la clave - sequence del argumento callinfo con - el número de secuencia devuelto por - Yar_Concurrent_Client::call. El - &array; callinfo contiene la - sequence, la uri y el - method de la llamada; véase - Yar_Concurrent_Client::call. - - - - - &reftitle.parameters; - - - callback - - - Un callable utilizado para tratar las respuestas de las - llamadas que se registraron sin su propio callback. Justo después de - que se hayan enviado todas las peticiones, se le llama además una vez - con dos argumentos &null;, antes de que llegue ninguna respuesta. - - - Si se omite este parámetro, el valor de retorno de una llamada - satisfactoria simplemente se imprime cuando llega su respuesta. - - - - - error_callback - - - Un callable utilizado para tratar los errores de las - llamadas que se registraron sin su propio callback de error. Recibe - tres argumentos: el tipo de error (uno de los códigos - YAR_ERR_*), el mensaje de error y el - &array; callinfo. - - - Si se omite este parámetro, una llamada fallida emite en su lugar una - advertencia de PHP; a diferencia del Yar_Client - síncrono, no se lanza ninguna excepción. - - - - - options - - - Un &array; de opciones del cliente, indexado por las constantes - YAR_OPT_*, que se aplica a cada llamada registrada - que no las sobrescriba. - - - - - - - - &reftitle.returnvalues; - - Devuelve &true; cuando todas las llamadas registradas han sido tratadas, - o cuando no se ha registrado ninguna llamada. Devuelve &false; si el - cliente concurrente ya se está ejecutando dentro de otro bucle; en ese - caso se emite una advertencia. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yar_Concurrent_Client::loop</methodname> - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yar_Concurrent_Client::call - Yar_Concurrent_Client::reset - - - - - - diff --git a/reference/yar/yar_concurrent_client/reset.xml b/reference/yar/yar_concurrent_client/reset.xml deleted file mode 100644 index 6e710dd49c..0000000000 --- a/reference/yar/yar_concurrent_client/reset.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - Yar_Concurrent_Client::reset - Limpia todas las llamadas registradas - - - - &reftitle.description; - - public static boolYar_Concurrent_Client::reset - - - - Descarta todas las llamadas registradas con - Yar_Concurrent_Client::call que todavía no se - han enviado. - - - - Yar_Concurrent_Client::loop vacía la lista de - llamadas automáticamente una vez que ha terminado, por lo que reset solo - es necesario para abortar un lote que nunca se envió. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true;, o &false; cuando el cliente concurrente se encuentra - actualmente dentro de - Yar_Concurrent_Client::loop, en cuyo caso se - emite un error de nivel E_WARNING. - - - - - &reftitle.examples; - - Ejemplo de <function>Yar_Concurrent_Client::reset</function> - - -]]> - - - - - - &reftitle.seealso; - - Yar_Concurrent_Client::call - Yar_Concurrent_Client::loop - - - - - - diff --git a/reference/yar/yar_server/construct.xml b/reference/yar/yar_server/construct.xml deleted file mode 100644 index f417cfdde2..0000000000 --- a/reference/yar/yar_server/construct.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - Yar_Server::__construct - Crea un servidor RPC - - - - &reftitle.description; - - final public Yar_Server::__construct - objectexecutor - - - Crea un servidor RPC HTTP de Yar. Todos los métodos públicos de - executor se registran como servicios RPC. - - - - - &reftitle.parameters; - - - executor - - - Cualquier objeto cuyos métodos públicos deban exponerse como - servicios RPC. Los métodos protegidos y privados, y los métodos cuyo - nombre empieza por un guion bajo, no se exponen. - - - El ejecutor puede definir opcionalmente dos métodos mágicos - protegidos, que son reconocidos por - Yar_Server::handle y nunca se exponen - como puntos de acceso RPC: - - - - - protected function __info(string $markup): - string — a partir de Yar 2.3.0. Se llama cuando se - solicita la página de información del servicio; recibe el - marcado de la página que Yar mostraría en otro caso, y si - devuelve una &string;, esa cadena se envía al cliente en su - lugar. Véase Yar_Server::handle. - - - - - protected function __auth(string $provider, string - $token): bool — a partir de Yar 2.3.0. Se llama al - principio de cada petición con los campos - provider y token de la - cabecera de la petición, establecidos por el cliente mediante - las opciones YAR_OPT_PROVIDER y - YAR_OPT_TOKEN. Devolver exactamente - &false; rechaza la petición; cualquier otro valor de retorno - permite que continúe. Véase - Yar_Server::handle. - - - - - Ambos métodos solo surten efecto cuando son - protected; un método público o privado con el - mismo nombre se ignora. - - - - - - - - &reftitle.returnvalues; - - Una instancia de Yar_Server. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yar_Server::__construct</methodname> - -handle(); -?> -]]> - - - - - - &reftitle.seealso; - - - Yar_Server::handle - - - - - - - diff --git a/reference/yar/yar_server/handle.xml b/reference/yar/yar_server/handle.xml deleted file mode 100644 index 3dfd8adfa1..0000000000 --- a/reference/yar/yar_server/handle.xml +++ /dev/null @@ -1,212 +0,0 @@ - - - - - - Yar_Server::handle - Inicia el servidor RPC - - - - &reftitle.description; - - public boolYar_Server::handle - - - - Empieza a atender la petición RPC entrante. - - - - Las llamadas RPC habituales se emiten como peticiones HTTP POST. Si en - su lugar se emite una petición HTTP GET, se muestra la página de - información del servicio, generada a partir de los métodos públicos y - de sus bloques de documentación del objeto ejecutor. Este - comportamiento se puede desactivar con la directiva - yar.expose_info, - en cuyo caso una petición GET lanza una - Yar_Server_Exception. - - - - - A partir de Yar 2.3.0, el objeto ejecutor puede definir los métodos - mágicos protegidos __info y - __auth para personalizar la página de información - del servicio y para autenticar las peticiones; véase - Yar_Server::__construct para más detalles. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true;. - - - - - &reftitle.errors; - - - Errores de <methodname>Yar_Server::handle</methodname> - - - - Condición - Excepción - - - - - - El método remoto lanzó una excepción. - - - Yar_Server_Exception (con el nombre - de clase original en su propiedad _type). - - - - - El método remoto no se encontró o no es público. - - - Yar_Server_Request_Exception. - - - - - El cuerpo de la petición no se pudo desempaquetar. - - - Yar_Server_Packager_Exception. - - - - - La petición está mal formada a nivel de protocolo. - - - Yar_Server_Protocol_Exception. - - - - - La salida del servidor no se pudo capturar. - - - Yar_Server_Output_Exception. - - - - - La autenticación falló, o se solicitó la página de información - mientras - yar.expose_info está - desactivada. - - - Yar_Server_Exception con el código - YAR_ERR_FORBIDDEN. - - - - -
    -
    -
    - - - &reftitle.examples; - - Ejemplo de <methodname>Yar_Server::handle</methodname> - -handle(); -?> -]]> - - - - Personalización de la página de información del servicio con - <literal>__info</literal> (a partir de Yar 2.3.0) - -handle(); -?> -]]> - - - - - - &reftitle.seealso; - - - Yar_Server::__construct - - - - -
    - - diff --git a/reference/yar/yar_server_exception/gettype.xml b/reference/yar/yar_server_exception/gettype.xml deleted file mode 100644 index 3bb4cb5faf..0000000000 --- a/reference/yar/yar_server_exception/gettype.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - Yar_Server_Exception::getType - Obtiene el tipo de la excepción - - - - &reftitle.description; - - public stringintYar_Server_Exception::getType - - - - Cuando un método remoto lanza una excepción, el servidor incrusta la - excepción original en la respuesta y el cliente la relanza como una - Yar_Server_Exception. Este método devuelve - el nombre de clase de esa excepción original. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - El nombre de clase de la excepción lanzada por el servicio remoto, o - "Yar_Exception_Server" cuando la excepción del lado - del servidor no llevaba ningún nombre de clase. - - - - - &reftitle.examples; - - Ejemplo de <methodname>Yar_Server_Exception::getType</methodname> - -handle(); -?> -]]> - - -throw_exception("client"); -} catch (Yar_Server_Exception $e) { - var_dump($e->getType()); - var_dump($e->getMessage()); -} -?> -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - Yar_Client_Exception::getType - - - - - - diff --git a/reference/yaz/book.xml b/reference/yaz/book.xml deleted file mode 100644 index d43423aac6..0000000000 --- a/reference/yaz/book.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - YAZ - - - - &reftitle.intro; - - Esta extensión ofrece una interface PHP a el kit de herramientas - YAZ que implementa el - Protocolo - Z39.50 para Recuperación de Información. - Con esta extensión se puede fácilmente implementar un origen Z39.50 (clientes) - que busca o escanea objetivos Z39.50 (servidores) en paralelo. - - - El modulo esconde la mayor parte de la complejidad de Z39.50 así que debería ser - bastante fácil a usar. Apoya de manera persistente conexiones apátridas muy similares - a esas ofrecidas por varias APIs RDB que están disponibles - para PHP. Significa que las sesiones son apátridas pero se comparten entre - usuarios, por lo tanto salvando la fase de pasos para la conexión e inicialización en más - casos. - - - YAZ está disponible &url.yaz;. Se puede encontrar nuevas noticias, - ejemplos de códigos, etc. Para esta extensión en &url.yaz-phpyaz;. - - - - &pecl.moved-ver;5.0.0. - - - - - - &reference.yaz.setup; - &reference.yaz.examples; - &reference.yaz.reference; - - - - - diff --git a/reference/yaz/configure.xml b/reference/yaz/configure.xml deleted file mode 100644 index ed4ec03106..0000000000 --- a/reference/yaz/configure.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;yaz - - - &pecl.windows.download; - - - Información específica para usuarios Windows - - php_yaz.dll depende de - yaz.dll. El yaz.dll - es parte del ZIP Win32 del sitio de PHP. También es parte de - la instalación de Windows YAZ disponible del área - WIN32 YAZ. - - - En Windows, no se debe olvidar agregar al PATH el directorio de PHP, - para que el sistema pueda encontrar el fichero yaz.dll. - - - - &warn.imaprecodeyaz; - -
    - - diff --git a/reference/yaz/examples.xml b/reference/yaz/examples.xml deleted file mode 100644 index 40ee023088..0000000000 --- a/reference/yaz/examples.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - &reftitle.examples; - - PHP/YAZ mantiene la vía de conexión con los objetivos de - las (Asociaciones-Z). Un recurso representa una conexión a - objetivo. - - - El código debajo demuestra las características de la búsqueda en paralelo - del API. Cuando se invoca sin argumentos imprime una consulta de formulario; sino - (los argumentos son suministrados) busca los objetivos como son dados en el arreglo del - anfitrión. - - - - Busqueda Paralela usando YAZ - - - - Prueba GILS - - Prueba local - - Congresos de librería -
    - RPN Query: - - - - '; -} else { - echo 'Se encontro para ' . htmlspecialchars($query) . '
    '; - for ($i = 0; $i < $num_hosts; $i++) { - $id[] = yaz_connect($host[$i]); - yaz_syntax($id[$i], "usmarc"); - yaz_range($id[$i], 1, 10); - yaz_search($id[$i], "rpn", $query); - } - yaz_wait(); - for ($i = 0; $i < $num_hosts; $i++) { - echo '
    ' . $host[$i] . ':'; - $error = yaz_error($id[$i]); - if (!empty($error)) { - echo "Error: $error"; - } else { - $hits = yaz_hits($id[$i]); - echo "Conteo de Resultado $hits"; - } - echo '
    '; - for ($p = 1; $p <= 10; $p++) { - $rec = yaz_record($id[$i], $p, "string"); - if (empty($rec)) continue; - echo "
    $p
    "; - echo nl2br($rec); - echo "
    "; - } - echo '
    '; - } -} -?> -]]> -
    -
    -
    -
    - - - diff --git a/reference/yaz/functions/yaz-addinfo.xml b/reference/yaz/functions/yaz-addinfo.xml deleted file mode 100644 index 6cfbc1a19b..0000000000 --- a/reference/yaz/functions/yaz-addinfo.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - yaz_addinfo - Devuelve un error adicional de información - - - &reftitle.description; - - stringyaz_addinfo - resourceid - - - Devuelve un error adicional de información para el ultimo requerimiento al servidor. - - - Con algunos servidores, Ésta función puede devolver la misma cadena como - yaz_error. - - - - &reftitle.parameters; - - - - id - - - El recurso de conexión devuelto por yaz_connect. - - - - - - - - &reftitle.returnvalues; - - Una cadena contiene el error adicional de información o una cadena vacia si la - ultima operación fue satisfactoria o si ninguna información fue proporcionada - por el servidor. - - - - &reftitle.seealso; - - - yaz_error - yaz_errno - - - - - - diff --git a/reference/yaz/functions/yaz-ccl-conf.xml b/reference/yaz/functions/yaz-ccl-conf.xml deleted file mode 100644 index d8660b1f5f..0000000000 --- a/reference/yaz/functions/yaz-ccl-conf.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - yaz_ccl_conf - Configura el analizador CCL - - - &reftitle.description; - - voidyaz_ccl_conf - resourceid - arrayconfig - - - Ésta función configura la consulta analizadora CCL para un servidor con - definiciones de puntos de acceso (Calificadores CCL) y su asignación al RPN. - - - Para asignar una consulta especifica CCL al RPN después se llama la función - yaz_ccl_parse. - - - - &reftitle.parameters; - - - - id - - - El recurso de conexión devuelto por yaz_connect. - - - - - config - - - Un arreglo de configuración. Cada clave del arreglo es el nombre de un campo CCL - y el correspondiente valor que mantiene una cadena que especifica una - asignación al RPN. - - - La asignación es una secuencia de el tipo de atributo, de los valores de los atributos pares. - El tipo de atributo y el valor del atributo están separados por un signo - (=). Cada par es separado por un espacio en blanco. - - - La información adicional la puede encontrar en la página CCL. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.examples; - - En cada ejemplo a continuación, el analizador CCL está configurado para soportar el árbol de los campos - CCL: ti, au y - isbn. Cada campo es asignado a su equivalente BIB-1. - Es asumida que la variable $id es la conexión ID. - - - Configuración del CCL - - "1=4", - "au" => "1=1", - "isbn" => "1=7" -); -yaz_ccl_conf($id, $fields); -?> -]]> - - - - - &reftitle.seealso; - - - yaz_ccl_parse - - - - - - diff --git a/reference/yaz/functions/yaz-ccl-parse.xml b/reference/yaz/functions/yaz-ccl-parse.xml deleted file mode 100644 index 84ed741051..0000000000 --- a/reference/yaz/functions/yaz-ccl-parse.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - - yaz_ccl_parse - Invocar el analizador CCL - - - &reftitle.description; - - boolyaz_ccl_parse - resourceid - stringquery - arrayresult - - - Esta función invoca un analizador CCL. Convierte una consulta dada CCL FIND a - una consulta RPN la cual puede ser pasada también a la función yaz_search - para ejecutar la búsqueda. - - - Para definir un conjunto de campos validos CCL llaman preferiblemente a yaz_ccl_conf - para definirlo en la función. - - - - &reftitle.parameters; - - - - id - - - El recurso de la conexión retornado por yaz_connect. - - - - - query - - - La consulta CCL FIND. - - - - - result - - - Si la función fue ejecutada con éxito, Va a ser un arreglo conteniendo - la consulta RPN valida dentro de la clave rpn. - - - En caso de fallo, tres índices son establecidos en este arreglo para indicar la causa - del fallo: - - - - errorcode - El código de error CCL (entero) - - - - - errorstring - El error CCL de cadena - - - - - errorpos - aproxima la posición en una consulta de fallo - (el entero es el carácter de posición) - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - Análisis CCL - - Se va a intentar hacer una búsqueda con CCL. En el ejemplo de abajo, - $ccl es una consulta CCL. - - - -]]> - - - - - - diff --git a/reference/yaz/functions/yaz-close.xml b/reference/yaz/functions/yaz-close.xml deleted file mode 100644 index 97989578b2..0000000000 --- a/reference/yaz/functions/yaz-close.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - yaz_close - Cierra una conexión YAZ - - - &reftitle.description; - - boolyaz_close - resourceid - - - Cierra la conexión dada por un parámetro id. - - - - Esta función va solo a cerrar una conexión no persistente abierta por - estableciendo la opción de persistent a &false; con - yaz_connect. - - - - - &reftitle.parameters; - - - - id - - - El recurso de conexión retornado por yaz_connect. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - yaz_connect - - - - - - diff --git a/reference/yaz/functions/yaz-connect.xml b/reference/yaz/functions/yaz-connect.xml deleted file mode 100644 index b182f6af14..0000000000 --- a/reference/yaz/functions/yaz-connect.xml +++ /dev/null @@ -1,224 +0,0 @@ - - - - - - - yaz_connect - - Prepara una conexión a un servidor Z39.50 - - - - &reftitle.description; - - mixedyaz_connect - stringzurl - mixedoptions - - - Esta función devuelve un recurso de conexión en caso de éxito, cero en caso - de fallo. - - - yaz_connect prepara una conexión a un servidor - Z39.50. - Esta función es no bloqueante y no intenta establecer - una conexión - únicamente prepara la conexión para que pueda ser realizada posteriormente cuando - se llame a la función yaz_wait. - - - - El proxy YAZ es un proxy - Z39.50 disponible gratuitamente. - - - - - &reftitle.parameters; - - - - zurl - - - Un string que toma la forma host[:port][/database]. - Si se omite el port, se utilizará el port 210. Si se omite database - se utilizará Default . - - - - - options - - - Si se trata de un string, éste se trata como el string de autenticación Z39.50 V2 - (OpenAuth). - - - Si se trata de un array, el contenido del array sirve como opciones. - - - user - - - Nombre de usuario para la autenticación. - - - - - group - - - Grupo para la autenticación. - - - - - password - - - Contraseña para la autenticación. - - - - - cookie - - - Cookie para la sesión (proxy YAZ). - - - - - proxy - - - Proxy para la conexión (proxy YAZ). - - - - - persistent - - - Un booleano. Si es &true; la conexión es persistente; Si es &false; la - conexión no es persistente. Por defecto las conexiones son persistentes. - - - - Si se abre una conexión persistente, no se podrá cerrar - posteriormente con la función yaz_close. - - - - - - piggyback - - - Un booleano. Si es &true; piggyback está activado para las búsquedas; Si es &false; - piggyback está desactivado. Por defecto piggyback está activado. - - - Activar piggyback es más eficiente y normalmente ahorra - una ruta de ida y vuelta en la red para las cargas de los registros por primera vez. Sin embargo, unos - pocos servidores Z39.50 no soportan piggyback o ignoran los - nombres de los elementos configurados. Para ellos, se debe desactivar piggyback. - - - - - charset - - - Un string que especifica el mapa de caracteres que será utilizado como - lenguaje y mapa de caracteres en la negociación Z39.50. Utilizar strings como: - ISO-8859-1, UTF-8, - UTF-16. - - - Muchos servidores Z39.50 no soportan esta funcionalidad (y por ello, ésta es - ignorada). Muchos servidores utilizan la codificación ISO-8859-1 para consultas y - mensajes. Los registros MARC21/USMARC no están afectados por este parámetro - - - - - - preferredMessageSize - - - Un entero que especifica el tamaño máximo de byte para todos los registros - que se devolverán por el objetivo durante la recuperación. Ver el - estandard Z39.50 para más - información. - - - - Esta opción está soportada en PECL YAZ 1.0.5 o posteriores. - - - - - - - maximumRecordSize - - - Un entero que especifica el tamaño máximo de byte de un único registro - a ser devuelto por un objetivo durante la recuperación. Esta - entidad se denomina como un Exceptional-record-size en el - standard Z39.50. - - - - Esta opción está soportada en PECL YAZ 1.0.5 o posteriores. - - - - - - - - - - - - - - &reftitle.returnvalues; - - Un recurso de conexión en caso de éxito, &false; en caso de error. - - - - &reftitle.seealso; - - - yaz_close - - - - - - diff --git a/reference/yaz/functions/yaz-database.xml b/reference/yaz/functions/yaz-database.xml deleted file mode 100644 index 37abbc7efc..0000000000 --- a/reference/yaz/functions/yaz-database.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - yaz_database - - Especifica las bases de datos dentro de una sesión - - - - &reftitle.description; - - boolyaz_database - resourceid - stringdatabases - - - Esta función permite cambiar las bases de datos dentro de una sesión por - una o más bases de datos especificadas a ser usadas en la búsqueda, recuperación, etc. - - primordialmente a las bases de datos especificadas a ser llamadas - yaz_connect. - - - - &reftitle.parameters; - - - - id - - - El recurso de conexión devuelto por yaz_connect. - - - - - databases - - - Una cadena conteniendo una o más bases de datos. Múltiple bases de datos son - separadas por un signo de más+. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/yaz/functions/yaz-element.xml b/reference/yaz/functions/yaz-element.xml deleted file mode 100644 index 9e3c5dfdd9..0000000000 --- a/reference/yaz/functions/yaz-element.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - yaz_element - - Especifica el nombre del elemento establecido para recuperar - - - - &reftitle.description; - - boolyaz_element - resourceid - stringelementset - - - Esta función especifica el nombre del elemento establecido para recuperar. - - - Llama esta función antes de yaz_search o - yaz_present para especificar el nombre del elemento establecido para - los registros a ser recuperados. - - - - Si la función parece no tener efecto, ve la descripción de la opción - piggybacking en - yaz_connect. - - - - - &reftitle.parameters; - - - - id - - - El recurso de conexión retornado por yaz_connect. - - - - - elementset - - - Más servidores soportan F (para registros completos) y - B (para registros breves). - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/yaz/functions/yaz-errno.xml b/reference/yaz/functions/yaz-errno.xml deleted file mode 100644 index f66d88b74c..0000000000 --- a/reference/yaz/functions/yaz-errno.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - yaz_errno - Devuelve el número de error - - - &reftitle.description; - - intyaz_errno - resourceid - - - Devuelve un número de error del servidor (la última solicitud) identificado por - id. - - - yaz_errno debe ser llamado después de la actividad de - red para cada servidor - (después del retorno de yaz_wait) para determinar - el éxito o el fracaso de la última operación (p. ej. búsqueda). - - - - &reftitle.parameters; - - - - id - - - El recurso de conexión devuelto por yaz_connect. - - - - - - - - &reftitle.returnvalues; - - Devuelve un código de error. El código de error es un código de diagnóstico - Z39.50 (por lo general un diagnóstico de Bib-1) o el código de error del lado - del cliente que es generado por PHP/YAZ, como "Error de conexión", "Init rechazado", etc - - - - &reftitle.seealso; - - - yaz_error - yaz_addinfo - - - - - - diff --git a/reference/yaz/functions/yaz-error.xml b/reference/yaz/functions/yaz-error.xml deleted file mode 100644 index c3a2d9f760..0000000000 --- a/reference/yaz/functions/yaz-error.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - yaz_error - Devuelve la descripción del error - - - &reftitle.description; - - stringyaz_error - resourceid - - - yaz_error retorna un mensaje textual en Inglés - correspondiente al último error numérico como devuelto por - yaz_errno. - - - - &reftitle.parameters; - - - - id - - - El recurso de conexión retornado por yaz_connect. - - - - - - - - &reftitle.returnvalues; - - Devuelve un mensaje textual por el servidor (último requerimiento), identificado por - el parámetro id. Una cadenma vacia es retornada si la última operación - fue satisfactoria. - - - - &reftitle.seealso; - - - yaz_errno - yaz_addinfo - - - - - - diff --git a/reference/yaz/functions/yaz-es-result.xml b/reference/yaz/functions/yaz-es-result.xml deleted file mode 100644 index c408ff4e37..0000000000 --- a/reference/yaz/functions/yaz-es-result.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - yaz_es_result - - Resulados de Servicios Extendidos de Inspección - - - - &reftitle.description; - - arrayyaz_es_result - resourceid - - - - Esta función inspecciona el último resultado de servicio extendido - retornado de un servidor. Un servicio extendido es iniciado - por cualquier yaz_item_order o - yaz_es. - - - - - &reftitle.parameters; - - - - id - - - El resultado de conexión retornado por yaz_connect. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un arreglo con targetReference elemento - para la referencia en la operación del servicio extendido (generado - y retornado del servidor). - - - - - &reftitle.seealso; - - - yaz_es - - - - - - - diff --git a/reference/yaz/functions/yaz-es.xml b/reference/yaz/functions/yaz-es.xml deleted file mode 100644 index e07a02a6b5..0000000000 --- a/reference/yaz/functions/yaz-es.xml +++ /dev/null @@ -1,147 +0,0 @@ - - - - - - yaz_es - - Prepara para una solicitud de servicio extendido - - - - &reftitle.description; - - voidyaz_es - - resourceid - - - stringtype - - - arrayargs - - - - Esta función prepara para una solicitud de servicio extendido. - Los servicios extendidos son una familia de diversas facilidades Z39.50, tales como - actualización de registros, ordenado de ítem, administración de base de datos, etc. - - - - Muchos servidores Z39.50 no soportan servicios extendidos. - - - - La yaz_es crea un paquete de solicitud de servicio - extendido y la pone en una cola de operaciones. - Se utiliza yaz_wait para enviar la(s) solicitud(es) al servidor. - Después de completar yaz_wait el resultado de - la operación del servicio extendido se debe esperar con - una llamada a yaz_es_result. - - - - &reftitle.parameters; - - - - id - - - El recurso de conexión devuelto por yaz_connect. - - - - - type - - - Un string que representa el tipo de servicio extendido: - itemorder (Ordenado de ítem), - create (Crear base de datos), - drop (Descartar base de datos), - commit (Operación de cometer), - update (Actualizar registro), - xmlupdate (Actualizar XML). - Cada tipo se especifica en la sección siguiente. - - - - - - args - - - Un array con las opciones de servicio extendido, más - opciones específicas del paquete. Las opciones son idénticas a - las ofrecidas en la API C de ZOOM C. Consulte a los - servicios extendidos de ZOOM. - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - Actualizar registro - - "some title", - "syntax" => "xml", - "action" => "specialUpdate" -); -yaz_es($con, "update", $args); -yaz_wait(); -$result = yaz_es_result($id); -?> -]]> - - - - - - &reftitle.seealso; - - - yaz_es_result - - - - - - - diff --git a/reference/yaz/functions/yaz-get-option.xml b/reference/yaz/functions/yaz-get-option.xml deleted file mode 100644 index 3d2ca1d599..0000000000 --- a/reference/yaz/functions/yaz-get-option.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - yaz_get_option - Devuelve el valor de opción para la conexión - - - &reftitle.description; - - stringyaz_get_option - resourceid - stringname - - - Devuelve el valor de la opción especificada con name. - - - - &reftitle.parameters; - - - - id - - - El recurso de conexión retornado por yaz_connect. - - - - - name - - - La opción del nombre. - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor de la opción especificada o una cadena vacía si la opción - wno está establecida. - - - - &reftitle.seealso; - - - - La descripción de yaz_set_option para las opciones - disponibles - - - - - - - diff --git a/reference/yaz/functions/yaz-hits.xml b/reference/yaz/functions/yaz-hits.xml deleted file mode 100644 index 7acaf18226..0000000000 --- a/reference/yaz/functions/yaz-hits.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - - - yaz_hits - Devuelve el número de éxitos de la última búsqueda - - - &reftitle.description; - - intyaz_hits - resourceid - arraysearchresult - - - yaz_hitsDevuelve el número de éxitos de la última - búsqueda. - - - - &reftitle.parameters; - - - - id - - - El recurso de conexión devuelto por yaz_connect. - - - - - searchresult - - - Array de resultados para obtener información de resultados de búsqueda detallada. - - - - - - - - &reftitle.returnvalues; - - Devuelve el número de éxitos de la última búsqueda o 0 si no se ha - realizado ninguna búsqueda. - - - La matriz de resultados de búsqueda (si se suministra) contiene información - que es devuelta por un servidor Z39.50 en el formato SearchResult-1 - parte de una respuesta de búsqueda. - El formato SearchResult-1 puede utilizarse para obtener información acerca de - recuentos de éxitos para varias partes de la consulta (subconsulta). - En particular, es posible obtener recuentos de éxitos para los términos de - búsqueda individuales en una consulta. Información para la primer subconsulta - está en $array[0], segunda subconsulta en $array[1], y así sucesivamente. - - - Miembros de searchresult - - - - - - Elemento - Descripción - - - - - id - Sub consulta ID2 (string) - - - count - Conteo resultados / éxitos (integer) - - - subquery.term - Término sub consulta(string) - - - interpretation.term - Interpretación de término de sub consulta (string) - - - recommendation.term - Término recomendado de sub consulta (string) - - - -
    - - - El centro de SearchResult requiere PECL YAZ 1.0.5 - o posterior y YAZ 2.1.9 o posterior. - - - - - Muy pocas implementaciones Z39.50 soportan la instalación de SearchResult. - - -
    -
    - - diff --git a/reference/yaz/functions/yaz-itemorder.xml b/reference/yaz/functions/yaz-itemorder.xml deleted file mode 100644 index 3f7f21a6ef..0000000000 --- a/reference/yaz/functions/yaz-itemorder.xml +++ /dev/null @@ -1,178 +0,0 @@ - - - - - - - - yaz_itemorder - - Prepara para la solicitud Z39.50 Item Order con el paquete ILL-Request - - - - &reftitle.description; - - voidyaz_itemorder - resourceid - arrayargs - - - Esta función prepara para una petición de tipo "Extended Services" utilizando el - "Profile" para "Use of Z39.50 Item Order Extended Service to - Transport ILL (Profile/1)". Ver aquí - y la especificación. - - - - &reftitle.parameters; - - - - id - - - El recurso de conexión devuelto por yaz_connect. - - - - - args - - - Debe ser un array asociativo con información sobre la solicitud - de los elementos que serán enviados. La clave de la tabla hash es el nombre del - camino de acceso ASN.1 correspondiente. Por ejemplo, el ISBN bajo el Item-ID - tiene la clave item-id,ISBN. - - - Los parámetros de la petición ILL son: - - -protocol-version-num -transaction-id,initial-requester-id,person-or-institution-symbol,person -transaction-id,initial-requester-id,person-or-institution-symbol,institution -transaction-id,initial-requester-id,name-of-person-or-institution,name-of-person -transaction-id,initial-requester-id,name-of-person-or-institution,name-of-institution -transaction-id,transaction-group-qualifier -transaction-id,transaction-qualifier -transaction-id,sub-transaction-qualifier -service-date-time,this,date -service-date-time,this,time -service-date-time,original,date -service-date-time,original,time -requester-id,person-or-institution-symbol,person -requester-id,person-or-institution-symbol,institution -requester-id,name-of-person-or-institution,name-of-person -requester-id,name-of-person-or-institution,name-of-institution -responder-id,person-or-institution-symbol,person -responder-id,person-or-institution-symbol,institution -responder-id,name-of-person-or-institution,name-of-person -responder-id,name-of-person-or-institution,name-of-institution -transaction-type -delivery-address,postal-address,name-of-person-or-institution,name-of-person -delivery-address,postal-address,name-of-person-or-institution,name-of-institution -delivery-address,postal-address,extended-postal-delivery-address -delivery-address,postal-address,street-and-number -delivery-address,postal-address,post-office-box -delivery-address,postal-address,city -delivery-address,postal-address,region -delivery-address,postal-address,country -delivery-address,postal-address,postal-code -delivery-address,electronic-address,telecom-service-identifier -delivery-address,electronic-address,telecom-service-addreess -billing-address,postal-address,name-of-person-or-institution,name-of-person -billing-address,postal-address,name-of-person-or-institution,name-of-institution -billing-address,postal-address,extended-postal-delivery-address -billing-address,postal-address,street-and-number -billing-address,postal-address,post-office-box -billing-address,postal-address,city -billing-address,postal-address,region -billing-address,postal-address,country -billing-address,postal-address,postal-code -billing-address,electronic-address,telecom-service-identifier -billing-address,electronic-address,telecom-service-addreess -ill-service-type -requester-optional-messages,can-send-RECEIVED -requester-optional-messages,can-send-RETURNED -requester-optional-messages,requester-SHIPPED -requester-optional-messages,requester-CHECKED-IN -search-type,level-of-service -search-type,need-before-date -search-type,expiry-date -search-type,expiry-flag -place-on-hold -client-id,client-name -client-id,client-status -client-id,client-identifier -item-id,item-type -item-id,call-number -item-id,author -item-id,title -item-id,sub-title -item-id,sponsoring-body -item-id,place-of-publication -item-id,publisher -item-id,series-title-number -item-id,volume-issue -item-id,edition -item-id,publication-date -item-id,publication-date-of-component -item-id,author-of-article -item-id,title-of-article -item-id,pagination -item-id,ISBN -item-id,ISSN -item-id,additional-no-letters -item-id,verification-reference-source -copyright-complicance -retry-flag -forward-flag -requester-note -forward-note - - - También hay unos pocos parámetros que son parte del Paquete - de Solicitud de Servicios Extendidos y el paquete ItemOrder: - - -package-name -user-id -contact-name -contact-phone -contact-email -itemorder-item - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/yaz/functions/yaz-present.xml b/reference/yaz/functions/yaz-present.xml deleted file mode 100644 index a0db4b1e92..0000000000 --- a/reference/yaz/functions/yaz-present.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - yaz_present - - Se prepara para la recuperación (Z39.50 presente) - - - - &reftitle.description; - - boolyaz_present - resourceid - - - Esta función se prepara para la recuperación de archivos después de una búsqueda exitosa. - - - La función yaz_range debe ser llamado antes de esta función - para especificar el rango de registros a ser recuperados. - - - - &reftitle.parameters; - - - - id - - - El recurso de conexión devuelto por yaz_connect. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/yaz/functions/yaz-range.xml b/reference/yaz/functions/yaz-range.xml deleted file mode 100644 index bd47873b05..0000000000 --- a/reference/yaz/functions/yaz-range.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - yaz_range - - Específica un rango de registros a recuperar - - - - &reftitle.description; - - voidyaz_range - resourceid - intstart - intnumber - - - Específica un rango de registros a recuperar. - - - Esta función debería ser llamada antes de yaz_search o - yaz_present. - - - - &reftitle.parameters; - - - - id - - - El recurso de conexión retornado por yaz_connect. - - - - - start - - - Especifíca la posición del primer registro a ser recuperado. Los - registros numéricos van de 1 a yaz_hits. - - - - - number - - - Específica un rango de registros a recuperar. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/yaz/functions/yaz-record.xml b/reference/yaz/functions/yaz-record.xml deleted file mode 100644 index 0577a9c719..0000000000 --- a/reference/yaz/functions/yaz-record.xml +++ /dev/null @@ -1,308 +0,0 @@ - - - - - - - - yaz_record - Devuelve un registro - - - &reftitle.description; - - stringyaz_record - resourceid - intpos - stringtype - - - La función yaz_record inspecciona un registro del - conjunto resultado actual que está en la posición especificada por el parámetro - pos. - - - - &reftitle.parameters; - - - - id - - - El recurso de conexión devuelto por yaz_connect. - - - - - pos - - - La posición del registro. Las posiciones de los registros en el conjunto resultado están numeradas con 1, - 2, ... $hits donde $hits es el contador devuelto por yaz_hits. - - - - - type - - - El parámetro type especifica la forma del - registro devuelto. - - - - Es la aplicación responsable de asegurar - realmente que los registros son devueltos en el formato correcto - por el servidor Z39.50/SRW. El type indicado únicamente especifica una conversión - que se realizará en el lado cliente (en PHP/YAZ). - - - - Además de la conversion del registro transferido a un string/array, PHP/YAZ - también puede realizar una conversión de mapa de caracteres del - registro. Esto es recomendado especialmente para USMARC/MARC21 puesto que - éstos se devuelven habitualmente en el mapa de caracteres MARC-8 que no - está soportado por navegadores, etc. Para especificar una conversión, añadir - ; charset=from, - to donde - from es el mapa de caracteres original - del registro y to es el mapa de caracteres - resultante (desde el punto de vista PHP). - - - - string - - - El registro se devuelve como un string de visualización simple. - En este modo, todos los registros MARC se convierten a un formato línea a línea - ya que ISO2709 es difícilmente legible. - Los registros XML y SUTRS se devuelven en su formato original. - GRS-1 se devuelve en un (feo) formato línea a línea. - - - Este formato es adecuado si los registros se mostrarán de forma - rápida - para depuración - o porque no es factible realizar - una visualización adecuada. - - - - - xml - - - El registro se devuelve como un string XML si es posible. - En este modo, todos los registros MARC se convierten en - MARCXML. - Los registros XML y SUTRS se devuelven en su formato original. - GRS-1 no está soportado. - - - Este formato es parecido a string excepto por los - registros MARC que se convierten a MARCXML - - - Este formato es adecuado si los registros se procesan posteriormente por un interpretador XML - o un procesador XSLT . - - - - - raw - - - El registro se devuelve como un string en su formato original. - Este tipo es adecuado para MARC, XML y SUTRS. No funciona con - GRS-1. - - - Los registros MARC se devuelven como un string ISO2709. XML y SUTRS son - devueltos como strings. - - - - - syntax - - - La sintaxis del registro se devuelve como un string, p.e. - USmarc, GRS-1, - XML, etc. - - - - - database - - - El nombre de la base de datos asociada con el registro en la posición, - se devuelve como un string. - - - - - array - - - El registro se devuelve como un array que refleja la estructura - GRS-1. Este tipo es adecuado para MARC y GRS-1. XML, SUTRS - no están soportados y si el registro actual es XML o SUTRS se - devolverá un string vacío. - - - El array devuelto consiste en una lista correspondiente a - cada hoja/nodo interno de GRS-1. Cada lista de elementos consiste en - una sublista con el primer elemento path y - data (si los datos están disponibles). - - - El camino de acceso, que es un string, contiene una lista de tres componentes (del - registro estructurado GRS-1) de la raíz a la hoja. Cada componente es - un par de tipo etiqueta/valor de etiqueta de la forma - (type, - value - - - Las etiguqetas normalmente tienen un tipo tag 3. - MARC también puede ser devuelto como un array (se convierten a - GRS-1 internamente). - - - - - - - - - - - &reftitle.returnvalues; - - Devuelve el registro que se encuentra en la posición pos o un string - vacío si no existe ningún registro en la posición indicada. - - - Si no hay registro en la posición indicada en la base de datos, se devolverá un string - vacío. - - - - &reftitle.examples; - - Array para registro GRS-1 - - Considerar este registro GRS-1 : - - - - Este registro tiene dos nodos a nivel de raíz. El primer elemento del nivel raíz es - (4,52) [tipo tag 4, valor de tag 52], y tiene datos Robert M. - Pirsig. El segundo elemento en el nivel raíz (4,70) tiene un subárbol con - un elemento simple (4,90). (4,90) tiene a su vez otro subárbol (2,7) con datos - Transworld Publishers, ltd.. - - - Si este registro está presente en la posición $p, entonces - - -]]> - - mostrará: - - Array - ( - [0] => (4,52) - [1] => Robert M. Pirsig - ) - [1] => Array - ( - [0] => (4,70) - ) - [2] => Array - ( - [0] => (4,70)(4,90) - ) - [3] => Array - ( - [0] => (4,70)(4,90)(2,7) - [1] => Transworld Publishers, ltd. - ) -) -]]> - - - - - Trabajar con MARCXML - - El siguiente fragmento de PHP devuelve un registro MARC21/USMARC como MARCXML. - El registro original se devuelve en marc-8 (desconocido para muchos interpretadores XML), - así que lo convertimos a UTF-8 (que todos los interpretadores XML deben soportar). - - -]]> - - - - El registro $rec puede ser procesado con el - procesador Sablotron XSLT de la forma siguiente: - - - - $rec); -$res = xslt_process($processor, 'arg:/_xml', $xslfile, NULL, $parms); -xslt_free($processor); -$res = preg_replace("']*>'", '', $res); -echo $res; - -?> -]]> - - - - - - - diff --git a/reference/yaz/functions/yaz-scan-result.xml b/reference/yaz/functions/yaz-scan-result.xml deleted file mode 100644 index b7bb0ee3e2..0000000000 --- a/reference/yaz/functions/yaz-scan-result.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - - yaz_scan_result - Devuelve el resultado de un escaneado - - - &reftitle.description; - - arrayyaz_scan_result - resourceid - arrayresult - - - yaz_scan_result devuelve una tabla con los términos y la información - asociada tal y como fue recibida del servidor en la última función - yaz_scan realizada. - - - - &reftitle.parameters; - - - - id - - - El recurso de conexión asociado por yaz_connect. - - - - - result - - - Si se indica, este array será modificado para contener información adicional - tomada de la respuesta del scan: - - - - number - Número de entradas devueltas - - - - - stepsize - Tamaño del paso - - - - - position - Posición del término - - - - - status - Estado del escaneo - - - - - - - - - - - &reftitle.returnvalues; - - Devuelve un array (0..n-1) donde n es el número de elementos devuetos. Cada - valor es un par donde el primer elemento es el término, y el segundo es - el contador de resultados. - - - - - diff --git a/reference/yaz/functions/yaz-scan.xml b/reference/yaz/functions/yaz-scan.xml deleted file mode 100644 index d9b0954d8c..0000000000 --- a/reference/yaz/functions/yaz-scan.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - - - yaz_scan - Prepara para un escaneo YAZ - - - &reftitle.description; - - voidyaz_scan - resourceid - stringtype - stringstartterm - arrayflags - - - Esta función prepara para una solicitud "Z39.50 Scan Request" en la conexión YAZ - especificada. - - - Para transferir realmente la "Scan Request" del servidor y recibir la - "Scan Response", debe llamarse yaz_wait. Después - de la finalización de la llamada a yaz_wait, llamar a - yaz_error y yaz_scan_result para - gestionar la respuesta. - - - - &reftitle.parameters; - - - - id - - - El recurso de conexión devuelto por yaz_connect. - - - - - type - - - Actualmente sólo está soportado el tipo rpn . - - - - - startterm - - - Punto de partida del escaneo. - - - La forma en la que el punto de partida es especificado, viene dado por el parámetro - type. - - - La sintaxis de este parámetro es parecido al de la consulta RPN tal y como se describe en - yaz_search. Consiste en cero o más - especificaciones del operador @attr, seguido de - exactamente un token. - - - - - flags - - - Este parámetro opcional describe información adicional para controlar - el comportamiento de la solicitud de escaneo. Tres índices se leen actualmente - del array de marcas: - number (número de términos solicitados), - position (posición preferida del término) y - stepSize (tamaño preferido del paso). - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.examples; - - - función PHP que escanea títulos - - $val) { - echo "$key = $val "; - } - echo '
    '; - while (list($key, list($k, $term, $tcount)) = each($ar)) { - if (empty($k)) continue; - echo ""; - } - echo '
    $term$tcount
    '; - } else { - echo "Error de escaneo. Error: " . yaz_error($id) . "
    "; - } -} -?> -]]> -
    -
    -
    -
    -
    - - diff --git a/reference/yaz/functions/yaz-schema.xml b/reference/yaz/functions/yaz-schema.xml deleted file mode 100644 index 93cb4c5993..0000000000 --- a/reference/yaz/functions/yaz-schema.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - yaz_schema - - Especifica el esquema para la recuperación - - - - &reftitle.description; - - voidyaz_schema - resourceid - stringschema - - - yaz_schema especifica el esquema para la recuperación. - - - Esta función debe ser llamada antes de - yaz_search o yaz_present. - - - - &reftitle.parameters; - - - - id - - - El recurso de conexión devuelto por yaz_connect. - - - - - schema - - - Debe ser especificado como un OID (identificador de objeto) notación de puntos - sin tratar (como 1.2.840.10003.13.4 ) o - como uno de los esquemas conocidos registrados: GILS-schema, - Holdings, Zthes, ... - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/yaz/functions/yaz-search.xml b/reference/yaz/functions/yaz-search.xml deleted file mode 100644 index e402eb0c5d..0000000000 --- a/reference/yaz/functions/yaz-search.xml +++ /dev/null @@ -1,207 +0,0 @@ - - - - - - - - yaz_search - Prepara una búsqueda - - - &reftitle.description; - - boolyaz_search - resourceid - stringtype - stringquery - - - yaz_search prepara una búsqueda en la conexión - dada. - - - Como yaz_connect esta función es no bloqueante y - únicamente prepara una búsqueda para ser ejecutada posteriormente cuando - se llame a la función yaz_wait . - - - - &reftitle.parameters; - - - - id - - - El recurso de conexión devuelto por yaz_connect. - - - - - type - - - Este parámetro representa el tipo de la consulta - únicamente "rpn" - está soportado ahora, en cuyo caso el tercer argumento especifica una consulta de tipo - Type-1 en notación de prefijo de consulta. - - - - - query - - - La consulta RPN es una representación textual de la consulta Type-1 tal y como está - definida por el estandard Z39.50 . Sin embargo, en la representación del texto - utilizada por YAZ se necesita una notación de prefijo, es decir que el operador - precede a los operandos. El string de la consulta es una secuencia de tokens donde - se ignora el espacio en blanco a menos que esté rodeado de dobles comillas. Los Tokens que empiecen - con una arroba (@) se considerarán operadores, - de otro modo, se tratarán como términos de búsqueda. - - - Operadores RPN - - - - - - Sintaxis - Descripción - - - - - @and query1 query2 - intersección de las consultas query1 y query2 - - - @or query1 query2 - unión de las consultas query1 y query2 - - - @not query1 query2 - query1 y no query2 - - - @set name - conjunto resultado de referencia - - - @attrset set query - - especifica el conjunto de atributos para la consulta. Esta construcción sólo se permite - una sola vez - en el inicio de la consulta - - - - @attr [set] type=value query - - aplica atributos a la consulta. El tipo y valor son enteros - especificando el tipo del atributo y valor del atributo respectivamente. - El conjunto, si se informa, especifica el conjunto atributo. - - - - -
    - - Se muestra más información sobre atributos en el sitio - Z39.50 Maintenance Agency. - - - - Si se desea utilizar una notación más amigable, - utilizar el interpretador CCL - functiones yaz_ccl_conf y - yaz_ccl_parse. - - -
    -
    -
    -
    -
    - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - Ejemplos de consulta - - Se puede buscar por términos sencillos, como en el caso siguiente: - - - - que busca documentos donde aparece "computer" . No se han especificado - atributos. - - - La consulta - - - - busca documentos donde aparece "knuth donald" (suponiendo que el - servidor soporta búsqueda de frases). - - - Esta consulta aplica dos atributos para la misma frase. - @attr 1=1003 @attr 4=1 "knuth donald" - El primer atributo es de tipo type 1 (usa Bib-1), el valor del atributo es 1003 - (Autor). - El segundo atributo es de tipo type 4 (estructura), valor 1 (frase), - así que debe buscar documentos donde Donald Knuth es el autor. - - - La consulta - - - - en notación infija tendría el aspecto: (a or b) and ((c or d) not - e). - - - Otro ejemplo, más complejo: - - - - La consulta utiliza el conjunto de atributos GILS . La consulta busca - documentos en los que art aparece en el título (GILS,BIB-1) - y en los que company aparece como Distributor (GILS). - - - -
    - - diff --git a/reference/yaz/functions/yaz-set-option.xml b/reference/yaz/functions/yaz-set-option.xml deleted file mode 100644 index 284c37e259..0000000000 --- a/reference/yaz/functions/yaz-set-option.xml +++ /dev/null @@ -1,163 +0,0 @@ - - - - - - - - yaz_set_option - Configura una o más opciones de la conexión - - - &reftitle.description; - - voidyaz_set_option - resourceid - stringname - stringvalue - - - voidyaz_set_option - resourceid - arrayoptions - - - Configura una o más opciones de la conexión dada. - - - - &reftitle.parameters; - - - - id - - - El recurso de conexión devuelta por yaz_connect. - - - - - name o options - - - Puede ser un string o un array. - - - Si se informa un string, será el nombre de la opción a configurar. Será necesario - especificar su value. - - - Si se informa un array, será un array asociativo (nombre opción - => valor opción). - - - Opciones de Conexión PHP/YAZ - - - - - - Nombre - Descripción - - - - - implementationName - nombre de la implementación del servidor - - - implementationVersion - versión de implementación del servidor - - - implementationId - ID de implementación del servidor - - - schema - - esquema de recuperación. Por defecto, no se utiliza ningún esquema. Configurar esta - opción es equivalente a utilizar la función - yaz_schema - - - - preferredRecordSyntax - - sintaxis del registro para la recuperación. Por defecto, no se utiliza sintaxis. Configurar - esta opción es equivalente a utilizar la función - yaz_syntax - - - - start - - desplazamiento para el primer registro a ser obtenido vía - yaz_search o yaz_present. - El primer registro está numerado con un valor inicial de 0. El segundo registro tiene - valor de inicio 1. - Configurar esta opción en combinación con la opción - count tiene el mismo efecto que llamar a - yaz_range excepto que los registros están - numerados a partir de de 1 con yaz_range - - - - count - número máximo de registros a recuperar vía - yaz_search o yaz_present. - - - - elementSetName - nombre del conjunto de elementos para la recuperación. Configurar esta opción es - equivalente a llamar a yaz_element. - - - - -
    -
    -
    - - value - - - El nuevo valor de la opción. Utilizar este parámetro únicamente si el argumento previo es - un string. - - - -
    -
    -
    - - &reftitle.returnvalues; - - &return.void; - - -
    - - diff --git a/reference/yaz/functions/yaz-sort.xml b/reference/yaz/functions/yaz-sort.xml deleted file mode 100644 index 4561f5e38e..0000000000 --- a/reference/yaz/functions/yaz-sort.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - - - yaz_sort - Configura los criterios de búsqueda - - - &reftitle.description; - - voidyaz_sort - resourceid - stringcriteria - - - Esta función configura los criterios de búsqueda y activa la ordenación Z39.50 . - - - LLamar a esta función antes de yaz_search. - Utilizar esta función por si sola no tiene ningún efecto. Cuando se usa en conjunción - con yaz_search, una ordenación Z39.50 se enviará después de que la - respuesta de la búsqueda ha sido recibida y antes de que cualquier registro sea recuperado con - Z39.50 Present (yaz_present. - - - - &reftitle.parameters; - - - - id - - - El recurso de conexión devuelto por yaz_connect. - - - - - criteria - - - Un string que toma la forma field1 flags1 field2 - flags2 donde field1 especifica los atributos primarios para - ordenar, field2 los secundarios, etc.. - - - El campo especifica ya sea combinaciones de atributos numéricos consistentes - de pares type=value separados por una coma (p.e. 1=4,2=1) - ; o el campo debe especificar un string con el criterio (p.e. - título). Los flags son secuencias de los caracteres - siguientes que no pueden estar separados por ningún espacio. - - - - Banderas de ordenación - - a - - - Ordenar de forma ascendente - - - - - d - - - Ordenar de forma descendente - - - - - i - - - No diferenciar entre mayúsculas o minúsculas en la ordenación - - - - - s - - - Diferenciar entre mayúsculas o minúsculas en la ordenación - - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.examples; - - Criterios de Ordenación - - Para ordenar con el título de atributo Bib1e, sin diferenciar mayúsculas o minúsculas, y de forma ascendente, - utilizar el siguiente criterio de ordenación: - - - - - - Si el criterio de ordenación secundario fuera el autor, diferenciando mayúsculas y minúsculas y - de forma ascendente, se usaría: - - - - - - - - - diff --git a/reference/yaz/functions/yaz-syntax.xml b/reference/yaz/functions/yaz-syntax.xml deleted file mode 100644 index 7da3b2480b..0000000000 --- a/reference/yaz/functions/yaz-syntax.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - yaz_syntax - - Especifica la sintaxis de registro preferida para la recuperación - - - - &reftitle.description; - - voidyaz_syntax - resourceid - stringsyntax - - - yaz_syntax especifica la sintaxis de registro preferida para - la recuperación - - - Esta función debe ser llamada antes de yaz_search o - yaz_present. - - - - &reftitle.parameters; - - - - id - - - El recurso de conexión devuelto por yaz_connect. - - - - - syntax - - - La sintaxis debe especificarse como un OID (identificador de objeto) en una - notación de puntos sin tratar (como 1.2.840.10003.5.10) o como una - de las sintaxis conocidas (sutrs, usmarc, grs1, xml, etc.). - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/yaz/functions/yaz-wait.xml b/reference/yaz/functions/yaz-wait.xml deleted file mode 100644 index f769975d5f..0000000000 --- a/reference/yaz/functions/yaz-wait.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - yaz_wait - Espera que las peticiones Z39.50 se completeten - - - &reftitle.description; - - mixedyaz_wait - arrayoptions - - - Esta función lleva a cabo en red (bloqueada) la actividad para la - solicitudes pendientes que han sido preparados por las funciones - yaz_connect, yaz_search, - yaz_present, yaz_scan y - yaz_itemorder. - - - yaz_wait devuelve cuando todos los servidores han - completado todas las solicitudes o abortado (en caso de error). - - - - &reftitle.parameters; - - - - options - - - Un array asociativo de opciones: - - - timeout - - - Establece el tiempo de espera en segundos. Si un servidor no ha respondido en el - tiempo de espera se considera muerto y retorna yaz_wait. - El valor por omisión de tiempo de espera es de 15 segundos. - - - - - event - - - Un boolean. - - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - En modo evento, retorna un recurso &return.falseforfailure;. - - - - - diff --git a/reference/yaz/reference.xml b/reference/yaz/reference.xml deleted file mode 100644 index 5d96a1c0a2..0000000000 --- a/reference/yaz/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - &Functions; de YAZ - - &reference.yaz.entities.functions; - - - - diff --git a/reference/yaz/setup.xml b/reference/yaz/setup.xml deleted file mode 100644 index 555193e600..0000000000 --- a/reference/yaz/setup.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - Obtenga YAZ (admite ANSI/NISO Z39.50) e instálelo. - YAZ se puede obtener desde el código fuente o en varios paquetes preconstruidos - desde el archivo YAZ. - Los sistemas como Debian GNU/Linux, Suse Linux, FreeBSD también tienen YAZ - como parte de su distribución. - -
    - - - - &reference.yaz.configure; - - -
    - - - diff --git a/reference/zmq/book.xml b/reference/zmq/book.xml deleted file mode 100644 index df48fd5ac0..0000000000 --- a/reference/zmq/book.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - ZMQ - Mensajería de 0MQ - - - &reftitle.intro; - - &warn.experimental; - "ØMQ es una biblioteca software que permite diseñar e implementar rápidamente una aplicación basada en mensajes." --Sitio web de 0MQ - - - Para más información acerca de 0MQ, visite &url.zeromq;. - - - - &reference.zmq.setup; - - &reference.zmq.zmq; - &reference.zmq.zmqexception; - - &reference.zmq.zmqcontext; - &reference.zmq.zmqcontextexception; - - &reference.zmq.zmqsocket; - &reference.zmq.zmqsocketexception; - - &reference.zmq.zmqpoll; - &reference.zmq.zmqpollexception; - - &reference.zmq.zmqdevice; - &reference.zmq.zmqdeviceexception; - - - - diff --git a/reference/zmq/setup.xml b/reference/zmq/setup.xml deleted file mode 100644 index 49ca859bd5..0000000000 --- a/reference/zmq/setup.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - - &reftitle.setup; - -
    - &reftitle.required; - - La extensión ZMQ requiere la version 2.0.7 o superior de 0MQ. 0MQ se puede adquirir en &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 deleted file mode 100644 index 84446e1537..0000000000 --- a/reference/zmq/zmq.xml +++ /dev/null @@ -1,783 +0,0 @@ - - - - - - - La clase ZMQ - ZMQ - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - ZMQ - - - - - ZMQ - - - - &Constants; - - const - int - ZMQ::SOCKET_PAIR - - - const - int - ZMQ::SOCKET_PUB - - - const - int - ZMQ::SOCKET_SUB - - - const - int - ZMQ::SOCKET_REQ - - - const - int - ZMQ::SOCKET_REP - - - const - int - ZMQ::SOCKET_XREQ - - - const - int - ZMQ::SOCKET_XREP - - - const - int - ZMQ::SOCKET_PUSH - - - const - int - ZMQ::SOCKET_PULL - - - const - int - ZMQ::SOCKET_ROUTER - - - const - int - ZMQ::SOCKET_DEALER - - - const - int - ZMQ::SOCKET_XPUB - - - const - int - ZMQ::SOCKET_XSUB - - - const - int - ZMQ::SOCKET_STREAM - - - const - int - ZMQ::SOCKOPT_HWM - - - const - int - ZMQ::SOCKOPT_SNDHWM - - - const - int - ZMQ::SOCKOPT_RCVHWM - - - const - int - ZMQ::SOCKOPT_AFFINITY - - - const - int - ZMQ::SOCKOPT_IDENTITY - - - const - int - ZMQ::SOCKOPT_SUBSCRIBE - - - const - int - ZMQ::SOCKOPT_UNSUBSCRIBE - - - const - int - ZMQ::SOCKOPT_RATE - - - const - int - ZMQ::SOCKOPT_RECOVERY_IVL - - - const - int - ZMQ::SOCKOPT_RECONNECT_IVL - - - const - int - ZMQ::SOCKOPT_RECONNECT_IVL_MAX - - - const - int - ZMQ::SOCKOPT_MCAST_LOOP - - - const - int - ZMQ::SOCKOPT_SNDBUF - - - const - int - ZMQ::SOCKOPT_RCVBUF - - - const - int - ZMQ::SOCKOPT_RCVMORE - - - const - int - ZMQ::SOCKOPT_TYPE - - - const - int - ZMQ::SOCKOPT_LINGER - - - const - int - ZMQ::SOCKOPT_BACKLOG - - - const - int - ZMQ::SOCKOPT_MAXMSGSIZE - - - const - int - ZMQ::SOCKOPT_SNDTIMEO - - - const - int - ZMQ::SOCKOPT_RCVTIMEO - - - const - int - ZMQ::SOCKOPT_IPV4ONLY - - - const - int - ZMQ::SOCKOPT_LAST_ENDPOINT - - - const - int - ZMQ::SOCKOPT_TCP_KEEPALIVE_IDLE - - - const - int - ZMQ::SOCKOPT_TCP_KEEPALIVE_CNT - - - const - int - ZMQ::SOCKOPT_TCP_KEEPALIVE_INTVL - - - const - int - ZMQ::SOCKOPT_TCP_ACCEPT_FILTER - - - const - int - ZMQ::SOCKOPT_TCP_ACCEPT_FILTER - - - const - int - ZMQ::SOCKOPT_DELAY_ATTACH_ON_CONNECT - - - const - int - ZMQ::SOCKOPT_XPUB_VERBOSE - - - const - int - ZMQ::SOCKOPT_ROUTER_RAW - - - const - int - ZMQ::SOCKOPT_IPV6 - - - const - int - ZMQ::CTXOPT_MAX_SOCKETS - - - const - int - ZMQ::POLL_IN - - - const - int - ZMQ::POLL_OUT - - - const - int - ZMQ::MODE_NOBLOCK - - - const - int - ZMQ::MODE_DONTWAIT - - - const - int - ZMQ::MODE_SNDMORE - - - const - int - ZMQ::ERR_INTERNAL - - - const - int - ZMQ::ERR_EAGAIN - - - const - int - ZMQ::ERR_ENOTSUP - - - const - int - ZMQ::ERR_EFSM - - - const - int - ZMQ::ERR_ETERM - - - &Methods; - - - - -
    - - -
    - &reftitle.constants; -
    - Tipos de constantes de ZMQ - - - - ZMQ::SOCKET_PAIR - - Patrón de par exclusivo - - - - - ZMQ::SOCKET_PUB - - Socket publicador - - - - - ZMQ::SOCKET_SUB - - Socket suscriptor - - - - - ZMQ::SOCKET_REQ - - Socket de petición - - - - - ZMQ::SOCKET_REP - - Socket de respuesta - - - - - ZMQ::SOCKET_XREQ - - Alias de SOCKET_DEALER - - - - - ZMQ::SOCKET_XREP - - Alias de SOCKET_ROUTER - - - - - ZMQ::SOCKET_PUSH - - Socket "push" ascendente de tubería - - - - - ZMQ::SOCKET_PULL - - Socket "pull" descendente de tubería - - - - - ZMQ::SOCKET_ROUTER - - Socket REP ampliado que puede dirigir réplicas a solicitantes - - - - - ZMQ::SOCKET_DEALER - - Sokect REQ ampliado que equilibra a todos los pares conectados - - - - - ZMQ::SOCKET_XPUB - - Similar a SOCKET_PUB, excepto que se pueden recibir suscripciones como mensajes. - El mensaje de suscripción es 0 (cancelar suscripción) o 1 (suscribirse) seguido del tema. - - - - - ZMQ::SOCKET_XSUB - - Similar a SOCKET_SUB, excepto que se puede enviar suscripciones como mensajes. Véase SOCKET_XPUB para el formato. - - - - - ZMQ::SOCKET_STREAM - - Utilizada para enviar y recibir datos TCP de un par que no sea ØMQ. Disponible si se compila con ZeroMQ 4.0 o superior (Valor: &integer;). - - - - - ZMQ::SOCKOPT_HWM - - La marca de agua para mensajes entrantes y salientes es un límite firme sobre el número máximo de mensajes salientes que ØMQ pondrá en cola en la memoria para cualquier único par con que se comunique el socket especificado. Establecer esta opción en un socket solamente afectará a las conexiones realizadas después de haber establecido esta opción. En ZeroMQ 3.x esto es una envoltura para establecer tanto SNDHWM como RCVHWM. (Valor: &integer;). - - - - - ZMQ::SOCKOPT_SNDHWM - - La opción ZMQ_SNDHWM establece la marca de agua alta para mensajes salientes en el socket especificado. Disponible si se compila con ZeroMQ 3.0 o superior (Valor: &integer;). - - - - - ZMQ::SOCKOPT_RCVHWM - - La opción SOCKOPT_RCVHWM establece la marca de agua alta para mensajes entrantes en el socket especificado. Disponible si se compila con ZeroMQ 3.0 o superior (Valor: &integer;). - - - - - ZMQ::SOCKOPT_AFFINITY - - Establecer la afinidad del hilo de E/S (Valor: &integer;) - - - - - ZMQ::SOCKOPT_IDENTITY - - Establecer la identidad del socket identity (Valor: &string;) - - - - - ZMQ::SOCKOPT_SUBSCRIBE - - Establecer un filtro para mensajes. Válido para socket suscriptores socket (Valor: &string;) - - - - - ZMQ::SOCKOPT_UNSUBSCRIBE - - Eliminar un filtro para mensajes. Válido para socket suscriptores (Valor: &string;) - - - - - ZMQ::SOCKOPT_RATE - - Establecer la tasa para los socket de multidifusión (pgm) (Valor: &integer; >= 0) - - - - - ZMQ::SOCKOPT_RECOVERY_IVL - - Establecer el intervalo de recuperación de la multidifusión (Valor: &integer; >= 0) - - - - - ZMQ::SOCKOPT_RECONNECT_IVL - - Establecer el intervañp de reconexión inicial (Valor: &integer; >= 0) - - - - - ZMQ::SOCKOPT_RECONNECT_IVL_MAX - - Establecer el intervalo de reconexión máximo (Valor: &integer; >= 0) - - - - - ZMQ::SOCKOPT_MCAST_LOOP - - Controlar el loopback de la multidifusión (Valor: &integer; >= 0) - - - - - ZMQ::SOCKOPT_SNDBUF - - Establecer el tamaño del buffer de transmisión del kernel (Valor: &integer; >= 0) - - - - - ZMQ::SOCKOPT_RCVBUF - - Establecer el tamaño del buffer de recepción del kernel (Valor: &integer; >= 0) - - - - - ZMQ::SOCKOPT_RCVMORE - - Recibir mensajes multiparte (Valor: &integer;) - - - - - ZMQ::SOCKOPT_TYPE - - Obtener el tipo de socket. Válido para getSockOpt (Valor: &integer;) - - - - - ZMQ::SOCKOPT_LINGER - - El valor de permanencia ("linger") del socket. Especifica cuánto quedará esperando el socket - intentando volcar mensajes después de haber sido cerrado (Valor: &integer;) - - - - - ZMQ::SOCKOPT_BACKLOG - - La opción SOCKOPT_BACKLOG establece la longitud máxima de la cola de las conexiones de pares salientes para el socket especificado; esto solamente se aplica a transportes orientados a conexión. (Valor: &integer;) - - - - - ZMQ::SOCKOPT_MAXMSGSIZE - - Limita el tamaño máximo del mensaje entrante. Un valor de -1 significa sin límite. Disponible si se compila con ZeroMQ 3.0 o superior (Valor: &integer;) - - - - - ZMQ::SOCKOPT_SNDTIMEO - - Establecer el tiempo de espera para la operación de envío del socket. Un valor de -1 significa sin límite. Disponible si se compila con ZeroMQ 3.0 o superior (Valor: &integer;) - - - - - ZMQ::SOCKOPT_RCVTIMEO - - Establecer el tiempo de espera para la operación de recepción del socket. Un valor de -1 significa sin límite. Disponible si se compila con ZeroMQ 3.0 o superior (Valor: &integer;) - - - - - ZMQ::SOCKOPT_IPV4ONLY - - Deshabilitar el soporte para IPV6 si es 1. Disponible si se compila con ZeroMQ 3.x (Valor: &integer;) - - - - - ZMQ::SOCKOPT_LAST_ENDPOINT - - Obtener el último extremo conectado - para emplear con puertos comodín *. Disponible si se compila con ZeroMQ 3.0 o superior (Valor: &string;) - - - - - ZMQ::SOCKOPT_TCP_KEEPALIVE_IDLE - - Tiempo de inactividad para el mensaje "keepalive" de TCP. Disponible si se compila con ZeroMQ 3.0 o superior (Valor: &integer;) - - - - - ZMQ::SOCKOPT_TCP_KEEPALIVE_CNT - - Cuante de tiempo para el mensaje "keepalive" de TCP. Disponible si se compila con ZeroMQ 3.0 o superior (Valor: &integer;) - - - - - ZMQ::SOCKOPT_TCP_KEEPALIVE_INTVL - - Intervalo para el mensaje "keepalive" de TCP. Disponible si se compila con ZeroMQ 3.0 o superior (Valor: &integer;) - - - - - ZMQ::SOCKOPT_DELAY_ATTACH_ON_CONNECT - - Establecer un string CIDR para comparar con conexiones TCP entrantes. Disponible si se compila con ZeroMQ 3.0 o superior (Valor: &string;) - - - - - ZMQ::SOCKOPT_TCP_ACCEPT_FILTER - - Establecer un string CIDR para comparar con conexioines TCP entrantes. Disponible si se compila con ZeroMQ 3.0 o superior (Valor: &string;) - - - - - ZMQ::SOCKOPT_XPUB_VERBOSE - - Establcer el XPUB para recibir un mensaje de aplicación en cada instancia de una subscripción. Disponible si se compila con ZeroMQ 3.0 o superior (Valor: &string;) - - - - - ZMQ::SOCKOPT_ROUTER_RAW - - Establece el modo puro ("raw") del ROUTER, cuando se establece a 1. En el modo puro, al usar el transporte tcp://, el socket leerá y escribirá sin el encuadrre de ZeroMQ. - Disponible si se compila con ZeroMQ 4.0 o superior (Valor: &string;) - - - - - ZMQ::SOCKOPT_IPV6 - - Habilitar IPV6. Disponible si se compila con ZeroMQ 4.0 o superior (Valor: &string;) - - - - - ZMQ::CTXOPT_MAX_SOCKETS - - El límite de socket para este contexto. Disponible si se compila con ZeroMQ 3.x o superior (Valor: &integer;) - - - - - ZMQ::POLL_IN - - Sondeo para datos entrantes - - - - - ZMQ::POLL_OUT - - Sondeo para datos salientes - - - - - ZMQ::MODE_NOBLOCK - - Operación de no espera. Obsoleta, emplee ZMQ::MODE_DONTWAIT en su lugar - - - - - ZMQ::MODE_DONTWAIT - - Operación de no espera - - - - - ZMQ::MODE_SNDMORE - - Enviar un mensaje multiparte - - - - - ZMQ::DEVICE_FORWARDER - - Dispositivo reenviador - - - - - ZMQ::DEVICE_QUEUE - - Dispositivo de cola - - - - - ZMQ::DEVICE_STREAMER - - Dispositivo de flujo - - - - - ZMQ::ERR_INTERNAL - - Error interno de la extensión ZMQ - - - - - ZMQ::ERR_EAGAIN - - Implica que la operación debería esperar esperar cuando se emplee ZMQ::MODE_DONTWAIT - - - - - ZMQ::ERR_ENOTSUP - - La operación no está soportada por el tipo de socket - - - - - ZMQ::ERR_EFSM - - La operación no se pudo ejecutar debido a que el socket no está en un estado correcto - - - - - ZMQ::ERR_ETERM - - El contexto ha sido finalizado - - - - -
    -
    - - - -
    - - &reference.zmq.entities.zmq; - -
    - - diff --git a/reference/zmq/zmq/construct.xml b/reference/zmq/zmq/construct.xml deleted file mode 100644 index 2926c5fc1b..0000000000 --- a/reference/zmq/zmq/construct.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - ZMQ::__construct - El constructor de ZMQ - - - - &reftitle.description; - - private ZMQ::__construct - - - - Constructor privado para evitar la inicialización directa. Esta clase mantiene las constantes para la extensión ZMQ. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/zmq/zmqcontext.xml b/reference/zmq/zmqcontext.xml deleted file mode 100644 index 568fde4a53..0000000000 --- a/reference/zmq/zmqcontext.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - La clase ZMQContext - ZMQContext - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - ZMQContext - - - - - ZMQContext - - - - - &Methods; - - - - -
    - -
    - - &reference.zmq.entities.zmqcontext; - -
    - - diff --git a/reference/zmq/zmqcontext/construct.xml b/reference/zmq/zmqcontext/construct.xml deleted file mode 100644 index 15ac1c59dd..0000000000 --- a/reference/zmq/zmqcontext/construct.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - ZMQContext::__construct - Construir un nuevo objeto ZMQContext - - - - &reftitle.description; - - public ZMQContext::__construct - intio_threads1 - boolis_persistent&true; - - - Construye un nuevo contexto ZMQ. Este se emplea para inicializar sockets. Se requiere una conexión persistente - para inicializar sockets persistentes. - - - - - &reftitle.parameters; - - - - io_threads - - - Número de hilos de entrada/salida del contexto. - - - - - is_persistent - - - Si el contexto es persistente. Los contextos persistentes se almacenan - durante múltiples peticiones, por lo que son un requisito para los sockets persistentes. - - - - - - - - - &reftitle.errors; - - Lanza una ZMQContextException si la inicialización del contexto falla. - - - - - &reftitle.examples; - - - Un ejemplo de <function>ZMQContext</function> - - Construir un nuevo contexto y asignarle un socket de petición - - -getSocket(ZMQ::SOCKET_REQ, 'my sock'); - -/* Conectar con el socket */ -$socket->connect("tcp://example.com:1234"); - -/* Enviar una petición */ -$socket->send("Hello there"); - -/* Recibir la respuesta */ -$message = $socket->recv(); -?> -]]> - - - - - - - - diff --git a/reference/zmq/zmqcontext/getopt.xml b/reference/zmq/zmqcontext/getopt.xml deleted file mode 100644 index b2eedc356f..0000000000 --- a/reference/zmq/zmqcontext/getopt.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - ZMQContext::getOpt - Obtener la opción de contexto - - - - &reftitle.description; - - public mixedZMQContext::getOpt - stringkey - - - Devuelve el valor de una opción de contexto. - - - - - &reftitle.parameters; - - - - key - - - Un entero que representa la opción. - Véanse las constantes ZMQ::CTXOPT_*. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un &string; o un &integer;, dependiendo de key. Lanza - una ZMQContextException en caso de error. - - - - - - - diff --git a/reference/zmq/zmqcontext/getsocket.xml b/reference/zmq/zmqcontext/getsocket.xml deleted file mode 100644 index c51fb5b22b..0000000000 --- a/reference/zmq/zmqcontext/getsocket.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - - ZMQContext::getSocket - Crear un nuevo socket - - - - &reftitle.description; - - public ZMQSocketZMQContext::getSocket - inttype - stringpersistent_id&null; - callableon_new_socket&null; - - - Método rápido para crear nuevos sockets desde un contexto. Si el contexto no es persistente, el parámetro persistent_id - es ignorado y el socket se convierte en no persistente. on_new_socket solamente se invoca - cuando se crea una estructura de socket subyacente. - - - - - &reftitle.parameters; - - - - type - - - Constante ZMQ::SOCKET_* para especificar el tipo de socket. - - - - - persistent_id - - - Si se especifica persistent_id, el socket será persistente durante varias peticiones. - - - - - on_new_socket - - - Función de retrollamada que es ejecutada cuando se crea una nueva estrucutra de socket. Esta función no es invocada - si la conexión persistente subyacente es reutilizada. La retrollamada toma ZMQSocket y persistent_id como dos argumentos. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un objeto ZMQSocket. - - - - - &reftitle.errors; - - Lanza una ZMQSocketException en caso de error. - - - - - &reftitle.examples; - - - Un ejemplo de <function>ZMQContext</function> - - Uso básico - - -getSocket(ZMQ::SOCKET_REQ, 'my sock'); - -/* Conectar con el socket */ -$socket->connect("tcp://example.com:1234"); - -/* Enviar una petición */ -$socket->send("Hello there"); - -/* Recibir la respuesta */ -$message = $socket->recv(); -echo "Received message: {$message}\n"; -?> -]]> - - - - - - - - diff --git a/reference/zmq/zmqcontext/ispersistent.xml b/reference/zmq/zmqcontext/ispersistent.xml deleted file mode 100644 index c0d9e9630a..0000000000 --- a/reference/zmq/zmqcontext/ispersistent.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - ZMQContext::isPersistent - Indicar si el contexto es persistente - - - - &reftitle.description; - - public boolZMQContext::isPersistent - - - - Indica si el contexto es persistente. Un contexto persistente es necesario para conexiones persistentes, - ya que cada socket se asigna a partir de un contexto. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve &true; si el contexto es persistente y &false; si no lo es. - - - - - - - diff --git a/reference/zmq/zmqcontext/setopt.xml b/reference/zmq/zmqcontext/setopt.xml deleted file mode 100644 index db5deb5b70..0000000000 --- a/reference/zmq/zmqcontext/setopt.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - ZMQContext::setOpt - Establecer una opción de socket - - - - &reftitle.description; - - public ZMQContextZMQContext::setOpt - intkey - mixedvalue - - - Establece una opción de contexto de ZMQ. El tipo del valor value depende de key. - Véanse los Tipos de constantes de ZMQ para más información. - - - - - &reftitle.parameters; - - - - key - - - Una de las constantes ZMQ::CTXOPT_*. - - - - - value - - - El valor del parámetro. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto actual. Lanza una ZMQContextException en caso de error. - - - - - - - diff --git a/reference/zmq/zmqcontextexception.xml b/reference/zmq/zmqcontextexception.xml deleted file mode 100644 index 11286e8f6a..0000000000 --- a/reference/zmq/zmqcontextexception.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - La clase ZMQContextException - ZMQContextException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - ZMQContextException - - - - - ZMQContextException - - - - extends - ZMQException - - - - &Properties; - - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - message - - - - - - code - - - - - - file - - - - - - line - - - - - -
    - - - -
    - - -
    - - diff --git a/reference/zmq/zmqdevice.xml b/reference/zmq/zmqdevice.xml deleted file mode 100644 index 10d5a75e58..0000000000 --- a/reference/zmq/zmqdevice.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - La clase ZMQDevice - ZMQDevice - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - ZMQDevice - - - - - ZMQDevice - - - - - &Methods; - - - - -
    - -
    - - &reference.zmq.entities.zmqdevice; - -
    - - diff --git a/reference/zmq/zmqdevice/construct.xml b/reference/zmq/zmqdevice/construct.xml deleted file mode 100644 index 69f7b8fcfe..0000000000 --- a/reference/zmq/zmqdevice/construct.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - - ZMQDevice::__construct - Construir un nuevo dispositivo - - - - &reftitle.description; - - public ZMQDevice::__construct - ZMQSocketfrontend - ZMQSocketbackend - ZMQSocketlistener - - - "Los dispositivos de ØMQ pueden hacer de intermediarios de direcciones, servicios, colas o cualquier abstracción que se defina sobre las capas de mensaje y socket." -- zguide - - - - - &reftitle.parameters; - - - frontend - - - Parámetro "frontend" para los dispositivos. Normalmente donde llegan - los mensajes. - - - - - backend - - - Parámetro "backend" para los dispositivos. Normalmente donde van - los mensajes. - - - - - listener - - - Socket escuchador, el cual recibe una copia de todos los mensajes en ambas direcciones. - El tipo de este socket debería ser SUB, PULL o DEALER. - - - - - - - - &reftitle.returnvalues; - - Una llamada a este método preparará el dispositivo. Normalmente, los dispositivos son procesos de - larga ejecución, por lo que no se recomienda la ejecución de este método desde un script interactivo. Este - método lanza una ZMQDeviceException si el dispositivo no puede iniciarse. - - - - - - - diff --git a/reference/zmq/zmqdevice/getidletimeout.xml b/reference/zmq/zmqdevice/getidletimeout.xml deleted file mode 100644 index d312c0d418..0000000000 --- a/reference/zmq/zmqdevice/getidletimeout.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - ZMQDevice::getIdleTimeout - Obtener el tiempo de espera de inactividad - - - - &reftitle.description; - - public ZMQDeviceZMQDevice::getIdleTimeout - - - - Obtiene el valor del tiempo de espera para la retrollamada de inactividad. Añadido en la versión 1.1.0 de la extensión ZMQ. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Este método devuelve el valor del tiempo de espera de la retrollamada del temporizador. - - - - - - diff --git a/reference/zmq/zmqdevice/gettimertimeout.xml b/reference/zmq/zmqdevice/gettimertimeout.xml deleted file mode 100644 index aea90ce9b2..0000000000 --- a/reference/zmq/zmqdevice/gettimertimeout.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - ZMQDevice::getTimerTimeout - Obtener el tiempo de espera del temporizador - - - - &reftitle.description; - - public ZMQDeviceZMQDevice::getTimerTimeout - - - - Obtiene el valor del tiempo de espera para la retrollamada del temporizador. Añadido en la versión 1.1.0 de la extensión ZMQ. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Este método devuelve el valor del tiempo de espera del temporizador. - - - - - - diff --git a/reference/zmq/zmqdevice/run.xml b/reference/zmq/zmqdevice/run.xml deleted file mode 100644 index 860405b94d..0000000000 --- a/reference/zmq/zmqdevice/run.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - ZMQDevice::run - Ejecutar el nuevo dispositivo - - - - &reftitle.description; - - public voidZMQDevice::run - - - - Ejecuta el dispositivo. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Una llamada a este método hará que quede en espera hasta que el dispositivo esté en ejecución. No se recomienda - que los dispositivos se utilicen desde script interactivos. En caso de fallo, este método lanzará una - ZMQDeviceException. - - - - - - - diff --git a/reference/zmq/zmqdevice/setidlecallback.xml b/reference/zmq/zmqdevice/setidlecallback.xml deleted file mode 100644 index 02ede11642..0000000000 --- a/reference/zmq/zmqdevice/setidlecallback.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - - ZMQDevice::setIdleCallback - Establecer la función de retrollamada de inactividad - - - - &reftitle.description; - - public ZMQDeviceZMQDevice::setIdleCallback - callablecb_func - inttimeout - mixeduser_data - - - Establece la función de retrollamada de inactividad. Si el tiempo de espera está definido, la función de retrollamada de inactividad - será invocada si el bucle de sondeo interno expira sin eventos. Si la función de retrollamada - devuelve false o un valor que se evalúa como false, el dispositivo se detendrá. - - La firma de la función de retrollamada es callback (mixed $datos_usuario). - - - - - &reftitle.parameters; - - - cb_func - - - Función de retrollamada a invocar cuando el dispositivo está inactivo. La devolución de false - o de un valor que se evalú como false por parte de esta función causará la detención - del dispositivo. - - - - - timeout - - - Frecuencia con la que se invoca la retrollamada de inactividad en milisegundos. La retrollamada de inactividad se invoca - periódicamente cuando no hay actividad en el dispositivo. - El valor del tiempo de espera garantiza que haya al menos dicha cantidad de milisegundos entre - invocaciones a la función de retrollamada. - - - - - user_data - - - Datos adcionales a pasar a la función de retrollamada. - - - - - - - - &reftitle.returnvalues; - - En caso de éxito, este método devuelve el objeto actual. - - - - - - - diff --git a/reference/zmq/zmqdevice/setidletimeout.xml b/reference/zmq/zmqdevice/setidletimeout.xml deleted file mode 100644 index c69a0dda89..0000000000 --- a/reference/zmq/zmqdevice/setidletimeout.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - ZMQDevice::setIdleTimeout - Establecer el tiempo de espera para la inactividad - - - - &reftitle.description; - - public ZMQDeviceZMQDevice::setIdleTimeout - inttimeout - - - Establece el valor del tiempo de espera de la retrollamada de inactividad. La retrollamada de inactividad se invoca periódicamente cuando el dispositivo está - inactivo. - - - - - &reftitle.parameters; - - - timeout - - - El valor del tiempo de espera de la retrollamada de inactividad. - - - - - - - - &reftitle.returnvalues; - - En caso de éxito, este método devuelve el objeto actual. - - - - - - - diff --git a/reference/zmq/zmqdevice/settimercallback.xml b/reference/zmq/zmqdevice/settimercallback.xml deleted file mode 100644 index 48c4b4d064..0000000000 --- a/reference/zmq/zmqdevice/settimercallback.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - ZMQDevice::setTimerCallback - Establecer la función de retrollamada del temporizador - - - - &reftitle.description; - - public ZMQDeviceZMQDevice::setTimerCallback - callablecb_func - inttimeout - mixeduser_data - - - Establece la función de retrollamada del temporizador. La retrollamada del temporizador será invocada después de haber - pasado el tiempo de espera. La diferencia entre las retrollamadas de inactividad y del temporizador es que la de inactividad - es invocada solamente cuando el dispositivo está inactivo. - - La firma de la función de retrollamada es callback (mixed $datos_usuario). Se añadió en la verisón 1.1.0 de la extensión ZMQ. - - - - - &reftitle.parameters; - - - cb_func - - - Función de retrollamada a invocar cuando se dispara el temporizador. La devolución de false - o de un valor que se evalúe como false por parte de esta función causará la detención - del dispositivo. - - - - - timeout - - - Frecuencia con la que se invoca la retrollamada del temporizador en milisegundos. La retrollamada del temporizador se invoca - periódicamente. - El valor del tiempo de espera garantiza que haya al menos dicha cantidad de milisegundos entre - invocaciones a la función de retrollamada. - - - - - user_data - - - Datos adcionales a pasar a la función de retrollamada. - - - - - - - - &reftitle.returnvalues; - - En caso de éxito, este método devuelve el objeto actual. - - - - - - - diff --git a/reference/zmq/zmqdevice/settimertimeout.xml b/reference/zmq/zmqdevice/settimertimeout.xml deleted file mode 100644 index abb3557f9a..0000000000 --- a/reference/zmq/zmqdevice/settimertimeout.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - ZMQDevice::setTimerTimeout - Establecer el tiempo de espera del temporizador - - - - &reftitle.description; - - public ZMQDeviceZMQDevice::setTimerTimeout - inttimeout - - - Establece el valor de tiempo de espera de la retrollamada del temporizador. La retrollamada del temporizador se invoca periódicamente si está establecida. - Se añadion en la versión 1.1.0 de la extensión ZMQ. - - - - - &reftitle.parameters; - - - timeout - - - El valor del tiempo de espera de la retrollamada del temporizador. - - - - - - - - &reftitle.returnvalues; - - En caso de éxito, este método devuelve el objeto actual. - - - - - - - diff --git a/reference/zmq/zmqdeviceexception.xml b/reference/zmq/zmqdeviceexception.xml deleted file mode 100644 index d5f18577da..0000000000 --- a/reference/zmq/zmqdeviceexception.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - La clase ZMQDeviceException - ZMQDeviceException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - ZMQDeviceException - - - - - ZMQDeviceException - - - - extends - ZMQException - - - - &Properties; - - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - message - - - - - - code - - - - - - file - - - - - - line - - - - - -
    - - - -
    - - -
    - - diff --git a/reference/zmq/zmqexception.xml b/reference/zmq/zmqexception.xml deleted file mode 100644 index e27c347b1b..0000000000 --- a/reference/zmq/zmqexception.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - La clase ZMQException - ZMQException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - ZMQException - - - - - ZMQException - - - - extends - Exception - - - - &Properties; - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - message - - - - - - code - - - - - - file - - - - - - line - - - - - -
    - - - -
    - - -
    - - diff --git a/reference/zmq/zmqpoll.xml b/reference/zmq/zmqpoll.xml deleted file mode 100644 index 611ee8890b..0000000000 --- a/reference/zmq/zmqpoll.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - La clase ZMQPoll - ZMQPoll - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - ZMQPoll - - - - - ZMQPoll - - - - - &Methods; - - - - -
    - -
    - - &reference.zmq.entities.zmqpoll; - -
    - - diff --git a/reference/zmq/zmqpoll/add.xml b/reference/zmq/zmqpoll/add.xml deleted file mode 100644 index c6935e70b0..0000000000 --- a/reference/zmq/zmqpoll/add.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - ZMQPoll::add - Añadir un elemento al conjunto de sondeo - - - - &reftitle.description; - - public stringZMQPoll::add - mixedentry - inttype - - - Añade un nuevo elemento al conjunto de sondeo y devuelve el ID interno de dicho elemento. El elemento puede ser eliminado - del conjunto de sondeo utilizando el ID devuelto. - - - - - &reftitle.parameters; - - - - entry - - - Un objeto ZMQSocket o un recursode de flujo de PHP - - - - - type - - - Defina la actidad para la que es sondeado el socket - Véanse las constantes ZMQ::POLL_IN y ZMQ::POLL_OUT. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el ID del elemento añadido, el cual puede ser empleado más adelante para eliminar el elemento. - Lanza una ZMQPollException en caso de error. - - - - - - - diff --git a/reference/zmq/zmqpoll/clear.xml b/reference/zmq/zmqpoll/clear.xml deleted file mode 100644 index d6defee205..0000000000 --- a/reference/zmq/zmqpoll/clear.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - ZMQPoll::clear - Limpiar el conjunto de sondeo - - - - &reftitle.description; - - public ZMQPollZMQPoll::clear - - - - Limpia todos los elementos del conjuntos de sondeo. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el objeto actual. - - - - - - - diff --git a/reference/zmq/zmqpoll/count.xml b/reference/zmq/zmqpoll/count.xml deleted file mode 100644 index 54bbb85a70..0000000000 --- a/reference/zmq/zmqpoll/count.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - ZMQPoll::count - Contar los elementos del conjunto de sondeo - - - - &reftitle.description; - - public intZMQPoll::count - - - - Cuenta los elementos del conjunto de sondeo. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un &integer; que representa la cantidad de elementos del conjunto de sondeo. - - - - - - - diff --git a/reference/zmq/zmqpoll/getlasterrors.xml b/reference/zmq/zmqpoll/getlasterrors.xml deleted file mode 100644 index b6ecdff6cf..0000000000 --- a/reference/zmq/zmqpoll/getlasterrors.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - ZMQPoll::getLastErrors - Obtener los errores del sondeo - - - - &reftitle.description; - - public arrayZMQPoll::getLastErrors - - - - Devuelve los ID de los objetos que poseen errores en el último sondeo. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devueve un array que contiene los ID de los elementos que poseen errores en el último sondeo. Se devuelve un - array vacío si no hay errores. - - - - - - - diff --git a/reference/zmq/zmqpoll/poll.xml b/reference/zmq/zmqpoll/poll.xml deleted file mode 100644 index f488c71600..0000000000 --- a/reference/zmq/zmqpoll/poll.xml +++ /dev/null @@ -1,173 +0,0 @@ - - - - - - - ZMQPoll::poll - Sondear los elementos - - - - &reftitle.description; - - public intZMQPoll::poll - arrayreadable - arraywritable - inttimeout-1 - - - Sondea los elementos en el conjunto de sondeo actual. Los elementos legibles y escribibles son devueltos en - los parámetros readable y writable respectivamente. - Se puede utilizar ZMQPoll::getLastErrors para comprobar si existen errores. - - - - - &reftitle.parameters; - - - - readable - - - Un array donde se sevuelven los flujos de PHP/ZMQSockets legibles. El array - se limpiará al inicio de la operación. - - - - - writable - - - Un array donde se sevuelven los flujos de PHP/ZMQSockets escribibles. El array - se limpiará al inicio de la operación. - - - - - timeout - - - Tiempo de espera de la operación. -1 significa que el sondeo esperará hasta - que al menos un elemento tenga actividad. Observe que desde la - versión 1.0.0, el tiempo de espera del sondeo está definido en milisegundos, en lugar - de en microsegundos. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un número entero que representa la cantidad de elementos con actividad. - - - - - &reftitle.errors; - - Lanza una ZMQPollException en caso de error. - - - - - &reftitle.examples; - - - Un ejemplo de <function>ZMQPoll</function> - - Crear un servidor de sondeos sencillo - - -getSocket(ZMQ::SOCKET_REP); - -/* Vincular al puerta 5555 en 127.0.0.1 */ -$server->bind("tcp://127.0.0.1:5555"); - -/* Crear un conjunto de sondeo nuevo para mensajes entrantes/salientes */ -$poll = new ZMQPoll(); - -/* Añadir el objeto y escuchar la entrada/salida del sondeo */ -$id = $poll->add($server, ZMQ::POLL_IN | ZMQ::POLL_OUT); -echo "Se añaió el objeto con id " . $id . "\n"; - -/* Inicializar los arrays readable y writable */ -$readable = array(); -$writable = array(); - -while (true) { - /* Cantidad de eventos recuperados */ - $events = 0; - - try { - /* Sondear hasta que haya algo que hacer */ - $events = $poll->poll($readable, $writable, -1); - $errors = $poll->getLastErrors(); - - if (count($errors) > 0) { - foreach ($errors as $error) { - echo "Error al sondear el objeto " . $error . "\n"; - } - } - } catch (ZMQPollException $e) { - echo "Fallón el sondeo: " . $e->getMessage() . "\n"; - } - - if ($events > 0) { - /* Recorrer los objetos legibles y los mensajes recibidos */ - foreach ($readable as $r) { - try { - echo "Mensaje recibido: " . $r->recv() . "\n"; - } catch (ZMQException $e) { - echo "Falló la recepción: " . $e->getMessage() . "\n"; - } - } - - /* Recorrer los objetos escribibles y enviar de vuelta los mensajes */ - foreach ($writable as $w) { - try { - $w->send("Got it!"); - } catch (ZMQException $e) { - echo "Falló el envío: " . $e->getMessage() . "\n"; - } - } - } -} -?> -]]> - - - - - - - - diff --git a/reference/zmq/zmqpoll/remove.xml b/reference/zmq/zmqpoll/remove.xml deleted file mode 100644 index dda8a102b4..0000000000 --- a/reference/zmq/zmqpoll/remove.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - ZMQPoll::remove - Eliminar un elemento del conjunto de sondeo - - - - &reftitle.description; - - public boolZMQPoll::remove - mixeditem - - - Elimina un elemento del conjunto de sondeo. El parámetro item puede ser un objeto ZMQSocket, - un recurso de flujo o el ID devuelto por el método ZMQPoll::add. - - - - - &reftitle.parameters; - - - - item - - - El objeto ZMQSocket, flujo de PHP o &string; con el ID del elemento. - - - - - - - - - &reftitle.returnvalues; - - Devuelve true si el objeto se eliminó y false si el objeto - con el ID dado no existe en el conjunto de sondeo. - - - - - - - diff --git a/reference/zmq/zmqpollexception.xml b/reference/zmq/zmqpollexception.xml deleted file mode 100644 index bae6e4b60c..0000000000 --- a/reference/zmq/zmqpollexception.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - La clase ZMQPollException - ZMQPollException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - ZMQPollException - - - - - ZMQPollException - - - - extends - ZMQException - - - - &Properties; - - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - message - - - - - - code - - - - - - file - - - - - - line - - - - - -
    - - - -
    - - -
    - - diff --git a/reference/zmq/zmqsocket.xml b/reference/zmq/zmqsocket.xml deleted file mode 100644 index 8d4b3cffe7..0000000000 --- a/reference/zmq/zmqsocket.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - La clase ZMQSocket - ZMQSocket - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - ZMQSocket - - - - - ZMQSocket - - - - - &Methods; - - - - -
    - -
    - - &reference.zmq.entities.zmqsocket; - -
    - - diff --git a/reference/zmq/zmqsocket/bind.xml b/reference/zmq/zmqsocket/bind.xml deleted file mode 100644 index efb19b0f02..0000000000 --- a/reference/zmq/zmqsocket/bind.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - ZMQSocket::bind - Vincular el socket - - - - &reftitle.description; - - public ZMQSocketZMQSocket::bind - stringdsn - boolforce&false; - - - Vincula el socket a un extremo. El extremo está definido en formato transporte://dirección donde - transporte es uno de los siguientes: inproc, ipc, tcp, pgm o epgm. - - - - - &reftitle.parameters; - - - - dsn - - - El DSN del vículo, por ejemplo transporte://dirección. - - - - - force - - - Intenta el vínculo incluso si elm socket ya ha sido vinculado al extremo dado. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto actual. Lanza una ZMQSocketException en caso de error. - - - - - - - diff --git a/reference/zmq/zmqsocket/connect.xml b/reference/zmq/zmqsocket/connect.xml deleted file mode 100644 index a37210c659..0000000000 --- a/reference/zmq/zmqsocket/connect.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - - ZMQSocket::connect - Contectar el socket - - - - &reftitle.description; - - public ZMQSocketZMQSocket::connect - stringdsn - boolforce&false; - - - Contecta el socket a un extremo remoto. El extremo está definido en formato transporte://dirección donde - transporte es uno de los siguientes: inproc, ipc, tcp, pgm o epgm. - - - - - &reftitle.parameters; - - - - dsn - - - El DSN de la conexión, por ejemplo transporte://dirección. - - - - - force - - - Intenta la conexión incluso si elm socket ya ha sido conectado al extremo dado. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto actual. - - - - - &reftitle.errors; - - Lanza una ZMQSocketException en caso de error. - - - - - &reftitle.examples; - - - Un ejemplo de <function>ZMQContext</function> - - Construir un nuevo contexto y asignar un socket de petición - - -getEndpoints(); - -/* Comprobar si el socket está conectado */ -if (!in_array($dsn, $endpoints['connect'])) { - echo "

    Conectando a $dsn

    "; - $socket->connect($dsn); -} else { - echo "

    Ya se ha contectado a $dsn

    "; -} - -/* Enviar y recibir */ -$socket->send("¡Hola!"); -$message = $socket->recv(); - -echo "

    El servidor dice: {$message}

    "; -?> -]]> -
    -
    -
    -
    - -
    - - diff --git a/reference/zmq/zmqsocket/construct.xml b/reference/zmq/zmqsocket/construct.xml deleted file mode 100644 index 51bfe1b052..0000000000 --- a/reference/zmq/zmqsocket/construct.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - - ZMQSocket::__construct - Construir un nuevo ZMQSocket - - - - &reftitle.description; - - public ZMQSocket::__construct - ZMQContextcontext - inttype - stringpersistent_id&null; - callableon_new_socket&null; - - - Construye un objeto ZMQSocket. Se puede utilizar el parámetro persistent_id para asignar un socket - persistente. Un socket persistente tiene que ser asignado desde un contexto persistente, por lo que permanece conectado durante múltiples peticiones. - Se puede emplear el parámetro persistent_id para recordar el mismo socket durante múltiples peticiones. - on_new_socket es llamado solamente cuando se crea un nueva estructura de socket subyacente. - - - - - &reftitle.parameters; - - - - context - - - Un objeto ZMQContext. - - - - - type - - - El tipo de socket. Véanse las constantes ZMQ::SOCKET_*. - - - - - persistent_id - - - Si se especifica persistent_id, el socket será persistente durante múltiples peticiones. - Si context no es persistente, el socket recurrirá al modo no persistente. - - - - - on_new_socket - - - Función de retrollamada que es ejecutada cuando se crea una nueva estrucutra de socket. Esta función no es invocada - si la conexión persistente subyacente es reutilizada. - - - callback - ZMQSocketsocket - stringpersistent_id&null; - - - - - - - - - &reftitle.errors; - - Lanza una ZMQSocketException en caso de error. - - - - - &reftitle.examples; - - - Un ejemplo de <function>ZMQSocket</function> - - Utilizar una callback para bind/connect del socket - - -bind("tcp://localhost:12122"); - } else { - $socket->connect("tcp://localhost:12122"); - } -} - -/* Asignar un nuevo contexto */ -$context = new ZMQContext(); - -/* Crear un nuevo socket */ -$socket = $context->getSocket(ZMQ::SOCKET_REP, 'server', 'on_new_socket_cb'); - -$message = $socket->recv(); -echo "Mensaje recibido: {$message}\n"; -?> -]]> - - - - - - - - diff --git a/reference/zmq/zmqsocket/disconnect.xml b/reference/zmq/zmqsocket/disconnect.xml deleted file mode 100644 index 6112ca63b0..0000000000 --- a/reference/zmq/zmqsocket/disconnect.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - ZMQSocket::disconnect - Desconectar un socket - - - - &reftitle.description; - - public ZMQSocketZMQSocket::disconnect - stringdsn - - - Desconectar el socket de un extremo remoto conectado previamente. El extremo está definido con el formato - transporte://dirección, donde transporte es uno de los siguientes: inproc, ipc, tcp, pgm o epgm. - - - - - &reftitle.parameters; - - - - dsn - - - El DSN de conexión, por ejemplo transporte://dirección. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto actual. Lanza una ZMQSocketException en caso de error. - - - - - - diff --git a/reference/zmq/zmqsocket/getendpoints.xml b/reference/zmq/zmqsocket/getendpoints.xml deleted file mode 100644 index 03042ffab1..0000000000 --- a/reference/zmq/zmqsocket/getendpoints.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - ZMQSocket::getEndpoints - Obtener una lista de los extremos - - - - &reftitle.description; - - public arrayZMQSocket::getEndpoints - - - - Devuelve una lista de los extremos donde el socket está conectado o vinculado. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un array que contiene los elementos 'bind' y 'connect'. - - - - - - diff --git a/reference/zmq/zmqsocket/getpersistentid.xml b/reference/zmq/zmqsocket/getpersistentid.xml deleted file mode 100644 index a93213ab9a..0000000000 --- a/reference/zmq/zmqsocket/getpersistentid.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - ZMQSocket::getPersistentId - Obtener el ID de persistencia - - - - &reftitle.description; - - public stringZMQSocket::getPersistentId - - - - Devuelve el ID de persistencia del socket. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el ID de persistencia asignado al objeto, y &null; si el socket no es persistente. - - - - - - - diff --git a/reference/zmq/zmqsocket/getsockettype.xml b/reference/zmq/zmqsocket/getsockettype.xml deleted file mode 100644 index 73afaad16d..0000000000 --- a/reference/zmq/zmqsocket/getsockettype.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - ZMQSocket::getSocketType - Obtener el tipo de socket - - - - &reftitle.description; - - public intZMQSocket::getSocketType - - - - Obtiene el tipo de socket. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un número entero que representa el tipo de socket. El número entero puede ser comparado con - las constantes ZMQ::SOCKET_* - - - - - - - diff --git a/reference/zmq/zmqsocket/getsockopt.xml b/reference/zmq/zmqsocket/getsockopt.xml deleted file mode 100644 index f4d835fad9..0000000000 --- a/reference/zmq/zmqsocket/getsockopt.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - ZMQSocket::getSockOpt - Obtener la opción de un socket - - - - &reftitle.description; - - public mixedZMQSocket::getSockOpt - stringkey - - - Devuelve el valor de la opción de un socket. - - - - - &reftitle.parameters; - - - - key - - - Un número entero que representa la opción. - Véanse las constantes ZMQ::SOCKOPT_*. - - - - - - - - - &reftitle.returnvalues; - - Devuelve un &string; o un &integer; dependiendo de key. Lanza - una ZMQSocketException en caso de error. - - - - - - - diff --git a/reference/zmq/zmqsocket/ispersistent.xml b/reference/zmq/zmqsocket/ispersistent.xml deleted file mode 100644 index 2fe6f0714a..0000000000 --- a/reference/zmq/zmqsocket/ispersistent.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - - ZMQSocket::isPersistent - Comprobrar si un socket es persistente - - - - &reftitle.description; - - public boolZMQSocket::isPersistent - - - - Comprueba si el socket es persistente. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve un &boolean; basado en si el socket es persistente o no. - - - - - - - diff --git a/reference/zmq/zmqsocket/recv.xml b/reference/zmq/zmqsocket/recv.xml deleted file mode 100644 index de4519d6df..0000000000 --- a/reference/zmq/zmqsocket/recv.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - - ZMQSocket::recv - Recibir un mensaje - - - - &reftitle.description; - - public stringZMQSocket::recv - intmode0 - - - Recibe un mensaje de un socket. Por defecto, la recepción quedará en espera hasta que haya disponible un mensaje, a menos - que se emplee la bandera ZMQ::MODE_DONTWAIT. Se puede emplear la opción de socket - ZMQ::SOCKOPT_RCVMORE para recibir mensajes multiparte. Véase ZMQSocket::setSockOpt - para más información. - - - - - &reftitle.parameters; - - - - mode - - - Proporcionar banderas de modo para recibir mensajes multiparte o hacer que la operación no quede en espera. - Véanse las constantes ZMQ::MODE_*. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el mensaje. Si se emplea ZMQ::MODE_DONTWAIT - y la operación debería quedar en espera, se devolverá &false;. - - - - - &reftitle.errors; - - Lanza una ZMQSocketException en caso de error. - - - - - &reftitle.examples; - - - Un ejemplo de send/recv - - Envío / respuesta sin esperas - - -connect("tcp://127.0.0.1:5555"); - -/* Asginar el socket 1 a la cola, enviar y recibir */ -$reintentos = 5; -$sending = true; - -/* Iniciar y recorrer */ -do { - try { - /* Intentar enviar / recibir */ - if ($sending) { - echo "Enviando el mensaje\n"; - $cola->send("Este es un mensaje", ZMQ::MODE_DONTWAIT); - $sending = false; - } else { - echo "Respuesta obtenida: " . $cola->recv(ZMQ::MODE_DONTWAIT) . "\n"; - break; - } - } catch (ZMQSocketException $e) { - /* EAGAIN significa que la operación tendrá que esperar, reintentar */ - if ($e->getCode() === ZMQ::ERR_EAGAIN) { - echo " - EAGAIN, reintentando ($reintentos)\n"; - } else { - die(" - Error: " . $e->getMessage()); - } - } - /* Dormir un poco entre operaciones */ - usleep(5); -} while (--$reintentos); -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/zmq/zmqsocket/recvmulti.xml b/reference/zmq/zmqsocket/recvmulti.xml deleted file mode 100644 index f00d27d4ba..0000000000 --- a/reference/zmq/zmqsocket/recvmulti.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - - ZMQSocket::recvMulti - Recibir un mensaje multiparte - - - - &reftitle.description; - - public arrayZMQSocket::recvMulti - intmode0 - - - Recibe un array con el mensaje multiparte de un socket. Por defecto, la recepción quedará en espera hasta que haya disponible un mensaje, a menos - que se emplee el flag ZMQ::MODE_*. - - - - - &reftitle.parameters; - - - - mode - - - Proporcionar banderas de modo para recibir mensajes multiparte o hacer que la operación no quede en espera. - Véanse las constantes ZMQ::MODE_*. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el array con las partes del mensaje. Lanza una ZMQSocketException en caso de error. - Si se emplea ZMQ::MODE_NOBLOCK y la operación debería quedar - en espera, se devolverá el &boolean; false. - - - - - - - diff --git a/reference/zmq/zmqsocket/send.xml b/reference/zmq/zmqsocket/send.xml deleted file mode 100644 index 180f28d646..0000000000 --- a/reference/zmq/zmqsocket/send.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - ZMQSocket::send - Enviar un mensaje - - - - &reftitle.description; - - public ZMQSocketZMQSocket::send - stringmessage - intmode0 - - - Envía un mensaje mediante el socket. La operación puede quedar en espera, a menos que se emplee ZMQ::MODE_NOBLOCK. - - - - - &reftitle.parameters; - - - - message - - - El mensaje a enviar. - - - - - mode - - - Proporcionar banderas de modo para recibir mensajes multiparte o hacer que la operación no quede en espera. - Véanse las constantes ZMQ::MODE_*. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto actual. Lanza una ZMQSocketException en caso de error. - Si se emplea ZMQ::MODE_NOBLOCK y la operación debería quedar - en espera, se devolverá el &boolean; false. - - - - - diff --git a/reference/zmq/zmqsocket/sendmulti.xml b/reference/zmq/zmqsocket/sendmulti.xml deleted file mode 100644 index 9a2f2af8b4..0000000000 --- a/reference/zmq/zmqsocket/sendmulti.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - ZMQSocket::sendmulti - Enviar un mensaje multiparte - - - - &reftitle.description; - - public ZMQSocketZMQSocket::sendmulti - arraymessage - intmode0 - - - Envía un mensaje multiparte mediante el socket. La operación puede quedar en espera, a menos que se emplee ZMQ::MODE_NOBLOCK. - - - - - &reftitle.parameters; - - - - message - - - El mensaje a enviar - un array de cadenas - - - - - mode - - - Proporcional flags de modo para recibir mensajes multiparte o hacer que la operación no quede en espera. - Véanse las constantes ZMQ::MODE_*. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto actual. Lanza una ZMQSocketException en caso de error. - Si se emplea ZMQ::MODE_NOBLOCK y la operación debería quedar - en espera, se devolverá el &boolean; false. - - - - - diff --git a/reference/zmq/zmqsocket/setsockopt.xml b/reference/zmq/zmqsocket/setsockopt.xml deleted file mode 100644 index abce9cba73..0000000000 --- a/reference/zmq/zmqsocket/setsockopt.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - ZMQSocket::setSockOpt - Establecer una opción de socket - - - - &reftitle.description; - - public ZMQSocketZMQSocket::setSockOpt - intkey - mixedvalue - - - Establece una opción de socket de ZMQ. El tipo del valor value depende de la clave key. - Véanse los Tipos de constantes de ZMQ para más información. - - - - - &reftitle.parameters; - - - - key - - - Una de las constantes ZMQ::SOCKOPT_*. - - - - - value - - - El valor del parámetro. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto actual. Lanaza una ZMQSocketException en caso de error. - - - - - - - diff --git a/reference/zmq/zmqsocket/unbind.xml b/reference/zmq/zmqsocket/unbind.xml deleted file mode 100644 index 50b99c9f40..0000000000 --- a/reference/zmq/zmqsocket/unbind.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - - ZMQSocket::unbind - Desvincular el socket - - - - &reftitle.description; - - public ZMQSocketZMQSocket::unbind - stringdsn - - - Desvincula el socket de un extremo. El extremo está definido con el formato transporte://dirección, donde - transporte es uno de los siguientes: inproc, ipc, tcp, pgm o epgm. - - - - - &reftitle.parameters; - - - - dsn - - - El DSN vinculado previamente, por ejemplo transporte://dirección. - - - - - - - - - &reftitle.returnvalues; - - Devuelve el objeto actual. Lanaza una ZMQSocketException en caso de error. - - - - - - - diff --git a/reference/zmq/zmqsocketexception.xml b/reference/zmq/zmqsocketexception.xml deleted file mode 100644 index 17b82010f5..0000000000 --- a/reference/zmq/zmqsocketexception.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - La clase ZMQSocketException - ZMQSocketException - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - ZMQSocketException - - - - - ZMQSocketException - - - - extends - ZMQException - - - - &Properties; - - - - &InheritedMethods; - - - - - -
    - - - -
    - &reftitle.properties; - - - message - - - - - - code - - - - - - file - - - - - - line - - - - - -
    - - - -
    - - -
    - - diff --git a/reference/zookeeper/book.xml b/reference/zookeeper/book.xml deleted file mode 100644 index c9982db192..0000000000 --- a/reference/zookeeper/book.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - ZooKeeper - ZooKeeper - - - - &reftitle.intro; - - Esta extensión utiliza la biblioteca libzookeeper para proporcionar una API para comunicarse con el servicio ZooKeeper. - - - ZooKeeper es un proyecto Apache que permite un servicio centralizado para mantener la información de configuración, nombrar, proporcionar sincronización distribuida y proporcionar servicios de grupo. - - - - - &reference.zookeeper.setup; - - &reference.zookeeper.reference; - - &reference.zookeeper.zookeeper; - &reference.zookeeper.zookeeperconfig; - - &reference.zookeeper.zookeeperexception; - &reference.zookeeper.zookeeperauthenticationexception; - &reference.zookeeper.zookeeperconnectionexception; - &reference.zookeeper.zookeepermarshallingexception; - &reference.zookeeper.zookeepernonodeexception; - &reference.zookeeper.zookeeperoperationtimeoutexception; - &reference.zookeeper.zookeepersessionexception; - - - - - diff --git a/reference/zookeeper/configure.xml b/reference/zookeeper/configure.xml deleted file mode 100644 index 7bab28604a..0000000000 --- a/reference/zookeeper/configure.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - -
    - &reftitle.install; - - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;zookeeper. - - - - Para habilitar el soporte de zookeeper, configure con - . DIR es el prefijo de instalación de ZooKeeper C Binding, que debe contener el include/zookeeper/zookeeper.h - - - &pecl.windows.download; - -
    - - - diff --git a/reference/zookeeper/functions/zookeeper_dispatch.xml b/reference/zookeeper/functions/zookeeper_dispatch.xml deleted file mode 100644 index fad615aefc..0000000000 --- a/reference/zookeeper/functions/zookeeper_dispatch.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - zookeeper_dispatch - Llama a las funciones de devolución de llamada para las operaciones pendientes - - - - &reftitle.description; - - voidzookeeper_dispatch - - - - - La función zookeeper_dispatch llama a las funciones de devolución de llamada pasadas por las operaciones como Zookeeper::get o Zookeeper::exists. - - - - - Desde la versión 0.4.0, esta función debe ser llamada manualmente para realizar operaciones asíncronas. Si desea que esto se haga automáticamente, también puede declarar ticks al inicio de su programa. - - - - - Después de PHP 7.1, puede ignorar esta función. Esta extensión usa EG(vm_interrupt) para implementar la distribución asíncrona. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Este método emite una alerta PHP cuando la función de devolución de llamada no puede ser invocada. - - - - - &reftitle.examples; - - Ejemplo de <methodname>zookeeper_dispatch</methodname> #1 - - Distribuir manualmente las funciones de devolución de llamada. - - -connect('localhost:2181'); -$client->get('/zookeeper', function() { - echo "Callback was called".PHP_EOL; -}); -while(true) { - sleep(1); - zookeeper_dispatch(); -} -?> -]]> - - - - - Ejemplo de <methodname>zookeeper_dispatch</methodname> #2 - - Declarar ticks. - - -connect('localhost:2181'); -$client->get('/zookeeper', function() { - echo "Callback was called".PHP_EOL; -}); -while(true) { - sleep(1); -} -?> -]]> - - - - - - &reftitle.seealso; - - - Zookeeper::addAuth - Zookeeper::connect - Zookeeper::__construct - Zookeeper::exists - Zookeeper::get - Zookeeper::getChildren - Zookeeper::setWatcher - - - - - - - diff --git a/reference/zookeeper/ini.xml b/reference/zookeeper/ini.xml deleted file mode 100644 index 2dcc0da276..0000000000 --- a/reference/zookeeper/ini.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - -
    - &reftitle.runtime; - &extension.runtime; - - - - Zookeeper &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - zookeeper.recv_timeout - 10000 - INI_ALL - - - - zookeeper.session_lock - 1 - INI_SYSTEM - - - - zookeeper.sess_lock_wait - 150000 - INI_ALL - - - - -
    - - &ini.php.constants; - -
    - - &ini.descriptions.title; - - - - - - - zookeeper.recv_timeout - int - - - - Tiempo máximo de espera predeterminado para todas las sesiones de ZooKeeper. - - - - - - - zookeeper.session_lock - int - - - - Permite el bloqueo de sesiones PHP. - - - - - - - zookeeper.sess_lock_wait - int - - - - Tiempo de espera en microsegundos para los intentos de bloqueo de la sesión PHP. - Se debe tener precaución al definir este valor. Los valores válidos son enteros, - donde 0 se interpreta como el valor predeterminado. - Los valores negativos provocan un bloqueo reducido a un intento de bloqueo. - - - - - - -
    - - diff --git a/reference/zookeeper/reference.xml b/reference/zookeeper/reference.xml deleted file mode 100644 index e9ff550669..0000000000 --- a/reference/zookeeper/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - ZooKeeper &Functions; - - &reference.zookeeper.entities.functions; - - - - diff --git a/reference/zookeeper/setup.xml b/reference/zookeeper/setup.xml deleted file mode 100644 index 1ed0e87e95..0000000000 --- a/reference/zookeeper/setup.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - Esta extensión requiere ZooKeeper C Binding (version 3.4.1 o superior). - Para más información, véase Guía del programador de ZooKeeper. - -
    - - - - &reference.zookeeper.configure; - - - - - &reference.zookeeper.ini; - - -
    - - - diff --git a/reference/zookeeper/zookeeper.xml b/reference/zookeeper/zookeeper.xml deleted file mode 100644 index afd9c731eb..0000000000 --- a/reference/zookeeper/zookeeper.xml +++ /dev/null @@ -1,832 +0,0 @@ - - - - - - La clase Zookeeper - Zookeeper - - - - -
    - &reftitle.intro; - - Representa la sesión de ZooKeeper. - -
    - - -
    - &reftitle.classsynopsis; - - - - Zookeeper - - - - - Zookeeper - - - - - - - &Methods; - - - - - - - - - - &Constants; - - const - int - PERM_READ - 1 - - - const - int - PERM_WRITE - 2 - - - const - int - PERM_CREATE - 4 - - - const - int - PERM_DELETE - 8 - - - const - int - PERM_ADMIN - 16 - - - const - int - PERM_ALL - 31 - - - - const - int - EPHEMERAL - 1 - - - const - int - SEQUENCE - 2 - - - - const - int - LOG_LEVEL_ERROR - 1 - - - const - int - LOG_LEVEL_WARN - 2 - - - const - int - LOG_LEVEL_INFO - 3 - - - const - int - LOG_LEVEL_DEBUG - 4 - - - - const - int - EXPIRED_SESSION_STATE - -112 - - - const - int - AUTH_FAILED_STATE - -113 - - - const - int - CONNECTING_STATE - 1 - - - const - int - ASSOCIATING_STATE - 2 - - - const - int - CONNECTED_STATE - 3 - - - const - int - READONLY_STATE - 5 - - - const - int - NOTCONNECTED_STATE - 999 - - - - const - int - CREATED_EVENT - 1 - - - const - int - DELETED_EVENT - 2 - - - const - int - CHANGED_EVENT - 3 - - - const - int - CHILD_EVENT - 4 - - - const - int - SESSION_EVENT - -1 - - - const - int - NOTWATCHING_EVENT - -2 - - - - const - int - SYSTEMERROR - -1 - - - const - int - RUNTIMEINCONSISTENCY - -2 - - - const - int - DATAINCONSISTENCY - -3 - - - const - int - CONNECTIONLOSS - -4 - - - const - int - MARSHALLINGERROR - -5 - - - const - int - UNIMPLEMENTED - -6 - - - const - int - OPERATIONTIMEOUT - -7 - - - const - int - BADARGUMENTS - -8 - - - const - int - INVALIDSTATE - -9 - - - const - int - NEWCONFIGNOQUORUM - -13 - - - const - int - RECONFIGINPROGRESS - -14 - - - - const - int - OK - 0 - - - const - int - APIERROR - -100 - - - const - int - NONODE - -101 - - - const - int - NOAUTH - -102 - - - const - int - BADVERSION - -103 - - - const - int - NOCHILDRENFOREPHEMERALS - -108 - - - const - int - NODEEXISTS - -110 - - - const - int - NOTEMPTY - -111 - - - const - int - SESSIONEXPIRED - -112 - - - const - int - INVALIDCALLBACK - -113 - - - const - int - INVALIDACL - -114 - - - const - int - AUTHFAILED - -115 - - - const - int - CLOSING - -116 - - - const - int - NOTHING - -117 - - - const - int - SESSIONMOVED - -118 - - - const - int - NOTREADONLY - -119 - - - const - int - EPHEMERALONLOCALSESSION - -120 - - - const - int - NOWATCHER - -121 - - - const - int - RECONFIGDISABLED - -122 - - - - - - -
    - - -
    - &reftitle.constants; - - -
    - Permisos <acronym>ZooKeeper</acronym> - - - - Zookeeper::PERM_READ - - Puede leer el valor de los nodos y enumerar sus hijos - - - - Zookeeper::PERM_WRITE - - Puede establecer el valor de los nodos - - - - Zookeeper::PERM_CREATE - - Puede crear hijos - - - - Zookeeper::PERM_DELETE - - Puede eliminar hijos - - - - Zookeeper::PERM_ADMIN - - Puede ejecutar set_acl() - - - - Zookeeper::PERM_ALL - - Todas las flags anteriores combinadas con OR - - - - -
    - - - -
    - Flags de creación de <acronym>ZooKeeper</acronym> - - - - Zookeeper::EPHEMERAL - - Si la flag Zookeeper::EPHEMERAL es establecida, el nodo se eliminará automáticamente si la sesión del cliente desaparece. - - - - Zookeeper::SEQUENCE - - Si la flag Zookeeper::SEQUENCE flag es establecida, un número de secuencia ascendente único se añade al nombre de la ruta. El número de secuencia es siempre de longitud fija de 10 dígitos, 0 relleno. - - - -
    - - - -
    - Niveles de log de <acronym>ZooKeeper</acronym> - - - - Zookeeper::LOG_LEVEL_ERROR - - Emite sólo mensajes de error - - - - Zookeeper::LOG_LEVEL_WARN - - Emite errores/advertencias - - - - Zookeeper::LOG_LEVEL_INFO - - Emite grandes mensajes de acción además de errores/advertencias - - - - Zookeeper::LOG_LEVEL_DEBUG - - Emite todo - - - - -
    - - - -
    - Estados de <acronym>ZooKeeper</acronym> - - - - Zookeeper::EXPIRED_SESSION_STATE - - Conectado pero la sesión expiró - - - - Zookeeper::AUTH_FAILED_STATE - - Conectado pero la autentificación falló - - - - Zookeeper::CONNECTING_STATE - - Conectando - - - - Zookeeper::ASSOCIATING_STATE - - Asociando - - - - Zookeeper::CONNECTED_STATE - - Conectado - - - - Zookeeper::READONLY_STATE - - TODO: Ayúdanos a mejorar esta extensión. - - - - Zookeeper::NOTCONNECTED_STATE - - La conexión falló - - - - -
    - - - -
    - Tipos de relojes <acronym>ZooKeeper</acronym> - - - - Zookeeper::CREATED_EVENT - - Se ha creado un nodo - Esto sólo se genera por los relojes en nodos inexistentes. Estos relojes se ajustan usando Zookeeper::exists. - - - - Zookeeper::DELETED_EVENT - - Se ha eliminado un nodo - Esto sólo se genera por los relojes de los nodos. Estos relojes se ajustan usando Zookeeper::exists y Zookeeper::get. - - - - Zookeeper::CHANGED_EVENT - - Un nodo ha cambiado - Esto sólo lo generan los relojes de los nodos. Estos relojes se ajustan usando Zookeeper::exists y Zookeeper::get. - - - - Zookeeper::CHILD_EVENT - - Un cambio como el ocurrido en la lista de hijos - Esto sólo se genera por los relojes en la lista de hijos de un nodo. Estos relojes se ajustan usando Zookeeper::getChildren. - - - - Zookeeper::SESSION_EVENT - - Se ha perdido una sesión - Esto se genera cuando un cliente pierde el contacto o se reconecta con un servidor. - - - - Zookeeper::NOTWATCHING_EVENT - - Se ha quitado un reloj - Esto se genera cuando el servidor, por alguna razón, probablemente una limitación de recursos, ya no vigila un nodo para un cliente. - - - - -
    - - - -
    - Errores del sistema y del servidor <acronym>ZooKeeper</acronym> - - - Zookeeper::SYSTEMERROR - - Esto nunca es lanzado por el servidor, no debe ser usado más que para indicar un rango. Específicamente códigos de error mayores que este valor, pero menores que Zookeeper::APIERROR, son errores del sistema. - - - - Zookeeper::RUNTIMEINCONSISTENCY - - Se encontró una inconsistencia en el tiempo de ejecución. - - - - Zookeeper::DATAINCONSISTENCY - - Se encontró una inconsistencia en los datos. - - - - Zookeeper::CONNECTIONLOSS - - Se ha perdido la conexión con el servidor. - - - - Zookeeper::MARSHALLINGERROR - - Error al ordenar o desordenar los datos. - - - - Zookeeper::UNIMPLEMENTED - - La operación no se ha llevado a cabo. - - - - Zookeeper::OPERATIONTIMEOUT - - Tiempo de espera de la operación. - - - - Zookeeper::BADARGUMENTS - - Argumentos inválidos. - - - - Zookeeper::INVALIDSTATE - - Estado de zhandle inválido. - - - - Zookeeper::NEWCONFIGNOQUORUM - - Ningún grupo de nueva configuración está conectado y actualizado con el líder de la última configuración realizada. - intente invocar la reconfiguración después de que los nuevos servidores estén conectados y sincronizados. - Disponible a partir de ZooKeeper 3.5.0 - - - - Zookeeper::RECONFIGINPROGRESS - - Se solicita una reconfiguración mientras se está llevando a cabo otra reconfiguración. Esto no se soporta actualmente. Por favor, vuelva a intentarlo.. - Disponible a partir de ZooKeeper 3.5.0 - - - -
    - - - -
    - Errores de la API <acronym>ZooKeeper</acronym> - - - Zookeeper::OK - - Todo está bien. - - - - Zookeeper::APIERROR - - Esto nunca es lanzado por el servidor, no debe usarse más que para indicar un rango. Específicamente los códigos de error mayores que este valor son errores de la API (mientras que los valores inferiores a éste indican una Zookeeper::SYSTEMERROR). - - - - Zookeeper::NONODE - - El nodo no existe. - - - - Zookeeper::NOAUTH - - No está autentificado. - - - - Zookeeper::BADVERSION - - Conflicto de versiones. - - - - Zookeeper::NOCHILDRENFOREPHEMERALS - - Los nodos efímeros pueden no tener hijos. - - - - Zookeeper::NODEEXISTS - - El nodo ya existe. - - - - Zookeeper::NOTEMPTY - - El nodo tiene hijos. - - - - Zookeeper::SESSIONEXPIRED - - La sesión ha expirado por el servidor. - - - - Zookeeper::INVALIDCALLBACK - - Se especificó una devolución de llamada inválida. - - - - Zookeeper::INVALIDACL - - Se especificó un LCA inválido. - - - - Zookeeper::AUTHFAILED - - La autentificación del cliente falló. - - - - Zookeeper::CLOSING - - ZooKeeper está cerrando. - - - - Zookeeper::NOTHING - - (no error) No hay respuestas del servidor al proceso. - - - - Zookeeper::SESSIONMOVED - - La sesión se movió a otro servidor, así que la operación es ignorada. - - - - Zookeeper::NOTREADONLY - - La solicitud de cambio de estado se pasa al servidor de sólo lectura. - - - - Zookeeper::EPHEMERALONLOCALSESSION - - Intentar crear un nodo efímero en una sesión local. - - - - Zookeeper::NOWATCHER - - El observador no pudo ser encontrado. - - - - Zookeeper::RECONFIGDISABLED - - Intentar realizar una operación de reconfiguración cuando la función de reconfiguración está desactivada. - - - -
    - - -
    - - - -
    - - &reference.zookeeper.entities.zookeeper; - -
    - - - diff --git a/reference/zookeeper/zookeeper/addauth.xml b/reference/zookeeper/zookeeper/addauth.xml deleted file mode 100644 index f514dcb866..0000000000 --- a/reference/zookeeper/zookeeper/addauth.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - Zookeeper::addAuth - Especifica la información de autenticación de la aplicación - - - - &reftitle.description; - - public - boolZookeeper::addAuth - stringscheme - stringcert - callablecompletion_cb&null; - - - La aplicación llama a esta función para especificar su información de autenticación. El servidor usará el proveedor de seguridad especificado por el parámetro scheme para autenticar la conexión del cliente. Si la solicitud de autenticación falla: - - la conexión del servidor se abandona. - - el observador es llamado con el valor ZOO_AUTH_FAILED_STATE como parámetro de estado. - - - - - &reftitle.parameters; - - - scheme - - - El id del esquema de autenticación. Soportado nativamente: "digest" autenticación basada en contraseña. - - - - - cert - - - La información de autenticación de la aplicación. El valor real depende del esquema. - - - - - completion_cb - - - La rutina a invocar cuando la solicitud ha terminado. Uno de los siguientes códigos de resultado puede ser pasado a la función de devolución de llamada de finalización: - - ZOK la operación se completó con éxito - - ZAUTHFAILED la autenticación falló - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - Este método emite un error/advertencia PHP cuando el número de parámetros o los tipos son incorrectos o cuando la operación falla. - - - - Desde la versión 0.3.0, este método emite ZookeeperException y sus derivados. - - - - - - &reftitle.examples; - - Ejemplo de <methodname>Zookeeper::addAuth</methodname> - - Añade la autenticación antes de solicitar el valor del nodo. - - -set($path, $value); - -$zookeeper->addAuth('digest', 'user0:passwd0'); -$r = $zookeeper->get($path); -if ($r) - echo $r; -else - echo 'ERR'; -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - Zookeeper::create - Zookeeper::setAcl - Zookeeper::getAcl - Estado de ZooKeeper - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/close.xml b/reference/zookeeper/zookeeper/close.xml deleted file mode 100644 index 3538a06813..0000000000 --- a/reference/zookeeper/zookeeper/close.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - Zookeeper::close - Cierra la conexión con el servidor ZooKeeper y libera los recursos asociados - - - - &reftitle.description; - - public - voidZookeeper::close - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Este método lanza ZookeeperException y sus derivados al cerrar una instancia no inicializada. - - - - - &reftitle.seealso; - - Zookeeper::__construct - Zookeeper::connect - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/connect.xml b/reference/zookeeper/zookeeper/connect.xml deleted file mode 100644 index 2756b5dc7e..0000000000 --- a/reference/zookeeper/zookeeper/connect.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - Zookeeper::connect - Crea un manejador para comunicarse con Zookeeper - - - - &reftitle.description; - - public - voidZookeeper::connect - stringhost - callablewatcher_cb&null; - intrecv_timeout10000 - - - - Este método crea una nueva conexión y una sesión zookeeper que corresponde a esa conexión. El establecimiento - de la sesión es asíncrono, lo que significa que la sesión no debe considerarse establecida hasta que se reciba - un evento ZOO_CONNECTED_STATE. - - - - - &reftitle.parameters; - - - host - - - Separados por comas, cada par host:puerto corresponde a un servidor zk. Por ejemplo, «127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002». - - - - - watcher_cb - - - La función de devolución de llamada de observación global. Cuando se activen las notificaciones, se invocará esta función. - - - - - recv_timeout - - - El tiempo de espera para esta sesión, sólo válido si la conexión está actualmente conectada (es decir, el último estado del observador es ZOO_CONNECTED_STATE). - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Este método emite un error/advertencia de PHP si el número de parámetros o tipos es incorrecto o si la instancia no ha podido ser inicializada. - - - - Desde la versión 0.3.0, este método lanza ZookeeperException y sus derivados. - - - - - - &reftitle.seealso; - - Zookeeper::__construct - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/construct.xml b/reference/zookeeper/zookeeper/construct.xml deleted file mode 100644 index c264d7a9a3..0000000000 --- a/reference/zookeeper/zookeeper/construct.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - Zookeeper::__construct - Crea un manejador para comunicarse con Zookeeper - - - - &reftitle.description; - - public - Zookeeper::__construct - stringhost'' - callablewatcher_cb&null; - intrecv_timeout10000 - - - Este método crea una nueva conexión y una sesión zookeeper que corresponde a ese handle. El establecimiento de la sesión es asíncrono, lo que significa que la sesión no debe considerarse establecida hasta que se reciba un evento ZOO_CONNECTED_STATE. - - - - - &reftitle.parameters; - - - host - - - Separados por comas, cada par host:puerto corresponde a un servidor zk. Por ejemplo, «127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002». - - - - - watcher_cb - - - La función de devolución de llamada de observación global. Cuando se activen las notificaciones, se invocará esta función. - - - - - recv_timeout - - - El tiempo de espera para esta sesión, sólo válido si la conexión está actualmente conectada (es decir, el último estado del observador es ZOO_CONNECTED_STATE). - - - - - - - - &reftitle.errors; - - Este método emite un error/advertencia de PHP si el número de parámetros o tipos es incorrecto o si la instancia no ha podido ser inicializada. - - - - Desde la versión 0.3.0, este método lanza ZookeeperException y sus derivados. - - - - - - &reftitle.seealso; - - Zookeeper::connect - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/create.xml b/reference/zookeeper/zookeeper/create.xml deleted file mode 100644 index ea4769ae81..0000000000 --- a/reference/zookeeper/zookeeper/create.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - Zookeeper::create - Crear un nodo de forma sincrónica - - - - &reftitle.description; - - public - stringZookeeper::create - stringpath - stringvalue - arrayacls - intflags&null; - - - Este método crea un nodo en ZooKeeper. Sólo se puede crear un nodo si aún no existe. Las banderas de creación - afectan a la creación de nodos. Si se establece el indicador ZOO_EPHEMERAL, el nodo se eliminará automáticamente - si desaparece la sesión del cliente. Si el indicador ZOO_SEQUENCE está activado, se añade un número de secuencia - ascendente único al nombre de la ruta. - - - - - &reftitle.parameters; - - - path - - - El nombre del nodo. Expresado como un nombre de archivo con barras separando los ancestros del nodo. - - - - - value - - - Los datos que se almacenarán en el nodo. - - - - - acls - - - La ACL inicial del nodo. La ACL no debe ser nula ni estar vacía. - - - - - flags - - - Este parámetro puede establecerse en 0 para una creación normal o en una combinación OR de las banderas de creación. - - - - - - - - &reftitle.returnvalues; - - Devuelve la ruta del nuevo nodo (puede ser diferente de la ruta suministrada debido a la bandera ZOO_SEQUENCE) en caso de éxito, y false en caso de fallo. - - - - - &reftitle.errors; - - Este método emite un error/advertencia de PHP si el número de parámetros o tipos es incorrecto o si la creación del nodo ha fallado. - - - - Desde la versión 0.3.0, este método lanza ZookeeperException y sus derivados. - - - - - - &reftitle.examples; - - Ejemplo de <methodname>Zookeeper::create</methodname> - - Crea un nuevo nodo. - - - Zookeeper::PERM_ALL, - 'scheme' => 'world', - 'id' => 'anyone', - ) -); -$path = '/path/to/newnode'; -$realPath = $zookeeper->create($path, null, $aclArray); -if ($realPath) - echo $realPath; -else - echo 'ERR'; -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - Zookeeper::delete - Zookeeper::getChildren - Permisos de ZooKeeper - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/delete.xml b/reference/zookeeper/zookeeper/delete.xml deleted file mode 100644 index 1b541e83c8..0000000000 --- a/reference/zookeeper/zookeeper/delete.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - Zookeeper::delete - Elimina un nodo de forma sincrónica - - - - &reftitle.description; - - public - boolZookeeper::delete - stringpath - intversion-1 - - - - - &reftitle.parameters; - - - path - - - El nombre del nodo. Expresado como un nombre de archivo con barras separando los ancestros del nodo. - - - - - version - - - La versión esperada del nodo. La función fallará si la versión actual del nodo no coincide con la versión esperada. - Si se utiliza -1, la comprobación de la versión no tendrá lugar. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - Este método emite un error/advertencia de PHP si el número de parámetros o los tipos son incorrectos o si la eliminación del nodo ha fallado. - - - Desde la versión 0.3.0, este método lanza ZookeeperException y sus derivados. - - - - - - &reftitle.examples; - - Ejemplo de <methodname>Zookeeper::delete</methodname> - - Elimina un nodo existente. - - -delete($path); -if ($r) - echo 'SUCCESS'; -else - echo 'ERR'; -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - Zookeeper::create - Zookeeper::getChildren - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/exists.xml b/reference/zookeeper/zookeeper/exists.xml deleted file mode 100644 index fd5bc5b4c5..0000000000 --- a/reference/zookeeper/zookeeper/exists.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - Zookeeper::exists - Comprueba la existencia de un nodo de forma sincrónica - - - - &reftitle.description; - - public - arrayZookeeper::exists - stringpath - callablewatcher_cb&null; - - - - - &reftitle.parameters; - - - path - - - El nombre del nodo. Expresado como un nombre de archivo con barras separando los ancestros del nodo. - - - - - watcher_cb - - - Si es distinto de cero, se establecerá un observador en el servidor para notificar al cliente si el nodo cambia. - El observador se activará incluso si el nodo no existe. - - - - - - - - &reftitle.returnvalues; - - Devuelve el valor stat de la ruta si el nodo dado existe, en caso contrario false. - - - - - &reftitle.errors; - - Este método emite un error/advertencia de PHP cuando el número de parámetros o los tipos son incorrectos o la comprobación de existencia del nodo ha fallado. - - - - Desde la versión 0.3.0, este método lanza ZookeeperException y sus derivados. - - - - - - &reftitle.examples; - - Ejemplo de <methodname>Zookeeper::exists</methodname> - - Comprueba la existencia de un nodo. - - -exists($path); -if ($r) - echo 'EXISTS'; -else - echo 'N/A or ERR'; -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - Zookeeper::get - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/get.xml b/reference/zookeeper/zookeeper/get.xml deleted file mode 100644 index 2837ac54e2..0000000000 --- a/reference/zookeeper/zookeeper/get.xml +++ /dev/null @@ -1,188 +0,0 @@ - - - - - - Zookeeper::get - Devuelve los datos asociados a un nodo de forma sincrónica - - - - &reftitle.description; - - public - stringZookeeper::get - stringpath - callablewatcher_cb&null; - arraystat&null; - intmax_size0 - - - - - &reftitle.parameters; - - - path - - - El nombre del nodo. Expresado como un nombre de archivo con barras separando los ancestros del nodo. - - - - - watcher_cb - - - Si es distinto de cero, se definirá un observador en el servidor para notificar al cliente si cambia el nodo. - - - - - stat - - - Si no es NULL, contendrá el valor de las estadísticas de la ruta devuelta. - - - - - max_size - - - El tamaño máximo de los datos. Si se utiliza 0, este método devolverá todos los datos. - - - - - - - - &reftitle.returnvalues; - - Devuelve datos en caso de éxito, y false en caso de fallo. - - - - - &reftitle.errors; - - Este método emite un error/advertencia de PHP si el número de parámetros o los tipos son incorrectos, - o si la recuperación de datos ha fallado. - - - - Desde la versión 0.3.0, este método lanza ZookeeperException y sus derivados. - - - - - - &reftitle.examples; - - Ejemplo de <methodname>Zookeeper::get</methodname> - - Recupera el valor del nodo. - - -set($path, $value); - -$r = $zookeeper->get($path); -if ($r) - echo $r; -else - echo 'ERR'; -?> -]]> - - &example.outputs; - - - - - - - Ejemplo de estadísticas de <methodname>Zookeeper::get</methodname> - - Devuelve información estadística del nodo. - - -get($path, null, $stat); -var_dump($stat); -?> -]]> - - &example.outputs; - - - float(0) - ["mzxid"]=> - float(0) - ["ctime"]=> - float(0) - ["mtime"]=> - float(0) - ["version"]=> - int(0) - ["cversion"]=> - int(-2) - ["aversion"]=> - int(0) - ["ephemeralOwner"]=> - float(0) - ["dataLength"]=> - int(0) - ["numChildren"]=> - int(2) - ["pzxid"]=> - float(0) -} -]]> - - - - - - &reftitle.seealso; - - Zookeeper::set - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/getacl.xml b/reference/zookeeper/zookeeper/getacl.xml deleted file mode 100644 index 5b2d210e88..0000000000 --- a/reference/zookeeper/zookeeper/getacl.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - Zookeeper::getAcl - Devuelve las ACL asociadas a un nodo de forma sincrónica - - - - &reftitle.description; - - public - arrayZookeeper::getAcl - stringpath - - - - - &reftitle.parameters; - - - path - - - El nombre del nodo. Expresado como un nombre de archivo con barras separando los ancestros del nodo. - - - - - - - - &reftitle.returnvalues; - - Devuelve un array de ACLs en caso de éxito y false en caso de fallo. - - - - - &reftitle.errors; - - Este método emite un error/advertencia de PHP si el número de parámetros o los tipos son incorrectos - o si no se han podido recuperar las ACL del nodo. - - - - Desde la versión 0.3.0, este método lanza ZookeeperException y sus derivados. - - - - - - &reftitle.examples; - - Ejemplo de <methodname>Zookeeper::getAcl</methodname> - - Devuelve las ACL de un nodo. - - - Zookeeper::PERM_ALL, - 'scheme' => 'world', - 'id' => 'anyone', - ) -); -$path = '/path/to/newnode'; -$zookeeper->setAcl($path, $aclArray); - -$r = $zookeeper->getAcl($path); -if ($r) - var_dump($r); -else - echo 'ERR'; -?> -]]> - - &example.outputs; - - - array(3) { - ["perms"]=> - int(31) - ["scheme"]=> - string(5) "world" - ["id"]=> - string(6) "anyone" - } -} -]]> - - - - - - &reftitle.seealso; - - Zookeeper::create - Zookeeper::setAcl - Permisos de ZooKeeper - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/getchildren.xml b/reference/zookeeper/zookeeper/getchildren.xml deleted file mode 100644 index 89342eba37..0000000000 --- a/reference/zookeeper/zookeeper/getchildren.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - Zookeeper::getChildren - Lista los hijos de un nodo de forma sincrónica - - - - &reftitle.description; - - public - arrayZookeeper::getChildren - stringpath - callablewatcher_cb&null; - - - - - &reftitle.parameters; - - - path - - - El nombre del nodo. Expresado como un nombre de archivo con barras separando los ancestros del nodo. - - - - - watcher_cb - - - Si es distinto de cero, se definirá un observador en el servidor para notificar al cliente si cambia el nodo. - - - - - - - - &reftitle.returnvalues; - - Devuelve un array con las rutas de los hijos en caso de éxito, y false en caso de fallo. - - - - - &reftitle.errors; - - Este método emite un error/advertencia PHP cuando el número de parámetros o tipos son incorrectos, o cuando la lista de hijos de un nodo ha fallado. - - - - Desde la versión 0.3.0, este método lanza ZookeeperException y sus derivados. - - - - - - &reftitle.examples; - - Ejemplo de <methodname>Zookeeper::getChildren</methodname> - - Lista los hijos de un nodo. - - -getchildren($path); - -if ($r) { - var_dump($r); -} else { - echo 'ERR'; -} - -?> -]]> - - &example.outputs; - - - string(6) "config" -} -]]> - - - - - - &reftitle.seealso; - - Zookeeper::create - Zookeeper::delete - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/getclientid.xml b/reference/zookeeper/zookeeper/getclientid.xml deleted file mode 100644 index 853ffb991c..0000000000 --- a/reference/zookeeper/zookeeper/getclientid.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - Zookeeper::getClientId - Devuelve el identificador de sesión del cliente, sólo válido si la conexión está actualmente establecida (es decir, si el último estado del observador es ZOO_CONNECTED_STATE). - - - - &reftitle.description; - - public - intZookeeper::getClientId - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el identificador de sesión del cliente en caso de éxito, y false en caso de fallo. - - - - - &reftitle.errors; - - Este método emite un error/advertencia de PHP cuando el cliente no ha podido obtener el identificador de sesión. - - - - Desde la versión 0.3.0, este método lanza ZookeeperException y sus derivados. - - - - - - &reftitle.seealso; - - Zookeeper::__construct - Zookeeper::connect - Zookeeper::getState - Estados de ZooKeeper - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/getconfig.xml b/reference/zookeeper/zookeeper/getconfig.xml deleted file mode 100644 index f35eb78635..0000000000 --- a/reference/zookeeper/zookeeper/getconfig.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - Zookeeper::getConfig - Devuelve la instancia de ZookeeperConfig - - - - &reftitle.description; - - public - ZookeeperConfigZookeeper::getConfig - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve la instancia de ZookeeperConfig. - - - - - &reftitle.seealso; - - ZookeeperConfig - - - - - - diff --git a/reference/zookeeper/zookeeper/getrecvtimeout.xml b/reference/zookeeper/zookeeper/getrecvtimeout.xml deleted file mode 100644 index 8d698601cd..0000000000 --- a/reference/zookeeper/zookeeper/getrecvtimeout.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Zookeeper::getRecvTimeout - Devuelve el tiempo de espera para esta sesión, sólo válido si la conexión está actualmente establecida (es decir, si el último estado del observador es ZOO_CONNECTED_STATE). Este valor puede cambiar tras una reconexión con el servidor. - - - - &reftitle.description; - - public - intZookeeper::getRecvTimeout - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el tiempo de espera para esta sesión en caso de éxito, y false en caso de fallo. - - - - - &reftitle.errors; - - Este método emite un error/advertencia PHP cuando la operación falla. - - - - Desde la versión 0.3.0, este método lanza ZookeeperException y sus derivados. - - - - - - &reftitle.seealso; - - Zookeeper::__construct - Zookeeper::connect - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/getstate.xml b/reference/zookeeper/zookeeper/getstate.xml deleted file mode 100644 index 77acd8268f..0000000000 --- a/reference/zookeeper/zookeeper/getstate.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - Zookeeper::getState - Devuelve el estado de la conexión zookeeper - - - - &reftitle.description; - - public - intZookeeper::getState - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve el estado de la conexión zookeeper en caso de éxito, y false en caso de fallo. - - - - - &reftitle.errors; - - Este método emite un error/advertencia PHP cuando no se puede obtener el estado de la conexión zookeeper. - - - - Desde la versión 0.3.0, este método lanza ZookeeperException y sus derivados. - - - - - - &reftitle.seealso; - - Zookeeper::__construct - Zookeeper::connect - Zookeeper::getClientId - Estados de ZooKeeper - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/isrecoverable.xml b/reference/zookeeper/zookeeper/isrecoverable.xml deleted file mode 100644 index 6febfcdb2a..0000000000 --- a/reference/zookeeper/zookeeper/isrecoverable.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - Zookeeper::isRecoverable - Comprueba si se puede recuperar el estado actual de la conexión zookeeper - - - - &reftitle.description; - - public - boolZookeeper::isRecoverable - - - - La aplicación debería cerrar el gestor e intentar volver a conectarse. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Devuelve true/false en caso de éxito y false en caso de fallo. - - - - - &reftitle.errors; - - Este método emite un error/advertencia PHP cuando la operación falla. - - - - Desde la versión 0.3.0, este método lanza ZookeeperException y sus derivados. - - - - - - &reftitle.seealso; - - Zookeeper::__construct - Zookeeper::connect - Zookeeper::getClientId - Estado de ZooKeeper - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/set.xml b/reference/zookeeper/zookeeper/set.xml deleted file mode 100644 index fbfe3bc92a..0000000000 --- a/reference/zookeeper/zookeeper/set.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - Zookeeper::set - Define los datos asociados a un nodo - - - - &reftitle.description; - - public - boolZookeeper::set - stringpath - stringvalue - intversion-1 - arraystat&null; - - - - - &reftitle.parameters; - - - path - - - El nombre del nodo. Expresado como un nombre de archivo con barras separando los ancestros del nodo. - - - - - value - - - Los datos que se almacenarán en el nodo. - - - - - version - - - La versión esperada del nodo. La función fallará si la versión actual del nodo no coincide con la versión esperada. - Si se utiliza -1, no se realizará la comprobación de la versión. - - - - - stat - - - Si no es NULL, contendrá el valor de las estadísticas de la ruta devuelta. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - Este método emite un error/advertencia de PHP cuando el número de parámetros o los tipos son incorrectos - o cuando guardar el valor en el nodo ha fallado. - - - - Desde la versión 0.3.0, este método lanza ZookeeperException y sus derivados. - - - - - - &reftitle.examples; - - Ejemplo de <methodname>Zookeeper::set</methodname> - - Guarda un valor en un nodo. - - -set($path, $value); -if ($r) - echo 'SUCCESS'; -else - echo 'ERR'; -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - Zookeeper::create - Zookeeper::get - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/setacl.xml b/reference/zookeeper/zookeeper/setacl.xml deleted file mode 100644 index b7bb540e63..0000000000 --- a/reference/zookeeper/zookeeper/setacl.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - Zookeeper::setAcl - Establece la ACL asociada a un nodo de forma sincrónica - - - - &reftitle.description; - - public - boolZookeeper::setAcl - stringpath - intversion - arrayacl - - - - - &reftitle.parameters; - - - path - - - El nombre del nodo. Expresado como un nombre de archivo con barras separando los ancestros del nodo. - - - - - version - - - El número de versión esperado de la ruta. - - - - - acl - - - La ACL que debe definirse en la ruta. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - Este método emite un error/advertencia de PHP cuando el número de parámetros o los tipos son incorrectos o no se ha podido definir la ACL para un nodo. - - - - Desde la versión 0.3.0, este método lanza ZookeeperException y sus derivados. - - - - - - &reftitle.examples; - - Ejemplo de <methodname>Zookeeper::setAcl</methodname> - - Establece la ACL para un nodo. - - - Zookeeper::PERM_ALL, - 'scheme' => 'world', - 'id' => 'anyone', - ) -); -$path = '/path/to/newnode'; -$zookeeper->setAcl($path, $aclArray); - -$r = $zookeeper->getAcl($path); -if ($r) - var_dump($r); -else - echo 'ERR'; -?> -]]> - - &example.outputs; - - - array(3) { - ["perms"]=> - int(31) - ["scheme"]=> - string(5) "world" - ["id"]=> - string(6) "anyone" - } -} -]]> - - - - - - &reftitle.seealso; - - Zookeeper::create - Zookeeper::getAcl - Permisos de ZooKeeper - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/setdebuglevel.xml b/reference/zookeeper/zookeeper/setdebuglevel.xml deleted file mode 100644 index 4f59da1eca..0000000000 --- a/reference/zookeeper/zookeeper/setdebuglevel.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - Zookeeper::setDebugLevel - Define el nivel de depuración de la biblioteca - - - - &reftitle.description; - - public - static - boolZookeeper::setDebugLevel - intlogLevel - - - - - &reftitle.parameters; - - - logLevel - - - Constantes de nivel de depuración de ZooKeeper. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - Este método emite un error/advertencia de PHP cuando el número de parámetros o los tipos son incorrectos - o no definen el nivel de depuración. - - - - Desde la versión 0.3.0, este método lanza ZookeeperException y sus derivados. - - - - - - &reftitle.examples; - - Ejemplo de <methodname>Zookeeper::setDebugLevel</methodname> - - Define el nivel de depuración. - - - -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - Nivel de registro ZooKeeper - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/setdeterministicconnorder.xml b/reference/zookeeper/zookeeper/setdeterministicconnorder.xml deleted file mode 100644 index 15441d1bde..0000000000 --- a/reference/zookeeper/zookeeper/setdeterministicconnorder.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - Zookeeper::setDeterministicConnOrder - Activa/desactiva la aleatorización del orden de los puntos finales de quórum. - - - - &reftitle.description; - - public - static - boolZookeeper::setDeterministicConnOrder - boolyesOrNo - - - Si se establece en true, hará que el cliente se conecte a los nodos del quórum en el orden especificado en la llamada - a zookeeper_init(). Un valor falso causará que zookeeper_init() intercambie los puntos finales de los nodos del quórum, - lo que es bueno para una distribución más uniforme de las conexiones de los clientes entre los nodos del quórum. - El cliente ZooKeeper C utiliza false por defecto. - - - - - &reftitle.parameters; - - - yesOrNo - - - Activa/desactiva la aleatorización del orden de los puntos finales de quórum. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - Este método emite un error/advertencia de PHP cuando el número de parámetros o tipos es incorrecto o la operación falla. - - - - Desde la versión 0.3.0, este método lanza ZookeeperException y sus derivados. - - - - - - &reftitle.seealso; - - Zookeeper::__construct - Zookeeper::connect - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/setlogstream.xml b/reference/zookeeper/zookeeper/setlogstream.xml deleted file mode 100644 index 4b4e0070b8..0000000000 --- a/reference/zookeeper/zookeeper/setlogstream.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Zookeeper::setLogStream - Define el flujo que utilizará la biblioteca para el registro - - - - &reftitle.description; - - public - boolZookeeper::setLogStream - resourcestream - - - La librería zookeeper utiliza stderr como flujo de registro por defecto. La aplicación debe asegurarse - de que el flujo es escribible. Pasar NULL restablece el flujo a su valor por defecto (stderr). - - - - - &reftitle.parameters; - - - stream - - - El flujo que utilizará la biblioteca para el registro. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - Este método emite un error/advertencia de PHP cuando el número de parámetros o tipos es incorrecto o la operación falla. - - - - Desde la versión 0.3.0, este método lanza ZookeeperException y sus derivados. - - - - - - &reftitle.seealso; - - Zookeeper::setDebugLevel - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeper/setwatcher.xml b/reference/zookeeper/zookeeper/setwatcher.xml deleted file mode 100644 index 2fd1030102..0000000000 --- a/reference/zookeeper/zookeeper/setwatcher.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - Zookeeper::setWatcher - Define una función de observación - - - - &reftitle.description; - - public - boolZookeeper::setWatcher - callablewatcher_cb - - - - - &reftitle.parameters; - - - watcher_cb - - - Un observador que será llamado cada vez que el nodo cambie. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - Este método emite un error/advertencia PHP cuando el número de parámetros o los tipos son incorrectos - o es imposible cambiar el observador. - - - - Desde la versión 0.3.0, este método lanza ZookeeperException y sus derivados. - - - - - - &reftitle.seealso; - - Zookeeper::exists - Zookeeper::get - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeperauthenticationexception.xml b/reference/zookeeper/zookeeperauthenticationexception.xml deleted file mode 100644 index 801a558cf5..0000000000 --- a/reference/zookeeper/zookeeperauthenticationexception.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - La clase ZookeeperAuthenticationException - ZookeeperAuthenticationException - - - - -
    - &reftitle.intro; - - La clase de manejo de excepciones de autenticación de ZooKeeper. - -
    - - -
    - &reftitle.classsynopsis; - - - - ZookeeperAuthenticationException - - - - - ZookeeperAuthenticationException - - - extends - ZookeeperException - - - &InheritedProperties; - - &InheritedMethods; - - - - -
    - -
    - -
    - - - diff --git a/reference/zookeeper/zookeeperconfig.xml b/reference/zookeeper/zookeeperconfig.xml deleted file mode 100644 index 2461e6a889..0000000000 --- a/reference/zookeeper/zookeeperconfig.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - La clase ZookeeperConfig - ZookeeperConfig - - - - -
    - &reftitle.intro; - - La clase de manejo de configuración de ZooKeeper. - -
    - - -
    - &reftitle.classsynopsis; - - - - ZookeeperConfig - - - - - ZookeeperConfig - - - - - - &Methods; - - - - - - - - -
    - -
    - - &reference.zookeeper.entities.zookeeperconfig; - -
    - - diff --git a/reference/zookeeper/zookeeperconfig/add.xml b/reference/zookeeper/zookeeperconfig/add.xml deleted file mode 100644 index 0d93ad87d8..0000000000 --- a/reference/zookeeper/zookeeperconfig/add.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - ZookeeperConfig::add - Agregar servidores al conjunto - - - - &reftitle.description; - - public - voidZookeeperConfig::add - stringmembers - intversion-1 - arraystat&null; - - - - - &reftitle.parameters; - - - members - - - La lista separada por comas de los servidores que se añadirán al conjunto. Cada uno tiene una línea de configuración para un servidor a añadir (como aparecería en un - en un fichero de configuración), sólo para quórums mayoritarios. - - - - - version - - - La versión esperada del nodo. La función fallará si la versión actual del nodo no coincide con la versión esperada. Si se utiliza -1, no se realizará la comprobación de la versión. - - - - - stat - - - Si no es NULL, contendrá el valor de stat para la ruta de retorno. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Este método lanza ZookeeperException y sus derivados cuando el número o tipo de parámetros es incorrecto o el valor no se puede guardar en el nodo. - - - - - &reftitle.examples; - - Ejemplo de <methodname>ZookeeperConfig::add</methodname> - - Agrega miembros. - - -connect('localhost:2181'); -$client->addAuth('digest', 'timandes:timandes'); -$zkConfig = $client->getConfig(); -$zkConfig->set("server.1=localhost:2888:3888:participant;0.0.0.0:2181"); -$zkConfig->add("server.2=localhost:2889:3889:participant;0.0.0.0:2182"); -$r = $zkConfig->get(); -if ($r) - echo $r; -else - echo 'ERR'; -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - ZookeeperConfig::get - ZookeeperConfig::set - ZookeeperConfig::remove - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeperconfig/get.xml b/reference/zookeeper/zookeeperconfig/get.xml deleted file mode 100644 index cdca8427f0..0000000000 --- a/reference/zookeeper/zookeeperconfig/get.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - ZookeeperConfig::get - Devuelve la última configuración validada del clúster ZooKeeper conocida por el servidor al que está conectado el cliente, de forma sincrónica - - - - &reftitle.description; - - public - stringZookeeperConfig::get - callablewatcher_cb&null; - arraystat&null; - - - - - &reftitle.parameters; - - - watcher_cb - - - Si es distinto de cero, se colocará un observador en el servidor para notificar al cliente si cambia el nodo. - - - - - stat - - - Si no es NULL, contendrá el valor de stat para la ruta de retorno. - - - - - - - - &reftitle.returnvalues; - - Devuelve la cadena de configuración en caso de éxito, y false en caso de fallo. - - - - - &reftitle.errors; - - Este método lanza ZookeeperException y sus derivados cuando el número o tipo de parámetros es incorrecto o si falla la recuperación de la configuración. - - - - - &reftitle.examples; - - Ejemplo de <methodname>ZookeeperConfig::get</methodname> - - Obtener la configuración. - - -connect('localhost:2181'); -$zk->addAuth('digest', 'timandes:timandes'); -$zkConfig = $zk->getConfig(); -$r = $zkConfig->get(); -if ($r) - echo $r; -else - echo 'ERR'; -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - ZookeeperConfig::set - ZookeeperConfig::add - ZookeeperConfig::remove - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeperconfig/remove.xml b/reference/zookeeper/zookeeperconfig/remove.xml deleted file mode 100644 index 5a848bb79c..0000000000 --- a/reference/zookeeper/zookeeperconfig/remove.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - ZookeeperConfig::remove - Eliminar servidores del conjunto - - - - &reftitle.description; - - public - voidZookeeperConfig::remove - stringid_list - intversion-1 - arraystat&null; - - - - - &reftitle.parameters; - - - id_list - - - La lista separada por comas de IDs de servidores a eliminar del conjunto. Cada uno tiene un identificador de un servidor a eliminar, sólo para quórums mayoritarios. - - - - - version - - - La versión esperada del nodo. La función fallará si la versión actual del nodo no coincide con la versión esperada. - Si se utiliza -1, no se realizará la comprobación de la versión. - - - - - stat - - - Si no es NULL, contendrá el valor de stat para la ruta de retorno. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Este método lanza ZookeeperException y sus derivados cuando el número o el tipo de los parámetros es incorrecto o si la eliminación del valor del nodo falla. - - - - - &reftitle.examples; - - Ejemplo de <methodname>ZookeeperConfig::remove</methodname> - - Quita miembros. - - -connect('localhost:2181'); -$client->addAuth('digest', 'timandes:timandes'); -$zkConfig = $client->getConfig(); -$zkConfig->set("server.1=localhost:2888:3888:participant;0.0.0.0:2181,server.2=localhost:2889:3889:participant;0.0.0.0:2182"); -$zkConfig->remove("2"); -echo $zkConfig->get(); -if ($r) - echo $r; -else - echo 'ERR'; -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - ZookeeperConfig::get - ZookeeperConfig::add - ZookeeperConfig::set - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeperconfig/set.xml b/reference/zookeeper/zookeeperconfig/set.xml deleted file mode 100644 index bd522e9808..0000000000 --- a/reference/zookeeper/zookeeperconfig/set.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - ZookeeperConfig::set - Cambia la pertenencia al conjunto de clústeres ZK y los roles de los pares en el conjunto. - - - - &reftitle.description; - - public - voidZookeeperConfig::set - stringmembers - intversion-1 - arraystat&null; - - - - - &reftitle.parameters; - - - members - - - La lista separada por comas de los nuevos miembros (por ejemplo, el contenido de un archivo de configuración de miembros) - para ser utilizado sólo con la reconfiguración no incremental. - - - - - version - - - La versión esperada del nodo. La función fallará si la versión actual del nodo no coincide con la versión esperada. - Si se utiliza -1, no se realizará la comprobación de la versión. - - - - - stat - - - Si no es NULL, contendrá el valor de stat para la ruta de retorno. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Este método lanza ZookeeperException y sus derivados cuando el número - o tipo de parámetros es incorrecto o si guardar el valor en el nodo falla. - - - - - &reftitle.examples; - - Ejemplo de <methodname>ZookeeperConfig::set</methodname> - - Reconfiguración. - - -connect('localhost:2181'); -$client->addAuth('digest', 'timandes:timandes'); -$zkConfig = $client->getConfig(); -$zkConfig->set("server.1=localhost:2888:3888:participant;0.0.0.0:2181"); -?> -]]> - - - - - - &reftitle.seealso; - - ZookeeperConfig::get - ZookeeperConfig::add - ZookeeperConfig::remove - ZookeeperException - - - - - - diff --git a/reference/zookeeper/zookeeperconnectionexception.xml b/reference/zookeeper/zookeeperconnectionexception.xml deleted file mode 100644 index 7b1d439c24..0000000000 --- a/reference/zookeeper/zookeeperconnectionexception.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - La clase ZookeeperConnectionException - ZookeeperConnectionException - - - - -
    - &reftitle.intro; - - La clase de manejo de excepciones de la conexión de ZooKeeper. - -
    - - -
    - &reftitle.classsynopsis; - - - - ZookeeperConnectionException - - - - - ZookeeperConnectionException - - - extends - ZookeeperException - - - &InheritedProperties; - - &InheritedMethods; - - - - - -
    - -
    - -
    - - - diff --git a/reference/zookeeper/zookeeperexception.xml b/reference/zookeeper/zookeeperexception.xml deleted file mode 100644 index d3065d5117..0000000000 --- a/reference/zookeeper/zookeeperexception.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - La clase ZookeeperException - ZookeeperException - - - - -
    - &reftitle.intro; - - La clase de manejo de excepciones de ZooKeeper. - -
    - - -
    - &reftitle.classsynopsis; - - - - ZookeeperException - - - - - ZookeeperException - - - extends - Exception - - - &InheritedProperties; - - &InheritedMethods; - - - - - -
    - -
    - -
    - - - diff --git a/reference/zookeeper/zookeepermarshallingexception.xml b/reference/zookeeper/zookeepermarshallingexception.xml deleted file mode 100644 index f4af53b62b..0000000000 --- a/reference/zookeeper/zookeepermarshallingexception.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - La clase ZookeeperMarshallingException - ZookeeperMarshallingException - - - - -
    - &reftitle.intro; - - La clase de manejo de la excepción ZooKeeper (mientras se marcan o desmarcan los datos). - -
    - - -
    - &reftitle.classsynopsis; - - - - ZookeeperMarshallingException - - - - - ZookeeperMarshallingException - - - extends - ZookeeperException - - - &InheritedProperties; - - &InheritedMethods; - - - - - -
    - -
    - -
    - - - diff --git a/reference/zookeeper/zookeepernonodeexception.xml b/reference/zookeeper/zookeepernonodeexception.xml deleted file mode 100644 index f9d9d00027..0000000000 --- a/reference/zookeeper/zookeepernonodeexception.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - La clase ZookeeperNoNodeException - ZookeeperNoNodeException - - - - -
    - &reftitle.intro; - - La clase de manejo de excepciones ZooKeeper (cuando el nodo no existe). - -
    - - -
    - &reftitle.classsynopsis; - - - - ZookeeperNoNodeException - - - - - ZookeeperNoNodeException - - - extends - ZookeeperException - - - &InheritedProperties; - - &InheritedMethods; - - - - - -
    - -
    - -
    - - - diff --git a/reference/zookeeper/zookeeperoperationtimeoutexception.xml b/reference/zookeeper/zookeeperoperationtimeoutexception.xml deleted file mode 100644 index 078e855feb..0000000000 --- a/reference/zookeeper/zookeeperoperationtimeoutexception.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - La clase ZookeeperOperationTimeoutException - ZookeeperOperationTimeoutException - - - - -
    - &reftitle.intro; - - La clase de manejo de excepciones de la operación de ZooKeeper. - -
    - - -
    - &reftitle.classsynopsis; - - - - ZookeeperOperationTimeoutException - - - - - ZookeeperOperationTimeoutException - - - extends - ZookeeperException - - - &InheritedProperties; - - &InheritedMethods; - - - - - -
    - -
    - -
    - - - diff --git a/reference/zookeeper/zookeepersessionexception.xml b/reference/zookeeper/zookeepersessionexception.xml deleted file mode 100644 index 43fd91f25f..0000000000 --- a/reference/zookeeper/zookeepersessionexception.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - La clase ZookeeperSessionException - ZookeeperSessionException - - - - -
    - &reftitle.intro; - - La clase de manejo de excepciones de la sesión de ZooKeeper. - -
    - - -
    - &reftitle.classsynopsis; - - - - ZookeeperSessionException - - - - - ZookeeperSessionException - - - extends - ZookeeperException - - - &InheritedProperties; - - &InheritedMethods; - - - - - -
    - -
    - -
    - - - diff --git a/security/database.xml b/security/database.xml index e6a73579ae..e2dcf6f04a 100644 --- a/security/database.xml +++ b/security/database.xml @@ -318,8 +318,8 @@ $result = mssql_query($query); eliminada en PHP 7.0.0. Aquí se utiliza únicamente para ilustrar el ataque; el código actual que se conecta a MSSQL Server debería utilizar en su lugar las extensiones - sqlsrv o - pdo_sqlsrv. + sqlsrv o + pdo_sqlsrv.